ansible-scaphandre/README.md
2024-03-01 11:00:17 +01:00

86 lines
1.5 KiB
Markdown

<p align="center">
<img src="https://github.com/hubblo-org/scaphandre/raw/main/docs_src/scaphandre.cleaned.png" width="200">
</p>
<h1 align="center">
Scaphandre
</h1>
<h3 align="center">
Your tech stack doesn't need so much energy ⚡
</h3>
This role installs [scaphandre](https://github.com/hubblo-org/scaphandre) and configures it's exporters.
Requirements
------------
The role in itself does not have other requirements than Scaphandre. It's written with Debian Bookworm in mind.
Role Variables
--------------
```
scaphandre_arch: "deb12-arm64"
```
The architecture targeted.
```
scaphandre_version: "1.0.0"
```
Scaphandre's version.
```
scaphandre_home_dir: "/opt/scaphandre"
```
The home directory for the scaphandre user.
```
scaphandre_exporter: "prometheus"
```
Which exporter should we use. You can choose between :
- `prometheus`
- `prometheus-push`
- `json`
- `riemann`
- `warp10`
scaphandre_exporter_web_listen_address: "localhost"
scaphandre_exporter_web_listen_port: "8085"
scaphandre_web_telemetry_path: "power-metrics"
```
scaphandre_web_telemetry_path: "/power-metris"
```
On which path will Scaphandre expose it's metrics.
Dependencies
------------
N/A
Example Playbook
----------------
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
- hosts: servers
roles:
- role: hubblo.scaphandre
License
-------
AGPLv3
Author Information
------------------
Written by [N07070](https://n07070.xyz).