Skip to content
This repository was archived by the owner on Aug 18, 2025. It is now read-only.

Commit 6544415

Browse files
jawnsyKatie Horne
andauthored
chore: clarify version support policy (#232)
Recommend that users track supported Kubernetes versions, and remove the reference to version 1.13. Co-authored-by: Katie Horne <katie@coder.com>
1 parent fc26906 commit 6544415

File tree

5 files changed

+39
-20
lines changed

5 files changed

+39
-20
lines changed

admin/workspace-management/cvms.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ Google, Azure, and Amazon to support CVMs.
4444
To use CVMs with GKE, [create a cluster](../../setup/kubernetes/google.md) using
4545
the following parameters:
4646

47-
- GKE Master version `>= 1.17`
48-
- `node-version >= 1.17`
47+
- GKE Master version `latest`
48+
- `node-version = "latest"`
4949
- `image-type = "UBUNTU"`
5050

51-
You can also provide `latest` instead of specific version numbers. For example:
51+
For example:
5252

5353
```console
5454
gcloud beta container clusters create "YOUR_NEW_CLUSTER" \

guides/ssl-certificates/cloudflare.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,18 +22,14 @@ you can enable HTTPS on your Coder deployment.
2222

2323
You must have:
2424

25-
- A Kubernetes cluster (v1.15 or greater) with internet connectivity
25+
- A Kubernetes cluster [meeting Coder's
26+
requirements](../../setup/kubernetes/index.md) with internet connectivity
2627
- kubectl with patch version
2728
[greater than v1.18.8, v1.17.11, or v1.16.14](https://cert-manager.io/docs/installation/upgrading/upgrading-0.15-0.16/#issue-with-older-versions-of-kubectl)
2829

2930
## Step 1: Add cert-manager to your Kubernetes cluster
3031

3132
```console
32-
# Kubernetes 1.16+
33-
$ kubectl apply --validate=false -f \
34-
https://github.com/jetstack/cert-manager/releases/download/v1.0.1/cert-manager.yaml
35-
36-
# Kubernetes <1.16
3733
$ kubectl apply --validate=false -f \
3834
https://github.com/jetstack/cert-manager/releases/download/v1.0.1/cert-manager-legacy.yaml
3935
```

guides/ssl-certificates/route53.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ configure your Coder hostname and dev URLs.
2323

2424
You must have:
2525

26-
- A [Kubernetes cluster](../../setup/kubernetes/index.md) (v1.17 or greater)
27-
with internet connectivity
26+
- A Kubernetes cluster [meeting Coder's
27+
requirements](../../setup/kubernetes/index.md) with internet connectivity
2828
- [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
2929

3030
You should also:

setup/kubernetes/aws.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,14 @@ SSH_KEY_PATH="<PATH/TO/KEY>.pub"
8484
REGION="YOUR_REGION"
8585
```
8686

87-
The following will spin up a Kubernetes cluster using `eksctl`:
87+
The following will spin up a Kubernetes cluster using `eksctl` (be sure to
88+
update the parameters as necessary, especially the version number):
8889

8990
```console
9091

9192
eksctl create cluster \
9293
--name "$CLUSTER_NAME" \
93-
--version 1.17 \
94+
--version <version> \
9495
--region "$REGION" \
9596
--nodegroup-name standard-workers \
9697
--node-type t3.medium \
@@ -172,7 +173,7 @@ as a workspace deployment option, you'll need to
172173
kind: ClusterConfig
173174

174175
metadata:
175-
version: "1.17"
176+
version: "<YOUR_K8s_VERSION"
176177
name: <YOUR_CLUSTER_NAME>
177178
region: <YOUR_AWS_REGION>
178179

setup/kubernetes/index.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,35 @@
11
---
22
title: Kubernetes
3-
description: Learn how to set up a K8 cluster for your Coder deployment.
3+
description: Learn how to set up a Kubernetes cluster for your Coder deployment.
44
---
55

6-
You can install and deploy Coder onto any Kubernetes cluster (version 1.13.7+)
7-
that meets the [requirements](../requirements.md).
6+
This section contains guides for creating a compatible cluster on common cloud
7+
platforms, including Microsoft Azure, Google Cloud Platform, and Amazon Web
8+
Services. If you already have a Kubernetes cluster, you may wish to proceed to
9+
the [installation guide].
810

9-
To help you get up and running, Coder offers the following deployment guides (if
10-
you're already set up with a Kubernetes cluster, please proceed to
11-
[installation](../installation.md)):
11+
## Supported Kubernetes versions
12+
13+
You can deploy Coder to any [compatible Kubernetes cluster]. Coder follows the
14+
[Kubernetes upstream version support policy], and the latest stable release
15+
version of Coder supports the previous two minor releases as well as the current
16+
release of Kubernetes at time of publication.
17+
18+
Coder may run successfully with
19+
older versions of Kubernetes. However, we strongly recommend running one of the
20+
currently-supported versions so that you receive applicable fixes, including
21+
security updates, from the Kubernetes project maintainers.
22+
23+
Coder continuously removes usage of deprecated Kubernetes API versions once
24+
the minimum baseline version of Kubernetes supports the necessary features in
25+
a stable version. We follow this policy to ensure that Coder stops
26+
using deprecated features before they are removed from new versions of
27+
Kubernetes.
28+
29+
[compatible kubernetes cluster]: ../requirements.md
30+
[kubernetes upstream version support policy]:
31+
https://kubernetes.io/docs/setup/release/version-skew-policy/
32+
33+
[installation guide]: ../installation.md
1234

1335
<children></children>

0 commit comments

Comments
 (0)