Starting the GraphQL Docker container with default configurations
Learn about how to start the GraphQL Docker container by specifying
CONFIGURE_MODE=Vault
.
Mandatory environment variables
These are the mandatory environment variables that you must specify to configure the
GraphQL 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 . |
CONFIGURE_MODE | The configure mode. Accepted values are:
|
Container environment variable. This can be specified in the
values.yaml configuration file under
common.configureMode . |
Optional Vault configuration variables
These are the optional Vault key values that you can specify within Vault to configure the GraphQL Docker container when used with the Vault configuration mode.
Vault path | Description | Reference Environment Variable |
---|---|---|
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/domainName |
Specify the internal service domain name. If the deployed
environment is on a special namespace on Kubernetes, then the domain name should
be .svc.cluster.local. If no value is specified, then the
default, |
DOMAIN_NAME |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txHost |
The Transaction server host name. The default value
is |
TX_HOST |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/txPort |
The Transaction server port number. The default
value is |
TX_PORT |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryHost |
The Search server host name for the Elasticsearch-based search solution. Specify a value if you want to set queryHost, instead of using the default value. | SEARCH_HOST |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryPort |
The Search server port number for
the Elasticsearch-based search solution. Specify a value if you want to set
queryPort, instead of using the default value. The
default value is |
SEARCH_PORT |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/queryScheme |
The Search server scheme for the
Elasticsearch-based search solution. Specify a value if you want to set
queryScheme, instead of using the default value. The
default value is |
SEARCH_SCHEME |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ingestHost |
The Ingest service host name. | INGEST_HOST |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ingestPort |
The Ingest service port number. | INGEST_PORT |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/ingestScheme |
The Ingest service scheme. | INGEST_SCHEME |
|
The Search server hostname. The value in Vault that you set depends on the search solution and environment type that you are configuring. |
SEARCH_HOST |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchPort |
The Solr-based search solution Search server port number. The default value is 3738 . |
SEARCH_PORT |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/searchScheme |
The Solr-based search solution Search server scheme. The default value is https . |
SEARCH_SCHEME |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/xcHost |
Specify a value if you want to set a host name for the Customization server, instead of using the default value. | XC_HOST |
${VAULT_URL}/${TENANT}/${ENVIRONMENT}/${ENVTYPE}/xcPort |
Specify a value if you want to set a port number for the Customization server, instead of using the default value. | XC_PORT |