Cache-app Docker container startup with Vault parameter retrieval

Learn about how to start the Cache-app Docker container by specifying CONFIGURE_MODE=Vault.

Mandatory environment variables

These are the mandatory environment variables that you must specify to configure the Cache-app Docker container to retrieve additional parameters from Vault.
Environment variable name Description Comments
TENANT The name of the group that contains your set of environments. For example, MyCompany. Container environment variable. This can be specified in the values.yaml configuration file under common.tenant.
ENVIRONMENT The name of the environment. For example, Non-production. Container environment variable. This can be specified in the values.yaml configuration file under common.environmentName.
ENVTYPE The environment type. Accepted values are auth and live. Container environment variable. This can be specified in the values.yaml configuration file under common.environmentType.
VAULT_TOKEN The Vault token to use to connect to Vault and request certification from Vault PKI. Container environment variable. This can be specified in the values.yaml configuration file under common.vaultToken.
VAULT_URL The Vault URL to use to connect to Vault and request certification from Vault PKI. Container environment variable. This can be specified in the values.yaml configuration file under common.vaultUrl.

Optional Vault configuration variables

These are the optional Vault key values that you can specify within Vault to configure the Cache-app Docker container when used with the Vault configuration mode.

Vault path Description Reference Environment Variable
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/domainName

Specify the internal service domain name. If the deployed environment is on a special namespace on Kubernetes, then the domain name should be .svc.cluster.local.

If no value is specified, then the default, default.svc.cluster.local, is used.

DOMAIN_NAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/externalDomainName

This value specifies the store-web external domain name, which can be recognized by your browser.

External domain name Default: EXTERNAL_DOMAIN_IN_VAULT		 EXTERNAL_DOMAIN_NAME
${VAULT_URL}/${VAULT_URL}/${TENANT}/${ENVIRONMENT}/enableJsonLogging

Enable JSON logging.

Accepted values are

  • true to enable JSON logging.
  • false to disable JSON logging
The default value is false. 		ENABLE_JSON_LOGGING
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/healthCenterEnable/cache-app

Specify a value if you want to enable Health Center.

Accepted values are:

  • true for enabling Health Center.
  • false for not enabling Heather Center.
 HEALTH_CENTER_ENABLED
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/threadMonitorEnable/cache-app

Specify a value if you want to enable Thread Monitor.

Accepted values are:

  • true for enabling Thread Monitor.
  • false for not enabling Thread Monitor.
  • The default value is false.
The default value is false. 		THREAD_MONITOR_ENABLED
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/cache-manager Logging level specifications. LOGGING_LEVEL_SPECS
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/redisPasswordEncrypt The encrypted Redis server password. REDIS_PASSWORD_ENCRYPT