Starting the Transaction server Docker container by retrieving parameters from Vault

Learn about how to start Transaction 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.

Note: You can also specify datasource credentials through the start up command if you do not want to retrieve the datasource values 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
STOREWEB_HOST	A unique hostname for use with Management Center Store preview. If you are using DC/OS, this is the internal DNS in DC/OS. For example, store-wytryqaauth.cn.ibm.com. Note: If you have multiple stores running on multiple domains, you can configure your domains to redirect to STOREWEB_HOST to ensure that preview works for all stores.	Container environment variable
SPIUSER_NAME	Your SPIUSER name. The default value is `spiuser`.	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
DBHOST	The database hostname.	Container environment variable/Vault
DBNAME	The name of the database.	Container environment variable/Vault
DBUSER	The database user name.	Container environment variable/Vault
DBPASS	The database user password.	Container environment variable/Vault
DBPORT	The database port.	Container environment variable/Vault
DBAUSER	The database administrator.	Container environment variable/Vault
DBAPASSENCRYPT	The database administrator password that is encrypted with wcs_encrypt.sh.	Container environment variable/Vault
DBPASSENCRYPT	The database user password that is encrypted with wcs_encrypt.sh.	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`.
DB_SSLENABLE	Determines whether to enable SSL protocol for connections to the database. Valid values are `true` or `false`. The default value is `false`. You can also specify datasource credentials through the start up command if you do not want to retrieve the datasource values from Vault.
DB_XA	Specify if the XA function has been enabled for database. Default value is false. You can also specify datasource credentials through the start up command if you do not want to retrieve the datasource values from Vault.
DBHOST_LIVE Note: If you need to point to a different live database, you need to specify all of the related parameters. You can also specify datasource credentials through the start up command if you do not want to retrieve the datasource values from Vault.	The database hostname in the live environment.
DBNAME_LIVE	The name of the database in the live environment.
DBPASS_LIVE	The database user password in the live environment.
DBPORT_LIVE	The database port in the live environment.
DBUSER_LIVE	The database user name in the live environment.
DB_SSLENABLE_LIVE	Determines whether to enable SSL protocol for connections to the live database. Valid values are `true` or `false`. The default value is `false`. You can also specify datasource credentials through the start up command if you do not want to retrieve the datasource values from Vault.
DB_XA_LIVE	Specify if the XA function has been enabled for the live database. The default value is `false`. You can also specify datasource credentials through the start up command if you do not want to retrieve the datasource values from Vault.
MERCHANTKEY_ENCRYPT	The encrypted merchant key value, encrypted with the key encryption key. The merchant key was created when you or an administrator loaded the HCL Commerce database schema. For more information, see: Loading the HCL Commerce database schema Generating encrypted data with the wcs_encrypt utility 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.
LOCALSTOREWEB	The web server host name of a local store if you migrated from WebSphere Commerce Version 7 or WebSphere Commerce Version 8.
HEALTH_CENTER_ENABLED	Determines whether Health Center is enabled. The default value is `false`.
adminPassword	The password for user configadmin, which is used to access the WebSphere Application Server Administrative Console.
TRACE_SPEC	Set 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.
SESSION_KEY_ENCRYPT	The encrypted session key.
	The Store server port number.
	The Redis server password.