mirror of
https://github.com/prometheus-operator/prometheus-operator.git
synced 2025-04-20 19:29:10 +00:00
docs: add compatibility warning
This commit is contained in:
Frederic Branczyk
parent
5e35bfef0b
commit
0457f55955
18 changed files with 93 additions and 4 deletions
Documentation
api.mdcompatibility.mddesign.mdexposing-metrics.mdhigh-availability.mdmigration.mdnetwork-policies.mdrbac.mdtroubleshooting.md
user-guides
cmd/po-docgen
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# API Docs
|
||||
|
||||
This Document documents the types introduced by the Prometheus Operator to be consumed by users.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# Compatibility
|
||||
|
||||
The Prometheus Operator supports a number of Kubernetes and Prometheus releases.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# Design
|
||||
|
||||
This document describes the design and interaction between the custom resource definitions that the Prometheus Operator introduces.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# Exposing Metrics
|
||||
|
||||
There are a number of [applications](https://prometheus.io/docs/instrumenting/exporters/#directly-instrumented-software) that are natively instrumented with Prometheus metrics. Those applications simply expose the metrics through an HTTP server.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# High Availability
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# Migration from TPR to CRDs
|
||||
|
||||
ThirdPartyResources (TPRs) are now being deprecated in favor of CustomResourceDefinitions (CRDs) and the Prometheus Operator automatically migrates TPRs to CRDs when it can. If it encounters an error during the migration, it will rollback the changes done until that point. To deal with edge cases, like the operator dying in the middle of a rollback, we store the data safely so that it can always be restored manually. This doc outlines the process of migration and the manual recovery.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
<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>
|
||||
|
||||
# Network policies
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# 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.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# FAQ / Troubleshooting
|
||||
|
||||
### RBAC on Google Container Engine (GKE)
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# Alerting
|
||||
|
||||
This guide assumes you have a basic understanding of the `Prometheus` resource and have read the [getting started](getting-started.md).
|
||||
|
|
|
|||
|
|
@ -1,7 +1,12 @@
|
|||
<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>
|
||||
|
||||
## Basic auth for targets
|
||||
|
||||
To authenticate a `ServiceMonitor`s over a metrics endpoint use [`basicAuth`](../api.md#basicauth)
|
||||
|
||||
To authenticate a `ServiceMonitor`s over a metrics endpoint use [`basicAuth`](../api.md#basicauth)
|
||||
|
||||
[embedmd]:# (../../contrib/kube-prometheus/manifests/examples/basic-auth/service-monitor.yaml)
|
||||
```yaml
|
||||
apiVersion: monitoring.coreos.com/v1
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# Cluster Monitoring
|
||||
|
||||
This guide is intended to give an introduction to all the parts required to start monitoring a Kubernetes cluster with Prometheus using the Prometheus Operator.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# Exposing Prometheus and Alertmanager
|
||||
|
||||
The Prometheus Operator takes care of operating Prometheus and Alertmanagers clusters, however, there are many ways in Kubernetes to expose these to the outside world. This document outlines best practices and caveats to do so in various ways.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# Prometheus Operator
|
||||
|
||||
Operators were introduced by CoreOS as a class of software that operates other software, putting operational knowledge collected by humans into software. Read more in the [original blog post](https://coreos.com/blog/introducing-operators.html).
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# Running Exporters
|
||||
Running exporters and scraping them with Prometheus configured by the prometheus-operator.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,8 @@
|
|||
<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>
|
||||
|
||||
# Storage
|
||||
|
||||
To keep data cross deployments and version upgrades the data must be persisted to some volume other than `emptyDir`, to be able to reuse it by `Pod`s after an upgrade.
|
||||
|
|
|
|||
|
|
@ -26,7 +26,12 @@ import (
|
|||
)
|
||||
|
||||
const (
|
||||
firstParagraph = `# API Docs
|
||||
firstParagraph = `<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>
|
||||
|
||||
# API Docs
|
||||
|
||||
This Document documents the types introduced by the Prometheus Operator to be consumed by users.
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,12 @@ import (
|
|||
)
|
||||
|
||||
func printCompatMatrixDocs() {
|
||||
fmt.Println(`# Compatibility
|
||||
fmt.Println(`<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>
|
||||
|
||||
# Compatibility
|
||||
|
||||
The Prometheus Operator supports a number of Kubernetes and Prometheus releases.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue