Added first draft of waiver doco.

Signed-off-by: Ryan Davis <zenspider@chef.io>
This commit is contained in:
Ryan Davis 2019-09-25 15:37:39 -07:00 committed by Mary Jinglewski
parent df93b99277
commit 6e220d0310

54
docs/waivers.md Normal file
View file

@ -0,0 +1,54 @@
# Waivers (Beta)
Waivers is a mechanism to mark controls as "waived" for various reasons
and to control the running and/or reporting of those controls. It
takes a YAML input file that identifies which controls are waived,
(optionally) whether they should be skipped from running, a description of why it
is waived, and (optionally) an expiration date for the waiver.
NOTE: This mechanism is currently in beta and is ultimately meant to be
ingested and maintained by Chef Automate UI.
## Usage
To use waivers, you must have a correctly formatted input file and
invoke `inspec exec` with `--waiver-file [path]`. Currentlty, waiver results are
only reported with the JSON reporter type, so you must also have
`--reporter json`. This may change in the future.
```
% inspec exec --waiver-file waivers.yaml --reporter json -- path/to/profile
```
## File Format
Waiver files are [input files](inputs.html "inputs files") with a
specific format:
```yaml
control_id:
expiration_date: YYYY-MM-DD
skip: true
justification: "reason for waiving this control"
```
+ `expiration_date` is optional. Absence means the waiver is permanent.
+ `skip` is optional. Absence means the control will run and be
reported, but failures in it won't make the overall run fail.
+ `justification` can be any text you want and might include a reason
as well as who signed off on the waiver.
### Example:
```yaml
waiver_control_1_2_3:
expiry_date: 2019-09-15
justification: Not needed until Q3. @secteam
xccdf_org.cisecurity.benchmarks_rule_1.1.1.4_Ensure_mounting_of_hfs_filesystems_is_disabled:
expiry_date: 2020-03-01
justification: "This might be a bug in the test. @qateam"
skip_run: true
# ... and so on ...
```