2019-03-11 20:59:48 -04:00
|
|
|
// Module included in the following assemblies:
|
|
|
|
|
//
|
2019-10-02 11:30:49 -04:00
|
|
|
// * cli_reference/openshift_cli/getting-started.adoc
|
2019-12-10 14:21:26 -05:00
|
|
|
// * installing/installing_aws/installing-aws-user-infra.adoc
|
2019-10-03 13:05:34 -04:00
|
|
|
// * installing/installing_aws/installing-aws-customizations.adoc
|
|
|
|
|
// * installing/installing_aws/installing-aws-default.adoc
|
2020-09-17 11:58:34 -04:00
|
|
|
// * installing/installing_aws/installing-aws-government-region.adoc
|
2019-10-03 13:05:34 -04:00
|
|
|
// * installing/installing_aws/installing-aws-network-customizations.adoc
|
2019-11-07 13:56:52 -05:00
|
|
|
// * installing/installing_aws/installing-aws-private.adoc
|
2019-11-08 15:26:26 -05:00
|
|
|
// * installing/installing_aws/installing-aws-vpc.adoc
|
2019-10-03 13:05:34 -04:00
|
|
|
// * installing/installing_azure/installing-azure-customizations.adoc
|
|
|
|
|
// * installing/installing_azure/installing-azure-default.adoc
|
2020-09-24 14:32:22 -04:00
|
|
|
// * installing/installing_azure/installing-azure-government-region.adoc
|
2019-11-22 08:24:58 -05:00
|
|
|
// * installing/installing_azure/installing-azure-private.adoc
|
2019-11-15 08:50:08 -05:00
|
|
|
// * installing/installing_azure/installing-azure-vnet.adoc
|
2020-01-30 14:13:19 -05:00
|
|
|
// * installing/installing_azure/installing-azure-user-infra.adoc
|
2019-10-03 13:05:34 -04:00
|
|
|
// * installing/installing_bare_metal/installing-bare-metal.adoc
|
|
|
|
|
// * installing/installing_gcp/installing-gcp-customizations.adoc
|
2019-11-07 13:56:52 -05:00
|
|
|
// * installing/installing_gcp/installing-gcp-private.adoc
|
2019-10-03 13:05:34 -04:00
|
|
|
// * installing/installing_gcp/installing-gcp-default.adoc
|
2019-11-18 12:35:43 -05:00
|
|
|
// * installing/installing_gcp/installing-gcp-vpc.adoc
|
2019-12-10 14:21:26 -05:00
|
|
|
// * installing/installing_gcp/installing-gcp-user-infra.adoc
|
|
|
|
|
// * installing/install_config/installing-restricted-networks-preparations.adoc
|
2019-10-03 13:05:34 -04:00
|
|
|
// * installing/installing_vsphere/installing-vsphere.adoc
|
2020-05-29 09:31:13 -04:00
|
|
|
// * installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc
|
|
|
|
|
// * installing/installing_vsphere/installing-vsphere-installer-provisioned-customizations.adoc
|
2019-11-28 12:41:35 +01:00
|
|
|
// * installing/installing_ibm_z/installing-ibm-z.adoc
|
2019-11-07 11:00:17 -05:00
|
|
|
// * openshift_images/samples-operator-alt-registry.adoc
|
2020-03-29 10:11:00 -04:00
|
|
|
// * installing/installing_rhv/installing-rhv-customizations.adoc
|
|
|
|
|
// * installing/installing_rhv/installing-rhv-default.adoc
|
2020-05-08 22:49:34 +05:30
|
|
|
// * updating/updating-restricted-network-cluster.adoc
|
2019-07-15 19:47:25 -04:00
|
|
|
//
|
|
|
|
|
// AMQ docs link to this; do not change anchor
|
2019-03-11 20:59:48 -04:00
|
|
|
|
2020-05-08 22:49:34 +05:30
|
|
|
ifeval::["{context}" == "updating-restricted-network-cluster"]
|
|
|
|
|
:restricted:
|
|
|
|
|
endif::[]
|
|
|
|
|
|
2019-05-13 08:55:00 +10:00
|
|
|
[id="cli-installing-cli_{context}"]
|
2021-02-04 08:45:01 -07:00
|
|
|
= Installing the OpenShift CLI by downloading the binary
|
2019-03-11 20:59:48 -04:00
|
|
|
|
2021-03-24 11:55:35 -04:00
|
|
|
You can install the OpenShift CLI (`oc`) to interact with {product-title} from a
|
2020-04-21 13:53:42 -04:00
|
|
|
command-line interface. You can install `oc` on Linux, Windows, or macOS.
|
2019-03-11 20:59:48 -04:00
|
|
|
|
2019-10-03 13:05:34 -04:00
|
|
|
[IMPORTANT]
|
|
|
|
|
====
|
|
|
|
|
If you installed an earlier version of `oc`, you cannot use it to complete all
|
2019-10-01 14:34:47 -04:00
|
|
|
of the commands in {product-title} {product-version}. Download and
|
2019-10-03 13:05:34 -04:00
|
|
|
install the new version of `oc`.
|
2020-05-08 22:49:34 +05:30
|
|
|
ifdef::restricted[]
|
|
|
|
|
If you are upgrading a cluster in a restricted network, install the `oc` version that you plan to upgrade to.
|
|
|
|
|
endif::restricted[]
|
2019-10-03 13:05:34 -04:00
|
|
|
====
|
|
|
|
|
|
2020-04-21 13:53:42 -04:00
|
|
|
[id="cli-installing-cli-on-linux_{context}"]
|
2021-02-04 08:45:01 -07:00
|
|
|
== Installing the OpenShift CLI on Linux
|
2020-04-21 13:53:42 -04:00
|
|
|
|
|
|
|
|
You can install the OpenShift CLI (`oc`) binary on Linux by using the following procedure.
|
|
|
|
|
|
2019-03-11 20:59:48 -04:00
|
|
|
.Procedure
|
2020-04-21 13:53:42 -04:00
|
|
|
|
2020-03-28 12:02:37 +01:00
|
|
|
ifdef::openshift-origin[]
|
2020-04-21 13:53:42 -04:00
|
|
|
. Navigate to https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/ and choose the folder for your operating system and architecture.
|
|
|
|
|
. Download `oc.tar.gz`.
|
2020-03-28 12:02:37 +01:00
|
|
|
endif::[]
|
|
|
|
|
ifndef::openshift-origin[]
|
2020-04-21 13:53:42 -04:00
|
|
|
. Navigate to the link:https://cloud.redhat.com/openshift/install[Infrastructure Provider] page on the {cloud-redhat-com} site.
|
|
|
|
|
. Select your infrastructure provider, and, if applicable, your installation type.
|
|
|
|
|
. In the *Command-line interface* section, select *Linux* from the drop-down menu and click *Download command-line tools*.
|
2020-03-28 12:02:37 +01:00
|
|
|
endif::[]
|
2020-04-21 13:53:42 -04:00
|
|
|
. Unpack the archive:
|
2019-10-03 13:05:34 -04:00
|
|
|
+
|
2020-08-05 10:46:55 -04:00
|
|
|
[source,terminal]
|
2020-04-21 13:53:42 -04:00
|
|
|
----
|
|
|
|
|
$ tar xvzf <file>
|
|
|
|
|
----
|
|
|
|
|
. Place the `oc` binary in a directory that is on your `PATH`.
|
|
|
|
|
+
|
|
|
|
|
To check your `PATH`, execute the following command:
|
|
|
|
|
+
|
2020-08-05 10:46:55 -04:00
|
|
|
[source,terminal]
|
2020-04-21 13:53:42 -04:00
|
|
|
----
|
|
|
|
|
$ echo $PATH
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
After you install the CLI, it is available using the `oc` command:
|
|
|
|
|
|
2020-08-05 10:46:55 -04:00
|
|
|
[source,terminal]
|
2020-04-21 13:53:42 -04:00
|
|
|
----
|
|
|
|
|
$ oc <command>
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
[id="cli-installing-cli-on-windows_{context}"]
|
2021-02-04 08:45:01 -07:00
|
|
|
== Installing the OpenShift CLI on Windows
|
2020-04-21 13:53:42 -04:00
|
|
|
|
|
|
|
|
You can install the OpenShift CLI (`oc`) binary on Windows by using the following procedure.
|
|
|
|
|
|
|
|
|
|
.Procedure
|
|
|
|
|
|
|
|
|
|
ifdef::openshift-origin[]
|
|
|
|
|
. Navigate to https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/ and choose the folder for your operating system and architecture.
|
|
|
|
|
. Download `oc.zip`.
|
|
|
|
|
endif::[]
|
|
|
|
|
ifndef::openshift-origin[]
|
|
|
|
|
. Navigate to the link:https://cloud.redhat.com/openshift/install[Infrastructure Provider] page on the {cloud-redhat-com} site.
|
|
|
|
|
. Select your infrastructure provider, and, if applicable, your installation type.
|
|
|
|
|
. In the *Command-line interface* section, select *Windows* from the drop-down menu and click *Download command-line tools*.
|
|
|
|
|
endif::[]
|
|
|
|
|
. Unzip the archive with a ZIP program.
|
|
|
|
|
. Move the `oc` binary to a directory that is on your `PATH`.
|
|
|
|
|
+
|
|
|
|
|
To check your `PATH`, open the command prompt and execute the following command:
|
|
|
|
|
+
|
2020-08-05 10:46:55 -04:00
|
|
|
[source,terminal]
|
2020-04-21 13:53:42 -04:00
|
|
|
----
|
|
|
|
|
C:\> path
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
After you install the CLI, it is available using the `oc` command:
|
|
|
|
|
|
2020-08-05 10:46:55 -04:00
|
|
|
[source,terminal]
|
2020-04-21 13:53:42 -04:00
|
|
|
----
|
|
|
|
|
C:\> oc <command>
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
[id="cli-installing-cli-on-macos_{context}"]
|
2021-02-04 08:45:01 -07:00
|
|
|
== Installing the OpenShift CLI on macOS
|
2020-04-21 13:53:42 -04:00
|
|
|
|
|
|
|
|
You can install the OpenShift CLI (`oc`) binary on macOS by using the following procedure.
|
|
|
|
|
|
|
|
|
|
.Procedure
|
|
|
|
|
|
|
|
|
|
ifdef::openshift-origin[]
|
|
|
|
|
. Navigate to https://mirror.openshift.com/pub/openshift-v4/clients/oc/latest/ and choose the folder for your operating system and architecture.
|
|
|
|
|
. Download `oc.tar.gz`.
|
|
|
|
|
endif::[]
|
|
|
|
|
ifndef::openshift-origin[]
|
|
|
|
|
. Navigate to the link:https://cloud.redhat.com/openshift/install[Infrastructure Provider] page on the {cloud-redhat-com} site.
|
|
|
|
|
. Select your infrastructure provider, and, if applicable, your installation type.
|
|
|
|
|
. In the *Command-line interface* section, select *MacOS* from the drop-down menu and click *Download command-line tools*.
|
|
|
|
|
endif::[]
|
|
|
|
|
. Unpack and unzip the archive.
|
|
|
|
|
. Move the `oc` binary to a directory on your PATH.
|
|
|
|
|
+
|
|
|
|
|
To check your `PATH`, open a terminal and execute the following command:
|
|
|
|
|
+
|
2020-08-05 10:46:55 -04:00
|
|
|
[source,terminal]
|
2020-04-21 13:53:42 -04:00
|
|
|
----
|
|
|
|
|
$ echo $PATH
|
|
|
|
|
----
|
2019-03-11 20:59:48 -04:00
|
|
|
|
|
|
|
|
After you install the CLI, it is available using the `oc` command:
|
|
|
|
|
|
2020-08-05 10:46:55 -04:00
|
|
|
[source,terminal]
|
2019-03-11 20:59:48 -04:00
|
|
|
----
|
|
|
|
|
$ oc <command>
|
|
|
|
|
----
|
2020-05-08 22:49:34 +05:30
|
|
|
|
|
|
|
|
|
|
|
|
|
ifeval::["{context}" == "updating-restricted-network-cluster"]
|
|
|
|
|
:!restricted:
|
|
|
|
|
endif::[]
|
