/cluster-monitoring-operator

Manage the OpenShift monitoring stack
  1. Go 88.9%
  2. Shell 6.1%
  3. Makefile 2.4%
  4. Python 1.7%
  5. Dockerfile 0.9%
Switch branches/tags
Nothing to show
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching GitHub Desktop...

If nothing happens, download GitHub Desktop and try again.

Launching Xcode...

If nothing happens, download Xcode and try again.

Launching Visual Studio...

If nothing happens, download the GitHub extension for Visual Studio and try again.

@openshift-merge-robot
openshift-merge-robot Merge pull request #137 from brancz/fix-serving-certs 
*: Fix handling of serving certs CA bundle
Latest commit 1cff58e Oct 30, 2018
Permalink
Failed to load latest commit information.
Documentation *: Open source Apr 13, 2018
assets prometheus: Initialize serving certs ca with empty value Oct 30, 2018
cmd/operator vendor: Update Oct 29, 2018
examples example: rename to cluster-monitoring Apr 13, 2018
hack pkg: add option to disable telemeter Oct 9, 2018
jsonnet prometheus: Initialize serving certs ca with empty value Oct 30, 2018
manifests jsonnet,assets: bump and regenerate Oct 26, 2018
pkg prometheus: Initialize serving certs ca with empty value Oct 30, 2018
scripts Fix deploy-on-openshift.sh Oct 5, 2018
test/e2e *: Open source Apr 13, 2018
vendor vendor: Update Oct 29, 2018
.dockerignore Use openshift/origin-base as base container image Jun 28, 2018
.gitignore *: Use jsonnet to sync from kube-prometheus Jun 1, 2018
.travis.yml Makefile: container build operator with deps Aug 15, 2018
.yamllint Add yamllint configuration, run yamllint in Travis Apr 26, 2018
CHANGELOG.md *: Cut v0.0.6 Jun 6, 2018
CONTRIBUTING.md *: Open source Apr 13, 2018
DCO *: Open source Apr 13, 2018
Dockerfile Use golang builder Oct 18, 2018
Dockerfile.generate Makefile: improve dependencies Aug 2, 2018
Gopkg.lock vendor: Update Oct 29, 2018
Gopkg.toml vendor: Update Oct 29, 2018
Jenkinsfile *: Open source Apr 13, 2018
LICENSE Initial commit Apr 11, 2018
Makefile Fix deploy-on-openshift.sh Oct 5, 2018
OWNERS OWNERS: add lucas and sergiusz Aug 14, 2018
README.md Update integration of cluster components description Aug 15, 2018
VERSION Integrate into cluster version operator Sep 27, 2018
code-of-conduct.md *: Open source Apr 13, 2018
container.yaml Dockerfile: switch to multistage builds Oct 17, 2018

README.md

Cluster Monitoring Operator

The Cluster Monitoring Operator manages and updates the Prometheus-based monitoring stack deployed on top of OpenShift.

It contains the following components:

The deployed Prometheus Operator is meant to be leveraged by users to easily deploy new Prometheus setup for their application monitoring. The Prometheus instance (prometheus-k8s) is responsible for monitoring and alerting on cluster and OpenShift components. It should not be extended to monitor user applications. Alertmanager is a cluster-global component for handling alerts generated by all Prometheus instances deployed in that cluster.

Metrics are collected from the following components

Important: The Prometheus Operator managed by the Cluster Monitoring Operator will by default only look for ServiceMonitor resources in namespaces containing an openshift.io/cluster-monitoring label (with any value).

Contributing new component integrations

The Cluster Monitoring Operator has many builtin ServiceMonitor resources which enable discovering the metrics endpoints of a variety of well-known components. Only components that must be created before the cluster monitoring stack belong in this repository, in order to solve the cyclic dependencies of bootstrapping.

To register a new builtin component, make the following changes:

  • Add a new ServiceMonitor manifest file to jsonnet/prometheus.jsonnet. An example of this can be seen for the OpenShift component "kube-controllers", here.
  • Re-generate the go-bindata code, using the pkg/manifests/bindata.go make target. This will also create a new file in assets/prometheus-k8s/ according to the name given in the jsonnet code.
  • Add a constant in pkg/manifests/manifests.go which points to the new manifest file, from assets/.
  • Add a new Factory method in pkg/manifests/manifests.go which loads the manifest using the new constant.
  • Add a step to PrometheusTask in pkg/tasks/prometheus.go which creates the ServiceMonitor using the Factory new method.

To add new builtin recording or alerting rules:

Run make pkg/manifests/bindata.go after you modify the files and make sure to add the modified files to the commit. All rules are automatically created, so no additional code changes are necessary.

Roadmap

  • Monitor etcd
  • Adapt Tectonic inherited alerts with OpenShift operational knowledge

Testing

End-to-end tests

Run e2e-tests with make e2e-test. Clean up after e2e-tests with make e2e-clean