Skip to content

Commit 03f143c

Browse files
author
Katie Horne
authored
chore: expand upgrade instructions for 1.21 (#523)
1 parent 61fd652 commit 03f143c

File tree

1 file changed

+89
-3
lines changed

1 file changed

+89
-3
lines changed

setup/updating.md

Lines changed: 89 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,49 @@ This guide will show you how to update your Coder deployment.
4040

4141
## Update Coder
4242

43-
To update Coder, follow these steps:
43+
1. Retrieve the latest repository information:
44+
45+
```console
46+
helm repo update
47+
```
48+
49+
1. Export your current Helm chart values into a file:
50+
51+
```console
52+
helm get values --namespace coder coder > current-values.yaml
53+
```
54+
55+
> Make sure that your values only contain the changes you want (e.g., if you
56+
> see references to a prior version, you may need to remove these).
57+
58+
1. Provide your Helm chart values file and upgrade to the desired version (e.g.,
59+
1.21.0):
60+
61+
_Note: If you omit `--version`, you'll upgrade to the latest version._
62+
63+
```console
64+
helm upgrade --namespace coder --install --atomic --wait \
65+
--version <version> coder coder/coder --values current-values.yaml
66+
```
67+
68+
1. Set Helm value `coderd.serviceNext=true` in your Helm chart. To do so, open
69+
up `current-values.yaml` and add the following:
70+
71+
```yaml
72+
coderd:
73+
serviceNext: true
74+
```
75+
76+
1. Update Coder with your new Helm chart:
77+
78+
```console
79+
helm upgrade coder coder/coder -n coder --version=<VERSION> --values current-values.yaml
80+
```
81+
82+
### Updating Coder when using a custom ingress controller
83+
84+
If you're using a custom ingress controller, the upgrade process from 1.20 to
85+
1.21 requires a few more steps:
4486

4587
1. Retrieve the latest repository information:
4688

@@ -58,15 +100,59 @@ To update Coder, follow these steps:
58100
> see references to a prior version, you may need to remove these).
59101
60102
1. Provide your Helm chart values file and upgrade to the desired version (e.g.,
61-
1.16.1):
103+
1.21.0):
62104

63105
_Note: If you omit `--version`, you'll upgrade to the latest version._
64106

65107
```console
66108
helm upgrade --namespace coder --install --atomic --wait \
67-
--version 1.16.1 coder coder/coder --values current-values.yaml
109+
--version <version> coder coder/coder --values current-values.yaml
110+
68111
```
69112

113+
1. [Update your Helm chart](../guides/admin/helm-charts.md) via the steps below.
114+
Refer to the `1.21`
115+
[helm chart](https://github.com/cdr/enterprise-helm/blob/main/values.yaml)
116+
when making such changes:
117+
118+
Rename all instances of `cemanager` to `coderd`.
119+
120+
Redirect all traffic from your custom ingress to `coderd`.
121+
122+
`coderd` now serves TLS certificates; to upgrade the NGINX ingress
123+
controller, set `coderd.serviceNext` to `true`. (See our
124+
[TLS certificates](../guides/tls-certificates/index.md) for more information
125+
on how to configure Coder to issue and use certificates.)
126+
127+
> To manage SSH, go to **Manage** > **Providers**. Select the provider you
128+
> want to modify, click the **vertical ellipses** to its right, and click
129+
> **Edit**. Under **Features**, you can toggle **External Connect** on/off.
130+
>
131+
> To manage the Access URL, go to **Manage** > **Admin** >
132+
> **Infrastructure**.
133+
134+
1. Redirect traffic by updating the following ports:
135+
136+
Move TCP port `8080` to `80`.
137+
138+
Move TCP port `8443` to `443`.
139+
140+
1. Update Coder with your new Helm chart values:
141+
142+
```console
143+
helm upgrade coder coder/coder -n coder --version=<VERSION> --values current-values.yaml
144+
```
145+
146+
1. Upgrade workspaces to use Coder's new Networking v2 functionality.
147+
148+
If you're using only the built-in provider and don't have additional
149+
workspace providers, go to Manage > Providers. Find your provider, click the
150+
**vertical ellipses** to its right, and click **Edit**. Toggle **Networking
151+
v2** to enable.
152+
153+
Alternatively, if your workspaces are distributed, migrate the providers to
154+
[satellites](../admin/satellites/index.md).
155+
70156
## Fixing a failed upgrade
71157

72158
While upgrading, the process may fail. You'll see an error message similar to

0 commit comments

Comments
 (0)