Skip to content

configuration-backend.md

Latest commit

 

History

History
85 lines (61 loc) · 2.27 KB

configuration-backend.md

File metadata and controls

85 lines (61 loc) · 2.27 KB

Configuration: backend

Let orchestrator know where to find backend database. In this setup orchestrator will serve HTTP on port :3000.

{
  "Debug": false,
  "ListenAddress": ":3000",
}

You may choose either a MySQL backend or a SQLite backend. See High availability page for scenarios, possibilities and reasons to using either.

MySQL backend

You will need to set up schema & credentials:

{
  "MySQLOrchestratorHost": "orchestrator.backend.master.com",
  "MySQLOrchestratorPort": 3306,
  "MySQLOrchestratorDatabase": "orchestrator",
  "MySQLOrchestratorCredentialsConfigFile": "/etc/mysql/orchestrator-backend.cnf",
}

Notice MySQLOrchestratorCredentialsConfigFile. It will be of the form:

[client]
user=orchestrator_srv
password=${ORCHESTRATOR_PASSWORD}

where either user or password can be in plaintext or get their value from the environment.

Alternatively, you may choose to use plaintext credentials in the config file:

{
  "MySQLOrchestratorUser": "orchestrator_srv",
  "MySQLOrchestratorPassword": "orc_server_password",
}

MySQL backend DB setup

For a MySQL backend DB, you will need to grant the necessary privileges:

CREATE USER 'orchestrator_srv'@'orc_host' IDENTIFIED BY 'orc_server_password';
GRANT ALL ON orchestrator.* TO 'orchestrator_srv'@'orc_host';

Configuring max_allowed_packet size sent by Orchestrator

When Orchestrator communicates with backend MySQL instance or with managed instances, it has to respect the instance's max_allowed_packet parameter value. The following two options allow configuring this area:

MySQLOrchestratorMaxAllowedPacket
MySQLTopologyMaxAllowedPacket

Allowed values are:

-1 - use the value hardcoded in the driver

0 - let the driver to query the max packet value automatically from the server (only once per connection at the connection begin)

> 0 - use the value provided

SQLite backend

Default backend is MySQL. To setup SQLite, use:

{
  "BackendDB": "sqlite",
  "SQLite3DataFile": "/var/lib/orchestrator/orchestrator.db",  
}

SQLite is embedded within orchestrator.

If the file indicated by SQLite3DataFile does not exist, orchestrator will create it. It will need write permissions on given path/file.