From e4b689dbfcc42faaf3cb017c5e0fb6cc2f4bf3b8 Mon Sep 17 00:00:00 2001 From: Gabriel McGoldrick Date: Thu, 13 Jan 2022 18:17:16 +0000 Subject: [PATCH] RHDEVDOCS-3591: odo 250 installation guide --- .../developer_cli_odo/installing-odo.adoc | 12 +-- ...r-cli-odo-installing-odo-on-linux-rpm.adoc | 56 ++++++++++++ ...loper-cli-odo-installing-odo-on-linux.adoc | 85 +++++-------------- ...loper-cli-odo-installing-odo-on-macos.adoc | 41 +++++---- ...per-cli-odo-installing-odo-on-windows.adoc | 47 +++++----- 5 files changed, 133 insertions(+), 108 deletions(-) create mode 100644 modules/developer-cli-odo-installing-odo-on-linux-rpm.adoc diff --git a/cli_reference/developer_cli_odo/installing-odo.adoc b/cli_reference/developer_cli_odo/installing-odo.adoc index 35cd184ba0..29b6f09e54 100644 --- a/cli_reference/developer_cli_odo/installing-odo.adoc +++ b/cli_reference/developer_cli_odo/installing-odo.adoc @@ -6,23 +6,23 @@ include::modules/common-attributes.adoc[] toc::[] -The following section describes how to install `{odo-title}` on different platforms using the CLI or the Visual Studio Code (VS Code) IDE. +// The following section describes how to install `{odo-title}` on different platforms using the CLI or the Visual Studio Code (VS Code) IDE. + +You can install the `{odo-title}` CLI on Linux, Windows, or macOS by downloading a binary. You can also install the OpenShift VS Code extension, which uses both the `{odo-title}` and the `oc` binaries to interact with your OpenShift Container Platform cluster. For {op-system-base-full}, you can install the `{odo-title}` CLI as an RPM. [NOTE] ==== Currently, `{odo-title}` does not support installation in a restricted network environment. ==== -You can also find the URL to the latest binaries from the {product-title} web console by clicking the *?* icon in the upper-right corner and selecting *Command Line Tools* +// You can also find the URL to the latest binaries from the {product-title} web console by clicking the *?* icon in the upper-right corner and selecting *Command Line Tools* include::modules/developer-cli-odo-installing-odo-on-linux.adoc[leveloffset=+1] -include::modules/developer-cli-odo-installing-odo-on-linux-on-ibm-power.adoc[leveloffset=+1] - -include::modules/developer-cli-odo-installing-odo-on-linux-on-ibm-z.adoc[leveloffset=+1] - include::modules/developer-cli-odo-installing-odo-on-windows.adoc[leveloffset=+1] include::modules/developer-cli-odo-installing-odo-on-macos.adoc[leveloffset=+1] include::modules/developer-cli-odo-installing-odo-on-vs-code.adoc[leveloffset=+1] + +include::modules/developer-cli-odo-installing-odo-on-linux-rpm.adoc[leveloffset=+1] \ No newline at end of file diff --git a/modules/developer-cli-odo-installing-odo-on-linux-rpm.adoc b/modules/developer-cli-odo-installing-odo-on-linux-rpm.adoc new file mode 100644 index 0000000000..2a91d72acd --- /dev/null +++ b/modules/developer-cli-odo-installing-odo-on-linux-rpm.adoc @@ -0,0 +1,56 @@ +[id="installing-odo-on-linux-rpm_{context}"] + += Installing {odo-title} on {op-system-base-full} using an RPM + +For {op-system-base-full}, you can install the `{odo-title}` CLI as an RPM. + +.Procedure + +. Register with Red Hat Subscription Manager: ++ +[source,terminal] +---- +# subscription-manager register +---- + +. Pull the latest subscription data: ++ +[source,terminal] +---- +# subscription-manager refresh +---- + +. List the available subscriptions: ++ +[source,terminal] +---- +# subscription-manager list --available --matches '*OpenShift Developer Tools and Services*' +---- + +. In the output of the previous command, find the `Pool ID` field for your {product-title} subscription and attach the subscription to the registered system: ++ +[source,terminal] +---- +# subscription-manager attach --pool= +---- + +. Enable the repositories required by `{odo-title}`: ++ +[source,terminal] +---- +# subscription-manager repos --enable="ocp-tools-4.9-for-rhel-8-x86_64-rpms" +---- + +. Install the `{odo-title}` package: ++ +[source,terminal] +---- +# yum install odo +---- + +. Verify that `{odo-title}` is now available on your system: ++ +[source,terminal] +---- +$ odo version +---- diff --git a/modules/developer-cli-odo-installing-odo-on-linux.adoc b/modules/developer-cli-odo-installing-odo-on-linux.adoc index b3bd63e9c4..52d9129c4a 100644 --- a/modules/developer-cli-odo-installing-odo-on-linux.adoc +++ b/modules/developer-cli-odo-installing-odo-on-linux.adoc @@ -6,88 +6,47 @@ = Installing {odo-title} on Linux -== Binary installation +The `{odo-title}` CLI is available to download as a binary and as a tarball for multiple operating systems and architectures including: + +[cols="2,1,1",options="header"] +|=== +|Operating System|Binary|Tarball +|Linux|link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-linux-amd64[odo-linux-amd64] |link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-linux-amd64.tar.gz[odo-linux-amd64.tar.gz] +|Linux on IBM Power|link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-linux-ppc64le[odo-linux-ppc64le] |link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-linux-ppc64le.tar.gz[odo-linux-ppc64le.tar.gz] +|Linux on IBM Z and LinuxONE|link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-linux-s390x[odo-linux-s390x] |link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-linux-s390x.tar.gz[odo-linux-s390x.tar.gz] +|=== + .Procedure -. Obtain the binary: +. Navigate to the link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/[content gateway] and download the appropriate file for your operating system and architecture. +** If you download the binary, rename it to `odo`: + [source,terminal] ---- -# curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-linux-amd64 -o /usr/local/bin/odo +$ curl -L https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-linux-amd64 -o odo ---- - -. Change the permissions on the file: +** If you download the tarball, extract the binary: + [source,terminal] ---- -# chmod +x /usr/local/bin/odo +$ curl -L https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-linux-amd64.tar.gz -o odo.tar.gz +$ tar xvzf odo.zip ---- - -== Tarball installation - -.Procedure - -. Obtain the tarball: +. Change the permissions on the binary: + [source,terminal] ---- -# sh -c 'curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-linux-amd64.tar.gz | gzip -d > /usr/local/bin/odo' +$ chmod +x ---- - -. Change the permissions on the file: +. Place the `{odo-title}` binary in a directory that is on your `PATH`. ++ +To check your `PATH`, execute the following command: + [source,terminal] ---- -# chmod +x /usr/local/bin/odo +$ echo $PATH ---- - -== Installing with yum on {op-system-base-full} - -.Procedure - -. Register with Red Hat Subscription Manager: -+ -[source,terminal] ----- -# subscription-manager register ----- - -. Pull the latest subscription data: -+ -[source,terminal] ----- -# subscription-manager refresh ----- - -. List the available subscriptions: -+ -[source,terminal] ----- -# subscription-manager list --available --matches '*OpenShift Developer Tools and Services*' ----- - -. In the output of the previous command, find the `Pool ID` field for your {product-title} subscription and attach the subscription to the registered system: -+ -[source,terminal] ----- -# subscription-manager attach --pool= ----- - -. Enable the repositories required by `{odo-title}`: -+ -[source,terminal] ----- -# subscription-manager repos --enable="ocp-tools-4.9-for-rhel-8-x86_64-rpms" ----- - -. Install the `{odo-title}` package: -+ -[source,terminal] ----- -# yum install odo ----- - . Verify that `{odo-title}` is now available on your system: + [source,terminal] diff --git a/modules/developer-cli-odo-installing-odo-on-macos.adoc b/modules/developer-cli-odo-installing-odo-on-macos.adoc index 6fa0e17212..2a90129782 100644 --- a/modules/developer-cli-odo-installing-odo-on-macos.adoc +++ b/modules/developer-cli-odo-installing-odo-on-macos.adoc @@ -6,38 +6,47 @@ = Installing {odo-title} on macOS -== Binary installation +The `{odo-title}` CLI for macOS is available to download as a binary and as a tarball. + +[cols="2,1,1",options="header"] +|=== +|Operating System|Binary|Tarball +|macOS|link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64[odo-darwin-amd64]|link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64.tar.gz[odo-darwin-amd64.tar.gz] +|=== .Procedure -. Obtain the binary: +. Navigate to the link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/[content gateway] and download the appropriate file: +** If you download the binary, rename it to `odo`: + [source,terminal] ---- -# curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64 -o /usr/local/bin/odo +$ curl -L https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64 -o odo ---- - -. Change the permissions on the file: +** If you download the tarball, extract the binary: + [source,terminal] ---- -# chmod +x /usr/local/bin/odo +$ curl -L https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64.tar.gz -o odo.tar.gz +$ tar xvzf odo.tar.gz ---- - -== Tarball installation - -.Procedure - -. Obtain the tarball: +. Change the permissions on the binary: + [source,terminal] ---- -# sh -c 'curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64.tar.gz | gzip -d > /usr/local/bin/odo' +# chmod +x odo ---- - -. Change the permissions on the file: +. Place the `{odo-title}` binary in a directory that is on your `PATH`. ++ +To check your `PATH`, execute the following command: + [source,terminal] ---- -# chmod +x /usr/local/bin/odo +$ echo $PATH ---- +. Verify that `{odo-title}` is now available on your system: ++ +[source,terminal] +---- +$ odo version +---- \ No newline at end of file diff --git a/modules/developer-cli-odo-installing-odo-on-windows.adoc b/modules/developer-cli-odo-installing-odo-on-windows.adoc index 08cca968e8..37d980785e 100644 --- a/modules/developer-cli-odo-installing-odo-on-windows.adoc +++ b/modules/developer-cli-odo-installing-odo-on-windows.adoc @@ -6,29 +6,30 @@ = Installing {odo-title} on Windows -== Binary installation +The `{odo-title}` CLI for Windows is available to download as a binary and as an archive. -. Download the latest link:https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-windows-amd64.exe[`odo.exe`] file. -. Add the location of your `odo.exe` to your `GOPATH/bin` directory. +[cols="2,1,1",options="header"] +|=== +|Operating System|Binary|Tarball +|Windows|link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-windows-amd64.exe[odo-windows-amd64.exe]|link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-windows-amd64.exe.zip[odo-windows-amd64.exe.zip] +|=== -[discrete] -== Setting the `PATH` variable for Windows 7/8 +.Procedure -The following example demonstrates how to set up a path variable. Your binaries can be located in any location, but this example uses `C:\go-bin` as the location. - -. Create a folder at `C:\go-bin`. -. Right click *Start* and click *Control Panel*. -. Select *System and Security* and then click *System*. -. From the menu on the left, select the *Advanced systems settings* and click *Environment Variables* at the bottom. -. Select *Path* from the *Variable* section and click *Edit*. -. Click *New* and type `C:\go-bin` into the field or click *Browse* and select the directory, and click *OK*. - -[discrete] -== Setting the `PATH` variable for Windows 10 - -Edit `Environment Variables` using search: - -. Click *Search* and type `env` or `environment`. -. Select *Edit environment variables for your account*. -. Select *Path* from the *Variable* section and click *Edit*. -. Click *New* and type `C:\go-bin` into the field or click *Browse* and select the directory, and click *OK*. +. Navigate to the link:https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/[content gateway] and download the appropriate file: +** If you download the binary, rename it to `odo.exe`. +** If you download the archive, unzip the binary with a ZIP program and then rename it to `odo.exe`. +. Move the `odo.exe` binary to a directory that is on your `PATH`. ++ +To check your `PATH`, open the command prompt and execute the following command: ++ +[source,terminal] +---- +C:\> path +---- +. Verify that `{odo-title}` is now available on your system: ++ +[source,terminal] +---- +C:\> odo version +---- \ No newline at end of file