| gio | 932849f | 2024-08-02 09:01:48 +0400 | [diff] [blame^] | 1 | # Coder Helm Chart |
| 2 | |
| 3 | This directory contains the Helm chart used to deploy Coder onto a Kubernetes |
| 4 | cluster. It contains the minimum required components to run Coder on Kubernetes, |
| 5 | and notably (compared to Coder Classic) does not include a database server. |
| 6 | |
| 7 | ## Getting Started |
| 8 | |
| 9 | > **Warning**: The main branch in this repository does not represent the |
| 10 | > latest release of Coder. Please reference our installation docs for |
| 11 | > instructions on a tagged release. |
| 12 | |
| 13 | View |
| 14 | [our docs](https://coder.com/docs/coder-oss/latest/install/kubernetes) |
| 15 | for detailed installation instructions. |
| 16 | |
| 17 | ## Values |
| 18 | |
| 19 | Please refer to [values.yaml](values.yaml) for available Helm values and their |
| 20 | defaults. |
| 21 | |
| 22 | A good starting point for your values file is: |
| 23 | |
| 24 | ```yaml |
| 25 | coder: |
| 26 | # You can specify any environment variables you'd like to pass to Coder |
| 27 | # here. Coder consumes environment variables listed in |
| 28 | # `coder server --help`, and these environment variables are also passed |
| 29 | # to the workspace provisioner (so you can consume them in your Terraform |
| 30 | # templates for auth keys etc.). |
| 31 | # |
| 32 | # Please keep in mind that you should not set `CODER_HTTP_ADDRESS`, |
| 33 | # `CODER_TLS_ENABLE`, `CODER_TLS_CERT_FILE` or `CODER_TLS_KEY_FILE` as |
| 34 | # they are already set by the Helm chart and will cause conflicts. |
| 35 | env: |
| 36 | - name: CODER_ACCESS_URL |
| 37 | value: "https://coder.example.com" |
| 38 | - name: CODER_PG_CONNECTION_URL |
| 39 | valueFrom: |
| 40 | secretKeyRef: |
| 41 | # You'll need to create a secret called coder-db-url with your |
| 42 | # Postgres connection URL like: |
| 43 | # postgres://coder:password@postgres:5432/coder?sslmode=disable |
| 44 | name: coder-db-url |
| 45 | key: url |
| 46 | |
| 47 | # This env enables the Prometheus metrics endpoint. |
| 48 | - name: CODER_PROMETHEUS_ADDRESS |
| 49 | value: "0.0.0.0:2112" |
| 50 | tls: |
| 51 | secretNames: |
| 52 | - my-tls-secret-name |
| 53 | ``` |