December, 2024 release

Registry Docker container startup with Vault parameter retrieval

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

Mandatory environment variables

These are the mandatory environment variables that you must specify to configure the Registry Docker container to retrieve additional parameters from Vault. The /SETUP/bin/vaultConfigure.sh script retrieves the values 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.

Mandatory Vault configuration variables

These are the mandatory Vault key values that you must specify within Vault to configure the Registry Docker container to use the Vault configuration mode.

Vault path Description Reference Environment Variable
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchHost Specify an elasticSearchHost value. ELASTICSEARCH_HOST

Optional Vault configuration variables

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

Vault path Description Reference Environment Variable
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/domainName 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.

DOMAIN_NAME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/elasticSearchPort The elasticSearch service port.

The default value is 9200.

ELASTICSEARCH_PORT
${VAULT_URL}/${TENANT}/${ENVIRONMENT}elasticSearchScheme The elasticSearchScheme.

The default value is http.

ELASTICSEARCH_SCHEME
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/nifiHost The Nifi container host name.

The default value is nifi.

NIFI_HOST
${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