mirror of
https://github.com/rancher/rancher-docs.git
synced 2026-09-25 04:28:15 +00:00
Merge pull request #2143 from catherineluse/show-k8s-versions
Add RKE command to show available K8s versions
This commit is contained in:
Catherine Luse
@@ -60,42 +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.]({{<baseurl>}}/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.
|
||||
|
||||
#### Listing Supported Kubernetes Versions
|
||||
|
||||
Please refer to the [release notes](https://github.com/rancher/rke/releases) of the RKE version that you are running, to find the list of supported Kubernetes versions as well as the default Kubernetes version.
|
||||
|
||||
You can also list the supported versions and system images of specific version of RKE release with a quick command.
|
||||
|
||||
```
|
||||
$ rke config --list-version --all
|
||||
v1.15.3-rancher2-1
|
||||
v1.13.10-rancher1-2
|
||||
v1.14.6-rancher2-1
|
||||
v1.16.0-beta.1-rancher1-1
|
||||
```
|
||||
|
||||
#### 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.
|
||||
|
||||
Prior to v0.2.0, if a version is defined in `kubernetes_version` and is not found in the specific list of supported Kubernetes versions, the default version from the supported list is used.
|
||||
|
||||
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.
|
||||
Rolling back to previous Kubernetes versions is not supported.
|
||||
|
||||
### Prefix Path
|
||||
|
||||
|
||||
@@ -3,40 +3,106 @@ 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/).
|
||||
|
||||
## Kubernetes Version Upgrades
|
||||
The default Kubernetes version for each RKE version can be found in [the RKE release notes](https://github.com/rancher/rke/releases/).
|
||||
|
||||
> **Note:** RKE does not support rollback to previous versions.
|
||||
You can also select a newer version of Kubernetes to install for your cluster. Downgrading Kubernetes is not supported.
|
||||
|
||||
To upgrade the Kubernetes version of an RKE provisioned cluster set the `kubernetes_version` string in the `cluster.yml` to the desired version from the list of supported Kubernetes versions for the specific version of RKE. You can find the list of supported Kubernetes versions for a specific version of RKE as documented at [Listing Supported Kubernetes Versions]({{< baseurl >}}/rke/latest/en/config-options/#listing-supported-kubernetes-versions.).
|
||||
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:
|
||||
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Upgrading Kubernetes](#upgrading-kubernetes)
|
||||
- [Listing supported Kubernetes versions](#listing-supported-kubernetes-versions)
|
||||
- [Kubernetes version precedence](#kubernetes-version-precedence)
|
||||
- [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. 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 %}}
|
||||
{{% tab "RKE v0.2.0+" %}}
|
||||
The `cluster.rkestate` file contains the current state of the cluster including the RKE configuration and the certificates.
|
||||
|
||||
This file is created in the same directory that has the cluster configuration file `cluster.yml`.
|
||||
|
||||
It is required to keep the `cluster.rkestate` file to perform any operation on the cluster through RKE, or when upgrading a cluster last managed via RKE v0.2.0 or later.
|
||||
{{% /tab %}}
|
||||
{{% tab "RKE prior to v0.2.0" %}}
|
||||
Ensure that the `kube_config_cluster.yml` file is present in the working directory.
|
||||
|
||||
RKE saves the Kubernetes cluster state as a secret. When updating the state, RKE pulls the secret, updates or changes the state, and saves a new secret. The `kube_config_cluster.yml` file is required for upgrading a cluster last managed via RKE v0.1.x.
|
||||
{{% /tab %}}
|
||||
{{% /tabs %}}
|
||||
|
||||
### Upgrading Kubernetes
|
||||
|
||||
> **Note:** RKE does not support rolling back to previous versions.
|
||||
|
||||
To upgrade the Kubernetes version of an RKE-provisioned cluster, set the `kubernetes_version` string in the `cluster.yml` to the desired version from the [list of supported Kubernetes versions](#listing-supported-kubernetes-versions) for the specific version of RKE:
|
||||
|
||||
```yaml
|
||||
kubernetes_version: "v1.15.5-rancher1-1"
|
||||
```
|
||||
|
||||
> **Note:** In case both `kubernetes_version` and `system_images` are defined, the `system_images` configuration will take precedence over `kubernetes_version`. 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`. The default Kubernetes version for each RKE version can be found in [the RKE release notes](https://github.com/rancher/rke/releases/).
|
||||
|
||||
Having configured the `kubernetes_version`, ensure that any `system_images` configuration is absent from the `cluster.yml`, and then invoke `rke up` to upgrade Kubernetes.
|
||||
|
||||
It is important to ensure that the correct files to manage [Kubernetes cluster state]({{< baseurl >}}/rke/latest/en/installation/#kubernetes-cluster-state) are present in the working directory when invoking `rke up` to upgrade the cluster.
|
||||
|
||||
- In v0.1.x, RKE saved the Kubernetes cluster state as a secret. When updating the state, RKE pulls the secret, updates/changes the state and saves a new secret. When upgrading a cluster last managed via RKE v0.1.x you should ensure the `kube_config_cluster.yml` file is present in the working directory when invoking `rke up`.
|
||||
- As of v0.2.0, RKE creates a `cluster.rkestate` file in the same directory that has the cluster configuration file `cluster.yml`. The `cluster.rkestate` file contains the current state of the cluster including the RKE configuration and the certificates. It is required to keep this file in order to update the cluster or perform any operation on it through RKE. When upgrading a cluster last managed via RKE v0.2.0 or later, you should ensure the `cluster.rkestate` file is present in the working directory when invoking `rke up`.
|
||||
|
||||
When all the prerequisites described above are fulfilled, you can invoke `rke up`:
|
||||
Then invoke `rke up`:
|
||||
|
||||
```
|
||||
$ rke up --config cluster.yml
|
||||
```
|
||||
|
||||
## Service Upgrades
|
||||
### Listing Supported Kubernetes Versions
|
||||
|
||||
Please refer to the [release notes](https://github.com/rancher/rke/releases) of the RKE version that you are running, to find the list of supported Kubernetes versions as well as the default Kubernetes version.
|
||||
|
||||
You can also list the supported versions and system images of specific version of RKE release with a quick command.
|
||||
|
||||
```
|
||||
$ rke config --list-version --all
|
||||
v1.15.3-rancher2-1
|
||||
v1.13.10-rancher1-2
|
||||
v1.14.6-rancher2-1
|
||||
v1.16.0-beta.1-rancher1-1
|
||||
```
|
||||
|
||||
### Kubernetes Version Precedence
|
||||
|
||||
In case both `kubernetes_version` and `system_images` are defined, the `system_images` configuration will take precedence over `kubernetes_version`.
|
||||
|
||||
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`.
|
||||
|
||||
### 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.
|
||||
|
||||
Prior to v0.2.0, if a version is defined in `kubernetes_version` and is not found in the specific list of supported Kubernetes versions, the default version from the supported list is used.
|
||||
|
||||
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.
|
||||
|
||||
> **Note:** The following arguments, `service_cluster_ip_range` or `cluster_cidr`, cannot be changed as any changes to these arguments will result in a broken cluster. Currently, network pods are not automatically upgraded.
|
||||
|
||||
## Add-Ons Upgrades
|
||||
### Add-Ons Upgrades
|
||||
|
||||
As of v0.1.8, upgrades to add-ons are supported.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user