From abfc38d6725f62df7ae4e9c8df562913e9864a35 Mon Sep 17 00:00:00 2001 From: Florent Delannoy Date: Thu, 21 Mar 2019 15:05:20 +0000 Subject: [PATCH] Update documentation after review --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 230a550..a687e0e 100644 --- a/README.md +++ b/README.md @@ -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` ) \ No newline at end of file +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` )