[OSDOCS-16123]:Prune "CLI Tools" Phase 2 #98783

mletalie · 2025-09-09T20:53:58Z

Version(s):

4.19+
Issue:

https://issues.redhat.com/browse/OSDOCS-16123
Link to docs preview:

Review CLI tools in Classic
Review CLI tools in ROSA
QE review:

QE has approved this change.

Additional information:

ocpdocs-previewbot · 2025-09-09T21:05:48Z

🤖 Wed Sep 17 00:12:41 - Prow CI generated the docs preview:
https://98783--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

ocpdocs-vale-bot · 2025-09-11T20:26:55Z

modules/rosa-configure.adoc

 [IMPORTANT]
 ====
-The method of authenticating using Red Hat single sign-on does not break any existing automations that rely on offline tokens. Red{nbsp}Hat recommends using link:https://console.redhat.com/iam/service-accounts[services accounts] for automation purposes. If you still need to use offline tokens for automation or other purposes, you can download the OpenShift Cluster Manager API token from the link:https://console.redhat.com/openshift/token[OpenShift Cluster Manager API Token] page.
+The method of authenticating using Red{nbsp}Hat single sign-on does not break any existing automations that rely on offline tokens. Red{nbsp}Hat recommends using link:https://console.redhat.com/iam/service-accounts[services accounts] for automation purposes. If you still need to use offline tokens for automation or other purposes, you can download the OpenShift Cluster Manager API token from the link:https://console.redhat.com/openshift/token[OpenShift Cluster Manager API Token] page.


🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{cluster-manager}' rather than the plain text product term 'OpenShift Cluster Manager', unless your use case is an exception.

ocpdocs-vale-bot · 2025-09-11T20:26:57Z

modules/rosa-configure.adoc

 [IMPORTANT]
 ====
-The method of authenticating using Red Hat single sign-on does not break any existing automations that rely on offline tokens. Red{nbsp}Hat recommends using link:https://console.redhat.com/iam/service-accounts[services accounts] for automation purposes. If you still need to use offline tokens for automation or other purposes, you can download the OpenShift Cluster Manager API token from the link:https://console.redhat.com/openshift/token[OpenShift Cluster Manager API Token] page.
+The method of authenticating using Red{nbsp}Hat single sign-on does not break any existing automations that rely on offline tokens. Red{nbsp}Hat recommends using link:https://console.redhat.com/iam/service-accounts[services accounts] for automation purposes. If you still need to use offline tokens for automation or other purposes, you can download the OpenShift Cluster Manager API token from the link:https://console.redhat.com/openshift/token[OpenShift Cluster Manager API Token] page.


🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{cluster-manager}' rather than the plain text product term 'OpenShift Cluster Manager', unless your use case is an exception.

mletalie · 2025-09-12T15:26:59Z

/re-test

ocpdocs-vale-bot · 2025-09-12T15:27:44Z

modules/rosa-create-objects.adoc

 = Create objects
-
+//Adding the following condition fpr pruning purposes. Once pruning complete, note should be removed from HCP docs and flag can be manually added to each create command (where applicable).
+ifdef::openshift-rosa-hcp[]


🤖 [error] AsciiDoc.ValidConditions: File contains unbalanced if statements. Review the file to ensure it contains matching opening and closing if statements.

ocpdocs-vale-bot · 2025-09-12T15:27:45Z

modules/rosa-create-objects.adoc

 $ rosa create admin --cluster=mycluster
 ----
-
+ifdef::openshift-rosa-hcp[]


🤖 [error] AsciiDoc.ValidConditions: File contains unbalanced if statements. Review the file to ensure it contains matching opening and closing if statements.

Think the bot is incorrectly flagging this and following if statements as being unbalanced due to the one above that wasn't.

ocpdocs-vale-bot · 2025-09-12T15:27:46Z

modules/rosa-create-objects.adoc

 |--additional-control-plane-security-group-ids <sec_group_id>
 |The identifier of one or more additional security groups to use along with the default security groups that are used with the control plane nodes created alongside the cluster. For more information on additional security groups, see the requirements for _Security groups_ under _Additional resources_.
-
+ifdef::openshift-rosa-hcp[]


🤖 [error] AsciiDoc.ValidConditions: File contains unbalanced if statements. Review the file to ensure it contains matching opening and closing if statements.

mletalie · 2025-09-12T15:29:08Z

/retest

ocpdocs-vale-bot · 2025-09-15T16:00:15Z

modules/rosa-configure.adoc

 [id="rosa-login_{context}"]
 == login
-There are several methods you can use to log into your Red{nbsp}Hat account using the {product-title} (ROSA) CLI (`rosa`). These methods are described in detail below.
+There are several methods you can use to log into your Red{nbsp}Hat account using the {product-title} CLI (`rosa`). These methods are described in detail below.


🤖 [error] RedHat.TermsErrors: Use 'log in to' rather than 'log into'. For more information, see RedHat.TermsErrors.

AedinC

Looks great Mark. Just had some small nits around conditionals and attributes.

AedinC · 2025-09-16T12:33:41Z

modules/rosa-about.adoc


-
-Use the {product-title} (ROSA) command-line interface (CLI), the `rosa` command, to create, update, manage, and delete ROSA clusters and resources.
+Use the {product-title} command-line interface (CLI) to create, update, manage, and delete {product-title} clusters and resources.


Suggested change

Use the {product-title} command-line interface (CLI) to create, update, manage, and delete {product-title} clusters and resources.

Use the {rosa-cli-first} to create, update, manage, and delete {product-title} clusters and resources.

AedinC · 2025-09-16T12:34:18Z

modules/rosa-cli-classic-examples.adoc

 :_mod-docs-content-type: REFERENCE
 [id="rosa-cli-classic-examples_{context}"]
-= Least privilege permissions for common ROSA Classic CLI commands
+= Least privilege permissions for common {product-title} CLI commands


Suggested change

= Least privilege permissions for common {product-title} CLI commands

= Least privilege permissions for common {rosa-cli} commands

AedinC · 2025-09-16T12:35:47Z

modules/rosa-configure.adoc

 = Configuring the ROSA CLI

-Use the following commands to configure the {product-title} (ROSA) CLI, `rosa`.
+Use the following commands to configure the {product-title} CLI, `rosa`.


Suggested change

Use the following commands to configure the {product-title} CLI, `rosa`.

Use the following commands to configure the {rosa-cli-first}.

AedinC · 2025-09-16T12:36:43Z

modules/rosa-configure.adoc

 [id="rosa-login_{context}"]
 == login
-There are several methods you can use to log into your Red{nbsp}Hat account using the {product-title} (ROSA) CLI (`rosa`). These methods are described in detail below.
+There are several methods you can use to log into your Red{nbsp}Hat account using the {product-title} CLI (`rosa`). These methods are described in detail below.


Suggested change

There are several methods you can use to log into your Red{nbsp}Hat account using the {product-title} CLI (`rosa`). These methods are described in detail below.

There are several methods you can use to log in to your Red{nbsp}Hat account using the {rosa-cli-first}. These methods are described in detail below.

AedinC · 2025-09-16T12:39:34Z

modules/rosa-using-bash-script.adoc



-This is an example workflow of how to use a Bash script with the {product-title} (ROSA) CLI, `rosa`.
+This is an example workflow of how to use a Bash script with the {product-title} CLI, `rosa`.


Suggested change

This is an example workflow of how to use a Bash script with the {product-title} CLI, `rosa`.

This is an example workflow of how to use a Bash script with the {rosa-cli-first}.

AedinC · 2025-09-16T12:50:53Z

cli_reference/rosa_cli/rosa-manage-objects-cli.adoc

 toc::[]

-Managing objects with the {product-title} (ROSA) CLI, `rosa`, such as adding `dedicated-admin` users, managing clusters, and scheduling cluster upgrades.
+Managing objects with the {product-title} CLI, `rosa`, such as adding `dedicated-admin` users, managing clusters, and scheduling cluster upgrades.


Suggested change

Managing objects with the {product-title} CLI, `rosa`, such as adding `dedicated-admin` users, managing clusters, and scheduling cluster upgrades.

Managing objects with the {rosa-cli-first}, such as adding `dedicated-admin` users, managing clusters, and scheduling cluster upgrades.

AedinC · 2025-09-16T12:52:59Z

modules/rosa-common-commands.adoc

 = Common commands and arguments

-These common commands and arguments are available for the {product-title} (ROSA) CLI, `rosa`.
+These common commands and arguments are available for the {product-title} CLI, `rosa`.


Suggested change

These common commands and arguments are available for the {product-title} CLI, `rosa`.

These common commands and arguments are available for the {rosa-cli-first}.

AedinC · 2025-09-16T13:00:30Z

modules/rosa-parent-commands.adoc



-The {product-title} (ROSA) CLI, `rosa`, uses parent commands with child commands to manage objects. The parent commands are `create`, `edit`, `delete`, `list`, and `describe`. Not all parent commands can be used with all child commands. For more information, see the specific reference topics that describes the child commands.
+The {product-title} CLI, `rosa`, uses parent commands with child commands to manage objects. The parent commands are `create`, `edit`, `delete`, `list`, and `describe`. Not all parent commands can be used with all child commands. For more information, see the specific reference topics that describes the child commands.


Suggested change

The {product-title} CLI, `rosa`, uses parent commands with child commands to manage objects. The parent commands are `create`, `edit`, `delete`, `list`, and `describe`. Not all parent commands can be used with all child commands. For more information, see the specific reference topics that describes the child commands.

The {rosa-cli-first} uses parent commands with child commands to manage objects. The parent commands are `create`, `edit`, `delete`, `list`, and `describe`. Not all parent commands can be used with all child commands. For more information, see the specific reference topics that describes the child commands.

AedinC · 2025-09-16T13:20:14Z

cli_reference/rosa_cli/rosa-cli-permission-examples.adoc

Suggest changing last sentence in line 8 to 'These policies contain only the minimum required permissions needed to perform specific actions by using the {rosa-cli-first}.'

AedinC · 2025-09-16T13:40:54Z

modules/rosa-updating-rosa-cli.adoc


 .Verification
-* Verify that the new version of ROSA is installed.
+* Verify that the new version of the ROSA CLI is installed.


Suggested change

* Verify that the new version of the ROSA CLI is installed.

* Verify that the new version of the {rosa-cli} is installed.

openshift-ci · 2025-09-17T00:14:23Z

@mletalie: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

mletalie · 2025-09-17T00:54:36Z

/cherrypick enterprise-4.19

mletalie · 2025-09-17T00:55:25Z

/cherrypick enterprise-4.20

openshift-cherrypick-robot · 2025-09-17T00:55:31Z

@mletalie: new pull request created: #99177

In response to this:

/cherrypick enterprise-4.19

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-cherrypick-robot · 2025-09-17T00:56:16Z

@mletalie: new pull request created: #99178

In response to this:

/cherrypick enterprise-4.20

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Sep 9, 2025

mletalie force-pushed the OSDOCS-16123 branch from 466ee3c to 74e658a Compare September 9, 2025 20:54

openshift-ci bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Sep 9, 2025

mletalie changed the title ~~Osdocs 16123~~ [OSDOCS-16123]:Prune "CLI Tools" Phase 2 Sep 9, 2025

mletalie force-pushed the OSDOCS-16123 branch from 74e658a to 71d1710 Compare September 11, 2025 20:13

openshift-ci bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Sep 11, 2025

ocpdocs-vale-bot reviewed Sep 11, 2025

View reviewed changes

mletalie force-pushed the OSDOCS-16123 branch 2 times, most recently from 381670b to e7b44a9 Compare September 12, 2025 15:13

ocpdocs-vale-bot reviewed Sep 12, 2025

View reviewed changes

mletalie force-pushed the OSDOCS-16123 branch 2 times, most recently from ca0b4c2 to 005c81c Compare September 15, 2025 15:25

ocpdocs-vale-bot reviewed Sep 15, 2025

View reviewed changes

mletalie force-pushed the OSDOCS-16123 branch from 9ca9339 to aa7aaac Compare September 15, 2025 17:23

AedinC reviewed Sep 16, 2025

View reviewed changes

mletalie force-pushed the OSDOCS-16123 branch 2 times, most recently from c8b3c4c to 12a18ba Compare September 16, 2025 21:10

CLI tools update

48a4be4

mletalie force-pushed the OSDOCS-16123 branch from b40c686 to 48a4be4 Compare September 17, 2025 00:04

mletalie merged commit d5843f7 into openshift:main Sep 17, 2025
2 checks passed

This was referenced Sep 17, 2025

[enterprise-4.19] [OSDOCS-16123]:Prune "CLI Tools" Phase 2 #99177

Merged

[enterprise-4.20] [OSDOCS-16123]:Prune "CLI Tools" Phase 2 #99178

Merged



		Use the {product-title} (ROSA) command-line interface (CLI), the `rosa` command, to create, update, manage, and delete ROSA clusters and resources.
		Use the {product-title} command-line interface (CLI) to create, update, manage, and delete {product-title} clusters and resources.

	Use the {product-title} command-line interface (CLI) to create, update, manage, and delete {product-title} clusters and resources.
	Use the {rosa-cli-first} to create, update, manage, and delete {product-title} clusters and resources.

	= Least privilege permissions for common {product-title} CLI commands
	= Least privilege permissions for common {rosa-cli} commands

	Use the following commands to configure the {product-title} CLI, `rosa`.
	Use the following commands to configure the {rosa-cli-first}.

	There are several methods you can use to log into your Red{nbsp}Hat account using the {product-title} CLI (`rosa`). These methods are described in detail below.
	There are several methods you can use to log in to your Red{nbsp}Hat account using the {rosa-cli-first}. These methods are described in detail below.



		This is an example workflow of how to use a Bash script with the {product-title} (ROSA) CLI, `rosa`.
		This is an example workflow of how to use a Bash script with the {product-title} CLI, `rosa`.

	Managing objects with the {product-title} CLI, `rosa`, such as adding `dedicated-admin` users, managing clusters, and scheduling cluster upgrades.
	Managing objects with the {rosa-cli-first}, such as adding `dedicated-admin` users, managing clusters, and scheduling cluster upgrades.

	These common commands and arguments are available for the {product-title} CLI, `rosa`.
	These common commands and arguments are available for the {rosa-cli-first}.



		The {product-title} (ROSA) CLI, `rosa`, uses parent commands with child commands to manage objects. The parent commands are `create`, `edit`, `delete`, `list`, and `describe`. Not all parent commands can be used with all child commands. For more information, see the specific reference topics that describes the child commands.
		The {product-title} CLI, `rosa`, uses parent commands with child commands to manage objects. The parent commands are `create`, `edit`, `delete`, `list`, and `describe`. Not all parent commands can be used with all child commands. For more information, see the specific reference topics that describes the child commands.

	The {product-title} CLI, `rosa`, uses parent commands with child commands to manage objects. The parent commands are `create`, `edit`, `delete`, `list`, and `describe`. Not all parent commands can be used with all child commands. For more information, see the specific reference topics that describes the child commands.
	The {rosa-cli-first} uses parent commands with child commands to manage objects. The parent commands are `create`, `edit`, `delete`, `list`, and `describe`. Not all parent commands can be used with all child commands. For more information, see the specific reference topics that describes the child commands.

	* Verify that the new version of the ROSA CLI is installed.
	* Verify that the new version of the {rosa-cli} is installed.

[OSDOCS-16123]:Prune "CLI Tools" Phase 2 #98783

[OSDOCS-16123]:Prune "CLI Tools" Phase 2 #98783

Uh oh!

Conversation

mletalie commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Sep 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mletalie commented Sep 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mletalie commented Sep 12, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

AedinC left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

openshift-ci bot commented Sep 17, 2025

Uh oh!

Uh oh!

mletalie commented Sep 17, 2025

Uh oh!

mletalie commented Sep 17, 2025

Uh oh!

openshift-cherrypick-robot commented Sep 17, 2025

Uh oh!

openshift-cherrypick-robot commented Sep 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

mletalie commented Sep 9, 2025 •

edited

Loading

ocpdocs-previewbot commented Sep 9, 2025 •

edited

Loading