tschoonj.ansible_role_guacamole_exporter

Ansible Role: guacamole_exporter

What is ansible-guacamole-exporter?

This role helps you install and set up guacamole_exporter to gather usage statistics from a Guacamole clientless remote desktop gateway. These statistics can be accessed by a Prometheus server.

Requirements

Ansible version 2.10 or higher (It may work with older versions, but they haven’t been tested)

Role Variables

You must define the following variables.

Name	Description
`guacamole_exporter_endpoint`	The address of your Guacamole instance
`guacamole_exporter_username`	A user account with access to the REST API
`guacamole_exporter_password`	The password for the above user
`guacamole_exporter_datasource`	The datasource for REST API calls, usually an SQL database

All variables found in default/main.yml can be updated.

Name	Default Value	Description
`guacamole_exporter_version`	0.1.1	The version to install, you can also use latest
`guacamole_exporter_binary_local_dir`	""	Use local packages from your machine instead of those on GitHub
`guacamole_exporter_web_listen_address`	"0.0.0.0:9623"	The address the exporter listens on
`guacamole_exporter_web_telemetry_path`	"/metrics"	The path used to expose the metrics

Dependencies

None

How to Use

From Galaxy

To install via galaxy, run:

ansible-galaxy install tschoonj.ansible_role_guacamole_exporter

As a Git Submodule

If you want to add this role as a submodule:

git submodule add -b main https://github.com/tschoonj/ansible-role-guacamole-exporter.git roles/guacamole-exporter

To update the role later:

git submodule update --remote

Example Playbook

Here’s an example of how to use this role in a playbook:

- hosts: all
  roles:
    - role: tschoonj.ansible_role_guacamole_exporter
      vars:
        guacamole_endpoint: guacamole.example.com
        guacamole_username: admin
        guacamole_password: admin
        guacamole_datasource: mysql