From 625675d77eab4e31da92fe23d5e26a6bb97a2a95 Mon Sep 17 00:00:00 2001 From: Jonathan Yu Date: Thu, 1 Apr 2021 03:52:10 +0000 Subject: [PATCH 1/5] chore: clarify version support policy Recommend that users track supported Kubernetes versions, and remove the reference to version 1.13. --- setup/kubernetes/index.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/setup/kubernetes/index.md b/setup/kubernetes/index.md index 753669b3d..cd7ffbc3a 100644 --- a/setup/kubernetes/index.md +++ b/setup/kubernetes/index.md @@ -1,13 +1,24 @@ --- title: Kubernetes -description: Learn how to set up a K8 cluster for your Coder deployment. +description: Learn how to set up a Kubernetes cluster for your Coder deployment. --- -You can install and deploy Coder onto any Kubernetes cluster (version 1.13.7+) -that meets the [requirements](../requirements.md). +You can deploy Coder into any [compatible Kubernetes cluster]. Coder follows the +[Kubernetes upstream version support policy] and the latest stable release +version of Coder supports the previous two minor releases as well as the current +release. While Coder may run on older versions of Kubernetes, we strongly +recommend running one of the supported versions, in order to receive applicable +fixes, including security fixes, from the project maintainers. -To help you get up and running, Coder offers the following deployment guides (if -you're already set up with a Kubernetes cluster, please proceed to -[installation](../installation.md)): +[compatible kubernetes cluster]: ../requirements.md +[kubernetes upstream version support policy]: + https://kubernetes.io/docs/setup/release/version-skew-policy/ + +This section contains guides for creating a compatible cluster on common cloud +platforms, including Microsoft Azure, Google Cloud Platform, and Amazon Web +Services. If you already have a Kubernetes cluster, you may wish to proceed to +the [installation guide]. + +[installation guide]: ../installation.md From 185b308a32f0fb4179b054a537e59721e2e93010 Mon Sep 17 00:00:00 2001 From: Jonathan Yu Date: Sat, 10 Jul 2021 22:10:45 +0000 Subject: [PATCH 2/5] elaborate on support policy --- setup/kubernetes/index.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/setup/kubernetes/index.md b/setup/kubernetes/index.md index cd7ffbc3a..02760ae69 100644 --- a/setup/kubernetes/index.md +++ b/setup/kubernetes/index.md @@ -4,21 +4,28 @@ description: Learn how to set up a Kubernetes cluster for your Coder deployment. --- You can deploy Coder into any [compatible Kubernetes cluster]. Coder follows the -[Kubernetes upstream version support policy] and the latest stable release +[Kubernetes upstream version support policy], and the latest stable release version of Coder supports the previous two minor releases as well as the current -release. While Coder may run on older versions of Kubernetes, we strongly -recommend running one of the supported versions, in order to receive applicable -fixes, including security fixes, from the project maintainers. +release of Kubernetes at time of publication. Coder may run successfully with +older versions of Kubernetes, however, we strongly recommend running one of the +currently-supported versions, in order to receive applicable fixes, including +security fixes, from the Kubernetes project maintainers. -[compatible kubernetes cluster]: ../requirements.md -[kubernetes upstream version support policy]: - https://kubernetes.io/docs/setup/release/version-skew-policy/ +Coder continuously removes usage of deprecated Kubernetes API versions once +the minimum baseline version of Kubernetes supports the necessary features in +a stable version. We follow this policy in order to ensure that Coder stops +using deprecated features before they are removed from new versions of +Kubernetes. This section contains guides for creating a compatible cluster on common cloud platforms, including Microsoft Azure, Google Cloud Platform, and Amazon Web Services. If you already have a Kubernetes cluster, you may wish to proceed to the [installation guide]. +[compatible kubernetes cluster]: ../requirements.md +[kubernetes upstream version support policy]: + https://kubernetes.io/docs/setup/release/version-skew-policy/ + [installation guide]: ../installation.md From dafadbee8a71ba0d5a566f07602cc64e42716b0a Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Mon, 12 Jul 2021 16:38:12 -0500 Subject: [PATCH 3/5] update info on Cloudflare page --- guides/ssl-certificates/cloudflare.md | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/guides/ssl-certificates/cloudflare.md b/guides/ssl-certificates/cloudflare.md index f94a83cda..53f2cc847 100644 --- a/guides/ssl-certificates/cloudflare.md +++ b/guides/ssl-certificates/cloudflare.md @@ -22,18 +22,13 @@ you can enable HTTPS on your Coder deployment. You must have: -- A Kubernetes cluster (v1.15 or greater) with internet connectivity +- A Kubernetes cluster (v1.17 or greater) with internet connectivity - kubectl with patch version [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) ## Step 1: Add cert-manager to your Kubernetes cluster ```console -# Kubernetes 1.16+ -$ kubectl apply --validate=false -f \ -https://github.com/jetstack/cert-manager/releases/download/v1.0.1/cert-manager.yaml - -# Kubernetes <1.16 $ kubectl apply --validate=false -f \ https://github.com/jetstack/cert-manager/releases/download/v1.0.1/cert-manager-legacy.yaml ``` From 42e27fe46bb85e8511514510c56de7d1eb3c9bd7 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Mon, 12 Jul 2021 16:49:51 -0500 Subject: [PATCH 4/5] update add'l K8s version refs --- admin/workspace-management/cvms.md | 6 +++--- guides/ssl-certificates/cloudflare.md | 3 ++- guides/ssl-certificates/route53.md | 4 ++-- setup/kubernetes/aws.md | 7 ++++--- 4 files changed, 11 insertions(+), 9 deletions(-) diff --git a/admin/workspace-management/cvms.md b/admin/workspace-management/cvms.md index 9a071b75e..9201e6ad7 100644 --- a/admin/workspace-management/cvms.md +++ b/admin/workspace-management/cvms.md @@ -44,11 +44,11 @@ Google, Azure, and Amazon to support CVMs. To use CVMs with GKE, [create a cluster](../../setup/kubernetes/google.md) using the following parameters: -- GKE Master version `>= 1.17` -- `node-version >= 1.17` +- GKE Master version `latest` +- `node-version = "latest"` - `image-type = "UBUNTU"` -You can also provide `latest` instead of specific version numbers. For example: +For example: ```console gcloud beta container clusters create "YOUR_NEW_CLUSTER" \ diff --git a/guides/ssl-certificates/cloudflare.md b/guides/ssl-certificates/cloudflare.md index 53f2cc847..37d0a1100 100644 --- a/guides/ssl-certificates/cloudflare.md +++ b/guides/ssl-certificates/cloudflare.md @@ -22,7 +22,8 @@ you can enable HTTPS on your Coder deployment. You must have: -- A Kubernetes cluster (v1.17 or greater) with internet connectivity +- A Kubernetes cluster [meeting Coder's + requirements](../../setup/kubernetes/index.md) with internet connectivity - kubectl with patch version [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) diff --git a/guides/ssl-certificates/route53.md b/guides/ssl-certificates/route53.md index 3f9067e7c..c4133d4bc 100644 --- a/guides/ssl-certificates/route53.md +++ b/guides/ssl-certificates/route53.md @@ -23,8 +23,8 @@ configure your Coder hostname and dev URLs. You must have: -- A [Kubernetes cluster](../../setup/kubernetes/index.md) (v1.17 or greater) - with internet connectivity +- A Kubernetes cluster [meeting Coder's + requirements](../../setup/kubernetes/index.md) with internet connectivity - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/) You should also: diff --git a/setup/kubernetes/aws.md b/setup/kubernetes/aws.md index a58412247..b00ef13a9 100644 --- a/setup/kubernetes/aws.md +++ b/setup/kubernetes/aws.md @@ -84,13 +84,14 @@ SSH_KEY_PATH=".pub" REGION="YOUR_REGION" ``` -The following will spin up a Kubernetes cluster using `eksctl`: +The following will spin up a Kubernetes cluster using `eksctl` (be sure to +update the parameters as necessary, especially the version number): ```console eksctl create cluster \ --name "$CLUSTER_NAME" \ - --version 1.17 \ + --version \ --region "$REGION" \ --nodegroup-name standard-workers \ --node-type t3.medium \ @@ -172,7 +173,7 @@ as a workspace deployment option, you'll need to kind: ClusterConfig metadata: - version: "1.17" + version: " region: From f370edc98f7849a10cdf8d1d1bbd63dae49294a2 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Mon, 12 Jul 2021 17:59:00 -0500 Subject: [PATCH 5/5] Edit text --- setup/kubernetes/index.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/setup/kubernetes/index.md b/setup/kubernetes/index.md index 02760ae69..1daffa008 100644 --- a/setup/kubernetes/index.md +++ b/setup/kubernetes/index.md @@ -3,25 +3,29 @@ title: Kubernetes description: Learn how to set up a Kubernetes cluster for your Coder deployment. --- -You can deploy Coder into any [compatible Kubernetes cluster]. Coder follows the +This section contains guides for creating a compatible cluster on common cloud +platforms, including Microsoft Azure, Google Cloud Platform, and Amazon Web +Services. If you already have a Kubernetes cluster, you may wish to proceed to +the [installation guide]. + +## Supported Kubernetes versions + +You can deploy Coder to any [compatible Kubernetes cluster]. Coder follows the [Kubernetes upstream version support policy], and the latest stable release version of Coder supports the previous two minor releases as well as the current -release of Kubernetes at time of publication. Coder may run successfully with -older versions of Kubernetes, however, we strongly recommend running one of the -currently-supported versions, in order to receive applicable fixes, including -security fixes, from the Kubernetes project maintainers. +release of Kubernetes at time of publication. + +Coder may run successfully with +older versions of Kubernetes. However, we strongly recommend running one of the +currently-supported versions so that you receive applicable fixes, including +security updates, from the Kubernetes project maintainers. Coder continuously removes usage of deprecated Kubernetes API versions once the minimum baseline version of Kubernetes supports the necessary features in -a stable version. We follow this policy in order to ensure that Coder stops +a stable version. We follow this policy to ensure that Coder stops using deprecated features before they are removed from new versions of Kubernetes. -This section contains guides for creating a compatible cluster on common cloud -platforms, including Microsoft Azure, Google Cloud Platform, and Amazon Web -Services. If you already have a Kubernetes cluster, you may wish to proceed to -the [installation guide]. - [compatible kubernetes cluster]: ../requirements.md [kubernetes upstream version support policy]: https://kubernetes.io/docs/setup/release/version-skew-policy/