You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Removes agent6/agent5 prefixes in variable names.
- Introduces `agent_major_version` setting that replaces `agent5_enable`.
- Unifies config for Agent 5/6 repos and removes use of facter.
- Removes uses of `validate_legacy`.
- Keeps the group ownership of config files as 'dd-agent', as they come in the agent package.
- Remove `service_name` and `package_name` parameters, since there is no use in changing these.
- Import the new RPM signing key only when installing Agent 7.
- Bumps major version to 3.0.
- Removes 1.x and 2.x instructions from README: these can still be found in puppetforge selecting an older version of the module.
The current version of this Puppet module is compatible with Puppet >= 4.6.x. For users running on older versions of Puppet the legacy module, series 1.x, should support most use-cases.
21
-
22
-
The majority of users should be able to use the current version, as the Puppet versions supported in the 1.x series of the module have been EOL'd.
23
-
24
-
Some features might be back-ported if there's enough demand, but in general only maintenance is performed on the 1.x series of the module. Future feature development is performed on the newer Puppet module.
25
-
26
-
Version 2.x
27
-
-----------
28
-
29
16
## Requirements
30
17
31
-
For detailed information on compatibility, check the [module page][2] on the Puppet forge.
18
+
The current version of this Puppet module supports both Linux and Windows and is compatible with Puppet >= 4.6.x.
19
+
20
+
For detailed information on compatibility, check the [module page on Puppet Forge][2].
32
21
33
22
## Installation
34
23
@@ -46,56 +35,24 @@ class{ 'datadog_agent':
46
35
}
47
36
```
48
37
49
-
### Upgrade from the previous module version 1.x
50
-
51
-
Most of the manifests are backward compatible. However, there are important changes to the main manifest:
52
-
53
-
- By default Datadog Agent 6.x is installed.
54
-
- To use Agent 5.x in your nodes set the `agent5_enable` boolean parameter to `True`.
55
-
- Enhanced support for our APM Tracing Agent.
56
-
- Enhanced support for our Process Agent.
57
-
- Enhanced support for additional `agent6` options.
58
-
- APM Tracing and Process Agents are now opt-in options and are disabled by default.
59
-
- The main `datadog_agent` class has parameters to enable and configure the Agents easily.
60
-
- Increased granularity for apt/yum repo configuration.
61
-
- New location for Datadog Puppet reporting configuration.
38
+
### Upgrade from the previous module version 2.x
62
39
63
-
64
-
Version 1.x
65
-
-----------
66
-
67
-
## Requirements
68
-
69
-
Puppet >=2.7.x and <=4.2.x. For detailed information on compatibility, check the [module page][2] on the Puppet forge.
70
-
71
-
## Installation
72
-
73
-
Install `datadog_agent` as a module in your Puppet master's module path.
### Upgrade from previous git manual install 0.x (unreleased)
80
-
81
-
You can keep using the `datadog` module but it becomes legacy with the release of `datadog_agent` 1.0.0. Upgrade to get new features, and use the Puppet forge system which is easier for maintenance.
82
-
83
-
* Delete the Datadog module `rm -r /etc/puppet/modules/datadog`
84
-
* Install the new module from the Puppet forge `puppet module install datadog-datadog_agent`
85
-
* Update your manifests with the new module class, basically replace `datadog` by `datadog_agent`
40
+
- By default Datadog Agent 7.x is installed. To use an earlier Agent version change the setting `agent_major_version`.
41
+
-`agent5_enable` is no longer used, as it has been replaced by `agent_major_version`.
42
+
-`agent6_extra_options` has been renamed to `agent_extra_options` since it now applies to both Agent version 6 and 7.
43
+
-`agent6_log_file` has been renamed to `agent_log_file` since it now applies to both Agent version 6 and 7.
44
+
-`agent5_repo_uri` and `agent6_repo_uri` become `agent_repo_uri` for all Agent versions.
45
+
-`conf_dir` and `conf6_dir` become `conf_dir` for all Agent versions.
46
+
- The repository file created on Linux is now named `datadog` for all agent versions instead of `datadog5`/`datadog6`.
86
47
87
48
Usage
88
49
-----
89
50
90
-
The following instructions are for both Puppet module versions (1.x, 2.x).
91
-
92
-
Note: 2.x installs Agent v6 by default, whereas 1.x defaults to Agent v5.
93
-
94
-
Once the `datadog_agent` module is installed on your `puppetserver`/`puppetmaster`, follow these configuration steps:
51
+
Once the `datadog_agent` module is installed on your `puppetserver`/`puppetmaster` (or on a masterless host), follow these configuration steps:
95
52
96
-
1.Update the default class parameters with your [API key][3].
53
+
1.Find your Datadog[API key][3].
97
54
98
-
2. Specify the module on any nodes you wish to install the DataDog Agent.
55
+
2. Specify the module on any nodes you wish to install the Datadog Agent.
99
56
100
57
```
101
58
include datadog_agent
@@ -118,13 +75,8 @@ Once the `datadog_agent` module is installed on your `puppetserver`/`puppetmaste
118
75
}
119
76
```
120
77
121
-
- To support reporting, your Puppet master needs the [dogapi][4] gem installed. To install, either run the Puppet Agent on your master with this configuration or install it manually with `gem`. You might need to restart your `puppetserver` service for the freshly installed `dogapi-rb` gem to be picked up.
122
-
- On version 2.x, `puppetserver_gem` is defined as a module dependency, it is installed automatically when the module is installed.
123
-
- On version 1.x:
124
-
- If you are on Puppet Enterprise or POSS (ie. >=3.7.0), there is a soft dependency for reporting on the `puppetserver_gem` module. Install with `puppet module install puppetlabs-puppetserver_gem` - installing manually with `gem` does *not* work.
125
-
- You may install `dogapi-rb` with `gem` as the system-level Ruby is used.
126
-
- The gem provider is configurable by setting it to `puppetserver_gem` (set by default on PE/POSS (>=3.7.0)) or `gem` if on older versions of Puppet.
127
-
- For users running puppet in standalone/masterless mode you will need to set the `puppet_gem_provider` to `puppet_gem` (or `gem` depending on versions) to ensure the `dogapi-rb` is available.
78
+
- To support reporting, your Puppet master needs the [dogapi][4] gem installed. To install, either run the Puppet Agent on your master with this configuration or install it manually with `gem`. You might need to restart your `puppetserver` service for the freshly installed `dogapi` gem to be picked up.
79
+
- `puppetserver_gem` is defined as a module dependency, it is installed automatically when the module is installed.
128
80
129
81
3. Include any other integrations you want the agent to use, for example:
130
82
@@ -166,7 +118,7 @@ The field `ensure` can be either `present` (default) or `absent`, the later bein
166
118
167
119
Reporting
168
120
---------
169
-
Ensure `dogapi-rb` is available on your system as explained earlier.
121
+
Ensure the `dogapi` gem is available on your system as explained earlier.
170
122
171
123
To enable reporting of changes to the Datadog timeline, enable the report processor on your Puppet master, and enable reporting for your clients. The clients send a run report after each check-in back to the master.
|`agent_major_version`| The version of the Agent to install: either 5, 6 or 7 (default: 7). |
264
+
|`agent_version`| Lets you pin a specific minor version of the agent to install, eg: `1:7.16.0-1`. Leave empty to install the latest version (not recommended). |
313
265
|`collect_ec2_tags`| Set this to yes to have an instance's custom EC2 tags used as agent tags. |
314
266
|`collect_instance_metadata`| Set this to yes to have an instance's EC2 metadata used as agent tags. |
315
-
|`datadog_site`| The Datadog site to report to. Defaults to `datadoghq.com`, set to `datadoghq.eu` to report to the EU site. Supported since v2.4.0 of the module, and only with Agent v6+|
316
-
|`dd_url`| The Datadog intake server URL. You are unlikely to need to change this. Overrides `datadog_site`|
267
+
|`datadog_site`| The Datadog site to report to. Defaults to `datadoghq.com`, set to `datadoghq.eu` to report to the EU site (Agent versions 6 and 7 only). |
268
+
|`dd_url`| The Datadog intake server URL. You are unlikely to need to change this. Overrides `datadog_site`|
317
269
|`host`| Overrides the node's host name. |
318
270
|`local_tags`| An array of <KEY:VALUE> strings that are set as tags for the node. |
319
271
|`non_local_traffic`| Set this to allow other nodes to relay their traffic through this one. |
320
-
|`agent5_enable`| A boolean to install Agent v5 and override the Agent v6 default. |
321
272
|`apm_enabled`| A boolean to enable the APM Agent (defaults to false). |
322
273
|`apm_analyzed_spans`| A hash to add APM events for the Trace Search & Analytics tool. (defaults to undef). For example: `{ 'app\|rails.request' => 1, 'service-name\|operation-name' => 0.8 }`|
323
274
|`process_enabled`| A boolean to enable the process agent (defaults to false). |
324
275
|`scrub_args`| A boolean to enable the process cmdline scrubbing (defaults to true). |
325
276
|`custom_sensitive_words`| An array to add more words beyond the default ones used by the scrubbing feature (defaults to []). |
326
277
|`logs_enabled`| A boolean to enable the logs agent (defaults to false). |
327
278
|`container_collect_all`| A boolean to enable logs collection for all containers. |
328
-
|`agent6_extra_options`| A hash to provide additional configuration options to Agent v6. |
279
+
|`agent_extra_options`| A hash to provide additional configuration options (Agent versions 6 and 7 only).|
329
280
|`hostname_extraction_regex`| A regex used to extract the hostname captured group to report the run in Datadog instead of reporting the Puppet nodename, for example:<br>`'^(?<hostname>.*\.datadoghq\.com)(\.i-\w{8}\..*)?$'`|
330
281
331
282
##### Notes:
332
283
333
-
-`agent6_extra_options` is used to provide a fine grain control of additional Agent v6 config options. A deep merge is performed that may override options provided in the `datadog_agent` class parameters.
284
+
-`agent_extra_options` is used to provide a fine grain control of additional Agent v6/v7 config options. A deep merge is performed that may override options provided in the `datadog_agent` class parameters.
334
285
-`hostname_extraction_regex` is useful when the Puppet module and the Datadog Agent are reporting different host names for the same host in the infrastructure list.
0 commit comments