Skip to content

Commit 4dff828

Browse files
authored
Merge pull request #43138 from sagidlow/OSDOCS-3172
OSDOCS-3172: Changing terminology from upgrade to update
2 parents df0051f + a867d0a commit 4dff828

18 files changed

+42
-42
lines changed

modules/understanding-upgrade-channels.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Cluster administrators can configure the upgrade channel from the web console.
1616

1717
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.
1818

19-
You can use the `candidate-{product-version}` channel to upgrade from a previous minor version of {product-title}.
19+
You can use the `candidate-{product-version}` channel to update from a previous minor version of {product-title}.
2020

2121
[NOTE]
2222
====

modules/update-configuring-image-signature.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You must perform following steps each time that you update a cluster.
1515

1616
.Procedure
1717

18-
. Review the link:https://access.redhat.com/solutions/4583231[{product-title} upgrade paths] knowledge base article to determine a valid upgrade path for your cluster.
18+
. Review the link:https://access.redhat.com/solutions/4583231[{product-title} upgrade paths] knowledge base article to determine a valid update path for your cluster.
1919

2020
. Add the version to the `OCP_RELEASE_NUMBER` environment variable:
2121
+

modules/update-mirror-repository.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
[id="update-mirror-repository_{context}"]
77
= Mirroring the {product-title} image repository
88

9-
Before you upgrade a cluster on infrastructure that you provision in a restricted network, you must mirror the required container images into that environment. You can also use this procedure in unrestricted networks to ensure your clusters only use container images that have satisfied your organizational controls on external content.
9+
Before you update a cluster on infrastructure that you provision in a restricted network, you must mirror the required container images into that environment. You can also use this procedure in unrestricted networks to ensure your clusters only use container images that have satisfied your organizational controls on external content.
1010

1111
.Procedure
1212

13-
. Use the link:https://access.redhat.com/labs/ocpupgradegraph/update_channel[Red Hat {product-title} Upgrade Graph visualizer and update planner] to plan an upgrade from one version to another. The OpenShift Upgrade Graph provides channel graphs and a way to confirm that there is an update path between your current and intended cluster versions.
13+
. Use the link:https://access.redhat.com/labs/ocpupgradegraph/update_channel[Red Hat {product-title} Upgrade Graph visualizer and update planner] to plan an update from one version to another. The OpenShift Upgrade Graph provides channel graphs and a way to confirm that there is an update path between your current and intended cluster versions.
1414

1515
. Set the required environment variables:
1616
.. Export the release version:
@@ -20,7 +20,7 @@ Before you upgrade a cluster on infrastructure that you provision in a restricte
2020
$ export OCP_RELEASE=<release_version>
2121
----
2222
+
23-
For `<release_version>`, specify the tag that corresponds to the version of {product-title} to which you want to upgrade, such as `4.5.4`.
23+
For `<release_version>`, specify the tag that corresponds to the version of {product-title} to which you want to update, such as `4.5.4`.
2424

2525
.. Export the local registry name and host port:
2626
+

modules/update-service-mirror-release.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Complete the following steps on the mirror host:
2828

2929
. Review the
3030
link:https://access.redhat.com/downloads/content/290/[{product-title} downloads page]
31-
to determine the version of {product-title} to which you want to upgrade and determine the corresponding tag on the link:https://quay.io/repository/openshift-release-dev/ocp-release?tab=tags[Repository Tags] page.
31+
to determine the version of {product-title} to which you want to update and determine the corresponding tag on the link:https://quay.io/repository/openshift-release-dev/ocp-release?tab=tags[Repository Tags] page.
3232

3333
. Set the required environment variables:
3434
.. Export the release version:

modules/update-service-overview.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ To allow the OpenShift Update Service to provide only compatible updates, a rele
2323

2424
[IMPORTANT]
2525
====
26-
The OpenShift Update Service displays all recommended updates for your current cluster. If an upgrade path is not recommended by the OpenShift Update Service, it might be because of a known issue with the update or the target release.
26+
The OpenShift Update Service displays all recommended updates for your current cluster. If an update path is not recommended by the OpenShift Update Service, it might be because of a known issue with the update or the target release.
2727
====
2828

2929
////
@@ -34,10 +34,10 @@ Two controllers run during continuous update mode. The first controller continuo
3434

3535
[IMPORTANT]
3636
====
37-
Only upgrading to a newer version is supported. Reverting or rolling back your cluster to a previous version is not supported. If your upgrade fails, contact Red Hat support.
37+
Only upgrading to a newer version is supported. Reverting or rolling back your cluster to a previous version is not supported. If your update fails, contact Red Hat support.
3838
====
3939

40-
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.
40+
During the update 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.
4141

4242
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.
4343

modules/update-upgrading-web.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ For production clusters, you must subscribe to a `stable-\*` or `fast-*` channel
3434
ifdef::openshift-origin[]
3535
such as `stable-4`.
3636
endif::openshift-origin[]
37-
** If the *Update status* is not *Updates available*, you cannot upgrade your cluster.
37+
** If the *Update status* is not *Updates available*, you cannot update your cluster.
3838
** *Select channel* indicates the cluster version that your cluster is running or is updating to.
3939

4040
. Select a version to update to and click *Save*.
@@ -44,7 +44,7 @@ The Input channel
4444
+
4545
[NOTE]
4646
====
47-
If you are upgrading your cluster to the next minor version, like version 4.y to 4.(y+1), it is recommended to confirm your nodes are upgraded before deploying workloads that rely on a new feature. Any pools with worker nodes that are not yet updated are displayed on the *Cluster Settings* page.
47+
If you are upgrading your cluster to the next minor version, like version 4.y to 4.(y+1), it is recommended to confirm your nodes are updated before deploying workloads that rely on a new feature. Any pools with worker nodes that are not yet updated are displayed on the *Cluster Settings* page.
4848
====
4949

5050
. After the update completes and the Cluster Version Operator refreshes the available updates, check if more updates are available in your current channel.

modules/update-vsphere-virtual-hardware-on-compute-nodes.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
[id="update-vsphere-virtual-hardware-on-compute-nodes_{context}"]
77
= Updating the virtual hardware for compute nodes on vSphere
88

9-
To reduce the risk of downtime, it is recommended that compute nodes be upgraded serially.
9+
To reduce the risk of downtime, it is recommended that compute nodes be updated serially.
1010

1111
[NOTE]
1212
====
13-
Multiple compute nodes can be upgraded in parallel given workloads are tolerant of having multiple nodes in a `NotReady` state. It is the responsibility of the administrator to ensure that the required compute nodes are available.
13+
Multiple compute nodes can be updated in parallel given workloads are tolerant of having multiple nodes in a `NotReady` state. It is the responsibility of the administrator to ensure that the required compute nodes are available.
1414
====
1515

1616
.Prerequisites
@@ -56,7 +56,7 @@ See the "Understanding how to evacuate pods on nodes" section for other options
5656

5757
. Shut down the virtual machine (VM) associated with the compute node. Do this in the vSphere client by right-clicking the VM and selecting *Power* -> *Shut Down Guest OS*. Do not shut down the VM using *Power Off* because it might not shut down safely.
5858

59-
. Upgrade the VM in the vSphere client. Follow link:https://kb.vmware.com/s/article/1010675[Upgrading a virtual machine to the latest hardware version] in the VMware documentation for more information.
59+
. Update the VM in the vSphere client. Follow link:https://kb.vmware.com/s/article/1010675[Upgrading a virtual machine to the latest hardware version] in the VMware documentation for more information.
6060

6161
. Power on the VM associated with the compute node. Do this in the vSphere client by right-clicking the VM and selecting *Power On*.
6262

modules/update-vsphere-virtual-hardware-on-control-plane-nodes.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[id="update-vsphere-virtual-hardware-on-control-plane-nodes_{context}"]
77
= Updating the virtual hardware for control plane nodes on vSphere
88

9-
To reduce the risk of downtime, it is recommended that control plane nodes be upgraded serially. This ensures that the Kubernetes API remains available and etcd retains quorum.
9+
To reduce the risk of downtime, it is recommended that control plane nodes be updated serially. This ensures that the Kubernetes API remains available and etcd retains quorum.
1010

1111
.Prerequisites
1212

@@ -42,7 +42,7 @@ $ oc adm cordon <control_plane_node>
4242

4343
. Shut down the virtual machine (VM) associated with the control plane node. Do this in the vSphere client by right-clicking the VM and selecting *Power* -> *Shut Down Guest OS*. Do not shut down the VM using *Power Off* because it might not shut down safely.
4444

45-
. Upgrade the VM in the vSphere client. Follow link:https://kb.vmware.com/s/article/1010675[Upgrading a virtual machine to the latest hardware version] in the VMware documentation for more information.
45+
. Update the VM in the vSphere client. Follow link:https://kb.vmware.com/s/article/1010675[Upgrading a virtual machine to the latest hardware version] in the VMware documentation for more information.
4646

4747
. Power on the VM associated with the control plane node. Do this in the vSphere client by right-clicking the VM and selecting *Power On*.
4848

modules/updating-clear.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66
= Recovering when an update fails before it is applied
77

88
If an update fails before it is applied, such as when the version that you
9-
specify cannot be found, you can cancel the upgrade:
9+
specify cannot be found, you can cancel the update:
1010

1111
[source,terminal]
1212
----
1313
$ oc adm upgrade clear
14-
----
14+
----

updating/installing-update-service.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ toc::[]
1313

1414
For clusters with internet accessibility, Red Hat provides over-the-air updates through an {product-title} update service as a hosted service located behind public APIs. However, clusters in a restricted network have no way to access public APIs for update information.
1515

16-
To provide a similar upgrade experience in a restricted network, you can install and configure the OpenShift Update Service locally so that it is available within a disconnected environment.
16+
To provide a similar update experience in a restricted network, you can install and configure the OpenShift Update Service locally so that it is available within a disconnected environment.
1717

1818
The following sections describe how to provide over-the-air updates for your disconnected cluster and its underlying operating system.
1919

@@ -86,7 +86,7 @@ include::modules/update-service-configure-cvo.adoc[leveloffset=+2]
8686

8787
[NOTE]
8888
====
89-
See xref:../networking/enable-cluster-wide-proxy.adoc#nw-proxy-configure-object[Enabling the cluster-wide proxy] to configure the CA to trust the update server.
89+
See xref:../networking/enable-cluster-wide-proxy.adoc#nw-proxy-configure-object[Enabling the cluster-wide proxy] to configure the CA to trust the update server.
9090
====
9191

9292
[id="update-service-delete-service"]

0 commit comments

Comments
 (0)