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

Document the json-automate reporter

Browse source 
Signed-off-by: Clinton Wolfe <clintoncwolfe@gmail.com>
This commit is contained in:
Clinton Wolfe 2021-02-15 18:45:17 -05:00
parent 5f07181a00
commit f6af8b0da6
1 changed files with 10 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs-chef-io/content/inspec/reporters.md
View file

@ -165,7 +165,7 @@ Specifies the full path to the location of a JavaScript file that will be read a
## Automate Reporter
The `automate` reporter type is a special reporter used with [Chef Automate](https://automate.chef.io/). To use this reporter you must pass in the correct configuration via a json config `--config`.
The `automate` reporter type is a special reporter used with [Chef Automate](https://automate.chef.io/). It communicates over the network to send its results to Automate. To use this reporter you must pass in the correct configuration via a json config `--config`.
Example config:
@ -218,3 +218,12 @@ environment where a `chef_guid` or `node_uuid` is already known to Chef InSpec.
#### environment
This will set the environment metadata for Automate.
## Json-Automate Reporter
The `json-automate` reporter is a special reporter that prepares the data format used by the Automate reporter. `json-automate` does not communicate on the network; rather it simply produces the JSON report format that Automate would be consuming. Notably, the report is based on the `json` reporter, with the following modifications:
* Controls that appear in child profiles are de-duplicated by ID, merging up into the parent profile.
* Child profiles are deleted, flattening the report.
The `json-automate` reporter is primarily used for internal needs, but some users may find it useful if they wish for a JSON based reporter that merges controls.