Address feedbacks in the README.
MODIFY
.kitchen.docker.yml
.kitchen.docker.yml
@@ -11,7 +11,7 @@ platforms:
# - name: ubuntu-12.04
- name: centos-6.6
- name: centos-7.7
- - name: debian-7.7
+ - name: debian-8.11
suites:
- name: dd-agent-handler

MODIFY
README.md
README.md
@@ -18,12 +18,10 @@ Chef recipes to deploy Datadog's components and configuration automatically.
This cookbook includes support for:
-* Datadog Agent version 6.0 and up: please refer to
-the [dedicated section](#agent-v6) and the [inline docs](https://github.com/DataDog/chef-datadog/blob/v3.0.0/attributes/default.rb#L42-L76)
-for more details on how to use it
+* Datadog Agent version 6.x
* Datadog Agent version 5.x
-**Log collection is now available with Agent v6, please refer to the [inline docs](https://github.com/DataDog/chef-datadog/blob/v2.15.0/attributes/default.rb#L383-L388) to enable it.**
+**Log collection is available with Agent v6, please refer to the [inline docs](https://github.com/DataDog/chef-datadog/blob/v3.0.0/attributes/default.rb#L401-L406) to enable it.**
*Note: This README may refer to features that are not released yet. Please check the README of the
git tag/the gem version you're using for your version's documentation*
@@ -164,7 +162,7 @@ This example enables the ElasticSearch integration by using the `datadog_monitor
Note that the Agent installation needs to be earlier in the run list.
-```ruby
+```
include_recipe 'datadog::dd-agent'
datadog_monitor 'elastic'
@@ -175,14 +173,6 @@ end
See `recipes/` for many examples using the `datadog_monitor` resource.
-Cookbook history
-================
-
- - `>= 3.0.0`: the cookbook supports installing either Agent v5 or v6, defaulting to Agent v6.
- - `>= 2.15.0`: add support to install either Agent v5 or Agent v6 on Windows, defaulting to Agent v5.
- - `>= 2.14.0`: the cookbook supports installing either Agent v5 or Agent v6 on Linux, defaulting to Agent v5.
- - `< 2.14.0`: the cookbook only supports Agent v5.
-
Usage
=====
@@ -202,6 +192,38 @@ Please review the [attributes/default.rb](https://github.com/DataDog/chef-datado
For general information on the Datadog Agent v6, please refer to the [datadog-agent](https://github.com/DataDog/datadog-agent/) repo.
+#### Windows Agent v6 installation
+
+Starting with version `>= 6.11`, the Windows Agent v6 must be installed with datadog
+cookbook version `>= 2.18.0`.
+
+This is due to the Agent v6 running with an unprivileged user on Windows
+since 6.11. However, prior to 2.18.0, the datadog cookbook was enforcing
+Administrators privileges to the Datadog Agent directories and files.
+
+#### Extra configuration
+
+Should you wish to add additional elements to the Agent v6 configuration file
+(typically `datadog.yaml`) that are not directly available
+as attributes of the cookbook, you may use the `node['datadog']['extra_config']`
+attribute. This attribute is a hash and will be marshaled into the configuration
+file accordingly.
+
+E.g.
+
+ ```
+ default_attributes(
+ 'datadog' => {
+ 'extra_config' => {
+ 'secret_backend_command' => '/sbin/local-secrets'
+ }
+ }
+ )
+ ```
+
+This example will set the field `secret_backend_command` in the configuration
+file `datadog.yaml`.
+
### Agent v5
Since `3.0.0`, the cookbook defaults installing Agent v6. You can still setup the Agent v5 by setting `node['datadog']['agent6']` to false.
@@ -225,7 +247,7 @@ To upgrade from an already installed Agent v5 to Agent v6, you'll have to set th
'datadog' => {
'agent6' => true,
'agent6_version' => '1:6.10.0-1', # optional but recommended
- 'agent6_package_action' => 'upgrade',
+ 'agent6_package_action' => 'install',
}
)
```
@@ -236,7 +258,7 @@ Note that there are Agent v6 counterparts to several well known Agent v5 attribu
You will need to indicate that you want to setup an Agent v5 instead of v6, pin the Agent v5 version that you want to install and allow downgrade:
-```ruby
+```
default_attributes(
'datadog' => {
'agent6' => false,
@@ -246,38 +268,6 @@ You will need to indicate that you want to setup an Agent v5 instead of v6, pin
)
```
-#### Windows Agent v6 installation
-
-Starting with version `>= 6.11`, the Windows Agent v6 must be installed with datadog
-cookbook version `>= 2.18.0`.
-
-This is due to the Agent v6 running with an unprivileged user on Windows
-since 6.11. However, prior to 2.18.0, the datadog cookbook was enforcing
-Administrators privileges to the Datadog Agent directories and files.
-
-### Extra configuration
-
-Should you wish to add additional elements to the Agent v6 configuration file
-(typically `datadog.yaml`) that are not directly available
-as attributes of the cookbook, you may use the `node['datadog']['extra_config']`
-attribute. This attribute is a hash and will be marshaled into the configuration
-file accordingly.
-
-E.g.
-
- ```
- default_attributes(
- 'datadog' => {
- 'extra_config' => {
- 'secret_backend_command' => '/sbin/local-secrets'
- }
- }
- )
- ```
-
-This example will set the field `secret_backend_command` in the configuration
-file `datadog.yaml`.
-
### Instructions
1. Add this cookbook to your Chef Server, either by installing with knife or by adding it to your Berksfile:

Address feedbacks in the README.