Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 2. Getting started

2.1. Maintenance and support for monitoring
Copy link

You can configure OpenShift Dedicated monitoring by using supported configuration options in the Cluster Monitoring Operator. Using only supported options ensures your monitoring configuration persists across cluster upgrades and Prometheus version changes.

Configuration paradigms might change across Prometheus releases, and such cases can only be handled gracefully if all configuration possibilities are controlled. If you use unsupported configurations, your changes will disappear because the CMO automatically reconciles any differences and resets any unsupported changes back to the originally defined state by default and by design.

Important

Installing another Prometheus instance is not supported by the Red Hat Site Reliability Engineers (SRE).

2.1.1. Support considerations for monitoring
Copy link

You can avoid automated configuration resets by understanding and adhering to the supported configuration options for the OpenShift Dedicated monitoring stack. Unsupported modifications are automatically reverted.

Note

Backward compatibility for metrics, recording rules, or alerting rules is not guaranteed.

The following modifications are explicitly not supported:

  • Installing custom Prometheus instances on OpenShift Dedicated. A custom instance is a Prometheus custom resource (CR) managed by the Prometheus Operator.
  • Modifying the default platform monitoring components. You should not modify any of the components defined in the cluster-monitoring-config config map. Red Hat SRE uses these components to monitor the core cluster components and Kubernetes services.

You can verify the supported versions of Prometheus, Alertmanager, and other monitoring components for each OpenShift Dedicated release by consulting this version compatibility matrix for releases 4.12 and later.

Expand
Table 2.1. OpenShift Dedicated and component versions
OpenShift DedicatedPrometheus OperatorPrometheusMetrics ServerAlertmanagerkube-state-metrics agentmonitoring-pluginnode-exporter agentThanos

4.20

0.85.0

3.5.0

0.8.0

0.28.1

2.16.0

1.0.0

1.9.1

0.39.2

4.19

0.81.0

3.2.1

0.7.2

0.28.1

2.15.0

1.0.0

1.9.1

0.37.2

4.18

0.78.1

2.55.1

0.7.2

0.27.0

2.13.0

1.0.0

1.8.2

0.36.1

4.17

0.75.2

2.53.1

0.7.1

0.27.0

2.13.0

1.0.0

1.8.2

0.35.1

4.16

0.73.2

2.52.0

0.7.1

0.26.0

2.12.0

1.0.0

1.8.0

0.35.0

4.15

0.70.0

2.48.0

0.6.4

0.26.0

2.10.1

1.0.0

1.7.0

0.32.5

4.14

0.67.1

2.46.0

N/A

0.25.0

2.9.2

1.0.0

1.6.1

0.30.2

4.13

0.63.0

2.42.0

N/A

0.25.0

2.8.1

N/A

1.5.0

0.30.2

4.12

0.60.1

2.39.1

N/A

0.24.0

2.6.0

N/A

1.4.0

0.28.1

Note

The openshift-state-metrics agent and Telemeter Client are OpenShift Dedicated-specific components. Therefore, their versions correspond with the versions of OpenShift Dedicated.

2.2. Disable monitoring for user-defined projects
Copy link

You can disable monitoring for user-defined projects to reduce resource consumption or exclude specific projects when they have custom monitoring solutions. This provides flexibility in managing cluster monitoring resources for your workloads.

2.2.1. Monitoring for user-defined projects
Copy link

You can monitor your own OpenShift Dedicated projects without requiring an additional monitoring solution. OpenShift Dedicated enables this capability by default when you install a cluster, allowing you to track metrics and performance for your custom workloads.

The dedicated-admin user has default permissions to configure and access monitoring for user-defined projects.

Optionally, you can disable monitoring for user-defined projects during or after a cluster installation.

Note

Custom Prometheus instances and the Prometheus Operator installed through Operator Lifecycle Manager (OLM) can cause issues with user-defined project monitoring if it is enabled. Custom Prometheus instances are not supported.

You can disable the built-in monitoring for user-defined projects when you plan to use an external monitoring solution or need to reduce cluster resource consumption.

Prerequisites

Procedure

  1. From the OpenShift Cluster Manager Hybrid Cloud Console, select a cluster.
  2. Click the Settings tab.

  3. Click the Enable user workload monitoring checkbox to clear the option, and then click Save.

    User workload monitoring is disabled. The Prometheus, Prometheus Operator, and Thanos Ruler components are stopped in the openshift-user-workload-monitoring project.

You can exclude individual user-defined projects from monitoring to reduce resource consumption or when projects use custom monitoring solutions. Exclusion is controlled by applying a label to the project namespace.

Procedure

  1. Add the label to the project namespace: 

    $ oc label namespace my-project 'openshift.io/user-monitoring=false'

  2. To re-enable monitoring, remove the label from the namespace: 

    $ oc label namespace my-project 'openshift.io/user-monitoring-'
    Note

    If there were any active monitoring targets for the project, it can take a few minutes for Prometheus to stop scraping them after adding the label.

Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Legal Notice

Theme

© 2026 Red HatBack to top