Skip to content

Commit e51482c

Browse files
authored
Use a real check in example (stackrox#770)
AFAICT there is no `privileged` check ATM.
1 parent 3f97963 commit e51482c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/configuring-kubelinter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,12 +103,12 @@ example,
103103

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

108108
```yaml
109109
metadata:
110110
annotations:
111-
ignore-check.kube-linter.io/privileged: "This deployment needs to run as privileged because it needs kernel access"
111+
ignore-check.kube-linter.io/privileged-container: "This deployment needs to run as privileged because it needs kernel access"
112112
```
113113

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

0 commit comments

Comments
 (0)