Data Query Docker container startup with Vault parameter retrieval

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

Mandatory environment variables

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

Optional environment variables

These are the optional environment variables that you can specify to configure the Data Query 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.	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 Data Query Docker container to use the Vault configuration mode.


Parameter name (key)	Value	Reference Environment Variable
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/ingestPort`	The ingest port.	INGEST_PORT
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/ingestScheme`	The ingest scheme.	INGEST_SCHEME
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/txToolingPort`	The live transaction tooling port for `jwt` authentication check.	LIVE_TX_TOOLING_PORT
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nlpLemmatizationFeature`	The `NLP` Lemmatization feature.	NLP_LEMMATIZATION_FEATURE
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/toolingOrigin`	The tooling origin url. For Example: `https://tooling.demoqa.mycompany.com`	TOOLING_ORIGIN
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/toolingOrigin`	If Env type is `auth` or `null` then, specify tooling Origin. The tooling origin url. For Example: `https://tooling.demoqa.mycompany.com`	TOOLING_ORIGIN

Optional Vault configuration variables

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


Parameter name (key)	Value	Reference Environment Variable
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchPort`	The Elasticsearch service port. The default value is `9200`.	ELASTICSEARCH_PORT
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchScheme`	The Elasticsearch service scheme. The default value is `http`.	ELASTICSEARCH_SCHEME
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/enableFeatureNlp`	Enable natural language processing. This is hard coded to `false` for data-query.	ENABLE_FEATURE_NLP
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txPort`	The Transaction server port. The default value is `443`.	TX_PORT
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/txToolingHost`	The transaction tooling host for jwt authentication check. The default value is: `${VAULT_URL}/${TENANT}${Environment}authts-web.$DOMAIN_NAME`	TX_TOOLING_HOST
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/txToolingHost`	The auth transaction tooling host for jwt authentication check. The default value is: `${VAULT_URL}/${TENANT}${Environment}authts-web.$DOMAIN_NAME`	AUTH_TX_TOOLING_HOST
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/live/txToolingHost`	The live transaction tooling host for jwt authentication check. The default value is: `${VAULT_URL}/${TENANT}${Environment}livets-web.$DOMAIN_NAME`	LIVE_TX_TOOLING_HOST
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/toolingOrigin`	If EnvType is `“auth”` or `“null”` then, specify tooling Origin.	TOOLING_ORIGIN
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/auth/toolingBaseUrl`	If EnvType is `“null”` then, specify tooling base url.	TOOLING_BASE_URL
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/traceSpecification/search-query-app`	Set the trace specification.	traceSpec
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/threadMonitorEnable/${component_name}`	Enable thread monitor for a specific component.	THREAD_MONITOR_ENABLED
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/CACHEENVTYPE/redisPasswordEncrypt`	Specify encrypted redis password.	REDIS_PASSWORD_ENCRYPT
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/stanzaEnabled`	Specify if Stanza is enabled.	STANZA_ENABLED
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/stanzaHost`	If STANZA_ENABLED is true, then set stanza host. default value is: `${VAULT_URL}/${TENANT}${ENVIRONMENT}stanza-app.${DOMAIN_NAME}`	STANZA_HOST
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/stanzaPort`	If STANZA_ENABLED is true, then set stanza port.	STANZA_PORT
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/stanzaScheme`	If STANZA_ENABLED is true, then set stanza scheme.	STANZA_SCHEME