Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Monitoring documentation #319

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Monitoring documentation #319

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3a58629
Documentation for the monitoring role
simcod Sep 10, 2024
6bfa2e8
Merge remote-tracking branch 'origin' into monitoring-documentation
simcod Sep 11, 2024
b20515f
One README for each role
simcod Sep 13, 2024
56e390d
Merge branch 'master' into monitoring-documentation
Gerrit91 Nov 12, 2024
e269b24
Merge branch 'master' into monitoring-documentation
Gerrit91 Dec 10, 2024
d520d25
Implement review
simcod Dec 11, 2024
dffc1f8
Make variables mandatory
simcod Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions partition/roles/monitoring/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# monitoring
Gerrit91 marked this conversation as resolved.
Show resolved Hide resolved

Deploys exporter in systemd-managed Docker containers.

## 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 |
| 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 | | 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_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 |
| 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 |
16 changes: 9 additions & 7 deletions partition/roles/promtail/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Loading