From 54c7fdbb8a37e24f46883fbeed4935e848b3ddc7 Mon Sep 17 00:00:00 2001 From: Catherine Luse Date: Tue, 14 Jan 2020 11:16:49 -0700 Subject: [PATCH] Move Kubernetes version info from config options to upgrades --- .../rke/latest/en/config-options/_index.md | 17 ++---------- content/rke/latest/en/upgrades/_index.md | 26 ++++++++++++++----- 2 files changed, 21 insertions(+), 22 deletions(-) diff --git a/content/rke/latest/en/config-options/_index.md b/content/rke/latest/en/config-options/_index.md index 387bf4d0543..ecf29f2a412 100644 --- a/content/rke/latest/en/config-options/_index.md +++ b/content/rke/latest/en/config-options/_index.md @@ -60,22 +60,9 @@ ignore_docker_version: true ### Kubernetes Version -By default, RKE is defaulted to launch with a specific Kubernetes version. You can also select a different version of Kubernetes to install for your cluster. Each version of RKE has a specific list of supported Kubernetes versions. +For information on upgrading Kubernetes, refer to the [upgrade section.]({{}}/rke/latest/en/upgrades/) -You can set the Kubernetes version as follows: - -```yaml -kubernetes_version: "v1.11.6-rancher1-1" -``` - -In case both `kubernetes_version` and [system images]({{< baseurl >}}/rke/latest/en/config-options/system-images/) are defined, the system images configuration will take precedence over `kubernetes_version`. - -> **Note:** In RKE, `kubernetes_version` is used to map the version of Kubernetes to the default services, parameters, and options: - -> - For RKE v0.3.0+, the service defaults are located [here](https://github.com/rancher/kontainer-driver-metadata/blob/master/rke/k8s_service_options.go). -> - For RKE prior to v0.3.0, the service defaults are located [here](https://github.com/rancher/types/blob/release/v2.2/apis/management.cattle.io/v3/k8s_defaults.go). Note: The version in the path of the service defaults file corresponds to a Rancher version. Therefore, for Rancher v2.1.x, [this file](https://github.com/rancher/types/blob/release/v2.1/apis/management.cattle.io/v3/k8s_defaults.go) should be used. - -For the command to list all of the supported Kubernetes versions, refer to [this section.]({{}}/rke/latest/en/upgrades/#listing-supported-kubernetes-versions) +Rolling back to previous Kubernetes versions is not supported. ### Prefix Path diff --git a/content/rke/latest/en/upgrades/_index.md b/content/rke/latest/en/upgrades/_index.md index 9cb8720dc55..5e47ee6ab09 100644 --- a/content/rke/latest/en/upgrades/_index.md +++ b/content/rke/latest/en/upgrades/_index.md @@ -3,7 +3,15 @@ title: Upgrades weight: 100 --- -After RKE has deployed Kubernetes, you can upgrade the versions of the components in your Kubernetes cluster, [definition of the Kubernetes services]({{< baseurl >}}/rke/latest/en/config-options/services/) or [add-ons]({{< baseurl >}}/rke/latest/en/config-options/add-ons/). +After RKE has deployed Kubernetes, you can upgrade the versions of the components in your Kubernetes cluster, the [definition of the Kubernetes services]({{< baseurl >}}/rke/latest/en/config-options/services/) or the [add-ons]({{< baseurl >}}/rke/latest/en/config-options/add-ons/). + +The default Kubernetes version for each RKE version can be found in [the RKE release notes](https://github.com/rancher/rke/releases/). + +You can also select a newer version of Kubernetes to install for your cluster. Downgrading Kubernetes is not supported. + +Each version of RKE has a specific [list of supported Kubernetes versions.](#listing-supported-kubernetes-versions) + +In case the Kubernetes version is defined in the `kubernetes_version` directive and under the `system-images` directive are defined, the `system-images` configuration will take precedence over `kubernetes_version`. This page covers the following topics: @@ -11,14 +19,14 @@ This page covers the following topics: - [Upgrading Kubernetes](#upgrading-kubernetes) - [Listing supported Kubernetes versions](#listing-supported-kubernetes-versions) - [Kubernetes version precedence](#kubernetes-version-precedence) -- [Default Kubernetes version](#default-kubernetes-version) - [Using an unsupported Kubernetes version](#using-an-unsupported-kubernetes-version) +- [Mapping the Kubernetes version to services](#mapping-the-kubernetes-version-to-services) - [Service upgrades](#service-upgrades) - [Add-ons upgrades](#add-ons-upgrades) ### Prerequisites -- Ensure that any `system_images` configuration is absent from the `cluster.yml`. The Kubernetes version should only be listed under the `system_images` directive if an [unsupported version](#using-an-unsupported-kubernetes-version) is being used. For details on how `system_images` configuration can affect the upgrade, refer to the section on [Kubernetes version precedence.](#kubernetes-version-precedence) +- Ensure that any `system_images` configuration is absent from the `cluster.yml`. The Kubernetes version should only be listed under the `system_images` directive if an [unsupported version](#using-an-unsupported-kubernetes-version) is being used. Refer to [Kubernetes version precedence](#kubernetes-version-precedence) for more information. - Ensure that the correct files to manage [Kubernetes cluster state]({{< baseurl >}}/rke/latest/en/installation/#kubernetes-cluster-state) are present in the working directory. Refer to the tabs below for the required files, which differ based on the RKE version. {{% tabs %}} @@ -72,10 +80,6 @@ In case both `kubernetes_version` and `system_images` are defined, the `system_i In addition, if neither `kubernetes_version` nor `system_images` are configured in the `cluster.yml`, RKE will apply the default Kubernetes version for the specific version of RKE used to invoke `rke up`. -### Default Kubernetes Version - -The default Kubernetes version for each RKE version can be found in [the RKE release notes](https://github.com/rancher/rke/releases/). - ### Using an Unsupported Kubernetes Version As of v0.2.0, if a version is defined in `kubernetes_version` and is not found in the specific list of supported Kubernetes versions, then RKE will error out. @@ -84,6 +88,14 @@ Prior to v0.2.0, if a version is defined in `kubernetes_version` and is not foun If you want to use a different version from the supported list, please use the [system images]({{< baseurl >}}/rke/latest/en/config-options/system-images/) option. +### Mapping the Kubernetes Version to Services + +In RKE, `kubernetes_version` is used to map the version of Kubernetes to the default services, parameters, and options. + +For RKE v0.3.0+, the service defaults are located [here](https://github.com/rancher/kontainer-driver-metadata/blob/master/rke/k8s_service_options.go). + +For RKE prior to v0.3.0, the service defaults are located [here](https://github.com/rancher/types/blob/release/v2.2/apis/management.cattle.io/v3/k8s_defaults.go). Note: The version in the path of the service defaults file corresponds to a Rancher version. Therefore, for Rancher v2.1.x, [this file](https://github.com/rancher/types/blob/release/v2.1/apis/management.cattle.io/v3/k8s_defaults.go) should be used. + ### Service Upgrades [Services]({{< baseurl >}}/rke/latest/en/config-options/services/) can be upgraded by changing any of the services arguments or `extra_args` and running `rke up` again with the updated configuration file.