Skip to content

Commit 0c5ee47

Browse files
authored
Merge pull request #88673 from eromanova97/OBSDOCS-1462
OBSDOCS-1462: Update monitoring config map API reference content for OCP 4.18 release
2 parents 5e1d5b1 + 651a826 commit 0c5ee47

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
@@ -152,6 +152,8 @@ The `ClusterMonitoringConfiguration` resource defines settings that customize th
152152

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

155+
|userWorkload|*link:#userworkloadconfig[UserWorkloadConfig]|`UserWorkload` defines settings for the monitoring of user-defined projects.
156+
155157
|kubeStateMetrics|*link:#kubestatemetricsconfig[KubeStateMetricsConfig]|`KubeStateMetricsConfig` defines settings for the `kube-state-metrics` agent.
156158

157159
|metricsServer|*link:#metricsserverconfig[MetricsServerConfig]|`MetricsServer` defines settings for the Metrics Server component.
@@ -545,6 +547,10 @@ Appears in: link:#userworkloadconfiguration[UserWorkloadConfiguration]
545547
[options="header"]
546548
|===
547549
| Property | Type | Description
550+
|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`.
551+
552+
|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`.
553+
548554
|additionalAlertmanagerConfigs|[]link:#additionalalertmanagerconfig[AdditionalAlertmanagerConfig]|Configures additional Alertmanager instances that receive alerts from the Prometheus component. By default, no additional Alertmanager instances are configured.
549555

550556
|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.
@@ -610,7 +616,7 @@ link:#prometheusrestrictedconfig[PrometheusRestrictedConfig]
610616

611617
|oauth2|*monv1.OAuth2|Defines OAuth2 authentication settings for the remote write endpoint.
612618

613-
|proxyUrl|string|Defines an optional proxy URL. It is superseded by the cluster-wide proxy, if enabled.
619+
|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.
614620

615621
|queueConfig|*monv1.QueueConfig|Allows tuning configuration for remote write queue parameters.
616622

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

729+
|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`.
730+
723731
|logLevel|string|Defines the log level setting for Thanos Ruler. The possible values are `error`, `warn`, `info`, and `debug`. The default value is `info`.
724732

725733
|nodeSelector|map[string]string|Defines the nodes on which the Pods are scheduled.
@@ -736,6 +744,21 @@ Appears in: link:#userworkloadconfiguration[UserWorkloadConfiguration]
736744

737745
|===
738746

747+
== UserWorkloadConfig
748+
749+
=== Description
750+
751+
The `UserWorkloadConfig` resource defines settings for the monitoring of user-defined projects.
752+
753+
Appears in: link:#clustermonitoringconfiguration[ClusterMonitoringConfiguration]
754+
755+
[options="header"]
756+
|===
757+
| Property | Type | Description
758+
|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`.
759+
760+
|===
761+
739762
== UserWorkloadConfiguration
740763

741764
=== Description
@@ -753,4 +776,10 @@ The `UserWorkloadConfiguration` resource defines the settings responsible for us
753776

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

779+
|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.
780+
781+
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.
782+
783+
To make the resulting alerts and metrics visible to project users, the query expressions should return a `namespace` label with a non-empty value.
784+
756785
|===

0 commit comments

Comments
 (0)