Starting the GraphQL Docker container by retrieving parameters from Vault

Learn about how to start GraphQL 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.

Note: You can also specify datasource credentials through the start up command if you do not want to retrieve the datasource values 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. Accepted values are auth and 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
ELASTICSEARCH_ENABLED Whether the Elasticsearch-based search solution is in use or not.
Accepted values are:
  • true for the Elasticsearch-based search solution;
  • Or false for the Solr-based search solution.
 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
TX_HOST The Transaction server host name.
TX_PORT The Transaction server port number.
QUERY_HOST The Query server hostname.
The default value is query.
Note: This parameter is only required if the Elasticsearch-based search solution is enabled.
QUERY_PORT The auth or live query server port.

The default value is 30901.
QUERY_SCHEME The auth or live query server scheme.

The default value is https.
DATA_QUERY_HOST The Data-query hostname.
The default value is data-query.
Note: This parameter is only required if the Elasticsearch-based search solution is enabled.
DATA_QUERY_PORT The Data Query server port.

The default value is 30901.
DATA_QUERY_SCHEME The Data Query server scheme.

The default value is https.
INGEST_HOST The Ingest service host name.
Note: This parameter is only required with the Elasticsearch-based search solution.
INGEST_PORT The Ingest service port number.
Note: This parameter is only required with the ealsticsearch-based search solution.
INGEST_SCHEME The Ingest service scheme.
Note: This parameter is only required with the Elasticsearch-based search solution.
SEARCH_HOST The Search server host name. This parameter value depends on which search service you are using, and the environment type.
SEARCH_PORT The Search server port number.
SEARCH_SCHEME The Search server scheme.

The default value is https.
XC_HOST The Customization server host name.
XC_PORT The Customization server port number.