From 1b4905097480ee7ec02cf3589510cec0610555ec Mon Sep 17 00:00:00 2001 From: Liz Rice Date: Tue, 15 Oct 2019 15:04:18 +0100 Subject: [PATCH] docs: Clarify the meaning of WARN state (#430) * docs: Clarify the meaning of WARN state * Update README.md --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 4e97da2..d5cc041 100644 --- a/README.md +++ b/README.md @@ -170,9 +170,15 @@ There are three output states - [WARN] means this test needs further attention, for example it is a test that needs to be run manually - [INFO] is informational output that needs no further action. +Note: +- If the test is Manual, this always generates WARN (because the user has to run it manually) +- If the test is Scored, and kube-bench was unable to run the test, this generates FAIL (because the test has not been passed, and as a Scored test, if it doesn't pass then it must be considered a failure). +- If the test is Not Scored, and kube-bench was unable to run the test, this generates WARN. +- If the test is Scored, type is empty, and there are no `test_items` present, it generates a WARN. + ## Configuration -Kubernetes config and binary file locations and names can vary from installation to installation, so these are configurable in the `cfg/config.yaml` file. +Kubernetes configuration and binary file locations and names can vary from installation to installation, so these are configurable in the `cfg/config.yaml` file. Any settings in the version-specific config file `cfg//config.yaml` take precedence over settings in the main `cfg/config.yaml` file.