https://github.com/paulfantom/ansible-rpi-exporter

raspberry pi prometheus metrics exporter
https://github.com/paulfantom/ansible-rpi-exporter

Last synced: 4 days ago
JSON representation

raspberry pi prometheus metrics exporter

• Host: GitHub
• URL: https://github.com/paulfantom/ansible-rpi-exporter
• Owner: paulfantom
• License: mit
• Created: 2019-12-08T19:24:55.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2019-12-13T23:58:22.000Z (about 5 years ago)
• Last Synced: 2024-11-01T09:29:20.643Z (about 2 months ago)
• Language: Shell
• Size: 21.5 KB
• Stars: 1
• Watchers: 3
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Ansible Role: rpi_exporter

[![Build Status](https://travis-ci.com/paulfantom/ansible-rpi-exporter.svg?branch=master)](https://travis-ci.com/paulfantom/ansible-rpi-exporter)

[![License](https://img.shields.io/badge/license-MIT%20License-brightgreen.svg)](https://opensource.org/licenses/MIT)

[![Ansible Role](https://img.shields.io/badge/ansible%20role-paulfantom.rpi_exporter-blue.svg)](https://galaxy.ansible.com/paulfantom/rpi_exporter/)

[![GitHub tag](https://img.shields.io/github/tag/paulfantom/ansible-rpi-exporter.svg)](https://github.com/paulfantom/ansible-rpi-exporter/tags)

## Description

Deploy [rpi-exporter](https://github.com/lukasmalkmus/rpi_exporter) using ansible.

## Requirements

- Ansible >= 2.7 (It might work on previous versions, but we cannot guarantee it)

## Role Variables

All variables which can be overridden are stored in [defaults/main.yml](defaults/main.yml) file as well as in table below.

| Name           | Default Value | Description                        |

| -------------- | ------------- | -----------------------------------|

| `rpi_exporter_version` | 0.6.0 | rpi-exporter packaged version. Also accepts `latest` as parameter. | 

| `rpi_exporter_web_listen_address` | "0.0.0.0:9243" | Address on which rpi_exporter will listen |

| `rpi_exporter_system_group` | "rpi-exporter" | System group used to run rpi-exporter |

| `rpi_exporter_system_user` | "rpi-exporter" | System user used to run rpi-exporter |

## Example

### Playbook

Use it in a playbook as follows:

```yaml

- hosts: all

  roles:

    - paulfantom.rpi_exporter

```

## Local Testing

The preferred way of locally testing the role is to use Docker and [molecule](https://github.com/metacloud/molecule) (v2.x). You will have to install Docker on your system. See "Get started" for a Docker package suitable to for your system.

We are using tox to simplify process of testing on multiple ansible versions. To install tox execute:

```sh

pip3 install tox

```

To run tests on all ansible versions (WARNING: this can take some time)

```sh

tox

```

To run a custom molecule command on custom environment with only default test scenario:

```sh

tox -e py35-ansible28 -- molecule test -s default

```

For more information about molecule go to their [docs](http://molecule.readthedocs.io/en/latest/).

If you would like to run tests on remote docker host just specify `DOCKER_HOST` variable before running tox tests.

## Travis CI

Combining molecule and travis CI allows us to test how new PRs will behave when used with multiple ansible versions and multiple operating systems. This also allows use to create test scenarios for different role configurations. As a result we have a quite large test matrix which will take more time than local testing, so please be patient.

## Contributing

See [contributor guideline](CONTRIBUTING.md).

## License

This project is licensed under MIT License. See [LICENSE](/LICENSE) for more details.