Skip to content

Commit 27c47ec

Browse files
committed
docs: modify README
1 parent 5c27ef0 commit 27c47ec

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,11 @@ The plugin collects the following global and namespace-specific information:
1313
- helm deployments
1414
- `nginx -T` output from the NIC pods
1515

16+
The plugin DOES NOT collect secrets or coredums.
17+
1618
## Installation
1719

20+
### Building from source
1821
Clone the repo and run `make install`. This will build the binary and copy it on `/usr/local/bin/`.
1922

2023
Verify that the plugin is properly found by `kubectl`:
@@ -26,12 +29,25 @@ The following compatible plugins are available:
2629
/usr/local/bin/kubectl-nic-supportpkg
2730
```
2831

32+
### Downloading the binary
33+
34+
Navigate to the [releases](https://github.com/nginxinc/nginx-supportpkg-for-k8s/releases) section and download the asset for your operating system and architecture from the most recent version.
35+
36+
Decompress the tarball and copy the binary somewhere in your `$PATH`. Make sure it is recognized by `kubectl`:
37+
38+
```
39+
$ kubectl plugin list
40+
The following compatible plugins are available:
41+
42+
/path/to/plugin/kubectl-nic-supportpkg
43+
```
44+
2945
## Usage
3046

31-
The plugin is invoked via `kubectl nic supportpkg` and has only one required flag, `-n` or `--namespace`:
47+
The plugin is invoked via `kubectl nic-supportpkg` and has only one required flag, `-n` or `--namespace`:
3248

3349
```
34-
$ kubectl nic supportpkg -n default -n nginx-ingress-0
50+
$ kubectl nic-supportpkg -n default -n nginx-ingress-0
3551
Running job pod-list... OK
3652
Running job collect-pods-logs... OK
3753
Running job events-list... OK

0 commit comments

Comments
 (0)