Customization server (xC) Docker container startup with Vault parameter retrieval

Learn about how to start Customization server (xC) Docker container by specifying CONFIGURE_MODE=Vault.

Mandatory environment variables

These are the mandatory environment variables that you must specify to configure the Customization server (xC) 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.

Mandatory Vault configuration variables

These are the mandatory Vault key values that you must specify within Vault to configure the Customization server (xC) Docker container to use the Vault configuration mode.

Vault path Description Reference Environment Variable
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/adminUser Admin user ADMIN_USER
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/adminPassword Admin password ADMIN_PASSWORD

Optional Vault configuration variables

These are the optional Vault key values that you can specify within Vault to configure the Customization server (xC) Docker container when used with the Vault configuration mode.

Vault path Description Reference Environment Variable
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/spiUsername Your SPIUSER name.

The default value is spiuser.

If BLANK than it will fall back to below value

${TENANT}/${ENVIRONMENT}/auth/spiUserName

 SPIUSER_NAME
${TENANT}/${ENVIRONMENT}/spiUserPwd SPI user password.

The encrypted password for the spiuser. For more information, see Configuring the spiuser password for Commerce+ Kubernetes Deployment.

If BLANK than it will fall back to below value

${TENANT}/${ENVIRONMENT}/auth/spiUserPwd

 SPIUSER_PWD
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/adminSpiUserPwd Admin SPI user password.

If BLANK or not specified than it will fallback to below value:

${TENANT}/${ENVIRONMENT}/${ENVTYPE}/adminSpiUserPwd

 ADMIN_SPIUSER_PWD
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/enableJsonLogging Enable JSON logging.

Value: true/false

 ENABLE_JSON_LOGGING
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/domainName Domain name

Default: default.svc.cluster.local

 DOMAIN_NAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txHost Transaction service host.

Default: ${TENANT}${ENVIRONMENT}${ENVTYPE}ts-app.${DOMAIN_NAME}

 TX_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txPort The Transaction server port number.

The default value is 5443.

TX_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/threadMonitorEnable/xc-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.
 THREAD_MONITOR_ENABLED
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/redisPasswordEncrypt The encrypted Redis password. REDIS_PASSWORD_ENCRYPT