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

Jump to bottom

Simplify installation instructions #1100

Merged
merged 1 commit into from
Apr 1, 2020
Merged

Simplify installation instructions #1100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 7 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,23 +31,16 @@ Sonobuoy supports 3 Kubernetes minor versions: the current release and 2 minor v

* The `sonobuoy images` subcommand requires [Docker](https://www.docker.com) to be installed. See [installing Docker](docker).

## Installing
## Installation

We recommend installing Sonobuoy via downloading one of the releases directly from [here][releases].
1. Download the [latest release][releases] for your client platform.
2. Extract the tarball:

You can use the web UI to download a release or from the terminal:
```
tar -xvf <RELEASE_TARBALL_NAME>.tar.gz
```

```
$ VERSION=0.16.1 OS=darwin && \
curl -L "https://github.com/vmware-tanzu/sonobuoy/releases/download/v${VERSION}/sonobuoy_${VERSION}_${OS}_amd64.tar.gz" --output $HOME/bin/sonobuoy.tar.gz && \
tar -xzf $HOME/bin/sonobuoy.tar.gz -C $HOME/bin && \
chmod +x $HOME/bin/sonobuoy && \
rm $HOME/bin/sonobuoy.tar.gz
```

> Note: Be sure to update the OS to your local value. Supported values are: "linux", "darwin", and "windows".

If building locally, you should clone the repository and run `make`. To build locally, Docker is required.
Move the extracted `sonobuoy` executable to somewhere on your `PATH`.

## Getting Started

Expand Down
21 changes: 7 additions & 14 deletions site/docs/master/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,23 +31,16 @@ Sonobuoy supports 3 Kubernetes minor versions: the current release and 2 minor v

* The `sonobuoy images` subcommand requires [Docker](https://www.docker.com) to be installed. See [installing Docker](docker).

## Installing
## Installation

We recommend installing Sonobuoy via downloading one of the releases directly from [here][releases].
1. Download the [latest release][releases] for your client platform.
2. Extract the tarball:

You can use the web UI to download a release or from the terminal:
```
tar -xvf <RELEASE_TARBALL_NAME>.tar.gz
```

```
$ VERSION=0.16.1 OS=darwin && \
curl -L "https://github.com/vmware-tanzu/sonobuoy/releases/download/v${VERSION}/sonobuoy_${VERSION}_${OS}_amd64.tar.gz" --output $HOME/bin/sonobuoy.tar.gz && \
tar -xzf $HOME/bin/sonobuoy.tar.gz -C $HOME/bin && \
chmod +x $HOME/bin/sonobuoy && \
rm $HOME/bin/sonobuoy.tar.gz
```

> Note: Be sure to update the OS to your local value. Supported values are: "linux", "darwin", and "windows".

If building locally, you should clone the repository and run `make`. To build locally, Docker is required.
Move the extracted `sonobuoy` executable to somewhere on your `PATH`.

## Getting Started

Expand Down