Ingest Docker container startup with Vault parameter retrieval

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`.

Optional environment variables

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


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 Ingest Docker container to use the Vault configuration mode.


Vault path	Description	Reference Environment Variable
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/`elasticSearchScheme	The Elasticsearch service scheme. The default value is `http`.	ELASTICSEARCH_SCHEME
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/`elasticSearchPort	The ElasticSearch port number.	ELASTICSEARCH_PORT
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/`elasticSearchHost	The ElasticSearch host name.	ELASTICSEARCH_HOST

Optional Vault configuration variables

Optional Vault parameters


Vault path	Description	Reference Environment Variable
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/registryHost`	Registry Container hostname. If Blank it will fall back to default value : `${TENANT}${ENVIRONMENT}registry-app.${DOMAIN_NAME}`	REGISTRY_HOST
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiHost`	The Nifi container host name. If Blank it will fall back to default value : `${TENANT}${ENVIRONMENT}nifi-app.${DOMAIN_NAME}`	NIFI_HOST
`${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 `${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
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/zookeeperPort`	The Zookeeper service port. The default value is `2181`.	ZOOKEEPER_PORT
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/zookeeperScheme`	The Zookeeper service scheme. The default value is `http`.	ZOOKEEPER_SCHEME
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiPort`	The Nifi service port. The default value is `30600`.	NIFI_PORT
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiScheme`	The Nifi service scheme. The default value is `http`.	NIFI_SCHEME
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/registryPort`	Specify the registry port. \	REGISTRY_PORT
`${VAULT_URL}/${TENANT}/${ENVIRONMENT}/registryScheme`	Specify the registry scheme.	REGISTRY_SCHEME