Tooling web Docker container startup with Vault parameter retrieval

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.

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
${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
 DEPLOYMENT_TYPE
${TENANT}/${ENVIRONMENT}/allowTelemetry The allow telemetry flag. ALLOW_TELEMETRY
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/rfqBaseUrl The auth quotes base URL.

If blank it will fall back to below value :

https://rfq.${TENANT}${ENVIRONMENT}auth.${EXTERNAL_DOMAIN_NAME}

 AUTH_QUOTES_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/rfqBaseUrl The live quotes base URL.

If blank it will fall back to below value :

https://rfq.${TENANT}${ENVIRONMENT}live.${EXTERNAL_DOMAIN_NAME}

 LIVE_QUOTES_BASE_URL

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 The external domain name.

Default: EXTERNAL_DOMAIN_IN_VAULT

EXTERNAL_DOMAIN_NAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/searchQueryBaseUrl The auth search query base URL. AUTH_SEARCH_QUERY_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/queryHost The auth query host.

If blank it will fall back to below value :

query. ${TENANT}${ENVIRONMENT}auth.${EXTERNAL_DOMAIN_NAME}

AUTH_QUERY_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/queryPort The auth query port.

Default: 443

AUTH_QUERY_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/searchQueryBaseUrl The live search query base URL. LIVE_SEARCH_QUERY_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/queryHost The live query host.

If blank it will fall back to below value :

query. ${TENANT}${ENVIRONMENT}live.${EXTERNAL_DOMAIN_NAME}

LIVE_QUERY_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/queryPort The live query port.

Default: 443

 LIVE_QUERY_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/searchDataQueryBaseUrl The search data query base URL. SEARCH_DATA_QUERY_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/queryHost The data query host.

If blank it will fall back to below value :

data-query.${TENANT}${ENVIRONMENT}.${EXTERNAL_DOMAIN_NAME}

DATA_QUERY_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/queryPort The data query port.

Default: 443

 DATA_QUERY_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/reactStoreBaseUrl The auth React store base URL.

If blank it will fall back to below value :

https://AUTHREACTSTOREHOST:AUTH_REACT_STORE_HOST:{AUTH_REACT_STORE_PORT}

 AUTH_REACT_STORE_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/reactStoreHost The auth React store host.

If blank it will fall back to below value :

www.${TENANT}${ENVIRONMENT}auth.${EXTERNAL_DOMAIN_NAME}

AUTH_REACT_STORE_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/reactStorePort The auth React store port.

Default: 443

 AUTH_REACT_STORE_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/reactStoreBaseUrl

The live React store base URL.

Default: https://${LIVE_REACT_STORE_HOST}:${LIVE_REACT_STORE_PORT}

LIVE_REACT_STORE_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/reactStoreHost The live React store host.

Default: www.${TENANT}${ENVIRONMENT}live.${EXTERNAL_DOMAIN_NAME}

 LIVE_REACT_STORE_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/reactStorePort The live React store port.

Default: 443

 LIVE_REACT_STORE_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/reactStorePreviewBaseUrl

The React store preview base URL.

If blank it will fall back to below value :

https://${REACT_STORE_PREVIEW_HOST}:${REACT_STORE_PREVIEW_PORT}

 REACT_STORE_PREVIEW_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/reactStorePreviewHost The React store preview host.

If blank it will fall back to below value :

store-preview.${TENANT}${ENVIRONMENT}auth.${EXTERNAL_DOMAIN_NAME}

REACT_STORE_PREVIEW_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/reactStorePreviewPort The React store preview port.

Default: 443

REACT_STORE_PREVIEW_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/transactionBaseUrl The auth transaction base URL.

Default: https://${AUTH_TRANSACTION_HOST}

 AUTH_TRANSACTION_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/transactionHost The auth transaction host.

If blank it will fall back to below value :

cmc.${TENANT}${ENVIRONMENT}auth.${EXTERNAL_DOMAIN_NAME}

AUTH_TRANSACTION_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/transactionBaseUrl The live transaction base URL.

Default: https://${LIVE_TRANSACTION_HOST}

LIVE_TRANSACTION_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/transactionHost The live transaction host.

If blank it will fall back to below value :

cmc.${TENANT}${ENVIRONMENT}live.${EXTERNAL_DOMAIN_NAME}

LIVE_TRANSACTION_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/keycloakBaseUrl The auth Keycloak base URL.

Default: https://keycloak.${TENANT}${ENVIRONMENT}auth.${EXTERNAL_DOMAIN_NAME}

AUTH_KEYCLOAK_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/keycloakBaseUrl The live Keycloak base URL.

If blank it will fall back to below value :

https://keycloak.${TENANT}${ENVIRONMENT}live.${EXTERNAL_DOMAIN_NAME}

LIVE_KEYCLOAK_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/pluginBaseUrl The auth plugin base URL.

If blank it will fall back to below value :

https://plugin.${TENANT}${ENVIRONMENT}auth.${EXTERNAL_DOMAIN_NAME}

AUTH_PLUGIN_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/pluginBaseUrl The live plugin base URL.

If blank it will fall back to below value :

https://plugin.${TENANT}${ENVIRONMENT}live.${EXTERNAL_DOMAIN_NAME}

LIVE_PLUGIN_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/toolingCommonPort The tooling common port.

Default value: 443
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/tooling-web/extraContentSecurityPolicySource The extra content security policy source.

Default value: ""

 EXTRA_CSP_SOURCE
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/inventoryBaseUrl The inventory base URL.

If blank it will fall back to below value :

https://inventory.${TENANT}${ENVIRONMENT}live.${EXTERNAL_DOMAIN_NAME}

INVENTORY_BASE_URL
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/toolingCommonDomainName
Note: This vault key is a mandatory vault configuration if the tooling web is being deployed on the cloud using the tooling bootstrap docker image.

This key specifies the URL of the cloud-based Tooling Common deployment.

For example: tooling-common.prd.hclcommercecloud.com

 TOOLING_COMMON_DOMAIN_NAME