Starting the Tooling Web Docker container by retrieving parameters from Vault

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

Mandatory environment variables

These are the mandatory environment variables that you must specify to configure the Tooling 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.
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.
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.

Mandatory Vault configuration variables

These are the mandatory Vault key values that you must specify within Vault to configure the Tooling Web Docker container to use the Vault configuration mode.

Vault path Description Reference Environment Variable
HCL Commerce Version 9.1.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/deploymentType The deployment type.

This value is required when allowTelemetry value is yes, but is ignored if the allowTelemetry value is set to no.

Accepted values are:
  • development,
  • staging,
  • production.
Important: When starting the Tooling Web Docker container in versions 9.1.12.0 through 9.1.14.0, you must set the container deployment type. Failure to do so will prevent the container from starting. Ensure that you set the deployment type via the DEPLOYMENT_TYPE container environment variable, or in Vault at the following path ${VAULT_URL}/${TENANT}/${ENVIRONMENT}/deploymentType. Accepted values are development, staging, or production.
 DEPLOYMENT_TYPE

Optional Vault configuration variables

These are the optional Vault key values that you can specify within Vault to configure the Tooling 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.12.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/allowTelemetry Management Center for HCL Commerce in all releases 9.1.12.0 and greater now report business user analytics to HCL. This information assists HCL in the development of new features and the enhancement of existing business user tools.
Accepted values are:
  • yes, to enable Google Analytics.
  • no, to disable Google Analytics.

The default value is yes.

If enabled, the deploymentType parameter is required to be specified.

 ALLOW_TELEMETRY