Skip to content

Commit abbffa2

Browse files
committed
add upgrade cluster command to ROSA docs
1 parent 50a6c00 commit abbffa2

File tree

1 file changed

+101
-4
lines changed

1 file changed

+101
-4
lines changed

modules/rosa-upgrade-cluster-cli.adoc

Lines changed: 101 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
// * rosa_cli/rosa-manage-objects-cli.adoc
55
:_mod-docs-content-type: REFERENCE
66
[id="rosa-upgrading-cluster_{context}"]
7-
= Upgrade and delete upgrade for clusters
7+
= Upgrade and delete upgrade for objects
88

9-
This section describes the `upgrade` command usage for clusters.
9+
This section describes the `upgrade` command usage for objects.
1010

1111
[id="rosa-upgrade-cluster_{context}"]
1212
== upgrade cluster
@@ -39,9 +39,17 @@ $ rosa upgrade cluster --cluster=<cluster_name> | <cluster_id> [arguments]
3939
|--schedule-time
4040
|The next time the upgrade will run on the specified date. Format: `HH:mm`
4141

42-
|--node-drain-grace-period
42+
|--node-drain-grace-period ^[1]^
4343
|Sets a grace period (string) for how long the pod disruption budget-protected workloads are respected during upgrades. After this grace period, any workloads protected by pod disruption budgets that have not been successfully drained from a node will be forcibly evicted. Default: `1 hour`
44+
45+
|--control-plane ^[2]^
46+
|Upgrades the cluster's hosted control plane.
4447
|===
48+
[.small]
49+
--
50+
1. Classic clusters only
51+
2. {hcp-title} clusters only
52+
--
4553

4654
.Optional arguments inherited from parent commands
4755
[cols="30,70"]
@@ -68,7 +76,7 @@ $ rosa upgrade cluster --cluster=mycluster --version 4.5.20
6876
----
6977

7078
[id="rosa-delete-upgrade-cluster_{context}"]
71-
== delete upgrade
79+
== delete cluster upgrade
7280

7381
Cancel a scheduled cluster upgrade.
7482

@@ -101,3 +109,92 @@ $ rosa delete upgrade --cluster=<cluster_name> | <cluster_id>
101109
|--yes
102110
|Automatically answers `yes` to confirm the operation.
103111
|===
112+
113+
[id="rosa-upgrade-machinepool_{context}"]
114+
== upgrade machinepool
115+
116+
Upgrades a specific machine pool configured on a cluster.
117+
118+
[NOTE]
119+
====
120+
The `upgrade` command for machinepools applies to {hcp-title} clusters only.
121+
====
122+
123+
.Syntax
124+
[source,terminal]
125+
----
126+
$ rosa upgrade machinepool --cluster=<cluster_name> <machinepool_name>
127+
----
128+
129+
.Arguments
130+
[cols="30,70"]
131+
|===
132+
|Option |Definition
133+
134+
|--cluster
135+
|Required: The name or ID (string) of the cluster.
136+
|===
137+
138+
.Optional arguments inherited from parent commands
139+
[cols="30,70"]
140+
|===
141+
|Option |Definition
142+
143+
|--help
144+
|Shows help for this command.
145+
146+
|--debug
147+
|Enables debug mode.
148+
149+
|--profile
150+
|Specifies an AWS profile (string) from your credentials file.
151+
|===
152+
153+
.Example
154+
Upgrade a machine pool on a cluster named `mycluster`.
155+
[source,terminal]
156+
----
157+
$ rosa upgrade machinepool --cluster=mycluster
158+
----
159+
160+
[id="rosa-delete-upgrade-machinepool_{context}"]
161+
== delete machinepool upgrade
162+
163+
Cancel a scheduled machinepool upgrade.
164+
165+
.Syntax
166+
[source,terminal]
167+
----
168+
$ rosa delete upgrade --cluster=<cluster_name> <machinepool_name>
169+
----
170+
171+
.Arguments
172+
[cols="30,70"]
173+
|===
174+
|Option |Definition
175+
176+
|--cluster
177+
|Required: The name or ID (string) of the cluster.
178+
|===
179+
180+
.Optional arguments inherited from parent commands
181+
[cols="30,70"]
182+
|===
183+
|Option |Definition
184+
185+
|--help
186+
|Shows help for this command.
187+
188+
|--debug
189+
|Enables debug mode.
190+
191+
|--profile
192+
|Specifies an AWS profile (string) from your credentials file.
193+
|===
194+
195+
// .Example
196+
// Delete a machine pool named `mymachinepool` on a cluster named `mycluster`.
197+
// [source,terminal]
198+
// ----
199+
// $ rosa upgrade machinepool --cluster=mycluster --machinepool=mymachinepool
200+
// ----

0 commit comments

Comments
 (0)