1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00

OSDOCS-11542: Add CLI Tools content to ROSA with HCP

This commit is contained in:
bmcelvee
2025-01-14 16:25:54 -05:00
committed by openshift-cherrypick-robot
parent 398e365159
commit c67a2b4e02
9 changed files with 158 additions and 82 deletions

View File

@@ -8,12 +8,12 @@ toc::[]
You can write and install plugins to build on the default `oc` commands,
allowing you to perform new and more complex tasks with the
ifndef::openshift-dedicated,openshift-rosa[]
ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
{product-title}
endif::openshift-dedicated,openshift-rosa[]
ifdef::openshift-rosa,openshift-dedicated[]
endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
OpenShift
endif::openshift-rosa,openshift-dedicated[]
endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[]
CLI.
// Writing CLI plugins

View File

@@ -7,18 +7,18 @@ include::_attributes/common-attributes.adoc[]
toc::[]
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
ifndef::microshift,openshift-dedicated,openshift-rosa[]
ifndef::microshift,openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
xref:../../authentication/understanding-authentication.adoc#understanding-authentication[user authentication]
endif::microshift,openshift-dedicated,openshift-rosa[]
endif::microshift,openshift-dedicated,openshift-rosa,openshift-rosa-hcp[]
ifdef::microshift[]
user authentication
endif::[]
ifndef::openshift-rosa[]
ifndef::openshift-rosa,openshift-rosa-hcp[]
an {product-title}
endif::openshift-rosa[]
ifdef::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
ifdef::openshift-rosa,openshift-rosa-hcp[]
the {product-title} (ROSA)
endif::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
server information associated with a _nickname_.
include::modules/about-cli-profiles-switch.adoc[leveloffset=+1]

View File

@@ -5,53 +5,53 @@ include::_attributes/common-attributes.adoc[]
:context: usage-oc-kubectl
The Kubernetes command-line interface (CLI), `kubectl`, can be used to run commands against a Kubernetes cluster. Because {product-title}
ifdef::openshift-rosa[]
ifdef::openshift-rosa,openshift-rosa-hcp[]
(ROSA)
endif::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
is a certified Kubernetes distribution, you can use the supported `kubectl` binaries that ship with
ifndef::openshift-rosa[]
ifndef::openshift-rosa,openshift-rosa-hcp[]
{product-title}
endif::openshift-rosa[]
ifdef::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
ifdef::openshift-rosa,openshift-rosa-hcp[]
ROSA
endif::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
, or you can gain extended functionality by using the `oc` binary.
== The oc binary
The `oc` binary offers the same capabilities as the `kubectl` binary, but it extends to natively support additional
ifndef::openshift-rosa[]
ifndef::openshift-rosa,openshift-rosa-hcp[]
{product-title}
endif::openshift-rosa[]
ifdef::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
ifdef::openshift-rosa,openshift-rosa-hcp[]
ROSA
endif::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
features, including:
* **Full support for
ifndef::openshift-rosa[]
ifndef::openshift-rosa,openshift-rosa-hcp[]
{product-title}
endif::openshift-rosa[]
ifdef::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
ifdef::openshift-rosa,openshift-rosa-hcp[]
ROSA
endif::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
resources**
+
Resources such as `DeploymentConfig`, `BuildConfig`, `Route`, `ImageStream`, and `ImageStreamTag` objects are specific to
ifndef::openshift-rosa[]
ifndef::openshift-rosa,openshift-rosa-hcp[]
{product-title}
endif::openshift-rosa[]
ifdef::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
ifdef::openshift-rosa,openshift-rosa-hcp[]
ROSA
endif::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
distributions, and build upon standard Kubernetes primitives.
+
* **Authentication**
+
ifndef::microshift,openshift-rosa,openshift-dedicated[]
ifndef::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
The `oc` binary offers a built-in `login` command for authentication and lets you work with projects, which map Kubernetes namespaces to authenticated users.
Read xref:../../authentication/understanding-authentication.adoc#understanding-authentication[Understanding authentication] for more information.
endif::microshift,openshift-rosa,openshift-dedicated[]
endif::microshift,openshift-rosa,openshift-rosa-hcp,openshift-dedicated[]
+
ifdef::microshift[]
The `oc` binary offers a built-in `login` command for authentication to {product-title}.
@@ -64,19 +64,19 @@ The additional command `oc new-app`, for example, makes it easier to get new app
[IMPORTANT]
====
If you installed an earlier version of the `oc` binary, you cannot use it to complete all of the commands in
ifndef::openshift-rosa[]
ifndef::openshift-rosa,openshift-rosa-hcp[]
{product-title} {product-version}
endif::openshift-rosa[]
ifdef::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
ifdef::openshift-rosa,openshift-rosa-hcp[]
ROSA
endif::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
. If you want the latest features, you must download and install the latest version of the `oc` binary corresponding to your
ifndef::openshift-rosa[]
ifndef::openshift-rosa,openshift-rosa-hcp[]
{product-title}
endif::openshift-rosa[]
ifdef::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
ifdef::openshift-rosa,openshift-rosa-hcp[]
ROSA
endif::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
server version.
====
@@ -110,19 +110,19 @@ image:redcircle-3.png[] `oc` client might provide options and features that migh
== The kubectl binary
The `kubectl` binary is provided as a means to support existing workflows and scripts for new
ifndef::openshift-rosa[]
ifndef::openshift-rosa,openshift-rosa-hcp[]
{product-title}
endif::openshift-rosa[]
ifdef::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
ifdef::openshift-rosa,openshift-rosa-hcp[]
ROSA
endif::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
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
ifndef::openshift-rosa[]
ifndef::openshift-rosa,openshift-rosa-hcp[]
{product-title}
endif::openshift-rosa[]
ifdef::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
ifdef::openshift-rosa,openshift-rosa-hcp[]
ROSA
endif::openshift-rosa[]
endif::openshift-rosa,openshift-rosa-hcp[]
cluster.
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.