Web server Docker container startup with Vault parameter retrieval

Learn about how to start Web server Docker container by specifying CONFIGURE_MODE=Vault.

Mandatory environment variables

These are the mandatory environment variables that you must specify to configure the Web server 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 optional m key values that you can specify within Vault to configure the Web server Docker container when used with the Vault configuration mode.

Vault path Description Reference Environment Variable
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txHost The Transaction server host name. TX_HOST

Optional Vault configuration variables

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

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

If no value is specified, then the default,

default.svc.cluster.local, is used.

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

The default value is 5443.

TX_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ts-web/extraContentSecurityPolicySource

Specify additional host names for the Content Security Policy (CSP) for the ts-web container. The format of these values must conform to the Content Security Policy source list standard.

Failure to correctly specify CSP values will trigger Cross-Site Scripting (XSS) protection in browsers. This means that third-party analytics, images, style sheets, or other scripts hosted on a secondary or third-party domain will fail to load, causing some features of your site to malfunction or fail gracefully.

The default values provided by Commerce+ include your domain (EXTERNAL_DOMAIN_NAME), as well as analytics and file hosting from Google. Additional hostnames specified via this variable apply to the following CSP directives:

  • frame-ancestors
  • frame-src
  • default-src
  • child-src
  • script-src
  • connect-src
  • style-src
  • font-src
  • img-src
definitions.

For example: *.seconddomain.comor*.seconddomain.com *.thirdpartydomain.com

 EXTRA_CSP_SOURCE