+Create a namespace for the Coder control plane. In this tutorial, we call it `coder`:
- Coder does not manage a database server for you. This is required for storing
- data about your Coder deployment and resources.
+```shell
+kubectl create namespace coder
+```
- ### Managed PostgreSQL (recommended)
+## Set up PostgreSQL
- If you're in a public cloud such as
- [Google Cloud](https://cloud.google.com/sql/docs/postgres/),
- [AWS](https://aws.amazon.com/rds/postgresql/),
- [Azure](https://docs.microsoft.com/en-us/azure/postgresql/), or
- [DigitalOcean](https://www.digitalocean.com/products/managed-databases-postgresql),
- you can use the managed PostgreSQL offerings they provide. Make sure that the
- PostgreSQL service is running and accessible from your cluster. It should be in
- the same network, same project, etc.
+Coder requires a PostgreSQL database to store deployment data.
+We recommend that you use a managed PostgreSQL service, but you can use an in-cluster PostgreSQL service for non-production deployments:
- ### In-Cluster PostgreSQL (for proof of concepts)
+
- You can install Postgres manually on your cluster using the
- [Bitnami PostgreSQL Helm chart](https://github.com/bitnami/charts/tree/master/bitnami/postgresql#readme).
- There are some [helpful guides](https://phoenixnap.com/kb/postgresql-kubernetes)
- on the internet that explain sensible configurations for this chart.
+### Managed PostgreSQL (Recommended)
- Here's one example:
+For production deployments, we recommend using a managed PostgreSQL service:
- ```console
- # Install PostgreSQL
- helm repo add bitnami https://charts.bitnami.com/bitnami
- helm install coder-db bitnami/postgresql \
- --namespace coder \
- --set auth.username=coder \
- --set auth.password=coder \
- --set auth.database=coder \
- --set persistence.size=10Gi
- ```
+- [Google Cloud SQL](https://cloud.google.com/sql/docs/postgres/)
+- [AWS RDS for PostgreSQL](https://aws.amazon.com/rds/postgresql/)
+- [Azure Database for PostgreSQL](https://docs.microsoft.com/en-us/azure/postgresql/)
+- [DigitalOcean Managed PostgreSQL](https://www.digitalocean.com/products/managed-databases-postgresql)
- The cluster-internal DB URL for the above database is:
+Ensure that your PostgreSQL service:
- ```shell
- postgres://coder:coder@coder-db-postgresql.coder.svc.cluster.local:5432/coder?sslmode=disable
- ```
+- Is running and accessible from your cluster
+- Is in the same network/project as your cluster
+- Has proper credentials and a database created for Coder
- Optionally, you can use the
- [Postgres operator](https://github.com/zalando/postgres-operator) to manage
- PostgreSQL deployments on your Kubernetes cluster.
+### In-Cluster PostgreSQL (Development/PoC)
-
+For proof-of-concept deployments, you can use Bitnami Helm chart to install PostgreSQL in your Kubernetes cluster:
-1. Create the PostgreSQL secret.
+```console
+helm repo add bitnami https://charts.bitnami.com/bitnami
+helm install coder-db bitnami/postgresql \
+ --namespace coder \
+ --set auth.username=coder \
+ --set auth.password=coder \
+ --set auth.database=coder \
+ --set persistence.size=10Gi
+```
- Create a secret with the PostgreSQL database URL string. In the case of the
- self-managed PostgreSQL, the address will be:
+After installation, the cluster-internal database URL will be:
- ```shell
- kubectl create secret generic coder-db-url -n coder \
- --from-literal=url="postgres://coder:coder@coder-db-postgresql.coder.svc.cluster.local:5432/coder?sslmode=disable"
- ```
+```text
+postgres://coder:coder@coder-db-postgresql.coder.svc.cluster.local:5432/coder?sslmode=disable
+```
+
+For more advanced PostgreSQL management, consider using the
+[Postgres operator](https://github.com/zalando/postgres-operator).
+
+