Starting the Search server Docker container by retrieving parameters from Vault

Learn about how to start Search 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. The default environment type value is auth. This value can also be set to 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
SOLR_MASTER

SOLR_SLAVE

 SOLR_MASTER and SOLR_SLAVE work together to determine the search node type. To configure the Search server container as:
  • Search-master node:
    SOLR_MASTER=true
SOLR_SLAVE=false
  • Search-repeater node:
    SOLR_MASTER=true
SOLR_SLAVE=true
  • Search-subordinate node:
    SOLR_MASTER=false
SOLR_SLAVE=true
 Container environment variable
SOLR_MASTER_SERVER_URL The IP and port of the search node to poll from. Mandatory for the search-repeater/subordinate on the live environment SOLR_SLAVE=true.
  • For the search-repeater node, specify the 
    search-master-ip:3737
  • For the search-subordinate node, specify the 
    search-repeater-ip:3737
 Container environment variable
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
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
ADMIN_SPIUSER_PWD The ADMIN_SPIUSER_PWD must be the same value as SPIUSER_PWD but kept as plain text. 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.
SOLR_REPLICATION_POLLINTERVAL The replication poll interval.
WORKAREA The search index path in the Search server Docker container. For example,
/search
TRACE_SPEC Sets trace specifications. For more information about trace, see Trace components
SESSION_KEY_ENCRYPT Encrypted session key.
HEALTH_CENTER_ENABLED Determines whether Health Center is enabled (true/false). Default value is false.
EXPOSE_METRICS Specify if you want to enable metrics for the commerce environment.
TX_HOST The Transaction server hostname.
TX_PORT The Transaction server port number.
STOREWEB_HOST The Store Web service host.
STOREWEB_PORT The Store Web service port number.
XC_HOST The Customization service hostname.
XC_PORT The Customization service port number.
DB_SSLENABLE Specifies whether to enable SSL protocol encryption for connections with 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 the 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.
DBTYPE The database type. Accepted values are db2 or oracle.

For more information about key-value data structure in Vault, see Environment data in Vault.