Understand and prepare the prerequisites

The following prerequisites are required to successfully deploy a client gateway using Helm charts:

1. A Kubernetes cluster containing a Postgres database

2. Familiarity with Helm CLI installation

3. A key vault service

A Kubernetes cluster containing a Postgres database

A postgres database and user (with read and write access) credentials are required. They are crucial environment variables for the client gateway application.

The postgres database connection string is required. It may look like something like:

postgresql://USER:PASSWORD@POSTGRES_HOST:5432/DATABASE_NAME

If you need help with deploy a self-hosted postgres server, please refer to the Postgres deployment guide.

Familiarity with Helm installation

Please refer to Helm’s guide to installing the Helm CLI and prerequisites.

A key vault service

The key vault service could be any one of the following options.

• Azure Key Vault

• AWS Secrets Manager

• Vault secrets engine

Whichever option is chosen, please see further guidance on how to obtain key vault access credentials for your chosen service.

Please use the values in the appropriate table below (click to expand) to configure the environment variables.

Azure Key Vault

Key	Type	Required	Value
SECRETS_ENGINE	String	true	azure
SECRET_PREFIX	String	false	ddhub/
AZURE_VAULT_URL	String	true	the key vault url, e.g. https://<VAULT NAME>.vault.azure.net
AZURE_CLIENT_ID	String	true	‘clientId’ of the service principle
AZURE_CLIENT_SECRET	String	true	'clientSecret' of the service principle
AZURE_TENANT_ID	String	true	'tenantId' of the service principle

AWS Secrets Manager

Key	Type	Required	Value
SECRETS_ENGINE	String	true	aws
SECRET_PREFIX	String	false	ddhub/
AWS_REGION	String	true	ap-southeast-2 (recommended)
AWS_ACCESS_KEY_ID	String	true	user’s access key id
AWS_SECRET_ACCESS_KEY	String	true	user’s secret access key

Vault Secrets Engine

Key	Type	Required	Value
SECRETS_ENGINE	String	true	vault
SECRET_PREFIX	String	false	ddhub/
VAULT_ENDPOINT	String	true	vault server address
VAULT_TOKEN	String	true	vault server access token