aboutsummaryrefslogtreecommitdiffstats
path: root/roles/prometheus/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'roles/prometheus/README.md')
-rw-r--r--roles/prometheus/README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/roles/prometheus/README.md b/roles/prometheus/README.md
new file mode 100644
index 0000000..febe029
--- /dev/null
+++ b/roles/prometheus/README.md
@@ -0,0 +1,13 @@
+# Role "prometheus"
+
+Installs and configured Prometheus on target servers.
+
+
+## Variables
+
+- `prometheus_cmdline_options` configures arguments to be added
+ to the prometheus command line, and changing it will result in
+ a restart.
+
+- `prometheus_configuration` is the prometheus configuration, serialized to
+ YAML by Ansible. If unset, the default Prometheus configuration is used.