|
| 1 | +# Deploy Coder on Rancher |
| 2 | + |
| 3 | +You can deploy Coder on Rancher using a |
| 4 | +[Workload](https://ranchermanager.docs.rancher.com/getting-started/quick-start-guides/deploy-workloads/nodeports). |
| 5 | + |
| 6 | +## Requirements |
| 7 | + |
| 8 | +- [Rancher](https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade/install-upgrade-on-a-kubernetes-cluster) |
| 9 | + - alternative link: [Deploy Rancher Manager](https://ranchermanager.docs.rancher.com/getting-started/quick-start-guides/deploy-rancher-manager) |
| 10 | +- other requirements |
| 11 | + |
| 12 | +## Configure Rancher |
| 13 | + |
| 14 | +The first thing to do |
| 15 | + |
| 16 | +## Install Coder with Helm |
| 17 | + |
| 18 | +```shell |
| 19 | +helm repo add coder-v2 https://helm.coder.com/v2 |
| 20 | +``` |
| 21 | + |
| 22 | +Create a `values.yaml` with the configuration settings you'd like for your |
| 23 | +deployment. For example: |
| 24 | + |
| 25 | +```yaml |
| 26 | +coder: |
| 27 | + # You can specify any environment variables you'd like to pass to Coder |
| 28 | + # here. Coder consumes environment variables listed in |
| 29 | + # `coder server --help`, and these environment variables are also passed |
| 30 | + # to the workspace provisioner (so you can consume them in your Terraform |
| 31 | + # templates for auth keys etc.). |
| 32 | + # |
| 33 | + # Please keep in mind that you should not set `CODER_HTTP_ADDRESS`, |
| 34 | + # `CODER_TLS_ENABLE`, `CODER_TLS_CERT_FILE` or `CODER_TLS_KEY_FILE` as |
| 35 | + # they are already set by the Helm chart and will cause conflicts. |
| 36 | + env: |
| 37 | + - name: CODER_PG_CONNECTION_URL |
| 38 | + valueFrom: |
| 39 | + secretKeyRef: |
| 40 | + # You'll need to create a secret called coder-db-url with your |
| 41 | + # Postgres connection URL like: |
| 42 | + # postgres://coder:password@postgres:5432/coder?sslmode=disable |
| 43 | + name: coder-db-url |
| 44 | + key: url |
| 45 | + |
| 46 | + # (Optional) For production deployments the access URL should be set. |
| 47 | + # If you're just trying Coder, access the dashboard via the service IP. |
| 48 | + # - name: CODER_ACCESS_URL |
| 49 | + # value: "https://coder.example.com" |
| 50 | + |
| 51 | + #tls: |
| 52 | + # secretNames: |
| 53 | + # - my-tls-secret-name |
| 54 | +``` |
| 55 | + |
| 56 | +> You can view our |
| 57 | +> [Helm README](https://github.com/coder/coder/blob/main/helm#readme) for |
| 58 | +> details on the values that are available, or you can view the |
| 59 | +> [values.yaml](https://github.com/coder/coder/blob/main/helm/coder/values.yaml) |
| 60 | +> file directly. |
| 61 | +
|
| 62 | +We support two release channels: mainline and stable - read the |
| 63 | +[Releases](./releases.md) page to learn more about which best suits your team. |
| 64 | + |
| 65 | +- **Mainline** Coder release: |
| 66 | + |
| 67 | + <!-- autoversion(mainline): "--version [version]" --> |
| 68 | + |
| 69 | + ```shell |
| 70 | + helm install coder coder-v2/coder \ |
| 71 | + --namespace coder \ |
| 72 | + --values values.yaml \ |
| 73 | + --version 2.18.0 |
| 74 | + ``` |
| 75 | + |
| 76 | +- **Stable** Coder release: |
| 77 | + |
| 78 | + <!-- autoversion(stable): "--version [version]" --> |
| 79 | + |
| 80 | + ```shell |
| 81 | + helm install coder coder-v2/coder \ |
| 82 | + --namespace coder \ |
| 83 | + --values values.yaml \ |
| 84 | + --version 2.17.2 |
| 85 | + ``` |
| 86 | + |
| 87 | +You can watch Coder start up by running `kubectl get pods -n coder`. Once Coder |
| 88 | +has started, the `coder-*` pods should enter the `Running` state. |
| 89 | + |
| 90 | +## Log in to Coder |
| 91 | + |
| 92 | +Use `kubectl get svc -n coder` to get the IP address of the LoadBalancer. Visit |
| 93 | +this in the browser to set up your first account. |
| 94 | + |
| 95 | +If you do not have a domain, you should set `CODER_ACCESS_URL` to this URL in |
| 96 | +the Helm chart and upgrade Coder (see below). This allows workspaces to connect |
| 97 | +to the proper Coder URL. |
| 98 | + |
| 99 | +## Upgrading Coder in Rancher |
| 100 | + |
| 101 | +To upgrade Coder in the future or change values, you can run the following |
| 102 | +command: |
| 103 | + |
| 104 | +```shell |
| 105 | +helm repo update |
| 106 | +helm upgrade coder coder-v2/coder \ |
| 107 | + --namespace coder \ |
| 108 | + -f values.yaml |
| 109 | +``` |
| 110 | + |
| 111 | +## Coder Observability Chart |
| 112 | + |
| 113 | +Use the [Observability Helm chart](https://github.com/coder/observability) for a |
| 114 | +pre-built set of dashboards to monitor your control plane over time. It includes |
| 115 | +Grafana, Prometheus, Loki, and Alert Manager out-of-the-box, and can be deployed |
| 116 | +on your existing Grafana instance. |
| 117 | + |
| 118 | +We recommend that all administrators deploying on Kubernetes set the |
| 119 | +observability bundle up with the control plane from the start. For installation |
| 120 | +instructions, visit the |
| 121 | +[observability repository](https://github.com/coder/observability?tab=readme-ov-file#installation). |
| 122 | + |
| 123 | +## Next steps |
| 124 | + |
| 125 | +- [Create your first template](../tutorials/template-from-scratch.md) |
| 126 | +- [Control plane configuration](../admin/setup/index.md) |
0 commit comments