Skip to content

Commit

Permalink
One README for each role
Browse files Browse the repository at this point in the history
  • Loading branch information
@simcod
simcod committed Sep 13, 2024
1 parent 6bfa2e8 commit b20515f
Show file tree
Hide file tree
Showing 5 changed files with 50 additions and 18 deletions.
12 changes: 12 additions & 0 deletions partition/roles/monitoring/blackbox-exporter/README.md
View file
Original file line number Diff line number Diff line change
@@ -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 |
12 changes: 12 additions & 0 deletions partition/roles/monitoring/ipmi-exporter/README.md
View file
Original file line number Diff line number Diff line change
@@ -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 |
12 changes: 12 additions & 0 deletions partition/roles/monitoring/node-exporter/README.md
View file
Original file line number Diff line number Diff line change
@@ -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 |
20 changes: 2 additions & 18 deletions partition/roles/monitoring/README.md → ...ion/roles/monitoring/prometheus/README.md
View file
Original file line number Diff line number Diff line change
@@ -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 |
Expand All @@ -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 |
12 changes: 12 additions & 0 deletions partition/roles/monitoring/sonic-exporter/README.md
View file
Original file line number Diff line number Diff line change
@@ -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 |

0 comments on commit b20515f

Please sign in to comment.