Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reorganizes installation document #6086

Merged
merged 2 commits into from
Sep 7, 2022
Merged

Reorganizes installation document #6086

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72f87e1
Reorganizes installation document
cdrage Sep 1, 2022
190b1ca
update based on review
cdrage Sep 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 26 additions & 39 deletions docs/website/docs/overview/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,11 @@ sidebar_position: 4

`odo` can be used as either a [CLI tool](./installation#cli-binary-installation) or an [IDE plugin](./installation#ide-installation) on Mac, Windows or Linux.

## CLI installation

Each release is *signed*, *checksummed*, *verified*, and then pushed to our [binary mirror](https://developers.redhat.com/content-gateway/rest/mirror/pub/openshift-v4/clients/odo/).

For more information on the changes of each release, they can be viewed either on [GitHub](https://github.com/redhat-developer/odo/releases) or the [blog](/blog).

### Linux
## Linux

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Expand Down Expand Up @@ -153,14 +151,33 @@ echo 'export PATH=$PATH:$HOME/bin' >> ~/.bashrc

---

### MacOS
## MacOS

### Homebrew

**NOTE:** This will install from the *main* branch on GitHub

Installing `odo` using [Homebrew](https://brew.sh/):

1. Install odo:

```shell
brew install --HEAD odo-dev
```

2. Verify the version you installed is up-to-date:

```shell
odo version
```

### Binary

<Tabs
defaultValue="intel"
values={[
{label: 'Intel', value: 'intel'},
{label: 'Apple Silicon', value: 'arm'},
{label: 'Homebrew', value: 'homebrew'},
]}>

<TabItem value="intel">
Expand Down Expand Up @@ -227,31 +244,11 @@ echo 'export PATH=$PATH:$HOME/bin' >> ~/.bashrc
```
</TabItem>

<TabItem value="homebrew">

**NOTE:** This will install from the *main* branch on GitHub

Installing `odo` using [Homebrew](https://brew.sh/):

1. Install odo:

```shell
brew install --HEAD odo-dev
```

2. Verify the version you installed is up-to-date:

```shell
odo version
```

</TabItem>

</Tabs>

---

### Windows
## Windows

1. Open a PowerShell terminal

Expand All @@ -270,8 +267,9 @@ type odo.exe.sha256

4. Add the binary to your `PATH`

## Alternative installation methods

### Installing from source code
### Source code
1. Clone the repository and cd into it.
```shell
git clone https://github.com/redhat-developer/odo.git
Expand All @@ -298,22 +296,11 @@ type odo.exe.sha256
odo version
```

### Installing `odo` using Maven plugin
### Maven plugin
It is possible to integrate the odo binary download in a Maven project using [odo Downloader Plugin](https://github.com/tnb-software/odo-downloader).
The download can be executed using `download` goal which automatically retrieves the version for the current architecture:
```shell
mvn software.tnb:odo-downloader-maven-plugin:0.1.3:download \
-Dodo.target.file=$HOME/bin/odo \
-Dodo.version=v3.0.0~rc1
```

## IDE Installation

### Installing `odo` in Visual Studio Code (VSCode)
The [OpenShift VSCode extension](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-openshift-connector) uses both `odo` and `oc` binary to interact with Kubernetes or OpenShift cluster.
1. Open VS Code.
2. Launch VS Code Quick Open (Ctrl+P)
3. Paste the following command:
```shell
ext install redhat.vscode-openshift-connector
```