You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: microshift_cli_ref/microshift-cli-tools-introduction.adoc
+6-6Lines changed: 6 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
:_mod-docs-content-type: ASSEMBLY
2
2
[id="microshift-cli-tools"]
3
-
= {product-title} CLI tools introduction
3
+
= {microshift-short} CLI tools introduction
4
4
include::_attributes/attributes-microshift.adoc[]
5
5
:context: microshift-cli-tools-introduction
6
6
7
7
toc::[]
8
8
9
-
You can use different command-line interface (CLI) tools to build, deploy, and manage {product-title} clusters and workloads. With CLI tools, you can complete various administration and development operations from the terminal to manage deployments and interact with each component of the system.
9
+
You can use different command-line interface (CLI) tools to build, deploy, and manage a {microshift-short} cluster and workloads. With CLI tools, you can complete various administration and development operations from the terminal to manage deployments and interact with each component of the system.
10
10
11
-
CLI tools available for use with {product-title} are the following:
11
+
CLI tools available for use with {microshift-short} are the following:
12
12
13
13
* Kubernetes CLI (`kubectl`)
14
14
* The {oc-first} tool with an enabled subset of commands
@@ -23,7 +23,7 @@ Commands for multi-node deployments, projects, and developer tooling are not sup
23
23
[id="additional-resources_microshift-cli-tools"]
24
24
== Additional resources
25
25
26
-
* xref:..//microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Installing the OpenShift CLI tool for MicroShift].
27
-
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.16/html/cli_tools/openshift-cli-oc[Detailed description of the OpenShift CLI (oc)].
28
-
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9[Red Hat Enterprise Linux (RHEL) documentation for specific use cases].
26
+
* xref:..//microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Getting started with the OpenShift CLI]
27
+
* link:https://docs.redhat.com/en/documentation/openshift_container_platform/4.16/html/cli_tools/openshift-cli-oc#cli-about-cli_cli-developer-commands[About the OpenShift CLI] (OpenShift Container Platform documentation)
28
+
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9[Red Hat Enterprise Linux (RHEL) documentation for specific use cases]
29
29
* xref:../microshift_configuring/microshift-cluster-access-kubeconfig.adoc#microshift-kubeconfig[Cluster access with kubeconfig]
The optional OpenShift CLI (`oc`) tool provides a subset of `oc` commands for {product-title} deployments. Using `oc` is convenient if you are familiar with {OCP} and Kubernetes.
9
+
The optional {oc-first} tool provides a subset of `oc` commands for {microshift-short} deployments. Using `oc` is convenient if you are familiar with {OCP} and Kubernetes.
Descriptions and example commands for OpenShift CLI (`oc`) commands are included in this reference document. You must have `cluster-admin` or equivalent permissions to use these commands. To list administrator commands and information about them, use the following commands:
9
+
Descriptions and example commands for {oc-first} commands are included in this reference document. You must have `cluster-admin` or equivalent permissions to use these commands. To list administrator commands and information about them, use the following commands:
10
10
11
11
* Enter the `oc adm -h` command to list all administrator commands:
To use the OpenShift CLI (`oc`) tool, you must download and install it separately from your {microshift-short} installation.
10
-
11
-
[id="installing-the-openshift-cli"]
12
-
== Installing the OpenShift CLI
13
-
14
-
You can install the OpenShift CLI (`oc`) either by downloading the binary or by using Homebrew.
9
+
To use the {oc-first} tool, you must download and install it separately from your {microshift-short} installation. You can install `oc` by downloading the binary or by using Homebrew.
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` CLI tool that ships with {product-title}, or you can gain extended functionality by using the `oc` CLI tool.
9
+
The Kubernetes command-line interface (CLI), `kubectl`, can be used to run commands against a Kubernetes cluster. Because {microshift-short} is a certified Kubernetes distribution, you can use the supported `kubectl` CLI tool or you can gain extended functionality by using the {oc-first}.
10
10
11
11
[id="microshift-kubectl-binary_{context}"]
12
12
== The kubectl CLI tool
13
13
14
-
You can use the `kubectl` CLI tool to interact with Kubernetes primitives on your {product-title} cluster. You can also use existing `kubectl` workflows and scripts for new {product-title} users coming from another Kubernetes environment, or for those who prefer to use the `kubectl` CLI.
14
+
You can use the `kubectl` CLI tool to interact with Kubernetes primitives on your {microshift-short} cluster. You can also use existing `kubectl` workflows and scripts for users coming from another Kubernetes environment, or for those who prefer to use the `kubectl` CLI.
15
15
16
-
The `kubectl` CLI tool is included in the archive if you download the `oc` CLI tool.
16
+
* The `kubectl` CLI tool is included in the archive when you download `oc`.
17
17
18
-
For more information, read the link:https://kubernetes.io/docs/reference/kubectl/overview/[Kubernetes CLI tool documentation].
18
+
* For more information, see the link:https://kubernetes.io/docs/reference/kubectl/overview/[Kubernetes CLI tool documentation].
19
19
20
20
[id="microshift-oc-binary_{context}"]
21
21
== The oc CLI tool
22
22
23
-
The `oc` CLI tool offers the same capabilities as the `kubectl` CLI tool, but it extends to natively support additional {product-title} features, including:
23
+
The `oc` CLI tool offers the same capabilities as the `kubectl` CLI tool, but it extends to natively support additional {OCP} features, including:
24
24
25
25
* **Route resource**
26
26
+
27
-
The `Route` resource object is specific to {product-title} distributions, and builds upon standard Kubernetes primitives.
27
+
The `Route` resource object is specific to {OCP} distributions, and builds upon standard Kubernetes primitives.
28
28
+
29
29
* **Additional commands**
30
30
+
31
31
The additional command `oc new-app`, for example, makes it easier to get new applications started using existing source code or pre-built images.
32
32
33
33
[IMPORTANT]
34
34
====
35
-
If you installed an earlier version of the `oc` CLI tool, you cannot use it to complete all of the commands in {product-title} {ocp-version}. If you want the latest features, you must download and install the latest version of the `oc` CLI tool corresponding to your {product-title} version.
35
+
If you installed an earlier version of `oc`, you might not be able use it to complete all of the commands in {microshift-short} {product-version}. If you want the latest features, you must download and install the latest version of `oc` that corresponds with your {microshift-short} version.
36
36
====
37
37
38
-
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.
38
+
Using new capabilities often requires the latest `oc` binary. A 4.17 server might have additional capabilities that a 4.12 `oc` binary cannot use and a 4.17 `oc` binary might have additional capabilities that are unsupported by a 4.13 server.
39
39
40
40
.Compatibility Matrix
41
41
@@ -47,16 +47,11 @@ Non-security API changes will involve, at minimum, two minor releases (4.1 to 4.
47
47
|*X.Y+N* footnote:versionpolicyn[Where *N* is a number greater than or equal to 1.] (`oc` Client)
48
48
49
49
|*X.Y* (Server)
50
-
|image:redcircle-1.png[]
51
-
|image:redcircle-3.png[]
50
+
|Fully compatible.
51
+
|The `oc` CLI tool might provide options and features that are not compatible with the accessed server.
52
52
53
53
|*X.Y+N* footnote:versionpolicyn[] (Server)
54
-
|image:redcircle-2.png[]
55
-
|image:redcircle-1.png[]
54
+
|The `oc` CLI tool might not be able to access server features.
55
+
|Fully compatible.
56
56
57
57
|===
58
-
image:redcircle-1.png[] Fully compatible.
59
-
60
-
image:redcircle-2.png[] `oc` client might not be able to access server features.
61
-
62
-
image:redcircle-3.png[] `oc` client might provide options and features that might not be compatible with the accessed server.
Copy file name to clipboardExpand all lines: modules/cli-installing-cli-rpm.adoc
+5-3Lines changed: 5 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,9 @@ ifdef::openshift-rosa[]
13
13
endif::openshift-rosa[]
14
14
subscription on your Red Hat account.
15
15
16
-
[NOTE]
16
+
[IMPORTANT]
17
17
====
18
-
It is not supported to install the OpenShift CLI (`oc`) as an RPM for {op-system-base-full} 9. You must install the OpenShift CLI for {op-system-base} 9 by downloading the binary.
18
+
You must install `oc`for {op-system-base} 9 by downloading the binary. Installing `oc` by using an RPM package is not supported on {op-system-base-full} 9.
19
19
====
20
20
21
21
.Prerequisites
@@ -79,7 +79,9 @@ endif::openshift-rosa[]
79
79
# yum install openshift-clients
80
80
----
81
81
82
-
After you install the CLI, it is available using the `oc` command:
82
+
.Verification
83
+
84
+
* Verify your installation by using an `oc` command:
Copy file name to clipboardExpand all lines: modules/microshift-oc-apis-errors.adoc
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
[id="microshift-oc-apis-errors_{context}"]
7
7
= oc command errors in {product-title}
8
8
9
-
Not all OpenShift CLI (oc) tool commands are relevant for {product-title} deployments. When you use `oc` to make a request call against an unsupported API, the `oc` binary usually generates an error message about a resource that cannot be found.
9
+
Not all {oc-first}commands are relevant for {microshift-short} deployments. When you use `oc` to make a request call against an unsupported API, the `oc` binary usually generates an error message about a resource that cannot be found.
0 commit comments