1
0
mirror of https://github.com/aquasecurity/kube-bench.git synced 2025-01-18 19:51:05 +00:00

Update documentation after review

This commit is contained in:
Florent Delannoy 2019-03-21 15:05:20 +00:00
parent 4d3144ca21
commit abfc38d672

View File

@ -149,7 +149,7 @@ These groups are further organized under `controls` which can be of the type `ma
## Tests
Tests are the items we actually look for to determine if a check is successful or not. Checks can have multiple tests, which must all be successful for the check to pass.
The syntax for tests operating on a flag:
The syntax for tests:
```
tests:
- flag:
@ -160,7 +160,8 @@ tests:
...
```
If using a JSON config file, the syntax is:
You can also define jsonpath and yamlpath tests using the following syntax:
```
tests:
- jsonpath:
@ -171,7 +172,6 @@ tests:
...
```
And for a YAML config file:
```
tests:
- yamlpath:
@ -211,4 +211,4 @@ Next you'll have to build the kube-bench docker image using `make build-docker`,
Finally we can use the `make kind-run` target to run the current version of kube-bench in the cluster and follow the logs of pods created. (Ctrl+C to exit)
Everytime you want to test a change, you'll need to rebuild the docker image and push it to cluster before running it again. ( `make build-docker kind-push kind-run` )
Everytime you want to test a change, you'll need to rebuild the docker image and push it to cluster before running it again. ( `make build-docker kind-push kind-run` )