Starting the Ingest Docker container by retrieving parameters from Vault

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

Mandatory environment variables

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

Optional environment variables

These are the optional environment variables that you can specify to configure the Ingest Docker container.

All parameters that you specify as container environment variables take precedence over the values that are stored in Vault.

Environment variable name Description Comments
EXPOSE_METRICS Specify if you want to enable metrics for the environment.
Accepted values are:
  • true for enabled.
  • false for disabled.
The default value is set to true.
 Container environment variable. This can be specified in the values.yaml configuration file under metrics.enabled.

Mandatory Vault configuration variables

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

Vault path Description Reference Environment Variable
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchHost Specify an elasticSearchHost value. ELASTICSEARCH_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/zookeeperHost Specify a value if you want to set a zookeeperHost value, instead of using the default value. ZOOKEEPER_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/sessionKeyEncrypt
HCL Commerce Version 9.1.12.0 or laterNote: Now mandatory, this value was optional prior to HCL Commerce 9.1.12.0.
 The encrypted session key, encrypted with the key encryption key. The Session key was created when you or an administrator loaded the HCL Commerce database schema.
Important: You must specify your own Merchant key and key encryption key values for the security of your HCL Commerce installation. Do not use the default values contained within the provided sample configuration files and documentation examples.
 SESSION_KEY_ENCRYPT

Optional Vault configuration variables

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

Vault path Description Reference Environment Variable
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/domainName Specify the internal service domain name. If the deployed environment is on a special namespace on Kubernetes, then the domain name should be .svc.cluster.local.

If no value is specified, then the default, default.svc.cluster.local, is used.

 DOMAIN_NAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchPort Specify a value if you want to set an elasticSearchPort value, instead of using the default value. ELASTICSEARCH_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchScheme Specify a value if you want to set an elasticSearchScheme value, instead of using the default value. ELASTICSEARCH_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/zookeeperPort Specify a value if you want to set a zookeeperPort value, instead of using the default value.

The default value is 2181.

 ZOOKEEPER_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/zookeeperScheme Specify a value if you want to set a zookeeperScheme value, instead of using the default value.

The default value is http.

 ZOOKEEPER_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiHost Specify a value if you want to set the NiFi service host name. The default value is nifi service name. NIFI_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiPort Specify a value if you want to set the NiFi service port number. The default value is 30600. NIFI_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiScheme Specify a value if you want to set the NiFi service scheme. The default value is http. NIFI_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/registryHost Specify a value if you want to set the Registry service host name. The default value is registry service name. REGISTRY_HOST
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/registryPort Specify a value if you want to set the Registry service port number. The default value is 30400. REGISTRY_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/registryScheme Specify a value if you want to set the Registry service scheme. The default value is http. REGISTRY_SCHEME
HCL Commerce Version 9.1.15.0 or later${VAULT_URL}/${TENANT}/${ENVIRONMENT}/autoUpdatePipeVersion Specify whether to automatically update the Ingest server pipe version.
  • If set to true, then automatic upgrades to the latest version in the registry will occur during an Ingest restart, reverting all local changes.
  • If set to false, then no automatic upgrades will take place. You can still use Ingest APIs to reset and upgrade any pipe.

The default value is false.

 AUTO_UPDATE_PIPE_VERSION
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/search-ingest-app If you want to change the trace specification for the Transaction server, specify a value. TRACE_SPEC
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/healthCenterEnable/search-ingest-app Specify a value if you want to enable Health Center.
Accepted values are:
  • true for enabling Health Center.
  • false for not enabling Heather Center.
The default value is false.
 HEALTH_CENTER_ENABLED
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/threadMonitorEnable/search-ingest-app Specify a value if you want to enable Thread Monitor.
Accepted values are:
  • true for enabling Thread Monitor.
  • false for not enabling Thread Monitor.
The default value is false.
 THREAD_MONITOR_ENABLED