diff --git a/docs/blackbox-exporter.md b/docs/blackbox-exporter.md index 624b9483..e6a52725 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 00000000..ea66c59a --- /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 how! + +Your chance of [**contributing**](https://github.com/prometheus-operator/kube-prometheus/blob/main/docs/deploy-kind.md)! diff --git a/docs/developing-prometheus-rules-and-grafana-dashboards.md b/docs/developing-prometheus-rules-and-grafana-dashboards.md index 4b300115..990c07bf 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 f05ab4ce..be1ba130 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 +--- +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/coreos/kube-prometheus) project. +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/coreos/kube-prometheus) stack by itself. +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 db15c431..37610593 100644 --- a/docs/kube-prometheus-on-kubeadm.md +++ b/docs/kube-prometheus-on-kubeadm.md @@ -1,15 +1,22 @@ -
- +--- +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 +--- -# 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. +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 f7071851..6ddecb18 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 51f21201..2e4ede9f 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