Skip to content

Commit 21fc25b

Browse files
authored
add storage & db requirements (#346)
1 parent ff56894 commit 21fc25b

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

setup/requirements.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,29 @@ currently require the following versions _or newer_:
5353
If you're using [Remote IDEs](../workspaces/editors.md), allow pop-ups; Coder
5454
launches the Remote IDE in a pop-up window.
5555

56+
## Storage
57+
58+
Coder requires the use of a [persistent
59+
volume](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) in your
60+
Kubernetes cluster to store [workspaces](../workspaces/index.md) data. More
61+
specifically, the persistent volume claim (PVC) requires the block storage type
62+
(the PVC is created when you create the workspace to mount the requested block
63+
storage).
64+
65+
## Database
66+
67+
Coder requires a [PostgreSQL](https://www.postgresql.org) database to
68+
store metadata related to your deployment.
69+
70+
By default, Coder deploys a TimescaleDB internal to your Kubernetes cluster.
71+
This is included for evaluation purposes _only_, and it is _not_ backed up. For
72+
production deployments, we recommend using a PostgreSQL database _external_ to
73+
your cluster. You can connect Coder to your external database by [modifying the
74+
Helm chart](../guides/admin/helm-charts.md) with information regarding your
75+
PostgreSQL instance.
76+
77+
Coder requires, at minimum, PostgreSQL 11 with the `contrib` package installed.
78+
5679
## Network Policies
5780

5881
Coder uses

0 commit comments

Comments
 (0)