Skip to content

Commit e26fc57

Browse files
committed
don't skip minor versions of k8s during upgrades
1 parent 7771640 commit e26fc57

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
:::important
2-
Do not downgrade the Embedded Cluster version. This is not supported but is not prohibited, and it can lead to unexpected behavior.
2+
Do not downgrade the Kubernetes version or upgrade Kubernetes by more than one minor version at a time. These actions are not prevented by the Admin Console and can lead to unexpected behavior. For more information, see [Limitations](/vendor/embedded-overview#limitations) in _Embedded Cluster Overview_.
33
:::

docs/reference/embedded-config.mdx

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,15 @@ spec:
6767
6868
## version
6969
70-
You must specify which version of Embedded Cluster to install. Each version of Embedded Cluster includes particular versions of components like KOTS (Admin Console) and OpenEBS.
70+
Specify which version of Embedded Cluster to install. Each version of Embedded Cluster includes particular versions of components like KOTS (Admin Console) and OpenEBS.
7171
72-
For a full list of versions, see the Embedded Cluster [releases page](https://github.com/replicatedhq/embedded-cluster/releases) in GitHub. It's recommended to keep this version as up to date as possible because Embedded Cluster is changing rapidly.
72+
Additionally, each version of Embedded Cluster also specifies a version of Kubernetes. For example, Embedded Cluster 2.1.3+k8s-1.30 uses Kubernetes 1.30, while 2.1.3+k8s-1.29 uses Kubernetes 1.29.
73+
74+
:::note
75+
Embedded Cluster does not support upgrading by more than one minor version of Kubernetes at a time. To avoid issues that could be caused by skipping a minor version of Kubernetes, Replicated recommends that you select **Prevent this release from being skipped during upgrades** when you promote a new application release that increases the Kubernetes version. For more information about required releases, see [Properties](/vendor/releases-about#properties) in _About Channels and Releases_.
76+
:::
77+
78+
For a full list of versions, see the Embedded Cluster [releases page](https://github.com/replicatedhq/embedded-cluster/releases) in GitHub. Replicated recommends that you update the version frequently to ensure that you are using the latest version of Embedded Cluster.
7379
7480
## roles (Beta)
7581

docs/vendor/embedded-overview.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,9 @@ Embedded Cluster has the following limitations:
113113

114114
* **KOTS Auto-GitOps workflow not supported**: Embedded Cluster does not support the KOTS Auto-GitOps workflow. If an end-user is interested in GitOps, consider the Helm install method instead. For more information, see [Install with Helm](/vendor/install-with-helm).
115115

116-
* **Downgrading Kubernetes not supported**: Embedded Cluster does not support downgrading Kubernetes. The admin console will not prevent end-users from attempting to downgrade Kubernetes if a more recent version of your application specifies a previous Embedded Cluster version. You must ensure that you do not promote new versions with previous Embedded Cluster versions.
116+
* **Downgrading Kubernetes not supported**: Embedded Cluster does not support downgrading Kubernetes. However, the Admin Console does not prevent end-users from attempting to downgrade Kubernetes. To avoid issues that could be caused by downgrading Kubernetes in customer installations, do not promote new application releases with Embedded Cluster versions that are earlier than the version used by the previous release.
117+
118+
* **Upgrading by more than one Kubernetes version at a time not supported**: Embedded Cluster does not support upgrading by more than one minor version of Kubernetes at a time. However, the Admin Console does not prevent end-users from attempting to upgrade to a new application release that specifies a Kubernetes version more than one minor version later than what is currently installed. To avoid issues that could be caused by skipping a minor version of Kubernetes, Replicated recommends that you select **Prevent this release from being skipped during upgrades** when you promote a new application release that increases the Kubernetes version. For more information about required releases, see [Properties](/vendor/releases-about#properties) in _About Channels and Releases_.
117119

118120
* **Templating not supported in Embedded Cluster Config**: The [Embedded Cluster Config](/reference/embedded-config) resource does not support the use of Go template functions, including [KOTS template functions](/reference/template-functions-about). This only applies to the Embedded Cluster Config. You can still use template functions in the rest of your release as usual.
119121

0 commit comments

Comments
 (0)