Skip to content

Commit 9b7b789

Browse files
PreeticpPreeticp
authored
Merge pull request #40570 from gabriel-rh/RHDEVDOCS-3591odoinstall
RHDEVDOCS-3591: odo 250 installation guide
2 parents 839ab77 + 547268c commit 9b7b789

5 files changed

+133
-108
lines changed

‎cli_reference/developer_cli_odo/installing-odo.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,23 @@ include::modules/common-attributes.adoc[]
66

77
toc::[]
88

9-
The following section describes how to install `{odo-title}` on different platforms using the CLI or the Visual Studio Code (VS Code) IDE.
9+
// The following section describes how to install `{odo-title}` on different platforms using the CLI or the Visual Studio Code (VS Code) IDE.
10+
11+
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.
1012

1113
[NOTE]
1214
====
1315
Currently, `{odo-title}` does not support installation in a restricted network environment.
1416
====
1517

16-
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*
18+
// 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*
1719

1820
include::modules/developer-cli-odo-installing-odo-on-linux.adoc[leveloffset=+1]
1921

20-
include::modules/developer-cli-odo-installing-odo-on-linux-on-ibm-power.adoc[leveloffset=+1]
21-
22-
include::modules/developer-cli-odo-installing-odo-on-linux-on-ibm-z.adoc[leveloffset=+1]
23-
2422
include::modules/developer-cli-odo-installing-odo-on-windows.adoc[leveloffset=+1]
2523

2624
include::modules/developer-cli-odo-installing-odo-on-macos.adoc[leveloffset=+1]
2725

2826
include::modules/developer-cli-odo-installing-odo-on-vs-code.adoc[leveloffset=+1]
27+
28+
include::modules/developer-cli-odo-installing-odo-on-linux-rpm.adoc[leveloffset=+1]

‎modules/developer-cli-odo-installing-odo-on-linux-rpm.adoc

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
[id="installing-odo-on-linux-rpm_{context}"]
2+
3+
= Installing {odo-title} on {op-system-base-full} using an RPM
4+
5+
For {op-system-base-full}, you can install the `{odo-title}` CLI as an RPM.
6+
7+
.Procedure
8+
9+
. Register with Red Hat Subscription Manager:
10+
+
11+
[source,terminal]
12+
----
13+
# subscription-manager register
14+
----
15+
16+
. Pull the latest subscription data:
17+
+
18+
[source,terminal]
19+
----
20+
# subscription-manager refresh
21+
----
22+
23+
. List the available subscriptions:
24+
+
25+
[source,terminal]
26+
----
27+
# subscription-manager list --available --matches '*OpenShift Developer Tools and Services*'
28+
----
29+
30+
. 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:
31+
+
32+
[source,terminal]
33+
----
34+
# subscription-manager attach --pool=<pool_id>
35+
----
36+
37+
. Enable the repositories required by `{odo-title}`:
38+
+
39+
[source,terminal]
40+
----
41+
# subscription-manager repos --enable="ocp-tools-4.9-for-rhel-8-x86_64-rpms"
42+
----
43+
44+
. Install the `{odo-title}` package:
45+
+
46+
[source,terminal]
47+
----
48+
# yum install odo
49+
----
50+
51+
. Verify that `{odo-title}` is now available on your system:
52+
+
53+
[source,terminal]
54+
----
55+
$ odo version
56+
----

‎modules/developer-cli-odo-installing-odo-on-linux.adoc

Lines changed: 19 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -6,88 +6,47 @@
66

77
= Installing {odo-title} on Linux
88

9-
== Binary installation
9+
The `{odo-title}` CLI is available to download as a binary and as a tarball for multiple operating systems and architectures including:
1010

11-
.Procedure
12-
13-
. Obtain the binary:
14-
+
15-
[source,terminal]
16-
----
17-
# curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-linux-amd64 -o /usr/local/bin/odo
18-
----
11+
[cols="2,1,1",options="header"]
12+
|===
13+
|Operating System|Binary|Tarball
14+
|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]
15+
|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]
16+
|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]
17+
|===
1918

20-
. Change the permissions on the file:
21-
+
22-
[source,terminal]
23-
----
24-
# chmod +x /usr/local/bin/odo
25-
----
26-
27-
== Tarball installation
2819

2920
.Procedure
3021

31-
. Obtain the tarball:
22+
. 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.
23+
** If you download the binary, rename it to `odo`:
3224
+
3325
[source,terminal]
3426
----
35-
# 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'
27+
$ curl -L https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-linux-amd64 -o odo
3628
----
37-
38-
. Change the permissions on the file:
29+
** If you download the tarball, extract the binary:
3930
+
4031
[source,terminal]
4132
----
42-
# chmod +x /usr/local/bin/odo
33+
$ 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
34+
$ tar xvzf odo.zip
4335
----
44-
45-
== Installing with yum on {op-system-base-full}
46-
47-
.Procedure
48-
49-
. Register with Red Hat Subscription Manager:
36+
. Change the permissions on the binary:
5037
+
5138
[source,terminal]
5239
----
53-
# subscription-manager register
40+
$ chmod +x <filename>
5441
----
55-
56-
. Pull the latest subscription data:
42+
. Place the `{odo-title}` binary in a directory that is on your `PATH`.
5743
+
58-
[source,terminal]
59-
----
60-
# subscription-manager refresh
61-
----
62-
63-
. List the available subscriptions:
64-
+
65-
[source,terminal]
66-
----
67-
# subscription-manager list --available --matches '*OpenShift Developer Tools and Services*'
68-
----
69-
70-
. 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:
71-
+
72-
[source,terminal]
73-
----
74-
# subscription-manager attach --pool=<pool_id>
75-
----
76-
77-
. Enable the repositories required by `{odo-title}`:
44+
To check your `PATH`, execute the following command:
7845
+
7946
[source,terminal]
8047
----
81-
# subscription-manager repos --enable="ocp-tools-4.9-for-rhel-8-x86_64-rpms"
48+
$ echo $PATH
8249
----
83-
84-
. Install the `{odo-title}` package:
85-
+
86-
[source,terminal]
87-
----
88-
# yum install odo
89-
----
90-
9150
. Verify that `{odo-title}` is now available on your system:
9251
+
9352
[source,terminal]

‎modules/developer-cli-odo-installing-odo-on-macos.adoc

Lines changed: 25 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,38 +6,47 @@
66

77
= Installing {odo-title} on macOS
88

9-
== Binary installation
9+
The `{odo-title}` CLI for macOS is available to download as a binary and as a tarball.
10+
11+
[cols="2,1,1",options="header"]
12+
|===
13+
|Operating System|Binary|Tarball
14+
|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]
15+
|===
1016

1117
.Procedure
1218

13-
. Obtain the binary:
19+
. 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:
20+
** If you download the binary, rename it to `odo`:
1421
+
1522
[source,terminal]
1623
----
17-
# curl -L https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64 -o /usr/local/bin/odo
24+
$ curl -L https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/latest/odo-darwin-amd64 -o odo
1825
----
19-
20-
. Change the permissions on the file:
26+
** If you download the tarball, extract the binary:
2127
+
2228
[source,terminal]
2329
----
24-
# chmod +x /usr/local/bin/odo
30+
$ 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
31+
$ tar xvzf odo.tar.gz
2532
----
26-
27-
== Tarball installation
28-
29-
.Procedure
30-
31-
. Obtain the tarball:
33+
. Change the permissions on the binary:
3234
+
3335
[source,terminal]
3436
----
35-
# 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'
37+
# chmod +x odo
3638
----
37-
38-
. Change the permissions on the file:
39+
. Place the `{odo-title}` binary in a directory that is on your `PATH`.
40+
+
41+
To check your `PATH`, execute the following command:
3942
+
4043
[source,terminal]
4144
----
42-
# chmod +x /usr/local/bin/odo
45+
$ echo $PATH
46+
----
47+
. Verify that `{odo-title}` is now available on your system:
48+
+
49+
[source,terminal]
4350
----
51+
$ odo version
52+
----

‎modules/developer-cli-odo-installing-odo-on-windows.adoc

Lines changed: 27 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,30 @@
66

77
= Installing {odo-title} on Windows
88

9-
== Binary installation
10-
11-
. Download the latest link:https://mirror.openshift.com/pub/openshift-v4/clients/odo/latest/odo-windows-amd64.exe[`odo.exe`] file.
12-
. Add the location of your `odo.exe` to your `GOPATH/bin` directory.
13-
14-
[discrete]
15-
== Setting the `PATH` variable for Windows 7/8
16-
17-
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.
18-
19-
. Create a folder at `C:\go-bin`.
20-
. Right click *Start* and click *Control Panel*.
21-
. Select *System and Security* and then click *System*.
22-
. From the menu on the left, select the *Advanced systems settings* and click *Environment Variables* at the bottom.
23-
. Select *Path* from the *Variable* section and click *Edit*.
24-
. Click *New* and type `C:\go-bin` into the field or click *Browse* and select the directory, and click *OK*.
25-
26-
[discrete]
27-
== Setting the `PATH` variable for Windows 10
28-
29-
Edit `Environment Variables` using search:
30-
31-
. Click *Search* and type `env` or `environment`.
32-
. Select *Edit environment variables for your account*.
33-
. Select *Path* from the *Variable* section and click *Edit*.
34-
. Click *New* and type `C:\go-bin` into the field or click *Browse* and select the directory, and click *OK*.
9+
The `{odo-title}` CLI for Windows is available to download as a binary and as an archive.
10+
11+
[cols="2,1,1",options="header"]
12+
|===
13+
|Operating System|Binary|Tarball
14+
|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]
15+
|===
16+
17+
.Procedure
18+
19+
. 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:
20+
** If you download the binary, rename it to `odo.exe`.
21+
** If you download the archive, unzip the binary with a ZIP program and then rename it to `odo.exe`.
22+
. Move the `odo.exe` binary to a directory that is on your `PATH`.
23+
+
24+
To check your `PATH`, open the command prompt and execute the following command:
25+
+
26+
[source,terminal]
27+
----
28+
C:\> path
29+
----
30+
. Verify that `{odo-title}` is now available on your system:
31+
+
32+
[source,terminal]
33+
----
34+
C:\> odo version
35+
----

0 commit comments

Comments
 (0)