diff --git a/docs/blackbox-exporter.md b/docs/blackbox-exporter.md index 624b94837cc2f27e95bbe30032439037f91265a2..e6a5272512aec4881a81b10307a5ce4fd1bf4bef 100644 --- a/docs/blackbox-exporter.md +++ b/docs/blackbox-exporter.md @@ -1,3 +1,18 @@ +--- +title: "Blackbox Exporter" +description: "Generated API docs for the Prometheus Operator" +lead: "This Document documents the types introduced by the Prometheus Operator to be consumed by users." +date: 2021-03-08T08:49:31+00:00 +lastmod: 2021-03-08T08:49:31+00:00 +draft: false +images: [] +menu: + docs: + parent: "kube" +weight: 630 +toc: true +--- + # Setting up a blackbox exporter The `prometheus-operator` defines a `Probe` resource type that can be used to describe blackbox checks. To execute these, a separate component called [`blackbox_exporter`](https://github.com/prometheus/blackbox_exporter) has to be deployed, which can be scraped to retrieve the results of these checks. You can use `kube-prometheus` to set up such a blackbox exporter within your Kubernetes cluster. diff --git a/docs/deploy-kind.md b/docs/deploy-kind.md new file mode 100644 index 0000000000000000000000000000000000000000..f586b7cfdbc38306c2b83c547602da26484af11d --- /dev/null +++ b/docs/deploy-kind.md @@ -0,0 +1,19 @@ +--- +title: "Deploy to kind" +description: "Deploy kube-prometheus to Kubernets kind." +lead: "Deploy kube-prometheus to Kubernets kind." +date: 2021-03-08T23:04:32+01:00 +draft: false +images: [] +menu: + docs: + parent: "kube" +weight: 500 +toc: true +--- + +--- + +Time to explain why! + +Your chance of **contributing**! diff --git a/docs/developing-prometheus-rules-and-grafana-dashboards.md b/docs/developing-prometheus-rules-and-grafana-dashboards.md index 814ccf88815e1f257800bedcdc33fd780550ffee..b438c88b247b869bcefad0c5c5a81f379a60079f 100644 --- a/docs/developing-prometheus-rules-and-grafana-dashboards.md +++ b/docs/developing-prometheus-rules-and-grafana-dashboards.md @@ -1,4 +1,16 @@ -# Developing Prometheus Rules and Grafana Dashboards +--- +title: "Prometheus Rules and Grafana Dashboards" +description: "Create Prometheus Rules and Grafana Dashboards on top of kube-prometheus" +lead: "Create Prometheus Rules and Grafana Dashboards on top of kube-prometheus" +date: 2021-03-08T23:04:32+01:00 +draft: false +images: [] +menu: + docs: + parent: "kube" +weight: 650 +toc: true +--- `kube-prometheus` ships with a set of default [Prometheus rules](https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/) and [Grafana](http://grafana.com/) dashboards. At some point one might like to extend them, the purpose of this document is to explain how to do this. diff --git a/docs/exposing-prometheus-alertmanager-grafana-ingress.md b/docs/exposing-prometheus-alertmanager-grafana-ingress.md index f05ab4ce52c9b0e8fe00ddb0242662d1ccf1c851..be1ba130cf09ad3666132912b3518b2db3a34a9a 100644 --- a/docs/exposing-prometheus-alertmanager-grafana-ingress.md +++ b/docs/exposing-prometheus-alertmanager-grafana-ingress.md @@ -1,12 +1,24 @@ -# Exposing Prometheus, Alertmanager and Grafana UIs via Ingress - -In order to access the web interfaces via the Internet [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) is a popular option. This guide explains, how Kubernetes Ingress can be setup, in order to expose the Prometheus, Alertmanager and Grafana UIs, that are included in the [kube-prometheus](https://github.com/coreos/kube-prometheus) project. - -Note: before continuing, it is recommended to first get familiar with the [kube-prometheus](https://github.com/coreos/kube-prometheus) stack by itself. +--- +title: "Expose via Ingress" +description: "How to setup a Kubernetes Ingress to expose the Prometheus, Alertmanager and Grafana." +lead: "How to setup a Kubernetes Ingress to expose the Prometheus, Alertmanager and Grafana." +date: 2021-03-08T23:04:32+01:00 +draft: false +images: [] +menu: + docs: + parent: "kube" +weight: 500 +toc: true +--- + +In order to access the web interfaces via the Internet [Kubernetes Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) is a popular option. This guide explains, how Kubernetes Ingress can be setup, in order to expose the Prometheus, Alertmanager and Grafana UIs, that are included in the [kube-prometheus](https://github.com/prometheus-operator/kube-prometheus) project. + +Note: before continuing, it is recommended to first get familiar with the [kube-prometheus](https://github.com/prometheus-operator/kube-prometheus) stack by itself. ## Prerequisites -Apart from a running Kubernetes cluster with a running [kube-prometheus](https://github.com/coreos/kube-prometheus) stack, a Kubernetes Ingress controller must be installed and functional. This guide was tested with the [nginx-ingress-controller](https://github.com/kubernetes/ingress-nginx). If you wish to reproduce the exact result in as depicted in this guide we recommend using the nginx-ingress-controller. +Apart from a running Kubernetes cluster with a running [kube-prometheus](https://github.com/prometheus-operator/kube-prometheus) stack, a Kubernetes Ingress controller must be installed and functional. This guide was tested with the [nginx-ingress-controller](https://github.com/kubernetes/ingress-nginx). If you wish to reproduce the exact result in as depicted in this guide we recommend using the nginx-ingress-controller. ## Setting up Ingress diff --git a/docs/kube-prometheus-on-kubeadm.md b/docs/kube-prometheus-on-kubeadm.md index db15c4319c20974f5fbd461f1b837ba66b57a815..37610593986f3a83d5f82dd0cecdbb7f81ba9f93 100644 --- a/docs/kube-prometheus-on-kubeadm.md +++ b/docs/kube-prometheus-on-kubeadm.md @@ -1,15 +1,22 @@ -<br> -<div class="alert alert-info" role="alert"> - <i class="fa fa-exclamation-triangle"></i><b> Note:</b> Starting with v0.12.0, Prometheus Operator requires use of Kubernetes v1.7.x and up. -</div> - -# Kube Prometheus on Kubeadm - -The [kubeadm](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/) tool is linked by Kubernetes as the offical way to deploy and manage self-hosted clusters. Kubeadm does a lot of heavy lifting by automatically configuring your Kubernetes cluster with some common options. This guide is intended to show you how to deploy Prometheus, Prometheus Operator and Kube Prometheus to get you started monitoring your cluster that was deployed with Kubeadm. +--- +title: "Deploy to kubeadm" +description: "Deploy kube-prometheus to Kubernets kubeadm." +lead: "Deploy kube-prometheus to Kubernets kubeadm." +date: 2021-03-08T23:04:32+01:00 +draft: false +images: [] +menu: + docs: + parent: "kube" +weight: 500 +toc: true +--- + +The [kubeadm](https://kubernetes.io/docs/setup/independent/create-cluster-kubeadm/) tool is linked by Kubernetes as the offical way to deploy and manage self-hosted clusters. kubeadm does a lot of heavy lifting by automatically configuring your Kubernetes cluster with some common options. This guide is intended to show you how to deploy Prometheus, Prometheus Operator and Kube Prometheus to get you started monitoring your cluster that was deployed with kubeadm. This guide assumes you have a basic understanding of how to use the functionality the Prometheus Operator implements. If you haven't yet, we recommend reading through the [getting started guide](https://github.com/coreos/prometheus-operator/blob/master/Documentation/user-guides/getting-started.md) as well as the [alerting guide](https://github.com/coreos/prometheus-operator/blob/master/Documentation/user-guides/alerting.md). -## Kubeadm Pre-requisites +## kubeadm Pre-requisites This guide assumes you have some familiarity with `kubeadm` or at least have deployed a cluster using `kubeadm`. By default, `kubeadm` does not expose two of the services that we will be monitoring. Therefore, in order to get the most out of the `kube-prometheus` package, we need to make some quick tweaks to the Kubernetes cluster. Since we will be monitoring the `kube-controller-manager` and `kube-scheduler`, we must expose them to the cluster. diff --git a/docs/monitoring-external-etcd.md b/docs/monitoring-external-etcd.md index f70718511c4b6ca9702b2efcd413134d72e5893b..6ddecb1876a744ae5db74b841a153d79f2075955 100644 --- a/docs/monitoring-external-etcd.md +++ b/docs/monitoring-external-etcd.md @@ -1,5 +1,18 @@ -# Monitoring external etcd -This guide will help you monitor an external etcd cluster. When the etcd cluster is not hosted inside Kubernetes. +--- +title: "Monitoring external etcd" +description: "This guide will help you monitor an external etcd cluster." +lead: "This guide will help you monitor an external etcd cluster." +date: 2021-03-08T23:04:32+01:00 +draft: false +images: [] +menu: + docs: + parent: "kube" +weight: 640 +toc: true +--- + +When the etcd cluster is not hosted inside Kubernetes. This is often the case with Kubernetes setups. This approach has been tested with kube-aws but the same principals apply to other tools. Note that [etcd.jsonnet](../examples/etcd.jsonnet) & [kube-prometheus-static-etcd.libsonnet](../jsonnet/kube-prometheus/kube-prometheus-static-etcd.libsonnet) (which are described by a section of the [Readme](../README.md#static-etcd-configuration)) do the following: diff --git a/docs/monitoring-other-namespaces.md b/docs/monitoring-other-namespaces.md index 51f21201b58f3d2353a6ef6fca78a9a3973a2a18..2e4ede9ffbc181b66e769da45b8ae5174eb01252 100644 --- a/docs/monitoring-other-namespaces.md +++ b/docs/monitoring-other-namespaces.md @@ -1,4 +1,17 @@ -# Monitoring other Kubernetes Namespaces +--- +title: "Monitoring other Namespaces" +description: "This guide will help you monitor applications in other Namespaces." +lead: "This guide will help you monitor applications in other Namespaces." +date: 2021-03-08T23:04:32+01:00 +draft: false +images: [] +menu: + docs: + parent: "kube" +weight: 640 +toc: true +--- + This guide will help you monitor applications in other Namespaces. By default the RBAC rules are only enabled for the `Default` and `kube-system` Namespace during Install. # Setup