From d93ff329df75e0301d4dad00138ba778174a2d9d Mon Sep 17 00:00:00 2001 From: Ludovic Cartier Date: Wed, 26 May 2021 19:04:05 +0200 Subject: [PATCH] update doc --- README.md | 46 +++++++++++++++++++++++++++++++++++++++------- 1 file changed, 39 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 7422d7e..3c5dac8 100644 --- a/README.md +++ b/README.md @@ -12,13 +12,34 @@ It has been tested on : Role variables -------------- -| Variable | Type | Choices | Default | Comment | -|------------------------------------|---------|--------------|-------------------------------------------------------------------------------|----------------------------------------------------------------------------| +| Variable | Type | Choices | Default | Comment | +|----------------------------------------------|---------|--------------------------------------|-------------|-----------------| +| prometheus_server_enable | string | true / false | | | +| prometheus_server_version | string | | latest | | +| prometheus_server_monitor | string | | | | +| prometheus_server_global_scrape_interval | string | | 15 | | +| prometheus_server_global_evaluation_interval | string | | 15 | | +| prometheus_server_job_name | string | | prometheus | | +| prometheus_server_scrape_interval | string | | 5 | | +| prometheus_server_scrape_timeout | string | | 5 | | +| prometheus_exporter_packages | list | node / mysqld / postgresql / mongodb | | | +| prometheus_node_exporter_targets | list | | | | +| prometheus_mysqld_exporter_targets | list | | | | +| prometheus_mongodb_exporter_targets | list | | | | +| prometheus_postgres_exporter_targets | list | | | | +| prometheus_mysqld_exporter_user | string | | | | +| prometheus_mysqld_exporter_password | string | | | | +| prometheus_mongodb_exporter_host | string | | localhost | | +| prometheus_mongodb_exporter_port | string | | 27017 | | +| prometheus_mongodb_exporter_user | string | | | | +| prometheus_mongodb_exporter_pass | string | | | | +| prometheus_server_version | string | | latest | | Dependencies ------------ -Docker must installed and running. + - jq + - Docker must installed and running for prometheus server Example Playbook ---------------- @@ -32,13 +53,24 @@ Example Playbook Example variables ----------------- - --- - prometheus_enable: 'true' - prometheus_node_exporter_enable: 'true' - prometheus_mysqld_exporter_enable: 'true' + --- + prometheus_server_enable: 'true' + prometheus_server_monitor: 'example' + + prometheus_exporter_packages: + - node + - mysqld + prometheus_mysqld_exporter_user: 'foo' prometheus_mysqld_exporter_password: 'bar' + prometheus_node_exporter_targets: + - server01 + - server02 + + prometheus_mysqld_exporter_targets: + - server01 + TODO ----