From 7ac4da1f9fc526bd7e00f12057f733be04976db2 Mon Sep 17 00:00:00 2001
From: Joshua Olson <joshua.olson.490@gmail.com>
Date: Fri, 3 Aug 2018 08:42:50 -0500
Subject: [PATCH] kube-prometheus: add more commentary to etcd.jsonnet
---
examples/etcd.jsonnet | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/examples/etcd.jsonnet b/examples/etcd.jsonnet
index fcce57be..cb864f97 100644
--- a/examples/etcd.jsonnet
+++ b/examples/etcd.jsonnet
@@ -5,9 +5,14 @@ local kp = (import 'kube-prometheus/kube-prometheus.libsonnet') +
// Reference info: https://github.com/coreos/prometheus-operator/blob/master/contrib/kube-prometheus/README.md#static-etcd-configuration
etcd+:: {
- // Configure this to be the IP(s) to scrape - i.e. your etcd node(s) (use commans to separate multiple values).
+ // Configure this to be the IP(s) to scrape - i.e. your etcd node(s) (use commas to separate multiple values).
ips: ['127.0.0.1'],
+ // Reference info:
+ // * https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#servicemonitorspec (has endpoints)
+ // * https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#endpoint (has tlsConfig)
+ // * https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#tlsconfig (has: caFile, certFile, keyFile, serverName, & insecureSkipVerify)
+
// Set these three variables to values that are valid to scrape etcd metrics with (check the apiserver container).
// Most likely these certificates are generated somewhere in an infrastructure repository, so using the jsonnet `importstr` function can
// be useful here. (Kube-aws stores these three files inside the credential folder.)
@@ -16,7 +21,7 @@ local kp = (import 'kube-prometheus/kube-prometheus.libsonnet') +
clientKey: importstr '/path-on-your-work-machine/etcd-client.key',
clientCert: importstr '/path-on-your-work-machine/etcd-client.crt',
- // A valid name for the certificate
+ // A valid name for the certificate.
serverName: 'etcd.my-cluster.local',
// TODO: enhance kube-prometheus-static-etcd.libsonnet to allow 'insecureSkipVerify: true' to be specified here (as an alternative to specifying a value for 'serverName').
--
GitLab