Store web Docker container startup with Vault parameter retrieval

Learn about how to start the Store web Docker container by specifying CONFIGURE_MODE=Vault.

Mandatory environment variables

These are the mandatory environment variables that you must specify to configure the Store web 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.
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 Store web Docker container when used with the Vault configuration mode.

Vault path Description Reference Environment Variable
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/domainName Internal cluster domain name.

Default: default.svc.cluster.local

 DOMAIN_NAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/externalDomainName External domain name.

Default: EXTERNAL_DOMAIN_IN_VAULT

 EXTERNAL_DOMAIN_NAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nextjsServiceHost Host for Next.js service.

If blank it will fall back to below value :

${TENANT}${ENVIRONMENT}${ENVTYPE}nextjs-app.${DOMAIN_NAME}

 NEXTJS_SERVICE_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txHost Host for transaction service.

If blank it will fall back to below value :

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

 TX_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryHost Host for search service.

If blank it will fall back to below value :

${TENANT}${ENVIRONMENT}${ENVTYPE}query-app.${DOMAIN_NAME}

 SEARCH_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/inventoryHost Host for inventory service.

If blank it will fall back to below value :

${TENANT}${ENVIRONMENT}liveinventory-app.${DOMAIN_NAME}

 INVENTORY_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/inventoryPort Port for inventory service.

Default: 11443

 INVENTORY_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/inventoryScheme Scheme for inventory service.

Default: https.

 INVENTORY_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/store-web/extraContentSecurityPolicySource Extra content security policy source. EXTRA_CSP_SOURCE
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txPort Port for transaction service.

Default: 5443

 TX_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryPort Port for search service.

Default: 30901

 SEARCH_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryScheme Scheme for search service.

Default: https.

 SEARCH_SCHEME