Playbooks/Roles used to deploy a pair of Telegraf agents to a node (one for metrics gathering and reporting, another for gathering and reporting logs)
To install a Telegraf agents using the provision-telegraf.yml playbook in this repository, first clone the contents of this repository to a local directory using a command like the following:
$ git clone --recursive https://github.com/Datanexus/dn-telegrafThat command will pull down the repository and it's dependencies. Currently this playbook's only dependencies are on the common-roles and common-utils submodules in this repository. The first provides a set of common roles that are reused across the DataNexus playbooks, while the second provides a similar set of common utilities, including a pair of dynamic inventory scripts that can be used to control deployments made using this playbook in AWS and OpenStack environments.
The only other requirements for using the playbook in this repository are a relatively recent (v2.x) release of Ansible. The easiest way to obtain a recent relese if Ansible is via a pip install, which requires that Python and pip are both installed locally. We have performed all of our testing using a recent (2.7.x) version of Python (Python 2); your mileage may vary if you attempt to run the playbook or the attached dynamic inventory scripts under a newer (v3.x) release of Python (Python 3).
The provision-telegraf.yml file at the top-level of this repository supports the deployment of a pair of agents to each target node, one for gathering and reporting metrics and the other for gathering and reporting logs. The process of deploying these Telegraf agents will vary, depending on whether you are managing your inventory dynamically or statically (more on this topic here) as well as where you are downloading any additional packages from that may have been requested by the user as part of a playbook run.
We discuss the various deployment scenarios supported by this playbook in this document and discuss how the Vagrantfile in this repository can be used to deploy Telegraf agents to a set of VMs hosted locally in VirtualBox here.
This repository includes a default set of parameters defined in the vars/telegraf.yml file that make it possible to perform deployments of Telegraf agents to nodes out of the box with few, if any, changes necessary. If you are not happy with the default configuration defined in that file, there are a number of ways that you can customize the configuration used for your deployment, and which method you use is entirely up to you:
- You can edit the vars/telegraf.yml file to modify the default values that are defined in that file or define additional configuration parameters
- You can override the values defined in that file or define additional configuration parameters by passing the values for those parameters into your
ansible-playbookrun on the command-line as extra variables - You can setup a local variables file on the local filesystem of the Ansible host that contains the values for the parameters you wish to set or customize, then pass the location of that file into your
ansible-playbookcommand as an extra variable
We have provided a summary of the configuration parameters that can be set (using any of these three methods) during an ansible-playbook run here. Overall, we have found the last option to be the easiest and most flexible of those three options. This is because:
- It avoids modifying files that are being tracked under version control in the main,
dn-telegrafrepository (the first option); making such changes will, more than likely, lead to conflicts at a later date when these files are modified in the maindn-telegrafrepository in a way that is inconsistent with the values that you have set in your clone, locally. - It lets you maintain your preferred configuration for any given deployment in the form of a configuration file, which you can easily maintain (along with the configuration files used for other deployments you have made) under version control in a separate repository
- It provides a record of the configuration of any given deployment, which is in direct contrast to the second option (where the configuration parameters for any given deployment are passed in on the command-line as extra variables)
That being said, the second option may be useful for some deployment scenarios (a one-off deployment of a local test environment, for example), so it remains a viable option for some users. Overall, we would recommend against trying to maintain your preferred cluster configuration using the values defined in the vars/telegraf.yml file.
It is assumed that this playbook will be run on a recent (systemd-based) version of RHEL or CentOS (RHEL-7.x or CentOS-7.x, for example); no support is provided for other distributions (and the site.xml playbook will not run successfully). Furthermore, it is assumed that you are interested in deploying a relatively recent version of the Telegraf agent using this playbook (the default behavior of this playbook is to install the latest version available from the main InfluxDB repository as an RPM package, but this playbook also supports replacement of this version with a more recent, custom-built version of Telegraf that can be uploaded from the Ansible host during the playbook run if necessary).
It should also be noted that in order to execute the vagrant commands shown in this document locally, recent versions of Vagrant and VirtualBox will have to be installed locally. While Vagrant does support management of Virtual Machines deployed via VMware Workstation and/or Fusion with the right (commercial) drivers in place, we have only tested the Vagrantfile in this repository under VirtualBox using recent (v1.9.x) releases of Vagrant.