Starting the Store Web Docker container by retrieving parameters from Vault

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.
CONFIGURE_MODE The configure mode.
Accepted values are:
  • Vault for Vault configuration.
  • EnvVariables for environment variables configuration.
Set this value to Vault to use Vault configuration, and the configurations present within this reference.
 Container environment variable. This can be specified in the values.yaml configuration file under common.configureMode.
HCL Commerce Version 9.1.14.0 or laterEXTERNAL_DOMAIN_NAME The external domain name for the Store Web Docker container (store-web).

For example, mycompany.com

 Container environment variable. This can be specified in the values.yaml configuration file under common.externalDomain.
EXTERNAL_DOMAIN_NAME=${TENANT}${ENVIRONMENT}${ENVTYPE}{{Values.common.externalDomain }}

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}/externalDomainName This value specifies the store-web external domain name, which can be recognized by your browser.

For example, in the hostname store.demo4qaauth.hcl.com, hcl.com is the external domain name.

 EXTERNAL_DOMAIN_NAME
HCL Commerce Version 9.1.14.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/store-web/extraContentSecurityPolicySource Specify additional host names for the Content Security Policy (CSP) for the store-web container. The format of this value must conform to the content security policy source list standard.

Failure to specify CSP correctly will trigger Cross Site Scripting (XSS) protection in browsers. Third-party analytics, images, style sheets, or other scripts that are hosted on a secondary domain or third-party domain will fail to load in the browser, resulting in features of your site failing otherwise gracefully.

The default values supplied by HCL Commerce include your domain (EXTERNAL_DOMAIN_NAME), as well as analytics and file hosting from Google. Additional hostnames supplied via this variable include frame-ancestors, frame-src, default-src, child-src, script-src, connect-src, style-src, font-src and img-src definitions.

For example:
*.seconddomain.com
or
*.seconddomain.com *.thirdpartydomain.com
 EXTRA_CSP_SOURCE