Wavefront Ansible Role

Ansible Role to install/configure the Wavefront Proxy agent (wavefront-proxy) or Collector (telegraf) agent.

Platforms

• Amazon Linux
• CentOS
• RedHat
• Ubuntu

Role Variables

The following variables are available for override.

proxy_address=GIVE_VALID_PROXY_ADDRESS                           # Required, if collector(true)
proxy_port=2878_is_a_valid_port (default: 2878)                  # Required, if collector(true)
wavefront_api_token: GIVE_A_VALID_API_TOKEN                      # Required, if wavefront_install_proxy(true). Your API Key
instance: <wavefront_instance_name> (default: try)               # Optional. Instance name
wavefront_api_url: https://try.wavefront.com (default)           # Optional. WaveFront URL
wavefront_install_proxy=true (default: false)                    # Optional.
wavefront_install_collector=true (default: false)                # Optional.
wavefront_create_cred_file=true (default: false)                 # Optional.
telegraf_tags                                                    # Optional. Check <roles>/defaults/main.yml for more info.
telegraf_inputs                                                  # Optional. Check <roles>/defaults/main.yml for more info.

Role Tags

The following tags are supported, can be given comma separated (for ex: --tags "tag1,tag2").

--tags "check" or --tags "failfast"  # Will perform few checks/fail-fast only
--tags "prereqs"                     # Will install only prerequisite packages
--tags "install"                     # Will install on any RedHat/Debian(Ubuntu)
--tags "redhat"                      # Will install on any RedHat/CentOS only.
--tags "debian"                      # Will install on any Debian(Ubuntu) only.
--tags "proxy"                       # Will install only Wavefront Proxy agent.
--tags "collector"                   # Will install only Collector(Telegraf) agent.
--tags "configure"                   # Will install/ensure configuration of agents.

How To Install

Using ansible galaxy, best for ad-hoc command situations:

$ ansible-galaxy install wavefrontHQ.wavefront-ansible

To install into your playbook roles, use -p ROLES_PATH or --path=ROLES_PATH

$ ansible-galaxy install wavefrontHQ.wavefront-ansible -p /your/project/root/roles

Check out: Advanced Control over Role Requirements Files

Basic Setup (playbook)

Create a sample playbook (yml) file like shown below. Name it for ex: wavefront-ansible.yml:

---
# See Role's (wavefrontHQ.wavefront-ansible) README file for more info on parameters.

- hosts: all
  gather_facts: true
  remote_user: root
  become: true
  roles:
    - { role: wavefrontHQ.wavefront-ansible, wavefront_install_collector: "true", proxy_address: "localhost" }
    #- { role: wavefrontHQ.wavefront-ansible, wavefront_install_collector: "true", proxy_address: "<a_proxy_host_for_sending_data_to_wavefront_instance>" }

Examples

Go to the folder where wavefront-ansible.yml file is present, then:

1. To install Wavefront Proxy agent (wavefront-proxy) on your local machine.

$ ansible-playbook -i "`hostname`," --connection=local wavefront-ansible.yml --extra-vars "wavefront_install_proxy=true wavefront_api_token=dummy012-f223-11cf-789c-T0kenOfWFUrl"

OR

PS: <role>/parent_folder_contents/README.md file and try that way.

If OS is RedHat/CentOS, you want to install proxy agent for (https://try.wavefront.com), and have localhost mentioned in a custom inventory file, then run:

$ ansible-playbook -i inventory -l localhost wavefront-ansible.yml --extra-vars "instance=try wavefront_install_proxy=true wavefront_api_token=dummy012-f223-11cf-789c-T0kenOfWFUrl" --tags "redhat"

OR

PS: <role>/parent_folder_contents/README.md file and try that way.

If you also want to create the '~/.wavefront/credentials' file and if the OS is Debian/Ubuntu, then run:

$ ansible-playbook -i inventory -l localhost wavefront-ansible.yml --extra-vars "wavefront_create_cred_file=true wavefront_install_proxy=true wavefront_api_token=dummy012-f223-11cf-789c-T0kenOfWFUrl" --tags "debian"

2. To install Wavefront Collector agent (telegraf) on a (local machine).

$ ansible-playbook -i "`hostname`," --connection=local wavefront-ansible.yml --extra-vars "wavefront_install_collector=true proxy_address=my-valid-wavefront-proxy-server-host.com proxy_port=2878"

OR

PS: <role>/parent_folder_contents/README.md file and try that way.

If OS is Debian/Ubuntu and and have localhost mentioned in a custom inventory file, then run:

$ansible-playbook -i inventory -l localhost wavefront-ansible.yml --extra-vars "wavefront_install_collector=true proxy_address=my-valid-wavefront-proxy-server-host.com proxy_port=2878" --tags "debian"

Dependencies

For ex: If target machines are in AWS, then user should have ~/.aws/credentials file setup with required info.

[Credentials]
aws_access_key_id = RBCKHC7KKJD99SSDUMMY
aws_secret_access_key = DummYGG62CCc62+iihhgga6+45Km+tG9+T9WL5Wc

[Boto]
ec2_region_name = us-west-2
ec2_region_endpoint = ec2.us-west-2.amazonaws.com

[default]
region = us-west-2
aws_access_key_id = RBCKHC7KKJD99SSDUMMY
aws_secret_access_key = DummyGG62CCc62+iihhgga6+45Km+tG9+T9WL5Wc

MISC Info

Once Wavefront Proxy agent (wavefront-proxy) is installed/configured successfully.

1. You can see its configuration files at: /etc/wavefront/wavefront-proxy/*

2. You can find the log files at: /var/log/wavefront/wavefront-proxy/*

Once Collector(telegraf) agent is installed/configured successfully.

1. You can see its configuration files at: /etc/telegraf/* or /etc/telegraf/telegraf.d/*

2. You can fine the log files at: /var/log/telegraf/*

3. telegraf_tags variable can be passed at cmd line (or set in /defaults/main.yml) This variable if enabled, will add tags under [global_tags] section in telegraf.conf file.

4. telegraf_inputs variable can be passed at cmd line (or set in /defaults/main.yml) This variable if enabled, will create respective inputs..conf files in telegraf.d folder for any user defined inputs plugins.

Optional

1. You can create a new Dashboard (for Telegraf) on your WaveFront instance URL using: Telegarf Dashboard template JSON file available here: https://raw.githubusercontent.com/wavefrontHQ/integrations/master/telegraf/dashboards/telegraf-host.json

Installation of Ansible Galaxy role

ansible-galaxy install <role> -p <path> step will result in an error if ansible-galaxy used is coming from Python 3.x version.

Error: Failed to get data from the API server - a bytes-like object is required, not 'str'

To resolve the above issue, make sure you use ansible-galaxy which is not using Python 3.x binaries. For more info see here: http://stackoverflow.com/questions/41837789/ansible-galaxy-failing-for-init-install-failed-to-get-data-from-the-api-server

License

Apache 2.0

Author Information

Ops Team [email protected] Use github issues for bugs in this repo.