diff --git a/roles/ipmi_exporter/README.md b/roles/ipmi_exporter/README.md index 89691b4..b22a041 100644 --- a/roles/ipmi_exporter/README.md +++ b/roles/ipmi_exporter/README.md @@ -6,13 +6,19 @@ This Ansible role installs ipmi_exporter on target host. This is a Prometheus ex Requirements ------------ -By default, the exporter relies on tools from the FreeIPMI suite for the actual IPMI implementation. +Target node: + +- `tar` +- `gzip` +- `freeipmi` Role Variables -------------- -Configuration files must have names ```web_conf.yaml``` and ```ipmi_local.conf```. If ipmi_exp_source_dir is specified, the role searches for ```web_conf.yaml``` and ```ipmi_local.conf``` in that directory and copy to target host in ```ipmi_exp_config_dir```. If the source directory is not specified, the role skips this step. In ipmi_local.conf user can describe what modules to use for metric collection. +Configuration files must have names `web_conf.yaml` and `ipmi_local.conf`. If ipmi_exp_source_dir is specified, the role searches for `web_conf.yaml` and `ipmi_local.conf` in that directory and copy to target host in `ipmi_exp_config_dir`. If the source directory is not specified, the role skips this step. In ipmi_local.conf user can describe what modules to use for metric collection. -ipmi_up{collector=""} is 1 if the data for this collector could successfully be retrieved from the remote host, 0 otherwise. The following collectors are available and can be enabled or disabled in the config: +ipmi_up{collector=""} is 1 if the data for this collector could successfully be retrieved from the remote host, 0 otherwise. + +The following collectors are available and can be enabled or disabled in the config: - ipmi: collects IPMI sensor data. If it fails, sensor metrics (see below) will not be available - dcmi: collects DCMI data, currently only power consumption. If it fails, power consumption metrics (see below) will not be available - bmc: collects BMC details. If it fails, BMC info metrics (see below) will not be available diff --git a/roles/node_exporter/README.md b/roles/node_exporter/README.md index 2ca20cf..8d02e4e 100644 --- a/roles/node_exporter/README.md +++ b/roles/node_exporter/README.md @@ -6,12 +6,16 @@ Deploy `prometheus/node_exporter` binary as a systemd unit. Requirements ------------ -None +Target node: + +- `tar` +- `gzip` + Role Variables -------------- -`node_exporter_bin_path`: where to install the binary (default: `/usr/bin`). +- `node_exporter_bin_path`: where to install the binary (default: `/usr/bin`). Dependencies ------------ diff --git a/roles/prometheus/README.md b/roles/prometheus/README.md index 49e0571..ba48457 100644 --- a/roles/prometheus/README.md +++ b/roles/prometheus/README.md @@ -10,7 +10,10 @@ Prometheus configuration files and rules should be placed in separate directorie Requirements ------------ -None +Target node: + +- `tar` +- `gzip` Role Variables --------------