Skip to content

Latest commit

 

History

History
63 lines (52 loc) · 3.52 KB

index.adoc

File metadata and controls

63 lines (52 loc) · 3.52 KB
// source code for the Cluster Monitoring Operator. Any changes made to this
// file will be overwritten when the content is re-generated. If you wish to
// make edits, read the docgen utility instructions in the source code for the
// CMO.
:_content-type: ASSEMBLY

ConfigMap reference for the Cluster Monitoring Operator

_attributes/common-attributes.adoc :context: configmap-reference-for-cluster-monitoring-operator

Cluster Monitoring Operator configuration reference

Parts of {product-title} cluster monitoring are configurable. The API is accessible by setting parameters defined in various config maps.

Depending on which part of the stack you want to configure, edit the following:

  • To configure monitoring components, edit the ConfigMap object named cluster-monitoring-config in the openshift-monitoring namespace. These configurations are defined by ClusterMonitoringConfiguration.

  • To configure monitoring components that monitor user-defined projects, edit the ConfigMap object named user-workload-monitoring-config in the openshift-user-workload-monitoring namespace. These configurations are defined by UserWorkloadConfiguration.

The configuration file itself is always defined under the config.yaml key in the config map data.

Note

  • Not all configuration parameters are exposed.

  • Configuring cluster monitoring is optional.

  • If a configuration does not exist or is empty, default values are used.

  • If the configuration is invalid YAML data, the Cluster Monitoring Operator stops reconciling the resources and reports Degraded=True in the status conditions of the Operator.