openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 21:46:22 +01:00
Code Issues Releases Activity

OBSDOCS-844-update-cmo-config-map-ref-4.16

Browse Source
This commit is contained in:
Brian Burt
2024-05-28 12:57:24 -04:00
parent 39799f19e2
commit bc0edae01a
1 changed files with 21 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -142,8 +142,6 @@ The `ClusterMonitoringConfiguration` resource defines settings that customize th
|enableUserWorkload|*bool|`UserWorkloadEnabled` is a Boolean flag that enables monitoring for user-defined projects.
|k8sPrometheusAdapter|*link:#k8sprometheusadapter[K8sPrometheusAdapter]|`K8sPrometheusAdapter` defines settings for the Prometheus Adapter component.
|kubeStateMetrics|*link:#kubestatemetricsconfig[KubeStateMetricsConfig]|`KubeStateMetricsConfig` defines settings for the `kube-state-metrics` agent.
|metricsServer|*link:#metricsserverconfig[MetricsServerConfig]|`MetricsServer` defines settings for the Metrics Server component.
@@ -166,52 +164,6 @@ The `ClusterMonitoringConfiguration` resource defines settings that customize th
|===
== DedicatedServiceMonitors
=== Description
[IMPORTANT]
====
This setting is deprecated and is planned to be removed in a future {product-title} version.
In the current version, this setting still exists but has no effect.
====
You can use the `DedicatedServiceMonitors` resource to configure dedicated Service Monitors for the Prometheus Adapter
Appears in: link:#k8sprometheusadapter[K8sPrometheusAdapter]
[options="header"]
|===
| Property | Type | Description
|enabled|bool|When `enabled` is set to `true`, the Cluster Monitoring Operator (CMO) deploys a dedicated Service Monitor that exposes the kubelet `/metrics/resource` endpoint. This Service Monitor sets `honorTimestamps: true` and only keeps metrics that are relevant for the pod resource queries of Prometheus Adapter. Additionally, Prometheus Adapter is configured to use these dedicated metrics. Overall, this feature improves the consistency of Prometheus Adapter-based CPU usage measurements used by, for example, the `oc adm top pod` command or the Horizontal Pod Autoscaler.
|===
== K8sPrometheusAdapter
=== Description
The `K8sPrometheusAdapter` resource defines settings for the Prometheus Adapter component.
Appears in: link:#clustermonitoringconfiguration[ClusterMonitoringConfiguration]
[options="header"]
|===
| Property | Type | Description
|audit|*Audit|Defines the audit configuration used by the Prometheus Adapter instance. Possible profile values are: `metadata`, `request`, `requestresponse`, and `none`. The default value is `metadata`.
|nodeSelector|map[string]string|Defines the nodes on which the pods are scheduled.
|resources|*v1.ResourceRequirements|Defines resource requests and limits for the `PrometheusAdapter` container.
|tolerations|[]v1.Toleration|Defines tolerations for the pods.
|topologySpreadConstraints|[]v1.TopologySpreadConstraint|Defines a pod's topology spread constraints.
|dedicatedServiceMonitors|*link:#dedicatedservicemonitors[DedicatedServiceMonitors]|Defines dedicated service monitors.
|===
== KubeStateMetricsConfig
=== Description
@@ -237,16 +189,15 @@ Appears in: link:#clustermonitoringconfiguration[ClusterMonitoringConfiguration]
=== Description
:FeatureName: Metrics Server
include::snippets/technology-preview.adoc[leveloffset=+1]
The `MetricsServerConfig` resource defines settings for the Metrics Server component. Note that this setting only applies when the `TechPreviewNoUpgrade` feature gate is enabled.
The `MetricsServerConfig` resource defines settings for the Metrics Server component.
Appears in: link:#clustermonitoringconfiguration[ClusterMonitoringConfiguration]
[options="header"]
|===
| Property | Type | Description
|audit|*Audit|Defines the audit configuration used by the Metrics Server instance. Possible profile values are `Metadata`, `Request`, `RequestResponse`, and `None`. The default value is `Metadata`.
|nodeSelector|map[string]string|Defines the nodes on which the pods are scheduled.
|tolerations|[]v1.Toleration|Defines tolerations for the pods.
@@ -257,24 +208,6 @@ Appears in: link:#clustermonitoringconfiguration[ClusterMonitoringConfiguration]
|===
== PrometheusOperatorAdmissionWebhookConfig
=== Description
The `PrometheusOperatorAdmissionWebhookConfig` resource defines settings for the admission webhook workload for Prometheus Operator.
Appears in: link:#clustermonitoringconfiguration[ClusterMonitoringConfiguration]
[options="header"]
|===
| Property | Type | Description
|resources|*v1.ResourceRequirements|Defines resource requests and limits for the `prometheus-operator-admission-webhook` container.
|topologySpreadConstraints|[]v1.TopologySpreadConstraint|Defines a pod's topology spread constraints.
|===
== MonitoringPluginConfig
=== Description
@@ -573,6 +506,24 @@ link:#userworkloadconfiguration[UserWorkloadConfiguration]
|===
== PrometheusOperatorAdmissionWebhookConfig
=== Description
The `PrometheusOperatorAdmissionWebhookConfig` resource defines settings for the admission webhook workload for Prometheus Operator.
Appears in: link:#clustermonitoringconfiguration[ClusterMonitoringConfiguration]
[options="header"]
|===
| Property | Type | Description
|resources|*v1.ResourceRequirements|Defines resource requests and limits for the `prometheus-operator-admission-webhook` container.
|topologySpreadConstraints|[]v1.TopologySpreadConstraint|Defines a pod's topology spread constraints.
|===
== PrometheusRestrictedConfig
=== Description