coreos/prometheus-operator
1
0
Fork 0
mirror of https://github.com/coreos/prometheus-operator.git synced 2026-02-05 06:45:27 +01:00
Code Issues Releases Wiki Activity

Add content header for hugo website

Browse Source
This commit is contained in:
Matthias Loibl
2021-03-09 01:03:31 +01:00
parent fcefd45939
commit 9b7157606f
9 changed files with 141 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
ADOPTERS.md
View File

@@ -1,10 +1,14 @@
# Adopters
---
title: "Adopters"
date: 2021-03-08T23:50:39+01:00
draft: false
---
This document tracks people and use cases for the Prometheus Operator in production. By creating a list of production use cases we hope to build a community of advisors that we can reach out to with experience using various the Prometheus Operator applications, operation environments, and cluster sizes. The Prometheus Operator development team may reach out periodically to check-in on how the Prometheus Operator is working in the field and update this list.
## Giant Swarm
https://www.giantswarm.io/
[giantswarm.io](https://www.giantswarm.io/)
Environments: AWS, Azure, Bare Metal
@@ -18,7 +22,7 @@ Details:
## Lunar
https://lunar.app/
[lunar.app](https://lunar.app/)
Environments: AWS
@@ -31,7 +35,7 @@ Details:
## OpenShift
https://www.openshift.com/
[openshift.com](https://www.openshift.com/)
Environments: AWS, Azure, Google Cloud, Bare Metal
@@ -43,7 +47,7 @@ All OpenShift clusters use the Prometheus Operator to manage the cluster monitor
## Polar Signals
https://polarsignals.com/
[polarsignals.com](https://polarsignals.com/)
Environment: Google Cloud
@@ -56,7 +60,7 @@ Details:
## Skyscanner
https://skyscanner.net/
[skyscanner.net](https://skyscanner.net/)
Environment: AWS
@@ -69,7 +73,7 @@ Details (optional):
## Veepee
https://www.veepee.com
[veepee.com](https://www.veepee.com)
Environments: Bare Metal
@@ -82,7 +86,7 @@ Details (optional):
## VSHN AG
https://www.vshn.ch/
[vshn.ch](https://www.vshn.ch/)
Environments: AWS, Azure, Google Cloud, cloudscale.ch, Exoscale, Swisscom
@@ -92,6 +96,8 @@ Details (optional):
- A huge fleet of OpenShift and Kubernetes clusters, each using Prometheus Operator
- All managed by [Project Syn](https://syn.tools/), leveraging Commodore Components like [component-rancher-monitoring](https://github.com/projectsyn/component-rancher-monitoring) which re-uses Prometheus Operator
---
## <Insert Company/Organization Name>
https://our-link.com/

20
Documentation/api.md
View File

@@ -1,9 +1,17 @@
<br>
<div class="alert alert-info" role="alert">
<i class="fa fa-exclamation-triangle"></i><b> Note:</b> Starting with v0.39.0, Prometheus Operator requires use of Kubernetes v1.16.x and up.
</div>
# API Docs
---
title: "API"
description: "Generated API docs for the Prometheus Operator"
lead: ""
date: 2021-03-08T08:49:31+00:00
lastmod: 2021-03-08T08:49:31+00:00
draft: false
images: []
menu:
docs:
parent: "operator"
weight: 1000
toc: true
---
This Document documents the types introduced by the Prometheus Operator to be consumed by users.

20
Documentation/compatibility.md
View File

@@ -1,9 +1,17 @@
<br>
<div class="alert alert-info" role="alert">
<i class="fa fa-exclamation-triangle"></i><b> Note:</b> Starting with v0.39.0, Prometheus Operator requires use of Kubernetes v1.16.x and up.
</div>
# Compatibility
---
title: "Compatibility"
description: "The Prometheus Operator supports a number of Kubernetes and Prometheus releases."
lead: ""
date: 2021-03-08T08:49:31+00:00
lastmod: 2021-03-08T08:49:31+00:00
draft: false
images: []
menu:
docs:
parent: "operator"
weight: 200
toc: true
---
The Prometheus Operator supports a number of Kubernetes and Prometheus releases.

36
Documentation/design.md
View File

@@ -1,22 +1,30 @@
<br>
<div class="alert alert-info" role="alert">
<i class="fa fa-exclamation-triangle"></i><b> Note:</b> Starting with v0.39.0, Prometheus Operator requires use of Kubernetes v1.16.x and up.
</div>
# Design
---
title: "Design"
description: "This document describes the design and interaction between the custom resource definitions that the Prometheus Operator introduces."
lead: ""
date: 2021-03-08T08:49:31+00:00
lastmod: 2021-03-08T08:49:31+00:00
draft: false
images: []
menu:
docs:
parent: "operator"
weight: 100
toc: true
---
This document describes the design and interaction between the custom resource definitions that the Prometheus Operator introduces.
The custom resources that the Prometheus Operator introduces are:
* `Prometheus`
* `Alertmanager`
* `ThanosRuler`
* `ServiceMonitor`
* `PodMonitor`
* `Probe`
* `PrometheusRule`
* `AlertmanagerConfig`
* [Prometheus](#prometheus)
* [Alertmanager](#alertmanager)
* [ThanosRuler](#thanosruler)
* [ServiceMonitor](#servicemonitor)
* [PodMonitor](#podmonitor)
* [Probe](#probe)
* [PrometheusRule](#prometheusrule)
* [AlertmanagerConfig](#alertmanagerconfig)
## Prometheus

20
Documentation/high-availability.md
View File

@@ -1,9 +1,17 @@
<br>
<div class="alert alert-info" role="alert">
<i class="fa fa-exclamation-triangle"></i><b> Note:</b> Starting with v0.39.0, Prometheus Operator requires use of Kubernetes v1.16.x and up.
</div>
# High Availability
---
title: "High Availability"
description: "High Availability is a must for the monitoring infrastructure."
lead: ""
date: 2021-03-08T08:49:31+00:00
lastmod: 2021-03-08T08:49:31+00:00
draft: false
images: []
menu:
docs:
parent: "operator"
weight: 300
toc: true
---
High availability is not only important for customer facing software, but if the monitoring infrastructure is not highly available, then there is a risk that operations people are not notified for alerts of the customer facing software. Therefore high availability must be just as thought through for the monitoring stack, as for anything else.

15
Documentation/rbac-crd.md
View File

@@ -1,4 +1,17 @@
# RBAC for Prometheus Operator CRDs
---
title: "RBAC for CRDs"
description: "Aggregate permissions on the Prometheus Operator CustomResourceDefinitions."
lead: ""
date: 2021-03-08T08:49:31+00:00
lastmod: 2021-03-08T08:49:31+00:00
draft: false
images: []
menu:
docs:
parent: "operator"
weight: 420 # nice
toc: true
---
## Aggregated ClusterRoles

22
Documentation/rbac.md
View File

@@ -1,11 +1,19 @@
<br>
<div class="alert alert-info" role="alert">
<i class="fa fa-exclamation-triangle"></i><b> Note:</b> Starting with v0.39.0, Prometheus Operator requires use of Kubernetes v1.16.x and up.
</div>
---
title: "RBAC"
description: "High Availability is a must for the monitoring infrastructure."
lead: ""
date: 2021-03-08T08:49:31+00:00
lastmod: 2021-03-08T08:49:31+00:00
draft: false
images: []
menu:
docs:
parent: "operator"
weight: 400
toc: true
---
# RBAC
RBAC for the Prometheus Operator involves two parts, RBAC rules for the Operator itself and RBAC rules for the Prometheus Pods themselves created by the Operator as Prometheus requires access to the Kubernetes API for target and Alertmanager discovery.
[Role-based access control](https://en.wikipedia.org/wiki/Role-based_access_control) (RBAC) for the Prometheus Operator involves two parts, RBAC rules for the Operator itself and RBAC rules for the Prometheus Pods themselves created by the Operator as Prometheus requires access to the Kubernetes API for target and Alertmanager discovery.
## Prometheus Operator RBAC

25
Documentation/thanos.md
View File

@@ -1,4 +1,17 @@
# Thanos and the Prometheus Operator
---
title: "Thanos"
description: "Thanos and the Prometheus Operator."
lead: "Thanos and the Prometheus Operator."
date: 2021-03-08T08:49:31+00:00
lastmod: 2021-03-08T08:49:31+00:00
draft: false
images: []
menu:
docs:
parent: "operator"
weight: 500
toc: true
---
_Note: This guide is valid for Prometheus Operator v0.28+ and Thanos v0.2+ and above._
@@ -7,7 +20,7 @@ multi Prometheus metric system with potentially unlimited storage capacity, if y
Before continuing with Prometheus Operator Thanos integration, it is recommended to read more about Thanos in the [documentation](https://thanos.io/tip/thanos/getting-started.md/).
## What Prometheus Operator helps with?
## What does the Prometheus Operator help with?
Prometheus Operator operates `Prometheus` and optionally `ThanosRuler` components.
Other Thanos components, such as the querier and store gateway, must be configured
@@ -27,7 +40,7 @@ Pod. To enable the sidecar, reference the following examples.
This is the simplest configuration change that needs to be made to your
Prometheus Custom Resource, after creating the secret.
```
```yaml
...
spec:
...
@@ -69,7 +82,7 @@ kubectl -n monitoring create secret generic thanos-objstore-config --from-file=t
And then you can specify this secret inside Thanos part of the Prometheus CRD we mentioned [earlier](#prometheus-custom-resource-with-thanos-sidecar):
```
```yaml
...
spec:
...
@@ -92,7 +105,7 @@ responsible for compactions on a global, object storage level.
The [Thanos Ruler](https://github.com/thanos-io/thanos/blob/master/docs/components/rule.md) component allows recording and alerting rules to be processed across
multiple Prometheus instances. A `ThanosRuler` instance requires at least one `queryEndpoint` which points to the location of Thanos Queriers or Prometheus instances. The `queryEndpoints` are used to configure the `--query` arguments(s) of the Thanos runtime.
```
```yaml
...
apiVersion: monitoring.coreos.com/v1
kind: ThanosRuler
@@ -124,7 +137,7 @@ Additionally, when object storage backup is desired:
- [Store](https://thanos.io/tip/components/store.md/)
- [Compactor](https://thanos.io/tip/components/compact.md/)
Again, take a look at the Thanos documentation for more details on these components: https://thanos.io/tip/thanos/quick-tutorial.md
Again, take a look at the Thanos documentation for more details on these components: [thanos.io/tip/thanos/quick-tutorial.md](https://thanos.io/tip/thanos/quick-tutorial.md)
kube-thanos project has already supported several thanos components.
For more details, please checkout [kube-thanos](https://github.com/thanos-io/kube-thanos/).

22
Documentation/troubleshooting.md
View File

@@ -1,9 +1,17 @@
<br>
<div class="alert alert-info" role="alert">
<i class="fa fa-exclamation-triangle"></i><b> Note:</b> Starting with v0.39.0, Prometheus Operator requires use of Kubernetes v1.16.x and up.
</div>
# FAQ / Troubleshooting
---
title: "Troubleshooting"
description: "Guide on troubleshooting the Prometheus Operator."
lead: ""
date: 2021-03-08T08:49:31+00:00
lastmod: 2021-03-08T08:49:31+00:00
draft: false
images: []
menu:
docs:
parent: "operator"
weight: 600
toc: true
---
### RBAC on Google Container Engine (GKE)
@@ -43,7 +51,7 @@ When creating/deleting/modifying `ServiceMonitor` objects it is sometimes not as
A common problem related to `ServiceMonitor` identification by Prometheus is related to an incorrect tagging, that does not match the `Prometheus` custom resource definition scope, or lack of permission for the Prometheus `ServiceAccount` to *get, list, watch* `Services` and `Endpoints` from the target application being monitored. As a general guideline consider the diagram below, giving an example of a `Deployment` and `Service` called `my-app`, being monitored by Prometheus based on a `ServiceMonitor` named `my-service-monitor`:
![flow diagram](custom-metrics-elements.png)
![flow diagram](../custom-metrics-elements.png)
Note: The `ServiceMonitor` references a `Service` (not a `Deployment`, or a `Pod`), by labels *and* by the port name in the `Service`. This *port name* is optional in Kubernetes, but must be specified for the `ServiceMonitor` to work. It is not the same as the port name on the `Pod` or container, although it can be.