This guide walks you through deploying Coder with an external PostgreSQL database.

Background

For convenience and ease of installation, Coder's default Helm Chart settings will deploy a PostgreSQL database within the installation's Kubernetes namespace. This is useful for evaluation purposes; however, we recommend using an out-of-cluster database for production to streamline maintenance operations, such as backups and upgrades. The database state is not backed up and will be lost when deleting the Kubernetes namespace or cluster.

For optimal performance, it is important to ensure that the round-trip latency between the Coder control plane services and the database is low. We recommend ensuring that the database is within the same data center as the control plane, such as within the same cloud availability zone.

1. Set up a PostgreSQL database for use with Coder. If you do not already have an instance available, consider using the service from your cloud provider:

   • Amazon Relational Database Service (RDS)
   • Azure Database for PostgreSQL
   • Google Cloud SQL

2. Configure a private IP address for use with your PostgreSQL instance. You will set this in the Helm settings (values file)).

3. If your PostgreSQL instance requires a password, you will need to create a Kubernetes Secret containing the password:

   kubectl create secret generic <NAME> --from-file=password=/dev/stdin
   

   We recommend using the syntax provided above, which reads credentials from the console, to avoid inadvertently storing credentials in shell history files.

4. Get the port number for your PostgreSQL instance:

   SELECT *
   FROM pg_settings
   WHERE name = 'port';
   

5. Get the user of the PostgreSQL instance:

   \du
   

6. Get the name of the database within your PostgreSQL instance in which you're currently working:

   SELECT current_database();
   

7. Get the name of the secret you created for your PostgreSQL instance's password:

   kubectl get secrets --namespace=<your-coder-namespace>
   

Set the database name, port number, user, and password secret created in the prior steps in your Helm values file. Coder will use these credentials to connect to your PostgreSQL instance:

postgres:
  useDefault: false
  host: "<your-postgres-private-ip>"
  port: "<your-postgres-port>"
  user: "<your-postgres-user>"
  database: "<your-db-name>"
  passwordSecret: "<your-postgres-secret-name>"

At this point, you can install/upgrade your Coder instance using the updated Helm chart.

To install Coder for the first time:

helm install coder coder/coder --namespace=<your-coder-namespace> \
  --version=<VERSION> --values=current-values.yml --wait

To upgrade Coder:

helm upgrade coder coder/coder --namespace=<your-coder-namespace> \
  --version=<VERSION> --values=current-values.yml --wait

If the upgrade fails for any reason, please run the helm rollback command and contact our support team for assistance.

Once you complete this process, you'll be able to access Coder using the external IP address of the ingress controller in your cluster.