-
Notifications
You must be signed in to change notification settings - Fork 15.1k
Add information on supported version skew and upgrade order #11060
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| --- | ||
| reviewers: | ||
| - sig-api-machinery | ||
| - sig-architecture | ||
| - sig-cli | ||
| - sig-cluster-lifecycle | ||
| - sig-node | ||
| - sig-release | ||
| title: Kubernetes Version and Version Skew Support Policy | ||
| content_template: templates/concept | ||
| weight: 70 | ||
| --- | ||
|
|
||
| {{% capture overview %}} | ||
| This document describes the maximum version skew supported between various Kubernetes components. | ||
| Specific cluster deployment tools may place additional restrictions on version skew. | ||
| {{% /capture %}} | ||
|
|
||
| {{% capture body %}} | ||
|
|
||
| ## Supported versions | ||
|
|
||
| Kubernetes versions are expressed as **x.y.z**, | ||
| where **x** is the major version, **y** is the minor version, and **z** is the patch version, following [Semantic Versioning](http://semver.org/) terminology. | ||
| For more information, see [Kubernetes Release Versioning](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/release/versioning.md#kubernetes-release-versioning). | ||
|
|
||
| The Kubernetes project maintains release branches for the most recent three minor releases. | ||
|
|
||
| Applicable fixes, including security fixes, may be backported to those three release branches, depending on severity and feasibility. | ||
| Patch releases are cut from those branches at a regular cadence, or as needed. | ||
| This decision is owned by the [patch release manager](https://github.com/kubernetes/sig-release/blob/master/release-team/role-handbooks/patch-release-manager/README.md#release-timing). | ||
| The patch release manager is a member of the [release team for each release](https://github.com/kubernetes/sig-release/tree/master/releases/). | ||
|
|
||
| Minor releases occur approximately every 3 months, so each minor release branch is maintained for approximately 9 months. | ||
|
|
||
| ## Supported version skew | ||
|
|
||
| ### kube-apiserver | ||
|
|
||
| In [highly-availabile (HA) clusters](https://kubernetes.io/docs/setup/independent/high-availability/), the newest and oldest `kube-apiserver` instances must be within one minor version. | ||
|
|
||
| Example: | ||
|
|
||
| * newest `kube-apiserver` is at **1.13** | ||
| * other `kube-apiserver` instances are supported at **1.13** and **1.12** | ||
|
|
||
| ### kubelet | ||
|
|
||
| `kubelet` must not be newer than `kube-apiserver`, and may be up to two minor versions older. | ||
liggitt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Example: | ||
|
|
||
| * `kube-apiserver` is at **1.13** | ||
| * `kubelet` is supported at **1.13**, **1.12**, and **1.11** | ||
|
|
||
| {{< note >}} | ||
| If version skew exists between `kube-apiserver` instances in an HA cluster, this narrows the allowed `kubelet` versions. | ||
| {{</ note >}} | ||
|
|
||
| Example: | ||
|
|
||
| * `kube-apiserver` instances are at **1.13** and **1.12** | ||
| * `kubelet` is supported at **1.12**, and **1.11** (**1.13** is not supported because that would be newer than the `kube-apiserver` instance at version **1.12**) | ||
|
|
||
| ### kube-controller-manager, kube-scheduler, and cloud-controller-manager | ||
|
|
||
| `kube-controller-manager`, `kube-scheduler`, and `cloud-controller-manager` must not be newer than the `kube-apiserver` instances they communicate with. They are expected to match the `kube-apiserver` minor version, but may be up to one minor version older (to allow live upgrades). | ||
|
|
||
| Example: | ||
|
|
||
| * `kube-apiserver` is at **1.13** | ||
| * `kube-controller-manager`, `kube-scheduler`, and `cloud-controller-manager` are supported at **1.13** and **1.12** | ||
|
|
||
| {{< note >}} | ||
| If version skew exists between `kube-apiserver` instances in an HA cluster, and these components can communicate with any `kube-apiserver` instance in the cluster (for example, via a load balancer), this narrows the allowed versions of these components. | ||
| {{< /note >}} | ||
|
|
||
| Example: | ||
|
|
||
| * `kube-apiserver` instances are at **1.13** and **1.12** | ||
| * `kube-controller-manager`, `kube-scheduler`, and `cloud-controller-manager` communicate with a load balancer that can route to any `kube-apiserver` instance | ||
| * `kube-controller-manager`, `kube-scheduler`, and `cloud-controller-manager` are supported at **1.12** (**1.13** is not supported because that would be newer than the `kube-apiserver` instance at version **1.12**) | ||
|
|
||
| ### kubectl | ||
|
|
||
| `kubectl` is supported within one minor version (older or newer) of `kube-apiserver`. | ||
liggitt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| Example: | ||
|
|
||
| * `kube-apiserver` is at **1.13** | ||
| * `kubectl` is supported at **1.14**, **1.13**, and **1.12** | ||
|
|
||
| {{< note >}} | ||
| If version skew exists between `kube-apiserver` instances in an HA cluster, this narrows the supported `kubectl` versions. | ||
| {{< /note >}} | ||
|
|
||
| Example: | ||
|
|
||
| * `kube-apiserver` instances are at **1.13** and **1.12** | ||
liggitt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| * `kubectl` is supported at **1.13** and **1.12** (other versions would be more than one minor version skewed from one of the `kube-apiserver` components) | ||
|
|
||
| ## Supported component upgrade order | ||
liggitt marked this conversation as resolved.
Show resolved
Hide resolved
liggitt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| The supported version skew between components has implications on the order in which components must be upgraded. | ||
| This section describes the order in which components must be upgraded to transition an existing cluster from version **1.n** to version **1.(n+1)**. | ||
liggitt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### kube-apiserver | ||
|
|
||
| Pre-requisites: | ||
|
|
||
| * In a single-instance cluster, the existing `kube-apiserver` instance is **1.n** | ||
| * In an HA cluster, all `kube-apiserver` instances are at **1.n** or **1.(n+1)** (this ensures maximum skew of 1 minor version between the oldest and newest `kube-apiserver` instance) | ||
| * The `kube-controller-manager`, `kube-scheduler`, and `cloud-controller-manager` instances that communicate with this server are at version **1.n** (this ensures they are not newer than the existing API server version, and are within 1 minor version of the new API server version) | ||
| * `kubelet` instances on all nodes are at version **1.n** or **1.(n-1)** (this ensures they are not newer than the existing API server version, and are within 2 minor versions of the new API server version) | ||
| * Registered admission webhooks are able to handle the data the new `kube-apiserver` instance will send them: | ||
| * `ValidatingWebhookConfiguration` and `MutatingWebhookConfiguration` objects are updated to include any new versions of REST resources added in **1.(n+1)** | ||
| * The webhooks are able to handle any new versions of REST resources that will be sent to them, and any new fields added to existing versions in **1.(n+1)** | ||
|
|
||
| Upgrade `kube-apiserver` to **1.(n+1)** | ||
|
|
||
| {{< note >}} | ||
| Project policies for [API deprecation](https://kubernetes.io/docs/reference/using-api/deprecation-policy/) and | ||
| [API change guidelines](https://github.com/kubernetes/community/blob/master/contributors/devel/api_changes.md) | ||
| require `kube-apiserver` to not skip minor versions when upgrading, even in single-instance clusters. | ||
| {{< /note >}} | ||
|
|
||
| ### kube-controller-manager, kube-scheduler, and cloud-controller-manager | ||
|
|
||
| Pre-requisites: | ||
|
|
||
| * The `kube-apiserver` instances these components communicate with are at **1.(n+1)** (in HA clusters in which these control plane components can communicate with any `kube-apiserver` instance in the cluster, all `kube-apiserver` instances must be upgraded before upgrading these components) | ||
|
|
||
| Upgrade `kube-controller-manager`, `kube-scheduler`, and `cloud-controller-manager` to **1.(n+1)** | ||
|
|
||
| ### kubelet | ||
|
|
||
| Pre-requisites: | ||
|
|
||
| * The `kube-apiserver` instances the `kubelet` communicates with are at **1.(n+1)** | ||
|
|
||
| Optionally upgrade `kubelet` instances to **1.(n+1)** (or they can be left at **1.n** or **1.(n-1)**) | ||
liggitt marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| {{< warning >}} | ||
| Running a cluster with `kubelet` instances that are persistently two minor versions behind `kube-apiserver` is not recommended: | ||
|
|
||
| * they must be upgraded within one minor version of `kube-apiserver` before the control plane can be upgraded | ||
| * it increases the likelihood of running `kubelet` versions older than the three maintained minor releases | ||
| {{</ warning >}} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.