diff options
author | Zheng Junyi <zhengjunyi@live.com> | 2024-05-30 18:24:31 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-05-30 12:24:31 +0200 |
commit | d8a5a620da8e1cae5348ede15cd244705e02598c (patch) | |
tree | ccded985386c5aa477a3d618abacf9f7ac8168ae /pkgs/applications/networking/cluster/rke2/README.md | |
parent | 507146ab23d6d2ac224669a930ebe8eebdd60d10 (diff) |
rke2: update and release packages by official release channels (#315599)
Get the legal go version from the k8s project. Use the `buildGoModule` compilation package instead of patching the build script. Add documents to explain Release Channels and support strategies. Increase the metadata `eol` (End of Life) to mark the life cycle of the package.
Diffstat (limited to 'pkgs/applications/networking/cluster/rke2/README.md')
-rw-r--r-- | pkgs/applications/networking/cluster/rke2/README.md | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/pkgs/applications/networking/cluster/rke2/README.md b/pkgs/applications/networking/cluster/rke2/README.md new file mode 100644 index 0000000000000..f7a12677db965 --- /dev/null +++ b/pkgs/applications/networking/cluster/rke2/README.md @@ -0,0 +1,25 @@ +# RKE2 Version + +RKE2, Kubernetes, and other clustered software has the property of not being able to update atomically. Most software in nixpkgs, like for example bash, can be updated as part of a `nixos-rebuild switch` without having to worry about the old and the new bash interacting in some way. + +> [!NOTE] +> Upgrade the server nodes first, one at a time. Once all servers have been upgraded, you may then upgrade agent nodes. + +## Release Channels + +RKE2 has there own release channels, which are: `stable`, `latest` and `testing`. + +The `stable` channel is the default channel and is recommended for production use. The `latest` channel is the latest stable release. The `testing` channel is the latest release, including pre-releases. + +| Channel | Description | +| --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `stable` | **(Default)** Stable is recommended for production environments. These releases have been through a period of community hardening, and are compatible with the most recent release of Rancher. | +| `latest` | Latest is recommended for trying out the latest features. These releases have not yet been through a period of community hardening, and may not be compatible with Rancher. | +| `testing` | The most recent release, including pre-releases. | + +Learn more about the [RKE2 release channels](https://docs.rke2.io/upgrade/manual_upgrade). + +For an exhaustive and up-to-date list of channels, you can visit the [rke2 channel service API](https://update.rke2.io/v1-release/channels). For more technical details on how channels work, you can see the [channelserver project](https://github.com/rancher/channelserver). + +> [!TIP] +> When attempting to upgrade to a new version of RKE2, the [Kubernetes version skew policy](https://kubernetes.io/docs/setup/release/version-skew-policy) applies. Ensure that your plan does not skip intermediate minor versions when upgrading. Nothing in the upgrade process will protect against unsupported changes to the Kubernetes version. |