Skip to content

Commit 651a826

Browse files
committed
OBSDOCS-1462: Update monitoring config map API reference content for OCP 4.18 release
1 parent 03bfd3f commit 651a826

File tree

1 file changed

+30
-1
lines changed

1 file changed

+30
-1
lines changed

observability/monitoring/config-map-reference-for-the-cluster-monitoring-operator.adoc

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,8 @@ The `ClusterMonitoringConfiguration` resource defines settings that customize th
142142

143143
|enableUserWorkload|*bool|`UserWorkloadEnabled` is a Boolean flag that enables monitoring for user-defined projects.
144144

145+
|userWorkload|*link:#userworkloadconfig[UserWorkloadConfig]|`UserWorkload` defines settings for the monitoring of user-defined projects.
146+
145147
|kubeStateMetrics|*link:#kubestatemetricsconfig[KubeStateMetricsConfig]|`KubeStateMetricsConfig` defines settings for the `kube-state-metrics` agent.
146148

147149
|metricsServer|*link:#metricsserverconfig[MetricsServerConfig]|`MetricsServer` defines settings for the Metrics Server component.
@@ -535,6 +537,10 @@ Appears in: link:#userworkloadconfiguration[UserWorkloadConfiguration]
535537
[options="header"]
536538
|===
537539
| Property | Type | Description
540+
|scrapeInterval|string|Configures the default interval between consecutive scrapes in case the `ServiceMonitor` or `PodMonitor` resource does not specify any value. The interval must be set between 5 seconds and 5 minutes. The value can be expressed in: seconds (for example `30s`), minutes (for example `1m`) or a mix of minutes and seconds (for example `1m30s`). The default value is `30s`.
541+
542+
|evaluationInterval|string|Configures the default interval between rule evaluations in case the `PrometheusRule` resource does not specify any value. The interval must be set between 5 seconds and 5 minutes. The value can be expressed in: seconds (for example `30s`), minutes (for example `1m`) or a mix of minutes and seconds (for example `1m30s`). It only applies to `PrometheusRule` resources with the `openshift.io/prometheus-rule-evaluation-scope=\"leaf-prometheus\"` label. The default value is `30s`.
543+
538544
|additionalAlertmanagerConfigs|[]link:#additionalalertmanagerconfig[AdditionalAlertmanagerConfig]|Configures additional Alertmanager instances that receive alerts from the Prometheus component. By default, no additional Alertmanager instances are configured.
539545

540546
|enforcedLabelLimit|*uint64|Specifies a per-scrape limit on the number of labels accepted for a sample. If the number of labels exceeds this limit after metric relabeling, the entire scrape is treated as failed. The default value is `0`, which means that no limit is set.
@@ -600,7 +606,7 @@ link:#prometheusrestrictedconfig[PrometheusRestrictedConfig]
600606

601607
|oauth2|*monv1.OAuth2|Defines OAuth2 authentication settings for the remote write endpoint.
602608

603-
|proxyUrl|string|Defines an optional proxy URL. It is superseded by the cluster-wide proxy, if enabled.
609+
|proxyUrl|string|Defines an optional proxy URL. If the cluster-wide proxy is enabled, it replaces the proxyUrl setting. The cluster-wide proxy supports both HTTP and HTTPS proxies, with HTTPS taking precedence.
604610

605611
|queueConfig|*monv1.QueueConfig|Allows tuning configuration for remote write queue parameters.
606612

@@ -710,6 +716,8 @@ Appears in: link:#userworkloadconfiguration[UserWorkloadConfiguration]
710716
| Property | Type | Description
711717
|additionalAlertmanagerConfigs|[]link:#additionalalertmanagerconfig[AdditionalAlertmanagerConfig]|Configures how the Thanos Ruler component communicates with additional Alertmanager instances. The default value is `nil`.
712718

719+
|evaluationInterval|string|Configures the default interval between Prometheus rule evaluations in case the `PrometheusRule` resource does not specify any value. The interval must be set between 5 seconds and 5 minutes. The value can be expressed in: seconds (for example `30s`), minutes (for example `1m`) or a mix of minutes and seconds (for example `1m30s`). It applies to `PrometheusRule` resources without the `openshift.io/prometheus-rule-evaluation-scope=\"leaf-prometheus\"` label. The default value is `15s`.
720+
713721
|logLevel|string|Defines the log level setting for Thanos Ruler. The possible values are `error`, `warn`, `info`, and `debug`. The default value is `info`.
714722

715723
|nodeSelector|map[string]string|Defines the nodes on which the Pods are scheduled.
@@ -726,6 +734,21 @@ Appears in: link:#userworkloadconfiguration[UserWorkloadConfiguration]
726734

727735
|===
728736

737+
== UserWorkloadConfig
738+
739+
=== Description
740+
741+
The `UserWorkloadConfig` resource defines settings for the monitoring of user-defined projects.
742+
743+
Appears in: link:#clustermonitoringconfiguration[ClusterMonitoringConfiguration]
744+
745+
[options="header"]
746+
|===
747+
| Property | Type | Description
748+
|rulesWithoutLabelEnforcementAllowed|*bool|A Boolean flag that enables or disables the ability to deploy user-defined `PrometheusRules` objects for which the `namespace` label is not enforced to the namespace of the object. Such objects should be created in a namespace configured under the `namespacesWithoutLabelEnforcement` property of the `UserWorkloadConfiguration` resource. The default value is `true`.
749+
750+
|===
751+
729752
== UserWorkloadConfiguration
730753

731754
=== Description
@@ -743,4 +766,10 @@ The `UserWorkloadConfiguration` resource defines the settings responsible for us
743766

744767
|thanosRuler|*link:#thanosrulerconfig[ThanosRulerConfig]|Defines the settings for the Thanos Ruler component in user workload monitoring.
745768

769+
|namespacesWithoutLabelEnforcement|[]string|Defines the list of namespaces for which Prometheus and Thanos Ruler in user-defined monitoring do not enforce the `namespace` label value in `PrometheusRule` objects.
770+
771+
The `namespacesWithoutLabelEnforcement` property allows users to define recording and alerting rules that can query across multiple projects (not limited to user-defined projects) instead of deploying identical `PrometheusRule` objects in each user project.
772+
773+
To make the resulting alerts and metrics visible to project users, the query expressions should return a `namespace` label with a non-empty value.
774+
746775
|===

0 commit comments

Comments
 (0)