diff --git a/docs-chef-io/content/inspec/reporters.md b/docs-chef-io/content/inspec/reporters.md index 714fa240f..db3434c91 100644 --- a/docs-chef-io/content/inspec/reporters.md +++ b/docs-chef-io/content/inspec/reporters.md @@ -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.