Skip to content

Commit 614fbc9

Browse files
authored
Merge pull request #44907 from sayjadha/JIRA-OSDOCS3322
JIRA-OSDOCS3322: Updated the steps for cluster upgrades per the UI changes
2 parents 5e0710c + 60a20ca commit 614fbc9

10 files changed

+58
-38
lines changed

_topic_maps/_topic_map_rosa.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -243,9 +243,9 @@ Name: Upgrading
243243
Dir: upgrading
244244
Distros: openshift-rosa
245245
Topics:
246-
#- Name: Preparing to upgrade ROSA to 4.9
247-
# File: rosa-upgrading-cluster-prepare
248-
# Distros: openshift-rosa
246+
- Name: Preparing to upgrade ROSA to 4.9
247+
File: rosa-upgrading-cluster-prepare
248+
Distros: openshift-rosa
249249
- Name: Upgrading ROSA with STS
250250
File: rosa-upgrading-sts
251251
- Name: Upgrading ROSA

modules/osd-create-cluster-ccs.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,11 @@ CIDR configurations cannot be changed later. Confirm your selections with your n
220220
You can review the end-of-life dates in the update life cycle documentation for {product-title}. For more information, see _{product-title} update life cycle_.
221221
====
222222
+
223+
.. Provide administrator approval based on your cluster update method:
224+
** Individual updates: If you select an update version that requires approval, provide an administrator’s acknowledgment and click *Approve and continue*.
225+
** Recurring updates: If you selected recurring updates for your cluster, provide an administrator’s acknowledgment and click *Approve and continue*. {cluster-manager} does not start scheduled y-stream updates for minor versions without receiving an administrator’s acknowledgment.
226+
+
227+
For information about administrator acknowledgment, see xref:./../upgrading/osd-upgrading-cluster-prepare.adoc#upgrade-49-acknowledgement_osd-updating-cluster-prepare[Administrator acknowledgment when upgrading to OpenShift 4.9].
223228
.. If you opted for recurring updates, select a preferred day of the week and upgrade start time in UTC from the drop-down menus.
224229
.. Optional: You can set a grace period for *Node draining* during cluster upgrades. A *1 hour* grace period is set by default.
225230
.. Click *Next*.

modules/osd-create-cluster-red-hat-account.adoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,11 @@ If the cluster privacy is set to *Private*, you cannot access your cluster until
105105
You can review the end-of-life dates in the update life cycle documentation for {product-title}. For more information, see _{product-title} update life cycle_.
106106
====
107107
+
108+
.. Provide administrator approval based on your cluster update method:
109+
** Individual updates: If you select an update version that requires approval, provide an administrator’s acknowledgment and click *Approve and continue*.
110+
** Recurring updates: If you selected recurring updates for your cluster, provide an administrator’s acknowledgment and click *Approve and continue*. {cluster-manager} does not start scheduled y-stream updates for minor versions without receiving an administrator’s acknowledgment.
111+
+
112+
For information about administrator acknowledgment, see xref:./../upgrading/osd-upgrading-cluster-prepare.adoc#upgrade-49-acknowledgement_osd-updating-cluster-prepare[Administrator acknowledgment when upgrading to OpenShift 4.9].
108113
.. If you opted for recurring updates, select a preferred day of the week and upgrade start time in UTC from the drop-down menus.
109114
.. Optional: You can set a grace period for *Node draining* during cluster upgrades. A *1 hour* grace period is set by default.
110115
.. Click *Next*.

modules/rosa-upgrading-automatic-ocm.adoc

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,20 @@
55

66
:_content-type: PROCEDURE
77
[id="rosa-scheduling-upgrade_{context}"]
8-
= Scheduling automatic upgrades
8+
= Scheduling recurring upgrades for your cluster
99

10-
You can schedule automatic upgrades for a {product-title} cluster through {cluster-manager-first} console.
10+
You can schedule recurring, automatic upgrades for z-stream patch versions for your {product-title} cluster through the {cluster-manager} console.
1111

1212
.Procedure
1313

1414
. Log in to {cluster-manager-url}.
1515
. Select a cluster to upgrade.
1616
. Click the *Settings* tab.
17-
. In the *Update strategy* pane, click *Automatic* and select a preferred day of the week and start time for the automatic upgrades.
17+
. In the *Update strategy* pane, select *Recurring updates*.
18+
. Select a preferred day of the week and start time for the upgrade, when updates are available.
19+
. Provide an administrator’s acknowledgment and click *Approve and continue*. {cluster-manager} does not start scheduled y-stream updates for minor versions without receiving an administrator’s acknowledgment.
20+
+
21+
For information about administrator acknowledgment, see xref:./../upgrading/rosa-upgrading-cluster-prepare.adoc#upgrade-49-acknowledgement_rosa-updating-cluster-prepare[Administrator acknowledgment when upgrading to OpenShift 4.9].
1822
. In the *Node draining* pane, select a grace period interval from the list. The grace period enables the nodes to gracefully drain before forcing the pod eviction. The default is *1 hour*.
1923
. In the *Update strategy* pane, click *Save* to apply your update strategy.
2024
+

modules/rosa-upgrading-manual-ocm.adoc

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ endif::[]
99

1010
:_content-type: PROCEDURE
1111
[id="rosa-upgrade-ocm_{context}"]
12-
= Upgrading using the console
12+
= Scheduling individual upgrades through the {cluster-manager} console
1313

14-
You can upgrade a {product-title} cluster
14+
You can schedule upgrades for a {product-title} cluster
1515
ifdef::sts[]
1616
that uses the AWS Security Token Service (STS)
1717
endif::sts[]
18-
manually by using {cluster-manager} console.
18+
manually one time by using {cluster-manager} console.
1919

2020
ifdef::sts[]
2121
.Prerequisites
@@ -28,7 +28,11 @@ endif::sts[]
2828
. Log in to {cluster-manager-url}.
2929
. Select a cluster to upgrade.
3030
. Click the *Settings* tab.
31-
. In the *Update strategy* pane, click *Manual* or *Individual Updates*.
31+
. In the *Update strategy* pane, select *Individual Updates*.
32+
. Select the version you want to upgrade your cluster to. Recommended cluster upgrades appear in the UI.
33+
. If you select an update version that requires approval, provide an administrator’s acknowledgment and click *Approve and continue*.
34+
+
35+
For information about administrator acknowledgment, see xref:./../upgrading/rosa-upgrading-cluster-prepare.adoc#upgrade-49-acknowledgement_rosa-updating-cluster-prepare[Administrator acknowledgment when upgrading to OpenShift 4.9].
3236
. In the *Node draining* pane, select a grace period interval from the list. The grace period enables the nodes to gracefully drain before forcing the pod eviction. The default is *1 hour*.
3337
. In the *Update strategy* pane, click *Save* to apply your update strategy.
3438
. In the *Update status* pane, review the *Update available* information and click *Update*.

modules/upgrade-auto.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,27 +6,29 @@
66
:_content-type: PROCEDURE
77
[id="upgrade-auto_{context}"]
88

9-
= Automatically upgrading your cluster through {cluster-manager-first}
9+
= Scheduling recurring upgrades for your cluster
1010

1111

12-
You can use {cluster-manager} to automatically upgrade your {product-title} cluster on a weekly basis. Based on upstream changes, there might be times when no updates are released. Therefore, no upgrade occurs for that week.
12+
You can use {cluster-manager} to schedule recurring, automatic upgrades for z-stream patch versions for your {product-title} cluster. Based on upstream changes, there might be times when no updates are released. Therefore, no upgrade occurs for that week.
1313

1414
.Procedure
1515

1616
. From {console-red-hat}, select your cluster from the clusters list.
1717

1818
. Click the *Upgrade settings* tab to access the upgrade operator.
1919

20-
. To schedule automatic upgrades, select *Automatic*.
20+
. To schedule recurring upgrades, select *Recurring updates*.
21+
22+
. Provide an administrator’s acknowledgment and click *Approve and continue*. {cluster-manager} does not start scheduled y-stream updates for minor versions without receiving an administrator’s acknowledgment.
2123

2224
. Specify the day of the week and the time you want your cluster to upgrade.
2325

2426
. Click *Save*.
2527

2628
. Optional: Set a grace period for *Node draining* by selecting a designated amount of time from the drop down list. A *1 hour* grace period is set by default.
2729

28-
. To edit an existing automatic upgrade policy, edit the preferred day or start time from the *Upgrade Settings* tab. Click *Save*.
30+
. To edit an existing recurring upgrade policy, edit the preferred day or start time from the *Upgrade Settings* tab. Click *Save*.
2931

30-
. To cancel an automatic upgrade policy, switch the upgrade method to manual from the *Upgrade Settings* tab. Click *Save*.
32+
. To cancel a recurring upgrade policy, switch the upgrade method to individual from the *Upgrade Settings* tab. Click *Save*.
3133

3234
On the *Upgrade settings* tab, the *Upgrade status* box indicates that an upgrade is scheduled. The date and time of the next scheduled update is listed.

modules/upgrade-manual.adoc

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66
:_content-type: PROCEDURE
77
[id="upgrade-manual_{context}"]
88

9-
= Manually upgrading your cluster through {cluster-manager-first}
9+
= Scheduling individual upgrades for your cluster
1010

1111

12-
You can use {cluster-manager} to manually upgrade your {product-title} cluster.
12+
You can use {cluster-manager} to manually upgrade your {product-title} cluster one time.
1313

1414

1515
.Procedure
@@ -18,9 +18,14 @@ You can use {cluster-manager} to manually upgrade your {product-title} cluster.
1818

1919
. Click the *Upgrade settings* tab to access the upgrade operator. You can also update your cluster from the *Overview* tab by clicking *Update* next to the cluster version under the *Details* heading.
2020

21+
22+
. To schedule an individual upgrade, select *Individual updates*.
23+
2124
. Click *Update* in the *Update Status* box.
2225

23-
. Select the version you want to upgrade your cluster to. Recommended cluster upgrades will be notated in the UI. To learn more about each available upgrade version, click *View release notes*.
26+
. Select the version you want to upgrade your cluster to. Recommended cluster upgrades appear in the UI. To learn more about each available upgrade version, click *View release notes*.
27+
28+
. If you select an update version that requires approval, provide an administrator’s acknowledgment and click *Approve and continue*.
2429

2530
. Click *Next*.
2631

@@ -42,5 +47,5 @@ The same upgrade details are available on the *Upgrade settings* tab under the *
4247

4348
[WARNING]
4449
====
45-
In the event that a CVE or other critical issue to OpenShift Dedicated is found, all clusters are upgraded within 48 hours of the fix being released. You are notified when the fix is available and informed that the cluster will be automatically upgraded at your latest preferred start time before the 48 hour window closes. You can also upgrade manually at any time before the automatic upgrade starts.
50+
In the event that a CVE or other critical issue to {product-title} is found, all clusters are upgraded within 48 hours of the fix being released. You are notified when the fix is available and informed that the cluster will be automatically upgraded at your latest preferred start time before the 48 hour window closes. You can also upgrade manually at any time before the recurring upgrade starts.
4651
====

modules/upgrade.adoc

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,19 +20,23 @@ All Kubernetes objects and PVs in each {product-title} cluster are backed up as
2020
====
2121

2222
[id="upgrade-automatic_{context}"]
23-
== Automatic upgrades
23+
== Recurring upgrades
2424

2525
Upgrades can be scheduled to occur automatically on a day and time specified by the cluster owner or administrator. Upgrades occur on a weekly basis, unless an upgrade is unavailable for that week.
2626

27+
If you select recurring updates for your cluster, you must provide an administrator’s acknowledgment. {cluster-manager} does not start scheduled y-stream updates for minor versions without receiving an administrator’s acknowledgment. For information about administrator acknowledgment, see link:https://docs.openshift.com/dedicated/upgrading/osd-upgrading-cluster-prepare.html#upgrade-49-acknowledgement_osd-updating-cluster-prepare[Administrator acknowledgment when upgrading to OpenShift 4.9].
28+
2729
[NOTE]
2830
====
29-
Automatic upgrade policies are optional and if they are not set, the upgrade policies default to manual.
31+
Recurring upgrade policies are optional and if they are not set, the upgrade policies default to individual.
3032
====
3133

3234
[id="upgrade-manual_upgrades_{context}"]
33-
== Manual upgrades
35+
== Individual upgrades
36+
37+
If you opt for individual upgrades, you are responsible for updating your cluster. If you select an update version that requires approval, you must provide an administrator’s acknowledgment. For information about administrator acknowledgment, see xref:./../upgrading/osd-upgrading-cluster-prepare.adoc#upgrade-49-acknowledgement_osd-updating-cluster-prepare[Administrator acknowledgment when upgrading to OpenShift 4.9].
3438

35-
If you opt for manual upgrades, you are responsible for updating your cluster. If your cluster version falls too far behind, it will transition to a limited support status. For more information on OpenShift life cycle policies, see xref:../osd_architecture/osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].
39+
If your cluster version becomes outdated, it will transition to a limited support status. For more information on OpenShift life cycle policies, see xref:../osd_architecture/osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].
3640

3741
[id="upgrade-notifications_{context}"]
3842
== Upgrade notifications
@@ -48,7 +52,7 @@ Every change of state also triggers an email notification to the cluster owner a
4852

4953
[NOTE]
5054
====
51-
For automatic upgrades, you will also receive email notifications before the upgrade occurs based on the following cadence:
55+
For recurring upgrades, you will also receive email notifications before the upgrade occurs based on the following cadence:
5256
5357
* 2 week notice
5458
* 1 week notice

upgrading/rosa-upgrading-sts.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ To plan an upgrade, review the xref:../rosa_architecture/rosa_policy_service_def
1616

1717
There are two methods to upgrade {product-title} (ROSA) clusters that uses the AWS Security Token Service (STS):
1818

19-
* Manual upgrades through the `rosa` CLI
20-
* Manual upgrades through the {cluster-manager} console
19+
* Individual upgrades through the `rosa` CLI
20+
* Individual upgrades through the {cluster-manager} console
2121

2222
[NOTE]
2323
====

upgrading/rosa-upgrading.adoc

Lines changed: 3 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -15,24 +15,15 @@ To plan an upgrade, review the xref:../rosa_architecture/rosa_policy_service_def
1515
== Upgrading a ROSA cluster
1616
There are three methods to upgrade {product-title} (ROSA) clusters:
1717

18-
* Manual upgrades through the `rosa` CLI
19-
* Manual upgrades through the {cluster-manager} console
20-
* Automatic upgrades through the {cluster-manager} console
21-
22-
Remove
18+
* Individual upgrades through the `rosa` CLI
19+
* Individual upgrades through the {cluster-manager-url} console
20+
* Recurring upgrades through the {cluster-manager-url} console
2321

2422
[NOTE]
2523
====
2624
For steps to upgrade a ROSA cluster that uses the AWS Security Token Service (STS), see xref:../upgrading/rosa-upgrading-sts.adoc#rosa-upgrading-sts[Upgrading ROSA clusters with STS].
2725
====
2826

29-
30-
There are three methods to upgrade {product-title} (ROSA) clusters:
31-
32-
* Manual upgrades through the `rosa` CLI
33-
* Manual upgrades through the {cluster-manager-url} console
34-
* Automatic upgrades through the {cluster-manager-url} console
35-
3627
include::modules/rosa-upgrading-cli-tutorial.adoc[leveloffset=+2]
3728
include::modules/rosa-upgrading-manual-ocm.adoc[leveloffset=+2]
3829
include::modules/rosa-upgrading-automatic-ocm.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)