Skip to content

Commit 17c7dc6

Browse files
committed
docs: update install section
Signed-off-by: Tomasz Janiszewski <[email protected]>
1 parent 67d89dd commit 17c7dc6

File tree

2 files changed

+35
-10
lines changed

2 files changed

+35
-10
lines changed

README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Visit https://docs.kubelinter.io for detailed documentation on installing, using
1818

1919
## Installing KubeLinter
2020

21+
Kube-linter binaries could be found here: https://github.com/stackrox/kube-linter/releases/latest
22+
2123
### Using Go
2224

2325
To install using [Go](https://golang.org/), run the following command:
@@ -36,7 +38,20 @@ To install using Homebrew or LinuxBrew, run the following command:
3638
brew install kube-linter
3739
```
3840

39-
### Building from source
41+
### Using nix-shell
42+
43+
```
44+
nix-shell -p kube-linter
45+
```
46+
47+
### Using docker
48+
49+
```
50+
docker pull stackrox/kube-linter:v0.6.8
51+
```
52+
53+
54+
## Development
4055

4156
### Prerequisites
4257
- Make sure that you have [installed Go](https://golang.org/doc/install) prior to building from source.

docs/README.md

+19-9
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ for resolving any potential issues and returns a non-zero exit code.
3030
To install by using [Go](https://golang.org/), run the following command:
3131

3232
```bash
33-
GO111MODULE=on go install golang.stackrox.io/kube-linter/cmd/kube-linter
33+
go install golang.stackrox.io/kube-linter/cmd/kube-linter
3434
```
3535
Otherwise, download the latest binary from
3636
[Releases](https://github.com/stackrox/kube-linter/releases) and add it to your
@@ -45,11 +45,18 @@ run the following command:
4545
brew install kube-linter
4646
```
4747

48+
### Using nix-shell
49+
To install by using [nix](https://nixos.org/) on macOS, Linux, and [Windows Subsystem for Linux (WSL)](https://docs.microsoft.com/en-us/windows/wsl/about),
50+
run the following command:
51+
```bash
52+
nix-shell -p kube-linter
53+
```
54+
4855
### Using Docker
4956

5057
1. Get the latest KubeLinter Docker image:
5158
```bash
52-
docker pull stackrox/kube-linter:0.1.4
59+
docker pull stackrox/kube-linter:v0.6.8
5360
```
5461
> [!NOTE] While we provide the `:latest` tag for convenience and ease of experimentation,
5562
> we recommend using a tag corresponding to a specific release
@@ -79,7 +86,10 @@ The KubeLinter Github Action accepts the following inputs:
7986
|:--|:--|
8087
|`directory`|(Mandatory) A directory path that contains the Kubernetes YAML files or `Chart.yaml` file.|
8188
|`config`|(Optional) A path to your custom [KubeLinter configuration file](configuring-kubelinter.md).
82-
## Building from source
89+
90+
## Development
91+
92+
### Building from source
8393

8494
> [!NOTE] Before you build, make sure that you have [installed Go](https://golang.org/doc/install).
8595

@@ -173,10 +183,10 @@ COSIGN_EXPERIMENTAL=1 cosign verify $IMAGE_NAME
173183
> **Security issue**
174184
> - The container in this pod is not running as a read-only file system,
175185
> allowing it to write to the root filesystem.
176-
>
186+
>
177187
> **Production readiness issue**
178188
> - The configuration doesn't specify the container's CPU limits,
179-
> allowing it to consume excessive CPU.
189+
> allowing it to consume excessive CPU.
180190
> - The configuration doesn't specify the container's memory limits,
181191
> allowing it to consume excessive memory.
182192

@@ -189,9 +199,9 @@ COSIGN_EXPERIMENTAL=1 cosign verify $IMAGE_NAME
189199
pod.yaml: (object: <no namespace>/security-context-demo /v1, Kind=Pod) container "sec-ctx-demo" does not have a read-only root file system (check: no-read-only-root-fs, remediation: Set readOnlyRootFilesystem to true in your container's securityContext.)
190200

191201
pod.yaml: (object: <no namespace>/security-context-demo /v1, Kind=Pod) container "sec-ctx-demo" has cpu limit 0 (check: unset-cpu-requirements, remediation: Set your container's CPU requests and limits depending on its requirements. See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits for more details.)
192-
202+
193203
pod.yaml: (object: <no namespace>/security-context-demo /v1, Kind=Pod) container "sec-ctx-demo" has memory limit 0 (check: unset-memory-requirements, remediation: Set your container's memory requests and limits depending on its requirements. See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits for more details.)
194-
204+
195205
Error: found 3 lint errors
196206
```
197207
@@ -217,7 +227,7 @@ chart:
217227
helm-chart-sample/helm-chart-sample/templates/tests/test-connection.yaml: (object: <no namespace>/test-release-helm-chart-sample-test-connection /v1, Kind=Pod) container "wget" is not set to runAsNonRoot (check: run-as-non-root, remediation: Set runAsUser to a non-zero number, and runAsNonRoot to true, in your pod or container securityContext. See https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ for more details.)
218228
219229
helm-chart-sample/helm-chart-sample/templates/tests/test-connection.yaml: (object: <no namespace>/test-release-helm-chart-sample-test-connection /v1, Kind=Pod) container "wget" has cpu request 0 (check: unset-cpu-requirements, remediation: Set your container's CPU requests and limits depending on its requirements. See https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits for more details.)
220-
230+
221231
...
222232
223233
Error: found 12 lint errors
@@ -240,6 +250,6 @@ To contribute, see the [contributing guide](https://github.com/stackrox/kube-lin
240250
> [!ATTENTION]
241251
> Our [code of conduct](https://github.com/stackrox/kube-linter/blob/main/CODE_OF_CONDUCT.md) governs all participation in the KubeLinter community.
242252
243-
# License
253+
# License
244254

245255
KubeLinter is licensed under the [Apache License 2.0](https://github.com/stackrox/kube-linter/blob/main/LICENSE).

0 commit comments

Comments
 (0)