okd/roles/openshift_cluster_monitoring_operator/README.md

OpenShift Cluster Monitoring Operator

This role installs the OpenShift Cluster Monitoring Operator, which manages and updates the Prometheus-based monitoring stack deployed on top of OpenShift.

NOTE: This component is unsupported in OCP at this time.

Installation

To install the monitoring operator, set this variable:

openshift_cluster_monitoring_operator_install: true

To uninstall, set:

openshift_cluster_monitoring_operator_install: false

Configuring Alertmanager

The Monitoring Operator comes with a default no-op Alertmanager configuration. To supply a new configuration, set:

openshift_cluster_monitoring_operator_alertmanager_config: |+
  global:
    # ...
  route:
    # ...
  receivers:
    # ...

The value of the variable should be a complete Alertmanager configuration file.

Monitoring new components

To integrate a new OpenShift component with monitoring, follow the Cluster Monitoring Operator docs for contributing new components.

License

Apache License, Version 2.0