PMM Client

==========

This role installs and sets up the Percona PMM Client.

Requirements

---

You need Ansible version 2.5.0 or higher.

To install a stable version, use pip like this:

pip install ansible==2.6.4

You can find all platform requirements in the metadata file.

Install

---

To install the PMM Client:

ansible-galaxy install timorunge.pmm_client

Role Variables

---

Here are the variables you can use with this role, along with a short description. You can see all variables in defaults/main.yml.

# Set the version
# Type: Int
pmm_client_version: 1.14.1
# IP address and port of the PMM server:
# Type: Str
pmm_client_server_host: 172.20.0.10
# Type: Int
pmm_client_server_port: 443
# Disable basic authentication:
# Type: Bool
pmm_client_server_basic_auth: False
# Enable SSL encryption:
# Type: Bool
pmm_client_server_use_ssl: True
# Services to add or remove:
# Type: List
pmm_client_add_services:
  - linux:metrics
  - mysql:metrics
  - mongodb:metrics
pmm_client_remove_services:
  - mysql:queries
# Services to start or stop:
# Type: List
pmm_client_start_services:
  - linux:metrics
  - mysql:metrics
  - mongodb:metrics
pmm_client_stop_services:
  - mysql:queries
# Database connection details for MySQL:
# Type: Dict
pmm_client_db:
  mysql:
    host: localhost
    port: 3306
    username: root
    password: toor

Examples

---

1) Install the PMM Client without basic authentication and SSL off

- hosts: all
  become: yes
  vars:
    pmm_client_server_host: 172.20.0.10
    pmm_client_server_port: 443
    pmm_client_server_basic_auth: False
    pmm_client_server_use_ssl: False
    pmm_client_add_services:
      - linux:metrics
    pmm_client_start_services:
      - linux:metrics
  roles:
    - timorunge.pmm_client

2) Install the PMM Client with basic authentication and SSL on

- hosts: all
  become: yes
  vars:
    pmm_client_server_host: 172.20.0.10
    pmm_client_server_port: 443
    pmm_client_server_basic_auth: True
    pmm_client_server_basic_auth_username: admin
    pmm_client_server_basic_auth_password: mySecurePassword
    pmm_client_server_use_ssl: True
    pmm_client_add_services:
      - linux:metrics
    pmm_client_start_services:
      - linux:metrics
  roles:
    - timorunge.pmm_client

3) Install the PMM Client from a specified URL

- hosts: all
  become: yes
  vars:
    pmm_client_version: 1.11.0
    pmm_client_version_revision: 1
    pmm_client_use_official_repo: False
    pmm_client_debian_pkg: "https://www.percona.com/downloads/pmm/{{ pmm_client_version }}/binary/debian/{{ ansible_distribution_release }}/x86_64/pmm-client_{{ pmm_client_version }}-{{ pmm_client_version_revision }}.{{ ansible_distribution_release }}_amd64.deb"
  roles:
    - timorunge.pmm_client

4) Uninstall the PMM Client

- hosts: all
  become: yes
  vars:
    pmm_client_enabled: False
  roles:
    - timorunge.pmm_client

Testing

---

Tests are performed with Docker and docker_test_runner. The tests on Travis check for linting and syntax issues.

Dependencies

---

None

License

---

BSD

Author Information

---

• This is based on an Ansible role by Chris Sam
• Heavily modified by: Timo Runge