From eb23d1d16ca56a400de061fc210fd62e7b2b0f03 Mon Sep 17 00:00:00 2001
From: Frederic Branczyk <fbranczyk@gmail.com>
Date: Mon, 13 Aug 2018 16:23:51 +0200
Subject: [PATCH] kube-prometheus: Add docs on monitoring additional namespaces
---
README.md | 26 ++++++++++++++++++++++++++
examples/additional-namespaces.jsonnet | 17 +++++++++++++++++
2 files changed, 43 insertions(+)
create mode 100644 examples/additional-namespaces.jsonnet
diff --git a/README.md b/README.md
index b653dc29..84aeb1d3 100644
--- a/README.md
+++ b/README.md
@@ -288,6 +288,32 @@ In the above example the configuration has been inlined, but can just as well be
},
}).alertmanager.secret
```
+
+### Adding additional namespaces to monitor
+
+In order to monitor additional namespaces, the Prometheus server requires the appropriate `Role` and `RoleBinding` to be able to discover targets from that namespace. By default the Prometheus server is limited to the three namespaces it requires: default, kube-system and the namespace you configure the stack to run in via `$._config.namespace`. This is specified in `$._config.prometheus.namespaces`, to add new namespaces to monitor, simply append the additional namespaces:
+
+[embedmd]:# (examples/additional-namespaces.jsonnet)
+```jsonnet
+local kp = (import 'kube-prometheus/kube-prometheus.libsonnet') + {
+ _config+:: {
+ namespace: 'monitoring',
+
+ prometheus+:: {
+ namespaces+: ['my-namespace', 'my-second-namespace'],
+ },
+ },
+};
+
+{ ['00namespace-' + name]: kp.kubePrometheus[name] for name in std.objectFields(kp.kubePrometheus) } +
+{ ['0prometheus-operator-' + name]: kp.prometheusOperator[name] for name in std.objectFields(kp.prometheusOperator) } +
+{ ['node-exporter-' + name]: kp.nodeExporter[name] for name in std.objectFields(kp.nodeExporter) } +
+{ ['kube-state-metrics-' + name]: kp.kubeStateMetrics[name] for name in std.objectFields(kp.kubeStateMetrics) } +
+{ ['alertmanager-' + name]: kp.alertmanager[name] for name in std.objectFields(kp.alertmanager) } +
+{ ['prometheus-' + name]: kp.prometheus[name] for name in std.objectFields(kp.prometheus) } +
+{ ['grafana-' + name]: kp.grafana[name] for name in std.objectFields(kp.grafana) }
+```
+
### Static etcd configuration
In order to configure a static etcd cluster to scrape there is a simple mixin prepared, so only the IPs and certificate information need to be configured. Simply append the `kube-prometheus/kube-prometheus-static-etcd.libsonnet` mixin to the rest of the configuration, and configure the `ips` to be the IPs to scrape, and the `clientCA`, `clientKey` and `clientCert` to values that are valid to scrape etcd metrics with.
diff --git a/examples/additional-namespaces.jsonnet b/examples/additional-namespaces.jsonnet
new file mode 100644
index 00000000..957fd912
--- /dev/null
+++ b/examples/additional-namespaces.jsonnet
@@ -0,0 +1,17 @@
+local kp = (import 'kube-prometheus/kube-prometheus.libsonnet') + {
+ _config+:: {
+ namespace: 'monitoring',
+
+ prometheus+:: {
+ namespaces+: ['my-namespace', 'my-second-namespace'],
+ },
+ },
+};
+
+{ ['00namespace-' + name]: kp.kubePrometheus[name] for name in std.objectFields(kp.kubePrometheus) } +
+{ ['0prometheus-operator-' + name]: kp.prometheusOperator[name] for name in std.objectFields(kp.prometheusOperator) } +
+{ ['node-exporter-' + name]: kp.nodeExporter[name] for name in std.objectFields(kp.nodeExporter) } +
+{ ['kube-state-metrics-' + name]: kp.kubeStateMetrics[name] for name in std.objectFields(kp.kubeStateMetrics) } +
+{ ['alertmanager-' + name]: kp.alertmanager[name] for name in std.objectFields(kp.alertmanager) } +
+{ ['prometheus-' + name]: kp.prometheus[name] for name in std.objectFields(kp.prometheus) } +
+{ ['grafana-' + name]: kp.grafana[name] for name in std.objectFields(kp.grafana) }
--
GitLab