Skip to content

Commit e0fd178

Browse files
jneczyporjneczypor
committed
Rebase OSDOCS-3986-Version3
1 parent ff85dac commit e0fd178

File tree

61 files changed

+758
-120
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+758
-120
lines changed

‎_topic_maps/_topic_map_osd.yml‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,78 @@ Topics:
100100
- Name: Deleting an OpenShift Dedicated cluster
101101
File: osd-deleting-a-cluster
102102
---
103+
Name: CLI tools
104+
Dir: cli_reference
105+
Distros: openshift-dedicated
106+
Topics:
107+
- Name: CLI tools overview
108+
File: index
109+
- Name: OpenShift CLI (oc)
110+
Dir: openshift_cli
111+
Topics:
112+
- Name: Getting started with the OpenShift CLI
113+
File: getting-started-cli
114+
- Name: Configuring the OpenShift CLI
115+
File: configuring-cli
116+
- Name: Usage of oc and kubectl commands
117+
File: usage-oc-kubectl
118+
- Name: Managing CLI profiles
119+
File: managing-cli-profiles
120+
- Name: Extending the OpenShift CLI with plugins
121+
File: extending-cli-plugins
122+
# - Name: Managing CLI plugins with Krew
123+
# File: managing-cli-plugins-krew
124+
# Distros: openshift-dedicated
125+
- Name: OpenShift CLI developer command reference
126+
File: developer-cli-commands
127+
- Name: OpenShift CLI administrator command reference
128+
File: administrator-cli-commands
129+
Distros: openshift-dedicated
130+
- Name: Developer CLI (odo)
131+
File: odo-important-update
132+
# Dir: developer_cli_odo
133+
Distros: openshift-dedicated
134+
# Topics:
135+
# - Name: odo release notes
136+
# File: odo-release-notes
137+
# - Name: Understanding odo
138+
# File: understanding-odo
139+
# - Name: Installing odo
140+
# File: installing-odo
141+
# - Name: Configuring the odo CLI
142+
# File: configuring-the-odo-cli
143+
# - Name: odo CLI reference
144+
# File: odo-cli-reference
145+
- Name: Knative CLI (kn) for use with OpenShift Serverless
146+
File: kn-cli-tools
147+
Distros: openshift-dedicated
148+
- Name: Pipelines CLI (tkn)
149+
Dir: tkn_cli
150+
Distros: openshift-dedicated
151+
Topics:
152+
- Name: Installing tkn
153+
File: installing-tkn
154+
- Name: Configuring tkn
155+
File: op-configuring-tkn
156+
- Name: Basic tkn commands
157+
File: op-tkn-reference
158+
- Name: opm CLI
159+
Dir: opm
160+
Distros: openshift-dedicated
161+
Topics:
162+
- Name: Installing the opm CLI
163+
File: cli-opm-install
164+
- Name: opm CLI reference
165+
File: cli-opm-ref
166+
- Name: Operator SDK
167+
Dir: osdk
168+
Distros: openshift-dedicated
169+
Topics:
170+
- Name: Installing the Operator SDK CLI
171+
File: cli-osdk-install
172+
- Name: Operator SDK CLI reference
173+
File: cli-osdk-ref
174+
---
103175
Name: Cluster administration
104176
Dir: osd_cluster_admin
105177
Distros: openshift-dedicated

‎_topic_maps/_topic_map_rosa.yml‎

Lines changed: 83 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -164,20 +164,91 @@ Topics:
164164
- Name: Command quick reference for creating clusters and users
165165
File: rosa-quickstart
166166
---
167-
Name: ROSA CLI
168-
Dir: rosa_cli
167+
Name: CLI tools
168+
Dir: cli_reference
169169
Distros: openshift-rosa
170170
Topics:
171-
# - Name: CLI and web console
172-
# File: rosa-cli-openshift-console
173-
- Name: Getting started with the ROSA CLI
174-
File: rosa-get-started-cli
175-
- Name: Managing objects with the ROSA CLI
176-
File: rosa-manage-objects-cli
177-
- Name: Checking account and version information with the ROSA CLI
178-
File: rosa-checking-acct-version-cli
179-
- Name: Checking logs with the ROSA CLI
180-
File: rosa-checking-logs-cli
171+
- Name: CLI tools overview
172+
File: index
173+
- Name: OpenShift CLI (oc)
174+
Dir: openshift_cli
175+
Topics:
176+
- Name: Getting started with the OpenShift CLI
177+
File: getting-started-cli
178+
- Name: Configuring the OpenShift CLI
179+
File: configuring-cli
180+
- Name: Usage of oc and kubectl commands
181+
File: usage-oc-kubectl
182+
- Name: Managing CLI profiles
183+
File: managing-cli-profiles
184+
- Name: Extending the OpenShift CLI with plugins
185+
File: extending-cli-plugins
186+
# - Name: Managing CLI plugins with Krew
187+
# File: managing-cli-plugins-krew
188+
# Distros: openshift-rosa
189+
- Name: OpenShift CLI developer command reference
190+
File: developer-cli-commands
191+
- Name: OpenShift CLI administrator command reference
192+
File: administrator-cli-commands
193+
Distros: openshift-rosa
194+
- Name: Developer CLI (odo)
195+
File: odo-important-update
196+
# Dir: developer_cli_odo
197+
Distros: openshift-rosa
198+
# Topics:
199+
# - Name: odo release notes
200+
# File: odo-release-notes
201+
# - Name: Understanding odo
202+
# File: understanding-odo
203+
# - Name: Installing odo
204+
# File: installing-odo
205+
# - Name: Configuring the odo CLI
206+
# File: configuring-the-odo-cli
207+
# - Name: odo CLI reference
208+
# File: odo-cli-reference
209+
- Name: Knative CLI (kn) for use with OpenShift Serverless
210+
File: kn-cli-tools
211+
Distros: openshift-rosa
212+
- Name: Pipelines CLI (tkn)
213+
Dir: tkn_cli
214+
Distros: openshift-rosa
215+
Topics:
216+
- Name: Installing tkn
217+
File: installing-tkn
218+
- Name: Configuring tkn
219+
File: op-configuring-tkn
220+
- Name: Basic tkn commands
221+
File: op-tkn-reference
222+
- Name: opm CLI
223+
Dir: opm
224+
Distros: openshift-rosa
225+
Topics:
226+
- Name: Installing the opm CLI
227+
File: cli-opm-install
228+
- Name: opm CLI reference
229+
File: cli-opm-ref
230+
- Name: Operator SDK
231+
Dir: osdk
232+
Distros: openshift-rosa
233+
Topics:
234+
- Name: Installing the Operator SDK CLI
235+
File: cli-osdk-install
236+
- Name: Operator SDK CLI reference
237+
File: cli-osdk-ref
238+
- Name: ROSA CLI
239+
Dir: rosa_cli
240+
Distros: openshift-rosa
241+
Topics:
242+
# - Name: CLI and web console
243+
# File: rosa-cli-openshift-console
244+
- Name: Getting started with the ROSA CLI
245+
File: rosa-get-started-cli
246+
- Name: Managing objects with the ROSA CLI
247+
File: rosa-manage-objects-cli
248+
- Name: Checking account and version information with the ROSA CLI
249+
File: rosa-checking-acct-version-cli
250+
- Name: Checking logs with the ROSA CLI
251+
File: rosa-checking-logs-cli
181252
---
182253
Name: Red Hat OpenShift Cluster Manager
183254
Dir: ocm

‎adding_service_cluster/rosa-available-services.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[]
77

88
You can add services to your existing {product-title} (ROSA) cluster using the xref:../adding_service_cluster/adding-service.adoc#adding-service[{cluster-manager-first} console].
99

10-
These services can also be installed xref:../rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[using the ROSA CLI (`rosa`)].
10+
These services can also be installed xref:../cli_reference/rosa_cli/rosa-manage-objects-cli.adoc#rosa-managing-objects-cli[using the `rosa` CLI].
1111

1212

1313
include::modules/aws-cloudwatch.adoc[leveloffset=+1]

‎cli_reference/index.adoc‎

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,53 @@ include::_attributes/common-attributes.adoc[]
66

77
toc::[]
88

9-
A user performs a range of operations while working on {product-title} such as the following:
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:
1014

1115
* Managing clusters
1216
* Building, deploying, and managing applications
1317
* Managing deployment processes
1418
* Developing Operators
1519
* Creating and maintaining Operator catalogs
1620
17-
{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.
21+
ifndef::openshift-rosa[]
22+
{product-title}
23+
endif::openshift-rosa[]
24+
ifdef::openshift-rosa[]
25+
ROSA
26+
endif::openshift-rosa[]
27+
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.
1828
These tools expose simple commands to manage the applications, as well as interact with each component of the system.
1929

2030
[id="cli-tools-list"]
2131
== List of CLI tools
2232

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

25-
* xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI (oc)]: This is the most commonly used CLI tool by {product-title} users. 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.
41+
* xref:../cli_reference/openshift_cli/getting-started-cli.adoc#cli-getting-started[OpenShift CLI (`oc`)]:
42+
ifndef::openshift-rosa[]
43+
This is the most commonly used CLI tool by {product-title} users.
44+
endif::openshift-rosa[]
45+
ifdef::openshift-rosa[]
46+
This is one of the more commonly used developer CLI tools.
47+
endif::openshift-rosa[]
48+
It helps both cluster administrators and developers to perform end-to-end operations across
49+
ifndef::openshift-rosa[]
50+
{product-title}
51+
endif::openshift-rosa[]
52+
ifdef::openshift-rosa[]
53+
ROSA
54+
endif::openshift-rosa[]
55+
using the terminal. Unlike the web console, it allows the user to work directly with the project source code using command scripts.
2656

2757
* 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.
2858

@@ -31,3 +61,8 @@ The following set of CLI tools are available in {product-title}:
3161
* 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.
3262

3363
* xref:../cli_reference/osdk/cli-osdk-install.adoc#cli-osdk-install[Operator SDK]: The Operator SDK, a component of the Operator Framework, provides a CLI tool that Operator developers can use to build, test, and deploy an Operator from the terminal. It simplifies the process of building Kubernetes-native applications, which can require deep, application-specific operational knowledge.
64+
65+
66+
ifdef::openshift-rosa[]
67+
* 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.
68+
endif::openshift-rosa[]

‎cli_reference/odo-important-update.adoc‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ include::_attributes/common-attributes.adoc[]
1111

1212
toc::[]
1313

14-
Red Hat does not provide information about `{odo-title}` on the {OCP} documentation site. See the link:https://odo.dev/docs/introduction[documentation] maintained by Red Hat and the upstream community for documentation information related to `{odo-title}`.
14+
Red Hat does not provide information about `{odo-title}` on the {product-title} documentation site. See the link:https://odo.dev/docs/introduction[documentation] maintained by Red Hat and the upstream community for documentation information related to `{odo-title}`.
1515

1616
[IMPORTANT]
1717
====

‎cli_reference/openshift_cli/extending-cli-plugins.adoc‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,14 @@ include::_attributes/common-attributes.adoc[]
77
toc::[]
88

99
You can write and install plugins to build on the default `oc` commands,
10-
allowing you to perform new and more complex tasks with the {product-title} CLI.
10+
allowing you to perform new and more complex tasks with the
11+
ifndef::openshift-dedicated,openshift-rosa[]
12+
{product-title}
13+
endif::openshift-dedicated,openshift-rosa[]
14+
ifdef::openshift-rosa,openshift-dedicated[]
15+
OpenShift
16+
endif::openshift-rosa,openshift-dedicated[]
17+
CLI.
1118

1219
// Writing CLI plugins
1320
include::modules/cli-extending-plugins-writing.adoc[leveloffset=+1]

‎cli_reference/openshift_cli/managing-cli-profiles.adoc‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,19 @@ include::_attributes/common-attributes.adoc[]
77
toc::[]
88

99
A CLI configuration file allows you to configure different profiles, or contexts, for use with the xref:../../cli_reference/index.adoc#cli-tools-overview[CLI tools overview]. A context consists of
10-
ifndef::microshift[]
10+
ifndef::microshift,openshift-dedicated,openshift-rosa[]
1111
xref:../../authentication/understanding-authentication.adoc#understanding-authentication[user authentication]
12-
endif::[]
12+
endif::microshift,openshift-dedicated,openshift-rosa[]
1313
ifdef::microshift[]
1414
user authentication
1515
endif::[]
16-
and {product-title} server information associated with a _nickname_.
16+
ifndef::openshift-rosa[]
17+
an {product-title}
18+
endif::openshift-rosa[]
19+
ifdef::openshift-rosa[]
20+
the {product-title} (ROSA)
21+
endif::openshift-rosa[]
22+
server information associated with a _nickname_.
1723

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

0 commit comments

Comments
 (0)