Skip to content

Commit

Permalink
Use a real check in example
Browse files Browse the repository at this point in the history
AFAICT there is no `privileged` check ATM.
  • Loading branch information
porridge authored Apr 23, 2024
1 parent dff294e commit c594c0b
Showing 1 changed file with 2 additions and 2 deletions.
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

0 comments on commit c594c0b

Please sign in to comment.