Skip to content

Commit 8c2feea

Browse files
authored
Merge pull request #71393 from EricPonvelle/OSDOCS-8914_HCP-Upgrades
OSDOCS-8914: Explaining upgrades for ROSA with HCP clusters.
2 parents 15a4fb4 + ed7dd71 commit 8c2feea

File tree

2 files changed

+119
-9
lines changed

2 files changed

+119
-9
lines changed
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * upgrading/rosa-hcp-upgrading.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="rosa-hcp-upgrading-cli_{context}"]
7+
= Upgrading with the ROSA CLI
8+
9+
You can manually upgrade a {hcp-title} cluster by using the ROSA CLI. This method schedules the cluster for an immediate upgrade if a more recent version is available.
10+
11+
[NOTE]
12+
====
13+
Your control plane only supports machine pools within two minor Y-stream versions. For example, a {hcp-title} cluster with a control plane using version 4.15.z supports machine pools with version 4.13.z and 4.14.z, but the control plane does not support machine pools using version 4.12.z.
14+
====
15+
16+
.Prerequisites
17+
18+
* You have installed and configured the latest version of the ROSA CLI.
19+
20+
.Procedure
21+
22+
. Verify the current version of your cluster by running the following command:
23+
+
24+
[source,terminal]
25+
----
26+
$ rosa describe cluster --cluster=<cluster_name_or_id> <1>
27+
----
28+
<1> Replace `<cluster_name_or_id>` with the cluster name or the cluster ID.
29+
30+
. List the versions that you can upgrade your control plane and machine pools to by running the following commands:
31+
+
32+
.. For the control plane versions, run the following command:
33+
+
34+
[source,terminal]
35+
----
36+
$ rosa list upgrade --cluster=<cluster_name|cluster_id>
37+
----
38+
+
39+
The command returns a list of available updates, including the recommended version.
40+
+
41+
.Example output
42+
+
43+
[source,terminal]
44+
----
45+
VERSION NOTES
46+
4.14.8 recommended
47+
4.14.7
48+
4.14.6
49+
----
50+
+
51+
.. For the machine pool versions, run the following command:
52+
+
53+
[source,terminal]
54+
----
55+
$ rosa list upgrade --cluster <cluster-name> --machinepool <machinepool_name>
56+
----
57+
+
58+
The command returns a list of available updates, including the recommended version.
59+
+
60+
.Example output
61+
+
62+
[source,terminal]
63+
----
64+
VERSION NOTES
65+
4.14.5 recommended
66+
4.14.4
67+
4.14.3
68+
4.14.2
69+
4.14.1
70+
----
71+
+
72+
[NOTE]
73+
====
74+
The latest available update for machine pools is limited to the current current version of the control plane. Ensure your control plane is up to date first.
75+
====
76+
77+
. Upgrade your cluster with one of the following options:
78+
** Upgrade the cluster's hosted control plane by running the following command:
79+
+
80+
[source,terminal]
81+
----
82+
$ rosa upgrade cluster -c <cluster_name> --control-plane [--schedule-date=XX --schedule-time=XX] [--version <version_number>]
83+
----
84+
+
85+
Your hosted control plane is now scheduled for an upgrade.
86+
87+
** Upgrade a specific machine pool on your cluster by running the following command:
88+
+
89+
[source,terminal]
90+
----
91+
$ rosa upgrade machinepool -c <cluster_name> <your_machine_pool_id> [--schedule-date=XX --schedule-time=XX] [--version <version_number>]
92+
----
93+
+
94+
Your machine pool is now scheduled for an upgrade.
95+
//
96+
// ** Upgrade both the hosted control plane and all attached machine pools by running the following command:
97+
// +
98+
// [source,terminal]
99+
// ----
100+
// $ rosa upgrade cluster -c <cluster_name> [--schedule-date=XX --schedule-time=XX] [--version <version_number>]
101+
// ----
102+
// +
103+
// Your hosted control plane and machine pools are now scheduled for an upgrade.
104+
105+
.Troubleshooting
106+
* Sometimes a scheduled upgrade does not initiate. See link:https://access.redhat.com/solutions/6648291[Upgrade maintenance cancelled] for more information.

upgrading/rosa-hcp-upgrading.adoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,24 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
66

77
toc::[]
88

9-
[id="rosa-hcp-lifecycle-policy_{context}"]
10-
== Life cycle policies and planning
9+
You can upgrade {hcp-title-first} clusters by individually upgrading the hosted control plane and the machine pools with the ROSA command line interface (CLI), `rosa`.
1110

12-
To plan an upgrade, review the xref:../rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc#rosa-life-cycle[{product-title} update life cycle]. The life cycle page includes release definitions, support and upgrade requirements, installation policy information and life cycle dates.
11+
Use one of the following methods to upgrade your HCP clusters:
1312

14-
You can manually upgrade your cluster. Red Hat Site Reliability Engineers (SREs) monitor upgrade progress and remedy any issues encountered.
13+
* Upgrade only your hosted control plane. This does not impact your worker nodes.
14+
* Upgrade only your machine pool. This initiates a rolling reboot of a specific machine pool and temporarily impacts the worker nodes on the specific machine pool. It does not impact all your worker nodes if you have multiple machine pools.
15+
* Upgrade your hosted control plane first and then your machine pool.
16+
+
17+
[NOTE]
18+
====
19+
If you want to upgrade both your hosted control plane and your machine pool to the same version, you must upgrade the the hosted control plane first.
20+
====
1521
16-
[id="rosa-hcp-upgrading-a-cluster"]
17-
== Upgrading a ROSA cluster
18-
You can upgrade {hcp-title-first} clusters by using individual upgrades through the {product-title} (ROSA) CLI, `rosa`.
22+
To plan an upgrade, review the xref:../rosa_architecture/rosa_policy_service_definition/rosa-hcp-life-cycle.adoc#rosa-hcp-life-cycle[{hcp-title} update life cycle] documentation. The life cycle page includes release definitions, support and upgrade requirements, installation policy information, and life cycle dates.
1923

2024
[NOTE]
2125
====
22-
When following a scheduled upgrade policy, there might be a delay of no more than thirty minutes before the upgrade process begins, even if it is an immediate upgrade. Additionally, the duration of the upgrade might vary based on your workload configuration and with machine pool upgrades, the number of worker nodes.
26+
Hosted control plane upgrade duration varies based on your workload configuration, and machine pool upgrade duration varies based on the number of worker nodes.
2327
====
2428

25-
include::modules/rosa-upgrading-cli-tutorial.adoc[leveloffset=+2]
29+
include::modules/rosa-hcp-upgrading-cli-tutorial.adoc[leveloffset=+1]

0 commit comments

Comments
 (0)