You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Documentation/api.md
+10-10
Original file line number
Diff line number
Diff line change
@@ -92,7 +92,7 @@ The `AlertmanagerMainConfig` resource defines settings for the Alertmanager comp
92
92
| secrets |[]string | 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. |
93
93
| tolerations |[][v1.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core)| Defines tolerations for the pods. |
| volumeClaimTemplate |*[monv1.EmbeddedPersistentVolumeClaim](https://github.com/prometheus-operator/prometheus-operator/blob/v0.76.0/Documentation/api.md#embeddedpersistentvolumeclaim)| Defines persistent storage for Alertmanager. Use this setting to configure the persistent volume claim, including storage class, volume size, and name. |
95
+
| volumeClaimTemplate |*[monv1.EmbeddedPersistentVolumeClaim](https://github.com/prometheus-operator/prometheus-operator/blob/v0.80.1/Documentation/api.md#embeddedpersistentvolumeclaim)| Defines persistent storage for Alertmanager. Use this setting to configure the persistent volume claim, including storage class, volume size, and name. |
96
96
97
97
[Back to TOC](#table-of-contents)
98
98
@@ -115,7 +115,7 @@ The `AlertmanagerUserWorkloadConfig` resource defines the settings for the Alert
115
115
| nodeSelector | map[string]string | Defines the nodes on which the pods are scheduled. |
116
116
| tolerations |[][v1.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core)| Defines tolerations for the pods. |
| volumeClaimTemplate |*[monv1.EmbeddedPersistentVolumeClaim](https://github.com/prometheus-operator/prometheus-operator/blob/v0.76.0/Documentation/api.md#embeddedpersistentvolumeclaim)| Defines persistent storage for Alertmanager. Use this setting to configure the persistent volume claim, including storage class, volume size and name. |
118
+
| volumeClaimTemplate |*[monv1.EmbeddedPersistentVolumeClaim](https://github.com/prometheus-operator/prometheus-operator/blob/v0.80.1/Documentation/api.md#embeddedpersistentvolumeclaim)| Defines persistent storage for Alertmanager. Use this setting to configure the persistent volume claim, including storage class, volume size and name. |
119
119
120
120
[Back to TOC](#table-of-contents)
121
121
@@ -434,7 +434,7 @@ The `PrometheusK8sConfig` resource defines settings for the Prometheus component
434
434
| tolerations |[][v1.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core)| Defines tolerations for the pods. |
| collectionProfile | CollectionProfile | Defines the metrics collection profile that Prometheus uses to collect metrics from the platform components. Supported values are `full` or `minimal`. In the `full` profile (default), Prometheus collects all metrics that are exposed by the platform components. In the `minimal` profile, Prometheus only collects metrics necessary for the default platform alerts, recording rules, telemetry and console dashboards. |
437
-
| volumeClaimTemplate |*[monv1.EmbeddedPersistentVolumeClaim](https://github.com/prometheus-operator/prometheus-operator/blob/v0.76.0/Documentation/api.md#embeddedpersistentvolumeclaim)| Defines persistent storage for Prometheus. Use this setting to configure the persistent volume claim, including storage class, volume size and name. |
437
+
| volumeClaimTemplate |*[monv1.EmbeddedPersistentVolumeClaim](https://github.com/prometheus-operator/prometheus-operator/blob/v0.80.1/Documentation/api.md#embeddedpersistentvolumeclaim)| Defines persistent storage for Prometheus. Use this setting to configure the persistent volume claim, including storage class, volume size and name. |
438
438
439
439
[Back to TOC](#table-of-contents)
440
440
@@ -502,7 +502,7 @@ The `PrometheusRestrictedConfig` resource defines the settings for the Prometheu
502
502
| retentionSize | string | Defines the maximum amount of disk space used by data blocks plus the write-ahead log (WAL). Supported values are `B`, `KB`, `KiB`, `MB`, `MiB`, `GB`, `GiB`, `TB`, `TiB`, `PB`, `PiB`, `EB`, and `EiB`. The default value is `nil`. |
503
503
| tolerations |[][v1.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core)| Defines tolerations for the pods. |
| volumeClaimTemplate |*[monv1.EmbeddedPersistentVolumeClaim](https://github.com/prometheus-operator/prometheus-operator/blob/v0.76.0/Documentation/api.md#embeddedpersistentvolumeclaim)| Defines persistent storage for Prometheus. Use this setting to configure the storage class and size of a volume. |
505
+
| volumeClaimTemplate |*[monv1.EmbeddedPersistentVolumeClaim](https://github.com/prometheus-operator/prometheus-operator/blob/v0.80.1/Documentation/api.md#embeddedpersistentvolumeclaim)| Defines persistent storage for Prometheus. Use this setting to configure the storage class and size of a volume. |
506
506
507
507
[Back to TOC](#table-of-contents)
508
508
@@ -520,20 +520,20 @@ The `RemoteWriteSpec` resource defines the settings for remote write storage.
520
520
| Property | Type | Description |
521
521
| -------- | ---- | ----------- |
522
522
| authorization |*monv1.SafeAuthorization | Defines the authorization settings for remote write storage. |
523
-
| basicAuth |*[monv1.BasicAuth](https://github.com/prometheus-operator/prometheus-operator/blob/v0.76.0/Documentation/api.md#basicauth)| Defines basic authentication settings for the remote write endpoint URL. |
523
+
| basicAuth |*[monv1.BasicAuth](https://github.com/prometheus-operator/prometheus-operator/blob/v0.80.1/Documentation/api.md#basicauth)| Defines basic authentication settings for the remote write endpoint URL. |
524
524
| bearerTokenFile | string | Defines the file that contains the bearer token for the remote write endpoint. However, because you cannot mount secrets in a pod, in practice you can only reference the token of the service account. |
525
525
| headers | map[string]string | Specifies the custom HTTP headers to be sent along with each remote write request. Headers set by Prometheus cannot be overwritten. |
526
-
| metadataConfig |*[monv1.MetadataConfig](https://github.com/prometheus-operator/prometheus-operator/blob/v0.76.0/Documentation/api.md#metadataconfig)| Defines settings for sending series metadata to remote write storage. |
526
+
| metadataConfig |*[monv1.MetadataConfig](https://github.com/prometheus-operator/prometheus-operator/blob/v0.80.1/Documentation/api.md#metadataconfig)| Defines settings for sending series metadata to remote write storage. |
527
527
| name | string | Defines the name of the remote write queue. This name is used in metrics and logging to differentiate queues. If specified, this name must be unique. |
528
528
| oauth2 |*monv1.OAuth2 | Defines OAuth2 authentication settings for the remote write endpoint. |
529
529
| 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. |
| remoteTimeout | string | Defines the timeout value for requests to the remote write endpoint. |
532
532
| sendExemplars |*bool | Enables sending exemplars via remote write. When enabled, Prometheus is configured to store a maximum of 100,000 exemplars in memory. Note that this setting only applies to user-defined monitoring. It is not applicable to default in-cluster monitoring. |
| tlsConfig |*[monv1.SafeTLSConfig](https://github.com/prometheus-operator/prometheus-operator/blob/v0.76.0/Documentation/api.md#safetlsconfig)| Defines TLS authentication settings for the remote write endpoint. |
534
+
| tlsConfig |*[monv1.SafeTLSConfig](https://github.com/prometheus-operator/prometheus-operator/blob/v0.80.1/Documentation/api.md#safetlsconfig)| Defines TLS authentication settings for the remote write endpoint. |
535
535
| url | string | Defines the URL of the remote write endpoint to which samples will be sent. |
536
-
| writeRelabelConfigs |[][monv1.RelabelConfig](https://github.com/prometheus-operator/prometheus-operator/blob/v0.76.0/Documentation/api.md#relabelconfig)| Defines the list of remote write relabel configurations. |
536
+
| writeRelabelConfigs |[][monv1.RelabelConfig](https://github.com/prometheus-operator/prometheus-operator/blob/v0.80.1/Documentation/api.md#relabelconfig)| Defines the list of remote write relabel configurations. |
537
537
538
538
[Back to TOC](#table-of-contents)
539
539
@@ -619,7 +619,7 @@ The `ThanosRulerConfig` resource defines configuration for the Thanos Ruler inst
619
619
| retention | string | Defines the duration for which Prometheus retains data. This definition must be specified using the following regular expression pattern: `[0-9]+(ms\|s\|m\|h\|d\|w\|y)` (ms = milliseconds, s= seconds,m = minutes, h = hours, d = days, w = weeks, y = years). The default value is `24h`. |
620
620
| tolerations |[][v1.Toleration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.32/#toleration-v1-core)| Defines tolerations for the pods. |
621
621
| topologySpreadConstraints |[]v1.TopologySpreadConstraint | Defines topology spread constraints for the pods. |
622
-
| volumeClaimTemplate |*[monv1.EmbeddedPersistentVolumeClaim](https://github.com/prometheus-operator/prometheus-operator/blob/v0.76.0/Documentation/api.md#embeddedpersistentvolumeclaim)| Defines persistent storage for Thanos Ruler. Use this setting to configure the storage class and size of a volume. |
622
+
| volumeClaimTemplate |*[monv1.EmbeddedPersistentVolumeClaim](https://github.com/prometheus-operator/prometheus-operator/blob/v0.80.1/Documentation/api.md#embeddedpersistentvolumeclaim)| Defines persistent storage for Thanos Ruler. Use this setting to configure the storage class and size of a volume. |
![openshift-merge-bot[bot]](https://avatars.githubusercontent.com/in/412865?v=4&size=40){kind=avatar}
0 commit comments