values.yaml file
The values.yaml file allows for application customization when launching
into kubernetes using helm. The supported config options are divided in Environment Settings,
Start-Up Settings, Webserver Settings and Cluster Connection Settings. These are all explained
below:
The values listed below will be translated into snake_case and stored in the config.json
file.
Table A.2. Environment Settings
| Option | Description |
|---|---|
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. |
logType | Type of log to be written to the console. Supported values are console-edn |
version | Information attached to application logs |
Table A.3. Start-Up Settings
| Option | Description |
|---|---|
clustersConnectOnStart | When set to true, the dashboard will connect to the clusters on startup. (Recommended for development use only) |
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) |
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) |
Table A.4. Webserver Settings
| Option | Description |
|---|---|
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 | Ppath 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 | true/false (default false). Use ssl server |
sslPort | webserver https and websocket secure port. |
tokenLifetime | Time to live of authentication token in seconds. |
allowTokenRenewal | true/false - can the existing token be used to get a new one. defaults : true |
Table A.5. Cluster Connection Settings
| Option | Description |
|---|---|
hostnameValidation | Global default for SSL hostname validation (can be overridden per cluster) |
defaultRrestPort | Default REST port for clusters. |
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. |
defaultTcpPort | Default TCP port for clusters. |
The values listed below will be translated into snake_case and stored in the clusters.json
file.
Table A.6. Cluster Settings
| Option | Description |
|---|---|
api-password | API Admin Password |
api-user | API Admin User |
api-cert | Base64 encoded PEM certificate (encoded including BEGIN and END markers) |
api-port | Rest API port number for cluster. Default: 8090 |
api-ssl | Toggle SSL for API connections (true/false) |
cert | Base64 encoded PEM certificate (encoded including BEGIN and END markers) |
host | Initial host name to connect for a cluster discovery |
namespace | Optional namespace label |
ssl | Toggle SSL in TCP socket connections (true/false) |
tcp-port | TCP port number for cluster. Default: 11999 |
hostname-validation | Hostname validation with https connections (set false for self signed certificates) |
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.