Skip to content

OSDOCS-16580: Address Vale warnings and errors in "Upgrading" #102886

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

OSDOCS-16580: Address Vale warnings and errors in "Upgrading" #102886

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 1 addition & 2 deletions modules/rosa-hcp-upgrade-options.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@
[id="rosa-upgrade-options_{context}"]
= Upgrade options for {product-title} clusters

In OpenShift, upgrading means provisioning a new component with updated software and using it to replace an existing component that has outdated software.

[role="_abstract"]
You can control the impact of upgrades to your workload by controlling which parts of the cluster are upgraded, for example:

Upgrade only the hosted control plane:: This initiates upgrade of the hosted control plane. It does not impact your worker nodes.
Expand Down
7 changes: 4 additions & 3 deletions modules/rosa-hcp-upgrading-cli-control-plane.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
ifeval::["{context}" != "rosa-hcp-upgrading-whole-cluster"]
= Upgrading the hosted control plane with the ROSA CLI

[role="_abstract"]
You can manually upgrade the hosted control plane of a {product-title} cluster by using the ROSA CLI. This method schedules the control plane for an upgrade if a more recent version is available, either immediately, or at a specified future time.

[NOTE]
Expand Down Expand Up @@ -40,9 +41,9 @@ endif::[]
+
[source,terminal]
----
$ rosa describe cluster --cluster=<cluster_name_or_id> <1>
$ rosa describe cluster --cluster=<cluster_name_or_id>
----
<1> Replace `<cluster_name_or_id>` with the cluster name or the cluster ID.
Replace `<cluster_name_or_id>` with the cluster name or the cluster ID.

. List the versions that you can upgrade your control plane to by running the following command:
+
Expand All @@ -53,7 +54,7 @@ $ rosa list upgrade --cluster=<cluster_name_or_id>
+
The command returns a list of available updates, including the recommended version.
+
.Example output
*Example output*
+
[source,terminal]
----
Expand Down
17 changes: 11 additions & 6 deletions modules/rosa-hcp-upgrading-cli-machinepool.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
ifeval::["{context}" != "rosa-hcp-upgrading-whole-cluster"]
= Upgrading machine pools with the ROSA CLI

[role="_abstract"]
You can manually upgrade one or more machine pools in a {hcp-title} cluster by using the ROSA CLI. This method schedules the specified machine pool for an upgrade if a more recent version is available, either immediately, or at a specified future time.

[NOTE]
Expand Down Expand Up @@ -41,19 +42,22 @@ Machine pool configurations such as node drain timeout, max-unavailable, and max
+
[source,terminal]
----
$ rosa describe cluster --cluster=<cluster_name_or_id> <1>
$ rosa describe cluster --cluster=<cluster_name_or_id>
----
<1> Replace `<cluster_name_or_id>` with the cluster name or the cluster ID.
Replace `<cluster_name_or_id>` with the cluster name or the cluster ID.
+
ifeval::["{context}" != "rosa-hcp-upgrading-whole-cluster"]
.Example output

*Example output*
Copy link
Contributor

@EricPonvelle EricPonvelle Nov 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You need to add a + to fix this:

Image

+
[source,terminal]
----
OpenShift Version: 4.14.0
----
endif::[]
ifeval::["{context}" == "rosa-hcp-upgrading-whole-cluster"]
.Example output
*Example output*
+
[source,terminal]
----
OpenShift Version: 4.14.8
Expand All @@ -70,7 +74,7 @@ $ rosa list upgrade --cluster <cluster-name> --machinepool <machinepool_name>
+
The command returns a list of available updates, including the recommended version.
+
.Example output
*Example output*
+
[source,terminal]
----
Expand All @@ -93,7 +97,8 @@ Do not upgrade your machine pool to a version higher than your control plane. If
$ rosa describe machinepool --cluster=<cluster_name_or_id> <machinepool_name>
----
+
.Example output
*Example output*
+
[source,terminal]
----
Replicas: 5
Expand Down
3 changes: 3 additions & 0 deletions upgrading/rosa-hcp-upgrading.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,9 @@ include::_attributes/attributes-openshift-dedicated.adoc[]

toc::[]

[role="_abstract"]
In {product-title}, upgrading provisions a new component with updated software and uses it to replace an existing component that has outdated software.

include::modules/rosa-hcp-upgrade-options.adoc[leveloffset=+1]

.Additional resources
Expand Down