mirror of
https://github.com/openshift/openshift-docs.git
synced 2026-02-05 12:46:18 +01:00
3c5c51ab57
- start topic list with about, welcome, legal notice - stub introduction with understanding section - stub in API reference - stub in storage and networking topics (These aren't filled in yet, but we need to cover them so include them in the topic map.) - add troubleshooting section - stub in installation section - add cli tools section - add links to index pages Co-Authored-By: Kathryn Alexander <kalexand@redhat.com>
38 lines
2.5 KiB
Plaintext
38 lines
2.5 KiB
Plaintext
:_content-type: ASSEMBLY
|
|
[id="cli-tools-overview"]
|
|
= {product-title} CLI tools overview
|
|
include::_attributes/common-attributes.adoc[]
|
|
:context: cli-tools-overview
|
|
|
|
toc::[]
|
|
|
|
A user performs a range of operations while working on {product-title} such as the following:
|
|
|
|
* Managing clusters
|
|
* Building, deploying, and managing applications
|
|
ifndef::microshift[]
|
|
* Managing deployment processes
|
|
* Developing Operators
|
|
* Creating and maintaining Operator catalogs
|
|
endif::[]
|
|
|
|
{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.
|
|
These tools expose simple commands to manage the applications, as well as interact with each component of the system.
|
|
|
|
[id="cli-tools-list"]
|
|
== List of CLI tools
|
|
|
|
The following set of CLI tools are available in {product-title}:
|
|
|
|
* 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.
|
|
|
|
ifndef::microshift[]
|
|
* 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.
|
|
|
|
* 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.
|
|
|
|
* 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.
|
|
|
|
* 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.
|
|
endif::microshift[]
|