Skip to content

Commit dbde3d9

Browse files
authored
Merge pull request #9 from nginxinc/mrajagopal
Issue 8: Update readme for installation via krew
2 parents d096d0c + 18702e7 commit dbde3d9

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,20 @@ Depending on the product, the plugin might collect some or all of the following
1919

2020
The plugin DOES NOT collect secrets or coredumps.
2121

22+
## Prerequisites
23+
* Install [krew](https://krew.sigs.k8s.io), the plugin manager for kubectl command-line tool, from the [official pages](https://krew.sigs.k8s.io/docs/user-guide/setup/install/)
24+
* Run `kubectl krew` to check the installation
25+
* Run through some of the examples in krew's [quickstart guide](https://krew.sigs.k8s.io/docs/user-guide/quickstart/)
26+
2227
## Installation
2328

29+
### Install from krew
30+
The `nginx-supportpkg` plugin can be found in the list of kubectl plugins distributed on the centralized [krew-index](https://sigs.k8s.io/krew-index).
31+
32+
To install `nginx-supportpkg` plugin on your machine:
33+
* Run `kubectl krew install nginx-supportpkg`
34+
35+
2436
### Building from source
2537
Clone the repo and run `make install`. This will build the binary and copy it on `/usr/local/bin/`.
2638

0 commit comments

Comments
 (0)