Skip to content

Commit

Permalink
updates install instruction re krew index
Browse files Browse the repository at this point in the history
  • Loading branch information
mhausenblas committed Dec 4, 2019
1 parent a976cb7 commit e042cda
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion doc/USAGE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,23 @@
## Installation

Most typically, you'd want to install `fleet` as a `kubectl` plugin.
In order to be able to do that, make sure you have [krew installed](https://github.com/kubernetes-sigs/krew/#installation) and then you can install `fleet` from this repo as follows:
In order to be able to do that, make sure you have [krew installed](https://github.com/kubernetes-sigs/krew/#installation) and then you can install `fleet` as follows:

```sh
$ kubectl krew install fleet.yaml
```

Alternatively, for a version that is not yet updated and hence available in the [krew index](https://index.krew.dev/), you can install `fleet` from this repo as follows:

```sh
$ git clone https://github.com/mhausenblas/kcf.git && cd kcf

$ kubectl krew install --manifest=deploy/krew/fleet.yaml
```

If the installation fails, check if `krew` is available on your local system
and also, make sure you're using the most recent index (run `kubectl krew update`) to ensure this.

## Usage

There are two levels `fleet` operates on: the top-level command, without any
Expand Down

0 comments on commit e042cda

Please sign in to comment.