Add info on node-exporter to README.md

This one slipped through while updating the README previously in ed6b80d. Note: cadvisor also slipped through, but I purposefully didn't add it into the README as it will eventually be removed due to #65. Signed-off-by: Ryan Drew <[email protected]>
cilium · Oct 14, 2022 · a6c1dc5 · a6c1dc5
1 parent b148bdd
commit a6c1dc5
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -164,6 +164,14 @@ Three dashboards are provided out-of-the-box in `kustomize/grafana/dashboards`,
 
 A dashboard provider is used to accomplish this. See the [grafana docs](https://grafana.com/docs/grafana/latest/administration/provisioning/#dashboards) for more information.
 
+### node-exporter
+
+Deploys [node-exporter](https://github.com/prometheus/node_exporter) in the `monitoring` namespace onto any node labeled with `role.scaffolding/monitored=true`.
+A ServiceMonitor is created to allow for collection from Prometheus.
+A dashboard for the exported metrics is included within the grafana kustomization (see above).
+
+`HostNetwork` is enabled to allow for network metrics on the node to be collected.
+
 ### monitoring-ns
 
 Creates a namespace named 'monitoring'.