Master host configuration variables
The tables in this section provide an overview of the serviced configuration variables that apply to the Control Center master host. Set these variables as required for your environment or applications.
Storage variables
The variables in the following table are set only on the master host.
-
Use one of the first two groups of variables but not both.
-
Before starting the master host for the first time, you might need to change the defaults of the third group.
-
Typically, the defaults of the last two groups of variables are not changed until Control Center has managed an application for a while and a need arises.
The SERVICED_STORAGE_STATS_UPDATE_INTERVAL variable sets the interval for collecting kernel statistics about the application data thin pool. Its default value is unlikely to require a change until a need arises.
| Variable | Description | Purpose |
|---|---|---|
SERVICED_FS_TYPE |
The specifications of a devicemapper-based application data storage resource for production use. | Provide basic information about the data storage resource. |
SERVICED_FS_TYPE |
The specifications of a devicemapper-based application data storage resource for development use. | Provide basic information about the data storage resource. |
SERVICED_ISVCS_PATH |
The data storage paths of separate functional components of Control Center internal services. | Enable separate storage areas for one or more components. The default installation process puts all three components on the same device. |
SERVICED_SNAPSHOT_TTL |
The snapshot retention interval, the percentage of the data storage thin pool that is unused, and the snapshot attempt timeout interval. | Prevent the creation of snapshots that are too large to fit the thin pool. |
SERVICED_LOGSTASH_MAX_DAYS |
The variables that manage the amount of space used by the application log storage service. | Prevent application logs from filling the storage device that logstash uses. |
Internal services endpoint variables
The variables in the following table must be set identically on all Control Center delegate hosts.
The SERVICED_AUTH_TOKEN_EXPIRATION variable affects RPC, mux, and internal services endpoint traffic.
| Variable | Endpoint | Description |
|---|---|---|
| SERVICED_DOCKER_REGISTRY | (varies) | The local Docker registry for Control Center internal services images and application images. |
| SERVICED_ENDPOINT | Master-Host:4979 | The serviced RPC server. The endpoint port number must match the value of SERVICED_RPC_PORT. |
| SERVICED_LOG_ADDRESS | Master-Host:5042 | The logstash service. |
| SERVICED_LOGSTASH_ES | Master-Host:9100 | The Elasticsearch service for logstash. |
| SERVICED_STATS_PORT | Master-Host:8443 | The serviced metrics consumer service. |
| SERVICED_AUTH_TOKEN_EXPIRATION | (none) | The length of time a delegate authentication token is valid. |
RPC service variables
The variables in the following table must be set identically on all Control Center hosts, except:
-
SERVICED_RPC_PORT, set only on the master
-
SERVICED_MAX_RPC_CLIENTS, set only on delegates
By default, serviced uses TLS to encrypt all RPC traffic. The SERVICED_KEY_FILE and SERVICED_CERT_FILE variables identify the digital certificate used for RPC, mux, and HTTP traffic.
The SERVICED_AUTH_TOKEN_EXPIRATION variable affects RPC, mux, and internal services endpoint traffic.
| Variable | Where to set |
|---|---|
| SERVICED_ENDPOINT | Master, delegates |
| SERVICED_MAX_RPC_CLIENTS | Delegates |
| SERVICED_RPC_PORT | Master |
| SERVICED_RPC_CERT_VERIFY | Master, delegates |
| SERVICED_RPC_DISABLE_TLS | Master, delegates |
| SERVICED_RPC_TLS_MIN_VERSION | Master, delegates |
| SERVICED_RPC_TLS_CIPHERS | Master, delegates |
| SERVICED_KEY_FILE | Master |
| SERVICED_CERT_FILE | Master |
| SERVICED_RPC_DIAL_TIMEOUT | Master, delegates |
| SERVICED_AUTH_TOKEN_EXPIRATION | Master |
Multiplexer variables
The variables in the following table must be set identically on all Control Center hosts.
By default, serviced uses TLS to encrypt all mux traffic. The SERVICED_KEY_FILE and SERVICED_CERT_FILE variables identify the digital certificate used for RPC, mux, and HTTP traffic.
The SERVICED_AUTH_TOKEN_EXPIRATION variable affects RPC, mux, and internal services endpoint traffic.
| Variable | Where to set |
|---|---|
| SERVICED_MUX_PORT | Master, delegates |
| SERVICED_MUX_DISABLE_TLS | Master, delegates |
| SERVICED_MUX_TLS_MIN_VERSION | Master, delegates |
| SERVICED_MUX_TLS_CIPHERS | Master, delegates |
| SERVICED_KEY_FILE | Master |
| SERVICED_CERT_FILE | Master |
| SERVICED_AUTH_TOKEN_EXPIRATION | Master |
HTTP server variables
The variables in the following table are set only on the master host, except the SERVICED_UI_PORT variable, which must be set identically on all Control Center hosts.
By default, serviced uses TLS to encrypt all HTTP traffic. The SERVICED_KEY_FILE and SERVICED_CERT_FILE variables identify the digital certificate used for RPC, mux, and HTTP traffic.
| Variable | Description |
|---|---|
| SERVICED_UI_PORT | The port on which the HTTP server listens for requests. |
| SERVICED_TLS_MIN_VERSION | The minimum version of TLS that serviced accepts for HTTP traffic. |
| SERVICED_TLS_CIPHERS | The list TLS ciphers that serviced accepts for HTTP traffic. |
| SERVICED_KEY_FILE | The path of a digital certificate key file. |
| SERVICED_CERT_FILE | The path of a digital certificate file. |
Browser interface variables (master host only)
The variables in the following table are set only on the master host.
| Variable | Description |
|---|---|
| SERVICED_UI_POLL_FREQUENCY | The number of seconds between polls from browser interface clients. |
| SERVICED_SVCSTATS_CACHE_TIMEOUT | The number of seconds to cache statistics about services. |
| SERVICED_ADMIN_GROUP | The group on the master host whose members can use the browser interface. |
| SERVICED_ALLOW_ROOT_LOGIN | Determines whether root on the master host can use the browser interface. |
Tuning variables (master host only)
| Variable | Description |
|---|---|
| GOMAXPROCS | The maximum number of CPU cores that serviced uses. |
| SERVICED_ES_STARTUP_TIMEOUT | The number of seconds to wait for the Elasticsearch service to start. |
| SERVICED_MASTER_POOLID | The name of the default resource pool. This variable is only used the first time serviced is started. |