From b20515f93fd2f7f315979eef2af5d4d981a14824 Mon Sep 17 00:00:00 2001 From: Simon Mayer Date: Fri, 13 Sep 2024 14:49:25 +0200 Subject: [PATCH] One README for each role --- .../monitoring/blackbox-exporter/README.md | 12 +++++++++++ .../roles/monitoring/ipmi-exporter/README.md | 12 +++++++++++ .../roles/monitoring/node-exporter/README.md | 12 +++++++++++ .../monitoring/{ => prometheus}/README.md | 20 ++----------------- .../roles/monitoring/sonic-exporter/README.md | 12 +++++++++++ 5 files changed, 50 insertions(+), 18 deletions(-) create mode 100644 partition/roles/monitoring/blackbox-exporter/README.md create mode 100644 partition/roles/monitoring/ipmi-exporter/README.md create mode 100644 partition/roles/monitoring/node-exporter/README.md rename partition/roles/monitoring/{ => prometheus}/README.md (58%) create mode 100644 partition/roles/monitoring/sonic-exporter/README.md diff --git a/partition/roles/monitoring/blackbox-exporter/README.md b/partition/roles/monitoring/blackbox-exporter/README.md new file mode 100644 index 00000000..ecb93530 --- /dev/null +++ b/partition/roles/monitoring/blackbox-exporter/README.md @@ -0,0 +1,12 @@ +# blackbox-exporter + +Deploys the blackbox-exporter in a systemd-managed Docker container. + +## Variables + +| Name | Mandatory | Description | +| ----------------------------------------- | --------- | -------------------------------------------- | +| monitoring_blackbox_exporter_etc_host_dir | | The host directory for the blackbox exporter | +| monitoring_blackbox_exporter_image_name | | Image name of the blackblox exporter | +| monitoring_blackbox_exporter_image_tag | | Image tag of the blackbox exporter | +| monitoring_blackbox_exporter_port | | Port for the blackblox exporter | diff --git a/partition/roles/monitoring/ipmi-exporter/README.md b/partition/roles/monitoring/ipmi-exporter/README.md new file mode 100644 index 00000000..6625f69b --- /dev/null +++ b/partition/roles/monitoring/ipmi-exporter/README.md @@ -0,0 +1,12 @@ +# ipmi-exporter + +Deploys the ipmi-exporter in a systemd-managed Docker container. + +## Variables + +| Name | Mandatory | Description | +| ------------------------------------- | --------- | ---------------------------------------- | +| monitoring_ipmi_exporter_etc_host_dir | | The host directory for the IPMI exporter | +| monitoring_ipmi_exporter_image_name | | Image name of the IPMI exporter | +| monitoring_ipmi_exporter_image_tag | | Image tag of the IPMI exporter | +| monitoring_ipmi_exporter_port | | Port for the IPMI exporter | diff --git a/partition/roles/monitoring/node-exporter/README.md b/partition/roles/monitoring/node-exporter/README.md new file mode 100644 index 00000000..980ddf4c --- /dev/null +++ b/partition/roles/monitoring/node-exporter/README.md @@ -0,0 +1,12 @@ +# node-exporter + +Deploys the node-exporter in a systemd-managed Docker container. + +## Variables + +| Name | Mandatory | Description | +| ----------------------------------- | --------- | ---------------------------------------- | +| monitoring_node_exporter_dir | | The host directory for the node exporter | +| monitoring_node_exporter_image_name | | Image name of the IPMI exporter | +| monitoring_node_exporter_image_tag | | Image tag of the IPMI exporter | +| monitoring_node_exporter_port | | Port for the IPMI exporter | diff --git a/partition/roles/monitoring/README.md b/partition/roles/monitoring/prometheus/README.md similarity index 58% rename from partition/roles/monitoring/README.md rename to partition/roles/monitoring/prometheus/README.md index 7278594e..950adf4e 100644 --- a/partition/roles/monitoring/README.md +++ b/partition/roles/monitoring/prometheus/README.md @@ -1,23 +1,11 @@ -# monitoring +# prometheus -Deploys exporter in systemd-managed Docker containers. +Deploys prometheus in a systemd-managed Docker container. ## Variables | Name | Mandatory | Description | | ------------------------------------------------ | --------- | ----------------------------------------------------------- | -| monitoring_blackbox_exporter_etc_host_dir | | The host directory for the blackbox exporter | -| monitoring_blackbox_exporter_image_name | | Image name of the blackblox exporter | -| monitoring_blackbox_exporter_image_tag | | Image tag of the blackbox exporter | -| monitoring_blackbox_exporter_port | | Port for the blackblox exporter | -| monitoring_ipmi_exporter_etc_host_dir | | The host directory for the IPMI exporter | -| monitoring_ipmi_exporter_image_name | | Image name of the IPMI exporter | -| monitoring_ipmi_exporter_image_tag | | Image tag of the IPMI exporter | -| monitoring_ipmi_exporter_port | | Port for the IPMI exporter | -| monitoring_node_exporter_dir | | The host directory for the node exporter | -| monitoring_node_exporter_image_name | | Image name of the IPMI exporter | -| monitoring_node_exporter_image_tag | | Image tag of the IPMI exporter | -| monitoring_node_exporter_port | | Port for the IPMI exporter | | prometheus_port | | Port for prometheus | | prometheus_config_host_dir | | The host directory for prometheus configurations | | prometheus_data_host_dir | | The host directory for prometheus data | @@ -39,7 +27,3 @@ Deploys exporter in systemd-managed Docker containers. | prometheus_blackbox_exporter_metal_api_probe_url | | metal-api probe URL for the blackbox exporter | | prometheus_remote_write_basic_auth_username | | The username for the prometheus remote write authentication | | prometheus_remote_write_basic_auth_password | | The password for the prometheus remote write authentication | -| sonic_exporter_image_name | | Image name of the sonic exporter | -| sonic_exporter_image_tag | | Image tag of the sonic exporter | -| sonic_exporter_address | | Address for the sonic exporter | -| sonic_exporter_port | | Port for the sonic exporter | diff --git a/partition/roles/monitoring/sonic-exporter/README.md b/partition/roles/monitoring/sonic-exporter/README.md new file mode 100644 index 00000000..65c4d84e --- /dev/null +++ b/partition/roles/monitoring/sonic-exporter/README.md @@ -0,0 +1,12 @@ +# sonic-exporter + +Deploys the sonic-exporter in a systemd-managed Docker container. + +## Variables + +| Name | Mandatory | Description | +| ------------------------- | --------- | -------------------------------- | +| sonic_exporter_image_name | | Image name of the sonic exporter | +| sonic_exporter_image_tag | | Image tag of the sonic exporter | +| sonic_exporter_address | | Address for the sonic exporter | +| sonic_exporter_port | | Port for the sonic exporter |