summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAdam Leff <adam@leff.co>2016-06-08 16:48:08 -0400
committerAdam Leff <adam@leff.co>2016-06-08 16:48:08 -0400
commit8fce576d82ea7d1e0e42d7361cac895cd7d16616 (patch)
tree8aa66052a1ecc6f61a25fcf5ebdbfeaf5739fecb
parentb323f61c7448e12621d130ae68492e23284a8e48 (diff)
downloadchef-8fce576d82ea7d1e0e42d7361cac895cd7d16616.tar.gz
added Data Collector info to the release notes [ci skip]adamleff/release_notes
-rw-r--r--RELEASE_NOTES.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
index fddcc0c7bd..6c46de805d 100644
--- a/RELEASE_NOTES.md
+++ b/RELEASE_NOTES.md
@@ -10,3 +10,15 @@ Please see `https://docs.chef.io/release/<major>-<minor>/release_notes.html` for
Also introduced is a new configuration setting - `exit_status`.
By default in this release, `exit_status` is `nil` and the default behavior will be to warn on the use of deprecated and non-standard exit codes. `exit_status` can be set to `:enabled`, which will force chef-client to exit with then RFC defined exit codes and any non-standard exit statuses will be converted to `1` or GENERIC_FAILURE. `exit_status` can also be set to `:disabled` which preserves the old behavior of non-standardized exit status and skips the deprecation warnings.
+
+## New Data Collector functionality for run statistics
+
+The Data Collector feature is new to Chef 12.11 and is detailed in [Chef RFC 077](https://github.com/chef/chef-rfc/blob/master/rfc077-mode-agnostic-data-collection.md). It provides a unified method for sharing statistics about your Chef runs in a webhook-like manner. The Data Collector supports Chef in all its modes: Chef Client, Chef Solo (commonly referred to as "Chef Client Local Mode"), and Chef Solo legacy mode.
+
+To enable the Data Collector, specify the following settings in your client configuration file:
+
+ * `data_collector.server_url`: Required. The URL to which the Chef Client will POST the Data Collector messages
+ * `data_collector.token`: Optional. An token which will be sent in a `x-data-collector-token` HTTP header which can be used to authenticate the message.
+ * `data_collector.mode`: The Chef mode in which the Data Collector should run. For example, this allows you to only enable Data Collector in Chef Solo but not Chef Client. Available options are `:solo`, `:client`, or `:both`. Default is `:both`.
+ * `data_collector.raise_on_failure`: If enabled, Chef will raise an exception and fail to run if the Data Collector cannot be reached at the start of the Chef run. Defaults to `false`.
+ * `data_collector.organization`: Optional. In Solo mode, the `organization` field in the messages will be set to this value. Default is `chef_solo`. This field does not apply to Chef Client mode.