diff --git a/modules/create-wif-cluster-cli.adoc b/modules/create-wif-cluster-cli.adoc index afe796a1b55e..03b52b67b339 100644 --- a/modules/create-wif-cluster-cli.adoc +++ b/modules/create-wif-cluster-cli.adoc @@ -55,7 +55,7 @@ $ ocm create cluster \ --min-replicas=3 \ --max-replicas=6 \ --secure-boot-for-shielded-vms=true ---channel-group +--channel ---- + where: @@ -91,7 +91,7 @@ For more information about supported versions for WIF configurations, see "Creat `--secure-boot-for-shielded-vms=true`:: Enables Secure Boot, which allows the use of Shielded VMs in the {gcp-full}. This parameter is optional. -`--channel-group `:: Specifies the name of the channel group you want to assign the cluster to. Channel group options include `stable` and `eus`. Replace `` with the desired channel group. This parameter is optional. +`--channel `:: Specifies the name of the channel you want to assign the cluster to. Channel options include `stable-4.y`, `fast-4.y`, and `eus-4.y`. Replace `` with the desired channel. This parameter is optional. [IMPORTANT] ==== diff --git a/modules/create-wif-cluster-ocm.adoc b/modules/create-wif-cluster-ocm.adoc index f0031c8305ad..3fbd5a9104d6 100644 --- a/modules/create-wif-cluster-ocm.adoc +++ b/modules/create-wif-cluster-ocm.adoc @@ -53,7 +53,7 @@ To customize the subdomain prefix, select the *Create custom domain prefix* chec Workload Identity Federation (WIF) is only supported on {product-title} version 4.17 and later. ==== + -.. Select a channel group from the *Channel group* drop-down menu. +.. Select a channel from the *Channel* drop-down menu. + -- include::snippets/rosa-osd-channel-group-options.adoc[] diff --git a/modules/osd-create-cluster-ccs.adoc b/modules/osd-create-cluster-ccs.adoc index 2ce8749de2ae..79243dd963b8 100644 --- a/modules/osd-create-cluster-ccs.adoc +++ b/modules/osd-create-cluster-ccs.adoc @@ -55,7 +55,7 @@ To customize the subdomain, select the *Create customize domain prefix* checkbox Clusters configured with Private Service Connect (PSC) are only supported on OpenShift Dedicated version 4.17 and later. For more information regarding PSC, see _Private Service Overview_ in the _Additional resources_ section. ==== + -.. Select a channel group from the *Channel group* drop-down menu. +.. Select a channel from the *Channel* drop-down menu. + -- include::snippets/rosa-osd-channel-group-options.adoc[] diff --git a/modules/osd-create-cluster-red-hat-account.adoc b/modules/osd-create-cluster-red-hat-account.adoc index 12672f884325..3064fcb0787c 100644 --- a/modules/osd-create-cluster-red-hat-account.adoc +++ b/modules/osd-create-cluster-red-hat-account.adoc @@ -35,7 +35,7 @@ You must have the required resource quota for the *Annual* subscription type to + To customize the subdomain, select the *Create custom domain prefix* checkbox, and enter your domain prefix name in the *Domain prefix* field. The domain prefix cannot be longer than 15 characters, must be unique within your organization, and cannot be changed after cluster creation. .. Select a cluster version from the *Version* drop-down menu. -.. Select a channel group from the *Channel group* drop-down menu. +.. Select a channel from the *Channel* drop-down menu. + -- include::snippets/rosa-osd-channel-group-options.adoc[] diff --git a/modules/osd-lifecycle-policy.adoc b/modules/osd-lifecycle-policy.adoc index b63664a3ba89..3b97321e6f2e 100644 --- a/modules/osd-lifecycle-policy.adoc +++ b/modules/osd-lifecycle-policy.adoc @@ -8,6 +8,6 @@ = Life cycle policies and planning [role="_abstract"] -To plan an upgrade, review the _{product-title} update life cycle_ guide in the "Additional resources" section. The life cycle page includes release definitions, support and upgrade requirements, installation policy information, and life cycle dates. +To plan an upgrade, review the _{product-title} update life cycle_ guide in the _Additional resources_ section. The life cycle page includes release definitions, support and upgrade requirements, installation policy information, and life cycle dates. -You can use update channels to decide which Red Hat {OCP} minor version to update your clusters to. {product-title} supports updates only through the `stable` channel. To learn more about OpenShift update channels and releases, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/updating_clusters/understanding-openshift-updates-1#understanding-update-channels-releases[Understanding update channels and releases]. +You can use update channels to decide which {product-title} minor version to update your clusters to. {product-title} supports updates through the `stable-4.y`, `fast-4.y`, and `eus-4.y` channels. For more information, see the _Channels in {product-title} clusters_ section. diff --git a/modules/osd-upgrading-channels.adoc b/modules/osd-upgrading-channels.adoc new file mode 100644 index 000000000000..2ea9cb3082e0 --- /dev/null +++ b/modules/osd-upgrading-channels.adoc @@ -0,0 +1,43 @@ +:_mod-docs-content-type: CONCEPT +[id="osd-upgrading-channels_{context}"] += Channels in {product-title} clusters + +[role="_abstract"] +You can use {product-title} channels to view available cluster update options and apply patches or z-stream updates in your existing channel. You can also view the update path to newer y-stream versions if available. + +== Channel groups and channels +Channel groups in {product-title} are similar to channels, but there is no specific version with channel groups. When you select a channel group, your {product-title} cluster receives z-stream updates for your current channel group. These channel groups typically include: + +* `fast`: cluster receives the latest updates as soon as they are available. +* `stable`: cluster receives updates after they have been thoroughly tested. +* `eus`: Extended Update Support channel, allowing for extended support for even-numbered versions, for example, 4.16, 4.18, or 4.20. + +By moving from channel groups to channels, you can have more control over your cluster updates. Instead of receiving patch/z-stream updates only for a particular channel group, by using channels you can view the available updates associated with a minor release version, and determine if there is a path available to that minor/y+1/y+2 version. + +[IMPORTANT] +==== +The channel group option is being deprecated. If you set a channel group only, {product-title} will default to preserving the current channel's target version. For example, a `stable-4.20` cluster moving to the `eus` channel group will use the `eus-4.20` channel by default, if the current cluster version is a member of the `eus-4.20` channel. +==== + +== Cluster update options +The process for updating your cluster is based on the updates that are available for your current version, and what level of release you are interested in, such as z-stream or y-stream updates. + +* *Patch (z-stream) updates*: You do not need to change the channel when performing a patch update within your current minor version. For example, if you have your cluster at version 4.19.12, you can stay within your current `stable-4.19` channel, and decide to update your cluster when there are updates available, such as 4.19.13, 4.19.14, 4.19.17, 4.19.20 until you have the latest updates for that minor version. + +* *Minor version (y-stream) updates*: To update to a new minor release, you must change the channel to the next release channel. ++ +For example, if you have your cluster at version 4.19.12, you can switch the channel to `stable-4.20` or `stable-4.21` and check if there is an update path available for those versions. ++ +If `stable-4.20` has an update path available, it shows you the z-stream updates for your current version, as well as the updates to the y+1 version, such as 4.19.14, 4.19.17, 4.19.20, 4.19.23, 4.19.27, 4.20.0. ++ +If you select `stable-4.21`, the available updates might be 4.19.14, 4.19.17, 4.19.20, 4.19.23, 4.19.27, 4.20.0, 4.20.3, 4.20.4, 4.20.6, 4.20.7, with all the z-stream/patch updates displayed right through to the y+2 version of 4.21.0. + +When you have set the channel and an update is initiated, the Cluster Version Operator (CVO) retrieves the target release image and begins applying the changes to the cluster. + +//// +[NOTE] +==== +The *Channel groups* option is now deprecated in {product-title}. Channel groups allowed you to upgrade through the available patch/z-stream updates for a particular channel group, such as stabe or eus. +There was the possibility of inadvertently upgrading to the next minor version/Y+1 version if it appeared in the available updates. +==== +//// diff --git a/modules/osd-upgrading-switch-channels.adoc b/modules/osd-upgrading-switch-channels.adoc new file mode 100644 index 000000000000..5d1a97bdf50c --- /dev/null +++ b/modules/osd-upgrading-switch-channels.adoc @@ -0,0 +1,27 @@ +// Module included in the following assemblies: +// +// * upgrading/osd-upgrades.adoc + +:_mod-docs-content-type: PROCEDURE +[id="osd-upgrading-switch-channels_{context}"] += Switch channels to view available update options + +[role="_abstract"] +You can switch the channel on a {product-title} cluster to access update options within a current minor version (y-stream), or the subsequent minor versions (y+1, y+2). The version number in the channel represents the target minor version. + +For example, if your cluster is on `stable-4.18`, switching the channel to `stable-4.19` shows update paths from 4.18.z to 4.19.z, if such paths are available. This strategy ensures that administrators must explicitly initiate minor version updates, and they never occur automatically. + +.Procedure + +. Log in to {cluster-manager-url}. +. Click *Fleet Management* > *Clusters*. +. Select the cluster for which you want to see the update options. +. To view the cluster details, click the *Overview* tab. + * The *Channel* field displays the current update channel for the cluster. +. Select the new update channel. +.. In the *Channel* field, click the *Edit channel* icon next to the current channel name. +.. On the *Edit channel* dialog, select the required channel version. +.. Click *Save*. +** The *Channel* field updates to display the new update channel. +** The *Version* field displays the *Update* link if updates are available for your selected channel. + diff --git a/snippets/rosa-osd-channel-group-options.adoc b/snippets/rosa-osd-channel-group-options.adoc index 33bd2a7a2826..8f0393bbdf79 100644 --- a/snippets/rosa-osd-channel-group-options.adoc +++ b/snippets/rosa-osd-channel-group-options.adoc @@ -13,5 +13,5 @@ [NOTE] ==== -Channel group options include *Stable* (default option) and *EUS*. For more information about the Stable and EUS channel group options, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/updating_clusters/understanding-openshift-updates-1#understanding-update-channels-releases[Understanding update channels and releases]. +Channel options include *Stable-4.y* (default option), *Fast-4.y*, and *EUS-4.y*. For more information about the Stable, Fast, and EUS channel options, see link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/updating_clusters/understanding-openshift-updates-1#understanding-update-channels-releases[Understanding update channels and releases]. ==== diff --git a/upgrading/osd-upgrades.adoc b/upgrading/osd-upgrades.adoc index 5279067db082..306aa4c4263b 100644 --- a/upgrading/osd-upgrades.adoc +++ b/upgrading/osd-upgrades.adoc @@ -14,18 +14,23 @@ Red Hat Site Reliability Engineers (SREs) monitor upgrade progress and remedy an include::modules/osd-lifecycle-policy.adoc[leveloffset=+1] -[role="_additional-resources"] -.Additional resources -* xref:../osd_architecture/osd_policy/osd-life-cycle.adoc#osd-life-cycle_life-cycle-overview[{product-title} update life cycle] - include::modules/upgrade.adoc[leveloffset=+1] +include::modules/osd-upgrading-channels.adoc[leveloffset=+1] + +include::modules/osd-upgrading-switch-channels.adoc[leveloffset=+1] + +include::modules/upgrade-auto.adoc[leveloffset=+1] + +include::modules/upgrade-manual.adoc[leveloffset=+1] + [role="_additional-resources"] .Additional resources +* xref:../osd_architecture/osd_policy/osd-life-cycle.adoc#osd-life-cycle_life-cycle-overview[{product-title} update life cycle] + + * link:https://docs.redhat.com/en/documentation/openshift_container_platform/latest/html/updating_clusters/understanding-openshift-updates-1#understanding-update-channels-releases[Understanding update channels and releases] + * xref:../osd_cluster_admin/osd-cluster-notifications.adoc#managed-cluster-notification-view-hcc_osd-cluster-notifications[Accessing cluster notifications in {hybrid-console}] * xref:../osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc#wif-configuration-update_osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Updating a WIF configuration] - -include::modules/upgrade-auto.adoc[leveloffset=+1] -include::modules/upgrade-manual.adoc[leveloffset=+1]