Starting the Store server Docker container by retrieving parameters from Vault

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

Mandatory parameters

These are the mandatory parameters that you need to specify to configure the container to retrieve more parameters from Vault.

Parameter name (key) Value Configuration
TENANT The name of the group that contains your set of environments. For example, MyCompany. Container environment variable
ENVIRONMENT The name of the environment. For example, Non-production. Container environment variable
ENVTYPE The environment type. Accepted values are auth and live. Container environment variable
VAULT_TOKEN The Vault token to use to connect to Vault and request certification from Vault PKI. Container environment variable
VAULT_URL The Vault URL to use to connect to Vault and request certification from Vault PKI. Container environment variable
SPIUSER_NAME Your SPIUSER name. The default value is spiuser.
Note: From version 9.1.7.0 onward, the SPIUSER_NAME parameter is optional. If it is not specified, then the default value is assumed.
Container environment variable/Vault
SPIUSER_PWD The encrypted password for the spiuser. For more information, see Setting the spiuser password in your Docker images. Container environment variable/Vault
ELASTICSEARCH_ENABLED Whether the elasticsearch-based search solution is in use or not. Accepted values are true or false. Container environment variable/Vault

Optional parameters

These are optional parameters. You can pass these parameters as container environment variables, or you can store them in Vault. If you store the key-value pairs in Vault, the /SETUP/bin/vaultConfigure.sh script retrieves the values from Vault. All parameters that you specify as container environment variables take precedence over the values that are stored in Vault.

Parameter name (key) Value
DOMAIN_NAME The internal service domain name. The default value is : default.svc.cluster.local. If the deployed environment is on a special namespace on Kubernetes, the domain name should be .svc.cluster.local.
SSLPort The remote store page redirect secure port.
NONSSLPort The remote store page redirect non-secure port.
TRACE_SPEC Sets trace specifications. For more information about trace, see Trace components
KAFKA_SERVERS
Note: The KAFKA_SERVERS, ZOOKEEPER_SERVERS, and KAFKA_TOPIC_PREFIX parameters must be provided together.
The Kafka server. Works with ZOOKEEPER_SERVERS if you want to configure the container to catch validation.
ZOOKEEPER_SERVERS Works with KAFKA_SERVERS, if you want to configure the container to catch validation.
KAFKA_TOPIC_PREFIX KAFKA_TOPIC_PREFIX is used to compose the queue name for the cache invalidation.
HEALTH_CENTER_ENABLED Specify whether Health Center is enabled. Accepted values are true and false.

The default value is false.

TX_HOST The Transaction server hostname.
TX_PORT The Transaction server port. The default value is 5443.
ADMIN_SPIUSER_PWD The ADMIN_SPIUSER_PWD must be the same value as SPIUSER_PWD but kept as plain text.
EXPOSE_METRICS Specify if you want to enable metrics for the commerce environment.
SEARCH_HOST The search service host name. This value depends on which search service you are using, and the environment type.
SEARCH_PORT The search service port number.
SEARCH_SCHEME The search service scheme. The default value is https.