values.yaml step and small edits

This commit is contained in:
EdwardAngert
2025-02-27 04:30:19 +00:00
parent 735e22182c
commit 5412a0ce88

View File

@ -61,7 +61,7 @@ You can deploy Coder on Rancher as a
postgres://coder:coder@coder-db-postgresql.coder.svc.cluster.local:5432/coder?sslmode=disable
```
You can optionally use the
Optionally, you can use the
[Postgres operator](https://github.com/zalando/postgres-operator) to manage
PostgreSQL deployments on your Kubernetes cluster.
@ -79,21 +79,93 @@ You can deploy Coder on Rancher as a
1. Select the target workload K8s cluster for Coder in the Rancher Manager console and access the Kubectl shell.
1. From the Cluster Manager console, go to **Apps** > **Charts** and select **Partners**.
1. From the **Cluster Manager** console, go to **Apps** > **Charts**
1. From the Chart providers, search for Coder.
1. Select **Partners** from the drop-down menu and search for `Coder`.
1. Select **Coder**, then **Install**.
1. Select the target namespace you created for Coder and select **Customize Helm options before install**, then **Next**.
1. Configure Values used by Helm that help define the Coder App. Review step 4 from the standard Kubernetes installation for suggested values, then Next.
1. Configure Values used by Helm that help define the Coder App.
1. Accept the defaults on the last pane and select Install.
Select **Edit YAML** and enter configuration settings for your deployment.
<details><summary>Expand for an example `values.yaml`</summary>
<!-- from kubernetes.md -->
```yaml
coder:
# You can specify any environment variables you'd like to pass to Coder
# here. Coder consumes environment variables listed in
# `coder server --help`, and these environment variables are also passed
# to the workspace provisioner (so you can consume them in your Terraform
# templates for auth keys etc.).
#
# Please keep in mind that you should not set `CODER_HTTP_ADDRESS`,
# `CODER_TLS_ENABLE`, `CODER_TLS_CERT_FILE` or `CODER_TLS_KEY_FILE` as
# they are already set by the Helm chart and will cause conflicts.
env:
- name: CODER_PG_CONNECTION_URL
valueFrom:
secretKeyRef:
# You'll need to create a secret called coder-db-url with your
# Postgres connection URL like:
# postgres://coder:password@postgres:5432/coder?sslmode=disable
name: coder-db-url
key: url
# (Optional) For production deployments the access URL should be set.
# If you're just trying Coder, access the dashboard via the service IP.
# - name: CODER_ACCESS_URL
# value: "https://coder.example.com"
#tls:
# secretNames:
# - my-tls-secret-name
```
> You can view our
> [Helm README](https://github.com/coder/coder/blob/main/helm#readme) for
> details on the values that are available, or you can view the
> [values.yaml](https://github.com/coder/coder/blob/main/helm/coder/values.yaml)
> file directly.
We support two release channels: mainline and stable - read the
[Releases](./releases.md) page to learn more about which best suits your team.
- **Mainline** Coder release:
<!-- autoversion(mainline): "--version [version]" -->
```shell
helm install coder coder-v2/coder \
--namespace coder \
--values values.yaml \
--version 2.19.0
```
- **Stable** Coder release:
<!-- autoversion(stable): "--version [version]" -->
```shell
helm install coder coder-v2/coder \
--namespace coder \
--values values.yaml \
--version 2.18.5
```
</details>
Select **Next** when you're done.
1. On the **Supply additional deployment options** screen, accept the default settings, then select **Install**.
A Helm install output shell will be displayed and should indicate success when completed.
1. To update a Coder deployment, select Coder from the Installed Apps and update as desired.
In the future, if you need to update a Coder deployment, select Coder from **Installed Apps** and use the options in the **⋮** menu.
## Next steps