feat(docs): Add configuration info

stenic · Dec 3, 2020 · a067708 · a067708
1 parent d1ce560
commit a067708
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 1 deletion.
diff --git a/charts/prometheus-pve-exporter/Chart.yaml b/charts/prometheus-pve-exporter/Chart.yaml
@@ -1,7 +1,7 @@
 apiVersion: v2
 name: prometheus-pve-exporter
 description: A Helm chart to export the metrics from pve in Prometheus format.
-version: 0.1.0
+version: 0.1.1
 appVersion: "2.0.1"
 keywords:
 - pve-exporter

diff --git a/charts/prometheus-pve-exporter/README.md b/charts/prometheus-pve-exporter/README.md
@@ -42,6 +42,27 @@ The command removes all the Kubernetes components associated with the chart and
 
 ## Configuration
 
+Add the following to your prometheus configuration:
+
+```yaml
+scrape_configs:
+  - job_name: 'pve'
+    static_configs:
+      - targets:
+        - 192.168.1.2  # Proxmox VE node.
+        - 192.168.1.3  # Proxmox VE node.
+    metrics_path: /pve
+    params:
+      module: [default]
+    relabel_configs:
+      - source_labels: [__address__]
+        target_label: __param_target
+      - source_labels: [__param_target]
+        target_label: instance
+      - target_label: __address__
+        replacement: prometheus-pve-exporter:9221  # PVE exporter service.
+```
+
 The following tables list the configurable parameters of the prometheus-pve-exporter chart and their default values.
 
 | Key | Type | Default | Description |

diff --git a/charts/prometheus-pve-exporter/README.md.gotmpl b/charts/prometheus-pve-exporter/README.md.gotmpl
@@ -47,6 +47,27 @@ The command removes all the Kubernetes components associated with the chart and
 
 ## Configuration
 
+Add the following to your prometheus configuration:
+
+```yaml
+scrape_configs:
+  - job_name: 'pve'
+    static_configs:
+      - targets:
+        - 192.168.1.2  # Proxmox VE node.
+        - 192.168.1.3  # Proxmox VE node.
+    metrics_path: /pve
+    params:
+      module: [default]
+    relabel_configs:
+      - source_labels: [__address__]
+        target_label: __param_target
+      - source_labels: [__param_target]
+        target_label: instance
+      - target_label: __address__
+        replacement: prometheus-pve-exporter:9221  # PVE exporter service.
+```
+
 The following tables list the configurable parameters of the {{ template "chart.name" . }} chart and their default values.
 
 {{ template "chart.valuesTable" . }}