Skip to content

Commit

Permalink
README updates (#264)
Browse files Browse the repository at this point in the history
Adds minimum Ansible version required at the top of the README.
Removes Ansible < 1.9 instructions, as we don't support these Ansible
versions in the current version of the role.
Adds missing "& v7" in some instructions.
  • Loading branch information
KSerrania authored Mar 16, 2020
1 parent 62361a9 commit 076c4ff
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ The version `4` of this role installs the Datadog Agent version 7 by default.

Supports most Debian and RHEL-based Linux distributions, and Windows.

Requires Ansible version `2.6` or higher.

- [Installation](#installation)
- [Role Variables](#role-variables)
- [Role upgrade from v3 to v4](#role-upgrade-from-v3-to-v4)
Expand Down Expand Up @@ -167,17 +169,17 @@ To define 2 instances for the `process` check use the configuration below:
init_config:
instances:
- name: ssh
search_string: ['ssh', 'sshd' ]
search_string: ['ssh', 'sshd']
- name: syslog
search_string: ['rsyslog' ]
search_string: ['rsyslog']
cpu_check_interval: 0.2
exact_match: true
ignore_denied_access: true
```

This creates the corresponding configuration files:

* For Agent v6: `/etc/datadog-agent/conf.d/process.d/conf.yaml`
* For Agent v6 & v7: `/etc/datadog-agent/conf.d/process.d/conf.yaml`
* For Agent v5: `/etc/dd-agent/conf.d/process.yaml`

### Custom Check
Expand All @@ -194,7 +196,7 @@ To configure a custom check use the configuration below:

This creates the corresponding configuration files:

* For Agent v6: `/etc/datadog-agent/conf.d/my_custom_check.d/conf.yaml`
* For Agent v6 & v7: `/etc/datadog-agent/conf.d/my_custom_check.d/conf.yaml`
* For Agent v5: `/etc/dd-agent/conf.d/my_custom_check.yaml`

### Autodiscovery Check
Expand Down Expand Up @@ -402,7 +404,7 @@ Alternatively, if your playbook **only runs on Windows hosts**, you can do the f

## APM

To enable APM with Agent v6 use the following configuration:
To enable APM with Agent v6 and v7 use the following configuration:

```yaml
datadog_config:
Expand Down Expand Up @@ -491,13 +493,13 @@ On Debian Stretch, the `apt_key` module that the role uses requires an additiona
- hosts: all
pre_tasks:
- name: Debian Stretch requires dirmngr package to be installed in order to use apt_key
become: yes # On Ansible < 1.9, use `sudo: yes` instead of `become: yes`
become: yes
apt:
name: dirmngr
state: present
roles:
- { role: datadog.datadog, become: yes, datadog_api_key: "mykey" } # On Ansible < 1.9, use `sudo: yes` instead of `become: yes`
- { role: datadog.datadog, become: yes, datadog_api_key: "mykey" }
```

### Datadog Agent 6.14 for Windows
Expand Down

0 comments on commit 076c4ff

Please sign in to comment.