Skip to content

Commit d1c9f09

Browse files
authored
Merge pull request #36492 from snarayan-redhat/OSDOCS-2542_CLI_overview
OSDOCS-2542: CLI Tools overview
2 parents d4c87d0 + 4f74679 commit d1c9f09

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

_topic_map.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -585,6 +585,8 @@ Name: CLI tools
585585
Dir: cli_reference
586586
Distros: openshift-enterprise,openshift-origin,openshift-dedicated,openshift-online
587587
Topics:
588+
- Name: CLI tools overview
589+
File: index
588590
- Name: OpenShift CLI (oc)
589591
Dir: openshift_cli
590592
Topics:

cli_reference/index.adoc

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
[id="cli-tools-overview"]
2+
= {product-title} CLI tools overview
3+
include::modules/common-attributes.adoc[]
4+
:context: cli-tools-overview
5+
6+
toc::[]
7+
8+
A user performs a range of operations while working on {product-title} such as the following:
9+
10+
* Managing clusters
11+
* Building, deploying, and managing applications
12+
* Managing deployment processes
13+
* Developing Operators
14+
* Creating and maintaining Operator catalogs
15+
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.
17+
These tools expose simple commands to manage the applications, as well as interact with each component of the system.
18+
19+
[id="cli-tools-list"]
20+
== List of CLI tools
21+
22+
The following set of CLI tools are available in {product-title}:
23+
24+
* 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.
25+
26+
* xref:../cli_reference/kn-cli-tools.adoc#kn-cli-tools[Knative CLI (kn)]: The `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.
27+
28+
* xref:../cli_reference/tkn_cli/installing-tkn.adoc#installing-tkn[Pipelines CLI (tkn)]: OpenShift Pipelines is a continuous integration and continuous delivery (CI/CD) solution in {product-title}, which internally uses Tekton. The `tkn` CLI tool provides simple and intuitive commands to interact with OpenShift Pipelines using the terminal.
29+
30+
* 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.
31+
32+
* 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.

0 commit comments

Comments
 (0)