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.

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

Use a real check in example #770

Merged
merged 1 commit into from
May 14, 2024
Merged
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/configuring-kubelinter.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,12 +103,12 @@ example,

To ignore violations for specific objects, users can add an annotation with the key
`ignore-check.kube-linter.io/<check-name>`. We strongly encourage adding an explanation as the value for the annotation.
For example, to ignore a check named "privileged" for a specific deployment, you can add an annotation like that:
For example, to ignore a check named "privileged-container" for a specific deployment, you can add an annotation like that:

```yaml
metadata:
annotations:
ignore-check.kube-linter.io/privileged: "This deployment needs to run as privileged because it needs kernel access"
ignore-check.kube-linter.io/privileged-container: "This deployment needs to run as privileged because it needs kernel access"
```

To ignore _all_ checks for a specific object, you can use the special annotation key `kube-linter.io/ignore-all`.
Expand Down
Loading