The values.yaml file
The values.yaml file allows for application customization when launching into kubernetes using helm. The supported configuration settings
are divided into four areas:
- Environment
- Start-Up
- Webserver
- Cluster Connection.
These four are explained below:
Application Configuration
The values listed below will be translated into snake_case and stored in the config.json file.
Environment Settings
| Option | Description | default |
|---|---|---|
configpath | String, path to configuration file location. Defaults to /app/persistent/ for production | |
helm | When set to true, warns user on cluster configuration modifications through the UI. This is used when the dashboard is deployed via Helm and cluster configurations should only be managed through Helm values. Valid: true, false | |
logtype | Type of log to be written to the console. Valid: console-edn | |
version | Information attached to application logs |
Start-Up Settings
| Option | Description | default |
|---|---|---|
clustersConnectOnStart | When set to true, the dashboard will connect to the clusters on startup. (Recommended for development use only) Valid: true, false | |
topologyCleanOnExit | When set to true, the dashboard will clean the cluster topology cache on exit by writing an empty map to the cache file. (Recommended for development use only) Valid: true, false | |
topologyStartupDiscover | When set to true, the dashboard will discover clusters on startup. This includes a rest api call to the clusters in clusters.json file. (Recommended for development use only) Valid: true, false |
Webserver Settings
| Option | Description | default |
|---|---|---|
allowTokenRenewal | Can the existing token be used to get a new one? Default: true | Valid: true, false | |
browserPort | If SSL is terminated on the dashbaord, the browserPort should match the SSL port. If no SSL is used (not recommended), or you use an external load balancer, this value should match the appropriate port for this configuration. | |
domain | Domain that dashboard is hosted on (including subdomain) - cannot be empty ie. example.com | |
keystorePassword | Password of keystore file. (only relevant for ssl) | |
keystorePath | Path to the key store file that contains the TLS certificate for dashboard server. Keystore must be of type JKS (only relevant for ssl) | |
path | Directory path at which the dashboard server is expected to respond to. | |
port | Webserver http and websocket port | |
ssl | Use SSL server. Default: false | Valid: true, false | |
sslPort | Webserver https and websocket secure port. | |
tokenLifetime | Time to live of authentication token in seconds. |
Cluster Connection Settings
| Option | Description | default |
|---|---|---|
defaultRestPort | Default REST port for clusters. | |
defaultTcpPort | Default TCP port for clusters. | |
hostnameValidation | Global default for SSL hostname validation (can be overridden per cluster) | |
restTimeout | The amount of time Dashboard server waits for the cluster to respond to a single REST api request. Consider adjusting this higher for large clusters or clusters under heavy load to reliably make the first topology discovery and connection. |
Cluster Configuration
The values listed below will be translated into snake_case and stored in the clusters.json file.
Cluster Settings
| Option | Description | default |
|---|---|---|
api-ssl | Toggle SSL for API connections Valid: true, false | |
apiCert | Base64 encoded PEM certificate (encoded including BEGIN and END markers) | |
apiPassword | API Admin Password | |
apiPort | Rest API port number for cluster Default: 8090 | |
apiUser | API Admin User | |
cert | Base64 encoded PEM certificate (encoded including BEGIN and END markers) | |
host | Initial host name to connect for a cluster discovery | |
hostnameValidation | Hostname validation with https connections (set false for self signed certificates) | |
namespace | Optional namespace label | |
ssl | Toggle SSL in TCP socket connections Valid: true, false | |
tcpPort | TCP port number for cluster. Default: 11999 |
User Configuration
The values listed below will be translated into snake_case and stored in the users.json file. Passwords in the final deployment will be
encrypted.