From c702f37e7ee1ded1cea810d32478874c6fffe0af Mon Sep 17 00:00:00 2001 From: Janelle Neczypor Date: Tue, 16 Sep 2025 14:50:35 -0700 Subject: [PATCH] OSDOCS-14495 --- modules/monitoring-about-managing-alerts.adoc | 2 +- ...ret-to-the-alertmanager-configuration.adoc | 8 +++---- ...-tolerations-to-monitoring-components.adoc | 8 +++---- ...labels-to-your-time-series-and-alerts.adoc | 8 +++---- modules/monitoring-common-terms.adoc | 14 +++++------ ...-for-monitoring-user-defined-projects.adoc | 12 +++++----- ...ng-configurable-monitoring-components.adoc | 8 +++---- ...configuring-a-persistent-volume-claim.adoc | 8 +++---- ...ert-routing-for-user-defined-projects.adoc | 8 +++---- ...rt-routing-user-defined-alerts-secret.adoc | 6 ++--- ...ng-configuring-external-alertmanagers.adoc | 8 +++---- ...toring-configuring-persistent-storage.adoc | 8 +++---- ...uring-pod-topology-spread-constraints.adoc | 8 +++---- ...ring-configuring-remote-write-storage.adoc | 8 +++---- ...d-attributes-in-user-defined-projects.adoc | 8 +++---- ...reating-cluster-id-labels-for-metrics.adoc | 12 +++++----- ...rting-rules-for-user-defined-projects.adoc | 8 +++---- ...monitoring-default-monitoring-targets.adoc | 20 ++++++++-------- ...rting-rules-for-user-defined-projects.adoc | 8 +++---- modules/monitoring-editing-silences.adoc | 8 +++---- ...stance-for-user-defined-alert-routing.adoc | 16 ++++++------- modules/monitoring-expiring-silences.adoc | 8 +++---- ...g-detailed-information-about-a-target.adoc | 16 ++++++------- ...ert-routing-for-user-defined-projects.adoc | 4 ++-- ...les-for-all-projects-in-a-single-view.adoc | 12 +++++----- ...rting-rules-for-user-defined-projects.adoc | 4 ++-- ...-and-size-for-prometheus-metrics-data.adoc | 8 +++---- ...on-time-for-thanos-ruler-metrics-data.adoc | 8 +++---- ...oring-monitoring-stack-in-ha-clusters.adoc | 4 ++-- ...itoring-components-to-different-nodes.adoc | 8 +++---- ...he-federation-endpoint-for-prometheus.adoc | 9 ++++++- ...s-for-all-projects-with-mon-dashboard.adoc | 20 ++++++++-------- ...r-defined-projects-with-mon-dashboard.adoc | 4 ++-- ...reviewing-monitoring-dashboards-admin.adoc | 8 +++---- ...ing-notifications-to-external-systems.adoc | 6 ++++- ...-log-levels-for-monitoring-components.adoc | 8 +++---- ...setting-query-log-file-for-prometheus.adoc | 8 +++---- ...vals-limits-for-user-defined-projects.adoc | 8 +++---- modules/monitoring-silencing-alerts.adoc | 8 +++---- ...specifying-how-a-service-is-monitored.adoc | 8 +++---- .../monitoring-support-considerations.adoc | 8 +++---- ...ing-targets-for-user-defined-projects.adoc | 8 +++---- ...ert-routing-for-user-defined-projects.adoc | 24 +++++++++---------- modules/monitoring-understanding-metrics.adoc | 8 +++---- ...ng-understanding-the-monitoring-stack.adoc | 16 ++++++------- observability/logging/about-logging.adoc | 2 +- .../about-ocp-monitoring.adoc | 6 +---- .../accessing-metrics-as-a-developer.adoc | 5 +--- ...uring-performance-and-scalability-uwm.adoc | 8 +++---- ...-monitoring-for-user-defined-projects.adoc | 13 +--------- 50 files changed, 222 insertions(+), 229 deletions(-) diff --git a/modules/monitoring-about-managing-alerts.adoc b/modules/monitoring-about-managing-alerts.adoc index 9ba92e54ed..2292dc27b0 100644 --- a/modules/monitoring-about-managing-alerts.adoc +++ b/modules/monitoring-about-managing-alerts.adoc @@ -9,7 +9,7 @@ In the {product-title}, the Alerting UI enables you to manage alerts, silences, and alerting rules. * *Alerting rules*. Alerting rules contain a set of conditions that outline a particular state within a cluster. Alerts are triggered when those conditions are true. An alerting rule can be assigned a severity that defines how the alerts are routed. -* *Alerts*. An alert is fired when the conditions defined in an alerting rule are true. Alerts provide a notification that a set of circumstances are apparent within an {product-title} cluster. +* *Alerts*. An alert is fired when the conditions defined in an alerting rule are true. Alerts provide a notification that a set of circumstances are apparent within your {product-title} cluster. * *Silences*. A silence can be applied to an alert to prevent notifications from being sent when the conditions for an alert are true. You can mute an alert after the initial notification, while you work on resolving the issue. [NOTE] diff --git a/modules/monitoring-adding-a-secret-to-the-alertmanager-configuration.adoc b/modules/monitoring-adding-a-secret-to-the-alertmanager-configuration.adoc index e9c89d680e..bff728efb9 100644 --- a/modules/monitoring-adding-a-secret-to-the-alertmanager-configuration.adoc +++ b/modules/monitoring-adding-a-secret-to-the-alertmanager-configuration.adoc @@ -30,14 +30,14 @@ After you add a secret to the config map, the secret is mounted as a volume at ` * You have created the `cluster-monitoring-config` config map. // end::CPM[] // tag::UWM[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // end::UWM[] * You have created the secret to be configured in Alertmanager in the `{namespace-name}` project. * You have installed the {oc-first}. diff --git a/modules/monitoring-assigning-tolerations-to-monitoring-components.adoc b/modules/monitoring-assigning-tolerations-to-monitoring-components.adoc index 10fcf9e248..13f7c22ab8 100644 --- a/modules/monitoring-assigning-tolerations-to-monitoring-components.adoc +++ b/modules/monitoring-assigning-tolerations-to-monitoring-components.adoc @@ -34,14 +34,14 @@ You can assign tolerations to the components that monitor user-defined projects, // end::CPM[] // tag::UWM[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists in the `openshift-user-workload-monitoring` namespace. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // end::UWM[] * You have installed the {oc-first}. diff --git a/modules/monitoring-attaching-additional-labels-to-your-time-series-and-alerts.adoc b/modules/monitoring-attaching-additional-labels-to-your-time-series-and-alerts.adoc index a8696b6ffb..49f0cf415a 100644 --- a/modules/monitoring-attaching-additional-labels-to-your-time-series-and-alerts.adoc +++ b/modules/monitoring-attaching-additional-labels-to-your-time-series-and-alerts.adoc @@ -28,14 +28,14 @@ You can attach custom labels to all time series and alerts leaving Prometheus by * You have created the `cluster-monitoring-config` `ConfigMap` object. // end::CPM[] // tag::UWM[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // end::UWM[] * You have installed the {oc-first}. diff --git a/modules/monitoring-common-terms.adoc b/modules/monitoring-common-terms.adoc index 06a6d0aef6..6855c09e0d 100644 --- a/modules/monitoring-common-terms.adoc +++ b/modules/monitoring-common-terms.adoc @@ -24,7 +24,7 @@ config map:: A config map provides a way to inject configuration data into pods. You can reference the data stored in a config map in a volume of type `ConfigMap`. Applications running in a pod can use this data. Container:: -A container is a lightweight and executable image that includes software and all its dependencies. Containers virtualize the operating system. As a result, you can run containers anywhere from a data center to a public or private cloud as well as a developer’s laptop. +A container is a lightweight and executable image that includes software and all its dependencies. Containers virtualize the operating system. As a result, you can run containers anywhere from a data center to a public or private cloud as well as a developer's laptop. custom resource (CR):: A CR is an extension of the Kubernetes API. You can create custom resources. @@ -61,7 +61,7 @@ node:: A compute machine in the {product-title} cluster. A node is either a virtual machine (VM) or a physical machine. Operator:: -The preferred method of packaging, deploying, and managing a Kubernetes application in an {product-title} cluster. An Operator takes human operational knowledge and encodes it into software that is packaged and shared with customers. +The preferred method of packaging, deploying, and managing a Kubernetes application in your {product-title} cluster. An Operator takes human operational knowledge and encodes it into software that is packaged and shared with customers. Operator Lifecycle Manager (OLM):: OLM helps you install, update, and manage the lifecycle of Kubernetes native applications. OLM is an open source toolkit designed to manage Operators in an effective, automated, and scalable way. @@ -85,16 +85,16 @@ Silences:: A silence can be applied to an alert to prevent notifications from being sent when the conditions for an alert are true. You can mute an alert after the initial notification, while you work on resolving the underlying issue. storage:: -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] {product-title} supports many types of storage, both for on-premise and cloud providers. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-dedicated[] {product-title} supports many types of storage on AWS and GCP. endif::openshift-dedicated[] -ifdef::openshift-rosa[] +ifdef::openshift-rosa,openshift-rosa-hcp[] {product-title} supports many types of storage on AWS. -endif::openshift-rosa[] -You can manage container storage for persistent and non-persistent data in an {product-title} cluster. +endif::openshift-rosa,openshift-rosa-hcp[] +You can manage container storage for persistent and non-persistent data in your {product-title} cluster. Thanos Ruler:: The Thanos Ruler is a rule evaluation engine for Prometheus that is deployed as a separate process. In {product-title}, Thanos Ruler provides rule and alerting evaluation for the monitoring of user-defined projects. diff --git a/modules/monitoring-components-for-monitoring-user-defined-projects.adoc b/modules/monitoring-components-for-monitoring-user-defined-projects.adoc index f7eb1abb83..7f8e764bc7 100644 --- a/modules/monitoring-components-for-monitoring-user-defined-projects.adoc +++ b/modules/monitoring-components-for-monitoring-user-defined-projects.adoc @@ -7,9 +7,9 @@ = Components for monitoring user-defined projects {product-title} -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] {product-version} -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] includes an optional enhancement to the monitoring stack that helps you monitor services and pods in user-defined projects. This feature includes the following components: .Components for monitoring user-defined projects @@ -26,9 +26,9 @@ includes an optional enhancement to the monitoring stack that helps you monitor |Thanos Ruler |The Thanos Ruler is a rule evaluation engine for Prometheus that is deployed as a separate process. In {product-title} -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] {product-version} -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] , Thanos Ruler provides rule and alerting evaluation for the monitoring of user-defined projects. |Alertmanager @@ -36,11 +36,11 @@ endif::openshift-dedicated,openshift-rosa[] |=== -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== The components in the preceding table are deployed after you enable monitoring for user-defined projects. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] The monitoring stack monitors all components for user-defined projects. The components are automatically updated when {product-title} is updated. diff --git a/modules/monitoring-configurable-monitoring-components.adoc b/modules/monitoring-configurable-monitoring-components.adoc index 05c44693cb..c8c4277422 100644 --- a/modules/monitoring-configurable-monitoring-components.adoc +++ b/modules/monitoring-configurable-monitoring-components.adoc @@ -25,12 +25,12 @@ This table shows the monitoring components you can configure and the keys used to specify the components in the `{configmap-name}` config map. // tag::UWM[] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [WARNING] ==== Do not modify the monitoring components in the `cluster-monitoring-config` `ConfigMap` object. Red{nbsp}Hat Site Reliability Engineers (SRE) use these components to monitor the core cluster components and Kubernetes services. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // end::UWM[] // tag::CPM[] @@ -55,7 +55,7 @@ endif::openshift-dedicated,openshift-rosa[] // end::CPM[] |==== -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [WARNING] ==== Different configuration changes to the `ConfigMap` object result in different outcomes: @@ -72,7 +72,7 @@ Different configuration changes to the `ConfigMap` object result in different ou Each procedure that requires a change in the config map includes its expected outcome. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // Unset the source code block attributes just to be safe. :!configmap-name: diff --git a/modules/monitoring-configuring-a-persistent-volume-claim.adoc b/modules/monitoring-configuring-a-persistent-volume-claim.adoc index de2413543a..a71a909e76 100644 --- a/modules/monitoring-configuring-a-persistent-volume-claim.adoc +++ b/modules/monitoring-configuring-a-persistent-volume-claim.adoc @@ -28,14 +28,14 @@ To use a persistent volume (PV) for monitoring components, you must configure a * You have created the `cluster-monitoring-config` `ConfigMap` object. // end::CPM[] // tag::UWM[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // end::UWM[] * You have installed the {oc-first}. diff --git a/modules/monitoring-configuring-alert-routing-for-user-defined-projects.adoc b/modules/monitoring-configuring-alert-routing-for-user-defined-projects.adoc index af8dffb2d8..1723d415f0 100644 --- a/modules/monitoring-configuring-alert-routing-for-user-defined-projects.adoc +++ b/modules/monitoring-configuring-alert-routing-for-user-defined-projects.adoc @@ -10,13 +10,13 @@ If you are a non-administrator user who has been given the `alert-routing-edit` .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * A cluster administrator has enabled monitoring for user-defined projects. * A cluster administrator has enabled alert routing for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * Alert routing has been enabled for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You are logged in as a user that has the `alert-routing-edit` cluster role for the project for which you want to create alert routing. * You have installed the {oc-first}. diff --git a/modules/monitoring-configuring-alert-routing-user-defined-alerts-secret.adoc b/modules/monitoring-configuring-alert-routing-user-defined-alerts-secret.adoc index 7e55af31ce..dae357e0c1 100644 --- a/modules/monitoring-configuring-alert-routing-user-defined-alerts-secret.adoc +++ b/modules/monitoring-configuring-alert-routing-user-defined-alerts-secret.adoc @@ -15,11 +15,11 @@ All features of a supported version of upstream Alertmanager are also supported .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role. * You have enabled a separate instance of Alertmanager for user-defined alert routing. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. endif::[] * You have installed the {oc-first}. diff --git a/modules/monitoring-configuring-external-alertmanagers.adoc b/modules/monitoring-configuring-external-alertmanagers.adoc index 5af519cc9a..b7c4d1de7f 100644 --- a/modules/monitoring-configuring-external-alertmanagers.adoc +++ b/modules/monitoring-configuring-external-alertmanagers.adoc @@ -39,14 +39,14 @@ If you add the same external Alertmanager configuration for multiple clusters an * You have created the `cluster-monitoring-config` `ConfigMap` object. // end::CPM[] // tag::UWM[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // end::UWM[] * You have installed the {oc-first}. diff --git a/modules/monitoring-configuring-persistent-storage.adoc b/modules/monitoring-configuring-persistent-storage.adoc index 3f1fb2b27c..6cd6f8bfb7 100644 --- a/modules/monitoring-configuring-persistent-storage.adoc +++ b/modules/monitoring-configuring-persistent-storage.adoc @@ -21,11 +21,11 @@ In multi-node clusters, you must configure persistent storage for Prometheus, Al [id="persistent-storage-prerequisites_{context}"] == Persistent storage prerequisites -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * Use the block type of storage. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * Dedicate sufficient persistent storage to ensure that the disk does not become full. * Use `Filesystem` as the storage type value for the `volumeMode` parameter when you configure the persistent volume. @@ -38,4 +38,4 @@ ifndef::openshift-dedicated,openshift-rosa[] For example, some NFS file system implementations are not POSIX compliant. If you want to use an NFS file system for storage, verify with the vendor that their NFS implementation is fully POSIX compliant. ==== -endif::openshift-dedicated,openshift-rosa[] \ No newline at end of file +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] \ No newline at end of file diff --git a/modules/monitoring-configuring-pod-topology-spread-constraints.adoc b/modules/monitoring-configuring-pod-topology-spread-constraints.adoc index 44aaceec59..ea900f1bb0 100644 --- a/modules/monitoring-configuring-pod-topology-spread-constraints.adoc +++ b/modules/monitoring-configuring-pod-topology-spread-constraints.adoc @@ -42,15 +42,15 @@ You can configure pod topology spread constraints for monitoring pods by using t * You have created the `cluster-monitoring-config` `ConfigMap` object. // end::CPM[] // tag::UWM[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // end::UWM[] * You have installed the {oc-first}. diff --git a/modules/monitoring-configuring-remote-write-storage.adoc b/modules/monitoring-configuring-remote-write-storage.adoc index 6a62cf1fc3..05dca06008 100644 --- a/modules/monitoring-configuring-remote-write-storage.adoc +++ b/modules/monitoring-configuring-remote-write-storage.adoc @@ -27,14 +27,14 @@ You can configure remote write storage to enable Prometheus to send ingested met * You have created the `cluster-monitoring-config` `ConfigMap` object. // end::CPM[] // tag::UWM[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // end::UWM[] * You have installed the {oc-first}. * You have set up a remote write compatible endpoint (such as Thanos) and know the endpoint URL. See the link:https://prometheus.io/docs/operating/integrations/#remote-endpoints-and-storage[Prometheus remote endpoints and storage documentation] for information about endpoints that are compatible with the remote write feature. diff --git a/modules/monitoring-controlling-the-impact-of-unbound-attributes-in-user-defined-projects.adoc b/modules/monitoring-controlling-the-impact-of-unbound-attributes-in-user-defined-projects.adoc index ede5fb096f..e74b3cda55 100644 --- a/modules/monitoring-controlling-the-impact-of-unbound-attributes-in-user-defined-projects.adoc +++ b/modules/monitoring-controlling-the-impact-of-unbound-attributes-in-user-defined-projects.adoc @@ -10,12 +10,12 @@ Developers can create labels to define attributes for metrics in the form of key Every assigned key-value pair has a unique time series. The use of many unbound attributes in labels can result in an exponential increase in the number of time series created. This can impact Prometheus performance and can consume a lot of disk space. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] Cluster administrators -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] A `dedicated-admin` -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] can use the following measures to control the impact of unbound metrics attributes in user-defined projects: * Limit the number of samples that can be accepted per target scrape in user-defined projects diff --git a/modules/monitoring-creating-cluster-id-labels-for-metrics.adoc b/modules/monitoring-creating-cluster-id-labels-for-metrics.adoc index 55feedc0aa..92014e660d 100644 --- a/modules/monitoring-creating-cluster-id-labels-for-metrics.adoc +++ b/modules/monitoring-creating-cluster-id-labels-for-metrics.adoc @@ -20,7 +20,7 @@ You can create cluster ID labels for metrics by adding the `write_relabel` settings for remote write storage in the `{configmap-name}` config map in the `{namespace-name}` namespace. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // tag::UWM[] [NOTE] ==== @@ -29,7 +29,7 @@ This behavior ensures that the final namespace label value is equal to the names You cannot override this default configuration by setting the value of the `honorLabels` field to `true` for `PodMonitor` or `ServiceMonitor` objects. ==== // end::UWM[] -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] .Prerequisites @@ -38,14 +38,14 @@ endif::openshift-dedicated,openshift-rosa[] * You have created the `cluster-monitoring-config` `ConfigMap` object. // end::CPM[] // tag::UWM[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` ConfigMap object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // end::UWM[] * You have installed the {oc-first}. * You have configured remote write storage. diff --git a/modules/monitoring-creating-cross-project-alerting-rules-for-user-defined-projects.adoc b/modules/monitoring-creating-cross-project-alerting-rules-for-user-defined-projects.adoc index f377d04355..58ac9957e3 100644 --- a/modules/monitoring-creating-cross-project-alerting-rules-for-user-defined-projects.adoc +++ b/modules/monitoring-creating-cross-project-alerting-rules-for-user-defined-projects.adoc @@ -12,14 +12,14 @@ Therefore, you can have generic alerting rules that apply to multiple user-defin .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * If you are a cluster administrator, you have access to the cluster as a user with the `cluster-admin` cluster role. * If you are a non-administrator user, you have access to the cluster as a user with the following user roles: ** The `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project to edit the `user-workload-monitoring-config` config map. ** The `monitoring-rules-edit` cluster role for the project where you want to create an alerting rule. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. + [NOTE] @@ -27,7 +27,7 @@ ifdef::openshift-dedicated,openshift-rosa[] If you are a non-administrator user, you can still create cross-project alerting rules if you have the `monitoring-rules-edit` cluster role for the project where you want to create an alerting rule. However, that project needs to be configured in the `user-workload-monitoring-config` config map under the `namespacesWithoutLabelEnforcement` property, which can be done only by cluster administrators. ==== * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have installed the {oc-first}. .Procedure diff --git a/modules/monitoring-default-monitoring-targets.adoc b/modules/monitoring-default-monitoring-targets.adoc index 1cdb350aba..d08e9a463d 100644 --- a/modules/monitoring-default-monitoring-targets.adoc +++ b/modules/monitoring-default-monitoring-targets.adoc @@ -6,15 +6,15 @@ [id="default-monitoring-targets_{context}"] = Default monitoring targets -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] In addition to the components of the stack itself, the default monitoring stack monitors additional platform components. The following are examples of monitoring targets: -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] The following are examples of targets monitored by Red{nbsp}Hat Site Reliability Engineers (SRE) in your {product-title} cluster: -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * CoreDNS * etcd @@ -24,20 +24,20 @@ endif::openshift-dedicated,openshift-rosa[] * Kubernetes API server * Kubernetes controller manager * Kubernetes scheduler -ifndef::openshift-rosa[] +ifndef::openshift-rosa,openshift-rosa-hcp[] * OpenShift API server * OpenShift Controller Manager * Operator Lifecycle Manager (OLM) -endif::openshift-rosa[] +endif::openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== The exact list of targets can vary depending on your cluster capabilities and installed components. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== * The exact list of targets can vary depending on your cluster capabilities and installed components. @@ -47,4 +47,4 @@ link:https://issues.redhat.com/secure/CreateIssueDetails!init.jspa?pid=12332330& ==== Other {product-title} framework components might be exposing metrics as well. For details, see their respective documentation. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/modules/monitoring-disabling-cross-project-alerting-rules-for-user-defined-projects.adoc b/modules/monitoring-disabling-cross-project-alerting-rules-for-user-defined-projects.adoc index cb1363eaeb..f8c9823891 100644 --- a/modules/monitoring-disabling-cross-project-alerting-rules-for-user-defined-projects.adoc +++ b/modules/monitoring-disabling-cross-project-alerting-rules-for-user-defined-projects.adoc @@ -13,12 +13,12 @@ Creating cross-project alerting rules for user-defined projects is enabled by de .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have installed the {oc-first}. .Procedure diff --git a/modules/monitoring-editing-silences.adoc b/modules/monitoring-editing-silences.adoc index 51fa0a60cf..91603b1b7f 100644 --- a/modules/monitoring-editing-silences.adoc +++ b/modules/monitoring-editing-silences.adoc @@ -11,12 +11,12 @@ You can edit a silence, which expires the existing silence and creates a new one .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * If you are a cluster administrator, you have access to the cluster as a user with the `cluster-admin` role. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * If you are a cluster administrator, you have access to the cluster as a user with the `dedicated-admin` role. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * If you are a non-administrator user, you have access to the cluster as a user with the following user roles: ** The `cluster-monitoring-view` cluster role, which allows you to access Alertmanager. ** The `monitoring-alertmanager-edit` role, which permits you to create and silence alerts. diff --git a/modules/monitoring-enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing.adoc b/modules/monitoring-enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing.adoc index add120d99d..166cf87cf9 100644 --- a/modules/monitoring-enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing.adoc +++ b/modules/monitoring-enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing.adoc @@ -6,21 +6,21 @@ [id="enabling-a-separate-alertmanager-instance-for-user-defined-alert-routing_{context}"] = Enabling a separate Alertmanager instance for user-defined alert routing -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] In some clusters, you might want to deploy a dedicated Alertmanager instance for user-defined projects, which can help reduce the load on the default platform Alertmanager instance and can better separate user-defined alerts from default platform alerts. endif::[] -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] In {product-title}, you may want to deploy a dedicated Alertmanager instance for user-defined projects, which provides user-defined alerts separate from default platform alerts. endif::[] In these cases, you can optionally enable a separate instance of Alertmanager to send alerts for user-defined projects only. .Prerequisites -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. endif::[] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role. * You have enabled monitoring for user-defined projects. endif::[] @@ -58,7 +58,7 @@ If you set this value to `false` or if the key is omitted, user-defined alerts a .Verification -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * Verify that the `user-workload` Alertmanager instance has started: + [source,terminal] @@ -73,10 +73,10 @@ $ oc -n openshift-user-workload-monitoring get alertmanager NAME VERSION REPLICAS AGE user-workload 0.24.0 2 100s ---- -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // In ROSA/OSD, a dedicated-admin doesn't have permission to view the alertmanager resource. -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * Verify that the `alert-manager-user-workload` pods are running: + [source,terminal] @@ -93,4 +93,4 @@ alertmanager-user-workload-0 6/6 Running 0 38s alertmanager-user-workload-1 6/6 Running 0 38s ... ---- -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/modules/monitoring-expiring-silences.adoc b/modules/monitoring-expiring-silences.adoc index 67f6dad4e7..29c13f090c 100644 --- a/modules/monitoring-expiring-silences.adoc +++ b/modules/monitoring-expiring-silences.adoc @@ -17,12 +17,12 @@ Expired silences older than 120 hours are garbage collected. .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * If you are a cluster administrator, you have access to the cluster as a user with the `cluster-admin` role. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * If you are a cluster administrator, you have access to the cluster as a user with the `dedicated-admin` role. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * If you are a non-administrator user, you have access to the cluster as a user with the following user roles: ** The `cluster-monitoring-view` cluster role, which allows you to access Alertmanager. ** The `monitoring-alertmanager-edit` role, which permits you to create and silence alerts. diff --git a/modules/monitoring-getting-detailed-information-about-a-target.adoc b/modules/monitoring-getting-detailed-information-about-a-target.adoc index 22d4d3af77..69fa1f3801 100644 --- a/modules/monitoring-getting-detailed-information-about-a-target.adoc +++ b/modules/monitoring-getting-detailed-information-about-a-target.adoc @@ -8,21 +8,21 @@ You can use the {product-title} web console to view, search, and filter the endpoints that are currently targeted for scraping, which helps you to identify and troubleshoot problems. For example, you can view the current status of targeted endpoints to see when {product-title} monitoring is not able to scrape metrics from a targeted component. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] The *Metrics targets* page shows targets for default {product-title} projects and for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] The *Metrics targets* page shows targets for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as an administrator for the project for which you want to view metrics targets. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] .Procedure diff --git a/modules/monitoring-granting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc b/modules/monitoring-granting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc index 4c38f6e90d..2457dcc99f 100644 --- a/modules/monitoring-granting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc +++ b/modules/monitoring-granting-users-permission-to-configure-alert-routing-for-user-defined-projects.adoc @@ -10,11 +10,11 @@ You can grant users permission to configure alert routing for user-defined proje .Prerequisites -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. endif::[] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role. * You have enabled monitoring for user-defined projects. endif::[] diff --git a/modules/monitoring-listing-alerting-rules-for-all-projects-in-a-single-view.adoc b/modules/monitoring-listing-alerting-rules-for-all-projects-in-a-single-view.adoc index b3f75b5fe4..777edfdd09 100644 --- a/modules/monitoring-listing-alerting-rules-for-all-projects-in-a-single-view.adoc +++ b/modules/monitoring-listing-alerting-rules-for-all-projects-in-a-single-view.adoc @@ -6,20 +6,20 @@ [id="listing-alerting-rules-for-all-projects-in-a-single-view_{context}"] = Listing alerting rules for all projects in a single view -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] As a cluster administrator, -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] As a `dedicated-admin`, -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] you can list alerting rules for core {product-title} and user-defined projects together in a single view. .Prerequisites -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. endif::[] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` role. endif::[] * You have installed the {oc-first}. diff --git a/modules/monitoring-managing-alerting-rules-for-user-defined-projects.adoc b/modules/monitoring-managing-alerting-rules-for-user-defined-projects.adoc index a612517845..c7aed4a214 100644 --- a/modules/monitoring-managing-alerting-rules-for-user-defined-projects.adoc +++ b/modules/monitoring-managing-alerting-rules-for-user-defined-projects.adoc @@ -9,12 +9,12 @@ In {product-title}, you can view, edit, and remove alerting rules in user-defined projects. -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] [IMPORTANT] ==== Managing alerting rules for user-defined projects is only available in {product-title} version 4.11 and later. ==== -endif::[] +endif::openshift-rosa,openshift-dedicated,openshift-rosa-hcp[] .Alerting rule considerations diff --git a/modules/monitoring-modifying-retention-time-and-size-for-prometheus-metrics-data.adoc b/modules/monitoring-modifying-retention-time-and-size-for-prometheus-metrics-data.adoc index 870933552e..82c73287e7 100644 --- a/modules/monitoring-modifying-retention-time-and-size-for-prometheus-metrics-data.adoc +++ b/modules/monitoring-modifying-retention-time-and-size-for-prometheus-metrics-data.adoc @@ -40,14 +40,14 @@ Data compaction occurs every two hours. Therefore, a persistent volume (PV) migh * You have created the `cluster-monitoring-config` `ConfigMap` object. // end::CPM[] // tag::UWM[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // end::UWM[] * You have installed the {oc-first}. diff --git a/modules/monitoring-modifying-the-retention-time-for-thanos-ruler-metrics-data.adoc b/modules/monitoring-modifying-the-retention-time-for-thanos-ruler-metrics-data.adoc index 31b63ded1d..06e3e339ae 100644 --- a/modules/monitoring-modifying-the-retention-time-for-thanos-ruler-metrics-data.adoc +++ b/modules/monitoring-modifying-the-retention-time-for-thanos-ruler-metrics-data.adoc @@ -10,14 +10,14 @@ By default, for user-defined projects, Thanos Ruler automatically retains metric .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have installed the {oc-first}. .Procedure diff --git a/modules/monitoring-monitoring-stack-in-ha-clusters.adoc b/modules/monitoring-monitoring-stack-in-ha-clusters.adoc index a0246553c4..0ab91bf3e8 100644 --- a/modules/monitoring-monitoring-stack-in-ha-clusters.adoc +++ b/modules/monitoring-monitoring-stack-in-ha-clusters.adoc @@ -11,11 +11,11 @@ By default, in multi-node clusters, the following components run in high-availab * Prometheus * Alertmanager * Thanos Ruler -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * Thanos Querier * Metrics Server * Monitoring plugin -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] The component is replicated across two pods, each running on a separate node. This means that the monitoring stack can tolerate the loss of one pod. diff --git a/modules/monitoring-moving-monitoring-components-to-different-nodes.adoc b/modules/monitoring-moving-monitoring-components-to-different-nodes.adoc index 328357dfb8..fb98d1ed2f 100644 --- a/modules/monitoring-moving-monitoring-components-to-different-nodes.adoc +++ b/modules/monitoring-moving-monitoring-components-to-different-nodes.adoc @@ -43,14 +43,14 @@ It is not permitted to move components to control plane or infrastructure nodes. // end::CPM[] // tag::UWM[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have installed the {oc-first}. // end::UWM[] diff --git a/modules/monitoring-querying-metrics-by-using-the-federation-endpoint-for-prometheus.adoc b/modules/monitoring-querying-metrics-by-using-the-federation-endpoint-for-prometheus.adoc index 0f17f06c65..edc2553f60 100644 --- a/modules/monitoring-querying-metrics-by-using-the-federation-endpoint-for-prometheus.adoc +++ b/modules/monitoring-querying-metrics-by-using-the-federation-endpoint-for-prometheus.adoc @@ -7,7 +7,14 @@ = Querying metrics by using the federation endpoint for Prometheus You can use the federation endpoint for Prometheus to scrape platform and user-defined metrics from a network location outside the cluster. -To do so, access the Prometheus `/federate` endpoint for the cluster via an {product-title} route. +To do so, access the Prometheus `/federate` endpoint for the cluster via +ifndef::openshift-rosa,openshift-hcp[] +an {product-title} +endif::openshift-rosa,openshift-hcp[] +ifdef::openshift-rosa,openshift-hcp[] +a {product-title} +endif::openshift-rosa,openshift-hcp[] +route. [IMPORTANT] ==== diff --git a/modules/monitoring-querying-metrics-for-all-projects-with-mon-dashboard.adoc b/modules/monitoring-querying-metrics-for-all-projects-with-mon-dashboard.adoc index 03871cf81f..84357f17b6 100644 --- a/modules/monitoring-querying-metrics-for-all-projects-with-mon-dashboard.adoc +++ b/modules/monitoring-querying-metrics-for-all-projects-with-mon-dashboard.adoc @@ -12,31 +12,31 @@ You can use the {product-title} metrics query browser to run Prometheus Query Language (PromQL) queries to examine metrics visualized on a plot. This functionality provides information about the state of a cluster and any user-defined workloads that you are monitoring. As a -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] cluster administrator -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] `dedicated-admin` -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] or as a user with view permissions for all projects, you can access metrics for all default {product-title} and user-defined projects in the Metrics UI. -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== Only dedicated administrators have access to the third-party UIs provided with {product-title} monitoring. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] The Metrics UI includes predefined queries, for example, CPU, memory, bandwidth, or network packet for all projects. You can also run custom Prometheus Query Language (PromQL) queries. .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role or with view permissions for all projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role or with view permissions for all projects. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have installed the {oc-first}. .Procedure diff --git a/modules/monitoring-querying-metrics-for-user-defined-projects-with-mon-dashboard.adoc b/modules/monitoring-querying-metrics-for-user-defined-projects-with-mon-dashboard.adoc index 10eeebb3af..1ae3adbf0f 100644 --- a/modules/monitoring-querying-metrics-for-user-defined-projects-with-mon-dashboard.adoc +++ b/modules/monitoring-querying-metrics-for-user-defined-projects-with-mon-dashboard.adoc @@ -13,12 +13,12 @@ As a developer, you must specify a project name when querying metrics. You must The Metrics UI includes predefined queries, for example, CPU, memory, bandwidth, or network packet. These queries are restricted to the selected project. You can also run custom Prometheus Query Language (PromQL) queries for the project. -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== Developers cannot access the third-party UIs provided with {product-title} monitoring. ==== -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] .Prerequisites diff --git a/modules/monitoring-reviewing-monitoring-dashboards-admin.adoc b/modules/monitoring-reviewing-monitoring-dashboards-admin.adoc index 24e200d891..d39d8e4e6b 100644 --- a/modules/monitoring-reviewing-monitoring-dashboards-admin.adoc +++ b/modules/monitoring-reviewing-monitoring-dashboards-admin.adoc @@ -12,12 +12,12 @@ include::snippets/unified-perspective-web-console.adoc[] .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] .Procedure diff --git a/modules/monitoring-sending-notifications-to-external-systems.adoc b/modules/monitoring-sending-notifications-to-external-systems.adoc index 5e61a1cdbf..b3af7fb051 100644 --- a/modules/monitoring-sending-notifications-to-external-systems.adoc +++ b/modules/monitoring-sending-notifications-to-external-systems.adoc @@ -7,7 +7,11 @@ [id="sending-notifications-to-external-systems_{context}"] = Sending notifications to external systems -In {product-title} {product-version}, firing alerts can be viewed in the Alerting UI. Alerts are not configured by default to be sent to any notification systems. You can configure {product-title} to send alerts to the following receiver types: +In {product-title} +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +{product-version} +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +, firing alerts can be viewed in the Alerting UI. Alerts are not configured by default to be sent to any notification systems. You can configure {product-title} to send alerts to the following receiver types: * PagerDuty * Webhook diff --git a/modules/monitoring-setting-log-levels-for-monitoring-components.adoc b/modules/monitoring-setting-log-levels-for-monitoring-components.adoc index adf62633c7..794a2b8c09 100644 --- a/modules/monitoring-setting-log-levels-for-monitoring-components.adoc +++ b/modules/monitoring-setting-log-levels-for-monitoring-components.adoc @@ -47,15 +47,15 @@ The following log levels can be applied to the relevant component in the `{confi * You have created the `cluster-monitoring-config` `ConfigMap` object. // end::CPM[] // tag::UWM[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // end::UWM[] * You have installed the {oc-first}. diff --git a/modules/monitoring-setting-query-log-file-for-prometheus.adoc b/modules/monitoring-setting-query-log-file-for-prometheus.adoc index 9e34d59c54..52119eb9f8 100644 --- a/modules/monitoring-setting-query-log-file-for-prometheus.adoc +++ b/modules/monitoring-setting-query-log-file-for-prometheus.adoc @@ -35,15 +35,15 @@ Because log rotation is not supported, only enable this feature temporarily when * You have created the `cluster-monitoring-config` `ConfigMap` object. // end::CPM[] // tag::UWM[] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] // end::UWM[] * You have installed the {oc-first}. diff --git a/modules/monitoring-setting-scrape-and-evaluation-intervals-limits-for-user-defined-projects.adoc b/modules/monitoring-setting-scrape-and-evaluation-intervals-limits-for-user-defined-projects.adoc index 92a7dba9af..a4e2cdc3a4 100644 --- a/modules/monitoring-setting-scrape-and-evaluation-intervals-limits-for-user-defined-projects.adoc +++ b/modules/monitoring-setting-scrape-and-evaluation-intervals-limits-for-user-defined-projects.adoc @@ -21,14 +21,14 @@ If you set sample or label limits, no further sample data is ingested for that t .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role, or as a user with the `user-workload-monitoring-config-edit` role in the `openshift-user-workload-monitoring` project. * A cluster administrator has enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role. * The `user-workload-monitoring-config` `ConfigMap` object exists. This object is created by default when the cluster is created. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have installed the {oc-first}. .Procedure diff --git a/modules/monitoring-silencing-alerts.adoc b/modules/monitoring-silencing-alerts.adoc index 2c53773212..c2744acd32 100644 --- a/modules/monitoring-silencing-alerts.adoc +++ b/modules/monitoring-silencing-alerts.adoc @@ -11,12 +11,12 @@ You can silence a specific alert or silence alerts that match a specification th .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * If you are a cluster administrator, you have access to the cluster as a user with the `cluster-admin` role. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * If you are a cluster administrator, you have access to the cluster as a user with the `dedicated-admin` role. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * If you are a non-administrator user, you have access to the cluster as a user with the following user roles: ** The `cluster-monitoring-view` cluster role, which allows you to access Alertmanager. ** The `monitoring-alertmanager-edit` role, which permits you to create and silence alerts. diff --git a/modules/monitoring-specifying-how-a-service-is-monitored.adoc b/modules/monitoring-specifying-how-a-service-is-monitored.adoc index 28f9744446..995fd87715 100644 --- a/modules/monitoring-specifying-how-a-service-is-monitored.adoc +++ b/modules/monitoring-specifying-how-a-service-is-monitored.adoc @@ -12,13 +12,13 @@ This procedure shows you how to create a `ServiceMonitor` resource for a service .Prerequisites -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `cluster-admin` cluster role or the `monitoring-edit` cluster role. * You have enabled monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * You have access to the cluster as a user with the `dedicated-admin` role or the `monitoring-edit` role. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * For this example, you have deployed the `prometheus-example-app` sample service in the `ns1` project. + [NOTE] diff --git a/modules/monitoring-support-considerations.adoc b/modules/monitoring-support-considerations.adoc index e6d10ae377..5660420483 100644 --- a/modules/monitoring-support-considerations.adoc +++ b/modules/monitoring-support-considerations.adoc @@ -13,7 +13,7 @@ Backward compatibility for metrics, recording rules, or alerting rules is not gu The following modifications are explicitly not supported: -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * *Creating additional `ServiceMonitor`, `PodMonitor`, and `PrometheusRule` objects in the `openshift-*` and `kube-*` projects.* * *Modifying any resources or objects deployed in the `openshift-monitoring` or `openshift-user-workload-monitoring` projects.* The resources created by the {product-title} monitoring stack are not meant to be used by any other resources, as there are no guarantees about their backward compatibility. + @@ -30,9 +30,9 @@ This procedure is a supported exception to the preceding statement. * *Enabling symptom based monitoring by using the `Probe` custom resource definition (CRD) in Prometheus Operator.* * *Manually deploying monitoring resources into namespaces that have the `openshift.io/cluster-monitoring: "true"` label.* * *Adding the `openshift.io/cluster-monitoring: "true"` label to namespaces.* This label is reserved only for the namespaces with core {product-title} components and Red{nbsp}Hat certified components. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * *Installing custom Prometheus instances on {product-title}.* A custom instance is a Prometheus custom resource (CR) managed by the Prometheus Operator. -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * *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. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/modules/monitoring-targets-for-user-defined-projects.adoc b/modules/monitoring-targets-for-user-defined-projects.adoc index 817526103e..3e52fc328a 100644 --- a/modules/monitoring-targets-for-user-defined-projects.adoc +++ b/modules/monitoring-targets-for-user-defined-projects.adoc @@ -6,13 +6,13 @@ [id="monitoring-targets-for-user-defined-projects_{context}"] = Monitoring targets for user-defined projects -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] When monitoring is enabled for user-defined projects, you can monitor: -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] -ifdef::openshift-dedicated,openshift-rosa[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] Monitoring is enabled by default for {product-title} user-defined projects. You can monitor: -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] * Metrics provided through service endpoints in user-defined projects. * Pods running in user-defined projects. diff --git a/modules/monitoring-understanding-alert-routing-for-user-defined-projects.adoc b/modules/monitoring-understanding-alert-routing-for-user-defined-projects.adoc index 00373dfc23..f13b52e7fa 100644 --- a/modules/monitoring-understanding-alert-routing-for-user-defined-projects.adoc +++ b/modules/monitoring-understanding-alert-routing-for-user-defined-projects.adoc @@ -7,32 +7,32 @@ = Understanding alert routing for user-defined projects [role="_abstract"] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] As a cluster administrator, you can enable alert routing for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] As a `dedicated-admin`, you can enable alert routing for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] With this feature, you can allow users with the `alert-routing-edit` cluster role to configure alert notification routing and receivers for user-defined projects. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] These notifications are routed by the default Alertmanager instance or, if enabled, an optional Alertmanager instance dedicated to user-defined monitoring. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] These notifications are routed by an Alertmanager instance dedicated to user-defined monitoring. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] Users can then create and configure user-defined alert routing by creating or editing the `AlertmanagerConfig` objects for their user-defined projects without the help of an administrator. -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] After a user has defined alert routing for a user-defined project, user-defined alert notifications are routed as follows: * To the `alertmanager-main` pods in the `openshift-monitoring` namespace if using the default platform Alertmanager instance. * To the `alertmanager-user-workload` pods in the `openshift-user-workload-monitoring` namespace if you have enabled a separate instance of Alertmanager for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] After a user has defined alert routing for a user-defined project, user-defined alert notifications are routed to the `alertmanager-user-workload` pods in the `openshift-user-workload-monitoring` namespace. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] [NOTE] ==== diff --git a/modules/monitoring-understanding-metrics.adoc b/modules/monitoring-understanding-metrics.adoc index 76c2308666..43859614f3 100644 --- a/modules/monitoring-understanding-metrics.adoc +++ b/modules/monitoring-understanding-metrics.adoc @@ -7,12 +7,12 @@ = Understanding metrics [role="_abstract"] -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] In {product-title} {product-version}, -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] In {product-title}, -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] cluster components are monitored by scraping metrics exposed through service endpoints. You can also configure metrics collection for user-defined projects. Metrics enable you to monitor how cluster components and your own workloads are performing. You can define the metrics that you want to provide for your own workloads by using Prometheus client libraries at the application level. diff --git a/modules/monitoring-understanding-the-monitoring-stack.adoc b/modules/monitoring-understanding-the-monitoring-stack.adoc index 33f381ee4a..94bce283b7 100644 --- a/modules/monitoring-understanding-the-monitoring-stack.adoc +++ b/modules/monitoring-understanding-the-monitoring-stack.adoc @@ -10,22 +10,22 @@ The monitoring stack includes the following components: Default platform monitoring components:: -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] A set of platform monitoring components are installed in the `openshift-monitoring` project by default during an {product-title} installation. This provides monitoring for core cluster components including Kubernetes services. The default monitoring stack also enables remote health monitoring for clusters. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] A set of platform monitoring components are installed in the `openshift-monitoring` project by default during a {product-title} installation. Red{nbsp}Hat Site Reliability Engineers (SRE) use these components to monitor core cluster components including Kubernetes services. This includes critical metrics, such as CPU and memory, collected from all of the workloads in every namespace. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] + You can see these components in the *Installed by default* section in the following diagram. Components for monitoring user-defined projects:: -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] If you enable monitoring for user-defined projects, additional monitoring components are installed in the `openshift-user-workload-monitoring` project. This provides optional monitoring for user-defined projects. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] A set of user-defined project monitoring components are installed in the `openshift-user-workload-monitoring` project by default during a {product-title} installation. You can use these components to monitor services and pods in user-defined projects. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] + You can see these components in the *User* section in the following diagram. diff --git a/observability/logging/about-logging.adoc b/observability/logging/about-logging.adoc index 9614cc5118..09fa38f00a 100644 --- a/observability/logging/about-logging.adoc +++ b/observability/logging/about-logging.adoc @@ -7,7 +7,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] -As a cluster administrator, you can deploy {logging} on an {product-title} cluster, and use it to collect and aggregate node system audit logs, application container logs, and infrastructure logs. +As a cluster administrator, you can deploy {logging} on your {product-title} cluster, and use it to collect and aggregate node system audit logs, application container logs, and infrastructure logs. You can use {logging} to perform the following tasks: diff --git a/observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc b/observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc index eff25d9161..cf1e4d735e 100644 --- a/observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc +++ b/observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc @@ -20,11 +20,7 @@ endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] In {product-title}, you can monitor your own projects in isolation from Red{nbsp}Hat Site Reliability Engineering (SRE) platform metrics. You can monitor your own projects without the need for an additional monitoring solution. -The {product-title} -ifdef::openshift-rosa,openshift-rosa-hcp[] -(ROSA) -endif::openshift-rosa,openshift-rosa-hcp[] -monitoring stack is based on the link:https://prometheus.io/[Prometheus] open source project and its wider ecosystem. +The {product-title} monitoring stack is based on the link:https://prometheus.io/[Prometheus] open source project and its wider ecosystem. endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] diff --git a/observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc b/observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc index 79a5c48484..3d18b86778 100644 --- a/observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc +++ b/observability/monitoring/accessing-metrics/accessing-metrics-as-a-developer.adoc @@ -33,7 +33,4 @@ include::modules/monitoring-reviewing-monitoring-dashboards-developer.adoc[level .Additional resources * xref:../../../observability/monitoring/about-ocp-monitoring/key-concepts.adoc#about-monitoring-dashboards_key-concepts[About monitoring dashboards] -* xref:../../../applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc#monitoring-project-and-application-metrics-using-developer-perspective[Monitoring project and application metrics using the Developer perspective] - - - +* xref:../../../applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc#monitoring-project-and-application-metrics-using-developer-perspective[Monitoring project and application metrics using the Developer perspective] \ No newline at end of file diff --git a/observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc b/observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc index e4ab25db9c..62b1edf03f 100644 --- a/observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc +++ b/observability/monitoring/configuring-user-workload-monitoring/configuring-performance-and-scalability-uwm.adoc @@ -65,12 +65,12 @@ include::modules/monitoring-specifying-limits-and-requests-for-monitoring-compon [id="controlling-the-impact-of-unbound-attributes-in-user-defined-projects_{context}"] == Controlling the impact of unbound metrics attributes in user-defined projects -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] Cluster administrators -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] A `dedicated-admin` -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] can use the following measures to control the impact of unbound metrics attributes in user-defined projects: * Limit the number of samples that can be accepted per target scrape in user-defined projects diff --git a/observability/monitoring/getting-started/sd-accessing-monitoring-for-user-defined-projects.adoc b/observability/monitoring/getting-started/sd-accessing-monitoring-for-user-defined-projects.adoc index dfe9084010..b35f89543d 100644 --- a/observability/monitoring/getting-started/sd-accessing-monitoring-for-user-defined-projects.adoc +++ b/observability/monitoring/getting-started/sd-accessing-monitoring-for-user-defined-projects.adoc @@ -6,18 +6,7 @@ include::_attributes/attributes-openshift-dedicated.adoc[] toc::[] -When you install a {product-title} -ifdef::openshift-rosa[] -(ROSA) -endif::openshift-rosa[] -cluster, monitoring for user-defined projects is enabled by default. With monitoring for user-defined projects enabled, you can monitor your own -ifdef::openshift-rosa[] -ROSA -endif::openshift-rosa[] -ifdef::openshift-dedicated[] -{product-title} -endif::openshift-dedicated[] -projects without the need for an additional monitoring solution. +When you install a {product-title} cluster, monitoring for user-defined projects is enabled by default. With monitoring for user-defined projects enabled, you can monitor your own {product-title} projects without the need for an additional monitoring solution. The `dedicated-admin` user has default permissions to configure and access monitoring for user-defined projects.