Skip to content

Commit d5843f7

Browse files
authored
Merge pull request #98783 from mletalie/OSDOCS-16123
[OSDOCS-16123]:Prune "CLI Tools" Phase 2
2 parents 870f79e + 48a4be4 commit d5843f7

34 files changed

+654
-314
lines changed

cli_reference/index.adoc

Lines changed: 5 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,36 +6,20 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
A user performs a range of operations while working on {product-title}
10-
ifdef::openshift-rosa[]
11-
(ROSA)
12-
endif::openshift-rosa[]
13-
such as the following:
9+
A user performs a range of operations while working on {product-title} such as the following:
1410

1511
* Managing clusters
1612
* Building, deploying, and managing applications
1713
* Managing deployment processes
1814
* Creating and maintaining Operator catalogs
1915
20-
ifndef::openshift-rosa[]
21-
{product-title}
22-
endif::openshift-rosa[]
23-
ifdef::openshift-rosa[]
24-
ROSA
25-
endif::openshift-rosa[]
26-
offers a set of command-line interface (CLI) tools that simplify these tasks by enabling users to perform various administration and development operations from the terminal.
16+
{product-title} offers a set of command-line interface (CLI) tools that simplify these tasks by enabling users to perform various administration and development operations from the terminal.
2717
These tools expose simple commands to manage the applications, as well as interact with each component of the system.
2818

2919
[id="cli-tools-list"]
3020
== List of CLI tools
3121

32-
The following set of CLI tools are available in
33-
ifndef::openshift-rosa[]
34-
{product-title}:
35-
endif::openshift-rosa[]
36-
ifdef::openshift-rosa[]
37-
ROSA:
38-
endif::openshift-rosa[]
22+
The following set of CLI tools are available in {product-title}:
3923

4024
* xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI (`oc`)]:
4125
ifndef::openshift-rosa[]
@@ -44,14 +28,7 @@ endif::openshift-rosa[]
4428
ifdef::openshift-rosa[]
4529
This is one of the more commonly used developer CLI tools.
4630
endif::openshift-rosa[]
47-
It helps both cluster administrators and developers to perform end-to-end operations across
48-
ifndef::openshift-rosa[]
49-
{product-title}
50-
endif::openshift-rosa[]
51-
ifdef::openshift-rosa[]
52-
ROSA
53-
endif::openshift-rosa[]
54-
using the terminal. Unlike the web console, it allows the user to work directly with the project source code using command scripts.
31+
It helps both cluster administrators and developers to perform end-to-end operations across {product-title} using the terminal. Unlike the web console, it allows the user to work directly with the project source code using command scripts.
5532

5633
* xref:../cli_reference/kn-cli-tools.adoc#kn-cli-tools[Knative CLI (kn)]: The Knative (`kn`) CLI tool provides simple and intuitive terminal commands that can be used to interact with OpenShift Serverless components, such as Knative Serving and Eventing.
5734

@@ -60,5 +37,5 @@ using the terminal. Unlike the web console, it allows the user to work directly
6037
* xref:../cli_reference/opm/cli-opm-install.adoc#cli-opm-install[opm CLI]: The `opm` CLI tool helps the Operator developers and cluster administrators to create and maintain the catalogs of Operators from the terminal.
6138

6239
ifdef::openshift-rosa,openshift-rosa-hcp[]
63-
* xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[ROSA CLI (`rosa`)]: Use the `rosa` CLI to create, update, manage, and delete ROSA clusters and resources.
40+
* xref:../cli_reference/rosa_cli/rosa-get-started-cli.adoc#rosa-get-started-cli[ROSA CLI (`rosa`)]: Use the `rosa` CLI to create, update, manage, and delete {product-title} clusters and resources.
6441
endif::openshift-rosa,openshift-rosa-hcp[]

cli_reference/kn-cli-tools.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,4 +25,4 @@ Key features of the Knative CLI include:
2525
[id="kn-cli-tools-installing-kn"]
2626
== Installing the Knative CLI
2727

28-
See link:https://docs.openshift.com/serverless/1.28/install/installing-kn.html#installing-kn[Installing the Knative CLI].
28+
See link:https://docs.redhat.com/en/documentation/red_hat_openshift_serverless/1.28/html/installing_serverless/installing-kn#installing-kn[Installing the Knative CLI].

cli_reference/openshift_cli/managing-cli-profiles.adoc

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,7 @@ endif::microshift,openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
1313
ifdef::microshift[]
1414
user authentication
1515
endif::[]
16-
ifndef::openshift-rosa,openshift-rosa-hcp[]
17-
an {product-title}
18-
endif::openshift-rosa,openshift-rosa-hcp[]
19-
ifdef::openshift-rosa,openshift-rosa-hcp[]
20-
the {product-title} (ROSA)
21-
endif::openshift-rosa,openshift-rosa-hcp[]
16+
a {product-title}
2217
server information associated with a _nickname_.
2318

2419
include::modules/about-cli-profiles-switch.adoc[leveloffset=+1]

cli_reference/openshift_cli/usage-oc-kubectl.adoc

Lines changed: 6 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -4,46 +4,18 @@
44
include::_attributes/common-attributes.adoc[]
55
:context: usage-oc-kubectl
66

7-
The Kubernetes command-line interface (CLI), `kubectl`, can be used to run commands against a Kubernetes cluster. Because {product-title}
8-
ifdef::openshift-rosa,openshift-rosa-hcp[]
9-
(ROSA)
10-
endif::openshift-rosa,openshift-rosa-hcp[]
11-
is a certified Kubernetes distribution, you can use the supported `kubectl` binaries that ship with
12-
ifndef::openshift-rosa,openshift-rosa-hcp[]
13-
{product-title}
14-
endif::openshift-rosa,openshift-rosa-hcp[]
15-
ifdef::openshift-rosa,openshift-rosa-hcp[]
16-
ROSA
17-
endif::openshift-rosa,openshift-rosa-hcp[]
18-
, or you can gain extended functionality by using the `oc` binary.
7+
The Kubernetes command-line interface (CLI), `kubectl`, can be used to run commands against a Kubernetes cluster. Because {product-title} is a certified Kubernetes distribution, you can use the supported `kubectl` binaries that ship with
8+
{product-title}, or you can gain extended functionality by using the `oc` binary.
199

2010
== The oc binary
2111

2212
The `oc` binary offers the same capabilities as the `kubectl` binary, but it extends to natively support additional
23-
ifndef::openshift-rosa,openshift-rosa-hcp[]
24-
{product-title}
25-
endif::openshift-rosa,openshift-rosa-hcp[]
26-
ifdef::openshift-rosa,openshift-rosa-hcp[]
27-
ROSA
28-
endif::openshift-rosa,openshift-rosa-hcp[]
29-
features, including:
13+
{product-title} features, including:
3014

31-
* **Full support for
32-
ifndef::openshift-rosa,openshift-rosa-hcp[]
33-
{product-title}
34-
endif::openshift-rosa,openshift-rosa-hcp[]
35-
ifdef::openshift-rosa,openshift-rosa-hcp[]
36-
ROSA
37-
endif::openshift-rosa,openshift-rosa-hcp[]
38-
resources**
15+
* **Full support for {product-title} resources**
3916
+
4017
Resources such as `DeploymentConfig`, `BuildConfig`, `Route`, `ImageStream`, and `ImageStreamTag` objects are specific to
41-
ifndef::openshift-rosa,openshift-rosa-hcp[]
4218
{product-title}
43-
endif::openshift-rosa,openshift-rosa-hcp[]
44-
ifdef::openshift-rosa,openshift-rosa-hcp[]
45-
ROSA
46-
endif::openshift-rosa,openshift-rosa-hcp[]
4719
distributions, and build upon standard Kubernetes primitives.
4820
+
4921
* **Authentication**
@@ -68,16 +40,9 @@ ifndef::openshift-rosa,openshift-rosa-hcp[]
6840
{product-title} {product-version}
6941
endif::openshift-rosa,openshift-rosa-hcp[]
7042
ifdef::openshift-rosa,openshift-rosa-hcp[]
71-
ROSA
72-
endif::openshift-rosa,openshift-rosa-hcp[]
73-
. If you want the latest features, you must download and install the latest version of the `oc` binary corresponding to your
74-
ifndef::openshift-rosa,openshift-rosa-hcp[]
7543
{product-title}
7644
endif::openshift-rosa,openshift-rosa-hcp[]
77-
ifdef::openshift-rosa,openshift-rosa-hcp[]
78-
ROSA
79-
endif::openshift-rosa,openshift-rosa-hcp[]
80-
server version.
45+
. If you want the latest features, you must download and install the latest version of the `oc` binary corresponding to your {product-title} server version.
8146
====
8247

8348
Non-security API changes will involve, at minimum, two minor releases (4.1 to 4.2 to 4.3, for example) to allow older `oc` binaries to update. Using new capabilities might require newer `oc` binaries. A 4.3 server might have additional capabilities that a 4.2 `oc` binary cannot use and a 4.3 `oc` binary might have additional capabilities that are unsupported by a 4.2 server.
@@ -109,20 +74,7 @@ image:redcircle-3.png[] `oc` client might provide options and features that migh
10974
== The kubectl binary
11075

11176
The `kubectl` binary is provided as a means to support existing workflows and scripts for new
112-
ifndef::openshift-rosa,openshift-rosa-hcp[]
113-
{product-title}
114-
endif::openshift-rosa,openshift-rosa-hcp[]
115-
ifdef::openshift-rosa,openshift-rosa-hcp[]
116-
ROSA
117-
endif::openshift-rosa,openshift-rosa-hcp[]
118-
users coming from a standard Kubernetes environment, or for those who prefer to use the `kubectl` CLI. Existing users of `kubectl` can continue to use the binary to interact with Kubernetes primitives, with no changes required to the
119-
ifndef::openshift-rosa,openshift-rosa-hcp[]
120-
{product-title}
121-
endif::openshift-rosa,openshift-rosa-hcp[]
122-
ifdef::openshift-rosa,openshift-rosa-hcp[]
123-
ROSA
124-
endif::openshift-rosa,openshift-rosa-hcp[]
125-
cluster.
77+
{product-title} users coming from a standard Kubernetes environment, or for those who prefer to use the `kubectl` CLI. Existing users of `kubectl` can continue to use the binary to interact with Kubernetes primitives, with no changes required to the {product-title} cluster.
12678

12779
You can install the supported `kubectl` binary by following the steps to xref:../../cli_reference/openshift_cli/getting-started-cli.adoc#cli-installing-cli_cli-developer-commands[Install the OpenShift CLI]. The `kubectl` binary is included in the archive if you download the binary, or is installed when you install the CLI by using an RPM.
12880

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
55
:context: rosa-cli-permission-examples
66
toc::[]
77

8-
You can create roles with permissions that adhere to the principal of least privilege, in which the users assigned the roles have no other permissions assigned to them outside the scope of the specific action they need to perform. These policies contain only the minimum required permissions needed to perform specific actions by using the {product-title} (ROSA) command-line interface (CLI).
8+
You can create roles with permissions that adhere to the principal of least privilege, in which the users assigned the roles have no other permissions assigned to them outside the scope of the specific action they need to perform. These policies contain only the minimum required permissions needed to perform specific actions by using the {rosa-cli-first}.
99

1010
[IMPORTANT]
1111
====
@@ -20,11 +20,13 @@ Although the policies and commands presented in this topic will work in conjunct
2020

2121
For more information about configuring permissions, policies, and roles in the AWS console, see link:https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html[AWS Identity and Access Management] in the AWS documentation.
2222

23-
include::modules/rosa-cli-hcp-classic-examples.adoc[leveloffset=+1]
24-
23+
// include::modules/rosa-cli-hcp-classic-examples.adoc[leveloffset=+1]
24+
ifdef::openshift-rosa-hcp[]
2525
include::modules/rosa-cli-hcp-examples.adoc[leveloffset=+1]
26+
endif::openshift-rosa-hcp[]
27+
ifdef::openshift-rosa[]
2628
include::modules/rosa-cli-classic-examples.adoc[leveloffset=+1]
27-
29+
endif::openshift-rosa[]
2830
include::modules/rosa-cli-no-permissions-required.adoc[leveloffset=+1]
2931

3032
[role="_additional-resources"]

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

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
77

88
toc::[]
99

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

1212
[NOTE]
1313
====
@@ -35,11 +35,13 @@ include::modules/rosa-edit-objects.adoc[leveloffset=+1]
3535
ifdef::openshift-rosa[]
3636
* See xref:../../networking/networking_operators/ingress-operator.adoc#configuring-ingress-controller[Configuring the Ingress Controller] for information regarding editing non-default application routers.
3737
endif::openshift-rosa[]
38-
//Classic to HCP breakout. Remove ROSA-specific conditionals when networking is added to HCP.
39-
38+
//Classic to HCP breakout. Remove ROSA-specific conditionals when networking is added to HCP.
39+
4040
include::modules/rosa-delete-objects.adoc[leveloffset=+1]
4141
include::modules/rosa-install-uninstall-addon.adoc[leveloffset=+1]
4242
include::modules/rosa-list-objects.adoc[leveloffset=+1]
43+
ifdef::openshift-rosa-hcp[]
4344
include::modules/rosa-revoke-objects.adoc[leveloffset=+1]
45+
endif::openshift-rosa-hcp[]
4446
include::modules/rosa-upgrade-cluster-cli.adoc[leveloffset=+1]
4547

cli_reference/rosa_cli/rosa-updating-billing-account-cli.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
:_mod-docs-content-type: ASSEMBLY
22
include::_attributes/attributes-openshift-dedicated.adoc[]
33
[id="rosa-updating-account-cli"]
4-
= Managing billing accounts for ROSA with HCP clusters
4+
= Managing billing accounts for {product-title} clusters
55
:context: rosa-updating-account-cli
66
toc::[]
77

@@ -12,7 +12,7 @@ This can be useful if you have accidentally linked to the wrong AWS billing acco
1212

1313
[NOTE]
1414
====
15-
You also have the option to update your billing account through the {cluster-manager}. For more information, see link:https://docs.redhat.com/en/documentation/openshift_cluster_manager/1-latest/html-single/managing_clusters/index#proc_updating-billing-accts-rosa-hcp_assembly-managing-clusters[Updating billing accounts for OpenShift Service on AWS Hosted Control Planes clusters.]
15+
You also have the option to update your billing account through the {cluster-manager}. For more information, see link:https://docs.redhat.com/en/documentation/openshift_cluster_manager/1-latest/html-single/managing_clusters/index#proc_updating-billing-accts-rosa-hcp_assembly-managing-clusters[Updating billing accounts for {product-title} clusters.]
1616
====
1717

1818

modules/about-cli-profiles-switch.adoc

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,9 @@
66
[id="about-switches-between-cli-profiles_{context}"]
77
= About switches between CLI profiles
88

9-
Contexts allow you to easily switch between multiple users across multiple
10-
ifndef::openshift-rosa[]
11-
{product-title}
12-
endif::openshift-rosa[]
13-
ifdef::openshift-rosa[]
14-
ROSA
15-
endif::openshift-rosa[]
16-
servers, or clusters, when using CLI operations. Nicknames make managing CLI configurations easier by providing short-hand references to contexts, user credentials, and cluster details.
9+
Contexts allow you to easily switch between multiple users across multiple {product-title} servers, or clusters, when using CLI operations. Nicknames make managing CLI configurations easier by providing short-hand references to contexts, user credentials, and cluster details.
1710
After a user logs in with the `oc` CLI for the first time,
18-
ifndef::openshift-rosa[]
19-
{product-title}
20-
endif::openshift-rosa[]
21-
ifdef::openshift-rosa[]
22-
ROSA
23-
endif::openshift-rosa[]
24-
creates a `~/.kube/config` file if one does not already exist. As more authentication and connection details are provided to the CLI, either automatically during an `oc login` operation or by manually configuring CLI profiles, the updated information is stored in the configuration file:
11+
{product-title} creates a `~/.kube/config` file if one does not already exist. As more authentication and connection details are provided to the CLI, either automatically during an `oc login` operation or by manually configuring CLI profiles, the updated information is stored in the configuration file:
2512

2613
.CLI config file
2714

@@ -58,13 +45,7 @@ users: <4>
5845
----
5946

6047
<1> The `clusters` section defines connection details for
61-
ifndef::openshift-rosa[]
62-
{product-title}
63-
endif::openshift-rosa[]
64-
ifdef::openshift-rosa[]
65-
ROSA
66-
endif::openshift-rosa[]
67-
clusters, including the address for their master server. In this example, one cluster is nicknamed `openshift1.example.com:8443` and another is nicknamed `openshift2.example.com:8443`.
48+
{product-title} clusters, including the address for their master server. In this example, one cluster is nicknamed `openshift1.example.com:8443` and another is nicknamed `openshift2.example.com:8443`.
6849
<2> This `contexts` section defines two contexts: one nicknamed `alice-project/openshift1.example.com:8443/alice`, using the `alice-project` project, `openshift1.example.com:8443` cluster, and `alice` user, and another nicknamed `joe-project/openshift1.example.com:8443/alice`, using the `joe-project` project, `openshift1.example.com:8443` cluster and `alice` user.
6950
<3> The `current-context` parameter shows that the `joe-project/openshift1.example.com:8443/alice` context is currently in use, allowing the `alice` user to work in the `joe-project` project on the `openshift1.example.com:8443` cluster.
7051
<4> The `users` section defines user credentials. In this example, the user nickname `alice/openshift1.example.com:8443` uses an access token.

modules/cli-extending-plugins-installing.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
= Installing and using CLI plugins
88

99
After you write a custom plugin for the
10-
ifndef::openshift-rosa,openshift-dedicated[]
10+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1111
{product-title}
12-
endif::openshift-rosa,openshift-dedicated[]
13-
ifdef::openshift-rosa,openshift-dedicated[]
12+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
13+
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1414
OpenShift
15-
endif::openshift-rosa,openshift-dedicated[]
15+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1616
CLI, you must install
1717
the plugin before use.
1818

modules/cli-extending-plugins-writing.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@
77
= Writing CLI plugins
88

99
You can write a plugin for the
10-
ifndef::openshift-rosa,openshift-dedicated[]
10+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1111
{product-title}
12-
endif::openshift-rosa,openshift-dedicated[]
13-
ifdef::openshift-rosa,openshift-dedicated[]
12+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
13+
ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1414
OpenShift
15-
endif::openshift-rosa,openshift-dedicated[]
15+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
1616
CLI in any programming language
1717
or script that allows you to write command-line commands. Note that you can not
1818
use a plugin to overwrite an existing `oc` command.
@@ -58,12 +58,12 @@ echo "I am a plugin named kubectl-foo"
5858
----
5959

6060
After you install this plugin for the
61-
ifndef::openshift-rosa,openshift-dedicated[]
61+
ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
6262
{product-title}
63-
endif::openshift-rosa,openshift-dedicated[]
64-
ifdef::openshift-rosa[]
63+
endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
64+
ifdef::openshift-rosa,openshift-rosa-hcp[]
6565
OpenShift
66-
endif::openshift-rosa[]
66+
endif::openshift-rosa,openshift-rosa-hcp[]
6767
CLI, it can be invoked
6868
using the `oc foo` command.
6969

0 commit comments

Comments
 (0)