From 44d59da57b8298b99986179de6c725af05d85086 Mon Sep 17 00:00:00 2001 From: Dawid Rogaczewski <20227477+daroga0002@users.noreply.github.com> Date: Thu, 27 Aug 2020 10:08:11 +0200 Subject: [PATCH] docs: Update README about `cluster_version` variable requirement (#988) --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 90180f0..89f016a 100644 --- a/README.md +++ b/README.md @@ -17,9 +17,14 @@ Read the [AWS docs on EKS to get connected to the k8s dashboard](https://docs.aw ## Important note -The default `cluster_version`is now 1.16. Kubernetes 1.16 includes a number of deprecated API removals, and you need to ensure your applications and add ons are updated, or workloads could fail after the upgrade is complete. For more information on the API removals, see the [Kubernetes blog post](https://kubernetes.io/blog/2019/07/18/api-deprecations-in-1-16/). For action you may need to take before upgrading, see the steps in the [EKS documentation](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html#1-16-prequisites). +The `cluster_version` is the required variable. Kubernetes is evolving a lot, and each major version includes new features, fixes, or changes. -Please set explicitly your `cluster_version` to an older EKS version until your workloads are ready for Kubernetes 1.16. +**Always check [Kubernetes Release Notes](https://kubernetes.io/docs/setup/release/notes/) before updating the major version.** + + +You also need to ensure your applications and add ons are updated, or workloads could fail after the upgrade is complete. For action, you may need to take before upgrading, see the steps in the [EKS documentation](https://docs.aws.amazon.com/eks/latest/userguide/update-cluster.html). + +An example of harming update was the removal of several commonly used, but deprecated APIs, in Kubernetes 1.16. More information on the API removals, see the [Kubernetes blog post](https://kubernetes.io/blog/2019/07/18/api-deprecations-in-1-16/). ## Usage example @@ -45,7 +50,7 @@ provider "kubernetes" { module "my-cluster" { source = "terraform-aws-modules/eks/aws" cluster_name = "my-cluster" - cluster_version = "1.16" + cluster_version = "1.17" subnets = ["subnet-abcde012", "subnet-bcde012a", "subnet-fghi345a"] vpc_id = "vpc-1234556abcdef"