Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2024-11-26 22:50:36 +00:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1713 from chef/dr/docs-impact

Browse source 
describe the value ranges of `impact`
This commit is contained in:
Christoph Hartmann 2017-04-25 21:14:28 +02:00 committed by GitHub
commit 5212ba9580
1 changed files with 4 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/dsl_inspec.md
View file

@ -44,7 +44,10 @@ where
* `'sshd-8'` is the name of the control * `'sshd-8'` is the name of the control
* `impact`, `title`, and `desc` define metadata that fully describes the importance of the control, its purpose, with a succinct and complete description * `impact`, `title`, and `desc` define metadata that fully describes the importance of the control, its purpose, with a succinct and complete description
* `impact` is an float that measures the importance of the compliance results and must be a value between `0.0` and `1.0`. * `impact` is an float that measures the importance of the compliance results and must be a value between `0.0` and `1.0`. The value ranges are:
* `0.0 to <0.4` these are controls with minor criticality
* `0.4 to <0.7` these are controls with major criticality
* `0.7 to 1.0` these are critical controls
* `tag` is optional meta-information with with key or key-value pairs * `tag` is optional meta-information with with key or key-value pairs
* `ref` is a reference to an external document * `ref` is a reference to an external document
* `describe` is a block that contains at least one test. A `control` block must contain at least one `describe` block, but may contain as many as required * `describe` is a block that contains at least one test. A `control` block must contain at least one `describe` block, but may contain as many as required