openshift-docs/rest_api/config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc

// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="clustermonitoring-config-openshift-io-v1alpha1"]
= ClusterMonitoring [config.openshift.io/v1alpha1]
:toc: macro
:toc-title:

toc::[]


Description::
+
--
ClusterMonitoring is the Custom Resource object which holds the current status of Cluster Monitoring Operator. CMO is a central component of the monitoring stack.

Compatibility level 4: No compatibility is provided, the API can change at any point for any reason. These capabilities should not be used by applications needing long term support.
ClusterMonitoring is the Schema for the Cluster Monitoring Operators API
--

Type::
  `object`

Required::
  - `spec`


== Specification

[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiVersion`
| `string`
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

| `kind`
| `string`
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

| `metadata`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

| `spec`
| `object`
| spec holds user configuration for the Cluster Monitoring Operator

| `status`
| `object`
| status holds observed values from the cluster. They may not be overridden.

|===
=== .spec
Description::
+
--
spec holds user configuration for the Cluster Monitoring Operator
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `alertmanagerConfig`
| `object`
| alertmanagerConfig allows users to configure how the default Alertmanager instance
should be deployed in the `openshift-monitoring` namespace.
alertmanagerConfig is optional.
When omitted, this means no opinion and the platform is left to choose a reasonable default, that is subject to change over time.
The current default value is `DefaultConfig`.

| `metricsServerConfig`
| `object`
| metricsServerConfig is an optional field that can be used to configure the Kubernetes Metrics Server that runs in the openshift-monitoring namespace.
Specifically, it can configure how the Metrics Server instance is deployed, pod scheduling, its audit policy and log verbosity.
When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time.

| `userDefined`
| `object`
| userDefined set the deployment mode for user-defined monitoring in addition to the default platform monitoring.
userDefined is optional.
When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time.
The current default value is `Disabled`.

|===
=== .spec.alertmanagerConfig
Description::
+
--
alertmanagerConfig allows users to configure how the default Alertmanager instance
should be deployed in the `openshift-monitoring` namespace.
alertmanagerConfig is optional.
When omitted, this means no opinion and the platform is left to choose a reasonable default, that is subject to change over time.
The current default value is `DefaultConfig`.
--

Type::
  `object`

Required::
  - `deploymentMode`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `customConfig`
| `object`
| customConfig must be set when deploymentMode is CustomConfig, and must be unset otherwise.
When set to CustomConfig, the Alertmanager will be deployed with custom configuration.

| `deploymentMode`
| `string`
| deploymentMode determines whether the default Alertmanager instance should be deployed
as part of the monitoring stack.
Allowed values are Disabled, DefaultConfig, and CustomConfig.
When set to Disabled, the Alertmanager instance will not be deployed.
When set to DefaultConfig, the platform will deploy Alertmanager with default settings.
When set to CustomConfig, the Alertmanager will be deployed with custom configuration.

|===
=== .spec.alertmanagerConfig.customConfig
Description::
+
--
customConfig must be set when deploymentMode is CustomConfig, and must be unset otherwise.
When set to CustomConfig, the Alertmanager will be deployed with custom configuration.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `logLevel`
| `string`
| logLevel defines the verbosity of logs emitted by Alertmanager.
This field allows users to control the amount and severity of logs generated, which can be useful
for debugging issues or reducing noise in production environments.
Allowed values are Error, Warn, Info, and Debug.
When set to Error, only errors will be logged.
When set to Warn, both warnings and errors will be logged.
When set to Info, general information, warnings, and errors will all be logged.
When set to Debug, detailed debugging information will be logged.
When omitted, this means no opinion and the platform is left to choose a reasonable default, that is subject to change over time.
The current default value is `Info`.

| `nodeSelector`
| `object (string)`
| nodeSelector defines the nodes on which the Pods are scheduled
nodeSelector is optional.

When omitted, this means the user has no opinion and the platform is left
to choose reasonable defaults. These defaults are subject to change over time.
The current default value is `kubernetes.io/os: linux`.

| `resources`
| `array`
| resources defines the compute resource requests and limits for the Alertmanager container.
This includes CPU, memory and HugePages constraints to help control scheduling and resource usage.
When not specified, defaults are used by the platform. Requests cannot exceed limits.
This field is optional.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
This is a simplified API that maps to Kubernetes ResourceRequirements.
The current default values are:
  resources:
   - name: cpu
     request: 4m
     limit: null
   - name: memory
     request: 40Mi
     limit: null
Maximum length for this list is 10.
Minimum length for this list is 1.

| `resources[]`
| `object`
| ContainerResource defines a single resource requirement for a container.

| `secrets`
| `array (string)`
| secrets defines a list of secrets that need to be mounted into the Alertmanager.
The secrets must reside within the same namespace as the Alertmanager object.
They will be added as volumes named secret-<secret-name> and mounted at
/etc/alertmanager/secrets/<secret-name> within the 'alertmanager' container of
the Alertmanager Pods.

These secrets can be used to authenticate Alertmanager with endpoint receivers.
For example, you can use secrets to:
- Provide certificates for TLS authentication with receivers that require private CA certificates
- Store credentials for Basic HTTP authentication with receivers that require password-based auth
- Store any other authentication credentials needed by your alert receivers

This field is optional.
Maximum length for this list is 10.
Minimum length for this list is 1.
Entries in this list must be unique.

| `tolerations`
| `array`
| tolerations defines tolerations for the pods.
tolerations is optional.

When omitted, this means the user has no opinion and the platform is left
to choose reasonable defaults. These defaults are subject to change over time.
Defaults are empty/unset.
Maximum length for this list is 10
Minimum length for this list is 1

| `tolerations[]`
| `object`
| The pod this Toleration is attached to tolerates any taint that matches
the triple <key,value,effect> using the matching operator <operator>.

| `topologySpreadConstraints`
| `array`
| topologySpreadConstraints defines rules for how Alertmanager Pods should be distributed
across topology domains such as zones, nodes, or other user-defined labels.
topologySpreadConstraints is optional.
This helps improve high availability and resource efficiency by avoiding placing
too many replicas in the same failure domain.

When omitted, this means no opinion and the platform is left to choose a default, which is subject to change over time.
This field maps directly to the `topologySpreadConstraints` field in the Pod spec.
Default is empty list.
Maximum length for this list is 10.
Minimum length for this list is 1
Entries must have unique topologyKey and whenUnsatisfiable pairs.

| `topologySpreadConstraints[]`
| `object`
| TopologySpreadConstraint specifies how to spread matching pods among the given topology.

| `volumeClaimTemplate`
| `object`
| volumeClaimTemplate Defines persistent storage for Alertmanager. Use this setting to
configure the persistent volume claim, including storage class, volume
size, and name.
If omitted, the Pod uses ephemeral storage and alert data will not persist
across restarts.
This field is optional.

|===
=== .spec.alertmanagerConfig.customConfig.resources
Description::
+
--
resources defines the compute resource requests and limits for the Alertmanager container.
This includes CPU, memory and HugePages constraints to help control scheduling and resource usage.
When not specified, defaults are used by the platform. Requests cannot exceed limits.
This field is optional.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
This is a simplified API that maps to Kubernetes ResourceRequirements.
The current default values are:
  resources:
   - name: cpu
     request: 4m
     limit: null
   - name: memory
     request: 40Mi
     limit: null
Maximum length for this list is 10.
Minimum length for this list is 1.
--

Type::
  `array`




=== .spec.alertmanagerConfig.customConfig.resources[]
Description::
+
--
ContainerResource defines a single resource requirement for a container.
--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `limit`
| `integer-or-string`
| limit is the maximum amount of the resource allowed (e.g. "2Mi", "1Gi").
This field is optional.
When request is specified, limit cannot be less than request.
The value must be greater than 0 when specified.

| `name`
| `string`
| name of the resource (e.g. "cpu", "memory", "hugepages-2Mi").
This field is required.
name must consist only of alphanumeric characters, `-`, `_` and `.` and must start and end with an alphanumeric character.

| `request`
| `integer-or-string`
| request is the minimum amount of the resource required (e.g. "2Mi", "1Gi").
This field is optional.
When limit is specified, request cannot be greater than limit.

|===
=== .spec.alertmanagerConfig.customConfig.tolerations
Description::
+
--
tolerations defines tolerations for the pods.
tolerations is optional.

When omitted, this means the user has no opinion and the platform is left
to choose reasonable defaults. These defaults are subject to change over time.
Defaults are empty/unset.
Maximum length for this list is 10
Minimum length for this list is 1
--

Type::
  `array`




=== .spec.alertmanagerConfig.customConfig.tolerations[]
Description::
+
--
The pod this Toleration is attached to tolerates any taint that matches
the triple <key,value,effect> using the matching operator <operator>.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `effect`
| `string`
| Effect indicates the taint effect to match. Empty means match all taint effects.
When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

| `key`
| `string`
| Key is the taint key that the toleration applies to. Empty means match all taint keys.
If the key is empty, operator must be Exists; this combination means to match all values and all keys.

| `operator`
| `string`
| Operator represents a key's relationship to the value.
Valid operators are Exists and Equal. Defaults to Equal.
Exists is equivalent to wildcard for value, so that a pod can
tolerate all taints of a particular category.

| `tolerationSeconds`
| `integer`
| TolerationSeconds represents the period of time the toleration (which must be
of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
it is not set, which means tolerate the taint forever (do not evict). Zero and
negative values will be treated as 0 (evict immediately) by the system.

| `value`
| `string`
| Value is the taint value the toleration matches to.
If the operator is Exists, the value should be empty, otherwise just a regular string.

|===
=== .spec.alertmanagerConfig.customConfig.topologySpreadConstraints
Description::
+
--
topologySpreadConstraints defines rules for how Alertmanager Pods should be distributed
across topology domains such as zones, nodes, or other user-defined labels.
topologySpreadConstraints is optional.
This helps improve high availability and resource efficiency by avoiding placing
too many replicas in the same failure domain.

When omitted, this means no opinion and the platform is left to choose a default, which is subject to change over time.
This field maps directly to the `topologySpreadConstraints` field in the Pod spec.
Default is empty list.
Maximum length for this list is 10.
Minimum length for this list is 1
Entries must have unique topologyKey and whenUnsatisfiable pairs.
--

Type::
  `array`




=== .spec.alertmanagerConfig.customConfig.topologySpreadConstraints[]
Description::
+
--
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
--

Type::
  `object`

Required::
  - `maxSkew`
  - `topologyKey`
  - `whenUnsatisfiable`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `labelSelector`
| `object`
| LabelSelector is used to find matching pods.
Pods that match this label selector are counted to determine the number of pods
in their corresponding topology domain.

| `matchLabelKeys`
| `array (string)`
| MatchLabelKeys is a set of pod label keys to select the pods over which
spreading will be calculated. The keys are used to lookup values from the
incoming pod labels, those key-value labels are ANDed with labelSelector
to select the group of existing pods over which spreading will be calculated
for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
MatchLabelKeys cannot be set when LabelSelector isn't set.
Keys that don't exist in the incoming pod labels will
be ignored. A null or empty list means only match against labelSelector.

This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).

| `maxSkew`
| `integer`
| MaxSkew describes the degree to which pods may be unevenly distributed.
When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference
between the number of matching pods in the target topology and the global minimum.
The global minimum is the minimum number of matching pods in an eligible domain
or zero if the number of eligible domains is less than MinDomains.
For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
labelSelector spread as 2/2/1:
In this case, the global minimum is 1.
\| zone1 \| zone2 \| zone3 \|
\|  P P  \|  P P  \|   P   \|
- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
violate MaxSkew(1).
- if MaxSkew is 2, incoming pod can be scheduled onto any zone.
When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence
to topologies that satisfy it.
It's a required field. Default value is 1 and 0 is not allowed.

| `minDomains`
| `integer`
| MinDomains indicates a minimum number of eligible domains.
When the number of eligible domains with matching topology keys is less than minDomains,
Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed.
And when the number of eligible domains with matching topology keys equals or greater than minDomains,
this value has no effect on scheduling.
As a result, when the number of eligible domains is less than minDomains,
scheduler won't schedule more than maxSkew Pods to those domains.
If value is nil, the constraint behaves as if MinDomains is equal to 1.
Valid values are integers greater than 0.
When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
labelSelector spread as 2/2/2:
\| zone1 \| zone2 \| zone3 \|
\|  P P  \|  P P  \|  P P  \|
The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0.
In this situation, new pod with the same labelSelector cannot be scheduled,
because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
it will violate MaxSkew.

| `nodeAffinityPolicy`
| `string`
| NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector
when calculating pod topology spread skew. Options are:
- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

If this value is nil, the behavior is equivalent to the Honor policy.

| `nodeTaintsPolicy`
| `string`
| NodeTaintsPolicy indicates how we will treat node taints when calculating
pod topology spread skew. Options are:
- Honor: nodes without taints, along with tainted nodes for which the incoming pod
has a toleration, are included.
- Ignore: node taints are ignored. All nodes are included.

If this value is nil, the behavior is equivalent to the Ignore policy.

| `topologyKey`
| `string`
| TopologyKey is the key of node labels. Nodes that have a label with this key
and identical values are considered to be in the same topology.
We consider each <key, value> as a "bucket", and try to put balanced number
of pods into each bucket.
We define a domain as a particular instance of a topology.
Also, we define an eligible domain as a domain whose nodes meet the requirements of
nodeAffinityPolicy and nodeTaintsPolicy.
e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology.
And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology.
It's a required field.

| `whenUnsatisfiable`
| `string`
| WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
the spread constraint.
- DoNotSchedule (default) tells the scheduler not to schedule it.
- ScheduleAnyway tells the scheduler to schedule the pod in any location,
  but giving higher precedence to topologies that would help reduce the
  skew.
A constraint is considered "Unsatisfiable" for an incoming pod
if and only if every possible node assignment for that pod would violate
"MaxSkew" on some topology.
For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
labelSelector spread as 3/1/1:
\| zone1 \| zone2 \| zone3 \|
\| P P P \|   P   \|   P   \|
If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
won't make it *more* imbalanced.
It's a required field.

|===
=== .spec.alertmanagerConfig.customConfig.topologySpreadConstraints[].labelSelector
Description::
+
--
LabelSelector is used to find matching pods.
Pods that match this label selector are counted to determine the number of pods
in their corresponding topology domain.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.alertmanagerConfig.customConfig.topologySpreadConstraints[].labelSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.alertmanagerConfig.customConfig.topologySpreadConstraints[].labelSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.alertmanagerConfig.customConfig.volumeClaimTemplate
Description::
+
--
volumeClaimTemplate Defines persistent storage for Alertmanager. Use this setting to
configure the persistent volume claim, including storage class, volume
size, and name.
If omitted, the Pod uses ephemeral storage and alert data will not persist
across restarts.
This field is optional.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiVersion`
| `string`
| APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

| `kind`
| `string`
| Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

| `metadata`
| `object`
| Standard object's metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

| `spec`
| `object`
| spec defines the desired characteristics of a volume requested by a pod author.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

| `status`
| `object`
| status represents the current information/status of a persistent volume claim.
Read-only.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

|===
=== .spec.alertmanagerConfig.customConfig.volumeClaimTemplate.metadata
Description::
+
--
Standard object's metadata.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
--

Type::
  `object`




=== .spec.alertmanagerConfig.customConfig.volumeClaimTemplate.spec
Description::
+
--
spec defines the desired characteristics of a volume requested by a pod author.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `accessModes`
| `array (string)`
| accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

| `dataSource`
| `object`
| dataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.

| `dataSourceRef`
| `object`
| dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef:
* While dataSource only allows two specific types of objects, dataSourceRef
  allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
  preserves all values, and generates an error if a disallowed value is
  specified.
* While dataSource only allows local objects, dataSourceRef allows objects
  in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

| `resources`
| `object`
| resources represents the minimum resources the volume should have.
If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

| `selector`
| `object`
| selector is a label query over volumes to consider for binding.

| `storageClassName`
| `string`
| storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

| `volumeAttributesClassName`
| `string`
| volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
it can be changed after the claim is created. An empty string or nil value indicates that no
VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,
this field can be reset to its previous value (including nil) to cancel the modification.
If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
exists.
More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/

| `volumeMode`
| `string`
| volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.

| `volumeName`
| `string`
| volumeName is the binding reference to the PersistentVolume backing this claim.

|===
=== .spec.alertmanagerConfig.customConfig.volumeClaimTemplate.spec.dataSource
Description::
+
--
dataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.
--

Type::
  `object`

Required::
  - `kind`
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiGroup`
| `string`
| APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.

| `kind`
| `string`
| Kind is the type of resource being referenced

| `name`
| `string`
| Name is the name of resource being referenced

|===
=== .spec.alertmanagerConfig.customConfig.volumeClaimTemplate.spec.dataSourceRef
Description::
+
--
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef:
* While dataSource only allows two specific types of objects, dataSourceRef
  allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
  preserves all values, and generates an error if a disallowed value is
  specified.
* While dataSource only allows local objects, dataSourceRef allows objects
  in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
--

Type::
  `object`

Required::
  - `kind`
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiGroup`
| `string`
| APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.

| `kind`
| `string`
| Kind is the type of resource being referenced

| `name`
| `string`
| Name is the name of resource being referenced

| `namespace`
| `string`
| Namespace is the namespace of resource being referenced
Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.
(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

|===
=== .spec.alertmanagerConfig.customConfig.volumeClaimTemplate.spec.resources
Description::
+
--
resources represents the minimum resources the volume should have.
If RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `limits`
| `integer-or-string`
| Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

| `requests`
| `integer-or-string`
| Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

|===
=== .spec.alertmanagerConfig.customConfig.volumeClaimTemplate.spec.selector
Description::
+
--
selector is a label query over volumes to consider for binding.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.alertmanagerConfig.customConfig.volumeClaimTemplate.spec.selector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.alertmanagerConfig.customConfig.volumeClaimTemplate.spec.selector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.alertmanagerConfig.customConfig.volumeClaimTemplate.status
Description::
+
--
status represents the current information/status of a persistent volume claim.
Read-only.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `accessModes`
| `array (string)`
| accessModes contains the actual access modes the volume backing the PVC has.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

| `allocatedResourceStatuses`
| `object (string)`
| allocatedResourceStatuses stores status of resource being resized for the given PVC.
Key names follow standard Kubernetes label syntax. Valid values are either:
	* Un-prefixed keys:
		- storage - the capacity of the volume.
	* Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered
reserved and hence may not be used.

ClaimResourceStatus can be in any of following states:
	- ControllerResizeInProgress:
		State set when resize controller starts resizing the volume in control-plane.
	- ControllerResizeFailed:
		State set when resize has failed in resize controller with a terminal error.
	- NodeResizePending:
		State set when resize controller has finished resizing the volume but further resizing of
		volume is needed on the node.
	- NodeResizeInProgress:
		State set when kubelet starts resizing the volume.
	- NodeResizeFailed:
		State set when resizing has failed in kubelet with a terminal error. Transient errors don't set
		NodeResizeFailed.
For example: if expanding a PVC for more capacity - this field can be one of the following states:
	- pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress"
     - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed"
     - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending"
     - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress"
     - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed"
When this field is not set, it means that no resize operation is in progress for the given PVC.

A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus
should ignore the update for the purpose it was designed. For example - a controller that
only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid
resources associated with PVC.

This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.

| `allocatedResources`
| `integer-or-string`
| allocatedResources tracks the resources allocated to a PVC including its capacity.
Key names follow standard Kubernetes label syntax. Valid values are either:
	* Un-prefixed keys:
		- storage - the capacity of the volume.
	* Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered
reserved and hence may not be used.

Capacity reported here may be larger than the actual capacity when a volume expansion operation
is requested.
For storage quota, the larger value from allocatedResources and PVC.spec.resources is used.
If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation.
If a volume expansion capacity request is lowered, allocatedResources is only
lowered if there are no expansion operations in progress and if the actual volume capacity
is equal or lower than the requested capacity.

A controller that receives PVC update with previously unknown resourceName
should ignore the update for the purpose it was designed. For example - a controller that
only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid
resources associated with PVC.

This is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.

| `capacity`
| `integer-or-string`
| capacity represents the actual resources of the underlying volume.

| `conditions`
| `array`
| conditions is the current Condition of persistent volume claim. If underlying persistent volume is being
resized then the Condition will be set to 'Resizing'.

| `conditions[]`
| `object`
| PersistentVolumeClaimCondition contains details about state of pvc

| `currentVolumeAttributesClassName`
| `string`
| currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using.
When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim

| `modifyVolumeStatus`
| `object`
| ModifyVolumeStatus represents the status object of ControllerModifyVolume operation.
When this is unset, there is no ModifyVolume operation being attempted.

| `phase`
| `string`
| phase represents the current phase of PersistentVolumeClaim.

|===
=== .spec.alertmanagerConfig.customConfig.volumeClaimTemplate.status.conditions
Description::
+
--
conditions is the current Condition of persistent volume claim. If underlying persistent volume is being
resized then the Condition will be set to 'Resizing'.
--

Type::
  `array`




=== .spec.alertmanagerConfig.customConfig.volumeClaimTemplate.status.conditions[]
Description::
+
--
PersistentVolumeClaimCondition contains details about state of pvc
--

Type::
  `object`

Required::
  - `status`
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `lastProbeTime`
| `string`
| lastProbeTime is the time we probed the condition.

| `lastTransitionTime`
| `string`
| lastTransitionTime is the time the condition transitioned from one status to another.

| `message`
| `string`
| message is the human-readable message indicating details about last transition.

| `reason`
| `string`
| reason is a unique, this should be a short, machine understandable string that gives the reason
for condition's last transition. If it reports "Resizing" that means the underlying
persistent volume is being resized.

| `status`
| `string`
| Status is the status of the condition.
Can be True, False, Unknown.
More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required

| `type`
| `string`
| Type is the type of the condition.
More info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=set%20to%20%27ResizeStarted%27.-,PersistentVolumeClaimCondition,-contains%20details%20about

|===
=== .spec.alertmanagerConfig.customConfig.volumeClaimTemplate.status.modifyVolumeStatus
Description::
+
--
ModifyVolumeStatus represents the status object of ControllerModifyVolume operation.
When this is unset, there is no ModifyVolume operation being attempted.
--

Type::
  `object`

Required::
  - `status`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `status`
| `string`
| status is the status of the ControllerModifyVolume operation. It can be in any of following states:
 - Pending
   Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as
   the specified VolumeAttributesClass not existing.
 - InProgress
   InProgress indicates that the volume is being modified.
 - Infeasible
  Infeasible indicates that the request has been rejected as invalid by the CSI driver. To
	  resolve the error, a valid VolumeAttributesClass needs to be specified.
Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.

| `targetVolumeAttributesClassName`
| `string`
| targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled

|===
=== .spec.metricsServerConfig
Description::
+
--
metricsServerConfig is an optional field that can be used to configure the Kubernetes Metrics Server that runs in the openshift-monitoring namespace.
Specifically, it can configure how the Metrics Server instance is deployed, pod scheduling, its audit policy and log verbosity.
When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `audit`
| `object`
| audit defines the audit configuration used by the Metrics Server instance.
audit is optional.
When omitted, this means no opinion and the platform is left to choose a reasonable default, that is subject to change over time.
The current default sets audit.profile to Metadata

| `nodeSelector`
| `object (string)`
| nodeSelector defines the nodes on which the Pods are scheduled
nodeSelector is optional.

When omitted, this means the user has no opinion and the platform is left
to choose reasonable defaults. These defaults are subject to change over time.
The current default value is `kubernetes.io/os: linux`.

| `resources`
| `array`
| resources defines the compute resource requests and limits for the Metrics Server container.
This includes CPU, memory and HugePages constraints to help control scheduling and resource usage.
When not specified, defaults are used by the platform. Requests cannot exceed limits.
This field is optional.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
This is a simplified API that maps to Kubernetes ResourceRequirements.
The current default values are:
  resources:
   - name: cpu
     request: 4m
     limit: null
   - name: memory
     request: 40Mi
     limit: null
Maximum length for this list is 10.
Minimum length for this list is 1.

| `resources[]`
| `object`
| ContainerResource defines a single resource requirement for a container.

| `tolerations`
| `array`
| tolerations defines tolerations for the pods.
tolerations is optional.

When omitted, this means the user has no opinion and the platform is left
to choose reasonable defaults. These defaults are subject to change over time.
Defaults are empty/unset.
Maximum length for this list is 10
Minimum length for this list is 1

| `tolerations[]`
| `object`
| The pod this Toleration is attached to tolerates any taint that matches
the triple <key,value,effect> using the matching operator <operator>.

| `topologySpreadConstraints`
| `array`
| topologySpreadConstraints defines rules for how Metrics Server Pods should be distributed
across topology domains such as zones, nodes, or other user-defined labels.
topologySpreadConstraints is optional.
This helps improve high availability and resource efficiency by avoiding placing
too many replicas in the same failure domain.

When omitted, this means no opinion and the platform is left to choose a default, which is subject to change over time.
This field maps directly to the `topologySpreadConstraints` field in the Pod spec.
Default is empty list.
Maximum length for this list is 10.
Minimum length for this list is 1
Entries must have unique topologyKey and whenUnsatisfiable pairs.

| `topologySpreadConstraints[]`
| `object`
| TopologySpreadConstraint specifies how to spread matching pods among the given topology.

| `verbosity`
| `string`
| verbosity defines the verbosity of log messages for Metrics Server.
Valid values are Errors, Info, Trace, TraceAll and omitted.
When set to Errors, only critical messages and errors are logged.
When set to Info, only basic information messages are logged.
When set to Trace, information useful for general debugging is logged.
When set to TraceAll, detailed information about metric scraping is logged.
When omitted, this means no opinion and the platform is left to choose a reasonable default, that is subject to change over time.
The current default value is `Errors`

|===
=== .spec.metricsServerConfig.audit
Description::
+
--
audit defines the audit configuration used by the Metrics Server instance.
audit is optional.
When omitted, this means no opinion and the platform is left to choose a reasonable default, that is subject to change over time.
The current default sets audit.profile to Metadata
--

Type::
  `object`

Required::
  - `profile`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `profile`
| `string`
| profile is a required field for configuring the audit log level of the Kubernetes Metrics Server.
Allowed values are None, Metadata, Request, or RequestResponse.
When set to None, audit logging is disabled and no audit events are recorded.
When set to Metadata, only request metadata (such as requesting user, timestamp, resource, verb, etc.) is logged, but not the request or response body.
When set to Request, event metadata and the request body are logged, but not the response body.
When set to RequestResponse, event metadata, request body, and response body are all logged, providing the most detailed audit information.

See: https://kubernetes.io/docs/tasks/debug-application-cluster/audit/#audit-policy
for more information about auditing and log levels.

|===
=== .spec.metricsServerConfig.resources
Description::
+
--
resources defines the compute resource requests and limits for the Metrics Server container.
This includes CPU, memory and HugePages constraints to help control scheduling and resource usage.
When not specified, defaults are used by the platform. Requests cannot exceed limits.
This field is optional.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
This is a simplified API that maps to Kubernetes ResourceRequirements.
The current default values are:
  resources:
   - name: cpu
     request: 4m
     limit: null
   - name: memory
     request: 40Mi
     limit: null
Maximum length for this list is 10.
Minimum length for this list is 1.
--

Type::
  `array`




=== .spec.metricsServerConfig.resources[]
Description::
+
--
ContainerResource defines a single resource requirement for a container.
--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `limit`
| `integer-or-string`
| limit is the maximum amount of the resource allowed (e.g. "2Mi", "1Gi").
This field is optional.
When request is specified, limit cannot be less than request.
The value must be greater than 0 when specified.

| `name`
| `string`
| name of the resource (e.g. "cpu", "memory", "hugepages-2Mi").
This field is required.
name must consist only of alphanumeric characters, `-`, `_` and `.` and must start and end with an alphanumeric character.

| `request`
| `integer-or-string`
| request is the minimum amount of the resource required (e.g. "2Mi", "1Gi").
This field is optional.
When limit is specified, request cannot be greater than limit.

|===
=== .spec.metricsServerConfig.tolerations
Description::
+
--
tolerations defines tolerations for the pods.
tolerations is optional.

When omitted, this means the user has no opinion and the platform is left
to choose reasonable defaults. These defaults are subject to change over time.
Defaults are empty/unset.
Maximum length for this list is 10
Minimum length for this list is 1
--

Type::
  `array`




=== .spec.metricsServerConfig.tolerations[]
Description::
+
--
The pod this Toleration is attached to tolerates any taint that matches
the triple <key,value,effect> using the matching operator <operator>.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `effect`
| `string`
| Effect indicates the taint effect to match. Empty means match all taint effects.
When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

| `key`
| `string`
| Key is the taint key that the toleration applies to. Empty means match all taint keys.
If the key is empty, operator must be Exists; this combination means to match all values and all keys.

| `operator`
| `string`
| Operator represents a key's relationship to the value.
Valid operators are Exists and Equal. Defaults to Equal.
Exists is equivalent to wildcard for value, so that a pod can
tolerate all taints of a particular category.

| `tolerationSeconds`
| `integer`
| TolerationSeconds represents the period of time the toleration (which must be
of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
it is not set, which means tolerate the taint forever (do not evict). Zero and
negative values will be treated as 0 (evict immediately) by the system.

| `value`
| `string`
| Value is the taint value the toleration matches to.
If the operator is Exists, the value should be empty, otherwise just a regular string.

|===
=== .spec.metricsServerConfig.topologySpreadConstraints
Description::
+
--
topologySpreadConstraints defines rules for how Metrics Server Pods should be distributed
across topology domains such as zones, nodes, or other user-defined labels.
topologySpreadConstraints is optional.
This helps improve high availability and resource efficiency by avoiding placing
too many replicas in the same failure domain.

When omitted, this means no opinion and the platform is left to choose a default, which is subject to change over time.
This field maps directly to the `topologySpreadConstraints` field in the Pod spec.
Default is empty list.
Maximum length for this list is 10.
Minimum length for this list is 1
Entries must have unique topologyKey and whenUnsatisfiable pairs.
--

Type::
  `array`




=== .spec.metricsServerConfig.topologySpreadConstraints[]
Description::
+
--
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
--

Type::
  `object`

Required::
  - `maxSkew`
  - `topologyKey`
  - `whenUnsatisfiable`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `labelSelector`
| `object`
| LabelSelector is used to find matching pods.
Pods that match this label selector are counted to determine the number of pods
in their corresponding topology domain.

| `matchLabelKeys`
| `array (string)`
| MatchLabelKeys is a set of pod label keys to select the pods over which
spreading will be calculated. The keys are used to lookup values from the
incoming pod labels, those key-value labels are ANDed with labelSelector
to select the group of existing pods over which spreading will be calculated
for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
MatchLabelKeys cannot be set when LabelSelector isn't set.
Keys that don't exist in the incoming pod labels will
be ignored. A null or empty list means only match against labelSelector.

This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).

| `maxSkew`
| `integer`
| MaxSkew describes the degree to which pods may be unevenly distributed.
When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference
between the number of matching pods in the target topology and the global minimum.
The global minimum is the minimum number of matching pods in an eligible domain
or zero if the number of eligible domains is less than MinDomains.
For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
labelSelector spread as 2/2/1:
In this case, the global minimum is 1.
\| zone1 \| zone2 \| zone3 \|
\|  P P  \|  P P  \|   P   \|
- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
violate MaxSkew(1).
- if MaxSkew is 2, incoming pod can be scheduled onto any zone.
When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence
to topologies that satisfy it.
It's a required field. Default value is 1 and 0 is not allowed.

| `minDomains`
| `integer`
| MinDomains indicates a minimum number of eligible domains.
When the number of eligible domains with matching topology keys is less than minDomains,
Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed.
And when the number of eligible domains with matching topology keys equals or greater than minDomains,
this value has no effect on scheduling.
As a result, when the number of eligible domains is less than minDomains,
scheduler won't schedule more than maxSkew Pods to those domains.
If value is nil, the constraint behaves as if MinDomains is equal to 1.
Valid values are integers greater than 0.
When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
labelSelector spread as 2/2/2:
\| zone1 \| zone2 \| zone3 \|
\|  P P  \|  P P  \|  P P  \|
The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0.
In this situation, new pod with the same labelSelector cannot be scheduled,
because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
it will violate MaxSkew.

| `nodeAffinityPolicy`
| `string`
| NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector
when calculating pod topology spread skew. Options are:
- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

If this value is nil, the behavior is equivalent to the Honor policy.

| `nodeTaintsPolicy`
| `string`
| NodeTaintsPolicy indicates how we will treat node taints when calculating
pod topology spread skew. Options are:
- Honor: nodes without taints, along with tainted nodes for which the incoming pod
has a toleration, are included.
- Ignore: node taints are ignored. All nodes are included.

If this value is nil, the behavior is equivalent to the Ignore policy.

| `topologyKey`
| `string`
| TopologyKey is the key of node labels. Nodes that have a label with this key
and identical values are considered to be in the same topology.
We consider each <key, value> as a "bucket", and try to put balanced number
of pods into each bucket.
We define a domain as a particular instance of a topology.
Also, we define an eligible domain as a domain whose nodes meet the requirements of
nodeAffinityPolicy and nodeTaintsPolicy.
e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology.
And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology.
It's a required field.

| `whenUnsatisfiable`
| `string`
| WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
the spread constraint.
- DoNotSchedule (default) tells the scheduler not to schedule it.
- ScheduleAnyway tells the scheduler to schedule the pod in any location,
  but giving higher precedence to topologies that would help reduce the
  skew.
A constraint is considered "Unsatisfiable" for an incoming pod
if and only if every possible node assignment for that pod would violate
"MaxSkew" on some topology.
For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
labelSelector spread as 3/1/1:
\| zone1 \| zone2 \| zone3 \|
\| P P P \|   P   \|   P   \|
If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
won't make it *more* imbalanced.
It's a required field.

|===
=== .spec.metricsServerConfig.topologySpreadConstraints[].labelSelector
Description::
+
--
LabelSelector is used to find matching pods.
Pods that match this label selector are counted to determine the number of pods
in their corresponding topology domain.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.metricsServerConfig.topologySpreadConstraints[].labelSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.metricsServerConfig.topologySpreadConstraints[].labelSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.userDefined
Description::
+
--
userDefined set the deployment mode for user-defined monitoring in addition to the default platform monitoring.
userDefined is optional.
When omitted, this means no opinion and the platform is left to choose a reasonable default, which is subject to change over time.
The current default value is `Disabled`.
--

Type::
  `object`

Required::
  - `mode`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `mode`
| `string`
| mode defines the different configurations of UserDefinedMonitoring
Valid values are Disabled and NamespaceIsolated
Disabled disables monitoring for user-defined projects. This restricts the default monitoring stack, installed in the openshift-monitoring project, to monitor only platform namespaces, which prevents any custom monitoring configurations or resources from being applied to user-defined namespaces.
NamespaceIsolated enables monitoring for user-defined projects with namespace-scoped tenancy. This ensures that metrics, alerts, and monitoring data are isolated at the namespace level.
The current default value is `Disabled`.

|===
=== .status
Description::
+
--
status holds observed values from the cluster. They may not be overridden.
--

Type::
  `object`





== API endpoints

The following API endpoints are available:

* `/apis/config.openshift.io/v1alpha1/clustermonitorings`
- `DELETE`: delete collection of ClusterMonitoring
- `GET`: list objects of kind ClusterMonitoring
- `POST`: create a ClusterMonitoring
* `/apis/config.openshift.io/v1alpha1/clustermonitorings/{name}`
- `DELETE`: delete a ClusterMonitoring
- `GET`: read the specified ClusterMonitoring
- `PATCH`: partially update the specified ClusterMonitoring
- `PUT`: replace the specified ClusterMonitoring
* `/apis/config.openshift.io/v1alpha1/clustermonitorings/{name}/status`
- `GET`: read status of the specified ClusterMonitoring
- `PATCH`: partially update status of the specified ClusterMonitoring
- `PUT`: replace status of the specified ClusterMonitoring


=== /apis/config.openshift.io/v1alpha1/clustermonitorings



HTTP method::
  `DELETE`

Description::
  delete collection of ClusterMonitoring




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  list objects of kind ClusterMonitoring




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-openshift-config-v1alpha1-ClusterMonitoringList[`ClusterMonitoringList`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `POST`

Description::
  create a ClusterMonitoring


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 201 - Created
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 202 - Accepted
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/config.openshift.io/v1alpha1/clustermonitorings/{name}

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ClusterMonitoring
|===


HTTP method::
  `DELETE`

Description::
  delete a ClusterMonitoring


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  read the specified ClusterMonitoring




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update the specified ClusterMonitoring


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace the specified ClusterMonitoring


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 201 - Created
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/config.openshift.io/v1alpha1/clustermonitorings/{name}/status

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ClusterMonitoring
|===


HTTP method::
  `GET`

Description::
  read status of the specified ClusterMonitoring




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update status of the specified ClusterMonitoring


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace status of the specified ClusterMonitoring


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 201 - Created
| xref:../config_apis/clustermonitoring-config-openshift-io-v1alpha1.adoc#clustermonitoring-config-openshift-io-v1alpha1[`ClusterMonitoring`] schema
| 401 - Unauthorized
| Empty
|===