mirrors/prometheus-operator
mirrors/prometheus-operator
1
0
Fork 0
mirror of https://github.com/prometheus-operator/prometheus-operator.git synced 2025-04-21 03:38:43 +00:00
Code Activity

Merge pull request from coreos/jonboulle-patch-1

Browse source 
README: minor formatting tweaks
This commit is contained in:
Frederic Branczyk 2017-01-02 16:58:19 +01:00 • committed by GitHub
commit 546941fabd
1 changed files with 17 additions and 20 deletions

37
README.md
View file

@ -7,7 +7,7 @@ for the alpha releases.
The Prometheus Operator for Kubernetes provides easy monitoring definitions for Kubernetes
services and deployment and management of Prometheus instances.
Once installed the Prometheus Operator provides the following features:
Once installed, the Prometheus Operator provides the following features:
* **Create/Destroy**: Easily launch a Prometheus instance for your Kubernetes namespace,
a specific application or team easily using the Operator.
@ -21,55 +21,52 @@ Once installed the Prometheus Operator provides the following features:
For an introduction to the Prometheus Operator, see the initial [blog
post](https://coreos.com/blog/the-prometheus-operator.html).
## [kube-prometheus](https://github.com/coreos/kube-prometheus)
## Prometheus Operator vs. kube-prometheus
The Prometheus Operator makes the Prometheus configuration Kubernetes native
and manages and operates Prometheus and Alertmanager clusters. It is a piece of
the puzzle regarding full end-to-end monitoring.
[kube-prometheus](https://github.com/coreos/kube-prometheus) is a collection of
manifests to help getting started monitoring Kubernetes itself and applications
running on top of it.
manifests to help getting started with monitoring Kubernetes itself and
applications running on top of it.
## Prerequisites
To run the Prometheus Operator version `0.2.0` and higher you need a Kubernetes
cluster version `1.5.0` or higher.
Version `>=0.2.0` of the Prometheus Operator requires a Kubernetes
cluster of version `>=1.5.0`. If you are just starting out with the
Prometheus Operator, it is highly recommended to use the latest version.
If you are just starting out with the Prometheus Operator, it is highly
encouraged to use the versions mentioned above.
If you have previously used the Prometheus Operator pre 1.5.0 releases of
kubernetes with the `0.1.0` version of it, see the [migration](#migration)
section.
If you have previously used pre-1.5.0 releases of Kubernetes with the `0.1.0`
version of the Prometheus Operator, see the [migration](#migration) section.
## Migration
The `PetSet` was deprecated in the `1.5.0` release of Kubernetes in favor of
the `StatefulSet`. As the Prometheus Operator used the `PetSet` in version
`0.1.0` those need to be migrated as we upgrade our Kubernetes cluster as well
`0.1.0`, those need to be migrated as we upgrade our Kubernetes cluster as well
as the Prometheus Operator.
First the Prometheus Operator needs to be shutdown. Once shutdown retrieve the
`PetSet`s that were generated by it. You can do so simply by finding all
`Prometheus` and `Alertmanager` objects created.
First the Prometheus Operator needs to be shut down. Once shut down, retrieve
the `PetSet`s that were generated by it. You can do so simply by finding all
`Prometheus` and `Alertmanager` objects created:
```
kubectl get prometheuses --all-namespaces
kubectl get alertmanagers --all-namespaces
```
For each `Prometheus` and `Alertmanger` object a respective `PetSet` with the
For each `Prometheus` and `Alertmanger` object, a respective `PetSet` with the
same name was created in the same namespace. Those `PetSet`s need to be
migrated according to the [official migration documentation](http://kubernetes.io/docs/tasks/manage-stateful-set/upgrade-pet-set-to-stateful-set/).
Once migrated and on a Kubernetes version `>=1.5.0` you can start the
Prometheus Operator of version `>=0.2.0` and up and the `StatefulSet` created
Once migrated and on Kubernetes version `>=1.5.0`, you can start the
Prometheus Operator of version `>=0.2.0`, and the `StatefulSet` created
in the migration will from now on be managed by the Prometheus Operator.
## Third party resources
The Operator acts on the following third party resources (TPRs):
The Operator acts on the following [third party resources (TPRs)](http://kubernetes.io/docs/user-guide/thirdpartyresources/):
* **[`Prometheus`](./Documentation/prometheus.md)**, which defines a desired Prometheus deployment.
The Operator ensures at all times that a deployment matching the resource definition is running.