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
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.
10
+
11
+
CLI tools available for use with {product-title} are the following:
12
+
13
+
* Built-in `microshift` command types
14
+
* Linux CLI tools
15
+
* Kubernetes CLI (`kubectl`)
16
+
* The OpenShift CLI (`oc`) tool with an enabled subset of commands
17
+
18
+
[NOTE]
19
+
====
20
+
Commands for multi-node deployments, projects, and developer tooling are not supported by {product-title}.
21
+
====
22
+
23
+
[role="_additional-resources"]
24
+
[id="additional-resources_microshift-cli-tools"]
25
+
.Additional resources
26
+
27
+
* xref:..//microshift_cli_ref/microshift-oc-cli-install.adoc#microshift-oc-cli-install[Installing the OpenShift CLI tool for MicroShift].
28
+
29
+
* link:https://access.redhat.com/documentation/en-us/openshift_container_platform/4.13/html/cli_tools/openshift-cli-oc[Detailed description of the OpenShift CLI (oc)].
30
+
31
+
* link:https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/9[Red Hat Enterprise Linux (RHEL) documentation for specific use cases].
Copy file name to clipboardExpand all lines: microshift_cli_ref/microshift-cli-using-oc.adoc
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
:_content-type: ASSEMBLY
2
2
[id="microshift-cli-using-oc"]
3
-
= Using the `oc` tool
3
+
= Using the oc tool
4
4
include::_attributes/attributes-microshift.adoc[]
5
5
:context: microshift-using-oc
6
6
7
7
toc::[]
8
8
9
-
The optional OpenShift CLI (`oc`) tool is available for you to use if you are already familiar with {OCP} and Kubernetes.
9
+
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.
Copy file name to clipboardExpand all lines: microshift_cli_ref/microshift-oc-cli-commands-list.adoc
+22-7Lines changed: 22 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,21 +2,36 @@
2
2
[id="microshift-oc-cli-commands"]
3
3
= OpenShift CLI command reference
4
4
include::_attributes/attributes-microshift.adoc[]
5
-
:context: cli-administrator-commands
5
+
:context: microshift-oc-cli-commands
6
6
7
7
toc::[]
8
8
9
-
This reference provides descriptions and example commands for OpenShift CLI (`oc`) commands. You must have `cluster-admin` or equivalent permissions to use these commands.
9
+
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:
10
10
11
-
Run `oc adm -h` to list all administrator commands or run `oc <command> --help` to get additional details for a specific command.
11
+
* Enter the `oc adm -h` command to list all administrator commands:
12
+
+
13
+
.Command syntax
14
+
+
15
+
[source,terminal]
16
+
----
17
+
$ oc adm -h
18
+
----
19
+
20
+
* Enter the `oc <command> --help` command to get additional details for a specific command:
21
+
+
22
+
.Command syntax
23
+
+
24
+
[source,terminal]
25
+
----
26
+
$ oc <command> --help
27
+
----
12
28
13
29
[IMPORTANT]
14
30
====
15
31
Using `oc <command> --help` lists details for any `oc` command. Not all `oc` commands apply to using {product-title}.
16
32
====
17
33
18
-
// The OCP file is auto-generated from the openshift/oc repository; MicroShift is made manually
// The OCP files are auto-generated from the openshift/oc repository; use the MicroShift-specific flags to generate MicroShift command files from the same repo
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` binaries that ship with {product-title}, or you can gain extended functionality by using the `oc` binary.
9
+
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.
10
+
11
+
[id="microshift-kubectl-binary_{context}"]
12
+
== The kubectl CLI tool
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.
15
+
16
+
The `kubectl` CLI tool is included in the archive if you download the `oc` CLI tool.
17
+
18
+
For more information, read the link:https://kubernetes.io/docs/reference/kubectl/overview/[Kubernetes CLI tool documentation].
10
19
11
20
[id="microshift-oc-binary_{context}"]
12
-
== The oc binary
21
+
== The oc CLI tool
13
22
14
-
The `oc` binary offers the same capabilities as the `kubectl` binary, 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 {product-title} features, including:
15
24
16
25
* **Route resource**
17
26
+
@@ -23,7 +32,7 @@ The additional command `oc new-app`, for example, makes it easier to get new app
23
32
24
33
[IMPORTANT]
25
34
====
26
-
If you installed an earlier version of the `oc` binary, you cannot use it to complete all of the commands in {product-title} {product-version}. If you want the latest features, you must download and install the latest version of the `oc` binary corresponding to your {product-title} server version.
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.
27
36
====
28
37
29
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.
image:redcircle-2.png[] `oc` client might not be able to access server features.
52
61
53
62
image:redcircle-3.png[] `oc` client might provide options and features that might not be compatible with the accessed server.
54
-
55
-
[id="microshift-kubectl-binary_{context}"]
56
-
== The kubectl binary
57
-
58
-
The `kubectl` binary is provided as a means to support existing workflows and scripts for new {product-title} 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 {product-title} cluster.
59
-
60
-
The `kubectl` binary is included in the archive if you download the `oc` binary.
61
-
62
-
For more information, see the link:https://kubernetes.io/docs/reference/kubectl/overview/[kubectl documentation].
= Opening the firewall for remote access to the {product-title} cluster
10
10
11
-
Use the following procedure to open the firewall so that a remote user can access the {product-title} cluster. Your account must have cluster admin privileges. This procedure must be completed before a workstation user can access the cluster remotely.
11
+
Use the following procedure to open the firewall so that a remote user can access the {product-title} cluster. This procedure must be completed before a workstation user can access the cluster remotely.
12
12
13
-
* `user@microshift`, is the user on the {product-title} host machine and is responsible for setting up that machine so that it can be accessed by a remote user on a separate workstation.
13
+
For this procedure, `user@microshift` is the user on the {product-title} host machine and is responsible for setting up that machine so that it can be accessed by a remote user on a separate workstation.
14
14
15
15
.Prerequisites
16
16
17
17
* You have installed the `oc` binary.
18
18
19
+
* Your account has cluster administration privileges.
20
+
19
21
.Procedure
20
22
21
-
. As `user@microshift` on the {product-title} host, open the firewall port for the Kubernetes API server (`6443/tcp`) by running the following command:
23
+
* As `user@microshift` on the {product-title} host, open the firewall port for the Kubernetes API server (`6443/tcp`) by running the following command:
0 commit comments