Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _javascripts/page-loader.js
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ function selectVersion(currentVersion) {

// main file to edit is the file path after the version to the html at
// the end.
// Example: https://docs.openshift.com/container-platform/4.4/updating/updating-cluster-between-minor.html
// file path is updating/updating-cluster-between-minor.adoc
// Example: https://docs.openshift.com/container-platform/4.4/updating/updating-cluster-within-minor.html
// file path is updating/updating-cluster-within-minor.adoc

mainFileToEdit =
window.location.pathname.substring(
Expand Down
12 changes: 6 additions & 6 deletions _topic_maps/_topic_map.yml
Original file line number Diff line number Diff line change
Expand Up @@ -361,11 +361,11 @@ Topics:
File: understanding-the-update-service
- Name: Installing and configuring the OpenShift Update Service
File: installing-update-service
- Name: Updating a cluster between minor versions
File: updating-cluster-between-minor
- Name: Updating a cluster within a minor version from the web console
File: updating-cluster
- Name: Updating a cluster within a minor version by using the CLI
- Name: Understanding upgrade channels
File: understanding-upgrade-channels-release
- Name: Updating a cluster within a minor version using the web console
File: updating-cluster-within-minor
- Name: Updating a cluster within a minor version using the CLI
File: updating-cluster-cli
- Name: Performing update using canary rollout strategy
File: update-using-custom-machine-config-pools
Expand Down Expand Up @@ -1082,7 +1082,7 @@ Dir: registry
Distros: openshift-enterprise,openshift-origin
Topics:
- Name: Registry overview
File: index
File: index
- Name: Image Registry Operator in OpenShift Container Platform
File: configuring-registry-operator
Distros: openshift-enterprise
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ include::modules/ipi-install-retrieving-the-openshift-installer.adoc[leveloffset

.Additional resources

* See xref:../../updating/updating-cluster-between-minor.adoc#understanding-upgrade-channels_updating-cluster-between-minor[{product-title} upgrade channels and releases] for an explanation of the different release channels.
* See xref:../../updating/understanding-upgrade-channels-release.adoc#understanding-upgrade-channels_understanding-upgrade-channels-releases[{product-title} upgrade channels and releases] for an explanation of the different release channels.

include::modules/ipi-install-extracting-the-openshift-installer.adoc[leveloffset=+1]

Expand Down
4 changes: 2 additions & 2 deletions installing/validating-an-installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ include::modules/getting-cluster-version-status-and-update-details.adoc[leveloff

* See xref:../support/troubleshooting/troubleshooting-operator-issues.adoc#troubleshooting-operator-issues[Troubleshooting Operator issues] for information about investigating issues with Operators.

* See xref:../updating/updating-cluster-between-minor.adoc#updating-cluster-between-minor[Updating a cluster between minor versions] for more information on updating your cluster.
* See xref:../updating/updating-cluster-within-minor.adoc#updating-cluster-within-minor[Updating a cluster between minor versions] for more information on updating your cluster.

* See xref:../updating/updating-cluster-between-minor.adoc#understanding-upgrade-channels_updating-cluster-between-minor[OpenShift Container Platform upgrade channels and releases] for an overview about upgrade release channels.
* See xref:../updating/understanding-upgrade-channels-release.adoc#understanding-upgrade-channels_understanding-upgrade-channels-releases[OpenShift Container Platform upgrade channels and releases] for an overview about upgrade release channels.

//Querying the status of the cluster nodes by using the CLI
include::modules/querying-the-status-of-cluster-nodes-using-the-cli.adoc[leveloffset=+1]
Expand Down
2 changes: 1 addition & 1 deletion migrating_from_ocp_3_to_4/planning-migration-3-4.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ For more information, see xref:../architecture/architecture-installation.adoc#in

In {product-title} 3.11, you upgraded your cluster by running Ansible playbooks. In {product-title} {product-version}, the cluster manages its own updates, including updates to {op-system-first} on cluster nodes. You can easily upgrade your cluster by using the web console or by using the `oc adm upgrade` command from the OpenShift CLI and the Operators will automatically upgrade themselves. If your {product-title} {product-version} cluster has {op-system-base} worker machines, then you will still need to run an Ansible playbook to upgrade those worker machines.

For more information, see xref:../updating/updating-cluster-between-minor.adoc#updating-cluster-between-minor[Updating clusters].
For more information, see xref:../updating/updating-cluster-within-minor.adoc#updating-cluster-within-minor[Updating clusters].

[id="migration-considerations"]
== Migration considerations
Expand Down
2 changes: 1 addition & 1 deletion modules/cluster-logging-release-notes-5.0.0.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ To work around this issue, upgrade to a supported version of Apache Kafka.
//
// [IMPORTANT]
// ====
// For any {ProductName} release, always review the instructions on xref:../updating/updating-cluster.adoc#TBD[updating your cluster] properly.
// For any {ProductName} release, always review the instructions on xref:../updating/updating-cluster-within-minor.adoc#TBD[updating your cluster] properly.
// ====
//
// [id="openshift-logging-5-0-0-ga"]
Expand Down
55 changes: 19 additions & 36 deletions modules/understanding-upgrade-channels.adoc
Original file line number Diff line number Diff line change
@@ -1,36 +1,14 @@
// Module included in the following assemblies:
//
// * updating/updating-cluster.adoc
// * updating/updating-cluster-between-minor.adoc
// * updating/updating-cluster-cli.adoc
// * updating/updating-cluster-rhel-compute.adoc
// * updating/understanding-upgrade-channels-release.adoc
// * updating/updating-disconnected-cluster.adoc

[id="understanding-upgrade-channels_{context}"]
= {product-title} upgrade channels and releases
= Upgrade channels and release paths

In {product-title} 4.1, Red Hat introduced the concept of channels for recommending the appropriate release versions for cluster upgrades. By controlling the pace of upgrades, these upgrade channels allow you to choose an upgrade strategy. Upgrade channels are tied to a minor version of {product-title}. For instance, {product-title} 4.7 upgrade channels recommend upgrades to 4.7 and upgrades within 4.7. They also recommend upgrades within 4.6 and from 4.6 to 4.7, to allow clusters on 4.6 to eventually upgrade to 4.7. They do not recommend upgrades to 4.8 or later releases. This strategy ensures that administrators explicitly decide to upgrade to the next minor version of {product-title}.
Cluster administrators can configure the upgrade channel from the web console.

Upgrade channels control only release selection and do not impact the version of the cluster that you install; the `openshift-install` binary file for a specific version of {product-title} always installs that version.

ifndef::openshift-origin[]
{product-title} {product-version} offers the following upgrade channels:

* `candidate-{product-version}`
* `fast-{product-version}`
* `stable-{product-version}`
* `eus-4.y` (only when running an even-numbered 4.y cluster release, like 4.10)

endif::openshift-origin[]
ifdef::openshift-origin[]
{product-title} {product-version} offers the following upgrade channel:

* `stable-4`

endif::openshift-origin[]

ifndef::openshift-origin[]
[discrete]
[id="candidate-version-channel_{context}"]
== candidate-{product-version} channel

The `candidate-{product-version}` channel contains candidate builds for a z-stream ({product-version}.z) and previous minor version releases. Release candidates contain all the features of the product but are not supported. Use release candidate versions to test feature acceptance and assist in qualifying the next version of {product-title}. A release candidate is any build that is available in the candidate channel, including ones that do not contain link:https://semver.org/spec/v2.0.0.html#spec-item-9[a pre-release version] such as `-rc` in their names. After a version is available in the candidate channel, it goes through more quality checks. If it meets the quality standard, it is promoted to the `fast-{product-version}` or `stable-{product-version}` channels. Because of this strategy, if a specific release is available in both the `candidate-{product-version}` channel and in the `fast-{product-version}` or `stable-{product-version}` channels, it is a Red Hat-supported version. The `candidate-{product-version}` channel can include release versions from which there are no recommended updates in any channel.
Expand All @@ -49,22 +27,23 @@ endif::[]
for more build information.
====

[discrete]
[id="fast-version-channel_{context}"]
== fast-{product-version} channel

The `fast-{product-version}` channel is updated with new and previous minor versions of {product-version} as soon as Red Hat declares the given version as a general availability release. As such, these releases are fully supported, are production quality, and have performed well while available as a release candidate in the `candidate-{product-version}` channel from where they were promoted. Some time after a release appears in the `fast-{product-version}` channel, it is added to the `stable-{product-version}` channel. Releases never appear in the `stable-{product-version}` channel before they appear in the `fast-{product-version}` channel.

You can use the `fast-{product-version}` channel to upgrade from a previous minor version of {product-title}.
endif::openshift-origin[]

ifndef::openshift-origin[]
[discrete]

[id="stable-version-channel_{context}"]
== stable-{product-version} channel

While the `fast-{product-version}` channel contains releases as soon as their errata are published, releases are added to the `stable-{product-version}` channel after a delay. During this delay, data is collected from Red Hat SRE teams, Red Hat support services, and pre-production and production environments that participate in connected customer program about the stability of the release. You can use the `stable-{product-version}` channel to upgrade from a previous minor version of {product-title}.
endif::openshift-origin[]
ifdef::openshift-origin[]
[discrete]

[id="stable-4-channel_{context}"]
== stable-4 channel
Releases are added to the `stable-4` channel
after passing all tests.
Expand All @@ -74,19 +53,20 @@ You can use the `stable-4` channel to upgrade from a previous minor version of
endif::openshift-origin[]

ifndef::openshift-origin[]
[discrete]

[id="eus-4y-channel_{context}"]
== eus-4.y channel

In addition to the stable channel, all even-numbered minor versions of {product-title} offer an link:https://access.redhat.com/support/policy/updates/openshift#ocp4_phases[Extended Update Support] (EUS). These EUS versions extend the Full and Maintenance support phases for customers with Standard and Premium Subscriptions to 18 months.

Although there is no difference between `stable-4.y` and `eus-4.y` channels until {product-title} 4.y transitions to the EUS phase, you can switch to the `eus-4.y` channel as soon as it becomes available.
Although there is no difference between `stable-4.y` and `eus-4.y` channels until {product-title} 4.y transitions to the EUS phase, you can switch to the `eus-4.y` channel as soon as it becomes available.

When upgrades to the next EUS channel are offered, you can switch to the next EUS channel and upgrade until you have reached the next EUS version.

This upgrade process does not apply for the `eus-4.6` channel.
endif::openshift-origin[]

[discrete]
[id="upgrade-version-paths_{context}"]
== Upgrade version paths

{product-title} maintains an upgrade recommendation service that understands the version of {product-title} you have installed as well as the path to take within the channel you choose to get you to the next release.
Expand Down Expand Up @@ -116,24 +96,27 @@ The presence of an update recommendation in the `stable-4` channel at any point
endif::openshift-origin[]

ifndef::openshift-origin[]
[discrete]

[id="fast-stable-channel-strategies_{context}"]
== Fast and stable channel use and strategies

The `fast-{product-version}` and `stable-{product-version}` channels present a choice between receiving general availability releases as soon as they are available or allowing Red Hat to control the rollout of those updates. If issues are detected during rollout or at a later time, upgrades to that version might be blocked in both the `fast-{product-version}` and `stable-{product-version}` channels, and a new version might be introduced that becomes the new preferred upgrade target.

Customers can improve this process by configuring pre-production systems on the `fast-{product-version}` channel, configuring production systems on the `stable-{product-version}` channel, and participating in the Red Hat connected customer program. Red Hat uses this program to observe the impact of updates on your specific hardware and software configurations. Future releases might improve or alter the pace at which updates move from the `fast-{product-version}` to the `stable-{product-version}` channel.

[discrete]
[id="restricted-network-clusters_{context}"]
== Restricted network clusters

If you manage the container images for your {product-title} clusters yourself, you must consult the Red Hat errata that is associated with product releases and note any comments that impact upgrades. During upgrade, the user interface might warn you about switching between these versions, so you must ensure that you selected an appropriate version before you bypass those warnings.

ifndef::openshift-origin[]
[discrete]

[id="switching-between-channels_{context}"]
== Switching between channels

A channel can be switched from the web console or through the `patch` command:

[source,terminal]
----
$ oc patch clusterversion version --type json -p '[{"op": "add", "path": "/spec/channel", "value": "<channel>”}]'
----
Expand Down
2 changes: 1 addition & 1 deletion modules/unmanaged-operators.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Module included in the following assemblies:
//
// * architecture/architecture-installation.adoc
// * updating/updating-cluster-between-minor.adoc
// * updating/updating-cluster-within-minor.adoc

[id="unmanaged-operators_{context}"]
= Support policy for unmanaged Operators
Expand Down
4 changes: 2 additions & 2 deletions modules/update-service-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
//
// * architecture/architecture-installation.adoc
// * architecture/control-plane.adoc
// * updating/updating-cluster-between-minor.adoc
// * updating/updating-cluster-within-minor.adoc
// * updating/updating-cluster-cli.adoc
// * updating/updating-cluster-rhel-compute.adoc
// * updating/updating-cluster.adoc
Expand Down Expand Up @@ -39,7 +39,7 @@ Only upgrading to a newer version is supported. Reverting or rolling back your c

During the upgrade process, the Machine Config Operator (MCO) applies the new configuration to your cluster machines. The MCO cordons the number of nodes as specified by the `maxUnavailable` field on the machine configuration pool and marks them as unavailable. By default, this value is set to `1`. The MCO then applies the new configuration and reboots the machine.

If you use {op-system-base-full} machines as workers, the MCO does not update the kubelet because you must update the OpenShift API on the machines first.
If you use {op-system-base-full} machines as workers, the MCO does not update the kubelet because you must update the OpenShift API on the machines first.

With the specification for the new version applied to the old kubelet, the {op-system-base} machine cannot return to the `Ready` state. You cannot complete the update until the machines are available. However, the maximum number of unavailable nodes is set to ensure that normal cluster operations can continue with that number of machines out of service.

Expand Down
31 changes: 4 additions & 27 deletions modules/update-upgrading-web.adoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,11 @@
// Module included in the following assemblies:
//
// * updating/updating-cluster.adoc
// * updating/updating-cluster-between-minor.adoc
// * updating/updating-cluster-within-minor.adoc


ifeval::["{context}" == "updating-cluster"]
:within:
endif::[]
ifeval::["{context}" == "updating-cluster-between-minor"]
:between:
endif::[]
ifeval::["{context}" == "updating-cluster-rhel-compute"]
:rhel:
:between:
endif::[]

[id="update-upgrading-web_{context}"]
Expand All @@ -30,35 +24,19 @@ link:https://access.redhat.com/downloads/content/290[in the errata section] of t

. From the web console, click *Administration* -> *Cluster Settings* and review the contents of the *Details* tab.

. For production clusters, ensure that the *Channel* is set to the correct channel for
ifdef::within[]
the version that you want to update to,
endif::within[]
ifdef::between[]
your current minor version,
endif::between[]
ifndef::openshift-origin[]
such as `stable-{product-version}`.
. For production clusters, ensure that the *Channel* is set to the correct channel for the version that you want to update to, such as `stable-{product-version}`.
+
[IMPORTANT]
====
For production clusters, you must subscribe to a stable-* or fast-* channel.
====
endif::openshift-origin[]
ifdef::openshift-origin[]
such as `stable-4`.
endif::openshift-origin[]
** If the *Update status* is not *Updates available*, you cannot upgrade your cluster.
** *Select channel* indicates the cluster version that your cluster is running or is updating to.

. Select
ifdef::within[]
a version to update to,
endif::within[]
ifdef::between[]
the highest available version
endif::between[]
and click *Save*.
. Select a version to update to, and click *Save*.
+
The Input channel
*Update status* changes to *Update to <product-version> in progress*, and you can review the progress of the cluster update by watching the progress bars for the Operators and nodes.
Expand All @@ -69,7 +47,6 @@ If you are upgrading your cluster to the next minor version, like version 4.y to
====


ifdef::between[]
. After the update completes and the Cluster Version Operator refreshes the available updates, check if more updates are available in your current channel.
+
--
Expand Down
Loading