easylinux/kube-prometheus
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

kube-prometheus: Improve README, recommending Tectonic Installer

Browse Source
This commit is contained in:
Arve Knudsen
2017-11-10 12:03:47 +01:00
parent b071ae02ca
commit 245029da50
1 changed files with 33 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

50
README.md
View File

@@ -1,35 +1,40 @@
# kube-prometheus # kube-prometheus
This repository collects Kubernetes manifests, dashboards, and alerting rules This repository collects Kubernetes manifests, [Grafana](http://grafana.com/) dashboards, and
combined with documentation and scripts to provide single-command deployments [Prometheus rules](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/)
of end-to-end Kubernetes cluster monitoring. combined with documentation and scripts to provide single-command deployments of end-to-end
Kubernetes cluster monitoring with [Prometheus](https://prometheus.io/) (Operator).
## Prerequisites ## Prerequisites
First, you need a running Kubernetes cluster. If you don't have one, follow the First, you need a running Kubernetes cluster. If you don't have one, we recommend you create one
instructions of [bootkube](https://github.com/kubernetes-incubator/bootkube) or with [Tectonic Installer](https://coreos.com/tectonic/docs/latest/). Despite the name,
[minikube](https://github.com/kubernetes/minikube). Some sample contents of this Tectonic Installer gives you also the choice to create a barebones Kubernetes cluster, without
CoreOS' Tectonic technology. Otherwise, you can simply make use of
[bootkube](https://github.com/kubernetes-incubator/bootkube) or
[minikube](https://github.com/kubernetes/minikube) for local testing. Some sample contents of this
repository are adapted to work with a [multi-node setup](https://github.com/kubernetes-incubator/bootkube/tree/master/hack/multi-node) repository are adapted to work with a [multi-node setup](https://github.com/kubernetes-incubator/bootkube/tree/master/hack/multi-node)
using [bootkube](https://github.com/kubernetes-incubator/bootkube). using [bootkube](https://github.com/kubernetes-incubator/bootkube).
## Monitoring Kubernetes ## Monitoring Kubernetes
The manifests used here use the [Prometheus Operator](https://github.com/coreos/prometheus-operator), The manifests here use the [Prometheus Operator](https://github.com/coreos/prometheus-operator),
which manages Prometheus servers and their configuration in a cluster. With a single command we can install which manages Prometheus servers and their configuration in a cluster. With a single command we can
install
* The Operator itself * The Operator itself
* The Prometheus [node_exporter](https://github.com/prometheus/node_exporter) * The Prometheus [node_exporter](https://github.com/prometheus/node_exporter)
* [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics) * [kube-state-metrics](https://github.com/kubernetes/kube-state-metrics)
* The [Prometheus specification](https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#prometheus) based on which the Operator deploys a Prometheus setup * The [Prometheus specification](https://github.com/coreos/prometheus-operator/blob/master/Documentation/api.md#prometheus) based on which the Operator deploys a Prometheus setup
* A Prometheus configuration covering monitoring of all Kubernetes core components and exporters * A Prometheus configuration covering monitoring of all Kubernetes core components and exporters
* A default set of alerting rules on the cluster component's health * A default set of alerting rules on the cluster components' health
* A Grafana instance serving dashboards on cluster metrics * A Grafana instance serving dashboards on cluster metrics
* A three node highly available Alertmanager cluster * A three node highly available Alertmanager cluster
Simply run: Simply run:
```bash ```bash
export KUBECONFIG=<path> # defaults to "~/.kube/config" export KUBECONFIG=<path> # defaults to "~/.kube/config"
hack/cluster-monitoring/deploy hack/cluster-monitoring/deploy
``` ```
@@ -47,11 +52,11 @@ hack/cluster-monitoring/teardown
## Monitoring custom services ## Monitoring custom services
The example manifests in [/manifests/examples/example-app](/contrib/kube-prometheus/manifests/examples/example-app) The example manifests in [manifests/examples/example-app](/contrib/kube-prometheus/manifests/examples/example-app)
deploy a fake service exposing Prometheus metrics. They additionally define a new Prometheus deploy a fake service exposing Prometheus metrics. They additionally define a new Prometheus
server and a [`ServiceMonitor`](https://github.com/coreos/prometheus-operator/blob/master/Documentation/design.md#servicemonitor), server and a [`ServiceMonitor`](https://github.com/coreos/prometheus-operator/blob/master/Documentation/design.md#servicemonitor),
which specifies how the example service should be monitored. which specifies how the example service should be monitored.
The Prometheus Operator will deploy and configure the desired Prometheus instance and continiously The Prometheus Operator will deploy and configure the desired Prometheus instance and continuously
manage its life cycle. manage its life cycle.
```bash ```bash
@@ -71,21 +76,32 @@ hack/example-service-monitoring/teardown
## Dashboarding ## Dashboarding
The provided manifests deploy a Grafana instance serving dashboards provided via a ConfigMap. The provided manifests deploy a Grafana instance serving dashboards provided via ConfigMaps.
To modify, delete, or add dashboards, the `grafana-dashboards` ConfigMap must be modified. Said ConfigMaps are generated from Python scripts in assets/grafana, that all have the extension
.dashboard.py as they are loaded by the [grafanalib](https://github.com/aknuds1/grafanalib)
Grafana dashboard generator. Bear in mind that we are for now using a fork of grafanalib as
we needed to make extensive changes to it, in order to be able to generate our dashboards. We are
hoping to be able to consolidate our version with the original.
As such, in order to make changes to the dashboard bundle, you need to change the \*.dashboard.py
files in assets/grafana, eventually add your own, and then run `make generate` in the
kube-prometheus root directory.
To read more in depth about developing dashboards, read the [Developing alerts and dashboards](docs/developing-alerts-and-dashboards.md) documentation.
### Reloading of dashboards
Currently, Grafana does not support serving dashboards from static files. Instead, the `grafana-watcher` Currently, Grafana does not support serving dashboards from static files. Instead, the `grafana-watcher`
sidecar container aims to emulate the behavior, by keeping the Grafana database always in sync sidecar container aims to emulate the behavior, by keeping the Grafana database always in sync
with the provided ConfigMap. Hence, the Grafana pod is effectively stateless. with the provided ConfigMap. Hence, the Grafana pod is effectively stateless.
This allows managing dashboards via `git` etc. and easily deploying them via CD pipelines. This allows managing dashboards via `git` etc. and easily deploying them via CD pipelines.
For information about how to update/handle the dashboards check [Developing alerts and dashboards](docs/developing-alerts-and-dashboards.md) doc.
In the future, a separate Grafana operator will support gathering dashboards from multiple In the future, a separate Grafana operator will support gathering dashboards from multiple
ConfigMaps based on label selection. ConfigMaps based on label selection.
WARNING: If you deploy multiple Grafana instances for HA, you must use session affinity. WARNING: If you deploy multiple Grafana instances for HA, you must use session affinity.
Otherwise if pods restart the prometheus datasource ID can get out of sync between the pods, breaking the UI Otherwise if pods restart the prometheus datasource ID can get out of sync between the pods,
breaking the UI
## Roadmap ## Roadmap