From 5f0768765418c7c808178845d79d95598edfe381 Mon Sep 17 00:00:00 2001 From: Simon Mayer <49491825+simcod@users.noreply.github.com> Date: Tue, 7 Jan 2025 15:23:07 +0100 Subject: [PATCH] Monitoring documentation (#319) --- .../monitoring/blackbox-exporter/README.md | 14 ++++++++ .../roles/monitoring/ipmi-exporter/README.md | 12 +++++++ .../roles/monitoring/node-exporter/README.md | 12 +++++++ .../roles/monitoring/prometheus/README.md | 35 +++++++++++++++++++ .../roles/monitoring/sonic-exporter/README.md | 12 +++++++ partition/roles/promtail/README.md | 16 +++++---- 6 files changed, 94 insertions(+), 7 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 create mode 100644 partition/roles/monitoring/prometheus/README.md 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..f83a34e4 --- /dev/null +++ b/partition/roles/monitoring/blackbox-exporter/README.md @@ -0,0 +1,14 @@ +# blackbox-exporter + +Deploys the blackbox-exporter in a systemd-managed Docker container. + +## Variables + +This role uses variables from [partition-defaults](/partition). So, make sure you define them adequately as well. + +| 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/prometheus/README.md b/partition/roles/monitoring/prometheus/README.md new file mode 100644 index 00000000..831c7389 --- /dev/null +++ b/partition/roles/monitoring/prometheus/README.md @@ -0,0 +1,35 @@ +# prometheus + +Deploys prometheus in a systemd-managed Docker container. + +## Variables + +This role uses variables from [partition-defaults](/partition). So, make sure +you define them adequately as well. + +| Name | Mandatory | Description | +| ------------------------------------------------ | --------- | ----------------------------------------------------------- | +| prometheus_port | | Port for prometheus | +| prometheus_image_name | yes | Image version of the prometheus | +| prometheus_image_tag | yes | Image tag of the prometheus | +| prometheus_config_host_dir | | The host directory for prometheus configurations | +| prometheus_data_host_dir | | The host directory for prometheus data | +| prometheus_alertmanager_target | | Targets for the alertmanager | +| prometheus_alertmanager_basic_auth_username | | The username for the authentication to the alertmanager | +| prometheus_alertmanager_basic_auth_password | | The password for the authentication to the alertmanager | +| prometheus_remote_write_url | | Remote write target for prometheus | +| prometheus_frr_exporter_targets | | FRR exporter targets to scrape from | +| prometheus_metal_core_targets | | metal-core targets to scrape from | +| prometheus_node_exporter_targets | | Node exporter targets to scrape from | +| prometheus_promtail_targets | | Promtail targets to scrape from | +| prometheus_ping_targets | | Ping targets to scrape from | +| prometheus_sonic_exporter_targets | | Sonic exporter targets to scrape from | +| prometheus_blackbox_exporter_targets | | Blackbox exporter targets to scrape from | +| prometheus_lightbox_exporter_targets | | Lightbox exporter targets to scrape from | +| prometheus_lightos_smart_targets | | Lightos smart targets to scrape from | +| prometheus_ipmi_exporter_targets | | IPMI exporter targets to scrape from | +| prometheus_hosts_content | | Available hosts for prometheus | +| prometheus_blackbox_exporter_icmp_groups | | ICMP groups for the blackbox exporter | +| 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 | 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 | diff --git a/partition/roles/promtail/README.md b/partition/roles/promtail/README.md index 1149b486..60c6d9b6 100644 --- a/partition/roles/promtail/README.md +++ b/partition/roles/promtail/README.md @@ -4,10 +4,12 @@ Deploys promtail in a systemd-managed Docker container. ## Variables -| Name | Mandatory | Description | -|-----------------------------|-----------|--------------------------------------| -| promtail_config_host_dir | | The location of the promtail config | -| promtail_image_name | yes | Image version of the promtail | -| promtail_image_tag | yes | Image tag of the promtail | -| promtail_loki_push_endpoint | yes | The URL to the Loki push endpoint | -| promtail_scrape_configs | yes | A list containing the scrape configs | +| Name | Mandatory | Description | +| --------------------------------- | --------- | ------------------------------------------ | +| promtail_config_host_dir | | The location of the promtail config | +| promtail_image_name | yes | Image version of the promtail | +| promtail_image_tag | yes | Image tag of the promtail | +| promtail_loki_push_endpoint | yes | The URL to the Loki push endpoint | +| promtail_scrape_configs | yes | A list containing the scrape configs | +| promtail_loki_basic_auth_username | | The username for the client authentication | +| promtail_loki_basic_auth_password | | The password for the client authentication |