From b7c32189eaa33a57410c8d84e2c61a6ea10dbd02 Mon Sep 17 00:00:00 2001 From: Roboquat Date: Mon, 15 Sep 2025 00:19:41 +0000 Subject: [PATCH] [bot] [main] Automated dependencies update --- jsonnetfile.lock.json | 32 +- ...managerConfigCustomResourceDefinition.yaml | 2313 ++++++++++------- ...0alertmanagerCustomResourceDefinition.yaml | 514 ++-- ...r-0podmonitorCustomResourceDefinition.yaml | 206 +- ...erator-0probeCustomResourceDefinition.yaml | 208 +- ...r-0prometheusCustomResourceDefinition.yaml | 1163 ++++----- ...ometheusagentCustomResourceDefinition.yaml | 777 +++--- ...rometheusruleCustomResourceDefinition.yaml | 34 +- ...0scrapeconfigCustomResourceDefinition.yaml | 2140 +++++++-------- ...ervicemonitorCustomResourceDefinition.yaml | 238 +- ...-0thanosrulerCustomResourceDefinition.yaml | 513 ++-- .../jsonnet/kube-prometheus/versions.json | 2 +- .../alertmanagerconfigs-crd.json | 1915 +++++++------- .../alertmanagerconfigs-v1beta1-crd.libsonnet | 2002 +++++++------- .../alertmanagers-crd.json | 515 ++-- .../prometheus-operator/podmonitors-crd.json | 206 +- .../prometheus-operator/probes-crd.json | 208 +- .../prometheusagents-crd.json | 758 +++--- .../prometheus-operator/prometheuses-crd.json | 1140 ++++---- .../prometheusrules-crd.json | 34 +- .../scrapeconfigs-crd.json | 2028 +++++++-------- .../servicemonitors-crd.json | 238 +- .../prometheus-operator/thanosrulers-crd.json | 499 ++-- 23 files changed, 9027 insertions(+), 8656 deletions(-) diff --git a/jsonnetfile.lock.json b/jsonnetfile.lock.json index c9e56993..cafdb5bc 100644 --- a/jsonnetfile.lock.json +++ b/jsonnetfile.lock.json @@ -18,7 +18,7 @@ "subdir": "contrib/mixin" } }, - "version": "22cedfb21d3710f94a02f9314ec19cf7923a1c7a", + "version": "d3a8ea5dd5a878ec6b7660b2b249acafb915a4e4", "sum": "XmXkOCriQIZmXwlIIFhqlJMa0e6qGWdxZD+ZDYaN0Po=" }, { @@ -28,7 +28,7 @@ "subdir": "operations/observability/mixins" } }, - "version": "c91acb905c36dbf5ce41b0a71ffdc6d9909bc247", + "version": "76fab77f75a41791282617f177e70798ba911c13", "sum": "wvuIMANAM9nLAR9RmTl2J7ZkFOV/XtIQ8LwKApfydKc=", "name": "gitpod" }, @@ -89,7 +89,7 @@ "subdir": "grafana-builder" } }, - "version": "17cab45a63bdc604bf85ecceeda23c8ad26e543c", + "version": "e10cd2ae1352eaba653b52f7004e2e4a1354b014", "sum": "G7B6E5sqWirDbMWRhifbLRfGgRFbIh9WCYa6X3kMh6g=" }, { @@ -99,7 +99,7 @@ "subdir": "mixin-utils" } }, - "version": "17cab45a63bdc604bf85ecceeda23c8ad26e543c", + "version": "e10cd2ae1352eaba653b52f7004e2e4a1354b014", "sum": "VAik6Sh5MD5H1Km1gSIXG4rwQ4m4zyw7odP5TKu3bGo=" }, { @@ -139,7 +139,7 @@ "subdir": "jsonnet/kube-state-metrics" } }, - "version": "c893a8e8aaecac30bf92bd67503fb306ee1d1a60", + "version": "c892a3f9da523ffe04328e5c0de49b6bc37c2e86", "sum": "3bioG7CfTfY9zeu5xU4yon6Zt3kYvNkyl492nOhQxnM=" }, { @@ -149,7 +149,7 @@ "subdir": "jsonnet/kube-state-metrics-mixin" } }, - "version": "c893a8e8aaecac30bf92bd67503fb306ee1d1a60", + "version": "c892a3f9da523ffe04328e5c0de49b6bc37c2e86", "sum": "qclI7LwucTjBef3PkGBkKxF0mfZPbHnn4rlNWKGtR4c=" }, { @@ -159,8 +159,8 @@ "subdir": "jsonnet/kube-prometheus" } }, - "version": "c79b82818a207c85de6c7efb7eabb8529f23fc25", - "sum": "8X6myAAcvWGI9CW84AEm0MITwaI7HcefMzoiLj+Mxvg=" + "version": "94a390f5986dc34af181c03673ef3aa84ae50dba", + "sum": "s0i5RLx1pGrmAuN4Oat5JdusWgqv1ATAqBb3rieyAMo=" }, { "source": { @@ -169,7 +169,7 @@ "subdir": "jsonnet/mixin" } }, - "version": "3d04de8b9cba6c68c18f2eb7dee26092c7e92090", + "version": "ea2b6502b7be62d9d9df9b01ee3618c0c7433781", "sum": "gi+knjdxs2T715iIQIntrimbHRgHnpM8IFBJDD1gYfs=", "name": "prometheus-operator-mixin" }, @@ -180,8 +180,8 @@ "subdir": "jsonnet/prometheus-operator" } }, - "version": "3d04de8b9cba6c68c18f2eb7dee26092c7e92090", - "sum": "q/qLDOlFe9bTcGhjo4AUBmCzGk65tp4IahbqJpa2rbo=" + "version": "ea2b6502b7be62d9d9df9b01ee3618c0c7433781", + "sum": "rYL0JQBrqVIGTu7f82SBbbvOH5Ue5SPVyomen3AHlSc=" }, { "source": { @@ -190,7 +190,7 @@ "subdir": "doc/alertmanager-mixin" } }, - "version": "3e70148d4f55a27b0c817d0997149bff30f6343e", + "version": "117eb83c676d9e127161fe0f3863f792b49f09d7", "sum": "j5prvRrJdoCv7n45l5Uy2ghl1IDb9BBUqjwCDs4ZJoQ=", "name": "alertmanager" }, @@ -201,7 +201,7 @@ "subdir": "docs/node-mixin" } }, - "version": "2f980160aa4197b9036f46c72b8f4995159b4f0e", + "version": "8da4825e48fcf71b026f3ca7a632fc9f732c3423", "sum": "NcpQ0Hz0qciUqmOYoAR0X8GUK5pH/QiUXm1aDNgvua0=" }, { @@ -211,7 +211,7 @@ "subdir": "documentation/prometheus-mixin" } }, - "version": "913cc8f72b8a4f6ae4beb1d168c16a88ca4705ab", + "version": "594f9d63a5f9635d48d6e26b68b708e21630f9ee", "sum": "JY9uhZWjDnMd6TYjgqyzEqXqBS1zIkJrDzauiXyaJ4A=", "name": "prometheus" }, @@ -222,7 +222,7 @@ "subdir": "jsonnet/controller-gen" } }, - "version": "369e6fe4efe195409ad747fbb2f1be56408cc476", + "version": "634d5f1a7edf139368544be734799e410ecec182", "sum": "O3c9Uurei8MWAY0Ad7DOL1fMqSgdHyHB7MpHsxSITKM=", "name": "pyrra" }, @@ -233,7 +233,7 @@ "subdir": "mixin" } }, - "version": "1c4d17bd1285e941141065ff8d861cf8abb8677c", + "version": "3f26e056719e4310daa7f1fbe6c7ce5033305051", "sum": "ieCD4eMgGbOlrI8GmckGPHBGQDcLasE1rULYq56W/bs=", "name": "thanos-mixin" }, diff --git a/monitoring-satellite/manifests/crds/prometheusOperator-0alertmanagerConfigCustomResourceDefinition.yaml b/monitoring-satellite/manifests/crds/prometheusOperator-0alertmanagerConfigCustomResourceDefinition.yaml index 17ea28c0..82d3c23b 100644 --- a/monitoring-satellite/manifests/crds/prometheusOperator-0alertmanagerConfigCustomResourceDefinition.yaml +++ b/monitoring-satellite/manifests/crds/prometheusOperator-0alertmanagerConfigCustomResourceDefinition.yaml @@ -3,7 +3,7 @@ kind: CustomResourceDefinition metadata: annotations: argocd.argoproj.io/sync-options: Replace=true - controller-gen.kubebuilder.io/version: v0.18.0 + controller-gen.kubebuilder.io/version: v0.19.0 operator.prometheus.io/version: 0.85.0 name: alertmanagerconfigs.monitoring.coreos.com spec: @@ -44,17 +44,11 @@ spec: metadata: type: object spec: - description: |- - AlertmanagerConfigSpec is a specification of the desired behavior of the - Alertmanager configuration. - By default, the Alertmanager configuration only applies to alerts for which - the `namespace` label is equal to the namespace of the AlertmanagerConfig - resource (see the `.spec.alertmanagerConfigMatcherStrategy` field of the - Alertmanager CRD). + description: spec defines the specification of AlertmanagerConfigSpec properties: inhibitRules: description: |- - List of inhibition rules. The rules will only apply to alerts matching + inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching the resource's namespace. items: description: |- @@ -64,23 +58,24 @@ spec: properties: equal: description: |- - Labels that must have an equal value in the source and target alert for - the inhibition to take effect. + equal defines labels that must have an equal value in the source and target alert + for the inhibition to take effect. This ensures related alerts are properly grouped. items: type: string type: array sourceMatch: description: |- - Matchers for which one or more alerts have to exist for the inhibition - to take effect. The operator enforces that the alert matches the - resource's namespace. + sourceMatch defines matchers for which one or more alerts have to exist for the inhibition + to take effect. The operator enforces that the alert matches the resource's namespace. + These are the "trigger" alerts that cause other alerts to be inhibited. items: description: Matcher defines how to match on alert's labels. properties: matchType: description: |- - Match operation available with AlertManager >= v0.22.0 and - takes precedence over Regex (deprecated) if non-empty. + matchType defines the match operation available with AlertManager >= v0.22.0. + Takes precedence over Regex (deprecated) if non-empty. + Valid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match). enum: - '!=' - = @@ -88,16 +83,20 @@ spec: - '!~' type: string name: - description: Label to match. + description: |- + name defines the label to match. + This specifies which alert label should be evaluated. minLength: 1 type: string regex: description: |- - Whether to match on equality (false) or regular-expression (true). + regex defines whether to match on equality (false) or regular-expression (true). Deprecated: for AlertManager >= v0.22.0, `matchType` should be used instead. type: boolean value: - description: Label value to match. + description: |- + value defines the label value to match. + This is the expected value for the specified label. type: string required: - name @@ -105,15 +104,17 @@ spec: type: array targetMatch: description: |- - Matchers that have to be fulfilled in the alerts to be muted. The - operator enforces that the alert matches the resource's namespace. + targetMatch defines matchers that have to be fulfilled in the alerts to be muted. + The operator enforces that the alert matches the resource's namespace. + When these conditions are met, matching alerts will be inhibited (silenced). items: description: Matcher defines how to match on alert's labels. properties: matchType: description: |- - Match operation available with AlertManager >= v0.22.0 and - takes precedence over Regex (deprecated) if non-empty. + matchType defines the match operation available with AlertManager >= v0.22.0. + Takes precedence over Regex (deprecated) if non-empty. + Valid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match). enum: - '!=' - = @@ -121,16 +122,20 @@ spec: - '!~' type: string name: - description: Label to match. + description: |- + name defines the label to match. + This specifies which alert label should be evaluated. minLength: 1 type: string regex: description: |- - Whether to match on equality (false) or regular-expression (true). + regex defines whether to match on equality (false) or regular-expression (true). Deprecated: for AlertManager >= v0.22.0, `matchType` should be used instead. type: boolean value: - description: Label value to match. + description: |- + value defines the label value to match. + This is the expected value for the specified label. type: string required: - name @@ -139,37 +144,37 @@ spec: type: object type: array muteTimeIntervals: - description: List of MuteTimeInterval specifying when the routes should be muted. + description: muteTimeIntervals defines the list of MuteTimeInterval specifying when the routes should be muted. items: description: MuteTimeInterval specifies the periods in time when notifications will be muted properties: name: - description: Name of the time interval + description: name of the time interval type: string timeIntervals: - description: TimeIntervals is a list of TimeInterval + description: timeIntervals defines a list of TimeInterval items: description: TimeInterval describes intervals of time properties: daysOfMonth: - description: DaysOfMonth is a list of DayOfMonthRange + description: daysOfMonth defines a list of DayOfMonthRange items: description: DayOfMonthRange is an inclusive range of days of the month beginning at 1 properties: end: - description: End of the inclusive range + description: end of the inclusive range maximum: 31 minimum: -31 type: integer start: - description: Start of the inclusive range + description: start of the inclusive range maximum: 31 minimum: -31 type: integer type: object type: array months: - description: Months is a list of MonthRange + description: months defines a list of MonthRange items: description: |- MonthRange is an inclusive range of months of the year beginning in January @@ -178,22 +183,22 @@ spec: type: string type: array times: - description: Times is a list of TimeRange + description: times defines a list of TimeRange items: description: TimeRange defines a start and end time in 24hr format properties: endTime: - description: EndTime is the end time in 24hr format. + description: endTime defines the end time in 24hr format. pattern: ^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$) type: string startTime: - description: StartTime is the start time in 24hr format. + description: startTime defines the start time in 24hr format. pattern: ^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$) type: string type: object type: array weekdays: - description: Weekdays is a list of WeekdayRange + description: weekdays defines a list of WeekdayRange items: description: |- WeekdayRange is an inclusive range of days of the week beginning on Sunday @@ -202,7 +207,7 @@ spec: type: string type: array years: - description: Years is a list of YearRange + description: years defines a list of YearRange items: description: YearRange is an inclusive range of years pattern: ^2\d{3}(?::2\d{3}|$) @@ -215,12 +220,12 @@ spec: type: object type: array receivers: - description: List of receivers. + description: receivers defines the list of receivers. items: description: Receiver defines one or more notification integrations. properties: discordConfigs: - description: List of Discord configurations. + description: discordConfigs defines the list of Slack configurations. items: description: |- DiscordConfig configures notifications via Discord. @@ -228,7 +233,7 @@ spec: properties: apiURL: description: |- - The secret's key that contains the Discord webhook URL. + apiURL defines the secret's key that contains the Discord webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. properties: @@ -252,23 +257,23 @@ spec: type: object x-kubernetes-map-type: atomic avatarURL: - description: The avatar url of the message sender. + description: avatarURL defines the avatar url of the message sender. pattern: ^https?://.+$ type: string content: - description: The template of the content's body. + description: content defines the template of the content's body. minLength: 1 type: string httpConfig: - description: HTTP client configuration. + description: httpConfig defines the HTTP client configuration. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -291,7 +296,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -300,12 +305,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -329,7 +334,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -354,7 +359,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -379,26 +384,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -420,7 +429,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -444,7 +453,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -470,12 +479,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -507,7 +516,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -515,29 +524,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -559,7 +568,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -582,10 +591,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -607,7 +616,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -630,10 +639,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -656,7 +665,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -667,7 +676,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -677,11 +686,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -715,7 +724,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -723,28 +732,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -766,7 +776,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -789,10 +799,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -814,7 +824,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -837,10 +847,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -863,7 +873,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -874,7 +884,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -884,21 +894,21 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object message: - description: The template of the message's body. + description: message defines the template of the message's body. type: string sendResolved: - description: Whether or not to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean title: - description: The template of the message's title. + description: title defines the template of the message's title. type: string username: - description: The username of the message sender. + description: username defines the username of the message sender. minLength: 1 type: string required: @@ -906,16 +916,18 @@ spec: type: object type: array emailConfigs: - description: List of Email configurations. + description: emailConfigs defines the list of Email configurations. items: description: EmailConfig configures notifications via Email. properties: authIdentity: - description: The identity to use for authentication. + description: |- + authIdentity defines the identity to use for SMTP authentication. + This is typically used with PLAIN authentication mechanism. type: string authPassword: description: |- - The secret's key that contains the password to use for authentication. + authPassword defines the secret's key that contains the password to use for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. properties: @@ -940,7 +952,8 @@ spec: x-kubernetes-map-type: atomic authSecret: description: |- - The secret's key that contains the CRAM-MD5 secret. + authSecret defines the secret's key that contains the CRAM-MD5 secret. + This is used for CRAM-MD5 authentication mechanism. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. properties: @@ -964,24 +977,32 @@ spec: type: object x-kubernetes-map-type: atomic authUsername: - description: The username to use for authentication. + description: |- + authUsername defines the username to use for SMTP authentication. + This is used for SMTP AUTH when the server requires authentication. type: string from: - description: The sender address. + description: |- + from defines the sender address for email notifications. + This appears as the "From" field in the email header. type: string headers: description: |- - Further headers email header key/value pairs. Overrides any headers - previously set by the notification implementation. + headers defines additional email header key/value pairs. + These override any headers previously set by the notification implementation. items: description: KeyValue defines a (key, value) tuple. properties: key: - description: Key of the tuple. + description: |- + key defines the key of the tuple. + This is the identifier or name part of the key-value pair. minLength: 1 type: string value: - description: Value of the tuple. + description: |- + value defines the value of the tuple. + This is the data or content associated with the key. type: string required: - key @@ -989,33 +1010,43 @@ spec: type: object type: array hello: - description: The hostname to identify to the SMTP server. + description: |- + hello defines the hostname to identify to the SMTP server. + This is used in the SMTP HELO/EHLO command during the connection handshake. type: string html: - description: The HTML body of the email notification. + description: |- + html defines the HTML body of the email notification. + This allows for rich formatting in the email content. type: string requireTLS: description: |- - The SMTP TLS requirement. + requireTLS defines the SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints. type: boolean sendResolved: - description: Whether or not to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean smarthost: - description: The SMTP host and port through which emails are sent. E.g. example.com:25 + description: |- + smarthost defines the SMTP host and port through which emails are sent. + Format should be "hostname:port", e.g. "smtp.example.com:587". type: string text: - description: The text body of the email notification. + description: |- + text defines the plain text body of the email notification. + This provides a fallback for email clients that don't support HTML. type: string tlsConfig: - description: TLS configuration + description: |- + tlsConfig defines the TLS configuration for SMTP connections. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1037,7 +1068,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1060,10 +1091,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1085,7 +1116,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1108,10 +1139,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1134,7 +1165,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -1145,7 +1176,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -1155,17 +1186,19 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object to: - description: The email address to send notifications to. + description: |- + to defines the email address to send notifications to. + This is the recipient address for alert notifications. type: string type: object type: array msteamsConfigs: description: |- - List of MSTeams configurations. + msteamsConfigs defines the list of MSTeams configurations. It requires Alertmanager >= 0.26.0. items: description: |- @@ -1173,15 +1206,15 @@ spec: It requires Alertmanager >= 0.26.0. properties: httpConfig: - description: HTTP client configuration. + description: httpConfig defines the HTTP client configuration for Teams webhook requests. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1204,7 +1237,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -1213,12 +1246,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -1242,7 +1275,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -1267,7 +1300,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -1292,26 +1325,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1333,7 +1370,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1357,7 +1394,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -1383,12 +1420,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -1420,7 +1457,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -1428,29 +1465,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1472,7 +1509,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1495,10 +1532,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1520,7 +1557,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1543,10 +1580,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1569,7 +1606,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -1580,7 +1617,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -1590,11 +1627,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -1628,7 +1665,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -1636,28 +1673,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1679,7 +1717,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1702,10 +1740,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1727,7 +1765,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1750,10 +1788,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1776,7 +1814,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -1787,7 +1825,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -1797,26 +1835,33 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object sendResolved: - description: Whether to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean summary: description: |- - Message summary template. + summary defines the message summary template for Teams notifications. + This provides a brief overview that appears in Teams notification previews. It requires Alertmanager >= 0.27.0. type: string text: - description: Message body template. + description: |- + text defines the message body template for Teams notifications. + This contains the detailed content of the Teams message. type: string title: - description: Message title template. + description: |- + title defines the message title template for Teams notifications. + This appears as the main heading of the Teams message card. type: string webhookUrl: - description: MSTeams webhook URL. + description: |- + webhookUrl defines the MSTeams webhook URL for sending notifications. + This is the incoming webhook URL configured in your Teams channel. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1843,24 +1888,24 @@ spec: type: array msteamsv2Configs: description: |- - List of MSTeamsV2 configurations. + msteamsv2Configs defines the list of MSTeamsV2 configurations. It requires Alertmanager >= 0.28.0. items: description: |- - MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows + MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows. See https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config It requires Alertmanager >= 0.28.0. properties: httpConfig: - description: HTTP client configuration. + description: httpConfig defines the HTTP client configuration for Teams webhook requests. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1883,7 +1928,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -1892,12 +1937,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -1921,7 +1966,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -1946,7 +1991,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -1971,26 +2016,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2012,7 +2061,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2036,7 +2085,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -2062,12 +2111,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -2099,7 +2148,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -2107,29 +2156,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2151,7 +2200,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2174,10 +2223,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2199,7 +2248,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2222,10 +2271,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2248,7 +2297,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -2259,7 +2308,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -2269,11 +2318,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -2307,7 +2356,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -2315,28 +2364,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2358,7 +2408,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2381,10 +2431,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2406,7 +2456,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2429,10 +2479,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2455,7 +2505,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -2466,7 +2516,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -2476,23 +2526,29 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object sendResolved: - description: Whether to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean text: - description: Message body template. + description: |- + text defines the message body template for adaptive card notifications. + This contains the detailed content displayed in the Teams adaptive card format. minLength: 1 type: string title: - description: Message title template. + description: |- + title defines the message title template for adaptive card notifications. + This appears as the main heading in the Teams adaptive card. minLength: 1 type: string webhookURL: - description: MSTeams incoming webhook URL. + description: |- + webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications. + This webhook must support the newer adaptive cards format required by Teams flows. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2516,22 +2572,24 @@ spec: type: object type: array name: - description: Name of the receiver. Must be unique across all items from the list. + description: name defiens the name of the receiver. Must be unique across all items from the list. minLength: 1 type: string opsgenieConfigs: - description: List of OpsGenie configurations. + description: opsgenieConfigs defines the list of OpsGenie configurations. items: description: |- OpsGenieConfig configures notifications via OpsGenie. See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config properties: actions: - description: Comma separated list of actions that will be available for the alert. + description: |- + actions defines a comma separated list of actions that will be available for the alert. + These appear as action buttons in the OpsGenie interface. type: string apiKey: description: |- - The secret's key that contains the OpsGenie API key. + apiKey defines the secret's key that contains the OpsGenie API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. properties: @@ -2555,22 +2613,32 @@ spec: type: object x-kubernetes-map-type: atomic apiURL: - description: The URL to send OpsGenie API requests to. + description: |- + apiURL defines the URL to send OpsGenie API requests to. + When not specified, defaults to the standard OpsGenie API endpoint. type: string description: - description: Description of the incident. + description: |- + description defines the detailed description of the incident. + This provides additional context beyond the message field. type: string details: - description: A set of arbitrary key/value pairs that provide further detail about the incident. + description: |- + details defines a set of arbitrary key/value pairs that provide further detail about the incident. + These appear as additional fields in the OpsGenie alert. items: description: KeyValue defines a (key, value) tuple. properties: key: - description: Key of the tuple. + description: |- + key defines the key of the tuple. + This is the identifier or name part of the key-value pair. minLength: 1 type: string value: - description: Value of the tuple. + description: |- + value defines the value of the tuple. + This is the data or content associated with the key. type: string required: - key @@ -2578,18 +2646,20 @@ spec: type: object type: array entity: - description: Optional field that can be used to specify which domain alert is related to. + description: |- + entity defines an optional field that can be used to specify which domain alert is related to. + This helps group related alerts together in OpsGenie. type: string httpConfig: - description: HTTP client configuration. + description: httpConfig defines the HTTP client configuration for OpsGenie API requests. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2612,7 +2682,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -2621,12 +2691,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -2650,7 +2720,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -2675,7 +2745,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -2700,26 +2770,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2741,7 +2815,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2765,7 +2839,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -2791,12 +2865,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -2828,7 +2902,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -2836,29 +2910,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2880,7 +2954,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2903,10 +2977,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2928,7 +3002,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2951,10 +3025,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2977,7 +3051,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -2988,7 +3062,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -2998,11 +3072,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -3036,7 +3110,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -3044,28 +3118,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3087,7 +3162,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3110,10 +3185,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3135,7 +3210,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3158,10 +3233,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3184,7 +3259,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -3195,7 +3270,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -3205,92 +3280,123 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object message: - description: Alert text limited to 130 characters. + description: |- + message defines the alert text limited to 130 characters. + This appears as the main alert title in OpsGenie. type: string note: - description: Additional alert note. + description: |- + note defines an additional alert note. + This provides supplementary information about the alert. type: string priority: - description: Priority level of alert. Possible values are P1, P2, P3, P4, and P5. + description: |- + priority defines the priority level of alert. + Possible values are P1, P2, P3, P4, and P5, where P1 is highest priority. type: string responders: - description: List of responders responsible for notifications. + description: |- + responders defines the list of responders responsible for notifications. + These determine who gets notified when the alert is created. items: description: |- OpsGenieConfigResponder defines a responder to an incident. One of `id`, `name` or `username` has to be defined. properties: id: - description: ID of the responder. + description: |- + id defines the unique identifier of the responder. + This corresponds to the responder's ID within OpsGenie. type: string name: - description: Name of the responder. + description: |- + name defines the display name of the responder. + This is used when the responder is identified by name rather than ID. type: string type: - description: Type of responder. + description: |- + type defines the type of responder. + Valid values include "user", "team", "schedule", and "escalation". + This determines how OpsGenie interprets the other identifier fields. + enum: + - team + - teams + - user + - escalation + - schedule minLength: 1 type: string username: - description: Username of the responder. + description: |- + username defines the username of the responder. + This is typically used for user-type responders when identifying by username. type: string required: - type type: object type: array sendResolved: - description: Whether or not to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean source: - description: Backlink to the sender of the notification. + description: |- + source defines the backlink to the sender of the notification. + This helps identify where the alert originated from. type: string tags: - description: Comma separated list of tags attached to the notifications. + description: |- + tags defines a comma separated list of tags attached to the notifications. + These help categorize and filter alerts within OpsGenie. type: string updateAlerts: description: |- - Whether to update message and description of the alert in OpsGenie if it already exists + updateAlerts defines Whether to update message and description of the alert in OpsGenie if it already exists By default, the alert is never updated in OpsGenie, the new message only appears in activity log. type: boolean type: object type: array pagerdutyConfigs: - description: List of PagerDuty configurations. + description: pagerdutyConfigs defines the List of PagerDuty configurations. items: description: |- PagerDutyConfig configures notifications via PagerDuty. See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config properties: class: - description: The class/type of the event. + description: class defines the class/type of the event. type: string client: - description: Client identification. + description: client defines the client identification. type: string clientURL: - description: Backlink to the sender of notification. + description: clientURL defines the backlink to the sender of notification. type: string component: - description: The part or component of the affected system that is broken. + description: component defines the part or component of the affected system that is broken. type: string description: - description: Description of the incident. + description: description of the incident. type: string details: - description: Arbitrary key/value pairs that provide further detail about the incident. + description: details defines the arbitrary key/value pairs that provide further detail about the incident. items: description: KeyValue defines a (key, value) tuple. properties: key: - description: Key of the tuple. + description: |- + key defines the key of the tuple. + This is the identifier or name part of the key-value pair. minLength: 1 type: string value: - description: Value of the tuple. + description: |- + value defines the value of the tuple. + This is the data or content associated with the key. type: string required: - key @@ -3298,18 +3404,18 @@ spec: type: object type: array group: - description: A cluster or grouping of sources. + description: group defines a cluster or grouping of sources. type: string httpConfig: - description: HTTP client configuration. + description: httpConfig defines the HTTP client configuration. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3332,7 +3438,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -3341,12 +3447,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -3370,7 +3476,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -3395,7 +3501,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -3420,26 +3526,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3461,7 +3571,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3485,7 +3595,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -3511,12 +3621,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -3548,7 +3658,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -3556,29 +3666,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3600,7 +3710,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3623,10 +3733,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3648,7 +3758,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3671,10 +3781,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3697,7 +3807,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -3708,7 +3818,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -3718,11 +3828,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -3756,7 +3866,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -3764,28 +3874,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3807,7 +3918,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3830,10 +3941,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3855,7 +3966,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3878,10 +3989,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3904,7 +4015,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -3915,7 +4026,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -3925,42 +4036,42 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object pagerDutyImageConfigs: - description: A list of image details to attach that provide further detail about an incident. + description: pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident. items: description: PagerDutyImageConfig attaches images to an incident properties: alt: - description: Alt is the optional alternative text for the image. + description: alt is the optional alternative text for the image. type: string href: - description: Optional URL; makes the image a clickable link. + description: href defines the optional URL; makes the image a clickable link. type: string src: - description: Src of the image being attached to the incident + description: src of the image being attached to the incident type: string type: object type: array pagerDutyLinkConfigs: - description: A list of link details to attach that provide further detail about an incident. + description: pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident. items: description: PagerDutyLinkConfig attaches text links to an incident properties: alt: - description: Text that describes the purpose of the link, and can be used as the link's text. + description: alt defines the text that describes the purpose of the link, and can be used as the link's text. type: string href: - description: Href is the URL of the link to be attached + description: href defines the URL of the link to be attached type: string type: object type: array routingKey: description: |- - The secret's key that contains the PagerDuty integration key (when using + routingKey defines the secret's key that contains the PagerDuty integration key (when using Events API v2). Either this field or `serviceKey` needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -3985,11 +4096,11 @@ spec: type: object x-kubernetes-map-type: atomic sendResolved: - description: Whether or not to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean serviceKey: description: |- - The secret's key that contains the PagerDuty service key (when using + serviceKey defines the secret's key that contains the PagerDuty service key (when using integration type "Prometheus"). Either this field or `routingKey` needs to be defined. The secret needs to be in the same namespace as the AlertmanagerConfig @@ -4015,45 +4126,49 @@ spec: type: object x-kubernetes-map-type: atomic severity: - description: Severity of the incident. + description: severity of the incident. type: string source: - description: Unique location of the affected system. + description: source defines the unique location of the affected system. type: string url: - description: The URL to send requests to. + description: url defines the URL to send requests to. type: string type: object type: array pushoverConfigs: - description: List of Pushover configurations. + description: pushoverConfigs defines the list of Pushover configurations. items: description: |- PushoverConfig configures notifications via Pushover. See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config properties: device: - description: The name of a device to send the notification to + description: |- + device defines the name of a specific device to send the notification to. + If not specified, the notification is sent to all user's devices. type: string expire: description: |- - How long your notification will continue to be retried for, unless the user - acknowledges the notification. + expire defines how long your notification will continue to be retried for, + unless the user acknowledges the notification. Only applies to priority 2 notifications. pattern: ^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$ type: string html: - description: Whether notification message is HTML or plain text. + description: |- + html defines whether notification message is HTML or plain text. + When true, the message can include HTML formatting tags. type: boolean httpConfig: - description: HTTP client configuration. + description: httpConfig defines the HTTP client configuration for Pushover API requests. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4076,7 +4191,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -4085,12 +4200,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -4114,7 +4229,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -4139,7 +4254,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -4164,26 +4279,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4205,7 +4324,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4229,7 +4348,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -4255,12 +4374,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -4292,7 +4411,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -4300,29 +4419,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4344,7 +4463,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4367,10 +4486,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4392,7 +4511,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4415,10 +4534,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4441,7 +4560,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -4452,7 +4571,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -4462,11 +4581,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -4500,7 +4619,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -4508,28 +4627,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4551,7 +4671,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4574,10 +4694,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4599,7 +4719,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4622,10 +4742,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4648,7 +4768,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -4659,7 +4779,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -4669,34 +4789,43 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object message: - description: Notification message. + description: |- + message defines the notification message content. + This is the main body text of the Pushover notification. type: string priority: - description: Priority, see https://pushover.net/api#priority + description: |- + priority defines the notification priority level. + See https://pushover.net/api#priority for valid values and behavior. type: string retry: description: |- - How often the Pushover servers will send the same notification to the user. - Must be at least 30 seconds. + retry defines how often the Pushover servers will send the same notification to the user. + Must be at least 30 seconds. Only applies to priority 2 notifications. pattern: ^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$ type: string sendResolved: - description: Whether or not to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean sound: - description: The name of one of the sounds supported by device clients to override the user's default sound choice + description: |- + sound defines the name of one of the sounds supported by device clients. + This overrides the user's default sound choice for this notification. type: string title: - description: Notification title. + description: |- + title defines the notification title displayed in the Pushover message. + This appears as the bold header text in the notification. type: string token: description: |- - The secret's key that contains the registered application's API token, see https://pushover.net/apps. + token defines the secret's key that contains the registered application's API token. + See https://pushover.net/apps for application registration. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either `token` or `tokenFile` is required. @@ -4722,23 +4851,30 @@ spec: x-kubernetes-map-type: atomic tokenFile: description: |- - The token file that contains the registered application's API token, see https://pushover.net/apps. + tokenFile defines the token file that contains the registered application's API token. + See https://pushover.net/apps for application registration. Either `token` or `tokenFile` is required. It requires Alertmanager >= v0.26.0. type: string ttl: - description: The time to live definition for the alert notification + description: |- + ttl defines the time to live for the alert notification. + This determines how long the notification remains active before expiring. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string url: - description: A supplementary URL shown alongside the message. + description: |- + url defines a supplementary URL shown alongside the message. + This creates a clickable link within the Pushover notification. type: string urlTitle: - description: A title for supplementary URL, otherwise just the URL is shown + description: |- + urlTitle defines a title for the supplementary URL. + If not specified, the raw URL is shown instead. type: string userKey: description: |- - The secret's key that contains the recipient user's user key. + userKey defines the secret's key that contains the recipient user's user key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. Either `userKey` or `userKeyFile` is required. @@ -4764,7 +4900,7 @@ spec: x-kubernetes-map-type: atomic userKeyFile: description: |- - The user key file that contains the recipient user's user key. + userKeyFile defines the user key file that contains the recipient user's user key. Either `userKey` or `userKeyFile` is required. It requires Alertmanager >= v0.26.0. type: string @@ -4772,7 +4908,7 @@ spec: type: array rocketchatConfigs: description: |- - List of RocketChat configurations. + rocketchatConfigs defines the list of RocketChat configurations. It requires Alertmanager >= 0.28.0. items: description: |- @@ -4780,20 +4916,28 @@ spec: It requires Alertmanager >= 0.28.0. properties: actions: - description: Actions to include in the message. + description: |- + actions defines interactive actions to include in the message. + These appear as buttons that users can click to trigger responses. items: description: RocketChatActionConfig defines actions for RocketChat messages. properties: msg: - description: The message to send when the button is clicked. + description: |- + msg defines the message to send when the button is clicked. + This allows the button to post a predefined message to the channel. minLength: 1 type: string text: - description: The button text. + description: |- + text defines the button text displayed to users. + This is the label that appears on the interactive button. minLength: 1 type: string url: - description: The URL the button links to. + description: |- + url defines the URL the button links to when clicked. + This creates a clickable button that opens the specified URL. pattern: ^https?://.+$ type: string type: object @@ -4801,51 +4945,65 @@ spec: type: array apiURL: description: |- - The API URL for RocketChat. + apiURL defines the API URL for RocketChat. Defaults to https://open.rocket.chat/ if not specified. pattern: ^https?://.+$ type: string channel: - description: The channel to send alerts to. + description: |- + channel defines the channel to send alerts to. + This can be a channel name (e.g., "#alerts") or a direct message recipient. minLength: 1 type: string color: - description: The message color. + description: |- + color defines the message color displayed in RocketChat. + This appears as a colored bar alongside the message. minLength: 1 type: string emoji: - description: If provided, the avatar will be displayed as an emoji. + description: |- + emoji defines the emoji to be displayed as an avatar. + If provided, this emoji will be used instead of the default avatar or iconURL. minLength: 1 type: string fields: - description: Additional fields for the message. + description: |- + fields defines additional fields for the message attachment. + These appear as structured key-value pairs within the message. items: description: RocketChatFieldConfig defines additional fields for RocketChat messages. properties: short: - description: Whether this field should be a short field. + description: |- + short defines whether this field should be a short field. + When true, the field may be displayed inline with other short fields to save space. type: boolean title: - description: The title of this field. + description: |- + title defines the title of this field. + This appears as bold text labeling the field content. minLength: 1 type: string value: - description: The value of this field, displayed underneath the title value. + description: |- + value defines the value of this field, displayed underneath the title. + This contains the actual data or content for the field. minLength: 1 type: string type: object minItems: 1 type: array httpConfig: - description: HTTP client configuration. + description: httpConfig defines the HTTP client configuration for RocketChat API requests. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4868,7 +5026,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -4877,12 +5035,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -4906,7 +5064,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -4931,7 +5089,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -4956,26 +5114,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4997,7 +5159,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5021,7 +5183,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -5047,12 +5209,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -5084,7 +5246,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -5092,29 +5254,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5136,7 +5298,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5159,10 +5321,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5184,7 +5346,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5207,10 +5369,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5233,7 +5395,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -5244,7 +5406,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -5254,11 +5416,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -5292,7 +5454,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -5300,28 +5462,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5343,7 +5506,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5366,10 +5529,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5391,7 +5554,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5414,10 +5577,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5440,7 +5603,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -5451,7 +5614,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -5461,45 +5624,63 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object iconURL: - description: Icon URL for the message. + description: |- + iconURL defines the icon URL for the message avatar. + This displays a custom image as the message sender's avatar. pattern: ^https?://.+$ type: string imageURL: - description: Image URL for the message. + description: |- + imageURL defines the image URL to display within the message. + This embeds an image directly in the message attachment. pattern: ^https?://.+$ type: string linkNames: - description: Whether to enable link names. + description: |- + linkNames defines whether to enable automatic linking of usernames and channels. + When true, @username and #channel references become clickable links. type: boolean sendResolved: - description: Whether to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean shortFields: - description: Whether to use short fields. + description: |- + shortFields defines whether to use short fields in the message layout. + When true, fields may be displayed side by side to save space. type: boolean text: - description: The message text to send, it is optional because of attachments. + description: |- + text defines the message text to send. + This is optional because attachments can be used instead of or alongside text. minLength: 1 type: string thumbURL: - description: Thumbnail URL for the message. + description: |- + thumbURL defines the thumbnail URL for the message. + This displays a small thumbnail image alongside the message content. pattern: ^https?://.+$ type: string title: - description: The message title. + description: |- + title defines the message title displayed prominently in the message. + This appears as bold text at the top of the message attachment. minLength: 1 type: string titleLink: - description: The title link for the message. + description: |- + titleLink defines the URL that the title will link to when clicked. + This makes the message title clickable in the RocketChat interface. minLength: 1 type: string token: - description: The sender token. + description: |- + token defines the sender token for RocketChat authentication. + This is the personal access token or bot token used to authenticate API requests. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5521,7 +5702,9 @@ spec: type: object x-kubernetes-map-type: atomic tokenID: - description: The sender token ID. + description: |- + tokenID defines the sender token ID for RocketChat authentication. + This is the user ID associated with the token used for API requests. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5548,14 +5731,14 @@ spec: type: object type: array slackConfigs: - description: List of Slack configurations. + description: slackConfigs defines the list of Slack configurations. items: description: |- SlackConfig configures notifications via Slack. See https://prometheus.io/docs/alerting/latest/configuration/#slack_config properties: actions: - description: A list of Slack actions that are sent with each notification. + description: actions defines a list of Slack actions that are sent with each notification. items: description: |- SlackAction configures a single Slack action that is sent with each @@ -5565,37 +5748,64 @@ spec: properties: confirm: description: |- - SlackConfirmationField protect users from destructive actions or - particularly distinguished decisions by asking them to confirm their button - click one more time. - See https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields - for more information. + confirm defines an optional confirmation dialog that appears before the action is executed. + When set, users must confirm their intent before the action proceeds. properties: dismissText: + description: |- + dismissText defines the label for the cancel button in the dialog. + When not specified, defaults to "Cancel". This button cancels the action. type: string okText: + description: |- + okText defines the label for the confirmation button in the dialog. + When not specified, defaults to "Okay". This button proceeds with the action. type: string text: + description: |- + text defines the main message displayed in the confirmation dialog. + This should be a clear question or statement asking the user to confirm their action. minLength: 1 type: string title: + description: |- + title defines the title text displayed at the top of the confirmation dialog. + When not specified, a default title will be used. type: string required: - text type: object name: + description: |- + name defines a unique identifier for the action within the message. + This value is sent back to your application when the action is triggered. type: string style: + description: |- + style defines the visual appearance of the action element. + Valid values include "default", "primary" (green), and "danger" (red). type: string text: + description: |- + text defines the user-visible label displayed on the action element. + For buttons, this is the button text. For select menus, this is the placeholder text. minLength: 1 type: string type: + description: |- + type defines the type of interactive component. + Common values include "button" for clickable buttons and "select" for dropdown menus. minLength: 1 type: string url: + description: |- + url defines the URL to open when the action is triggered. + Only applicable for button-type actions. When set, clicking the button opens this URL. type: string value: + description: |- + value defines the payload sent when the action is triggered. + This data is included in the callback sent to your application. type: string required: - text @@ -5604,7 +5814,7 @@ spec: type: array apiURL: description: |- - The secret's key that contains the Slack webhook URL. + apiURL defines the secret's key that contains the Slack webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. properties: @@ -5628,16 +5838,21 @@ spec: type: object x-kubernetes-map-type: atomic callbackId: + description: callbackId defines an identifier for the message used in interactive components. type: string channel: - description: The channel or user to send notifications to. + description: channel defines the channel or user to send notifications to. type: string color: + description: |- + color defines the color of the left border of the Slack message attachment. + Can be a hex color code (e.g., "#ff0000") or a predefined color name. type: string fallback: + description: fallback defines a plain-text summary of the attachment for clients that don't support attachments. type: string fields: - description: A list of Slack fields that are sent with each notification. + description: fields defines a list of Slack fields that are sent with each notification. items: description: |- SlackField configures a single Slack field that is sent with each notification. @@ -5646,11 +5861,21 @@ spec: See https://api.slack.com/docs/message-attachments#fields for more information. properties: short: + description: |- + short determines whether this field can be displayed alongside other short fields. + When true, Slack may display this field side by side with other short fields. + When false or not specified, the field takes the full width of the message. type: boolean title: + description: |- + title defines the label or header text displayed for this field. + This appears as bold text above the field value in the Slack message. minLength: 1 type: string value: + description: |- + value defines the content or data displayed for this field. + This appears below the title and can contain plain text or Slack markdown. minLength: 1 type: string required: @@ -5659,17 +5884,18 @@ spec: type: object type: array footer: + description: footer defines small text displayed at the bottom of the message attachment. type: string httpConfig: - description: HTTP client configuration. + description: httpConfig defines the HTTP client configuration. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5692,7 +5918,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -5701,12 +5927,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -5730,7 +5956,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -5755,7 +5981,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -5780,26 +6006,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5821,7 +6051,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5845,7 +6075,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -5871,12 +6101,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -5908,7 +6138,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -5916,29 +6146,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5960,7 +6190,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5983,10 +6213,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6008,7 +6238,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6031,10 +6261,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6057,7 +6287,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -6068,7 +6298,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -6078,11 +6308,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -6116,7 +6346,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -6124,28 +6354,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6167,7 +6398,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6190,10 +6421,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6215,7 +6446,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6238,10 +6469,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6264,7 +6495,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -6275,7 +6506,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -6285,43 +6516,63 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object iconEmoji: + description: iconEmoji defines the emoji to use as the bot's avatar (e.g., ":ghost:"). type: string iconURL: + description: iconURL defines the URL to an image to use as the bot's avatar. type: string imageURL: + description: imageURL defines the URL to an image file that will be displayed inside the message attachment. type: string linkNames: + description: |- + linkNames enables automatic linking of channel names and usernames in the message. + When true, @channel and @username will be converted to clickable links. type: boolean mrkdwnIn: + description: |- + mrkdwnIn defines which fields should be parsed as Slack markdown. + Valid values include "pretext", "text", and "fields". items: type: string type: array pretext: + description: pretext defines optional text that appears above the message attachment block. type: string sendResolved: - description: Whether or not to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean shortFields: + description: |- + shortFields determines whether fields are displayed in a compact format. + When true, fields are shown side by side when possible. type: boolean text: + description: text defines the main text content of the Slack message attachment. type: string thumbURL: + description: |- + thumbURL defines the URL to an image file that will be displayed as a thumbnail + on the right side of the message attachment. type: string title: + description: title defines the title text displayed in the Slack message attachment. type: string titleLink: + description: titleLink defines the URL that the title will link to when clicked. type: string username: + description: username defines the slack bot user name. type: string type: object type: array snsConfigs: - description: List of SNS configurations + description: snsConfigs defines the list of SNS configurations items: description: |- SNSConfig configures notifications via AWS SNS. @@ -6329,24 +6580,26 @@ spec: properties: apiURL: description: |- - The SNS API URL i.e. https://sns.us-east-2.amazonaws.com. + apiURL defines the SNS API URL, e.g. https://sns.us-east-2.amazonaws.com. If not specified, the SNS API URL from the SNS SDK will be used. type: string attributes: additionalProperties: type: string - description: SNS message attributes. + description: |- + attributes defines SNS message attributes as key-value pairs. + These provide additional metadata that can be used for message filtering and routing. type: object httpConfig: - description: HTTP client configuration. + description: httpConfig defines the HTTP client configuration for SNS API requests. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6369,7 +6622,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -6378,12 +6631,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -6407,7 +6660,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -6432,7 +6685,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -6457,26 +6710,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6498,7 +6755,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6522,7 +6779,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -6548,12 +6805,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -6585,7 +6842,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -6593,29 +6850,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6637,7 +6894,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6660,10 +6917,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6685,7 +6942,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6708,10 +6965,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6734,7 +6991,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -6745,7 +7002,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -6755,11 +7012,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -6793,7 +7050,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -6801,28 +7058,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6844,7 +7102,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6867,10 +7125,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6892,7 +7150,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6915,10 +7173,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6941,7 +7199,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -6952,7 +7210,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -6962,27 +7220,31 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object message: - description: The message content of the SNS notification. + description: |- + message defines the message content of the SNS notification. + This is the actual notification text that will be sent to subscribers. type: string phoneNumber: description: |- - Phone number if message is delivered via SMS in E.164 format. + phoneNumber defines the phone number if message is delivered via SMS in E.164 format. If you don't specify this value, you must specify a value for the TopicARN or TargetARN. type: string sendResolved: - description: Whether or not to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean sigv4: - description: Configures AWS's Signature Verification 4 signing process to sign requests. + description: |- + sigv4 configures AWS's Signature Verification 4 signing process to sign requests. + This includes AWS credentials and region configuration for authentication. properties: accessKey: description: |- - AccessKey is the AWS API key. If not specified, the environment variable + accessKey defines the AWS API key. If not specified, the environment variable `AWS_ACCESS_KEY_ID` is used. properties: key: @@ -7005,17 +7267,17 @@ spec: type: object x-kubernetes-map-type: atomic profile: - description: Profile is the named AWS profile used to authenticate. + description: profile defines the named AWS profile used to authenticate. type: string region: - description: Region is the AWS region. If blank, the region from the default credentials chain used. + description: region defines the AWS region. If blank, the region from the default credentials chain used. type: string roleArn: - description: RoleArn is the named AWS profile used to authenticate. + description: roleArn defines the named AWS profile used to authenticate. type: string secretKey: description: |- - SecretKey is the AWS API secret. If not specified, the environment + secretKey defines the AWS API secret. If not specified, the environment variable `AWS_SECRET_ACCESS_KEY` is used. properties: key: @@ -7039,22 +7301,24 @@ spec: x-kubernetes-map-type: atomic type: object subject: - description: Subject line when the message is delivered to email endpoints. + description: |- + subject defines the subject line when the message is delivered to email endpoints. + This field is only used when sending to email subscribers of an SNS topic. type: string targetARN: description: |- - The mobile platform endpoint ARN if message is delivered via mobile notifications. - If you don't specify this value, you must specify a value for the topic_arn or PhoneNumber. + targetARN defines the mobile platform endpoint ARN if message is delivered via mobile notifications. + If you don't specify this value, you must specify a value for the TopicARN or PhoneNumber. type: string topicARN: description: |- - SNS topic ARN, i.e. arn:aws:sns:us-east-2:698519295917:My-Topic + topicARN defines the SNS topic ARN, e.g. arn:aws:sns:us-east-2:698519295917:My-Topic. If you don't specify this value, you must specify a value for the PhoneNumber or TargetARN. type: string type: object type: array telegramConfigs: - description: List of Telegram configurations. + description: telegramConfigs defines the list of Telegram configurations. items: description: |- TelegramConfig configures notifications via Telegram. @@ -7062,15 +7326,14 @@ spec: properties: apiURL: description: |- - The Telegram API URL i.e. https://api.telegram.org. - If not specified, default API URL will be used. + apiURL defines the Telegram API URL, e.g. https://api.telegram.org. + If not specified, the default Telegram API URL will be used. type: string botToken: description: |- - Telegram bot token. It is mutually exclusive with `botTokenFile`. + botToken defines the Telegram bot token. It is mutually exclusive with `botTokenFile`. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. - Either `botToken` or `botTokenFile` is required. properties: key: @@ -7094,28 +7357,32 @@ spec: x-kubernetes-map-type: atomic botTokenFile: description: |- - File to read the Telegram bot token from. It is mutually exclusive with `botToken`. + botTokenFile defines the file to read the Telegram bot token from. + It is mutually exclusive with `botToken`. Either `botToken` or `botTokenFile` is required. - It requires Alertmanager >= v0.26.0. type: string chatID: - description: The Telegram chat ID. + description: |- + chatID defines the Telegram chat ID where messages will be sent. + This can be a user ID, group ID, or channel ID (with @ prefix for public channels). format: int64 type: integer disableNotifications: - description: Disable telegram notifications + description: |- + disableNotifications controls whether Telegram notifications are sent silently. + When true, users will receive the message without notification sounds. type: boolean httpConfig: - description: HTTP client configuration. + description: httpConfig defines the HTTP client configuration for Telegram API requests. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7138,7 +7405,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -7147,12 +7414,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -7176,7 +7443,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -7201,7 +7468,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -7226,26 +7493,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7267,7 +7538,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7291,7 +7562,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -7317,12 +7588,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -7354,7 +7625,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -7362,29 +7633,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7406,7 +7677,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7429,10 +7700,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7454,7 +7725,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7477,10 +7748,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7503,7 +7774,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -7514,7 +7785,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -7524,11 +7795,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -7562,7 +7833,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -7570,28 +7841,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7613,7 +7885,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7636,10 +7908,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7661,7 +7933,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7684,10 +7956,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7710,7 +7982,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -7721,7 +7993,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -7731,35 +8003,41 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object message: - description: Message template + description: |- + message defines the message template for the Telegram notification. + This is the content that will be sent to the specified chat. type: string messageThreadID: description: |- - The Telegram Group Topic ID. + messageThreadID defines the Telegram Group Topic ID for threaded messages. + This allows sending messages to specific topics within Telegram groups. It requires Alertmanager >= 0.26.0. format: int64 type: integer parseMode: - description: Parse mode for telegram message + description: |- + parseMode defines the parse mode for telegram message formatting. + Valid values are "MarkdownV2", "Markdown", and "HTML". + This determines how text formatting is interpreted in the message. enum: - MarkdownV2 - Markdown - HTML type: string sendResolved: - description: Whether to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean required: - chatID type: object type: array victoropsConfigs: - description: List of VictorOps configurations. + description: victoropsConfigs defines the list of VictorOps configurations. items: description: |- VictorOpsConfig configures notifications via VictorOps. @@ -7767,7 +8045,7 @@ spec: properties: apiKey: description: |- - The secret's key that contains the API key to use when talking to the VictorOps API. + apiKey defines the secret's key that contains the API key to use when talking to the VictorOps API. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. properties: @@ -7791,19 +8069,27 @@ spec: type: object x-kubernetes-map-type: atomic apiUrl: - description: The VictorOps API URL. + description: |- + apiUrl defines the VictorOps API URL. + When not specified, defaults to the standard VictorOps API endpoint. type: string customFields: - description: Additional custom fields for notification. + description: |- + customFields defines additional custom fields for notification. + These provide extra metadata that will be included with the VictorOps incident. items: description: KeyValue defines a (key, value) tuple. properties: key: - description: Key of the tuple. + description: |- + key defines the key of the tuple. + This is the identifier or name part of the key-value pair. minLength: 1 type: string value: - description: Value of the tuple. + description: |- + value defines the value of the tuple. + This is the data or content associated with the key. type: string required: - key @@ -7811,18 +8097,20 @@ spec: type: object type: array entityDisplayName: - description: Contains summary of the alerted problem. + description: |- + entityDisplayName contains a summary of the alerted problem. + This appears as the main title or identifier for the incident. type: string httpConfig: - description: The HTTP client's configuration. + description: httpConfig defines the HTTP client's configuration for VictorOps API requests. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7845,7 +8133,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -7854,12 +8142,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -7883,7 +8171,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -7908,7 +8196,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -7933,26 +8221,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7974,7 +8266,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7998,7 +8290,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -8024,12 +8316,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -8061,7 +8353,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -8069,29 +8361,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8113,7 +8405,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8136,10 +8428,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8161,7 +8453,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8184,10 +8476,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8210,7 +8502,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -8221,7 +8513,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -8231,11 +8523,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -8269,7 +8561,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -8277,28 +8569,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8320,7 +8613,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8343,10 +8636,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8368,7 +8661,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8391,10 +8684,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8417,7 +8710,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -8428,7 +8721,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -8438,52 +8731,56 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object messageType: - description: Describes the behavior of the alert (CRITICAL, WARNING, INFO). + description: |- + messageType describes the behavior of the alert. + Valid values are "CRITICAL", "WARNING", and "INFO". type: string monitoringTool: - description: The monitoring tool the state message is from. + description: |- + monitoringTool defines the monitoring tool the state message is from. + This helps identify the source system that generated the alert. type: string routingKey: - description: A key used to map the alert to a team. + description: |- + routingKey defines a key used to map the alert to a team. + This determines which VictorOps team will receive the alert notification. type: string sendResolved: - description: Whether or not to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean stateMessage: - description: Contains long explanation of the alerted problem. + description: |- + stateMessage contains a long explanation of the alerted problem. + This provides detailed context about the incident. type: string type: object type: array webexConfigs: - description: List of Webex configurations. + description: webexConfigs defines the list of Webex configurations. items: description: |- WebexConfig configures notification via Cisco Webex See https://prometheus.io/docs/alerting/latest/configuration/#webex_config properties: apiURL: - description: |- - The Webex Teams API URL i.e. https://webexapis.com/v1/messages - Provide if different from the default API URL. + description: apiURL defines the Webex Teams API URL i.e. https://webexapis.com/v1/messages pattern: ^https?://.+$ type: string httpConfig: - description: |- - The HTTP client's configuration. - You must supply the bot token via the `httpConfig.authorization` field. + description: httpConfig defines the HTTP client's configuration. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8506,7 +8803,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -8515,12 +8812,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -8544,7 +8841,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -8569,7 +8866,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -8594,26 +8891,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8635,7 +8936,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8659,7 +8960,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -8685,12 +8986,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -8722,7 +9023,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -8730,29 +9031,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8774,7 +9075,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8797,10 +9098,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8822,7 +9123,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8845,10 +9146,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8871,7 +9172,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -8882,7 +9183,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -8892,11 +9193,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -8930,7 +9231,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -8938,28 +9239,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8981,7 +9283,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9004,10 +9306,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9029,7 +9331,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9052,10 +9354,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9078,7 +9380,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -9089,7 +9391,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -9099,41 +9401,41 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object message: - description: Message template + description: message defines the message template type: string roomID: - description: ID of the Webex Teams room where to send the messages. + description: roomID defines the ID of the Webex Teams room where to send the messages. minLength: 1 type: string sendResolved: - description: Whether to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean required: - roomID type: object type: array webhookConfigs: - description: List of webhook configurations. + description: webhookConfigs defines the List of webhook configurations. items: description: |- WebhookConfig configures notifications via a generic receiver supporting the webhook payload. See https://prometheus.io/docs/alerting/latest/configuration/#webhook_config properties: httpConfig: - description: HTTP client configuration. + description: httpConfig defines the HTTP client configuration for webhook requests. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9156,7 +9458,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -9165,12 +9467,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -9194,7 +9496,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -9219,7 +9521,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -9244,26 +9546,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9285,7 +9591,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9309,7 +9615,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -9335,12 +9641,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -9372,7 +9678,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -9380,29 +9686,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9424,7 +9730,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9447,10 +9753,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9472,7 +9778,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9495,10 +9801,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9521,7 +9827,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -9532,7 +9838,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -9542,11 +9848,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -9580,7 +9886,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -9588,28 +9894,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9631,7 +9938,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9654,10 +9961,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9679,7 +9986,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9702,10 +10009,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9728,7 +10035,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -9739,7 +10046,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -9749,35 +10056,36 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object maxAlerts: - description: Maximum number of alerts to be sent per webhook message. When 0, all alerts are included. + description: |- + maxAlerts defines the maximum number of alerts to be sent per webhook message. + When 0, all alerts are included in the webhook payload. format: int32 minimum: 0 type: integer sendResolved: - description: Whether or not to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean timeout: description: |- - The maximum time to wait for a webhook request to complete, before failing the - request and allowing it to be retried. + timeout defines the maximum time to wait for a webhook request to complete, + before failing the request and allowing it to be retried. It requires Alertmanager >= v0.28.0. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string url: description: |- - The URL to send HTTP POST requests to. `urlSecret` takes precedence over - `url`. One of `urlSecret` and `url` should be defined. + url defines the URL to send HTTP POST requests to. + urlSecret takes precedence over url. One of urlSecret and url should be defined. type: string urlSecret: description: |- - The secret's key that contains the webhook URL to send HTTP requests to. - `urlSecret` takes precedence over `url`. One of `urlSecret` and `url` - should be defined. + urlSecret defines the secret's key that contains the webhook URL to send HTTP requests to. + urlSecret takes precedence over url. One of urlSecret and url should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. properties: @@ -9803,17 +10111,20 @@ spec: type: object type: array wechatConfigs: - description: List of WeChat configurations. + description: wechatConfigs defines the list of WeChat configurations. items: description: |- WeChatConfig configures notifications via WeChat. See https://prometheus.io/docs/alerting/latest/configuration/#wechat_config properties: agentID: + description: |- + agentID defines the application agent ID within WeChat Work. + This identifies which WeChat Work application will send the notifications. type: string apiSecret: description: |- - The secret's key that contains the WeChat API key. + apiSecret defines the secret's key that contains the WeChat API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. properties: @@ -9837,21 +10148,25 @@ spec: type: object x-kubernetes-map-type: atomic apiURL: - description: The WeChat API URL. + description: |- + apiURL defines the WeChat API URL. + When not specified, defaults to the standard WeChat Work API endpoint. type: string corpID: - description: The corp id for authentication. + description: |- + corpID defines the corp id for authentication. + This is the unique identifier for your WeChat Work organization. type: string httpConfig: - description: HTTP client configuration. + description: httpConfig defines the HTTP client configuration for WeChat API requests. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9874,7 +10189,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -9883,12 +10198,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -9912,7 +10227,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -9937,7 +10252,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -9962,26 +10277,30 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: |- + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: |- + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10003,7 +10322,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10027,7 +10346,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -10053,12 +10372,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -10090,7 +10409,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -10098,29 +10417,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10142,7 +10461,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10165,10 +10484,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10190,7 +10509,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10213,10 +10532,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10239,7 +10558,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -10250,7 +10569,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -10260,11 +10579,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -10298,7 +10617,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -10306,28 +10625,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyURL: description: |- - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. type: string proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: |- + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10349,7 +10669,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10372,10 +10692,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10397,7 +10717,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10420,10 +10740,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10446,7 +10766,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -10457,7 +10777,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -10467,23 +10787,37 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object message: - description: API request data as defined by the WeChat API. + description: |- + message defines the API request data as defined by the WeChat API. + This contains the actual notification content to be sent. type: string messageType: + description: |- + messageType defines the type of message to send. + Valid values include "text", "markdown", and other WeChat Work supported message types. type: string sendResolved: - description: Whether or not to notify about resolved alerts. + description: sendResolved defines whether or not to notify about resolved alerts. type: boolean toParty: + description: |- + toParty defines the target department(s) to receive the notification. + Can be a single department ID or multiple department IDs separated by '|'. type: string toTag: + description: |- + toTag defines the target tag(s) to receive the notification. + Can be a single tag ID or multiple tag IDs separated by '|'. type: string toUser: + description: |- + toUser defines the target user(s) to receive the notification. + Can be a single user ID or multiple user IDs separated by '|'. type: string type: object type: array @@ -10493,24 +10827,24 @@ spec: type: array route: description: |- - The Alertmanager route definition for alerts matching the resource's + route defines the Alertmanager route definition for alerts matching the resource's namespace. If present, it will be added to the generated Alertmanager configuration as a first-level route. properties: activeTimeIntervals: - description: ActiveTimeIntervals is a list of MuteTimeInterval names when this route should be active. + description: activeTimeIntervals is a list of MuteTimeInterval names when this route should be active. items: type: string type: array continue: description: |- - Boolean indicating whether an alert should continue matching subsequent + continue defines the boolean indicating whether an alert should continue matching subsequent sibling nodes. It will always be overridden to true for the first-level route by the Prometheus operator. type: boolean groupBy: description: |- - List of labels to group by. + groupBy defines the list of labels to group by. Labels must not be repeated (unique list). Special label "..." (aggregate by all possible labels), if provided, must be the only element in the list. items: @@ -10518,19 +10852,19 @@ spec: type: array groupInterval: description: |- - How long to wait before sending an updated notification. + groupInterval defines how long to wait before sending an updated notification. Must match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$` Example: "5m" type: string groupWait: description: |- - How long to wait before sending the initial notification. + groupWait defines how long to wait before sending the initial notification. Must match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$` Example: "30s" type: string matchers: description: |- - List of matchers that the alert's labels should match. For the first + matchers defines the list of matchers that the alert's labels should match. For the first level route, the operator removes any existing equality and regexp matcher on the `namespace` label and adds a `namespace: ` matcher. @@ -10539,8 +10873,9 @@ spec: properties: matchType: description: |- - Match operation available with AlertManager >= v0.22.0 and - takes precedence over Regex (deprecated) if non-empty. + matchType defines the match operation available with AlertManager >= v0.22.0. + Takes precedence over Regex (deprecated) if non-empty. + Valid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match). enum: - '!=' - = @@ -10548,47 +10883,43 @@ spec: - '!~' type: string name: - description: Label to match. + description: |- + name defines the label to match. + This specifies which alert label should be evaluated. minLength: 1 type: string regex: description: |- - Whether to match on equality (false) or regular-expression (true). + regex defines whether to match on equality (false) or regular-expression (true). Deprecated: for AlertManager >= v0.22.0, `matchType` should be used instead. type: boolean value: - description: Label value to match. + description: |- + value defines the label value to match. + This is the expected value for the specified label. type: string required: - name type: object type: array muteTimeIntervals: - description: |- - Note: this comment applies to the field definition above but appears - below otherwise it gets included in the generated manifest. - CRD schema doesn't support self-referential types for now (see - https://github.com/kubernetes/kubernetes/issues/62872). We have to use - an alternative type to circumvent the limitation. The downside is that - the Kube API can't validate the data beyond the fact that it is a valid - JSON representation. - MuteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched, + description: muteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched, items: type: string type: array receiver: description: |- - Name of the receiver for this route. If not empty, it should be listed in + receiver defines the name of the receiver for this route. If not empty, it should be listed in the `receivers` field. type: string repeatInterval: description: |- - How long to wait before repeating the last notification. + repeatInterval defines how long to wait before repeating the last notification. Must match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$` Example: "4h" type: string routes: - description: Child routes. + description: routes defines the child routes. items: x-kubernetes-preserve-unknown-fields: true type: array diff --git a/monitoring-satellite/manifests/crds/prometheusOperator-0alertmanagerCustomResourceDefinition.yaml b/monitoring-satellite/manifests/crds/prometheusOperator-0alertmanagerCustomResourceDefinition.yaml index d26b773b..637f9db9 100644 --- a/monitoring-satellite/manifests/crds/prometheusOperator-0alertmanagerCustomResourceDefinition.yaml +++ b/monitoring-satellite/manifests/crds/prometheusOperator-0alertmanagerCustomResourceDefinition.yaml @@ -3,7 +3,7 @@ kind: CustomResourceDefinition metadata: annotations: argocd.argoproj.io/sync-options: Replace=true - controller-gen.kubebuilder.io/version: v0.18.0 + controller-gen.kubebuilder.io/version: v0.19.0 operator.prometheus.io/version: 0.85.0 name: alertmanagers.monitoring.coreos.com spec: @@ -75,12 +75,12 @@ spec: type: object spec: description: |- - Specification of the desired behavior of the Alertmanager cluster. More info: + spec defines the specification of the desired behavior of the Alertmanager cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status properties: additionalArgs: description: |- - AdditionalArgs allows setting additional arguments for the 'Alertmanager' container. + additionalArgs allows setting additional arguments for the 'Alertmanager' container. It is intended for e.g. activating hidden flags which are not supported by the dedicated configuration options yet. The arguments are passed as-is to the Alertmanager container which may cause issues if they are invalid or not supported @@ -89,23 +89,23 @@ spec: description: Argument as part of the AdditionalArgs list. properties: name: - description: Name of the argument, e.g. "scrape.discovery-reload-interval". + description: name of the argument, e.g. "scrape.discovery-reload-interval". minLength: 1 type: string value: - description: Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) + description: value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) type: string required: - name type: object type: array additionalPeers: - description: AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster. + description: additionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster. items: type: string type: array affinity: - description: If specified, the pod's scheduling constraints. + description: affinity defines the pod's scheduling constraints. properties: nodeAffinity: description: Describes node affinity scheduling rules for the pod. @@ -979,13 +979,13 @@ spec: type: object alertmanagerConfigMatcherStrategy: description: |- - AlertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects + alertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects process incoming alerts. properties: type: default: OnNamespace description: |- - AlertmanagerConfigMatcherStrategyType defines the strategy used by + type defines the strategy used by AlertmanagerConfig objects to match alerts in the routes and inhibition rules. @@ -998,7 +998,7 @@ spec: type: object alertmanagerConfigNamespaceSelector: description: |- - Namespaces to be selected for AlertmanagerConfig discovery. If nil, only + alertmanagerConfigNamespaceSelector defines the namespaces to be selected for AlertmanagerConfig discovery. If nil, only check own namespace. properties: matchExpressions: @@ -1043,7 +1043,7 @@ spec: type: object x-kubernetes-map-type: atomic alertmanagerConfigSelector: - description: AlertmanagerConfigs to be selected for to merge and configure Alertmanager with. + description: alertmanagerConfigSelector defines the selector to be used for to merge and configure Alertmanager with. properties: matchExpressions: description: matchExpressions is a list of label selector requirements. The requirements are ANDed. @@ -1088,7 +1088,7 @@ spec: x-kubernetes-map-type: atomic alertmanagerConfiguration: description: |- - alertmanagerConfiguration specifies the configuration of Alertmanager. + alertmanagerConfiguration defines the configuration of Alertmanager. If defined, it takes precedence over the `configSecret` field. @@ -1096,18 +1096,18 @@ spec: in a breaking way. properties: global: - description: Defines the global parameters of the Alertmanager configuration. + description: global defines the global parameters of the Alertmanager configuration. properties: httpConfig: - description: HTTP client configuration. + description: httpConfig defines the default HTTP configuration. properties: authorization: description: |- - Authorization header configuration for the client. + authorization defines the header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1130,7 +1130,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -1139,12 +1139,12 @@ spec: type: object basicAuth: description: |- - BasicAuth for the client. + basicAuth defines basicAuth for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -1168,7 +1168,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -1193,7 +1193,7 @@ spec: type: object bearerTokenSecret: description: |- - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the Alertmanager object and accessible by the Prometheus Operator. @@ -1218,26 +1218,26 @@ spec: type: object x-kubernetes-map-type: atomic followRedirects: - description: FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + description: followRedirects defines whether the client should follow HTTP 3xx redirects. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: OAuth2 client credentials used to fetch a token for the targets. + description: oauth2 defines the client credentials used to fetch a token for the targets. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1259,7 +1259,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1283,7 +1283,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -1309,12 +1309,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -1346,7 +1346,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -1354,29 +1354,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1398,7 +1398,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1421,10 +1421,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1446,7 +1446,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1469,10 +1469,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1495,7 +1495,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -1506,7 +1506,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -1516,11 +1516,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -1554,7 +1554,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -1562,22 +1562,22 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS configuration for the client. + description: tlsConfig defines the TLSConfig for the client. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1599,7 +1599,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1622,10 +1622,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1647,7 +1647,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1670,10 +1670,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1696,7 +1696,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -1707,7 +1707,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -1717,23 +1717,23 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object jira: - description: The default configuration for Jira. + description: jira defines the default configuration for Jira. properties: apiURL: description: |- - The default Jira API URL. + apiURL defines the default Jira API URL. It requires Alertmanager >= v0.28.0. pattern: ^(http|https)://.+$ type: string type: object opsGenieApiKey: - description: The default OpsGenie API Key. + description: opsGenieApiKey defines the default OpsGenie API Key. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1755,7 +1755,7 @@ spec: type: object x-kubernetes-map-type: atomic opsGenieApiUrl: - description: The default OpsGenie API URL. + description: opsGenieApiUrl defines the default OpsGenie API URL. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1777,28 +1777,28 @@ spec: type: object x-kubernetes-map-type: atomic pagerdutyUrl: - description: The default Pagerduty URL. + description: pagerdutyUrl defines the default Pagerduty URL. type: string resolveTimeout: description: |- - ResolveTimeout is the default value used by alertmanager if the alert does + resolveTimeout defines the default value used by alertmanager if the alert does not include EndsAt, after this time passes it can declare the alert as resolved if it has not been updated. This has no impact on alerts from Prometheus, as they always include EndsAt. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string rocketChat: - description: The default configuration for Rocket Chat. + description: rocketChat defines the default configuration for Rocket Chat. properties: apiURL: description: |- - The default Rocket Chat API URL. + apiURL defines the default Rocket Chat API URL. It requires Alertmanager >= v0.28.0. pattern: ^(http|https)://.+$ type: string token: description: |- - The default Rocket Chat token. + token defines the default Rocket Chat token. It requires Alertmanager >= v0.28.0. properties: @@ -1823,7 +1823,7 @@ spec: x-kubernetes-map-type: atomic tokenID: description: |- - The default Rocket Chat Token ID. + tokenID defines the default Rocket Chat Token ID. It requires Alertmanager >= v0.28.0. properties: @@ -1848,7 +1848,7 @@ spec: x-kubernetes-map-type: atomic type: object slackApiUrl: - description: The default Slack API URL. + description: slackApiUrl defines the default Slack API URL. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1870,13 +1870,13 @@ spec: type: object x-kubernetes-map-type: atomic smtp: - description: Configures global SMTP parameters. + description: smtp defines global SMTP parameters. properties: authIdentity: - description: SMTP Auth using PLAIN + description: authIdentity represents SMTP Auth using PLAIN type: string authPassword: - description: SMTP Auth using LOGIN and PLAIN. + description: authPassword represents SMTP Auth using LOGIN and PLAIN. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1898,7 +1898,7 @@ spec: type: object x-kubernetes-map-type: atomic authSecret: - description: SMTP Auth using CRAM-MD5. + description: authSecret represents SMTP Auth using CRAM-MD5. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1920,28 +1920,28 @@ spec: type: object x-kubernetes-map-type: atomic authUsername: - description: SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server. + description: authUsername represents SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server. type: string from: - description: The default SMTP From header field. + description: from defines the default SMTP From header field. type: string hello: - description: The default hostname to identify to the SMTP server. + description: hello defines the default hostname to identify to the SMTP server. type: string requireTLS: description: |- - The default SMTP TLS requirement. + requireTLS defines the default SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints. type: boolean smartHost: - description: The default SMTP smarthost used for sending emails. + description: smartHost defines the default SMTP smarthost used for sending emails. properties: host: - description: Defines the host's address, it can be a DNS name or a literal IP address. + description: host defines the host's address, it can be a DNS name or a literal IP address. minLength: 1 type: string port: - description: Defines the host's port, it can be a literal port number or a port name. + description: port defines the host's port, it can be a literal port number or a port name. minLength: 1 type: string required: @@ -1949,13 +1949,13 @@ spec: - port type: object tlsConfig: - description: The default TLS configuration for SMTP receivers + description: tlsConfig defines the default TLS configuration for SMTP receivers properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1977,7 +1977,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2000,10 +2000,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2025,7 +2025,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2048,10 +2048,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2074,7 +2074,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -2085,7 +2085,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -2095,26 +2095,26 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object telegram: - description: The default Telegram config + description: telegram defines the default Telegram config properties: apiURL: description: |- - The default Telegram API URL. + apiURL defines he default Telegram API URL. It requires Alertmanager >= v0.24.0. pattern: ^(http|https)://.+$ type: string type: object victorops: - description: The default configuration for VictorOps. + description: victorops defines the default configuration for VictorOps. properties: apiKey: - description: The default VictorOps API Key. + description: apiKey defines the default VictorOps API Key. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2136,30 +2136,30 @@ spec: type: object x-kubernetes-map-type: atomic apiURL: - description: The default VictorOps API URL. + description: apiURL defines the default VictorOps API URL. pattern: ^(http|https)://.+$ type: string type: object webex: - description: The default configuration for Jira. + description: webex defines the default configuration for Jira. properties: apiURL: description: |- - The default Webex API URL. + apiURL defines the is the default Webex API URL. It requires Alertmanager >= v0.25.0. pattern: ^(http|https)://.+$ type: string type: object wechat: - description: The default WeChat Config + description: wechat defines the default WeChat Config properties: apiCorpID: - description: The default WeChat API Corporate ID. + description: apiCorpID defines the default WeChat API Corporate ID. minLength: 1 type: string apiSecret: - description: The default WeChat API Secret. + description: apiSecret defines the default WeChat API Secret. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2182,7 +2182,7 @@ spec: x-kubernetes-map-type: atomic apiURL: description: |- - The default WeChat API URL. + apiURL defines he default WeChat API URL. The default value is "https://qyapi.weixin.qq.com/cgi-bin/" pattern: ^(http|https)://.+$ type: string @@ -2190,18 +2190,18 @@ spec: type: object name: description: |- - The name of the AlertmanagerConfig resource which is used to generate the Alertmanager configuration. + name defines the name of the AlertmanagerConfig custom resource which is used to generate the Alertmanager configuration. It must be defined in the same namespace as the Alertmanager object. The operator will not enforce a `namespace` label for routes and inhibition rules. minLength: 1 type: string templates: - description: Custom notification templates. + description: templates defines the custom notification templates. items: description: SecretOrConfigMap allows to specify data as a Secret or ConfigMap. Fields are mutually exclusive. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2223,7 +2223,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2249,51 +2249,51 @@ spec: type: object automountServiceAccountToken: description: |- - AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod. + automountServiceAccountToken defines whether a service account token should be automatically mounted in the pod. If the service account has `automountServiceAccountToken: true`, set the field to `false` to opt out of automounting API credentials. type: boolean baseImage: description: |- - Base image that is used to deploy pods, without tag. + baseImage that is used to deploy pods, without tag. Deprecated: use 'image' instead. type: string clusterAdvertiseAddress: description: |- - ClusterAdvertiseAddress is the explicit address to advertise in cluster. + clusterAdvertiseAddress defines the explicit address to advertise in cluster. Needs to be provided for non RFC1918 [1] (public) addresses. [1] RFC1918: https://tools.ietf.org/html/rfc1918 type: string clusterGossipInterval: - description: Interval between gossip attempts. + description: clusterGossipInterval defines the interval between gossip attempts. pattern: ^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string clusterLabel: description: |- - Defines the identifier that uniquely identifies the Alertmanager cluster. + clusterLabel defines the identifier that uniquely identifies the Alertmanager cluster. You should only set it when the Alertmanager cluster includes Alertmanager instances which are external to this Alertmanager resource. In practice, the addresses of the external instances are provided via the `.spec.additionalPeers` field. type: string clusterPeerTimeout: - description: Timeout for cluster peering. + description: clusterPeerTimeout defines the timeout for cluster peering. pattern: ^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string clusterPushpullInterval: - description: Interval between pushpull attempts. + description: clusterPushpullInterval defines the interval between pushpull attempts. pattern: ^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string clusterTLS: description: |- - Configures the mutual TLS configuration for the Alertmanager cluster's gossip protocol. + clusterTLS defines the mutual TLS configuration for the Alertmanager cluster's gossip protocol. It requires Alertmanager >= 0.24.0. properties: client: - description: Client-side configuration for mutual TLS. + description: client defines the client-side configuration for mutual TLS. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2315,7 +2315,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2338,10 +2338,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2363,7 +2363,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2386,10 +2386,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2412,7 +2412,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -2423,7 +2423,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -2433,22 +2433,22 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object server: - description: Server-side configuration for mutual TLS. + description: server defines the server-side configuration for mutual TLS. properties: cert: description: |- - Secret or ConfigMap containing the TLS certificate for the web server. + cert defines the Secret or ConfigMap containing the TLS certificate for the web server. Either `keySecret` or `keyFile` must be defined. It is mutually exclusive with `certFile`. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2470,7 +2470,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2494,7 +2494,7 @@ spec: type: object certFile: description: |- - Path to the TLS certificate file in the container for the web server. + certFile defines the path to the TLS certificate file in the container for the web server. Either `keySecret` or `keyFile` must be defined. @@ -2502,7 +2502,7 @@ spec: type: string cipherSuites: description: |- - List of supported cipher suites for TLS versions up to TLS 1.2. + cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2. If not defined, the Go default cipher suites are used. Available cipher suites are documented in the Go documentation: @@ -2512,13 +2512,13 @@ spec: type: array client_ca: description: |- - Secret or ConfigMap containing the CA certificate for client certificate + client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server. It is mutually exclusive with `clientCAFile`. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2540,7 +2540,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2564,21 +2564,21 @@ spec: type: object clientAuthType: description: |- - The server policy for client TLS authentication. + clientAuthType defines the server policy for client TLS authentication. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType type: string clientCAFile: description: |- - Path to the CA certificate file for client certificate authentication to + clientCAFile defines the path to the CA certificate file for client certificate authentication to the server. It is mutually exclusive with `client_ca`. type: string curvePreferences: description: |- - Elliptic curves that will be used in an ECDHE handshake, in preference + curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the Go documentation: @@ -2588,7 +2588,7 @@ spec: type: array keyFile: description: |- - Path to the TLS private key file in the container for the web server. + keyFile defines the path to the TLS private key file in the container for the web server. If defined, either `cert` or `certFile` must be defined. @@ -2596,7 +2596,7 @@ spec: type: string keySecret: description: |- - Secret containing the TLS private key for the web server. + keySecret defines the secret containing the TLS private key for the web server. Either `cert` or `certFile` must be defined. @@ -2622,14 +2622,14 @@ spec: type: object x-kubernetes-map-type: atomic maxVersion: - description: Maximum TLS version that is acceptable. + description: maxVersion defines the Maximum TLS version that is acceptable. type: string minVersion: - description: Minimum TLS version that is acceptable. + description: minVersion defines the minimum TLS version that is acceptable. type: string preferServerCipherSuites: description: |- - Controls whether the server selects the client's most preferred cipher + preferServerCipherSuites defines whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in @@ -2642,7 +2642,7 @@ spec: type: object configMaps: description: |- - ConfigMaps is a list of ConfigMaps in the same namespace as the Alertmanager + configMaps defines a list of ConfigMaps in the same namespace as the Alertmanager object, which shall be mounted into the Alertmanager Pods. Each ConfigMap is added to the StatefulSet definition as a volume named `configmap-`. The ConfigMaps are mounted into `/etc/alertmanager/configmaps/` in the 'alertmanager' container. @@ -2651,7 +2651,7 @@ spec: type: array configSecret: description: |- - ConfigSecret is the name of a Kubernetes Secret in the same namespace as the + configSecret defines the name of a Kubernetes Secret in the same namespace as the Alertmanager object, which contains the configuration for this Alertmanager instance. If empty, it defaults to `alertmanager-`. @@ -2666,7 +2666,7 @@ spec: type: string containers: description: |- - Containers allows injecting additional containers. This is meant to + containers allows injecting additional containers. This is meant to allow adding an authentication proxy to an Alertmanager pod. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge @@ -4135,11 +4135,11 @@ spec: type: object type: array dnsConfig: - description: Defines the DNS configuration for the pods. + description: dnsConfig defines the DNS configuration for the pods. properties: nameservers: description: |- - A list of DNS name server IP addresses. + nameservers defines the list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. items: minLength: 1 @@ -4148,7 +4148,7 @@ spec: x-kubernetes-list-type: set options: description: |- - A list of DNS resolver options. + options defines the list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Resolution options given in Options will override those that appear in the base DNSPolicy. @@ -4156,11 +4156,11 @@ spec: description: PodDNSConfigOption defines DNS resolver options of a pod. properties: name: - description: Name is required and must be unique. + description: name is required and must be unique. minLength: 1 type: string value: - description: Value is optional. + description: value is optional. type: string required: - name @@ -4171,7 +4171,7 @@ spec: x-kubernetes-list-type: map searches: description: |- - A list of DNS search domains for host-name lookup. + searches defines the list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. items: minLength: 1 @@ -4180,7 +4180,7 @@ spec: x-kubernetes-list-type: set type: object dnsPolicy: - description: Defines the DNS policy for the pods. + description: dnsPolicy defines the DNS policy for the pods. enum: - ClusterFirstWithHostNet - ClusterFirst @@ -4189,7 +4189,7 @@ spec: type: string enableFeatures: description: |- - Enable access to Alertmanager feature flags. By default, no features are enabled. + enableFeatures defines the Alertmanager's feature flags. By default, no features are enabled. Enabling features which are disabled by default is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. @@ -4199,33 +4199,33 @@ spec: type: string type: array enableServiceLinks: - description: Indicates whether information about services should be injected into pod's environment variables + description: enableServiceLinks defines whether information about services should be injected into pod's environment variables type: boolean externalUrl: description: |- - The external URL the Alertmanager instances will be available under. This is + externalUrl defines the URL used to access the Alertmanager web service. This is necessary to generate correct URLs. This is necessary if Alertmanager is not served from root of a DNS name. type: string forceEnableClusterMode: description: |- - ForceEnableClusterMode ensures Alertmanager does not deactivate the cluster mode when running with a single replica. + forceEnableClusterMode ensures Alertmanager does not deactivate the cluster mode when running with a single replica. Use case is e.g. spanning an Alertmanager cluster across Kubernetes clusters with a single replica in each. type: boolean hostAliases: - description: Pods' hostAliases configuration + description: hostAliases Pods configuration items: description: |- HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. properties: hostnames: - description: Hostnames for the above IP address. + description: hostnames defines hostnames for the above IP address. items: type: string type: array ip: - description: IP address of the host file entry. + description: ip defines the IP address of the host file entry. type: string required: - hostnames @@ -4237,7 +4237,7 @@ spec: x-kubernetes-list-type: map hostUsers: description: |- - HostUsers supports the user space in Kubernetes. + hostUsers supports the user space in Kubernetes. More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/ @@ -4246,14 +4246,14 @@ spec: type: boolean image: description: |- - Image if specified has precedence over baseImage, tag and sha + image if specified has precedence over baseImage, tag and sha combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Alertmanager is being configured. type: string imagePullPolicy: description: |- - Image pull policy for the 'alertmanager', 'init-config-reloader' and 'config-reloader' containers. + imagePullPolicy for the 'alertmanager', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details. enum: - "" @@ -4263,7 +4263,7 @@ spec: type: string imagePullSecrets: description: |- - An optional list of references to secrets in the same namespace + imagePullSecrets An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ items: @@ -4285,7 +4285,7 @@ spec: type: array initContainers: description: |- - InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. + initContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the Alertmanager configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers described here modify an operator @@ -5755,18 +5755,18 @@ spec: type: object type: array limits: - description: Defines the limits command line flags when starting Alertmanager. + description: limits defines the limits command line flags when starting Alertmanager. properties: maxPerSilenceBytes: description: |- - The maximum size of an individual silence as stored on disk. This corresponds to the Alertmanager's + maxPerSilenceBytes defines the maximum size of an individual silence as stored on disk. This corresponds to the Alertmanager's `--silences.max-per-silence-bytes` flag. It requires Alertmanager >= v0.28.0. pattern: (^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$ type: string maxSilences: description: |- - The maximum number active and pending silences. This corresponds to the + maxSilences defines the maximum number active and pending silences. This corresponds to the Alertmanager's `--silences.max-silences` flag. It requires Alertmanager >= v0.28.0. format: int32 @@ -5775,19 +5775,19 @@ spec: type: object listenLocal: description: |- - ListenLocal makes the Alertmanager server listen on loopback, so that it + listenLocal defines the Alertmanager server listen on loopback, so that it does not bind against the Pod IP. Note this is only for the Alertmanager UI, not the gossip communication. type: boolean logFormat: - description: Log format for Alertmanager to be configured with. + description: logFormat for Alertmanager to be configured with. enum: - "" - logfmt - json type: string logLevel: - description: Log level for Alertmanager to be configured with. + description: logLevel for Alertmanager to be configured with. enum: - "" - debug @@ -5797,7 +5797,7 @@ spec: type: string minReadySeconds: description: |- - Minimum number of seconds for which a newly created pod should be ready + minReadySeconds defines the minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. If unset, pods will be considered available as soon as they are ready. @@ -5807,16 +5807,16 @@ spec: nodeSelector: additionalProperties: type: string - description: Define which Nodes the Pods are scheduled on. + description: nodeSelector defines which Nodes the Pods are scheduled on. type: object paused: description: |- - If set to true all actions on the underlying managed objects are not + paused if set to true all actions on the underlying managed objects are not going to be performed, except for delete actions. type: boolean persistentVolumeClaimRetentionPolicy: description: |- - The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet. + persistentVolumeClaimRetentionPolicy controls if and how PVCs are deleted during the lifecycle of a StatefulSet. The default behavior is all PVCs are retained. This is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26. It requires enabling the StatefulSetAutoDeletePVC feature gate. @@ -5839,7 +5839,7 @@ spec: type: object podMetadata: description: |- - PodMetadata configures labels and annotations which are propagated to the Alertmanager pods. + podMetadata defines labels and annotations which are propagated to the Alertmanager pods. The following items are reserved and cannot be overridden: * "alertmanager" label, set to the name of the Alertmanager instance. @@ -5853,7 +5853,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ @@ -5862,14 +5862,14 @@ spec: additionalProperties: type: string description: |- - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. @@ -5880,21 +5880,21 @@ spec: portName: default: web description: |- - Port name used for the pods and governing service. + portName defines the port's name for the pods and governing service. Defaults to `web`. type: string priorityClassName: - description: Priority class assigned to the Pods + description: priorityClassName assigned to the Pods type: string replicas: description: |- - Size is the expected size of the alertmanager cluster. The controller will + replicas defines the expected size of the alertmanager cluster. The controller will eventually make the size of the running cluster equal to the expected size. format: int32 type: integer resources: - description: Define resources requests and limits for single Pods. + description: resources defines the resource requests and limits of the Pods. properties: claims: description: |- @@ -5955,20 +5955,20 @@ spec: retention: default: 120h description: |- - Time duration Alertmanager shall retain data for. Default is '120h', + retention defines the time duration Alertmanager shall retain data for. Default is '120h', and must match the regular expression `[0-9]+(ms|s|m|h)` (milliseconds seconds minutes hours). pattern: ^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string routePrefix: description: |- - The route prefix Alertmanager registers HTTP handlers for. This is useful, + routePrefix Alertmanager registers HTTP handlers for. This is useful, if using ExternalURL and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but the server serves requests under a different route prefix. For example for use with `kubectl proxy`. type: string secrets: description: |- - Secrets is a list of Secrets in the same namespace as the Alertmanager + secrets is a list of Secrets in the same namespace as the Alertmanager object, which shall be mounted into the Alertmanager Pods. Each Secret is added to the StatefulSet definition as a volume named `secret-`. The Secrets are mounted into `/etc/alertmanager/secrets/` in the 'alertmanager' container. @@ -5977,7 +5977,7 @@ spec: type: array securityContext: description: |- - SecurityContext holds pod-level security attributes and common container settings. + securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext. properties: appArmorProfile: @@ -6206,12 +6206,12 @@ spec: type: object serviceAccountName: description: |- - ServiceAccountName is the name of the ServiceAccount to use to run the + serviceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods. type: string serviceName: description: |- - The name of the service name used by the underlying StatefulSet(s) as the governing service. + serviceName defines the service name used by the underlying StatefulSet(s) as the governing service. If defined, the Service must be created before the Alertmanager resource in the same namespace and it must define a selector that matches the pod labels. If empty, the operator will create and manage a headless service named `alertmanager-operated` for Alermanager resources. When deploying multiple Alertmanager resources in the same namespace, it is recommended to specify a different value for each. @@ -6220,22 +6220,22 @@ spec: type: string sha: description: |- - SHA of Alertmanager container image to be deployed. Defaults to the value of `version`. + sha of Alertmanager container image to be deployed. Defaults to the value of `version`. Similar to a tag, but the SHA explicitly deploys an immutable container image. Version and Tag are ignored if SHA is set. Deprecated: use 'image' instead. The image digest can be specified as part of the image URL. type: string storage: description: |- - Storage is the definition of how storage will be used by the Alertmanager + storage defines the definition of how storage will be used by the Alertmanager instances. properties: disableMountSubPath: - description: 'Deprecated: subPath usage will be removed in a future release.' + description: 'disableMountSubPath deprecated: subPath usage will be removed in a future release.' type: boolean emptyDir: description: |- - EmptyDirVolumeSource to be used by the StatefulSet. + emptyDir to be used by the StatefulSet. If specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir properties: @@ -6262,7 +6262,7 @@ spec: type: object ephemeral: description: |- - EphemeralVolumeSource to be used by the StatefulSet. + ephemeral to be used by the StatefulSet. This is a beta field in k8s 1.21 and GA in 1.15. For lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes @@ -6498,7 +6498,7 @@ spec: type: object volumeClaimTemplate: description: |- - Defines the PVC spec to be used by the Prometheus StatefulSets. + volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets. The easiest way to use a volume that cannot be automatically provisioned is to use a label selector alongside manually created PersistentVolumes. properties: @@ -6518,13 +6518,13 @@ spec: More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: - description: EmbeddedMetadata contains metadata relevant to an EmbeddedResource. + description: metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource. properties: annotations: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ @@ -6533,14 +6533,14 @@ spec: additionalProperties: type: string description: |- - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. @@ -6550,7 +6550,7 @@ spec: type: object spec: description: |- - Defines the desired characteristics of a volume requested by a pod author. + spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims properties: accessModes: @@ -6742,7 +6742,7 @@ spec: type: string type: object status: - description: 'Deprecated: this field is never set.' + description: 'status is deprecated: this field is never set.' properties: accessModes: description: |- @@ -6850,13 +6850,13 @@ spec: type: object tag: description: |- - Tag of Alertmanager container image to be deployed. Defaults to the value of `version`. + tag of Alertmanager container image to be deployed. Defaults to the value of `version`. Version is ignored if Tag is set. Deprecated: use 'image' instead. The image tag can be specified as part of the image URL. type: string terminationGracePeriodSeconds: description: |- - Optional duration in seconds the pod needs to terminate gracefully. + terminationGracePeriodSeconds defines the Optional duration in seconds the pod needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down) which may lead to data corruption. @@ -6865,7 +6865,7 @@ spec: minimum: 0 type: integer tolerations: - description: If specified, the pod's tolerations. + description: tolerations defines the pod's tolerations. items: description: |- The pod this Toleration is attached to tolerates any taint that matches @@ -6904,7 +6904,7 @@ spec: type: object type: array topologySpreadConstraints: - description: If specified, the pod's topology spread constraints. + description: topologySpreadConstraints defines the Pod's topology spread constraints. items: description: TopologySpreadConstraint specifies how to spread matching pods among the given topology. properties: @@ -7075,11 +7075,11 @@ spec: type: object type: array version: - description: Version the cluster should be on. + description: version the cluster should be on. type: string volumeMounts: description: |- - VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. + volumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the alertmanager container, that are generated as a result of StorageSpec objects. items: @@ -7145,7 +7145,7 @@ spec: type: array volumes: description: |- - Volumes allows configuration of additional volumes on the output StatefulSet definition. + volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects. items: @@ -8945,28 +8945,28 @@ spec: type: object type: array web: - description: Defines the web command line flags when starting Alertmanager. + description: web defines the web command line flags when starting Alertmanager. properties: getConcurrency: description: |- - Maximum number of GET requests processed concurrently. This corresponds to the + getConcurrency defines the maximum number of GET requests processed concurrently. This corresponds to the Alertmanager's `--web.get-concurrency` flag. format: int32 type: integer httpConfig: - description: Defines HTTP parameters for web server. + description: httpConfig defines HTTP parameters for web server. properties: headers: - description: List of headers that can be added to HTTP responses. + description: headers defines a list of headers that can be added to HTTP responses. properties: contentSecurityPolicy: description: |- - Set the Content-Security-Policy header to HTTP responses. + contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank. type: string strictTransportSecurity: description: |- - Set the Strict-Transport-Security header to HTTP responses. + strictTransportSecurity defines the Strict-Transport-Security header to HTTP responses. Unset if blank. Please make sure that you use this with care as this header might force browsers to load Prometheus and the other applications hosted on the same @@ -8975,7 +8975,7 @@ spec: type: string xContentTypeOptions: description: |- - Set the X-Content-Type-Options header to HTTP responses. + xContentTypeOptions defines the X-Content-Type-Options header to HTTP responses. Unset if blank. Accepted value is nosniff. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options enum: @@ -8984,7 +8984,7 @@ spec: type: string xFrameOptions: description: |- - Set the X-Frame-Options header to HTTP responses. + xFrameOptions defines the X-Frame-Options header to HTTP responses. Unset if blank. Accepted values are deny and sameorigin. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options enum: @@ -8994,37 +8994,37 @@ spec: type: string xXSSProtection: description: |- - Set the X-XSS-Protection header to all responses. + xXSSProtection defines the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection type: string type: object http2: description: |- - Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. + http2 enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. When TLSConfig is not configured, HTTP/2 will be disabled. Whenever the value of the field changes, a rolling update will be triggered. type: boolean type: object timeout: description: |- - Timeout for HTTP requests. This corresponds to the Alertmanager's + timeout for HTTP requests. This corresponds to the Alertmanager's `--web.timeout` flag. format: int32 type: integer tlsConfig: - description: Defines the TLS parameters for HTTPS. + description: tlsConfig defines the TLS parameters for HTTPS. properties: cert: description: |- - Secret or ConfigMap containing the TLS certificate for the web server. + cert defines the Secret or ConfigMap containing the TLS certificate for the web server. Either `keySecret` or `keyFile` must be defined. It is mutually exclusive with `certFile`. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9046,7 +9046,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9070,7 +9070,7 @@ spec: type: object certFile: description: |- - Path to the TLS certificate file in the container for the web server. + certFile defines the path to the TLS certificate file in the container for the web server. Either `keySecret` or `keyFile` must be defined. @@ -9078,7 +9078,7 @@ spec: type: string cipherSuites: description: |- - List of supported cipher suites for TLS versions up to TLS 1.2. + cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2. If not defined, the Go default cipher suites are used. Available cipher suites are documented in the Go documentation: @@ -9088,13 +9088,13 @@ spec: type: array client_ca: description: |- - Secret or ConfigMap containing the CA certificate for client certificate + client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server. It is mutually exclusive with `clientCAFile`. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9116,7 +9116,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9140,21 +9140,21 @@ spec: type: object clientAuthType: description: |- - The server policy for client TLS authentication. + clientAuthType defines the server policy for client TLS authentication. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType type: string clientCAFile: description: |- - Path to the CA certificate file for client certificate authentication to + clientCAFile defines the path to the CA certificate file for client certificate authentication to the server. It is mutually exclusive with `client_ca`. type: string curvePreferences: description: |- - Elliptic curves that will be used in an ECDHE handshake, in preference + curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the Go documentation: @@ -9164,7 +9164,7 @@ spec: type: array keyFile: description: |- - Path to the TLS private key file in the container for the web server. + keyFile defines the path to the TLS private key file in the container for the web server. If defined, either `cert` or `certFile` must be defined. @@ -9172,7 +9172,7 @@ spec: type: string keySecret: description: |- - Secret containing the TLS private key for the web server. + keySecret defines the secret containing the TLS private key for the web server. Either `cert` or `certFile` must be defined. @@ -9198,14 +9198,14 @@ spec: type: object x-kubernetes-map-type: atomic maxVersion: - description: Maximum TLS version that is acceptable. + description: maxVersion defines the Maximum TLS version that is acceptable. type: string minVersion: - description: Minimum TLS version that is acceptable. + description: minVersion defines the minimum TLS version that is acceptable. type: string preferServerCipherSuites: description: |- - Controls whether the server selects the client's most preferred cipher + preferServerCipherSuites defines whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in @@ -9216,18 +9216,18 @@ spec: type: object status: description: |- - Most recent observed status of the Alertmanager cluster. Read-only. + status defines the most recent observed status of the Alertmanager cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status properties: availableReplicas: description: |- - Total number of available pods (ready for at least minReadySeconds) + availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this Alertmanager cluster. format: int32 type: integer conditions: - description: The current state of the Alertmanager object. + description: conditions defines the current state of the Alertmanager object. items: description: |- Condition represents the state of the resources associated with the @@ -9238,11 +9238,11 @@ spec: format: date-time type: string message: - description: Human-readable message indicating details for the condition's last transition. + description: message defines human-readable message indicating details for the condition's last transition. type: string observedGeneration: description: |- - ObservedGeneration represents the .metadata.generation that the + observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if `.metadata.generation` is currently 12, but the `.status.conditions[].observedGeneration` is 9, the condition is out of date with respect to the current state of the @@ -9250,14 +9250,14 @@ spec: format: int64 type: integer reason: - description: Reason for the condition's last transition. + description: reason for the condition's last transition. type: string status: - description: Status of the condition. + description: status of the condition. minLength: 1 type: string type: - description: Type of the condition being reported. + description: type of the condition being reported. minLength: 1 type: string required: @@ -9271,34 +9271,28 @@ spec: x-kubernetes-list-type: map paused: description: |- - Represents whether any actions on the underlying managed objects are + paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed. type: boolean replicas: description: |- - Total number of non-terminated pods targeted by this Alertmanager + replicas defines the total number of non-terminated pods targeted by this Alertmanager object (their labels match the selector). format: int32 type: integer selector: - description: The selector used to match the pods targeted by this Alertmanager object. + description: selector used to match the pods targeted by this Alertmanager object. type: string unavailableReplicas: - description: Total number of unavailable pods targeted by this Alertmanager object. + description: unavailableReplicas defines the total number of unavailable pods targeted by this Alertmanager object. format: int32 type: integer updatedReplicas: description: |- - Total number of non-terminated pods targeted by this Alertmanager + updatedReplicas defines the total number of non-terminated pods targeted by this Alertmanager object that have the desired version spec. format: int32 type: integer - required: - - availableReplicas - - paused - - replicas - - unavailableReplicas - - updatedReplicas type: object required: - spec diff --git a/monitoring-satellite/manifests/crds/prometheusOperator-0podmonitorCustomResourceDefinition.yaml b/monitoring-satellite/manifests/crds/prometheusOperator-0podmonitorCustomResourceDefinition.yaml index 1e864bf3..7f936000 100644 --- a/monitoring-satellite/manifests/crds/prometheusOperator-0podmonitorCustomResourceDefinition.yaml +++ b/monitoring-satellite/manifests/crds/prometheusOperator-0podmonitorCustomResourceDefinition.yaml @@ -3,7 +3,7 @@ kind: CustomResourceDefinition metadata: annotations: argocd.argoproj.io/sync-options: Replace=true - controller-gen.kubebuilder.io/version: v0.18.0 + controller-gen.kubebuilder.io/version: v0.19.0 operator.prometheus.io/version: 0.85.0 name: podmonitors.monitoring.coreos.com spec: @@ -50,18 +50,18 @@ spec: metadata: type: object spec: - description: Specification of desired Pod selection for target discovery by Prometheus. + description: spec defines the specification of desired Pod selection for target discovery by Prometheus. properties: attachMetadata: description: |- - `attachMetadata` defines additional metadata which is added to the + attachMetadata defines additional metadata which is added to the discovered targets. It requires Prometheus >= v2.35.0. properties: node: description: |- - When set to true, Prometheus attaches node metadata to the discovered + node when set to true, Prometheus attaches node metadata to the discovered targets. The Prometheus service account must have the `list` and `watch` @@ -70,7 +70,7 @@ spec: type: object bodySizeLimit: description: |- - When defined, bodySizeLimit specifies a job level limit on the size + bodySizeLimit when defined specifies a job level limit on the size of uncompressed response body that will be accepted by Prometheus. It requires Prometheus >= v2.28.0. @@ -78,12 +78,12 @@ spec: type: string convertClassicHistogramsToNHCB: description: |- - Whether to convert all scraped classic histograms into a native histogram with custom buckets. + convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0. type: boolean fallbackScrapeProtocol: description: |- - The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. + fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It requires Prometheus >= v3.0.0. enum: @@ -95,7 +95,7 @@ spec: type: string jobLabel: description: |- - The label to use to retrieve the job name from. + jobLabel defines the label to use to retrieve the job name from. `jobLabel` selects the label from the associated Kubernetes `Pod` object which will be used as the `job` label for all metrics. @@ -108,7 +108,7 @@ spec: type: string keepDroppedTargets: description: |- - Per-scrape limit on the number of targets dropped by relabeling + keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0. @@ -116,44 +116,44 @@ spec: type: integer labelLimit: description: |- - Per-scrape limit on number of labels that will be accepted for a sample. + labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample. It requires Prometheus >= v2.27.0. format: int64 type: integer labelNameLengthLimit: description: |- - Per-scrape limit on length of labels name that will be accepted for a sample. + labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. It requires Prometheus >= v2.27.0. format: int64 type: integer labelValueLengthLimit: description: |- - Per-scrape limit on length of labels value that will be accepted for a sample. + labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. It requires Prometheus >= v2.27.0. format: int64 type: integer namespaceSelector: description: |- - `namespaceSelector` defines in which namespace(s) Prometheus should discover the pods. + namespaceSelector defines in which namespace(s) Prometheus should discover the pods. By default, the pods are discovered in the same namespace as the `PodMonitor` object but it is possible to select pods across different/all namespaces. properties: any: description: |- - Boolean describing whether all namespaces are selected in contrast to a + any defines the boolean describing whether all namespaces are selected in contrast to a list restricting them. type: boolean matchNames: - description: List of namespace names to select from. + description: matchNames defines the list of namespace names to select from. items: type: string type: array type: object nativeHistogramBucketLimit: description: |- - If there are more than this many buckets in a native histogram, + nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0. format: int64 @@ -163,13 +163,13 @@ spec: - type: integer - type: string description: |- - If the growth factor of one bucket to the next is smaller than this, + nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this, buckets will be merged to increase the factor sufficiently. It requires Prometheus >= v2.50.0. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true podMetricsEndpoints: - description: Defines how to scrape metrics from the selected pods. + description: podMetricsEndpoints defines how to scrape metrics from the selected pods. items: description: |- PodMetricsEndpoint defines an endpoint serving Prometheus metrics to be scraped by @@ -177,13 +177,13 @@ spec: properties: authorization: description: |- - `authorization` configures the Authorization header credentials to use when + authorization defines the Authorization header credentials to use when scraping the target. Cannot be set at the same time as `basicAuth`, or `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -206,7 +206,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -215,14 +215,14 @@ spec: type: object basicAuth: description: |- - `basicAuth` configures the Basic Authentication credentials to use when + basicAuth defines the Basic Authentication credentials to use when scraping the target. Cannot be set at the same time as `authorization`, or `oauth2`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -246,7 +246,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -271,7 +271,7 @@ spec: type: object bearerTokenSecret: description: |- - `bearerTokenSecret` specifies a key of a Secret containing the bearer + bearerTokenSecret defines a key of a Secret containing the bearer token for scraping targets. The secret needs to be in the same namespace as the PodMonitor object and readable by the Prometheus Operator. @@ -297,11 +297,11 @@ spec: type: object x-kubernetes-map-type: atomic enableHttp2: - description: '`enableHttp2` can be used to disable HTTP2 when scraping the target.' + description: enableHttp2 can be used to disable HTTP2 when scraping the target. type: boolean filterRunning: description: |- - When true, the pods which are not running (e.g. either in Failed or + filterRunning when true, the pods which are not running (e.g. either in Failed or Succeeded state) are dropped during the target discovery. If unset, the filtering is enabled. @@ -310,29 +310,29 @@ spec: type: boolean followRedirects: description: |- - `followRedirects` defines whether the scrape requests should follow HTTP + followRedirects defines whether the scrape requests should follow HTTP 3xx redirects. type: boolean honorLabels: description: |- - When true, `honorLabels` preserves the metric's labels when they collide + honorLabels when true preserves the metric's labels when they collide with the target's labels. type: boolean honorTimestamps: description: |- - `honorTimestamps` controls whether Prometheus preserves the timestamps + honorTimestamps defines whether Prometheus preserves the timestamps when exposed by the target. type: boolean interval: description: |- - Interval at which Prometheus scrapes the metrics from the target. + interval at which Prometheus scrapes the metrics from the target. If empty, Prometheus uses the global scrape interval. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string metricRelabelings: description: |- - `metricRelabelings` configures the relabeling rules to apply to the + metricRelabelings defines the relabeling rules to apply to the samples before ingestion. items: description: |- @@ -344,7 +344,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -376,27 +376,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -408,7 +408,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -419,7 +419,7 @@ spec: type: array noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -427,7 +427,7 @@ spec: type: string oauth2: description: |- - `oauth2` configures the OAuth2 settings to use when scraping the target. + oauth2 defines the OAuth2 settings to use when scraping the target. It requires Prometheus >= 2.27.0. @@ -435,11 +435,11 @@ spec: properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -461,7 +461,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -485,7 +485,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -511,12 +511,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -548,7 +548,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -556,29 +556,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -600,7 +600,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -623,10 +623,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -648,7 +648,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -671,10 +671,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -697,7 +697,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -708,7 +708,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -718,11 +718,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -735,22 +735,22 @@ spec: items: type: string type: array - description: '`params` define optional HTTP URL parameters.' + description: params define optional HTTP URL parameters. type: object path: description: |- - HTTP path from which to scrape for metrics. + path defines the HTTP path from which to scrape for metrics. If empty, Prometheus uses the default value (e.g. `/metrics`). type: string port: description: |- - The `Pod` port name which exposes the endpoint. + port defines the `Pod` port name which exposes the endpoint. It takes precedence over the `portNumber` and `targetPort` fields. type: string portNumber: - description: The `Pod` port number which exposes the endpoint. + description: portNumber defines the `Pod` port number which exposes the endpoint. format: int32 maximum: 65535 minimum: 1 @@ -781,7 +781,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -789,17 +789,17 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string relabelings: description: |- - `relabelings` configures the relabeling rules to apply the target's + relabelings defines the relabeling rules to apply the target's metadata labels. The Operator automatically adds relabelings for a few standard Kubernetes fields. @@ -817,7 +817,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -849,27 +849,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -881,7 +881,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -892,7 +892,7 @@ spec: type: array scheme: description: |- - HTTP scheme to use for scraping. + scheme defines the HTTP scheme to use for scraping. `http` and `https` are the expected values unless you rewrite the `__scheme__` label via relabeling. @@ -904,7 +904,7 @@ spec: type: string scrapeTimeout: description: |- - Timeout after which Prometheus considers the scrape to be failed. + scrapeTimeout defines the timeout after which Prometheus considers the scrape to be failed. If empty, Prometheus uses the global scrape timeout unless it is less than the target's scrape interval value in which the latter is used. @@ -916,19 +916,19 @@ spec: - type: integer - type: string description: |- - Name or number of the target port of the `Pod` object behind the Service, the + targetPort defines the name or number of the target port of the `Pod` object behind the Service, the port must be specified with container port property. Deprecated: use 'port' or 'portNumber' instead. x-kubernetes-int-or-string: true tlsConfig: - description: TLS configuration to use when scraping the target. + description: tlsConfig defines the TLS configuration to use when scraping the target. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -950,7 +950,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -973,10 +973,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -998,7 +998,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1021,10 +1021,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1047,7 +1047,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -1058,7 +1058,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -1068,12 +1068,12 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object trackTimestampsStaleness: description: |- - `trackTimestampsStaleness` defines whether Prometheus tracks staleness of + trackTimestampsStaleness defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if `honorTimestamps` is false. @@ -1083,31 +1083,31 @@ spec: type: array podTargetLabels: description: |- - `podTargetLabels` defines the labels which are transferred from the + podTargetLabels defines the labels which are transferred from the associated Kubernetes `Pod` object onto the ingested metrics. items: type: string type: array sampleLimit: description: |- - `sampleLimit` defines a per-scrape limit on the number of scraped samples + sampleLimit defines a per-scrape limit on the number of scraped samples that will be accepted. format: int64 type: integer scrapeClass: - description: The scrape class to apply. + description: scrapeClass defines the scrape class to apply. minLength: 1 type: string scrapeClassicHistograms: description: |- - Whether to scrape a classic histogram that is also exposed as a native histogram. + scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0. Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration. type: boolean scrapeProtocols: description: |- - `scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the + scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. @@ -1132,7 +1132,7 @@ spec: type: array x-kubernetes-list-type: set selector: - description: Label selector to select the Kubernetes `Pod` objects to scrape metrics from. + description: selector defines the label selector to select the Kubernetes `Pod` objects to scrape metrics from. properties: matchExpressions: description: matchExpressions is a list of label selector requirements. The requirements are ANDed. @@ -1177,7 +1177,7 @@ spec: x-kubernetes-map-type: atomic selectorMechanism: description: |- - Mechanism used to select the endpoints to scrape. + selectorMechanism defines the mechanism used to select the endpoints to scrape. By default, the selection process relies on relabel configurations to filter the discovered targets. Alternatively, you can opt in for role selectors, which may offer better efficiency in large clusters. Which strategy is best for your use case needs to be carefully evaluated. @@ -1189,7 +1189,7 @@ spec: type: string targetLimit: description: |- - `targetLimit` defines a limit on the number of scraped targets that will + targetLimit defines a limit on the number of scraped targets that will be accepted. format: int64 type: integer diff --git a/monitoring-satellite/manifests/crds/prometheusOperator-0probeCustomResourceDefinition.yaml b/monitoring-satellite/manifests/crds/prometheusOperator-0probeCustomResourceDefinition.yaml index 6c87c21a..47317966 100644 --- a/monitoring-satellite/manifests/crds/prometheusOperator-0probeCustomResourceDefinition.yaml +++ b/monitoring-satellite/manifests/crds/prometheusOperator-0probeCustomResourceDefinition.yaml @@ -3,7 +3,7 @@ kind: CustomResourceDefinition metadata: annotations: argocd.argoproj.io/sync-options: Replace=true - controller-gen.kubebuilder.io/version: v0.18.0 + controller-gen.kubebuilder.io/version: v0.19.0 operator.prometheus.io/version: 0.85.0 name: probes.monitoring.coreos.com spec: @@ -49,13 +49,13 @@ spec: metadata: type: object spec: - description: Specification of desired Ingress selection for target discovery by Prometheus. + description: spec defines the specification of desired Ingress selection for target discovery by Prometheus. properties: authorization: - description: Authorization section for this endpoint + description: authorization section for this endpoint properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -78,7 +78,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -87,12 +87,12 @@ spec: type: object basicAuth: description: |- - BasicAuth allow an endpoint to authenticate over basic authentication. + basicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -116,7 +116,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -141,7 +141,7 @@ spec: type: object bearerTokenSecret: description: |- - Secret to mount to read bearer token for scraping targets. The secret + bearerTokenSecret defines the secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the probe and accessible by the Prometheus Operator. properties: @@ -166,12 +166,12 @@ spec: x-kubernetes-map-type: atomic convertClassicHistogramsToNHCB: description: |- - Whether to convert all scraped classic histograms into a native histogram with custom buckets. + convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0. type: boolean fallbackScrapeProtocol: description: |- - The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. + fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It requires Prometheus >= v3.0.0. enum: @@ -183,16 +183,16 @@ spec: type: string interval: description: |- - Interval at which targets are probed using the configured prober. + interval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string jobName: - description: The job name assigned to scraped metrics by default. + description: jobName assigned to scraped metrics by default. type: string keepDroppedTargets: description: |- - Per-scrape limit on the number of targets dropped by relabeling + keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0. @@ -200,24 +200,24 @@ spec: type: integer labelLimit: description: |- - Per-scrape limit on number of labels that will be accepted for a sample. + labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. format: int64 type: integer labelNameLengthLimit: description: |- - Per-scrape limit on length of labels name that will be accepted for a sample. + labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. format: int64 type: integer labelValueLengthLimit: description: |- - Per-scrape limit on length of labels value that will be accepted for a sample. + labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. format: int64 type: integer metricRelabelings: - description: MetricRelabelConfigs to apply to samples before ingestion. + description: metricRelabelings defines the RelabelConfig to apply to samples before ingestion. items: description: |- RelabelConfig allows dynamic rewriting of the label set for targets, alerts, @@ -228,7 +228,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -260,27 +260,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -292,7 +292,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -303,13 +303,13 @@ spec: type: array module: description: |- - The module to use for probing specifying how to probe the target. + module to use for probing specifying how to probe the target. Example module configuring in the blackbox exporter: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml type: string nativeHistogramBucketLimit: description: |- - If there are more than this many buckets in a native histogram, + nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0. format: int64 @@ -319,21 +319,21 @@ spec: - type: integer - type: string description: |- - If the growth factor of one bucket to the next is smaller than this, + nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this, buckets will be merged to increase the factor sufficiently. It requires Prometheus >= v2.50.0. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true oauth2: - description: OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. + description: oauth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -355,7 +355,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -379,7 +379,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -405,12 +405,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -442,7 +442,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -450,29 +450,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -494,7 +494,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -517,10 +517,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -542,7 +542,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -565,10 +565,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -591,7 +591,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -602,7 +602,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -612,11 +612,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -626,18 +626,18 @@ spec: type: object params: description: |- - The list of HTTP query parameters for the scrape. + params defines the list of HTTP query parameters for the scrape. Please note that the `.spec.module` field takes precedence over the `module` parameter from this list when both are defined. The module name must be added using Module under ProbeSpec. items: description: ProbeParam defines specification of extra parameters for a Probe. properties: name: - description: The parameter name + description: name defines the parameter name minLength: 1 type: string values: - description: The parameter values + description: values defines the parameter values items: minLength: 1 type: string @@ -653,12 +653,12 @@ spec: x-kubernetes-list-type: map prober: description: |- - Specification for the prober to use for probing targets. + prober defines the pecification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty. properties: noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -667,7 +667,7 @@ spec: path: default: /probe description: |- - Path to collect metrics from. + path to collect metrics from. Defaults to `/probe`. type: string proxyConnectHeader: @@ -696,7 +696,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -704,17 +704,17 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scheme: description: |- - HTTP scheme to use for scraping. + scheme defines the HTTP scheme to use for scraping. `http` and `https` are the expected values unless you rewrite the `__scheme__` label via relabeling. If empty, Prometheus uses the default value `http`. enum: @@ -722,29 +722,29 @@ spec: - https type: string url: - description: Mandatory URL of the prober. + description: url defines the mandatory URL of the prober. type: string required: - url type: object sampleLimit: - description: SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. + description: sampleLimit defines per-scrape limit on number of scraped samples that will be accepted. format: int64 type: integer scrapeClass: - description: The scrape class to apply. + description: scrapeClass defines the scrape class to apply. minLength: 1 type: string scrapeClassicHistograms: description: |- - Whether to scrape a classic histogram that is also exposed as a native histogram. + scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0. Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration. type: boolean scrapeProtocols: description: |- - `scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the + scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. @@ -770,17 +770,17 @@ spec: x-kubernetes-list-type: set scrapeTimeout: description: |- - Timeout for scraping metrics from the Prometheus exporter. + scrapeTimeout defines the timeout for scraping metrics from the Prometheus exporter. If not specified, the Prometheus global scrape timeout is used. The value cannot be greater than the scrape interval otherwise the operator will reject the resource. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string targetLimit: - description: TargetLimit defines a limit on the number of scraped targets that will be accepted. + description: targetLimit defines a limit on the number of scraped targets that will be accepted. format: int64 type: integer targets: - description: Targets defines a set of static or dynamically discovered targets to probe. + description: targets defines a set of static or dynamically discovered targets to probe. properties: ingress: description: |- @@ -789,22 +789,22 @@ spec: If `staticConfig` is also defined, `staticConfig` takes precedence. properties: namespaceSelector: - description: From which namespaces to select Ingress objects. + description: namespaceSelector defines from which namespaces to select Ingress objects. properties: any: description: |- - Boolean describing whether all namespaces are selected in contrast to a + any defines the boolean describing whether all namespaces are selected in contrast to a list restricting them. type: boolean matchNames: - description: List of namespace names to select from. + description: matchNames defines the list of namespace names to select from. items: type: string type: array type: object relabelingConfigs: description: |- - RelabelConfigs to apply to the label set of the target before it gets + relabelingConfigs to apply to the label set of the target before it gets scraped. The original ingress address is available via the `__tmp_prometheus_ingress_address` label. It can be used to customize the @@ -821,7 +821,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -853,27 +853,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -885,7 +885,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -895,7 +895,7 @@ spec: type: object type: array selector: - description: Selector to select the Ingress objects. + description: selector to select the Ingress objects. properties: matchExpressions: description: matchExpressions is a list of label selector requirements. The requirements are ANDed. @@ -949,11 +949,11 @@ spec: labels: additionalProperties: type: string - description: Labels assigned to all metrics scraped from the targets. + description: labels defines all labels assigned to all metrics scraped from the targets. type: object relabelingConfigs: description: |- - RelabelConfigs to apply to the label set of the targets before it gets + relabelingConfigs defines relabelings to be apply to the label set of the targets before it gets scraped. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config items: @@ -966,7 +966,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -998,27 +998,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -1030,7 +1030,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -1040,20 +1040,20 @@ spec: type: object type: array static: - description: The list of hosts to probe. + description: static defines the list of hosts to probe. items: type: string type: array type: object type: object tlsConfig: - description: TLS configuration to use when scraping the endpoint. + description: tlsConfig defines the TLS configuration to use when scraping the endpoint. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1075,7 +1075,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1098,10 +1098,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1123,7 +1123,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1146,10 +1146,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1172,7 +1172,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -1183,7 +1183,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -1193,7 +1193,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object diff --git a/monitoring-satellite/manifests/crds/prometheusOperator-0prometheusCustomResourceDefinition.yaml b/monitoring-satellite/manifests/crds/prometheusOperator-0prometheusCustomResourceDefinition.yaml index fa373612..a85b7975 100644 --- a/monitoring-satellite/manifests/crds/prometheusOperator-0prometheusCustomResourceDefinition.yaml +++ b/monitoring-satellite/manifests/crds/prometheusOperator-0prometheusCustomResourceDefinition.yaml @@ -3,7 +3,7 @@ kind: CustomResourceDefinition metadata: annotations: argocd.argoproj.io/sync-options: Replace=true - controller-gen.kubebuilder.io/version: v0.18.0 + controller-gen.kubebuilder.io/version: v0.19.0 operator.prometheus.io/version: 0.85.0 name: prometheuses.monitoring.coreos.com spec: @@ -77,12 +77,12 @@ spec: type: object spec: description: |- - Specification of the desired behavior of the Prometheus cluster. More info: + spec defines the specification of the desired behavior of the Prometheus cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status properties: additionalAlertManagerConfigs: description: |- - AdditionalAlertManagerConfigs specifies a key of a Secret containing + additionalAlertManagerConfigs defines a key of a Secret containing additional Prometheus Alertmanager configurations. The Alertmanager configurations are appended to the configuration generated by the Prometheus Operator. They must be formatted according to the official @@ -118,7 +118,7 @@ spec: x-kubernetes-map-type: atomic additionalAlertRelabelConfigs: description: |- - AdditionalAlertRelabelConfigs specifies a key of a Secret containing + additionalAlertRelabelConfigs defines a key of a Secret containing additional Prometheus alert relabel configurations. The alert relabel configurations are appended to the configuration generated by the Prometheus Operator. They must be formatted according to the official @@ -154,7 +154,7 @@ spec: x-kubernetes-map-type: atomic additionalArgs: description: |- - AdditionalArgs allows setting additional arguments for the 'prometheus' container. + additionalArgs allows setting additional arguments for the 'prometheus' container. It is intended for e.g. activating hidden flags which are not supported by the dedicated configuration options yet. The arguments are passed as-is to the @@ -168,11 +168,11 @@ spec: description: Argument as part of the AdditionalArgs list. properties: name: - description: Name of the argument, e.g. "scrape.discovery-reload-interval". + description: name of the argument, e.g. "scrape.discovery-reload-interval". minLength: 1 type: string value: - description: Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) + description: value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) type: string required: - name @@ -180,7 +180,7 @@ spec: type: array additionalScrapeConfigs: description: |- - AdditionalScrapeConfigs allows specifying a key of a Secret containing + additionalScrapeConfigs allows specifying a key of a Secret containing additional Prometheus scrape configurations. Scrape configurations specified are appended to the configurations generated by the Prometheus Operator. Job configurations specified must have the form as specified @@ -212,7 +212,7 @@ spec: type: object x-kubernetes-map-type: atomic affinity: - description: Defines the Pods' affinity scheduling rules if specified. + description: affinity defines the Pods' affinity scheduling rules if specified. properties: nodeAffinity: description: Describes node affinity scheduling rules for the pod. @@ -1085,10 +1085,10 @@ spec: type: object type: object alerting: - description: Defines the settings related to Alertmanager. + description: alerting defines the settings related to Alertmanager. properties: alertmanagers: - description: Alertmanager endpoints where Prometheus should send alerts to. + description: alertmanagers endpoints where Prometheus should send alerts to. items: description: |- AlertmanagerEndpoints defines a selection of a single Endpoints object @@ -1096,7 +1096,7 @@ spec: properties: alertRelabelings: description: |- - Relabeling configs applied before sending alerts to a specific Alertmanager. + alertRelabelings defines the relabeling configs applied before sending alerts to a specific Alertmanager. It requires Prometheus >= v2.51.0. items: description: |- @@ -1108,7 +1108,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -1140,27 +1140,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -1172,7 +1172,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -1183,7 +1183,7 @@ spec: type: array apiVersion: description: |- - Version of the Alertmanager API that Prometheus uses to send alerts. + apiVersion defines the version of the Alertmanager API that Prometheus uses to send alerts. It can be "V1" or "V2". The field has no effect for Prometheus >= v3.0.0 because only the v2 API is supported. enum: @@ -1194,12 +1194,12 @@ spec: type: string authorization: description: |- - Authorization section for Alertmanager. + authorization section for Alertmanager. Cannot be set at the same time as `basicAuth`, `bearerTokenFile` or `sigv4`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1222,7 +1222,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -1231,13 +1231,13 @@ spec: type: object basicAuth: description: |- - BasicAuth configuration for Alertmanager. + basicAuth configuration for Alertmanager. Cannot be set at the same time as `bearerTokenFile`, `authorization` or `sigv4`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -1261,7 +1261,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -1286,22 +1286,22 @@ spec: type: object bearerTokenFile: description: |- - File to read bearer token for Alertmanager. + bearerTokenFile defines the file to read bearer token for Alertmanager. Cannot be set at the same time as `basicAuth`, `authorization`, or `sigv4`. Deprecated: this will be removed in a future release. Prefer using `authorization`. type: string enableHttp2: - description: Whether to enable HTTP2. + description: enableHttp2 defines whether to enable HTTP2. type: boolean name: - description: Name of the Endpoints object in the namespace. + description: name of the Endpoints object in the namespace. minLength: 1 type: string namespace: description: |- - Namespace of the Endpoints object. + namespace of the Endpoints object. If not set, the object will be discovered in the namespace of the Prometheus object. @@ -1309,20 +1309,20 @@ spec: type: string noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string pathPrefix: - description: Prefix for the HTTP path alerts are pushed to. + description: pathPrefix defines the prefix for the HTTP path alerts are pushed to. type: string port: anyOf: - type: integer - type: string - description: Port on which the Alertmanager API is exposed. + description: port on which the Alertmanager API is exposed. x-kubernetes-int-or-string: true proxyConnectHeader: additionalProperties: @@ -1350,7 +1350,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -1358,16 +1358,16 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string relabelings: - description: Relabel configuration applied to the discovered Alertmanagers. + description: relabelings defines the relabel configuration applied to the discovered Alertmanagers. items: description: |- RelabelConfig allows dynamic rewriting of the label set for targets, alerts, @@ -1378,7 +1378,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -1410,27 +1410,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -1442,7 +1442,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -1452,11 +1452,11 @@ spec: type: object type: array scheme: - description: Scheme to use when firing alerts. + description: scheme to use when firing alerts. type: string sigv4: description: |- - Sigv4 allows to configures AWS's Signature Verification 4 for the URL. + sigv4 defines AWS's Signature Verification 4 for the URL. It requires Prometheus >= v2.48.0. @@ -1464,7 +1464,7 @@ spec: properties: accessKey: description: |- - AccessKey is the AWS API key. If not specified, the environment variable + accessKey defines the AWS API key. If not specified, the environment variable `AWS_ACCESS_KEY_ID` is used. properties: key: @@ -1487,17 +1487,17 @@ spec: type: object x-kubernetes-map-type: atomic profile: - description: Profile is the named AWS profile used to authenticate. + description: profile defines the named AWS profile used to authenticate. type: string region: - description: Region is the AWS region. If blank, the region from the default credentials chain used. + description: region defines the AWS region. If blank, the region from the default credentials chain used. type: string roleArn: - description: RoleArn is the named AWS profile used to authenticate. + description: roleArn defines the named AWS profile used to authenticate. type: string secretKey: description: |- - SecretKey is the AWS API secret. If not specified, the environment + secretKey defines the AWS API secret. If not specified, the environment variable `AWS_SECRET_ACCESS_KEY` is used. properties: key: @@ -1521,17 +1521,17 @@ spec: x-kubernetes-map-type: atomic type: object timeout: - description: Timeout is a per-target Alertmanager timeout when pushing alerts. + description: timeout defines a per-target Alertmanager timeout when pushing alerts. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string tlsConfig: - description: TLS Config to use for Alertmanager. + description: tlsConfig to use for Alertmanager. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1553,7 +1553,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1576,13 +1576,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1604,7 +1604,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1627,16 +1627,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1659,7 +1659,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -1670,7 +1670,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -1680,7 +1680,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -1693,14 +1693,14 @@ spec: type: object allowOverlappingBlocks: description: |- - AllowOverlappingBlocks enables vertical compaction and vertical query + allowOverlappingBlocks enables vertical compaction and vertical query merge in Prometheus. Deprecated: this flag has no effect for Prometheus >= 2.39.0 where overlapping blocks are enabled by default. type: boolean apiserverConfig: description: |- - APIServerConfig allows specifying a host and auth methods to access the + apiserverConfig allows specifying a host and auth methods to access the Kuberntees API server. If null, Prometheus is assumed to run inside of the cluster: it will discover the API servers automatically and use the Pod's CA certificate @@ -1708,13 +1708,13 @@ spec: properties: authorization: description: |- - Authorization section for the API server. + authorization section for the API server. Cannot be set at the same time as `basicAuth`, `bearerToken`, or `bearerTokenFile`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1736,11 +1736,11 @@ spec: type: object x-kubernetes-map-type: atomic credentialsFile: - description: File to read a secret from, mutually exclusive with `credentials`. + description: credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. type: string type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -1749,14 +1749,14 @@ spec: type: object basicAuth: description: |- - BasicAuth configuration for the API server. + basicAuth configuration for the API server. Cannot be set at the same time as `authorization`, `bearerToken`, or `bearerTokenFile`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -1780,7 +1780,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -1805,14 +1805,13 @@ spec: type: object bearerToken: description: |- - *Warning: this field shouldn't be used because the token value appears + bearerToken is deprecated: this will be removed in a future release. + *Warning: this field shouldn't be used because the token value appears in clear-text. Prefer using `authorization`.* - - Deprecated: this will be removed in a future release. type: string bearerTokenFile: description: |- - File to read bearer token for accessing apiserver. + bearerTokenFile defines the file to read bearer token for accessing apiserver. Cannot be set at the same time as `basicAuth`, `authorization`, or `bearerToken`. @@ -1820,12 +1819,12 @@ spec: type: string host: description: |- - Kubernetes API address consisting of a hostname or IP address followed + host defines the Kubernetes API address consisting of a hostname or IP address followed by an optional port number. type: string noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -1857,7 +1856,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -1865,22 +1864,22 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS Config to use for the API server. + description: tlsConfig to use for the API server. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1902,7 +1901,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1925,13 +1924,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1953,7 +1952,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1976,16 +1975,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2008,7 +2007,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -2019,7 +2018,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -2029,7 +2028,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -2037,7 +2036,7 @@ spec: type: object arbitraryFSAccessThroughSMs: description: |- - When true, ServiceMonitor, PodMonitor and Probe object are forbidden to + arbitraryFSAccessThroughSMs when true, ServiceMonitor, PodMonitor and Probe object are forbidden to reference arbitrary files on the file system of the 'prometheus' container. When a ServiceMonitor's endpoint specifies a `bearerTokenFile` value @@ -2049,22 +2048,27 @@ spec: `spec.bearerTokenSecret` field. properties: deny: + description: |- + deny prevents service monitors from accessing arbitrary files on the file system. + When true, service monitors cannot use file-based configurations like BearerTokenFile + that could potentially access sensitive files. When false (default), such access is allowed. + Setting this to true enhances security by preventing potential credential theft attacks. type: boolean type: object automountServiceAccountToken: description: |- - AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod. + automountServiceAccountToken defines whether a service account token should be automatically mounted in the pod. If the field isn't set, the operator mounts the service account token by default. **Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery. It is possible to use strategic merge patch to project the service account token into the 'prometheus' container. type: boolean baseImage: - description: 'Deprecated: use ''spec.image'' instead.' + description: 'baseImage is deprecated: use ''spec.image'' instead.' type: string bodySizeLimit: description: |- - BodySizeLimit defines per-scrape on response body size. + bodySizeLimit defines per-scrape on response body size. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. @@ -2073,7 +2077,7 @@ spec: type: string configMaps: description: |- - ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus + configMaps defines a list of ConfigMaps in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each ConfigMap is added to the StatefulSet definition as a volume named `configmap-`. The ConfigMaps are mounted into /etc/prometheus/configmaps/ in the 'prometheus' container. @@ -2082,7 +2086,7 @@ spec: type: array containers: description: |- - Containers allows injecting additional containers or modifying operator + containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to the Pods or to change the behavior of an operator generated container. Containers described here modify an operator generated @@ -3559,23 +3563,23 @@ spec: type: array convertClassicHistogramsToNHCB: description: |- - Whether to convert all scraped classic histograms into a native + convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.4.0. type: boolean disableCompaction: description: |- - When true, the Prometheus compaction is disabled. + disableCompaction when true, the Prometheus compaction is disabled. When `spec.thanos.objectStorageConfig` or `spec.objectStorageConfigFile` are defined, the operator automatically disables block compaction to avoid race conditions during block uploads (as the Thanos documentation recommends). type: boolean dnsConfig: - description: Defines the DNS configuration for the pods. + description: dnsConfig defines the DNS configuration for the pods. properties: nameservers: description: |- - A list of DNS name server IP addresses. + nameservers defines the list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. items: minLength: 1 @@ -3584,7 +3588,7 @@ spec: x-kubernetes-list-type: set options: description: |- - A list of DNS resolver options. + options defines the list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Resolution options given in Options will override those that appear in the base DNSPolicy. @@ -3592,11 +3596,11 @@ spec: description: PodDNSConfigOption defines DNS resolver options of a pod. properties: name: - description: Name is required and must be unique. + description: name is required and must be unique. minLength: 1 type: string value: - description: Value is optional. + description: value is optional. type: string required: - name @@ -3607,7 +3611,7 @@ spec: x-kubernetes-list-type: map searches: description: |- - A list of DNS search domains for host-name lookup. + searches defines the list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. items: minLength: 1 @@ -3616,7 +3620,7 @@ spec: x-kubernetes-list-type: set type: object dnsPolicy: - description: Defines the DNS policy for the pods. + description: dnsPolicy defines the DNS policy for the pods. enum: - ClusterFirstWithHostNet - ClusterFirst @@ -3625,7 +3629,7 @@ spec: type: string enableAdminAPI: description: |- - Enables access to the Prometheus web admin API. + enableAdminAPI defines access to the Prometheus web admin API. WARNING: Enabling the admin APIs enables mutating endpoints, to delete data, shutdown Prometheus, and more. Enabling this should be done with care and the @@ -3637,7 +3641,7 @@ spec: type: boolean enableFeatures: description: |- - Enable access to Prometheus feature flags. By default, no features are enabled. + enableFeatures enables access to Prometheus feature flags. By default, no features are enabled. Enabling features which are disabled by default is entirely outside the scope of what the maintainers will support and by doing so, you accept @@ -3651,7 +3655,7 @@ spec: x-kubernetes-list-type: set enableOTLPReceiver: description: |- - Enable Prometheus to be used as a receiver for the OTLP Metrics protocol. + enableOTLPReceiver defines the Prometheus to be used as a receiver for the OTLP Metrics protocol. Note that the OTLP receiver endpoint is automatically enabled if `.spec.otlpConfig` is defined. @@ -3659,7 +3663,7 @@ spec: type: boolean enableRemoteWriteReceiver: description: |- - Enable Prometheus to be used as a receiver for the Prometheus remote + enableRemoteWriteReceiver defines the Prometheus to be used as a receiver for the Prometheus remote write protocol. WARNING: This is not considered an efficient way of ingesting samples. @@ -3671,11 +3675,11 @@ spec: It requires Prometheus >= v2.33.0. type: boolean enableServiceLinks: - description: Indicates whether information about services should be injected into pod's environment variables + description: enableServiceLinks defines whether information about services should be injected into pod's environment variables type: boolean enforcedBodySizeLimit: description: |- - When defined, enforcedBodySizeLimit specifies a global limit on the size + enforcedBodySizeLimit when defined specifies a global limit on the size of uncompressed response body that will be accepted by Prometheus. Targets responding with a body larger than this many bytes will cause the scrape to fail. @@ -3691,7 +3695,7 @@ spec: type: string enforcedKeepDroppedTargets: description: |- - When defined, enforcedKeepDroppedTargets specifies a global limit on the number of targets + enforcedKeepDroppedTargets when defined specifies a global limit on the number of targets dropped by relabeling that will be kept in memory. The value overrides any `spec.keepDroppedTargets` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is @@ -3708,7 +3712,7 @@ spec: type: integer enforcedLabelLimit: description: |- - When defined, enforcedLabelLimit specifies a global limit on the number + enforcedLabelLimit when defined specifies a global limit on the number of labels per sample. The value overrides any `spec.labelLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is greater than zero and less than `spec.enforcedLabelLimit`. @@ -3724,7 +3728,7 @@ spec: type: integer enforcedLabelNameLengthLimit: description: |- - When defined, enforcedLabelNameLengthLimit specifies a global limit on the length + enforcedLabelNameLengthLimit when defined specifies a global limit on the length of labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is greater than zero and less than `spec.enforcedLabelNameLengthLimit`. @@ -3740,7 +3744,7 @@ spec: type: integer enforcedLabelValueLengthLimit: description: |- - When not null, enforcedLabelValueLengthLimit defines a global limit on the length + enforcedLabelValueLengthLimit when not null defines a global limit on the length of labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is greater than zero and less than `spec.enforcedLabelValueLengthLimit`. @@ -3756,7 +3760,7 @@ spec: type: integer enforcedNamespaceLabel: description: |- - When not empty, a label will be added to: + enforcedNamespaceLabel when not empty, a label will be added to: 1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects. 2. All metrics generated from recording rules defined in `PrometheusRule` objects. @@ -3771,7 +3775,7 @@ spec: type: string enforcedSampleLimit: description: |- - When defined, enforcedSampleLimit specifies a global limit on the number + enforcedSampleLimit when defined specifies a global limit on the number of scraped samples that will be accepted. This overrides any `spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.sampleLimit` is greater than zero and less than @@ -3789,7 +3793,7 @@ spec: type: integer enforcedTargetLimit: description: |- - When defined, enforcedTargetLimit specifies a global limit on the number + enforcedTargetLimit when defined specifies a global limit on the number of scraped targets. The value overrides any `spec.targetLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is greater than zero and less than `spec.enforcedTargetLimit`. @@ -3807,13 +3811,13 @@ spec: evaluationInterval: default: 30s description: |- - Interval between rule evaluations. + evaluationInterval defines the interval between rule evaluations. Default: "30s" pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string excludedFromEnforcement: description: |- - List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects + excludedFromEnforcement defines the list of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects to be excluded from enforcing a namespace label of origin. It is only applicable if `spec.enforcedNamespaceLabel` set to true. @@ -3822,21 +3826,21 @@ spec: properties: group: default: monitoring.coreos.com - description: Group of the referent. When not specified, it defaults to `monitoring.coreos.com` + description: group of the referent. When not specified, it defaults to `monitoring.coreos.com` enum: - monitoring.coreos.com type: string name: - description: Name of the referent. When not set, all resources in the namespace are matched. + description: name of the referent. When not set, all resources in the namespace are matched. type: string namespace: description: |- - Namespace of the referent. + namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ minLength: 1 type: string resource: - description: Resource of the referent. + description: resource of the referent. enum: - prometheusrules - servicemonitors @@ -3851,12 +3855,12 @@ spec: type: array exemplars: description: |- - Exemplars related settings that are runtime reloadable. + exemplars related settings that are runtime reloadable. It requires to enable the `exemplar-storage` feature flag to be effective. properties: maxSize: description: |- - Maximum number of exemplars stored in memory for all series. + maxSize defines the maximum number of exemplars stored in memory for all series. exemplar-storage itself must be enabled using the `spec.enableFeature` option for exemplars to be scraped in the first place. @@ -3870,20 +3874,20 @@ spec: additionalProperties: type: string description: |- - The labels to add to any time series or alerts when communicating with + externalLabels defines the labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager). Labels defined by `spec.replicaExternalLabelName` and `spec.prometheusExternalLabelName` take precedence over this list. type: object externalUrl: description: |- - The external URL under which the Prometheus service is externally + externalUrl defines the external URL under which the Prometheus service is externally available. This is necessary to generate correct URLs (for instance if Prometheus is accessible behind an Ingress resource). type: string hostAliases: description: |- - Optional list of hosts and IPs that will be injected into the Pod's + hostAliases defines the optional list of hosts and IPs that will be injected into the Pod's hosts file if specified. items: description: |- @@ -3891,12 +3895,12 @@ spec: pod's hosts file. properties: hostnames: - description: Hostnames for the above IP address. + description: hostnames defines hostnames for the above IP address. items: type: string type: array ip: - description: IP address of the host file entry. + description: ip defines the IP address of the host file entry. type: string required: - hostnames @@ -3908,7 +3912,7 @@ spec: x-kubernetes-list-type: map hostNetwork: description: |- - Use the host's network namespace if true. + hostNetwork defines the host's network namespace if true. Make sure to understand the security implications if you want to enable it (https://kubernetes.io/docs/concepts/configuration/overview/ ). @@ -3919,7 +3923,7 @@ spec: type: boolean hostUsers: description: |- - HostUsers supports the user space in Kubernetes. + hostUsers supports the user space in Kubernetes. More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/ @@ -3928,14 +3932,14 @@ spec: type: boolean ignoreNamespaceSelectors: description: |- - When true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor + ignoreNamespaceSelectors when true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor and Probe objects will be ignored. They will only discover targets within the namespace of the PodMonitor, ServiceMonitor and Probe object. type: boolean image: description: |- - Container image name for Prometheus. If specified, it takes precedence + image defines the container image name for Prometheus. If specified, it takes precedence over the `spec.baseImage`, `spec.tag` and `spec.sha` fields. Specifying `spec.version` is still necessary to ensure the Prometheus @@ -3947,7 +3951,7 @@ spec: type: string imagePullPolicy: description: |- - Image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers. + imagePullPolicy defines the image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details. enum: - "" @@ -3957,7 +3961,7 @@ spec: type: string imagePullSecrets: description: |- - An optional list of references to Secrets in the same namespace + imagePullSecrets defines an optional list of references to Secrets in the same namespace to use for pulling images from registries. See http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod items: @@ -3979,7 +3983,7 @@ spec: type: array initContainers: description: |- - InitContainers allows injecting initContainers to the Pod definition. Those + initContainers allows injecting initContainers to the Pod definition. Those can be used to e.g. fetch secrets for injection into the Prometheus configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: @@ -5456,7 +5460,7 @@ spec: type: array keepDroppedTargets: description: |- - Per-scrape limit on the number of targets dropped by relabeling + keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0. @@ -5467,7 +5471,7 @@ spec: type: integer labelLimit: description: |- - Per-scrape limit on number of labels that will be accepted for a sample. + labelLimit defines per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. @@ -5476,7 +5480,7 @@ spec: type: integer labelNameLengthLimit: description: |- - Per-scrape limit on length of labels name that will be accepted for a sample. + labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. @@ -5485,7 +5489,7 @@ spec: type: integer labelValueLengthLimit: description: |- - Per-scrape limit on length of labels value that will be accepted for a sample. + labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. @@ -5494,18 +5498,18 @@ spec: type: integer listenLocal: description: |- - When true, the Prometheus server listens on the loopback address + listenLocal when true, the Prometheus server listens on the loopback address instead of the Pod IP's address. type: boolean logFormat: - description: Log format for Log level for Prometheus and the config-reloader sidecar. + description: logFormat for Log level for Prometheus and the config-reloader sidecar. enum: - "" - logfmt - json type: string logLevel: - description: Log level for Prometheus and the config-reloader sidecar. + description: logLevel for Prometheus and the config-reloader sidecar. enum: - "" - debug @@ -5515,14 +5519,14 @@ spec: type: string maximumStartupDurationSeconds: description: |- - Defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete. + maximumStartupDurationSeconds defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete. If set, the value should be greater than 60 (seconds). Otherwise it will be equal to 600 seconds (15 minutes). format: int32 minimum: 60 type: integer minReadySeconds: description: |- - Minimum number of seconds for which a newly created Pod should be ready + minReadySeconds defines the minimum number of seconds for which a newly created Pod should be ready without any of its container crashing for it to be considered available. If unset, pods will be considered available as soon as they are ready. @@ -5531,7 +5535,7 @@ spec: type: integer nameEscapingScheme: description: |- - Specifies the character escaping scheme that will be requested when scraping + nameEscapingScheme defines the character escaping scheme that will be requested when scraping for metric and label names that do not conform to the legacy Prometheus character set. @@ -5544,7 +5548,7 @@ spec: type: string nameValidationScheme: description: |- - Specifies the validation scheme for metric and label names. + nameValidationScheme defines the validation scheme for metric and label names. It requires Prometheus >= v2.55.0. enum: @@ -5554,21 +5558,21 @@ spec: nodeSelector: additionalProperties: type: string - description: Defines on which Nodes the Pods are scheduled. + description: nodeSelector defines on which Nodes the Pods are scheduled. type: object otlp: description: |- - Settings related to the OTLP receiver feature. + otlp defines the settings related to the OTLP receiver feature. It requires Prometheus >= v2.55.0. properties: convertHistogramsToNHCB: description: |- - Configures optional translation of OTLP explicit bucket histograms into native histograms with custom buckets. + convertHistogramsToNHCB defines optional translation of OTLP explicit bucket histograms into native histograms with custom buckets. It requires Prometheus >= v3.4.0. type: boolean ignoreResourceAttributes: description: |- - List of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true. + ignoreResourceAttributes defines the list of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true. It requires `promoteAllResourceAttributes` to be true. It requires Prometheus >= v3.5.0. @@ -5580,21 +5584,21 @@ spec: x-kubernetes-list-type: set keepIdentifyingResourceAttributes: description: |- - Enables adding `service.name`, `service.namespace` and `service.instance.id` + keepIdentifyingResourceAttributes enables adding `service.name`, `service.namespace` and `service.instance.id` resource attributes to the `target_info` metric, on top of converting them into the `instance` and `job` labels. It requires Prometheus >= v3.1.0. type: boolean promoteAllResourceAttributes: description: |- - Promote all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`. + promoteAllResourceAttributes promotes all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`. Cannot be true when `promoteResourceAttributes` is defined. It requires Prometheus >= v3.5.0. type: boolean promoteResourceAttributes: description: |- - List of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none. + promoteResourceAttributes defines the list of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none. Cannot be defined when `promoteAllResourceAttributes` is true. items: minLength: 1 @@ -5604,7 +5608,7 @@ spec: x-kubernetes-list-type: set translationStrategy: description: |- - Configures how the OTLP receiver endpoint translates the incoming metrics. + translationStrategy defines how the OTLP receiver endpoint translates the incoming metrics. It requires Prometheus >= v3.0.0. enum: @@ -5615,7 +5619,7 @@ spec: type: object overrideHonorLabels: description: |- - When true, Prometheus resolves label conflicts by renaming the labels in the scraped data + overrideHonorLabels when true, Prometheus resolves label conflicts by renaming the labels in the scraped data to “exported_” for all targets created from ServiceMonitor, PodMonitor and ScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies. In practice,`overrideHonorLaels:true` enforces `honorLabels:false` @@ -5623,18 +5627,18 @@ spec: type: boolean overrideHonorTimestamps: description: |- - When true, Prometheus ignores the timestamps for all the targets created + overrideHonorTimestamps when true, Prometheus ignores the timestamps for all the targets created from service and pod monitors. Otherwise the HonorTimestamps field of the service or pod monitor applies. type: boolean paused: description: |- - When a Prometheus deployment is paused, no actions except for deletion + paused defines when a Prometheus deployment is paused, no actions except for deletion will be performed on the underlying objects. type: boolean persistentVolumeClaimRetentionPolicy: description: |- - The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet. + persistentVolumeClaimRetentionPolicy defines the field controls if and how PVCs are deleted during the lifecycle of a StatefulSet. The default behavior is all PVCs are retained. This is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26. It requires enabling the StatefulSetAutoDeletePVC feature gate. @@ -5657,7 +5661,7 @@ spec: type: object podMetadata: description: |- - PodMetadata configures labels and annotations which are propagated to the Prometheus pods. + podMetadata defines labels and annotations which are propagated to the Prometheus pods. The following items are reserved and cannot be overridden: * "prometheus" label, set to the name of the Prometheus object. @@ -5673,7 +5677,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ @@ -5682,14 +5686,14 @@ spec: additionalProperties: type: string description: |- - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. @@ -5699,7 +5703,7 @@ spec: type: object podMonitorNamespaceSelector: description: |- - Namespaces to match for PodMonitors discovery. An empty label selector + podMonitorNamespaceSelector defines the namespaces to match for PodMonitors discovery. An empty label selector matches all namespaces. A null label selector (default value) matches the current namespace only. properties: @@ -5746,7 +5750,7 @@ spec: x-kubernetes-map-type: atomic podMonitorSelector: description: |- - PodMonitors to be selected for target discovery. An empty label selector + podMonitorSelector defines the podMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -5801,7 +5805,7 @@ spec: x-kubernetes-map-type: atomic podTargetLabels: description: |- - PodTargetLabels are appended to the `spec.podTargetLabels` field of all + podTargetLabels are appended to the `spec.podTargetLabels` field of all PodMonitor and ServiceMonitor objects. items: type: string @@ -5809,15 +5813,15 @@ spec: portName: default: web description: |- - Port name used for the pods and governing service. + portName used for the pods and governing service. Default: "web" type: string priorityClassName: - description: Priority class assigned to the Pods. + description: priorityClassName assigned to the Pods. type: string probeNamespaceSelector: description: |- - Namespaces to match for Probe discovery. An empty label + probeNamespaceSelector defines the namespaces to match for Probe discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only. properties: @@ -5864,7 +5868,7 @@ spec: x-kubernetes-map-type: atomic probeSelector: description: |- - Probes to be selected for target discovery. An empty label selector + probeSelector defines the probes to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -5919,7 +5923,7 @@ spec: x-kubernetes-map-type: atomic prometheusExternalLabelName: description: |- - Name of Prometheus external label used to denote the Prometheus instance + prometheusExternalLabelName defines the name of Prometheus external label used to denote the Prometheus instance name. The external label will _not_ be added when the field is set to the empty string (`""`). @@ -5927,7 +5931,7 @@ spec: type: string prometheusRulesExcludedFromEnforce: description: |- - Defines the list of PrometheusRule objects to which the namespace label + prometheusRulesExcludedFromEnforce defines the list of PrometheusRule objects to which the namespace label enforcement doesn't apply. This is only relevant when `spec.enforcedNamespaceLabel` is set to true. Deprecated: use `spec.excludedFromEnforcement` instead. @@ -5938,10 +5942,10 @@ spec: namespace label for alerts and metrics. properties: ruleName: - description: Name of the excluded PrometheusRule object. + description: ruleName defines the name of the excluded PrometheusRule object. type: string ruleNamespace: - description: Namespace of the excluded PrometheusRule object. + description: ruleNamespace defines the namespace of the excluded PrometheusRule object. type: string required: - ruleName @@ -5949,25 +5953,25 @@ spec: type: object type: array query: - description: QuerySpec defines the configuration of the Promethus query service. + description: query defines the configuration of the Promethus query service. properties: lookbackDelta: - description: The delta difference allowed for retrieving metrics during expression evaluations. + description: lookbackDelta defines the delta difference allowed for retrieving metrics during expression evaluations. type: string maxConcurrency: - description: Number of concurrent queries that can be run at once. + description: maxConcurrency defines the number of concurrent queries that can be run at once. format: int32 minimum: 1 type: integer maxSamples: description: |- - Maximum number of samples a single query can load into memory. Note that + maxSamples defines the maximum number of samples a single query can load into memory. Note that queries will fail if they would load more samples than this into memory, so this also limits the number of samples a query can return. format: int32 type: integer timeout: - description: Maximum time a query may take before being aborted. + description: timeout defines the maximum time a query may take before being aborted. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string type: object @@ -5987,14 +5991,14 @@ spec: type: string reloadStrategy: description: |- - Defines the strategy used to reload the Prometheus configuration. + reloadStrategy defines the strategy used to reload the Prometheus configuration. If not specified, the configuration is reloaded using the /-/reload HTTP endpoint. enum: - HTTP - ProcessSignal type: string remoteRead: - description: Defines the list of remote read configurations. + description: remoteRead defines the list of remote read configurations. items: description: |- RemoteReadSpec defines the configuration for Prometheus to read back samples @@ -6002,14 +6006,14 @@ spec: properties: authorization: description: |- - Authorization section for the URL. + authorization section for the URL. It requires Prometheus >= v2.26.0. Cannot be set at the same time as `basicAuth`, or `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6031,11 +6035,11 @@ spec: type: object x-kubernetes-map-type: atomic credentialsFile: - description: File to read a secret from, mutually exclusive with `credentials`. + description: credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. type: string type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -6044,13 +6048,13 @@ spec: type: object basicAuth: description: |- - BasicAuth configuration for the URL. + basicAuth configuration for the URL. Cannot be set at the same time as `authorization`, or `oauth2`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -6074,7 +6078,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -6099,26 +6103,25 @@ spec: type: object bearerToken: description: |- + bearerToken is deprecated: this will be removed in a future release. *Warning: this field shouldn't be used because the token value appears in clear-text. Prefer using `authorization`.* - - Deprecated: this will be removed in a future release. type: string bearerTokenFile: description: |- - File from which to read the bearer token for the URL. + bearerTokenFile defines the file from which to read the bearer token for the URL. Deprecated: this will be removed in a future release. Prefer using `authorization`. type: string filterExternalLabels: description: |- - Whether to use the external labels as selectors for the remote read endpoint. + filterExternalLabels defines whether to use the external labels as selectors for the remote read endpoint. It requires Prometheus >= v2.34.0. type: boolean followRedirects: description: |- - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. It requires Prometheus >= v2.26.0. type: boolean @@ -6126,13 +6129,13 @@ spec: additionalProperties: type: string description: |- - Custom HTTP headers to be sent along with each remote read request. + headers defines the custom HTTP headers to be sent along with each remote read request. Be aware that headers that are set by Prometheus itself can't be overwritten. Only valid in Prometheus versions 2.26.0 and newer. type: object name: description: |- - The name of the remote read queue, it must be unique if specified. The + name of the remote read queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate read configurations. @@ -6140,7 +6143,7 @@ spec: type: string noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -6148,7 +6151,7 @@ spec: type: string oauth2: description: |- - OAuth2 configuration for the URL. + oauth2 configuration for the URL. It requires Prometheus >= v2.27.0. @@ -6156,11 +6159,11 @@ spec: properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6182,7 +6185,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6206,7 +6209,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -6232,12 +6235,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -6269,7 +6272,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -6277,29 +6280,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6321,7 +6324,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6344,10 +6347,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6369,7 +6372,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6392,10 +6395,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6418,7 +6421,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -6429,7 +6432,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -6439,11 +6442,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -6477,7 +6480,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -6485,38 +6488,38 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string readRecent: description: |- - Whether reads should be made for queries for time ranges that + readRecent defines whether reads should be made for queries for time ranges that the local storage should have complete data for. type: boolean remoteTimeout: - description: Timeout for requests to the remote read endpoint. + description: remoteTimeout defines the timeout for requests to the remote read endpoint. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string requiredMatchers: additionalProperties: type: string description: |- - An optional list of equality matchers which have to be present + requiredMatchers defines an optional list of equality matchers which have to be present in a selector to query the remote read endpoint. type: object tlsConfig: - description: TLS Config to use for the URL. + description: tlsConfig to use for the URL. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6538,7 +6541,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6561,13 +6564,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6589,7 +6592,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6612,16 +6615,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6644,7 +6647,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -6655,7 +6658,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -6665,18 +6668,18 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object url: - description: The URL of the endpoint to query from. + description: url defines the URL of the endpoint to query from. type: string required: - url type: object type: array remoteWrite: - description: Defines the list of remote write configurations. + description: remoteWrite defines the list of remote write configurations. items: description: |- RemoteWriteSpec defines the configuration to write samples from Prometheus @@ -6684,14 +6687,14 @@ spec: properties: authorization: description: |- - Authorization section for the URL. + authorization section for the URL. It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. Cannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6713,11 +6716,11 @@ spec: type: object x-kubernetes-map-type: atomic credentialsFile: - description: File to read a secret from, mutually exclusive with `credentials`. + description: credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. type: string type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -6726,14 +6729,14 @@ spec: type: object azureAd: description: |- - AzureAD for the URL. + azureAd for the URL. It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0. Cannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`. properties: cloud: - description: The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'. + description: cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'. enum: - AzureChina - AzureGovernment @@ -6741,28 +6744,28 @@ spec: type: string managedIdentity: description: |- - ManagedIdentity defines the Azure User-assigned Managed identity. + managedIdentity defines the Azure User-assigned Managed identity. Cannot be set at the same time as `oauth` or `sdk`. properties: clientId: - description: The client id + description: clientId defines defines the Azure User-assigned Managed identity. type: string required: - clientId type: object oauth: description: |- - OAuth defines the oauth config that is being used to authenticate. + oauth defines the oauth config that is being used to authenticate. Cannot be set at the same time as `managedIdentity` or `sdk`. It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0. properties: clientId: - description: '`clientID` is the clientId of the Azure Active Directory application that is being used to authenticate.' + description: clientId defines the clientId of the Azure Active Directory application that is being used to authenticate. minLength: 1 type: string clientSecret: - description: '`clientSecret` specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.' + description: clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6784,7 +6787,7 @@ spec: type: object x-kubernetes-map-type: atomic tenantId: - description: '`tenantId` is the tenant ID of the Azure Active Directory application that is being used to authenticate.' + description: tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate. minLength: 1 pattern: ^[0-9a-zA-Z-.]+$ type: string @@ -6795,27 +6798,27 @@ spec: type: object sdk: description: |- - SDK defines the Azure SDK config that is being used to authenticate. + sdk defines the Azure SDK config that is being used to authenticate. See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication Cannot be set at the same time as `oauth` or `managedIdentity`. It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0. properties: tenantId: - description: '`tenantId` is the tenant ID of the azure active directory application that is being used to authenticate.' + description: tenantId defines the tenant ID of the azure active directory application that is being used to authenticate. pattern: ^[0-9a-zA-Z-.]+$ type: string type: object type: object basicAuth: description: |- - BasicAuth configuration for the URL. + basicAuth configuration for the URL. Cannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -6839,7 +6842,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -6864,23 +6867,22 @@ spec: type: object bearerToken: description: |- + bearerToken is deprecated: this will be removed in a future release. *Warning: this field shouldn't be used because the token value appears in clear-text. Prefer using `authorization`.* - - Deprecated: this will be removed in a future release. type: string bearerTokenFile: description: |- - File from which to read bearer token for the URL. + bearerTokenFile defines the file from which to read bearer token for the URL. Deprecated: this will be removed in a future release. Prefer using `authorization`. type: string enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean followRedirects: description: |- - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. type: boolean @@ -6888,14 +6890,14 @@ spec: additionalProperties: type: string description: |- - Custom HTTP headers to be sent along with each remote write request. + headers defines the custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can't be overwritten. It requires Prometheus >= v2.25.0 or Thanos >= v0.24.0. type: object messageVersion: description: |- - The Remote Write message's version to use when writing to the endpoint. + messageVersion defines the Remote Write message's version to use when writing to the endpoint. `Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0. `Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0. @@ -6912,34 +6914,34 @@ spec: - V2.0 type: string metadataConfig: - description: MetadataConfig configures the sending of series metadata to the remote storage. + description: metadataConfig defines how to send a series metadata to the remote storage. properties: maxSamplesPerSend: description: |- - MaxSamplesPerSend is the maximum number of metadata samples per send. + maxSamplesPerSend defines the maximum number of metadata samples per send. It requires Prometheus >= v2.29.0. format: int32 minimum: -1 type: integer send: - description: Defines whether metric metadata is sent to the remote storage or not. + description: send defines whether metric metadata is sent to the remote storage or not. type: boolean sendInterval: - description: Defines how frequently metric metadata is sent to the remote storage. + description: sendInterval defines how frequently metric metadata is sent to the remote storage. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string type: object name: description: |- - The name of the remote write queue, it must be unique if specified. The + name of the remote write queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate queues. It requires Prometheus >= v2.15.0 or Thanos >= 0.24.0. type: string noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -6947,7 +6949,7 @@ spec: type: string oauth2: description: |- - OAuth2 configuration for the URL. + oauth2 configuration for the URL. It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0. @@ -6955,11 +6957,11 @@ spec: properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6981,7 +6983,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7005,7 +7007,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -7031,12 +7033,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -7068,7 +7070,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -7076,29 +7078,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7120,7 +7122,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7143,10 +7145,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7168,7 +7170,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7191,10 +7193,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7217,7 +7219,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -7228,7 +7230,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -7238,11 +7240,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -7276,7 +7278,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -7284,82 +7286,70 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string queueConfig: - description: QueueConfig allows tuning of the remote write queue parameters. + description: queueConfig allows tuning of the remote write queue parameters. properties: batchSendDeadline: - description: BatchSendDeadline is the maximum time a sample will wait in buffer. + description: batchSendDeadline defines the maximum time a sample will wait in buffer. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string capacity: description: |- - Capacity is the number of samples to buffer per shard before we start + capacity defines the number of samples to buffer per shard before we start dropping them. type: integer maxBackoff: - description: MaxBackoff is the maximum retry delay. + description: maxBackoff defines the maximum retry delay. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string maxRetries: - description: MaxRetries is the maximum number of times to retry a batch on recoverable errors. + description: maxRetries defines the maximum number of times to retry a batch on recoverable errors. type: integer maxSamplesPerSend: - description: MaxSamplesPerSend is the maximum number of samples per send. + description: maxSamplesPerSend defines the maximum number of samples per send. type: integer maxShards: - description: MaxShards is the maximum number of shards, i.e. amount of concurrency. + description: maxShards defines the maximum number of shards, i.e. amount of concurrency. type: integer minBackoff: - description: MinBackoff is the initial retry delay. Gets doubled for every retry. + description: minBackoff defines the initial retry delay. Gets doubled for every retry. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string minShards: - description: MinShards is the minimum number of shards, i.e. amount of concurrency. + description: minShards defines the minimum number of shards, i.e. amount of concurrency. type: integer retryOnRateLimit: description: |- - Retry upon receiving a 429 status code from the remote-write storage. + retryOnRateLimit defines the retry upon receiving a 429 status code from the remote-write storage. This is an *experimental feature*, it may change in any upcoming release in a breaking way. type: boolean sampleAgeLimit: description: |- - SampleAgeLimit drops samples older than the limit. + sampleAgeLimit drops samples older than the limit. It requires Prometheus >= v2.50.0 or Thanos >= v0.32.0. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string type: object remoteTimeout: - description: Timeout for requests to the remote write endpoint. + description: remoteTimeout defines the timeout for requests to the remote write endpoint. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string roundRobinDNS: - description: |- - When enabled: - - The remote-write mechanism will resolve the hostname via DNS. - - It will randomly select one of the resolved IP addresses and connect to it. - - When disabled (default behavior): - - The Go standard library will handle hostname resolution. - - It will attempt connections to each resolved IP address sequentially. - - Note: The connection timeout applies to the entire resolution and connection process. - If disabled, the timeout is distributed across all connection attempts. - - It requires Prometheus >= v3.1.0 or Thanos >= v0.38.0. + description: "roundRobinDNS controls the DNS resolution behavior for remote-write connections.\nWhen enabled:\n - The remote-write mechanism will resolve the hostname via DNS.\n - It will randomly select one of the resolved IP addresses and connect to it.\n\nWhen disabled (default behavior):\n - The Go standard library will handle hostname resolution.\n - It will attempt connections to each resolved IP address sequentially.\n\nNote: The connection timeout applies to the entire resolution and connection process.\n\n\tIf disabled, the timeout is distributed across all connection attempts.\n\nIt requires Prometheus >= v3.1.0 or Thanos >= v0.38.0." type: boolean sendExemplars: description: |- - Enables sending of exemplars over remote write. Note that + sendExemplars enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the `spec.enableFeatures` option for exemplars to be scraped in the first place. @@ -7367,14 +7357,14 @@ spec: type: boolean sendNativeHistograms: description: |- - Enables sending of native histograms, also known as sparse histograms + sendNativeHistograms enables sending of native histograms, also known as sparse histograms over remote write. It requires Prometheus >= v2.40.0 or Thanos >= v0.30.0. type: boolean sigv4: description: |- - Sigv4 allows to configures AWS's Signature Verification 4 for the URL. + sigv4 defines the AWS's Signature Verification 4 for the URL. It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. @@ -7382,7 +7372,7 @@ spec: properties: accessKey: description: |- - AccessKey is the AWS API key. If not specified, the environment variable + accessKey defines the AWS API key. If not specified, the environment variable `AWS_ACCESS_KEY_ID` is used. properties: key: @@ -7405,17 +7395,17 @@ spec: type: object x-kubernetes-map-type: atomic profile: - description: Profile is the named AWS profile used to authenticate. + description: profile defines the named AWS profile used to authenticate. type: string region: - description: Region is the AWS region. If blank, the region from the default credentials chain used. + description: region defines the AWS region. If blank, the region from the default credentials chain used. type: string roleArn: - description: RoleArn is the named AWS profile used to authenticate. + description: roleArn defines the named AWS profile used to authenticate. type: string secretKey: description: |- - SecretKey is the AWS API secret. If not specified, the environment + secretKey defines the AWS API secret. If not specified, the environment variable `AWS_SECRET_ACCESS_KEY` is used. properties: key: @@ -7439,13 +7429,13 @@ spec: x-kubernetes-map-type: atomic type: object tlsConfig: - description: TLS Config to use for the URL. + description: tlsConfig to use for the URL. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7467,7 +7457,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7490,13 +7480,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7518,7 +7508,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7541,16 +7531,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7573,7 +7563,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -7584,7 +7574,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -7594,15 +7584,15 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object url: - description: The URL of the endpoint to send samples to. + description: url defines the URL of the endpoint to send samples to. minLength: 1 type: string writeRelabelConfigs: - description: The list of remote write relabel configurations. + description: writeRelabelConfigs defines the list of remote write relabel configurations. items: description: |- RelabelConfig allows dynamic rewriting of the label set for targets, alerts, @@ -7613,7 +7603,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -7645,27 +7635,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -7677,7 +7667,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -7692,7 +7682,7 @@ spec: type: array remoteWriteReceiverMessageVersions: description: |- - List of the protobuf message versions to accept when receiving the + remoteWriteReceiverMessageVersions list of the protobuf message versions to accept when receiving the remote writes. It requires Prometheus >= v2.54.0. @@ -7706,7 +7696,7 @@ spec: x-kubernetes-list-type: set replicaExternalLabelName: description: |- - Name of Prometheus external label used to denote the replica name. + replicaExternalLabelName defines the name of Prometheus external label used to denote the replica name. The external label will _not_ be added when the field is set to the empty string (`""`). @@ -7714,7 +7704,7 @@ spec: type: string replicas: description: |- - Number of replicas of each shard to deploy for a Prometheus deployment. + replicas defines the number of replicas of each shard to deploy for a Prometheus deployment. `spec.replicas` multiplied by `spec.shards` is the total number of Pods created. @@ -7722,7 +7712,7 @@ spec: format: int32 type: integer resources: - description: Defines the resources requests and limits of the 'prometheus' container. + description: resources defines the resources requests and limits of the 'prometheus' container. properties: claims: description: |- @@ -7782,18 +7772,18 @@ spec: type: object retention: description: |- - How long to retain the Prometheus data. + retention defines how long to retain the Prometheus data. Default: "24h" if `spec.retention` and `spec.retentionSize` are empty. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string retentionSize: - description: Maximum number of bytes used by the Prometheus data. + description: retentionSize defines the maximum number of bytes used by the Prometheus data. pattern: (^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$ type: string routePrefix: description: |- - The route prefix Prometheus registers HTTP handlers for. + routePrefix defines the route prefix Prometheus registers HTTP handlers for. This is useful when using `spec.externalURL`, and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but @@ -7802,7 +7792,7 @@ spec: type: string ruleNamespaceSelector: description: |- - Namespaces to match for PrometheusRule discovery. An empty label selector + ruleNamespaceSelector defines the namespaces to match for PrometheusRule discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only. properties: @@ -7849,13 +7839,13 @@ spec: x-kubernetes-map-type: atomic ruleQueryOffset: description: |- - Defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past. + ruleQueryOffset defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past. It requires Prometheus >= v2.53.0. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string ruleSelector: description: |- - PrometheusRule objects to be selected for rule evaluation. An empty + ruleSelector defines the prometheusRule objects to be selected for rule evaluation. An empty label selector matches all objects. A null label selector matches no objects. properties: @@ -7901,39 +7891,39 @@ spec: type: object x-kubernetes-map-type: atomic rules: - description: Defines the configuration of the Prometheus rules' engine. + description: rules defines the configuration of the Prometheus rules' engine. properties: alert: description: |- - Defines the parameters of the Prometheus rules' engine. + alert defines the parameters of the Prometheus rules' engine. Any update to these parameters trigger a restart of the pods. properties: forGracePeriod: description: |- - Minimum duration between alert and restored 'for' state. + forGracePeriod defines the minimum duration between alert and restored 'for' state. This is maintained only for alerts with a configured 'for' time greater than the grace period. type: string forOutageTolerance: description: |- - Max time to tolerate prometheus outage for restoring 'for' state of + forOutageTolerance defines the max time to tolerate prometheus outage for restoring 'for' state of alert. type: string resendDelay: description: |- - Minimum amount of time to wait before resending an alert to + resendDelay defines the minimum amount of time to wait before resending an alert to Alertmanager. type: string type: object type: object runtime: - description: RuntimeConfig configures the values for the Prometheus process behavior + description: runtime defines the values for the Prometheus process behavior properties: goGC: description: |- - The Go garbage collection target percentage. Lowering this number may increase the CPU usage. + goGC defines the Go garbage collection target percentage. Lowering this number may increase the CPU usage. See: https://tip.golang.org/doc/gc-guide#GOGC format: int32 minimum: -1 @@ -7941,7 +7931,7 @@ spec: type: object sampleLimit: description: |- - SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. + sampleLimit defines per-scrape limit on number of scraped samples that will be accepted. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. @@ -7950,7 +7940,7 @@ spec: type: integer scrapeClasses: description: |- - List of scrape classes to expose to scraping objects such as + scrapeClasses defines the list of scrape classes to expose to scraping objects such as PodMonitors, ServiceMonitors, Probes and ScrapeConfigs. This is an *experimental feature*, it may change in any upcoming release @@ -7959,13 +7949,13 @@ spec: properties: attachMetadata: description: |- - AttachMetadata configures additional metadata to the discovered targets. + attachMetadata defines additional metadata to the discovered targets. When the scrape object defines its own configuration, it takes precedence over the scrape class configuration. properties: node: description: |- - When set to true, Prometheus attaches node metadata to the discovered + node when set to true, Prometheus attaches node metadata to the discovered targets. The Prometheus service account must have the `list` and `watch` @@ -7974,11 +7964,11 @@ spec: type: object authorization: description: |- - Authorization section for the ScrapeClass. + authorization section for the ScrapeClass. It will only apply if the scrape resource doesn't specify any Authorization. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8000,11 +7990,11 @@ spec: type: object x-kubernetes-map-type: atomic credentialsFile: - description: File to read a secret from, mutually exclusive with `credentials`. + description: credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. type: string type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -8013,14 +8003,14 @@ spec: type: object default: description: |- - Default indicates that the scrape applies to all scrape objects that + default defines that the scrape applies to all scrape objects that don't configure an explicit scrape class name. Only one scrape class can be set as the default. type: boolean fallbackScrapeProtocol: description: |- - The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. + fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It will only apply if the scrape resource doesn't specify any FallbackScrapeProtocol It requires Prometheus >= v3.0.0. @@ -8033,7 +8023,7 @@ spec: type: string metricRelabelings: description: |- - MetricRelabelings configures the relabeling rules to apply to all samples before ingestion. + metricRelabelings defines the relabeling rules to apply to all samples before ingestion. The Operator adds the scrape class metric relabelings defined here. Then the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs. @@ -8050,7 +8040,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -8082,27 +8072,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -8114,7 +8104,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -8124,12 +8114,12 @@ spec: type: object type: array name: - description: Name of the scrape class. + description: name of the scrape class. minLength: 1 type: string relabelings: description: |- - Relabelings configures the relabeling rules to apply to all scrape targets. + relabelings defines the relabeling rules to apply to all scrape targets. The Operator automatically adds relabelings for a few standard Kubernetes fields like `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`. @@ -8147,7 +8137,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -8179,27 +8169,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -8211,7 +8201,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -8222,17 +8212,17 @@ spec: type: array tlsConfig: description: |- - TLSConfig defines the TLS settings to use for the scrape. When the + tlsConfig defines the TLS settings to use for the scrape. When the scrape objects define their own CA, certificate and/or key, they take precedence over the corresponding scrape class fields. For now only the `caFile`, `certFile` and `keyFile` fields are supported. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8254,7 +8244,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8277,13 +8267,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8305,7 +8295,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8328,16 +8318,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8360,7 +8350,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -8371,7 +8361,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -8381,7 +8371,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -8393,7 +8383,7 @@ spec: x-kubernetes-list-type: map scrapeClassicHistograms: description: |- - Whether to scrape a classic histogram that is also exposed as a native histogram. + scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration. @@ -8401,7 +8391,7 @@ spec: type: boolean scrapeConfigNamespaceSelector: description: |- - Namespaces to match for ScrapeConfig discovery. An empty label selector + scrapeConfigNamespaceSelector defines the namespaces to match for ScrapeConfig discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only. @@ -8450,7 +8440,7 @@ spec: x-kubernetes-map-type: atomic scrapeConfigSelector: description: |- - ScrapeConfigs to be selected for target discovery. An empty label + scrapeConfigSelector defines the scrapeConfigs to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -8507,7 +8497,7 @@ spec: x-kubernetes-map-type: atomic scrapeFailureLogFile: description: |- - File to which scrape failures are logged. + scrapeFailureLogFile defines the file to which scrape failures are logged. Reloading the configuration will reopen the file. If the filename has an empty path, e.g. 'file.log', The Prometheus Pods @@ -8520,14 +8510,14 @@ spec: scrapeInterval: default: 30s description: |- - Interval between consecutive scrapes. + scrapeInterval defines interval between consecutive scrapes. Default: "30s" pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string scrapeProtocols: description: |- - The protocols to negotiate during a scrape. It tells clients the + scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. @@ -8555,13 +8545,13 @@ spec: x-kubernetes-list-type: set scrapeTimeout: description: |- - Number of seconds to wait until a scrape request times out. + scrapeTimeout defines the number of seconds to wait until a scrape request times out. The value cannot be greater than the scrape interval otherwise the operator will reject the resource. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string secrets: description: |- - Secrets is a list of Secrets in the same namespace as the Prometheus + secrets defines a list of Secrets in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each Secret is added to the StatefulSet definition as a volume named `secret-`. The Secrets are mounted into /etc/prometheus/secrets/ in the 'prometheus' container. @@ -8571,7 +8561,7 @@ spec: x-kubernetes-list-type: set securityContext: description: |- - SecurityContext holds pod-level security attributes and common container settings. + securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext. properties: appArmorProfile: @@ -8800,12 +8790,12 @@ spec: type: object serviceAccountName: description: |- - ServiceAccountName is the name of the ServiceAccount to use to run the + serviceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods. type: string serviceDiscoveryRole: description: |- - Defines the service discovery role used to discover targets from + serviceDiscoveryRole defines the service discovery role used to discover targets from `ServiceMonitor` objects and Alertmanager endpoints. If set, the value should be either "Endpoints" or "EndpointSlice". @@ -8816,7 +8806,7 @@ spec: type: string serviceMonitorNamespaceSelector: description: |- - Namespaces to match for ServicedMonitors discovery. An empty label selector + serviceMonitorNamespaceSelector defines the namespaces to match for ServicedMonitors discovery. An empty label selector matches all namespaces. A null label selector (default value) matches the current namespace only. properties: @@ -8863,7 +8853,7 @@ spec: x-kubernetes-map-type: atomic serviceMonitorSelector: description: |- - ServiceMonitors to be selected for target discovery. An empty label + serviceMonitorSelector defines the serviceMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -8918,7 +8908,7 @@ spec: x-kubernetes-map-type: atomic serviceName: description: |- - The name of the service name used by the underlying StatefulSet(s) as the governing service. + serviceName defines the name of the service name used by the underlying StatefulSet(s) as the governing service. If defined, the Service must be created before the Prometheus/PrometheusAgent resource in the same namespace and it must define a selector that matches the pod labels. If empty, the operator will create and manage a headless service named `prometheus-operated` for Prometheus resources, or `prometheus-agent-operated` for PrometheusAgent resources. @@ -8927,11 +8917,11 @@ spec: minLength: 1 type: string sha: - description: 'Deprecated: use ''spec.image'' instead. The image''s digest can be specified as part of the image name.' + description: 'sha is deprecated: use ''spec.image'' instead. The image''s digest can be specified as part of the image name.' type: string shardRetentionPolicy: description: |- - ShardRetentionPolicy defines the retention policy for the Prometheus shards. + shardRetentionPolicy defines the retention policy for the Prometheus shards. (Alpha) Using this field requires the 'PrometheusShardRetentionPolicy' feature gate to be enabled. The final goals for this feature can be seen at https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/proposals/202310-shard-autoscaling.md#graceful-scale-down-of-prometheus-servers, @@ -8940,14 +8930,11 @@ spec: properties: retain: description: |- - Defines the config for retention when the retention policy is set to `Retain`. + retain defines the config for retention when the retention policy is set to `Retain`. This field is ineffective as of now. properties: retentionPeriod: - description: |- - Duration is a valid time duration that can be parsed by Prometheus model.ParseDuration() function. - Supported units: y, w, d, h, m, s, ms - Examples: `30s`, `1m`, `1h20m15s`, `15d` + description: retentionPeriod defines the retentionPeriod for shard retention policy. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string required: @@ -8955,7 +8942,7 @@ spec: type: object whenScaled: description: |- - Defines the retention policy when the Prometheus shards are scaled down. + whenScaled defines the retention policy when the Prometheus shards are scaled down. * `Delete`, the operator will delete the pods from the scaled-down shard(s). * `Retain`, the operator will keep the pods from the scaled-down shard(s), so the data can still be queried. @@ -8967,7 +8954,7 @@ spec: type: object shards: description: |- - Number of shards to distribute the scraped targets onto. + shards defines the number of shards to distribute the scraped targets onto. `spec.replicas` multiplied by `spec.shards` is the total number of Pods being created. @@ -8996,14 +8983,14 @@ spec: format: int32 type: integer storage: - description: Storage defines the storage used by Prometheus. + description: storage defines the storage used by Prometheus. properties: disableMountSubPath: - description: 'Deprecated: subPath usage will be removed in a future release.' + description: 'disableMountSubPath deprecated: subPath usage will be removed in a future release.' type: boolean emptyDir: description: |- - EmptyDirVolumeSource to be used by the StatefulSet. + emptyDir to be used by the StatefulSet. If specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir properties: @@ -9030,7 +9017,7 @@ spec: type: object ephemeral: description: |- - EphemeralVolumeSource to be used by the StatefulSet. + ephemeral to be used by the StatefulSet. This is a beta field in k8s 1.21 and GA in 1.15. For lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes @@ -9266,7 +9253,7 @@ spec: type: object volumeClaimTemplate: description: |- - Defines the PVC spec to be used by the Prometheus StatefulSets. + volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets. The easiest way to use a volume that cannot be automatically provisioned is to use a label selector alongside manually created PersistentVolumes. properties: @@ -9286,13 +9273,13 @@ spec: More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: - description: EmbeddedMetadata contains metadata relevant to an EmbeddedResource. + description: metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource. properties: annotations: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ @@ -9301,14 +9288,14 @@ spec: additionalProperties: type: string description: |- - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. @@ -9318,7 +9305,7 @@ spec: type: object spec: description: |- - Defines the desired characteristics of a volume requested by a pod author. + spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims properties: accessModes: @@ -9510,7 +9497,7 @@ spec: type: string type: object status: - description: 'Deprecated: this field is never set.' + description: 'status is deprecated: this field is never set.' properties: accessModes: description: |- @@ -9617,11 +9604,11 @@ spec: type: object type: object tag: - description: 'Deprecated: use ''spec.image'' instead. The image''s tag can be specified as part of the image name.' + description: 'tag is deprecated: use ''spec.image'' instead. The image''s tag can be specified as part of the image name.' type: string targetLimit: description: |- - TargetLimit defines a limit on the number of scraped targets that will be accepted. + targetLimit defines a limit on the number of scraped targets that will be accepted. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. @@ -9630,7 +9617,7 @@ spec: type: integer terminationGracePeriodSeconds: description: |- - Optional duration in seconds the pod needs to terminate gracefully. + terminationGracePeriodSeconds defines the optional duration in seconds the pod needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down) which may lead to data corruption. @@ -9639,11 +9626,11 @@ spec: minimum: 0 type: integer thanos: - description: Defines the configuration of the optional Thanos sidecar. + description: thanos defines the configuration of the optional Thanos sidecar. properties: additionalArgs: description: |- - AdditionalArgs allows setting additional arguments for the Thanos container. + additionalArgs allows setting additional arguments for the Thanos container. The arguments are passed as-is to the Thanos container which may cause issues if they are invalid or not supported the given Thanos version. In case of an argument conflict (e.g. an argument which is already set by the @@ -9653,23 +9640,23 @@ spec: description: Argument as part of the AdditionalArgs list. properties: name: - description: Name of the argument, e.g. "scrape.discovery-reload-interval". + description: name of the argument, e.g. "scrape.discovery-reload-interval". minLength: 1 type: string value: - description: Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) + description: value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) type: string required: - name type: object type: array baseImage: - description: 'Deprecated: use ''image'' instead.' + description: 'baseImage is deprecated: use ''image'' instead.' type: string blockSize: default: 2h description: |- - BlockDuration controls the size of TSDB blocks produced by Prometheus. + blockSize controls the size of TSDB blocks produced by Prometheus. The default value is 2h to match the upstream Prometheus defaults. WARNING: Changing the block duration can impact the performance and @@ -9680,31 +9667,31 @@ spec: pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string getConfigInterval: - description: How often to retrieve the Prometheus configuration. + description: getConfigInterval defines how often to retrieve the Prometheus configuration. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string getConfigTimeout: - description: Maximum time to wait when retrieving the Prometheus configuration. + description: getConfigTimeout defines the maximum time to wait when retrieving the Prometheus configuration. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string grpcListenLocal: description: |- - When true, the Thanos sidecar listens on the loopback interface instead + grpcListenLocal defines when true, the Thanos sidecar listens on the loopback interface instead of the Pod IP's address for the gRPC endpoints. It has no effect if `listenLocal` is true. type: boolean grpcServerTlsConfig: description: |- - Configures the TLS parameters for the gRPC server providing the StoreAPI. + grpcServerTlsConfig defines the TLS parameters for the gRPC server providing the StoreAPI. Note: Currently only the `caFile`, `certFile`, and `keyFile` fields are supported. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9726,7 +9713,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9749,13 +9736,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9777,7 +9764,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9800,16 +9787,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9832,7 +9819,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -9843,7 +9830,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -9853,19 +9840,19 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object httpListenLocal: description: |- - When true, the Thanos sidecar listens on the loopback interface instead + httpListenLocal when true, the Thanos sidecar listens on the loopback interface instead of the Pod IP's address for the HTTP endpoints. It has no effect if `listenLocal` is true. type: boolean image: description: |- - Container image name for Thanos. If specified, it takes precedence over + image defines the container image name for Thanos. If specified, it takes precedence over the `spec.thanos.baseImage`, `spec.thanos.tag` and `spec.thanos.sha` fields. @@ -9877,17 +9864,17 @@ spec: the time when the operator was released. type: string listenLocal: - description: 'Deprecated: use `grpcListenLocal` and `httpListenLocal` instead.' + description: 'listenLocal is deprecated: use `grpcListenLocal` and `httpListenLocal` instead.' type: boolean logFormat: - description: Log format for the Thanos sidecar. + description: logFormat for the Thanos sidecar. enum: - "" - logfmt - json type: string logLevel: - description: Log level for the Thanos sidecar. + description: logLevel for the Thanos sidecar. enum: - "" - debug @@ -9897,14 +9884,14 @@ spec: type: string minTime: description: |- - Defines the start of time range limit served by the Thanos sidecar's StoreAPI. + minTime defines the start of time range limit served by the Thanos sidecar's StoreAPI. The field's value should be a constant time in RFC3339 format or a time duration relative to current time, such as -1d or 2h45m. Valid duration units are ms, s, m, h, d, w, y. type: string objectStorageConfig: description: |- - Defines the Thanos sidecar's configuration to upload TSDB blocks to object storage. + objectStorageConfig defines the Thanos sidecar's configuration to upload TSDB blocks to object storage. More info: https://thanos.io/tip/thanos/storage.md/ @@ -9931,7 +9918,7 @@ spec: x-kubernetes-map-type: atomic objectStorageConfigFile: description: |- - Defines the Thanos sidecar's configuration file to upload TSDB blocks to object storage. + objectStorageConfigFile defines the Thanos sidecar's configuration file to upload TSDB blocks to object storage. More info: https://thanos.io/tip/thanos/storage.md/ @@ -9939,12 +9926,12 @@ spec: type: string readyTimeout: description: |- - ReadyTimeout is the maximum time that the Thanos sidecar will wait for + readyTimeout defines the maximum time that the Thanos sidecar will wait for Prometheus to start. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string resources: - description: Defines the resources requests and limits of the Thanos sidecar. + description: resources defines the resources requests and limits of the Thanos sidecar. properties: claims: description: |- @@ -10003,14 +9990,14 @@ spec: type: object type: object sha: - description: 'Deprecated: use ''image'' instead. The image digest can be specified as part of the image name.' + description: 'sha is deprecated: use ''image'' instead. The image digest can be specified as part of the image name.' type: string tag: - description: 'Deprecated: use ''image'' instead. The image''s tag can be specified as as part of the image name.' + description: 'tag is deprecated: use ''image'' instead. The image''s tag can be specified as as part of the image name.' type: string tracingConfig: description: |- - Defines the tracing configuration for the Thanos sidecar. + tracingConfig defines the tracing configuration for the Thanos sidecar. `tracingConfigFile` takes precedence over this field. @@ -10040,7 +10027,7 @@ spec: x-kubernetes-map-type: atomic tracingConfigFile: description: |- - Defines the tracing configuration file for the Thanos sidecar. + tracingConfigFile defines the tracing configuration file for the Thanos sidecar. This field takes precedence over `tracingConfig`. @@ -10051,7 +10038,7 @@ spec: type: string version: description: |- - Version of Thanos being deployed. The operator uses this information + version of Thanos being deployed. The operator uses this information to generate the Prometheus StatefulSet + configuration files. If not specified, the operator assumes the latest upstream release of @@ -10060,7 +10047,7 @@ spec: type: string volumeMounts: description: |- - VolumeMounts allows configuration of additional VolumeMounts for Thanos. + volumeMounts allows configuration of additional VolumeMounts for Thanos. VolumeMounts specified will be appended to other VolumeMounts in the 'thanos-sidecar' container. items: @@ -10126,7 +10113,7 @@ spec: type: array type: object tolerations: - description: Defines the Pods' tolerations if specified. + description: tolerations defines the Pods' tolerations if specified. items: description: |- The pod this Toleration is attached to tolerates any taint that matches @@ -10165,11 +10152,11 @@ spec: type: object type: array topologySpreadConstraints: - description: Defines the pod's topology spread constraints if specified. + description: topologySpreadConstraints defines the pod's topology spread constraints if specified. items: properties: additionalLabelSelectors: - description: Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint. + description: additionalLabelSelectors Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint. enum: - OnResource - OnShard @@ -10342,53 +10329,53 @@ spec: type: array tracingConfig: description: |- - TracingConfig configures tracing in Prometheus. + tracingConfig defines tracing in Prometheus. This is an *experimental feature*, it may change in any upcoming release in a breaking way. properties: clientType: - description: Client used to export the traces. Supported values are `http` or `grpc`. + description: clientType defines the client used to export the traces. Supported values are `http` or `grpc`. enum: - http - grpc type: string compression: - description: Compression key for supported compression types. The only supported value is `gzip`. + description: compression key for supported compression types. The only supported value is `gzip`. enum: - gzip type: string endpoint: - description: Endpoint to send the traces to. Should be provided in format :. + description: endpoint to send the traces to. Should be provided in format :. minLength: 1 type: string headers: additionalProperties: type: string - description: Key-value pairs to be used as headers associated with gRPC or HTTP requests. + description: headers defines the key-value pairs to be used as headers associated with gRPC or HTTP requests. type: object insecure: - description: If disabled, the client will use a secure connection. + description: insecure if disabled, the client will use a secure connection. type: boolean samplingFraction: anyOf: - type: integer - type: string - description: Sets the probability a given trace will be sampled. Must be a float from 0 through 1. + description: samplingFraction defines the probability a given trace will be sampled. Must be a float from 0 through 1. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true timeout: - description: Maximum time the exporter will wait for each batch export. + description: timeout defines the maximum time the exporter will wait for each batch export. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string tlsConfig: - description: TLS Config to use when sending traces. + description: tlsConfig to use when sending traces. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10410,7 +10397,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10433,13 +10420,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10461,7 +10448,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10484,16 +10471,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10516,7 +10503,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -10527,7 +10514,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -10537,7 +10524,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -10545,12 +10532,12 @@ spec: type: object tsdb: description: |- - Defines the runtime reloadable configuration of the timeseries database(TSDB). + tsdb defines the runtime reloadable configuration of the timeseries database(TSDB). It requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0. properties: outOfOrderTimeWindow: description: |- - Configures how old an out-of-order/out-of-bounds sample can be with + outOfOrderTimeWindow defines how old an out-of-order/out-of-bounds sample can be with respect to the TSDB max time. An out-of-order/out-of-bounds sample is ingested into the TSDB as long as @@ -10565,7 +10552,7 @@ spec: type: object version: description: |- - Version of Prometheus being deployed. The operator uses this information + version of Prometheus being deployed. The operator uses this information to generate the Prometheus StatefulSet + configuration files. If not specified, the operator assumes the latest upstream version of @@ -10574,7 +10561,7 @@ spec: type: string volumeMounts: description: |- - VolumeMounts allows the configuration of additional VolumeMounts. + volumeMounts allows the configuration of additional VolumeMounts. VolumeMounts will be appended to other VolumeMounts in the 'prometheus' container, that are generated as a result of StorageSpec objects. @@ -10641,7 +10628,7 @@ spec: type: array volumes: description: |- - Volumes allows the configuration of additional volumes on the output + volumes allows the configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects. items: @@ -12442,29 +12429,29 @@ spec: type: array walCompression: description: |- - Configures compression of the write-ahead log (WAL) using Snappy. + walCompression defines the compression of the write-ahead log (WAL) using Snappy. WAL compression is enabled by default for Prometheus >= 2.20.0 Requires Prometheus v2.11.0 and above. type: boolean web: - description: Defines the configuration of the Prometheus web server. + description: web defines the configuration of the Prometheus web server. properties: httpConfig: - description: Defines HTTP parameters for web server. + description: httpConfig defines HTTP parameters for web server. properties: headers: - description: List of headers that can be added to HTTP responses. + description: headers defines a list of headers that can be added to HTTP responses. properties: contentSecurityPolicy: description: |- - Set the Content-Security-Policy header to HTTP responses. + contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank. type: string strictTransportSecurity: description: |- - Set the Strict-Transport-Security header to HTTP responses. + strictTransportSecurity defines the Strict-Transport-Security header to HTTP responses. Unset if blank. Please make sure that you use this with care as this header might force browsers to load Prometheus and the other applications hosted on the same @@ -12473,7 +12460,7 @@ spec: type: string xContentTypeOptions: description: |- - Set the X-Content-Type-Options header to HTTP responses. + xContentTypeOptions defines the X-Content-Type-Options header to HTTP responses. Unset if blank. Accepted value is nosniff. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options enum: @@ -12482,7 +12469,7 @@ spec: type: string xFrameOptions: description: |- - Set the X-Frame-Options header to HTTP responses. + xFrameOptions defines the X-Frame-Options header to HTTP responses. Unset if blank. Accepted values are deny and sameorigin. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options enum: @@ -12492,41 +12479,41 @@ spec: type: string xXSSProtection: description: |- - Set the X-XSS-Protection header to all responses. + xXSSProtection defines the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection type: string type: object http2: description: |- - Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. + http2 enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. When TLSConfig is not configured, HTTP/2 will be disabled. Whenever the value of the field changes, a rolling update will be triggered. type: boolean type: object maxConnections: description: |- - Defines the maximum number of simultaneous connections + maxConnections defines the maximum number of simultaneous connections A zero value means that Prometheus doesn't accept any incoming connection. format: int32 minimum: 0 type: integer pageTitle: - description: The prometheus web page title. + description: pageTitle defines the prometheus web page title. type: string tlsConfig: - description: Defines the TLS parameters for HTTPS. + description: tlsConfig defines the TLS parameters for HTTPS. properties: cert: description: |- - Secret or ConfigMap containing the TLS certificate for the web server. + cert defines the Secret or ConfigMap containing the TLS certificate for the web server. Either `keySecret` or `keyFile` must be defined. It is mutually exclusive with `certFile`. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -12548,7 +12535,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -12572,7 +12559,7 @@ spec: type: object certFile: description: |- - Path to the TLS certificate file in the container for the web server. + certFile defines the path to the TLS certificate file in the container for the web server. Either `keySecret` or `keyFile` must be defined. @@ -12580,7 +12567,7 @@ spec: type: string cipherSuites: description: |- - List of supported cipher suites for TLS versions up to TLS 1.2. + cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2. If not defined, the Go default cipher suites are used. Available cipher suites are documented in the Go documentation: @@ -12590,13 +12577,13 @@ spec: type: array client_ca: description: |- - Secret or ConfigMap containing the CA certificate for client certificate + client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server. It is mutually exclusive with `clientCAFile`. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -12618,7 +12605,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -12642,21 +12629,21 @@ spec: type: object clientAuthType: description: |- - The server policy for client TLS authentication. + clientAuthType defines the server policy for client TLS authentication. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType type: string clientCAFile: description: |- - Path to the CA certificate file for client certificate authentication to + clientCAFile defines the path to the CA certificate file for client certificate authentication to the server. It is mutually exclusive with `client_ca`. type: string curvePreferences: description: |- - Elliptic curves that will be used in an ECDHE handshake, in preference + curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the Go documentation: @@ -12666,7 +12653,7 @@ spec: type: array keyFile: description: |- - Path to the TLS private key file in the container for the web server. + keyFile defines the path to the TLS private key file in the container for the web server. If defined, either `cert` or `certFile` must be defined. @@ -12674,7 +12661,7 @@ spec: type: string keySecret: description: |- - Secret containing the TLS private key for the web server. + keySecret defines the secret containing the TLS private key for the web server. Either `cert` or `certFile` must be defined. @@ -12700,14 +12687,14 @@ spec: type: object x-kubernetes-map-type: atomic maxVersion: - description: Maximum TLS version that is acceptable. + description: maxVersion defines the Maximum TLS version that is acceptable. type: string minVersion: - description: Minimum TLS version that is acceptable. + description: minVersion defines the minimum TLS version that is acceptable. type: string preferServerCipherSuites: description: |- - Controls whether the server selects the client's most preferred cipher + preferServerCipherSuites defines whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in @@ -12718,18 +12705,18 @@ spec: type: object status: description: |- - Most recent observed status of the Prometheus cluster. Read-only. + status defines the most recent observed status of the Prometheus cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status properties: availableReplicas: description: |- - Total number of available pods (ready for at least minReadySeconds) + availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this Prometheus deployment. format: int32 type: integer conditions: - description: The current state of the Prometheus deployment. + description: conditions defines the current state of the Prometheus deployment. items: description: |- Condition represents the state of the resources associated with the @@ -12740,11 +12727,11 @@ spec: format: date-time type: string message: - description: Human-readable message indicating details for the condition's last transition. + description: message defines human-readable message indicating details for the condition's last transition. type: string observedGeneration: description: |- - ObservedGeneration represents the .metadata.generation that the + observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if `.metadata.generation` is currently 12, but the `.status.conditions[].observedGeneration` is 9, the condition is out of date with respect to the current state of the @@ -12752,14 +12739,14 @@ spec: format: int64 type: integer reason: - description: Reason for the condition's last transition. + description: reason for the condition's last transition. type: string status: - description: Status of the condition. + description: status of the condition. minLength: 1 type: string type: - description: Type of the condition being reported. + description: type of the condition being reported. minLength: 1 type: string required: @@ -12773,42 +12760,42 @@ spec: x-kubernetes-list-type: map paused: description: |- - Represents whether any actions on the underlying managed objects are + paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed. type: boolean replicas: description: |- - Total number of non-terminated pods targeted by this Prometheus deployment + replicas defines the total number of non-terminated pods targeted by this Prometheus deployment (their labels match the selector). format: int32 type: integer selector: - description: The selector used to match the pods targeted by this Prometheus resource. + description: selector used to match the pods targeted by this Prometheus resource. type: string shardStatuses: - description: The list has one entry per shard. Each entry provides a summary of the shard status. + description: shardStatuses defines the list has one entry per shard. Each entry provides a summary of the shard status. items: properties: availableReplicas: description: |- - Total number of available pods (ready for at least minReadySeconds) + availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this shard. format: int32 type: integer replicas: - description: Total number of pods targeted by this shard. + description: replicas defines the total number of pods targeted by this shard. format: int32 type: integer shardID: - description: Identifier of the shard. + description: shardID defines the identifier of the shard. type: string unavailableReplicas: - description: Total number of unavailable pods targeted by this shard. + description: unavailableReplicas defines the Total number of unavailable pods targeted by this shard. format: int32 type: integer updatedReplicas: description: |- - Total number of non-terminated pods targeted by this shard + updatedReplicas defines the total number of non-terminated pods targeted by this shard that have the desired spec. format: int32 type: integer @@ -12824,25 +12811,19 @@ spec: - shardID x-kubernetes-list-type: map shards: - description: Shards is the most recently observed number of shards. + description: shards defines the most recently observed number of shards. format: int32 type: integer unavailableReplicas: - description: Total number of unavailable pods targeted by this Prometheus deployment. + description: unavailableReplicas defines the total number of unavailable pods targeted by this Prometheus deployment. format: int32 type: integer updatedReplicas: description: |- - Total number of non-terminated pods targeted by this Prometheus deployment + updatedReplicas defines the total number of non-terminated pods targeted by this Prometheus deployment that have the desired version spec. format: int32 type: integer - required: - - availableReplicas - - paused - - replicas - - unavailableReplicas - - updatedReplicas type: object required: - spec diff --git a/monitoring-satellite/manifests/crds/prometheusOperator-0prometheusagentCustomResourceDefinition.yaml b/monitoring-satellite/manifests/crds/prometheusOperator-0prometheusagentCustomResourceDefinition.yaml index 48d636db..495749b6 100644 --- a/monitoring-satellite/manifests/crds/prometheusOperator-0prometheusagentCustomResourceDefinition.yaml +++ b/monitoring-satellite/manifests/crds/prometheusOperator-0prometheusagentCustomResourceDefinition.yaml @@ -2,7 +2,7 @@ apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.18.0 + controller-gen.kubebuilder.io/version: v0.19.0 operator.prometheus.io/version: 0.85.0 name: prometheusagents.monitoring.coreos.com spec: @@ -72,12 +72,12 @@ spec: type: object spec: description: |- - Specification of the desired behavior of the Prometheus agent. More info: + spec defines the specification of the desired behavior of the Prometheus agent. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status properties: additionalArgs: description: |- - AdditionalArgs allows setting additional arguments for the 'prometheus' container. + additionalArgs allows setting additional arguments for the 'prometheus' container. It is intended for e.g. activating hidden flags which are not supported by the dedicated configuration options yet. The arguments are passed as-is to the @@ -91,11 +91,11 @@ spec: description: Argument as part of the AdditionalArgs list. properties: name: - description: Name of the argument, e.g. "scrape.discovery-reload-interval". + description: name of the argument, e.g. "scrape.discovery-reload-interval". minLength: 1 type: string value: - description: Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) + description: value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) type: string required: - name @@ -103,7 +103,7 @@ spec: type: array additionalScrapeConfigs: description: |- - AdditionalScrapeConfigs allows specifying a key of a Secret containing + additionalScrapeConfigs allows specifying a key of a Secret containing additional Prometheus scrape configurations. Scrape configurations specified are appended to the configurations generated by the Prometheus Operator. Job configurations specified must have the form as specified @@ -135,7 +135,7 @@ spec: type: object x-kubernetes-map-type: atomic affinity: - description: Defines the Pods' affinity scheduling rules if specified. + description: affinity defines the Pods' affinity scheduling rules if specified. properties: nodeAffinity: description: Describes node affinity scheduling rules for the pod. @@ -1009,7 +1009,7 @@ spec: type: object apiserverConfig: description: |- - APIServerConfig allows specifying a host and auth methods to access the + apiserverConfig allows specifying a host and auth methods to access the Kuberntees API server. If null, Prometheus is assumed to run inside of the cluster: it will discover the API servers automatically and use the Pod's CA certificate @@ -1017,13 +1017,13 @@ spec: properties: authorization: description: |- - Authorization section for the API server. + authorization section for the API server. Cannot be set at the same time as `basicAuth`, `bearerToken`, or `bearerTokenFile`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1045,11 +1045,11 @@ spec: type: object x-kubernetes-map-type: atomic credentialsFile: - description: File to read a secret from, mutually exclusive with `credentials`. + description: credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. type: string type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -1058,14 +1058,14 @@ spec: type: object basicAuth: description: |- - BasicAuth configuration for the API server. + basicAuth configuration for the API server. Cannot be set at the same time as `authorization`, `bearerToken`, or `bearerTokenFile`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -1089,7 +1089,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -1114,14 +1114,13 @@ spec: type: object bearerToken: description: |- - *Warning: this field shouldn't be used because the token value appears + bearerToken is deprecated: this will be removed in a future release. + *Warning: this field shouldn't be used because the token value appears in clear-text. Prefer using `authorization`.* - - Deprecated: this will be removed in a future release. type: string bearerTokenFile: description: |- - File to read bearer token for accessing apiserver. + bearerTokenFile defines the file to read bearer token for accessing apiserver. Cannot be set at the same time as `basicAuth`, `authorization`, or `bearerToken`. @@ -1129,12 +1128,12 @@ spec: type: string host: description: |- - Kubernetes API address consisting of a hostname or IP address followed + host defines the Kubernetes API address consisting of a hostname or IP address followed by an optional port number. type: string noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -1166,7 +1165,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -1174,22 +1173,22 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string tlsConfig: - description: TLS Config to use for the API server. + description: tlsConfig to use for the API server. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1211,7 +1210,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1234,13 +1233,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1262,7 +1261,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1285,16 +1284,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1317,7 +1316,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -1328,7 +1327,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -1338,7 +1337,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -1346,7 +1345,7 @@ spec: type: object arbitraryFSAccessThroughSMs: description: |- - When true, ServiceMonitor, PodMonitor and Probe object are forbidden to + arbitraryFSAccessThroughSMs when true, ServiceMonitor, PodMonitor and Probe object are forbidden to reference arbitrary files on the file system of the 'prometheus' container. When a ServiceMonitor's endpoint specifies a `bearerTokenFile` value @@ -1358,11 +1357,16 @@ spec: `spec.bearerTokenSecret` field. properties: deny: + description: |- + deny prevents service monitors from accessing arbitrary files on the file system. + When true, service monitors cannot use file-based configurations like BearerTokenFile + that could potentially access sensitive files. When false (default), such access is allowed. + Setting this to true enhances security by preventing potential credential theft attacks. type: boolean type: object automountServiceAccountToken: description: |- - AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod. + automountServiceAccountToken defines whether a service account token should be automatically mounted in the pod. If the field isn't set, the operator mounts the service account token by default. **Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery. @@ -1370,7 +1374,7 @@ spec: type: boolean bodySizeLimit: description: |- - BodySizeLimit defines per-scrape on response body size. + bodySizeLimit defines per-scrape on response body size. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. @@ -1379,7 +1383,7 @@ spec: type: string configMaps: description: |- - ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus + configMaps defines a list of ConfigMaps in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each ConfigMap is added to the StatefulSet definition as a volume named `configmap-`. The ConfigMaps are mounted into /etc/prometheus/configmaps/ in the 'prometheus' container. @@ -1388,7 +1392,7 @@ spec: type: array containers: description: |- - Containers allows injecting additional containers or modifying operator + containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to the Pods or to change the behavior of an operator generated container. Containers described here modify an operator generated @@ -2865,17 +2869,17 @@ spec: type: array convertClassicHistogramsToNHCB: description: |- - Whether to convert all scraped classic histograms into a native + convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.4.0. type: boolean dnsConfig: - description: Defines the DNS configuration for the pods. + description: dnsConfig defines the DNS configuration for the pods. properties: nameservers: description: |- - A list of DNS name server IP addresses. + nameservers defines the list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. items: minLength: 1 @@ -2884,7 +2888,7 @@ spec: x-kubernetes-list-type: set options: description: |- - A list of DNS resolver options. + options defines the list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Resolution options given in Options will override those that appear in the base DNSPolicy. @@ -2892,11 +2896,11 @@ spec: description: PodDNSConfigOption defines DNS resolver options of a pod. properties: name: - description: Name is required and must be unique. + description: name is required and must be unique. minLength: 1 type: string value: - description: Value is optional. + description: value is optional. type: string required: - name @@ -2907,7 +2911,7 @@ spec: x-kubernetes-list-type: map searches: description: |- - A list of DNS search domains for host-name lookup. + searches defines the list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. items: minLength: 1 @@ -2916,7 +2920,7 @@ spec: x-kubernetes-list-type: set type: object dnsPolicy: - description: Defines the DNS policy for the pods. + description: dnsPolicy defines the DNS policy for the pods. enum: - ClusterFirstWithHostNet - ClusterFirst @@ -2925,7 +2929,7 @@ spec: type: string enableFeatures: description: |- - Enable access to Prometheus feature flags. By default, no features are enabled. + enableFeatures enables access to Prometheus feature flags. By default, no features are enabled. Enabling features which are disabled by default is entirely outside the scope of what the maintainers will support and by doing so, you accept @@ -2939,7 +2943,7 @@ spec: x-kubernetes-list-type: set enableOTLPReceiver: description: |- - Enable Prometheus to be used as a receiver for the OTLP Metrics protocol. + enableOTLPReceiver defines the Prometheus to be used as a receiver for the OTLP Metrics protocol. Note that the OTLP receiver endpoint is automatically enabled if `.spec.otlpConfig` is defined. @@ -2947,7 +2951,7 @@ spec: type: boolean enableRemoteWriteReceiver: description: |- - Enable Prometheus to be used as a receiver for the Prometheus remote + enableRemoteWriteReceiver defines the Prometheus to be used as a receiver for the Prometheus remote write protocol. WARNING: This is not considered an efficient way of ingesting samples. @@ -2959,11 +2963,11 @@ spec: It requires Prometheus >= v2.33.0. type: boolean enableServiceLinks: - description: Indicates whether information about services should be injected into pod's environment variables + description: enableServiceLinks defines whether information about services should be injected into pod's environment variables type: boolean enforcedBodySizeLimit: description: |- - When defined, enforcedBodySizeLimit specifies a global limit on the size + enforcedBodySizeLimit when defined specifies a global limit on the size of uncompressed response body that will be accepted by Prometheus. Targets responding with a body larger than this many bytes will cause the scrape to fail. @@ -2979,7 +2983,7 @@ spec: type: string enforcedKeepDroppedTargets: description: |- - When defined, enforcedKeepDroppedTargets specifies a global limit on the number of targets + enforcedKeepDroppedTargets when defined specifies a global limit on the number of targets dropped by relabeling that will be kept in memory. The value overrides any `spec.keepDroppedTargets` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is @@ -2996,7 +3000,7 @@ spec: type: integer enforcedLabelLimit: description: |- - When defined, enforcedLabelLimit specifies a global limit on the number + enforcedLabelLimit when defined specifies a global limit on the number of labels per sample. The value overrides any `spec.labelLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is greater than zero and less than `spec.enforcedLabelLimit`. @@ -3012,7 +3016,7 @@ spec: type: integer enforcedLabelNameLengthLimit: description: |- - When defined, enforcedLabelNameLengthLimit specifies a global limit on the length + enforcedLabelNameLengthLimit when defined specifies a global limit on the length of labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is greater than zero and less than `spec.enforcedLabelNameLengthLimit`. @@ -3028,7 +3032,7 @@ spec: type: integer enforcedLabelValueLengthLimit: description: |- - When not null, enforcedLabelValueLengthLimit defines a global limit on the length + enforcedLabelValueLengthLimit when not null defines a global limit on the length of labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is greater than zero and less than `spec.enforcedLabelValueLengthLimit`. @@ -3044,7 +3048,7 @@ spec: type: integer enforcedNamespaceLabel: description: |- - When not empty, a label will be added to: + enforcedNamespaceLabel when not empty, a label will be added to: 1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects. 2. All metrics generated from recording rules defined in `PrometheusRule` objects. @@ -3059,7 +3063,7 @@ spec: type: string enforcedSampleLimit: description: |- - When defined, enforcedSampleLimit specifies a global limit on the number + enforcedSampleLimit when defined specifies a global limit on the number of scraped samples that will be accepted. This overrides any `spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.sampleLimit` is greater than zero and less than @@ -3077,7 +3081,7 @@ spec: type: integer enforcedTargetLimit: description: |- - When defined, enforcedTargetLimit specifies a global limit on the number + enforcedTargetLimit when defined specifies a global limit on the number of scraped targets. The value overrides any `spec.targetLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is greater than zero and less than `spec.enforcedTargetLimit`. @@ -3094,7 +3098,7 @@ spec: type: integer excludedFromEnforcement: description: |- - List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects + excludedFromEnforcement defines the list of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects to be excluded from enforcing a namespace label of origin. It is only applicable if `spec.enforcedNamespaceLabel` set to true. @@ -3103,21 +3107,21 @@ spec: properties: group: default: monitoring.coreos.com - description: Group of the referent. When not specified, it defaults to `monitoring.coreos.com` + description: group of the referent. When not specified, it defaults to `monitoring.coreos.com` enum: - monitoring.coreos.com type: string name: - description: Name of the referent. When not set, all resources in the namespace are matched. + description: name of the referent. When not set, all resources in the namespace are matched. type: string namespace: description: |- - Namespace of the referent. + namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ minLength: 1 type: string resource: - description: Resource of the referent. + description: resource of the referent. enum: - prometheusrules - servicemonitors @@ -3134,20 +3138,20 @@ spec: additionalProperties: type: string description: |- - The labels to add to any time series or alerts when communicating with + externalLabels defines the labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager). Labels defined by `spec.replicaExternalLabelName` and `spec.prometheusExternalLabelName` take precedence over this list. type: object externalUrl: description: |- - The external URL under which the Prometheus service is externally + externalUrl defines the external URL under which the Prometheus service is externally available. This is necessary to generate correct URLs (for instance if Prometheus is accessible behind an Ingress resource). type: string hostAliases: description: |- - Optional list of hosts and IPs that will be injected into the Pod's + hostAliases defines the optional list of hosts and IPs that will be injected into the Pod's hosts file if specified. items: description: |- @@ -3155,12 +3159,12 @@ spec: pod's hosts file. properties: hostnames: - description: Hostnames for the above IP address. + description: hostnames defines hostnames for the above IP address. items: type: string type: array ip: - description: IP address of the host file entry. + description: ip defines the IP address of the host file entry. type: string required: - hostnames @@ -3172,7 +3176,7 @@ spec: x-kubernetes-list-type: map hostNetwork: description: |- - Use the host's network namespace if true. + hostNetwork defines the host's network namespace if true. Make sure to understand the security implications if you want to enable it (https://kubernetes.io/docs/concepts/configuration/overview/ ). @@ -3183,7 +3187,7 @@ spec: type: boolean hostUsers: description: |- - HostUsers supports the user space in Kubernetes. + hostUsers supports the user space in Kubernetes. More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/ @@ -3192,14 +3196,14 @@ spec: type: boolean ignoreNamespaceSelectors: description: |- - When true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor + ignoreNamespaceSelectors when true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor and Probe objects will be ignored. They will only discover targets within the namespace of the PodMonitor, ServiceMonitor and Probe object. type: boolean image: description: |- - Container image name for Prometheus. If specified, it takes precedence + image defines the container image name for Prometheus. If specified, it takes precedence over the `spec.baseImage`, `spec.tag` and `spec.sha` fields. Specifying `spec.version` is still necessary to ensure the Prometheus @@ -3211,7 +3215,7 @@ spec: type: string imagePullPolicy: description: |- - Image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers. + imagePullPolicy defines the image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details. enum: - "" @@ -3221,7 +3225,7 @@ spec: type: string imagePullSecrets: description: |- - An optional list of references to Secrets in the same namespace + imagePullSecrets defines an optional list of references to Secrets in the same namespace to use for pulling images from registries. See http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod items: @@ -3243,7 +3247,7 @@ spec: type: array initContainers: description: |- - InitContainers allows injecting initContainers to the Pod definition. Those + initContainers allows injecting initContainers to the Pod definition. Those can be used to e.g. fetch secrets for injection into the Prometheus configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: @@ -4720,7 +4724,7 @@ spec: type: array keepDroppedTargets: description: |- - Per-scrape limit on the number of targets dropped by relabeling + keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0. @@ -4731,7 +4735,7 @@ spec: type: integer labelLimit: description: |- - Per-scrape limit on number of labels that will be accepted for a sample. + labelLimit defines per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. @@ -4740,7 +4744,7 @@ spec: type: integer labelNameLengthLimit: description: |- - Per-scrape limit on length of labels name that will be accepted for a sample. + labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. @@ -4749,7 +4753,7 @@ spec: type: integer labelValueLengthLimit: description: |- - Per-scrape limit on length of labels value that will be accepted for a sample. + labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. @@ -4758,18 +4762,18 @@ spec: type: integer listenLocal: description: |- - When true, the Prometheus server listens on the loopback address + listenLocal when true, the Prometheus server listens on the loopback address instead of the Pod IP's address. type: boolean logFormat: - description: Log format for Log level for Prometheus and the config-reloader sidecar. + description: logFormat for Log level for Prometheus and the config-reloader sidecar. enum: - "" - logfmt - json type: string logLevel: - description: Log level for Prometheus and the config-reloader sidecar. + description: logLevel for Prometheus and the config-reloader sidecar. enum: - "" - debug @@ -4779,14 +4783,14 @@ spec: type: string maximumStartupDurationSeconds: description: |- - Defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete. + maximumStartupDurationSeconds defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete. If set, the value should be greater than 60 (seconds). Otherwise it will be equal to 600 seconds (15 minutes). format: int32 minimum: 60 type: integer minReadySeconds: description: |- - Minimum number of seconds for which a newly created Pod should be ready + minReadySeconds defines the minimum number of seconds for which a newly created Pod should be ready without any of its container crashing for it to be considered available. If unset, pods will be considered available as soon as they are ready. @@ -4795,7 +4799,7 @@ spec: type: integer mode: description: |- - Mode defines how the Prometheus operator deploys the PrometheusAgent pod(s). + mode defines how the Prometheus operator deploys the PrometheusAgent pod(s). (Alpha) Using this field requires the `PrometheusAgentDaemonSet` feature gate to be enabled. enum: @@ -4804,7 +4808,7 @@ spec: type: string nameEscapingScheme: description: |- - Specifies the character escaping scheme that will be requested when scraping + nameEscapingScheme defines the character escaping scheme that will be requested when scraping for metric and label names that do not conform to the legacy Prometheus character set. @@ -4817,7 +4821,7 @@ spec: type: string nameValidationScheme: description: |- - Specifies the validation scheme for metric and label names. + nameValidationScheme defines the validation scheme for metric and label names. It requires Prometheus >= v2.55.0. enum: @@ -4827,21 +4831,21 @@ spec: nodeSelector: additionalProperties: type: string - description: Defines on which Nodes the Pods are scheduled. + description: nodeSelector defines on which Nodes the Pods are scheduled. type: object otlp: description: |- - Settings related to the OTLP receiver feature. + otlp defines the settings related to the OTLP receiver feature. It requires Prometheus >= v2.55.0. properties: convertHistogramsToNHCB: description: |- - Configures optional translation of OTLP explicit bucket histograms into native histograms with custom buckets. + convertHistogramsToNHCB defines optional translation of OTLP explicit bucket histograms into native histograms with custom buckets. It requires Prometheus >= v3.4.0. type: boolean ignoreResourceAttributes: description: |- - List of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true. + ignoreResourceAttributes defines the list of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true. It requires `promoteAllResourceAttributes` to be true. It requires Prometheus >= v3.5.0. @@ -4853,21 +4857,21 @@ spec: x-kubernetes-list-type: set keepIdentifyingResourceAttributes: description: |- - Enables adding `service.name`, `service.namespace` and `service.instance.id` + keepIdentifyingResourceAttributes enables adding `service.name`, `service.namespace` and `service.instance.id` resource attributes to the `target_info` metric, on top of converting them into the `instance` and `job` labels. It requires Prometheus >= v3.1.0. type: boolean promoteAllResourceAttributes: description: |- - Promote all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`. + promoteAllResourceAttributes promotes all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`. Cannot be true when `promoteResourceAttributes` is defined. It requires Prometheus >= v3.5.0. type: boolean promoteResourceAttributes: description: |- - List of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none. + promoteResourceAttributes defines the list of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none. Cannot be defined when `promoteAllResourceAttributes` is true. items: minLength: 1 @@ -4877,7 +4881,7 @@ spec: x-kubernetes-list-type: set translationStrategy: description: |- - Configures how the OTLP receiver endpoint translates the incoming metrics. + translationStrategy defines how the OTLP receiver endpoint translates the incoming metrics. It requires Prometheus >= v3.0.0. enum: @@ -4888,7 +4892,7 @@ spec: type: object overrideHonorLabels: description: |- - When true, Prometheus resolves label conflicts by renaming the labels in the scraped data + overrideHonorLabels when true, Prometheus resolves label conflicts by renaming the labels in the scraped data to “exported_” for all targets created from ServiceMonitor, PodMonitor and ScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies. In practice,`overrideHonorLaels:true` enforces `honorLabels:false` @@ -4896,18 +4900,18 @@ spec: type: boolean overrideHonorTimestamps: description: |- - When true, Prometheus ignores the timestamps for all the targets created + overrideHonorTimestamps when true, Prometheus ignores the timestamps for all the targets created from service and pod monitors. Otherwise the HonorTimestamps field of the service or pod monitor applies. type: boolean paused: description: |- - When a Prometheus deployment is paused, no actions except for deletion + paused defines when a Prometheus deployment is paused, no actions except for deletion will be performed on the underlying objects. type: boolean persistentVolumeClaimRetentionPolicy: description: |- - The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet. + persistentVolumeClaimRetentionPolicy defines the field controls if and how PVCs are deleted during the lifecycle of a StatefulSet. The default behavior is all PVCs are retained. This is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26. It requires enabling the StatefulSetAutoDeletePVC feature gate. @@ -4930,7 +4934,7 @@ spec: type: object podMetadata: description: |- - PodMetadata configures labels and annotations which are propagated to the Prometheus pods. + podMetadata defines labels and annotations which are propagated to the Prometheus pods. The following items are reserved and cannot be overridden: * "prometheus" label, set to the name of the Prometheus object. @@ -4946,7 +4950,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ @@ -4955,14 +4959,14 @@ spec: additionalProperties: type: string description: |- - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. @@ -4972,7 +4976,7 @@ spec: type: object podMonitorNamespaceSelector: description: |- - Namespaces to match for PodMonitors discovery. An empty label selector + podMonitorNamespaceSelector defines the namespaces to match for PodMonitors discovery. An empty label selector matches all namespaces. A null label selector (default value) matches the current namespace only. properties: @@ -5019,7 +5023,7 @@ spec: x-kubernetes-map-type: atomic podMonitorSelector: description: |- - PodMonitors to be selected for target discovery. An empty label selector + podMonitorSelector defines the podMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -5074,7 +5078,7 @@ spec: x-kubernetes-map-type: atomic podTargetLabels: description: |- - PodTargetLabels are appended to the `spec.podTargetLabels` field of all + podTargetLabels are appended to the `spec.podTargetLabels` field of all PodMonitor and ServiceMonitor objects. items: type: string @@ -5082,15 +5086,15 @@ spec: portName: default: web description: |- - Port name used for the pods and governing service. + portName used for the pods and governing service. Default: "web" type: string priorityClassName: - description: Priority class assigned to the Pods. + description: priorityClassName assigned to the Pods. type: string probeNamespaceSelector: description: |- - Namespaces to match for Probe discovery. An empty label + probeNamespaceSelector defines the namespaces to match for Probe discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only. properties: @@ -5137,7 +5141,7 @@ spec: x-kubernetes-map-type: atomic probeSelector: description: |- - Probes to be selected for target discovery. An empty label selector + probeSelector defines the probes to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -5192,7 +5196,7 @@ spec: x-kubernetes-map-type: atomic prometheusExternalLabelName: description: |- - Name of Prometheus external label used to denote the Prometheus instance + prometheusExternalLabelName defines the name of Prometheus external label used to denote the Prometheus instance name. The external label will _not_ be added when the field is set to the empty string (`""`). @@ -5200,14 +5204,14 @@ spec: type: string reloadStrategy: description: |- - Defines the strategy used to reload the Prometheus configuration. + reloadStrategy defines the strategy used to reload the Prometheus configuration. If not specified, the configuration is reloaded using the /-/reload HTTP endpoint. enum: - HTTP - ProcessSignal type: string remoteWrite: - description: Defines the list of remote write configurations. + description: remoteWrite defines the list of remote write configurations. items: description: |- RemoteWriteSpec defines the configuration to write samples from Prometheus @@ -5215,14 +5219,14 @@ spec: properties: authorization: description: |- - Authorization section for the URL. + authorization section for the URL. It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. Cannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5244,11 +5248,11 @@ spec: type: object x-kubernetes-map-type: atomic credentialsFile: - description: File to read a secret from, mutually exclusive with `credentials`. + description: credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. type: string type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -5257,14 +5261,14 @@ spec: type: object azureAd: description: |- - AzureAD for the URL. + azureAd for the URL. It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0. Cannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`. properties: cloud: - description: The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'. + description: cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'. enum: - AzureChina - AzureGovernment @@ -5272,28 +5276,28 @@ spec: type: string managedIdentity: description: |- - ManagedIdentity defines the Azure User-assigned Managed identity. + managedIdentity defines the Azure User-assigned Managed identity. Cannot be set at the same time as `oauth` or `sdk`. properties: clientId: - description: The client id + description: clientId defines defines the Azure User-assigned Managed identity. type: string required: - clientId type: object oauth: description: |- - OAuth defines the oauth config that is being used to authenticate. + oauth defines the oauth config that is being used to authenticate. Cannot be set at the same time as `managedIdentity` or `sdk`. It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0. properties: clientId: - description: '`clientID` is the clientId of the Azure Active Directory application that is being used to authenticate.' + description: clientId defines the clientId of the Azure Active Directory application that is being used to authenticate. minLength: 1 type: string clientSecret: - description: '`clientSecret` specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.' + description: clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5315,7 +5319,7 @@ spec: type: object x-kubernetes-map-type: atomic tenantId: - description: '`tenantId` is the tenant ID of the Azure Active Directory application that is being used to authenticate.' + description: tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate. minLength: 1 pattern: ^[0-9a-zA-Z-.]+$ type: string @@ -5326,27 +5330,27 @@ spec: type: object sdk: description: |- - SDK defines the Azure SDK config that is being used to authenticate. + sdk defines the Azure SDK config that is being used to authenticate. See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication Cannot be set at the same time as `oauth` or `managedIdentity`. It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0. properties: tenantId: - description: '`tenantId` is the tenant ID of the azure active directory application that is being used to authenticate.' + description: tenantId defines the tenant ID of the azure active directory application that is being used to authenticate. pattern: ^[0-9a-zA-Z-.]+$ type: string type: object type: object basicAuth: description: |- - BasicAuth configuration for the URL. + basicAuth configuration for the URL. Cannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -5370,7 +5374,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -5395,23 +5399,22 @@ spec: type: object bearerToken: description: |- + bearerToken is deprecated: this will be removed in a future release. *Warning: this field shouldn't be used because the token value appears in clear-text. Prefer using `authorization`.* - - Deprecated: this will be removed in a future release. type: string bearerTokenFile: description: |- - File from which to read bearer token for the URL. + bearerTokenFile defines the file from which to read bearer token for the URL. Deprecated: this will be removed in a future release. Prefer using `authorization`. type: string enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean followRedirects: description: |- - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. type: boolean @@ -5419,14 +5422,14 @@ spec: additionalProperties: type: string description: |- - Custom HTTP headers to be sent along with each remote write request. + headers defines the custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can't be overwritten. It requires Prometheus >= v2.25.0 or Thanos >= v0.24.0. type: object messageVersion: description: |- - The Remote Write message's version to use when writing to the endpoint. + messageVersion defines the Remote Write message's version to use when writing to the endpoint. `Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0. `Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0. @@ -5443,34 +5446,34 @@ spec: - V2.0 type: string metadataConfig: - description: MetadataConfig configures the sending of series metadata to the remote storage. + description: metadataConfig defines how to send a series metadata to the remote storage. properties: maxSamplesPerSend: description: |- - MaxSamplesPerSend is the maximum number of metadata samples per send. + maxSamplesPerSend defines the maximum number of metadata samples per send. It requires Prometheus >= v2.29.0. format: int32 minimum: -1 type: integer send: - description: Defines whether metric metadata is sent to the remote storage or not. + description: send defines whether metric metadata is sent to the remote storage or not. type: boolean sendInterval: - description: Defines how frequently metric metadata is sent to the remote storage. + description: sendInterval defines how frequently metric metadata is sent to the remote storage. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string type: object name: description: |- - The name of the remote write queue, it must be unique if specified. The + name of the remote write queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate queues. It requires Prometheus >= v2.15.0 or Thanos >= 0.24.0. type: string noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -5478,7 +5481,7 @@ spec: type: string oauth2: description: |- - OAuth2 configuration for the URL. + oauth2 configuration for the URL. It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0. @@ -5486,11 +5489,11 @@ spec: properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5512,7 +5515,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5536,7 +5539,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -5562,12 +5565,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -5599,7 +5602,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -5607,29 +5610,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5651,7 +5654,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5674,10 +5677,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5699,7 +5702,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5722,10 +5725,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5748,7 +5751,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -5759,7 +5762,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -5769,11 +5772,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -5807,7 +5810,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -5815,82 +5818,70 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string queueConfig: - description: QueueConfig allows tuning of the remote write queue parameters. + description: queueConfig allows tuning of the remote write queue parameters. properties: batchSendDeadline: - description: BatchSendDeadline is the maximum time a sample will wait in buffer. + description: batchSendDeadline defines the maximum time a sample will wait in buffer. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string capacity: description: |- - Capacity is the number of samples to buffer per shard before we start + capacity defines the number of samples to buffer per shard before we start dropping them. type: integer maxBackoff: - description: MaxBackoff is the maximum retry delay. + description: maxBackoff defines the maximum retry delay. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string maxRetries: - description: MaxRetries is the maximum number of times to retry a batch on recoverable errors. + description: maxRetries defines the maximum number of times to retry a batch on recoverable errors. type: integer maxSamplesPerSend: - description: MaxSamplesPerSend is the maximum number of samples per send. + description: maxSamplesPerSend defines the maximum number of samples per send. type: integer maxShards: - description: MaxShards is the maximum number of shards, i.e. amount of concurrency. + description: maxShards defines the maximum number of shards, i.e. amount of concurrency. type: integer minBackoff: - description: MinBackoff is the initial retry delay. Gets doubled for every retry. + description: minBackoff defines the initial retry delay. Gets doubled for every retry. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string minShards: - description: MinShards is the minimum number of shards, i.e. amount of concurrency. + description: minShards defines the minimum number of shards, i.e. amount of concurrency. type: integer retryOnRateLimit: description: |- - Retry upon receiving a 429 status code from the remote-write storage. + retryOnRateLimit defines the retry upon receiving a 429 status code from the remote-write storage. This is an *experimental feature*, it may change in any upcoming release in a breaking way. type: boolean sampleAgeLimit: description: |- - SampleAgeLimit drops samples older than the limit. + sampleAgeLimit drops samples older than the limit. It requires Prometheus >= v2.50.0 or Thanos >= v0.32.0. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string type: object remoteTimeout: - description: Timeout for requests to the remote write endpoint. + description: remoteTimeout defines the timeout for requests to the remote write endpoint. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string roundRobinDNS: - description: |- - When enabled: - - The remote-write mechanism will resolve the hostname via DNS. - - It will randomly select one of the resolved IP addresses and connect to it. - - When disabled (default behavior): - - The Go standard library will handle hostname resolution. - - It will attempt connections to each resolved IP address sequentially. - - Note: The connection timeout applies to the entire resolution and connection process. - If disabled, the timeout is distributed across all connection attempts. - - It requires Prometheus >= v3.1.0 or Thanos >= v0.38.0. + description: "roundRobinDNS controls the DNS resolution behavior for remote-write connections.\nWhen enabled:\n - The remote-write mechanism will resolve the hostname via DNS.\n - It will randomly select one of the resolved IP addresses and connect to it.\n\nWhen disabled (default behavior):\n - The Go standard library will handle hostname resolution.\n - It will attempt connections to each resolved IP address sequentially.\n\nNote: The connection timeout applies to the entire resolution and connection process.\n\n\tIf disabled, the timeout is distributed across all connection attempts.\n\nIt requires Prometheus >= v3.1.0 or Thanos >= v0.38.0." type: boolean sendExemplars: description: |- - Enables sending of exemplars over remote write. Note that + sendExemplars enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the `spec.enableFeatures` option for exemplars to be scraped in the first place. @@ -5898,14 +5889,14 @@ spec: type: boolean sendNativeHistograms: description: |- - Enables sending of native histograms, also known as sparse histograms + sendNativeHistograms enables sending of native histograms, also known as sparse histograms over remote write. It requires Prometheus >= v2.40.0 or Thanos >= v0.30.0. type: boolean sigv4: description: |- - Sigv4 allows to configures AWS's Signature Verification 4 for the URL. + sigv4 defines the AWS's Signature Verification 4 for the URL. It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. @@ -5913,7 +5904,7 @@ spec: properties: accessKey: description: |- - AccessKey is the AWS API key. If not specified, the environment variable + accessKey defines the AWS API key. If not specified, the environment variable `AWS_ACCESS_KEY_ID` is used. properties: key: @@ -5936,17 +5927,17 @@ spec: type: object x-kubernetes-map-type: atomic profile: - description: Profile is the named AWS profile used to authenticate. + description: profile defines the named AWS profile used to authenticate. type: string region: - description: Region is the AWS region. If blank, the region from the default credentials chain used. + description: region defines the AWS region. If blank, the region from the default credentials chain used. type: string roleArn: - description: RoleArn is the named AWS profile used to authenticate. + description: roleArn defines the named AWS profile used to authenticate. type: string secretKey: description: |- - SecretKey is the AWS API secret. If not specified, the environment + secretKey defines the AWS API secret. If not specified, the environment variable `AWS_SECRET_ACCESS_KEY` is used. properties: key: @@ -5970,13 +5961,13 @@ spec: x-kubernetes-map-type: atomic type: object tlsConfig: - description: TLS Config to use for the URL. + description: tlsConfig to use for the URL. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5998,7 +5989,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6021,13 +6012,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6049,7 +6040,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6072,16 +6063,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6104,7 +6095,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -6115,7 +6106,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -6125,15 +6116,15 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object url: - description: The URL of the endpoint to send samples to. + description: url defines the URL of the endpoint to send samples to. minLength: 1 type: string writeRelabelConfigs: - description: The list of remote write relabel configurations. + description: writeRelabelConfigs defines the list of remote write relabel configurations. items: description: |- RelabelConfig allows dynamic rewriting of the label set for targets, alerts, @@ -6144,7 +6135,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -6176,27 +6167,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -6208,7 +6199,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -6223,7 +6214,7 @@ spec: type: array remoteWriteReceiverMessageVersions: description: |- - List of the protobuf message versions to accept when receiving the + remoteWriteReceiverMessageVersions list of the protobuf message versions to accept when receiving the remote writes. It requires Prometheus >= v2.54.0. @@ -6237,7 +6228,7 @@ spec: x-kubernetes-list-type: set replicaExternalLabelName: description: |- - Name of Prometheus external label used to denote the replica name. + replicaExternalLabelName defines the name of Prometheus external label used to denote the replica name. The external label will _not_ be added when the field is set to the empty string (`""`). @@ -6245,7 +6236,7 @@ spec: type: string replicas: description: |- - Number of replicas of each shard to deploy for a Prometheus deployment. + replicas defines the number of replicas of each shard to deploy for a Prometheus deployment. `spec.replicas` multiplied by `spec.shards` is the total number of Pods created. @@ -6253,7 +6244,7 @@ spec: format: int32 type: integer resources: - description: Defines the resources requests and limits of the 'prometheus' container. + description: resources defines the resources requests and limits of the 'prometheus' container. properties: claims: description: |- @@ -6313,7 +6304,7 @@ spec: type: object routePrefix: description: |- - The route prefix Prometheus registers HTTP handlers for. + routePrefix defines the route prefix Prometheus registers HTTP handlers for. This is useful when using `spec.externalURL`, and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but @@ -6321,11 +6312,11 @@ spec: for use with `kubectl proxy`. type: string runtime: - description: RuntimeConfig configures the values for the Prometheus process behavior + description: runtime defines the values for the Prometheus process behavior properties: goGC: description: |- - The Go garbage collection target percentage. Lowering this number may increase the CPU usage. + goGC defines the Go garbage collection target percentage. Lowering this number may increase the CPU usage. See: https://tip.golang.org/doc/gc-guide#GOGC format: int32 minimum: -1 @@ -6333,7 +6324,7 @@ spec: type: object sampleLimit: description: |- - SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. + sampleLimit defines per-scrape limit on number of scraped samples that will be accepted. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. @@ -6342,7 +6333,7 @@ spec: type: integer scrapeClasses: description: |- - List of scrape classes to expose to scraping objects such as + scrapeClasses defines the list of scrape classes to expose to scraping objects such as PodMonitors, ServiceMonitors, Probes and ScrapeConfigs. This is an *experimental feature*, it may change in any upcoming release @@ -6351,13 +6342,13 @@ spec: properties: attachMetadata: description: |- - AttachMetadata configures additional metadata to the discovered targets. + attachMetadata defines additional metadata to the discovered targets. When the scrape object defines its own configuration, it takes precedence over the scrape class configuration. properties: node: description: |- - When set to true, Prometheus attaches node metadata to the discovered + node when set to true, Prometheus attaches node metadata to the discovered targets. The Prometheus service account must have the `list` and `watch` @@ -6366,11 +6357,11 @@ spec: type: object authorization: description: |- - Authorization section for the ScrapeClass. + authorization section for the ScrapeClass. It will only apply if the scrape resource doesn't specify any Authorization. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6392,11 +6383,11 @@ spec: type: object x-kubernetes-map-type: atomic credentialsFile: - description: File to read a secret from, mutually exclusive with `credentials`. + description: credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. type: string type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -6405,14 +6396,14 @@ spec: type: object default: description: |- - Default indicates that the scrape applies to all scrape objects that + default defines that the scrape applies to all scrape objects that don't configure an explicit scrape class name. Only one scrape class can be set as the default. type: boolean fallbackScrapeProtocol: description: |- - The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. + fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It will only apply if the scrape resource doesn't specify any FallbackScrapeProtocol It requires Prometheus >= v3.0.0. @@ -6425,7 +6416,7 @@ spec: type: string metricRelabelings: description: |- - MetricRelabelings configures the relabeling rules to apply to all samples before ingestion. + metricRelabelings defines the relabeling rules to apply to all samples before ingestion. The Operator adds the scrape class metric relabelings defined here. Then the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs. @@ -6442,7 +6433,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -6474,27 +6465,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -6506,7 +6497,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -6516,12 +6507,12 @@ spec: type: object type: array name: - description: Name of the scrape class. + description: name of the scrape class. minLength: 1 type: string relabelings: description: |- - Relabelings configures the relabeling rules to apply to all scrape targets. + relabelings defines the relabeling rules to apply to all scrape targets. The Operator automatically adds relabelings for a few standard Kubernetes fields like `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`. @@ -6539,7 +6530,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -6571,27 +6562,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -6603,7 +6594,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -6614,17 +6605,17 @@ spec: type: array tlsConfig: description: |- - TLSConfig defines the TLS settings to use for the scrape. When the + tlsConfig defines the TLS settings to use for the scrape. When the scrape objects define their own CA, certificate and/or key, they take precedence over the corresponding scrape class fields. For now only the `caFile`, `certFile` and `keyFile` fields are supported. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6646,7 +6637,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6669,13 +6660,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6697,7 +6688,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6720,16 +6711,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6752,7 +6743,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -6763,7 +6754,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -6773,7 +6764,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -6785,7 +6776,7 @@ spec: x-kubernetes-list-type: map scrapeClassicHistograms: description: |- - Whether to scrape a classic histogram that is also exposed as a native histogram. + scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration. @@ -6793,7 +6784,7 @@ spec: type: boolean scrapeConfigNamespaceSelector: description: |- - Namespaces to match for ScrapeConfig discovery. An empty label selector + scrapeConfigNamespaceSelector defines the namespaces to match for ScrapeConfig discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only. @@ -6842,7 +6833,7 @@ spec: x-kubernetes-map-type: atomic scrapeConfigSelector: description: |- - ScrapeConfigs to be selected for target discovery. An empty label + scrapeConfigSelector defines the scrapeConfigs to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -6899,7 +6890,7 @@ spec: x-kubernetes-map-type: atomic scrapeFailureLogFile: description: |- - File to which scrape failures are logged. + scrapeFailureLogFile defines the file to which scrape failures are logged. Reloading the configuration will reopen the file. If the filename has an empty path, e.g. 'file.log', The Prometheus Pods @@ -6912,14 +6903,14 @@ spec: scrapeInterval: default: 30s description: |- - Interval between consecutive scrapes. + scrapeInterval defines interval between consecutive scrapes. Default: "30s" pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string scrapeProtocols: description: |- - The protocols to negotiate during a scrape. It tells clients the + scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. @@ -6947,13 +6938,13 @@ spec: x-kubernetes-list-type: set scrapeTimeout: description: |- - Number of seconds to wait until a scrape request times out. + scrapeTimeout defines the number of seconds to wait until a scrape request times out. The value cannot be greater than the scrape interval otherwise the operator will reject the resource. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string secrets: description: |- - Secrets is a list of Secrets in the same namespace as the Prometheus + secrets defines a list of Secrets in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each Secret is added to the StatefulSet definition as a volume named `secret-`. The Secrets are mounted into /etc/prometheus/secrets/ in the 'prometheus' container. @@ -6963,7 +6954,7 @@ spec: x-kubernetes-list-type: set securityContext: description: |- - SecurityContext holds pod-level security attributes and common container settings. + securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext. properties: appArmorProfile: @@ -7192,12 +7183,12 @@ spec: type: object serviceAccountName: description: |- - ServiceAccountName is the name of the ServiceAccount to use to run the + serviceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods. type: string serviceDiscoveryRole: description: |- - Defines the service discovery role used to discover targets from + serviceDiscoveryRole defines the service discovery role used to discover targets from `ServiceMonitor` objects and Alertmanager endpoints. If set, the value should be either "Endpoints" or "EndpointSlice". @@ -7208,7 +7199,7 @@ spec: type: string serviceMonitorNamespaceSelector: description: |- - Namespaces to match for ServicedMonitors discovery. An empty label selector + serviceMonitorNamespaceSelector defines the namespaces to match for ServicedMonitors discovery. An empty label selector matches all namespaces. A null label selector (default value) matches the current namespace only. properties: @@ -7255,7 +7246,7 @@ spec: x-kubernetes-map-type: atomic serviceMonitorSelector: description: |- - ServiceMonitors to be selected for target discovery. An empty label + serviceMonitorSelector defines the serviceMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -7310,7 +7301,7 @@ spec: x-kubernetes-map-type: atomic serviceName: description: |- - The name of the service name used by the underlying StatefulSet(s) as the governing service. + serviceName defines the name of the service name used by the underlying StatefulSet(s) as the governing service. If defined, the Service must be created before the Prometheus/PrometheusAgent resource in the same namespace and it must define a selector that matches the pod labels. If empty, the operator will create and manage a headless service named `prometheus-operated` for Prometheus resources, or `prometheus-agent-operated` for PrometheusAgent resources. @@ -7320,7 +7311,7 @@ spec: type: string shards: description: |- - Number of shards to distribute the scraped targets onto. + shards defines the number of shards to distribute the scraped targets onto. `spec.replicas` multiplied by `spec.shards` is the total number of Pods being created. @@ -7349,14 +7340,14 @@ spec: format: int32 type: integer storage: - description: Storage defines the storage used by Prometheus. + description: storage defines the storage used by Prometheus. properties: disableMountSubPath: - description: 'Deprecated: subPath usage will be removed in a future release.' + description: 'disableMountSubPath deprecated: subPath usage will be removed in a future release.' type: boolean emptyDir: description: |- - EmptyDirVolumeSource to be used by the StatefulSet. + emptyDir to be used by the StatefulSet. If specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir properties: @@ -7383,7 +7374,7 @@ spec: type: object ephemeral: description: |- - EphemeralVolumeSource to be used by the StatefulSet. + ephemeral to be used by the StatefulSet. This is a beta field in k8s 1.21 and GA in 1.15. For lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes @@ -7619,7 +7610,7 @@ spec: type: object volumeClaimTemplate: description: |- - Defines the PVC spec to be used by the Prometheus StatefulSets. + volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets. The easiest way to use a volume that cannot be automatically provisioned is to use a label selector alongside manually created PersistentVolumes. properties: @@ -7639,13 +7630,13 @@ spec: More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: - description: EmbeddedMetadata contains metadata relevant to an EmbeddedResource. + description: metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource. properties: annotations: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ @@ -7654,14 +7645,14 @@ spec: additionalProperties: type: string description: |- - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. @@ -7671,7 +7662,7 @@ spec: type: object spec: description: |- - Defines the desired characteristics of a volume requested by a pod author. + spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims properties: accessModes: @@ -7863,7 +7854,7 @@ spec: type: string type: object status: - description: 'Deprecated: this field is never set.' + description: 'status is deprecated: this field is never set.' properties: accessModes: description: |- @@ -7971,7 +7962,7 @@ spec: type: object targetLimit: description: |- - TargetLimit defines a limit on the number of scraped targets that will be accepted. + targetLimit defines a limit on the number of scraped targets that will be accepted. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. @@ -7980,7 +7971,7 @@ spec: type: integer terminationGracePeriodSeconds: description: |- - Optional duration in seconds the pod needs to terminate gracefully. + terminationGracePeriodSeconds defines the optional duration in seconds the pod needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down) which may lead to data corruption. @@ -7989,7 +7980,7 @@ spec: minimum: 0 type: integer tolerations: - description: Defines the Pods' tolerations if specified. + description: tolerations defines the Pods' tolerations if specified. items: description: |- The pod this Toleration is attached to tolerates any taint that matches @@ -8028,11 +8019,11 @@ spec: type: object type: array topologySpreadConstraints: - description: Defines the pod's topology spread constraints if specified. + description: topologySpreadConstraints defines the pod's topology spread constraints if specified. items: properties: additionalLabelSelectors: - description: Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint. + description: additionalLabelSelectors Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint. enum: - OnResource - OnShard @@ -8205,53 +8196,53 @@ spec: type: array tracingConfig: description: |- - TracingConfig configures tracing in Prometheus. + tracingConfig defines tracing in Prometheus. This is an *experimental feature*, it may change in any upcoming release in a breaking way. properties: clientType: - description: Client used to export the traces. Supported values are `http` or `grpc`. + description: clientType defines the client used to export the traces. Supported values are `http` or `grpc`. enum: - http - grpc type: string compression: - description: Compression key for supported compression types. The only supported value is `gzip`. + description: compression key for supported compression types. The only supported value is `gzip`. enum: - gzip type: string endpoint: - description: Endpoint to send the traces to. Should be provided in format :. + description: endpoint to send the traces to. Should be provided in format :. minLength: 1 type: string headers: additionalProperties: type: string - description: Key-value pairs to be used as headers associated with gRPC or HTTP requests. + description: headers defines the key-value pairs to be used as headers associated with gRPC or HTTP requests. type: object insecure: - description: If disabled, the client will use a secure connection. + description: insecure if disabled, the client will use a secure connection. type: boolean samplingFraction: anyOf: - type: integer - type: string - description: Sets the probability a given trace will be sampled. Must be a float from 0 through 1. + description: samplingFraction defines the probability a given trace will be sampled. Must be a float from 0 through 1. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true timeout: - description: Maximum time the exporter will wait for each batch export. + description: timeout defines the maximum time the exporter will wait for each batch export. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string tlsConfig: - description: TLS Config to use when sending traces. + description: tlsConfig to use when sending traces. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8273,7 +8264,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8296,13 +8287,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8324,7 +8315,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8347,16 +8338,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8379,7 +8370,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -8390,7 +8381,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -8400,7 +8391,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -8408,12 +8399,12 @@ spec: type: object tsdb: description: |- - Defines the runtime reloadable configuration of the timeseries database(TSDB). + tsdb defines the runtime reloadable configuration of the timeseries database(TSDB). It requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0. properties: outOfOrderTimeWindow: description: |- - Configures how old an out-of-order/out-of-bounds sample can be with + outOfOrderTimeWindow defines how old an out-of-order/out-of-bounds sample can be with respect to the TSDB max time. An out-of-order/out-of-bounds sample is ingested into the TSDB as long as @@ -8428,7 +8419,7 @@ spec: type: object version: description: |- - Version of Prometheus being deployed. The operator uses this information + version of Prometheus being deployed. The operator uses this information to generate the Prometheus StatefulSet + configuration files. If not specified, the operator assumes the latest upstream version of @@ -8437,7 +8428,7 @@ spec: type: string volumeMounts: description: |- - VolumeMounts allows the configuration of additional VolumeMounts. + volumeMounts allows the configuration of additional VolumeMounts. VolumeMounts will be appended to other VolumeMounts in the 'prometheus' container, that are generated as a result of StorageSpec objects. @@ -8504,7 +8495,7 @@ spec: type: array volumes: description: |- - Volumes allows the configuration of additional volumes on the output + volumes allows the configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects. items: @@ -10305,29 +10296,29 @@ spec: type: array walCompression: description: |- - Configures compression of the write-ahead log (WAL) using Snappy. + walCompression defines the compression of the write-ahead log (WAL) using Snappy. WAL compression is enabled by default for Prometheus >= 2.20.0 Requires Prometheus v2.11.0 and above. type: boolean web: - description: Defines the configuration of the Prometheus web server. + description: web defines the configuration of the Prometheus web server. properties: httpConfig: - description: Defines HTTP parameters for web server. + description: httpConfig defines HTTP parameters for web server. properties: headers: - description: List of headers that can be added to HTTP responses. + description: headers defines a list of headers that can be added to HTTP responses. properties: contentSecurityPolicy: description: |- - Set the Content-Security-Policy header to HTTP responses. + contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank. type: string strictTransportSecurity: description: |- - Set the Strict-Transport-Security header to HTTP responses. + strictTransportSecurity defines the Strict-Transport-Security header to HTTP responses. Unset if blank. Please make sure that you use this with care as this header might force browsers to load Prometheus and the other applications hosted on the same @@ -10336,7 +10327,7 @@ spec: type: string xContentTypeOptions: description: |- - Set the X-Content-Type-Options header to HTTP responses. + xContentTypeOptions defines the X-Content-Type-Options header to HTTP responses. Unset if blank. Accepted value is nosniff. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options enum: @@ -10345,7 +10336,7 @@ spec: type: string xFrameOptions: description: |- - Set the X-Frame-Options header to HTTP responses. + xFrameOptions defines the X-Frame-Options header to HTTP responses. Unset if blank. Accepted values are deny and sameorigin. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options enum: @@ -10355,41 +10346,41 @@ spec: type: string xXSSProtection: description: |- - Set the X-XSS-Protection header to all responses. + xXSSProtection defines the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection type: string type: object http2: description: |- - Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. + http2 enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. When TLSConfig is not configured, HTTP/2 will be disabled. Whenever the value of the field changes, a rolling update will be triggered. type: boolean type: object maxConnections: description: |- - Defines the maximum number of simultaneous connections + maxConnections defines the maximum number of simultaneous connections A zero value means that Prometheus doesn't accept any incoming connection. format: int32 minimum: 0 type: integer pageTitle: - description: The prometheus web page title. + description: pageTitle defines the prometheus web page title. type: string tlsConfig: - description: Defines the TLS parameters for HTTPS. + description: tlsConfig defines the TLS parameters for HTTPS. properties: cert: description: |- - Secret or ConfigMap containing the TLS certificate for the web server. + cert defines the Secret or ConfigMap containing the TLS certificate for the web server. Either `keySecret` or `keyFile` must be defined. It is mutually exclusive with `certFile`. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10411,7 +10402,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10435,7 +10426,7 @@ spec: type: object certFile: description: |- - Path to the TLS certificate file in the container for the web server. + certFile defines the path to the TLS certificate file in the container for the web server. Either `keySecret` or `keyFile` must be defined. @@ -10443,7 +10434,7 @@ spec: type: string cipherSuites: description: |- - List of supported cipher suites for TLS versions up to TLS 1.2. + cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2. If not defined, the Go default cipher suites are used. Available cipher suites are documented in the Go documentation: @@ -10453,13 +10444,13 @@ spec: type: array client_ca: description: |- - Secret or ConfigMap containing the CA certificate for client certificate + client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server. It is mutually exclusive with `clientCAFile`. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10481,7 +10472,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10505,21 +10496,21 @@ spec: type: object clientAuthType: description: |- - The server policy for client TLS authentication. + clientAuthType defines the server policy for client TLS authentication. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType type: string clientCAFile: description: |- - Path to the CA certificate file for client certificate authentication to + clientCAFile defines the path to the CA certificate file for client certificate authentication to the server. It is mutually exclusive with `client_ca`. type: string curvePreferences: description: |- - Elliptic curves that will be used in an ECDHE handshake, in preference + curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the Go documentation: @@ -10529,7 +10520,7 @@ spec: type: array keyFile: description: |- - Path to the TLS private key file in the container for the web server. + keyFile defines the path to the TLS private key file in the container for the web server. If defined, either `cert` or `certFile` must be defined. @@ -10537,7 +10528,7 @@ spec: type: string keySecret: description: |- - Secret containing the TLS private key for the web server. + keySecret defines the secret containing the TLS private key for the web server. Either `cert` or `certFile` must be defined. @@ -10563,14 +10554,14 @@ spec: type: object x-kubernetes-map-type: atomic maxVersion: - description: Maximum TLS version that is acceptable. + description: maxVersion defines the Maximum TLS version that is acceptable. type: string minVersion: - description: Minimum TLS version that is acceptable. + description: minVersion defines the minimum TLS version that is acceptable. type: string preferServerCipherSuites: description: |- - Controls whether the server selects the client's most preferred cipher + preferServerCipherSuites defines whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in @@ -10594,18 +10585,18 @@ spec: rule: '!(has(self.mode) && self.mode == ''DaemonSet'' && has(self.probeSelector))' status: description: |- - Most recent observed status of the Prometheus cluster. Read-only. + status defines the most recent observed status of the Prometheus cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status properties: availableReplicas: description: |- - Total number of available pods (ready for at least minReadySeconds) + availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this Prometheus deployment. format: int32 type: integer conditions: - description: The current state of the Prometheus deployment. + description: conditions defines the current state of the Prometheus deployment. items: description: |- Condition represents the state of the resources associated with the @@ -10616,11 +10607,11 @@ spec: format: date-time type: string message: - description: Human-readable message indicating details for the condition's last transition. + description: message defines human-readable message indicating details for the condition's last transition. type: string observedGeneration: description: |- - ObservedGeneration represents the .metadata.generation that the + observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if `.metadata.generation` is currently 12, but the `.status.conditions[].observedGeneration` is 9, the condition is out of date with respect to the current state of the @@ -10628,14 +10619,14 @@ spec: format: int64 type: integer reason: - description: Reason for the condition's last transition. + description: reason for the condition's last transition. type: string status: - description: Status of the condition. + description: status of the condition. minLength: 1 type: string type: - description: Type of the condition being reported. + description: type of the condition being reported. minLength: 1 type: string required: @@ -10649,42 +10640,42 @@ spec: x-kubernetes-list-type: map paused: description: |- - Represents whether any actions on the underlying managed objects are + paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed. type: boolean replicas: description: |- - Total number of non-terminated pods targeted by this Prometheus deployment + replicas defines the total number of non-terminated pods targeted by this Prometheus deployment (their labels match the selector). format: int32 type: integer selector: - description: The selector used to match the pods targeted by this Prometheus resource. + description: selector used to match the pods targeted by this Prometheus resource. type: string shardStatuses: - description: The list has one entry per shard. Each entry provides a summary of the shard status. + description: shardStatuses defines the list has one entry per shard. Each entry provides a summary of the shard status. items: properties: availableReplicas: description: |- - Total number of available pods (ready for at least minReadySeconds) + availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this shard. format: int32 type: integer replicas: - description: Total number of pods targeted by this shard. + description: replicas defines the total number of pods targeted by this shard. format: int32 type: integer shardID: - description: Identifier of the shard. + description: shardID defines the identifier of the shard. type: string unavailableReplicas: - description: Total number of unavailable pods targeted by this shard. + description: unavailableReplicas defines the Total number of unavailable pods targeted by this shard. format: int32 type: integer updatedReplicas: description: |- - Total number of non-terminated pods targeted by this shard + updatedReplicas defines the total number of non-terminated pods targeted by this shard that have the desired spec. format: int32 type: integer @@ -10700,25 +10691,19 @@ spec: - shardID x-kubernetes-list-type: map shards: - description: Shards is the most recently observed number of shards. + description: shards defines the most recently observed number of shards. format: int32 type: integer unavailableReplicas: - description: Total number of unavailable pods targeted by this Prometheus deployment. + description: unavailableReplicas defines the total number of unavailable pods targeted by this Prometheus deployment. format: int32 type: integer updatedReplicas: description: |- - Total number of non-terminated pods targeted by this Prometheus deployment + updatedReplicas defines the total number of non-terminated pods targeted by this Prometheus deployment that have the desired version spec. format: int32 type: integer - required: - - availableReplicas - - paused - - replicas - - unavailableReplicas - - updatedReplicas type: object required: - spec diff --git a/monitoring-satellite/manifests/crds/prometheusOperator-0prometheusruleCustomResourceDefinition.yaml b/monitoring-satellite/manifests/crds/prometheusOperator-0prometheusruleCustomResourceDefinition.yaml index 4ee2e188..ece8f865 100644 --- a/monitoring-satellite/manifests/crds/prometheusOperator-0prometheusruleCustomResourceDefinition.yaml +++ b/monitoring-satellite/manifests/crds/prometheusOperator-0prometheusruleCustomResourceDefinition.yaml @@ -3,7 +3,7 @@ kind: CustomResourceDefinition metadata: annotations: argocd.argoproj.io/sync-options: Replace=true - controller-gen.kubebuilder.io/version: v0.18.0 + controller-gen.kubebuilder.io/version: v0.19.0 operator.prometheus.io/version: 0.85.0 name: prometheusrules.monitoring.coreos.com spec: @@ -45,22 +45,22 @@ spec: metadata: type: object spec: - description: Specification of desired alerting rule definitions for Prometheus. + description: spec defines the specification of desired alerting rule definitions for Prometheus. properties: groups: - description: Content of Prometheus rule file + description: groups defines the content of Prometheus rule file items: description: RuleGroup is a list of sequentially evaluated recording and alerting rules. properties: interval: - description: Interval determines how often rules in the group are evaluated. + description: interval defines how often rules in the group are evaluated. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string labels: additionalProperties: type: string description: |- - Labels to add or overwrite before storing the result for its rules. + labels define the labels to add or overwrite before storing the result for its rules. The labels defined at the rule level take precedence. It requires Prometheus >= 3.0.0. @@ -68,31 +68,31 @@ spec: type: object limit: description: |- - Limit the number of alerts an alerting rule and series a recording + limit defines the number of alerts an alerting rule and series a recording rule can produce. Limit is supported starting with Prometheus >= 2.31 and Thanos Ruler >= 0.24. type: integer name: - description: Name of the rule group. + description: name defines the name of the rule group. minLength: 1 type: string partial_response_strategy: description: |- - PartialResponseStrategy is only used by ThanosRuler and will + partial_response_strategy is only used by ThanosRuler and will be ignored by Prometheus instances. More info: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response pattern: ^(?i)(abort|warn)?$ type: string query_offset: description: |- - Defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past. + query_offset defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past. It requires Prometheus >= v2.53.0. It is not supported for ThanosRuler. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string rules: - description: List of alerting and recording rules. + description: rules defines the list of alerting and recording rules. items: description: |- Rule describes an alerting or recording rule @@ -100,39 +100,39 @@ spec: properties: alert: description: |- - Name of the alert. Must be a valid label value. + alert defines the name of the alert. Must be a valid label value. Only one of `record` and `alert` must be set. type: string annotations: additionalProperties: type: string description: |- - Annotations to add to each alert. + annotations defines annotations to add to each alert. Only valid for alerting rules. type: object expr: anyOf: - type: integer - type: string - description: PromQL expression to evaluate. + description: expr defines the PromQL expression to evaluate. x-kubernetes-int-or-string: true for: - description: Alerts are considered firing once they have been returned for this long. + description: for defines how alerts are considered firing once they have been returned for this long. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string keep_firing_for: - description: KeepFiringFor defines how long an alert will continue firing after the condition that triggered it has cleared. + description: keep_firing_for defines how long an alert will continue firing after the condition that triggered it has cleared. minLength: 1 pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string labels: additionalProperties: type: string - description: Labels to add or overwrite. + description: labels defines labels to add or overwrite. type: object record: description: |- - Name of the time series to output to. Must be a valid metric name. + record defines the name of the time series to output to. Must be a valid metric name. Only one of `record` and `alert` must be set. type: string required: diff --git a/monitoring-satellite/manifests/crds/prometheusOperator-0scrapeconfigCustomResourceDefinition.yaml b/monitoring-satellite/manifests/crds/prometheusOperator-0scrapeconfigCustomResourceDefinition.yaml index 1cf478d5..6d721aa3 100644 --- a/monitoring-satellite/manifests/crds/prometheusOperator-0scrapeconfigCustomResourceDefinition.yaml +++ b/monitoring-satellite/manifests/crds/prometheusOperator-0scrapeconfigCustomResourceDefinition.yaml @@ -2,7 +2,7 @@ apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: - controller-gen.kubebuilder.io/version: v0.18.0 + controller-gen.kubebuilder.io/version: v0.19.0 operator.prometheus.io/version: 0.85.0 name: scrapeconfigs.monitoring.coreos.com spec: @@ -43,13 +43,13 @@ spec: metadata: type: object spec: - description: ScrapeConfigSpec is a specification of the desired configuration for a scrape configuration. + description: spec defines the specification of ScrapeConfigSpec. properties: authorization: - description: Authorization header to use on every scrape request. + description: authorization defines the header to use on every scrape request. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -72,7 +72,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -80,7 +80,7 @@ spec: type: string type: object azureSDConfigs: - description: AzureSDConfigs defines a list of Azure service discovery configurations. + description: azureSDConfigs defines a list of Azure service discovery configurations. items: description: |- AzureSDConfig allow retrieving scrape targets from Azure VMs. @@ -88,7 +88,7 @@ spec: properties: authenticationMethod: description: |- - # The authentication method, either `OAuth` or `ManagedIdentity` or `SDK`. + authenticationMethod defines the authentication method, either `OAuth` or `ManagedIdentity` or `SDK`. See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview SDK authentication method uses environment variables by default. See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication @@ -99,11 +99,11 @@ spec: type: string authorization: description: |- - Authorization header configuration to authenticate against the target HTTP endpoint. + authorization defines the authorization header configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `oAuth2`, or `basicAuth`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -126,7 +126,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -135,13 +135,13 @@ spec: type: object basicAuth: description: |- - BasicAuth information to authenticate against the target HTTP endpoint. + basicAuth defines the information to authenticate against the target HTTP endpoint. More info: https://prometheus.io/docs/operating/configuration/#endpoints Cannot be set at the same time as `authorization`, or `oAuth2`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -165,7 +165,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -189,11 +189,11 @@ spec: x-kubernetes-map-type: atomic type: object clientID: - description: Optional client ID. Only required with the OAuth authentication method. + description: clientID defines client ID. Only required with the OAuth authentication method. minLength: 1 type: string clientSecret: - description: Optional client secret. Only required with the OAuth authentication method. + description: clientSecret defines client secret. Only required with the OAuth authentication method. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -215,35 +215,33 @@ spec: type: object x-kubernetes-map-type: atomic enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean environment: - description: The Azure environment. + description: environment defines the Azure environment. minLength: 1 type: string followRedirects: - description: Configure whether HTTP requests follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: |- - Optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. - Cannot be set at the same time as `authorization`, or `basicAuth`. + description: oauth2 defines the configuration to use on every scrape request. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -265,7 +263,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -289,7 +287,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -315,12 +313,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -352,7 +350,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -360,29 +358,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -404,7 +402,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -427,10 +425,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -452,7 +450,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -475,10 +473,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -501,7 +499,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -512,7 +510,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -522,11 +520,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -536,7 +534,7 @@ spec: type: object port: description: |- - The port to scrape metrics from. If using the public IP address, this must + port defines the port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule. format: int32 maximum: 65535 @@ -568,7 +566,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -576,40 +574,42 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: - description: RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string resourceGroup: description: |- - Optional resource group name. Limits discovery to this resource group. + resourceGroup defines resource group name. Limits discovery to this resource group. Requires Prometheus v2.35.0 and above minLength: 1 type: string subscriptionID: - description: The subscription ID. Always required. + description: subscriptionID defines subscription ID. Always required. minLength: 1 type: string tenantID: - description: Optional tenant ID. Only required with the OAuth authentication method. + description: tenantID defines tenant ID. Only required with the OAuth authentication method. minLength: 1 type: string tlsConfig: - description: TLS configuration applying to the target HTTP endpoint. + description: tlsConfig defies the TLS configuration applying to the target HTTP endpoint. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -631,7 +631,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -654,10 +654,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -679,7 +679,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -702,10 +702,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -728,7 +728,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -739,7 +739,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -749,7 +749,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -757,11 +757,11 @@ spec: type: object type: array basicAuth: - description: BasicAuth information to use on every scrape request. + description: basicAuth defines information to use on every scrape request. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -785,7 +785,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -809,7 +809,7 @@ spec: x-kubernetes-map-type: atomic type: object consulSDConfigs: - description: ConsulSDConfigs defines a list of Consul service discovery configurations. + description: consulSDConfigs defines a list of Consul service discovery configurations. items: description: |- ConsulSDConfig defines a Consul service discovery configuration @@ -817,16 +817,16 @@ spec: properties: allowStale: description: |- - Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul. + allowStale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul. If unset, Prometheus uses its default value. type: boolean authorization: description: |- - Optional Authorization header configuration to authenticate against the Consul Server. + authorization defines the header configuration to authenticate against the Consul Server. Cannot be set at the same time as `basicAuth`, or `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -849,7 +849,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -858,13 +858,13 @@ spec: type: object basicAuth: description: |- - Optional BasicAuth information to authenticate against the Consul Server. + basicAuth defines the information to authenticate against the Consul Server. More info: https://prometheus.io/docs/operating/configuration/#endpoints Cannot be set at the same time as `authorization`, or `oauth2`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -888,7 +888,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -912,36 +912,32 @@ spec: x-kubernetes-map-type: atomic type: object datacenter: - description: Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter. + description: datacenter defines the consul Datacenter name, if not provided it will use the local Consul Agent Datacenter. minLength: 1 type: string enableHTTP2: - description: |- - Whether to enable HTTP2. - If unset, Prometheus uses its default value. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean filter: description: |- - Filter expression used to filter the catalog results. + filter defines the filter expression used to filter the catalog results. See https://www.consul.io/api-docs/catalog#list-services It requires Prometheus >= 3.0.0. minLength: 1 type: string followRedirects: - description: |- - Configure whether HTTP requests follow HTTP 3xx redirects. - If unset, Prometheus uses its default value. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean namespace: description: |- - Namespaces are only supported in Consul Enterprise. + namespace are only supported in Consul Enterprise. It requires Prometheus >= 2.28.0. minLength: 1 type: string noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -951,22 +947,22 @@ spec: additionalProperties: type: string description: |- - Node metadata key/value pairs to filter nodes for a given service. + nodeMeta defines the node metadata key/value pairs to filter nodes for a given service. Starting with Consul 1.14, it is recommended to use `filter` with the `NodeMeta` selector instead. type: object x-kubernetes-map-type: atomic oauth2: description: |- - Optional OAuth2.0 configuration. - Cannot be set at the same time as `basicAuth`, or `authorization`. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. + Cannot be set at the same time as `authorization`, or `basicAuth`. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -988,7 +984,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1012,7 +1008,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -1038,12 +1034,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -1075,7 +1071,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -1083,29 +1079,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1127,7 +1123,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1150,10 +1146,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1175,7 +1171,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1198,10 +1194,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1224,7 +1220,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -1235,7 +1231,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -1245,11 +1241,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -1258,12 +1254,12 @@ spec: - tokenUrl type: object partition: - description: Admin Partitions are only supported in Consul Enterprise. + description: partition defines the admin Partitions are only supported in Consul Enterprise. minLength: 1 type: string pathPrefix: description: |- - Prefix for URIs for when consul is behind an API gateway (reverse proxy). + pathPrefix defines the prefix for URIs for when consul is behind an API gateway (reverse proxy). It requires Prometheus >= 2.45.0. minLength: 1 @@ -1294,7 +1290,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -1302,59 +1298,58 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: description: |- - The time after which the provided names are refreshed. - On large setup it might be a good idea to increase this value because the catalog will change all the time. - If unset, Prometheus uses its default value. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string scheme: - description: HTTP Scheme default "http" + description: scheme defines the HTTP Scheme default "http" enum: - HTTP - HTTPS type: string server: - description: Consul server address. A valid string consisting of a hostname or IP followed by an optional port number. + description: server defines the consul server address. A valid string consisting of a hostname or IP followed by an optional port number. minLength: 1 type: string services: - description: A list of services for which targets are retrieved. If omitted, all services are scraped. + description: services defines a list of services for which targets are retrieved. If omitted, all services are scraped. items: type: string type: array x-kubernetes-list-type: set tagSeparator: description: |- - The string by which Consul tags are joined into the tag label. + tagSeparator defines the string by which Consul tags are joined into the tag label. If unset, Prometheus uses its default value. minLength: 1 type: string tags: description: |- - An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list. + tags defines an optional list of tags used to filter nodes for a given service. Services must contain all tags in the list. Starting with Consul 1.14, it is recommended to use `filter` with the `ServiceTags` selector instead. items: type: string type: array x-kubernetes-list-type: set tlsConfig: - description: TLS configuration to connect to the Consul API. + description: tlsConfig defines the TLS configuration to connect to the Consul API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1376,7 +1371,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1399,10 +1394,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1424,7 +1419,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1447,10 +1442,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1473,7 +1468,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -1484,7 +1479,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -1494,11 +1489,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenRef: - description: Consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent. + description: tokenRef defines the consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1525,11 +1520,11 @@ spec: type: array convertClassicHistogramsToNHCB: description: |- - Whether to convert all scraped classic histograms into a native histogram with custom buckets. + convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0. type: boolean digitalOceanSDConfigs: - description: DigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations. + description: digitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations. items: description: |- DigitalOceanSDConfig allow retrieving scrape targets from DigitalOcean's Droplets API. @@ -1538,11 +1533,11 @@ spec: properties: authorization: description: |- - Authorization header configuration to authenticate against the DigitalOcean API. + authorization defines the header configuration to authenticate against the DigitalOcean API. Cannot be set at the same time as `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1565,7 +1560,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -1573,31 +1568,29 @@ spec: type: string type: object enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean followRedirects: - description: Configure whether HTTP requests follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: |- - Optional OAuth 2.0 configuration. - Cannot be set at the same time as `authorization`. + description: oauth2 defines the configuration to use on every scrape request. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1619,7 +1612,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1643,7 +1636,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -1669,12 +1662,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -1706,7 +1699,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -1714,29 +1707,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1758,7 +1751,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1781,10 +1774,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1806,7 +1799,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1829,10 +1822,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1855,7 +1848,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -1866,7 +1859,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -1876,11 +1869,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -1889,7 +1882,7 @@ spec: - tokenUrl type: object port: - description: The port to scrape metrics from. + description: port defines the port to scrape metrics from. If using the public IP address, this must format: int32 maximum: 65535 minimum: 0 @@ -1920,7 +1913,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -1928,26 +1921,28 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: - description: Refresh interval to re-read the instance list. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string tlsConfig: - description: TLS configuration applying to the target HTTP endpoint. + description: tlsConfig defines the TLS configuration to connect to the Consul API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -1969,7 +1964,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -1992,10 +1987,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2017,7 +2012,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2040,10 +2035,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2066,7 +2061,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -2077,7 +2072,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -2087,13 +2082,13 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object type: array dnsSDConfigs: - description: DNSSDConfigs defines a list of DNS service discovery configurations. + description: dnsSDConfigs defines a list of DNS service discovery configurations. items: description: |- DNSSDConfig allows specifying a set of DNS domain names which are periodically queried to discover a list of targets. @@ -2101,7 +2096,7 @@ spec: See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dns_sd_config properties: names: - description: A list of DNS domain names to be queried. + description: names defines a list of DNS domain names to be queried. items: minLength: 1 type: string @@ -2109,7 +2104,7 @@ spec: type: array port: description: |- - The port number used if the query type is not SRV + port defines the port to scrape metrics from. If using the public IP address, this must Ignored for SRV records format: int32 maximum: 65535 @@ -2117,13 +2112,13 @@ spec: type: integer refreshInterval: description: |- - RefreshInterval configures the time after which the provided names are refreshed. + refreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string type: description: |- - The type of DNS query to perform. One of SRV, A, AAAA, MX or NS. + type defines the type of DNS query to perform. One of SRV, A, AAAA, MX or NS. If not set, Prometheus uses its default value. When set to NS, it requires Prometheus >= v2.49.0. @@ -2140,7 +2135,7 @@ spec: type: object type: array dockerSDConfigs: - description: DockerSDConfigs defines a list of Docker service discovery configurations. + description: dockerSDConfigs defines a list of Docker service discovery configurations. items: description: |- Docker SD configurations allow retrieving scrape targets from Docker Engine hosts. @@ -2150,11 +2145,11 @@ spec: properties: authorization: description: |- - Authorization header configuration to authenticate against the Docker API. + authorization defines the header configuration to authenticate against the DigitalOcean API. Cannot be set at the same time as `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2177,7 +2172,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -2185,11 +2180,11 @@ spec: type: string type: object basicAuth: - description: BasicAuth information to use on every scrape request. + description: basicAuth defines information to use on every scrape request. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -2213,7 +2208,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -2237,18 +2232,18 @@ spec: x-kubernetes-map-type: atomic type: object enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean filters: - description: Optional filters to limit the discovery process to a subset of the available resources. + description: filters defines filters to limit the discovery process to a subset of the available resources. items: description: Filter name and value pairs to limit the discovery process to a subset of available resources. properties: name: - description: Name of the Filter. + description: name of the Filter. type: string values: - description: Value to filter on. + description: values defines values to filter on. items: minLength: 1 type: string @@ -2264,42 +2259,40 @@ spec: - name x-kubernetes-list-type: map followRedirects: - description: Configure whether HTTP requests follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean host: - description: Address of the docker daemon + description: host defines the address of the docker daemon minLength: 1 type: string hostNetworkingHost: - description: The host to use if the container is in host networking mode. + description: hostNetworkingHost defines the host to use if the container is in host networking mode. minLength: 1 type: string matchFirstNetwork: description: |- - Configure whether to match the first network if the container has multiple networks defined. + matchFirstNetwork defines whether to match the first network if the container has multiple networks defined. If unset, Prometheus uses true by default. It requires Prometheus >= v2.54.1. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: |- - Optional OAuth 2.0 configuration. - Cannot be set at the same time as `authorization`. + description: oauth2 defines the configuration to use on every scrape request. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2321,7 +2314,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2345,7 +2338,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -2371,12 +2364,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -2408,7 +2401,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -2416,29 +2409,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2460,7 +2453,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2483,10 +2476,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2508,7 +2501,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2531,10 +2524,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2557,7 +2550,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -2568,7 +2561,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -2578,11 +2571,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -2591,7 +2584,7 @@ spec: - tokenUrl type: object port: - description: The port to scrape metrics from. + description: port defines the port to scrape metrics from. If using the public IP address, this must format: int32 maximum: 65535 minimum: 0 @@ -2622,7 +2615,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -2630,26 +2623,28 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: - description: Time after which the container is refreshed. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string tlsConfig: - description: TLS configuration applying to the target HTTP endpoint. + description: tlsConfig defines the TLS configuration to connect to the Consul API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2671,7 +2666,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2694,10 +2689,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2719,7 +2714,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2742,10 +2737,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2768,7 +2763,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -2779,7 +2774,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -2789,7 +2784,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -2797,17 +2792,19 @@ spec: type: object type: array dockerSwarmSDConfigs: - description: DockerswarmSDConfigs defines a list of Dockerswarm service discovery configurations. + description: dockerSwarmSDConfigs defines a list of Dockerswarm service discovery configurations. items: description: |- DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dockerswarm_sd_config properties: authorization: - description: Authorization header configuration to authenticate against the target HTTP endpoint. + description: |- + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2830,7 +2827,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -2838,11 +2835,11 @@ spec: type: string type: object basicAuth: - description: Optional HTTP basic authentication information. + description: basicAuth defines information to use on every scrape request. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -2866,7 +2863,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -2890,11 +2887,11 @@ spec: x-kubernetes-map-type: atomic type: object enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean filters: description: |- - Optional filters to limit the discovery process to a subset of available + filters defines the filters to limit the discovery process to a subset of available resources. The available filters are listed in the upstream documentation: Services: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList @@ -2904,10 +2901,10 @@ spec: description: Filter name and value pairs to limit the discovery process to a subset of available resources. properties: name: - description: Name of the Filter. + description: name of the Filter. type: string values: - description: Value to filter on. + description: values defines values to filter on. items: minLength: 1 type: string @@ -2923,15 +2920,15 @@ spec: - name x-kubernetes-list-type: map followRedirects: - description: Configure whether HTTP requests follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean host: - description: Address of the Docker daemon + description: host defines the address of the Docker daemon pattern: ^[a-zA-Z][a-zA-Z0-9+.-]*://.+$ type: string noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -2939,16 +2936,16 @@ spec: type: string oauth2: description: |- - Optional OAuth 2.0 configuration. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2970,7 +2967,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2994,7 +2991,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -3020,12 +3017,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -3057,7 +3054,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -3065,29 +3062,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3109,7 +3106,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3132,10 +3129,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3157,7 +3154,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3180,10 +3177,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3206,7 +3203,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -3217,7 +3214,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -3227,11 +3224,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -3241,7 +3238,7 @@ spec: type: object port: description: |- - The port to scrape metrics from, when `role` is nodes, and for discovered + port defines the port to scrape metrics from. If using the public IP address, this must tasks and services that don't have published ports. format: int32 maximum: 65535 @@ -3273,7 +3270,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -3281,33 +3278,35 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: - description: The time after which the service discovery data is refreshed. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string role: - description: Role of the targets to retrieve. Must be `Services`, `Tasks`, or `Nodes`. + description: role of the targets to retrieve. Must be `Services`, `Tasks`, or `Nodes`. enum: - Services - Tasks - Nodes type: string tlsConfig: - description: TLS configuration to use on every scrape request + description: tlsConfig defines the TLS configuration to connect to the Consul API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3329,7 +3328,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3352,10 +3351,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3377,7 +3376,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3400,10 +3399,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3426,7 +3425,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -3437,7 +3436,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -3447,7 +3446,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -3456,7 +3455,7 @@ spec: type: object type: array ec2SDConfigs: - description: EC2SDConfigs defines a list of EC2 service discovery configurations. + description: ec2SDConfigs defines a list of EC2 service discovery configurations. items: description: |- EC2SDConfig allow retrieving scrape targets from AWS EC2 instances. @@ -3468,7 +3467,7 @@ spec: BasicAuth, Authorization and OAuth2 fields are not present on purpose. properties: accessKey: - description: AccessKey is the AWS API key. + description: accessKey defines the AWS API key. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3491,12 +3490,12 @@ spec: x-kubernetes-map-type: atomic enableHTTP2: description: |- - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. It requires Prometheus >= v2.41.0 type: boolean filters: description: |- - Filters can be used optionally to filter the instance list by other criteria. + filters can be used optionally to filter the instance list by other criteria. Available filter criteria can be found here: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html Filter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html @@ -3505,10 +3504,10 @@ spec: description: Filter name and value pairs to limit the discovery process to a subset of available resources. properties: name: - description: Name of the Filter. + description: name of the Filter. type: string values: - description: Value to filter on. + description: values defines values to filter on. items: minLength: 1 type: string @@ -3525,12 +3524,12 @@ spec: x-kubernetes-list-type: map followRedirects: description: |- - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. It requires Prometheus >= v2.41.0 type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -3538,7 +3537,7 @@ spec: type: string port: description: |- - The port to scrape metrics from. If using the public IP address, this must + port defines the port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule. format: int32 maximum: 65535 @@ -3570,7 +3569,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -3578,28 +3577,30 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: - description: RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string region: - description: The AWS region. + description: region defines the AWS region. minLength: 1 type: string roleARN: - description: AWS Role ARN, an alternative to using AWS API keys. + description: roleARN defines an alternative to using AWS API keys. minLength: 1 type: string secretKey: - description: SecretKey is the AWS API secret. + description: secretKey defines the AWS API secret. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3622,14 +3623,14 @@ spec: x-kubernetes-map-type: atomic tlsConfig: description: |- - TLS configuration to connect to the AWS EC2 API. + tlsConfig defines the TLS configuration to connect to the Consul API. It requires Prometheus >= v2.41.0 properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3651,7 +3652,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3674,10 +3675,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3699,7 +3700,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3722,10 +3723,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3748,7 +3749,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -3759,7 +3760,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -3769,24 +3770,24 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object type: array enableCompression: description: |- - When false, Prometheus will request uncompressed response from the scraped target. + enableCompression when false, Prometheus will request uncompressed response from the scraped target. It requires Prometheus >= v2.49.0. If unset, Prometheus uses true by default. type: boolean enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean eurekaSDConfigs: - description: EurekaSDConfigs defines a list of Eureka service discovery configurations. + description: eurekaSDConfigs defines a list of Eureka service discovery configurations. items: description: |- Eureka SD configurations allow retrieving scrape targets using the Eureka REST API. @@ -3794,10 +3795,12 @@ spec: See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#eureka_sd_config properties: authorization: - description: Authorization header to use on every scrape request. + description: |- + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3820,7 +3823,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -3828,11 +3831,11 @@ spec: type: string type: object basicAuth: - description: BasicAuth information to use on every scrape request. + description: basicAuth defines the BasicAuth information to use on every scrape request. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -3856,7 +3859,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -3880,31 +3883,29 @@ spec: x-kubernetes-map-type: atomic type: object enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean followRedirects: - description: Configure whether HTTP requests follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: |- - Optional OAuth 2.0 configuration. - Cannot be set at the same time as `authorization` or `basic_auth`. + description: oauth2 defines the configuration to use on every scrape request. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -3926,7 +3927,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -3950,7 +3951,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -3976,12 +3977,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -4013,7 +4014,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -4021,29 +4022,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4065,7 +4066,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4088,10 +4089,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4113,7 +4114,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4136,10 +4137,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4162,7 +4163,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -4173,7 +4174,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -4183,11 +4184,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -4221,7 +4222,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -4229,31 +4230,33 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: - description: Refresh interval to re-read the instance list. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string server: - description: The URL to connect to the Eureka server. + description: server defines the URL to connect to the Eureka server. minLength: 1 pattern: ^http(s)?://.+$ type: string tlsConfig: - description: TLS configuration applying to the target HTTP endpoint. + description: tlsConfig defines the TLS configuration to connect to the Consul API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4275,7 +4278,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4298,10 +4301,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4323,7 +4326,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4346,10 +4349,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4372,7 +4375,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -4383,7 +4386,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -4393,7 +4396,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -4402,7 +4405,7 @@ spec: type: array fallbackScrapeProtocol: description: |- - The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. + fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It requires Prometheus >= v3.0.0. enum: @@ -4413,7 +4416,7 @@ spec: - PrometheusText1.0.0 type: string fileSDConfigs: - description: FileSDConfigs defines a list of file service discovery configurations. + description: fileSDConfigs defines a list of file service discovery configurations. items: description: |- FileSDConfig defines a Prometheus file service discovery configuration @@ -4421,7 +4424,7 @@ spec: properties: files: description: |- - List of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the + files defines the list of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the prometheus-operator project makes no guarantees about the working directory where the configuration file is stored. Files must be mounted using Prometheus.ConfigMaps or Prometheus.Secrets. @@ -4433,7 +4436,9 @@ spec: type: array x-kubernetes-list-type: set refreshInterval: - description: RefreshInterval configures the refresh interval at which Prometheus will reload the content of the files. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string required: @@ -4441,7 +4446,7 @@ spec: type: object type: array gceSDConfigs: - description: GCESDConfigs defines a list of GCE service discovery configurations. + description: gceSDConfigs defines a list of GCE service discovery configurations. items: description: |- GCESDConfig configures scrape targets from GCP GCE instances. @@ -4460,33 +4465,35 @@ spec: properties: filter: description: |- - Filter can be used optionally to filter the instance list by other criteria + filter defines the filter that can be used optionally to filter the instance list by other criteria Syntax of this filter is described in the filter query parameter section: https://cloud.google.com/compute/docs/reference/latest/instances/list minLength: 1 type: string port: description: |- - The port to scrape metrics from. If using the public IP address, this must + port defines the port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule. format: int32 maximum: 65535 minimum: 0 type: integer project: - description: The Google Cloud Project ID + description: project defines the Google Cloud Project ID minLength: 1 type: string refreshInterval: - description: RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string tagSeparator: - description: The tag separator is used to separate the tags on concatenation + description: tagSeparator defines the tag separator is used to separate the tags on concatenation minLength: 1 type: string zone: - description: The zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs. + description: zone defines the zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs. minLength: 1 type: string required: @@ -4495,7 +4502,7 @@ spec: type: object type: array hetznerSDConfigs: - description: HetznerSDConfigs defines a list of Hetzner service discovery configurations. + description: hetznerSDConfigs defines a list of Hetzner service discovery configurations. items: description: |- HetznerSDConfig allow retrieving scrape targets from Hetzner Cloud API and Robot API. @@ -4504,11 +4511,11 @@ spec: properties: authorization: description: |- - Authorization header configuration, required when role is hcloud. - Role robot does not support bearer token authentication. + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4531,7 +4538,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -4539,13 +4546,11 @@ spec: type: string type: object basicAuth: - description: |- - BasicAuth information to use on every scrape request, required when role is robot. - Role hcloud does not support basic auth. + description: basicAuth defines information to use on every scrape request. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -4569,7 +4574,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -4593,37 +4598,35 @@ spec: x-kubernetes-map-type: atomic type: object enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean followRedirects: - description: Configure whether HTTP requests follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean labelSelector: description: |- - Label selector used to filter the servers when fetching them from the API. + labelSelector defines the label selector used to filter the servers when fetching them from the API. It requires Prometheus >= v3.5.0. minLength: 1 type: string noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: |- - Optional OAuth 2.0 configuration. - Cannot be used at the same time as `basic_auth` or `authorization`. + description: oauth2 defines the configuration to use on every scrape request. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4645,7 +4648,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4669,7 +4672,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -4695,12 +4698,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -4732,7 +4735,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -4740,29 +4743,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4784,7 +4787,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4807,10 +4810,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4832,7 +4835,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4855,10 +4858,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4881,7 +4884,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -4892,7 +4895,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -4902,11 +4905,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -4915,7 +4918,7 @@ spec: - tokenUrl type: object port: - description: The port to scrape metrics from. + description: port defines the port to scrape metrics from. If using the public IP address, this must format: int32 maximum: 65535 minimum: 0 @@ -4946,7 +4949,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -4954,20 +4957,22 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: - description: The time after which the servers are refreshed. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string role: - description: The Hetzner role of entities that should be discovered. + description: role defines the Hetzner role of entities that should be discovered. enum: - hcloud - Hcloud @@ -4975,13 +4980,13 @@ spec: - Robot type: string tlsConfig: - description: TLS configuration to use on every scrape request. + description: tlsConfig defines the TLS configuration to connect to the Consul API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5003,7 +5008,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5026,10 +5031,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5051,7 +5056,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5074,10 +5079,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5100,7 +5105,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -5111,7 +5116,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -5121,7 +5126,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -5129,13 +5134,17 @@ spec: type: object type: array honorLabels: - description: HonorLabels chooses the metric's labels on collisions with target labels. + description: |- + honorLabels defines when true the metric's labels when they collide + with the target's labels. type: boolean honorTimestamps: - description: HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data. + description: |- + honorTimestamps defines whether Prometheus preserves the timestamps + when exposed by the target. type: boolean httpSDConfigs: - description: HTTPSDConfigs defines a list of HTTP service discovery configurations. + description: httpSDConfigs defines a list of HTTP service discovery configurations. items: description: |- HTTPSDConfig defines a prometheus HTTP service discovery configuration @@ -5143,11 +5152,11 @@ spec: properties: authorization: description: |- - Authorization header configuration to authenticate against the target HTTP endpoint. + authorization defines the authorization header configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `oAuth2`, or `basicAuth`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5170,7 +5179,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -5179,13 +5188,13 @@ spec: type: object basicAuth: description: |- - BasicAuth information to authenticate against the target HTTP endpoint. + basicAuth defines information to use on every scrape request. More info: https://prometheus.io/docs/operating/configuration/#endpoints Cannot be set at the same time as `authorization`, or `oAuth2`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -5209,7 +5218,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -5233,14 +5242,14 @@ spec: x-kubernetes-map-type: atomic type: object enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean followRedirects: - description: Configure whether HTTP requests follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -5248,16 +5257,16 @@ spec: type: string oauth2: description: |- - Optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5279,7 +5288,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5303,7 +5312,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -5329,12 +5338,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -5366,7 +5375,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -5374,29 +5383,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5418,7 +5427,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5441,10 +5450,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5466,7 +5475,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5489,10 +5498,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5515,7 +5524,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -5526,7 +5535,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -5536,11 +5545,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -5574,7 +5583,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -5582,28 +5591,28 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: description: |- - RefreshInterval configures the refresh interval at which Prometheus will re-query the - endpoint to update the target list. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string tlsConfig: - description: TLS configuration applying to the target HTTP endpoint. + description: tlsConfig defines the TLS configuration applying to the target HTTP endpoint. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5625,7 +5634,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5648,10 +5657,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5673,7 +5682,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5696,10 +5705,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5722,7 +5731,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -5733,7 +5742,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -5743,11 +5752,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object url: - description: URL from which the targets are fetched. + description: url defines the URL from which the targets are fetched. minLength: 1 pattern: ^http(s)?://.+$ type: string @@ -5756,17 +5765,19 @@ spec: type: object type: array ionosSDConfigs: - description: IonosSDConfigs defines a list of IONOS service discovery configurations. + description: ionosSDConfigs defines a list of IONOS service discovery configurations. items: description: |- IonosSDConfig configurations allow retrieving scrape targets from IONOS resources. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#ionos_sd_config properties: authorization: - description: Authorization` header configuration, required when using IONOS. + description: |- + authorization defines the header configuration to authenticate against the IONOS. + Cannot be set at the same time as `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5789,7 +5800,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -5797,33 +5808,33 @@ spec: type: string type: object datacenterID: - description: The unique ID of the IONOS data center. + description: datacenterID defines the unique ID of the IONOS data center. minLength: 1 type: string enableHTTP2: - description: Configure whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean followRedirects: - description: Configure whether the HTTP requests should follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: Configure whether to enable OAuth2. + description: oauth2 defines the configuration to use on every scrape request. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5845,7 +5856,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5869,7 +5880,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -5895,12 +5906,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -5932,7 +5943,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -5940,29 +5951,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5984,7 +5995,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6007,10 +6018,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6032,7 +6043,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6055,10 +6066,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6081,7 +6092,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -6092,7 +6103,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -6102,11 +6113,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -6115,7 +6126,7 @@ spec: - tokenUrl type: object port: - description: Port to scrape the metrics from. + description: port defines the port to scrape metrics from. If using the public IP address, this must format: int32 maximum: 65535 minimum: 0 @@ -6146,7 +6157,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -6154,26 +6165,28 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: - description: Refresh interval to re-read the list of resources. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string tlsConfig: - description: TLS configuration to use when connecting to the IONOS API. + description: tlsConfig defines the TLS configuration to connect to the Consul API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6195,7 +6208,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6218,10 +6231,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6243,7 +6256,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6266,10 +6279,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6292,7 +6305,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -6303,7 +6316,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -6313,7 +6326,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -6323,7 +6336,7 @@ spec: type: array jobName: description: |- - The value of the `job` label assigned to the scraped metrics by default. + jobName defines the value of the `job` label assigned to the scraped metrics by default. The `job_name` field in the rendered scrape configuration is always controlled by the operator to prevent duplicate job names, which Prometheus does not allow. Instead the @@ -6332,14 +6345,14 @@ spec: type: string keepDroppedTargets: description: |- - Per-scrape limit on the number of targets dropped by relabeling + keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0. format: int64 type: integer kubernetesSDConfigs: - description: KubernetesSDConfigs defines a list of Kubernetes service discovery configurations. + description: kubernetesSDConfigs defines a list of Kubernetes service discovery configurations. items: description: |- KubernetesSDConfig allows retrieving scrape targets from Kubernetes' REST API. @@ -6347,7 +6360,7 @@ spec: properties: apiServer: description: |- - The API server address consisting of a hostname or IP address followed + apiServer defines the API server address consisting of a hostname or IP address followed by an optional port number. If left empty, Prometheus is assumed to run inside of the cluster. It will discover API servers automatically and use the pod's @@ -6356,13 +6369,13 @@ spec: type: string attachMetadata: description: |- - Optional metadata to attach to discovered targets. + attachMetadata defines the metadata to attach to discovered targets. It requires Prometheus >= v2.35.0 when using the `Pod` role and Prometheus >= v2.37.0 for `Endpoints` and `Endpointslice` roles. properties: node: description: |- - Attaches node metadata to discovered targets. + node attaches node metadata to discovered targets. When set to true, Prometheus must have the `get` permission on the `Nodes` objects. Only valid for Pod, Endpoint and Endpointslice roles. @@ -6370,11 +6383,11 @@ spec: type: object authorization: description: |- - Authorization header to use on every scrape request. + authorization defines the authorization header to use on every scrape request. Cannot be set at the same time as `basicAuth`, or `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6397,7 +6410,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -6406,12 +6419,12 @@ spec: type: object basicAuth: description: |- - BasicAuth information to use on every scrape request. + basicAuth defines information to use on every scrape request. Cannot be set at the same time as `authorization`, or `oauth2`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -6435,7 +6448,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -6459,29 +6472,29 @@ spec: x-kubernetes-map-type: atomic type: object enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean followRedirects: - description: Configure whether HTTP requests follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean namespaces: - description: Optional namespace discovery. If omitted, Prometheus discovers targets across all namespaces. + description: namespaces defines the namespace discovery. If omitted, Prometheus discovers targets across all namespaces. properties: names: description: |- - List of namespaces where to watch for resources. + names defines a list of namespaces where to watch for resources. If empty and `ownNamespace` isn't true, Prometheus watches for resources in all namespaces. items: type: string type: array x-kubernetes-list-type: set ownNamespace: - description: Includes the namespace in which the Prometheus pod runs to the list of watched namespaces. + description: ownNamespace includes the namespace in which the Prometheus pod runs to the list of watched namespaces. type: boolean type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -6489,16 +6502,16 @@ spec: type: string oauth2: description: |- - Optional OAuth 2.0 configuration. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6520,7 +6533,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6544,7 +6557,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -6570,12 +6583,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -6607,7 +6620,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -6615,29 +6628,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6659,7 +6672,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6682,10 +6695,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6707,7 +6720,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6730,10 +6743,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6756,7 +6769,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -6767,7 +6780,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -6777,11 +6790,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -6815,7 +6828,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -6823,17 +6836,17 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string role: description: |- - Role of the Kubernetes entities that should be discovered. + role defines the Kubernetes role of the entities that should be discovered. Role `Endpointslice` requires Prometheus >= v2.21.0 enum: - Pod @@ -6845,26 +6858,26 @@ spec: type: string selectors: description: |- - Selector to select objects. + selectors defines the selector to select objects. It requires Prometheus >= v2.17.0 items: description: K8SSelectorConfig is Kubernetes Selector Config properties: field: description: |- - An optional field selector to limit the service discovery to resources which have fields with specific values. + field defines an optional field selector to limit the service discovery to resources which have fields with specific values. e.g: `metadata.name=foobar` minLength: 1 type: string label: description: |- - An optional label selector to limit the service discovery to resources with specific labels and label values. + label defines an optional label selector to limit the service discovery to resources with specific labels and label values. e.g: `node.kubernetes.io/instance-type=master` minLength: 1 type: string role: description: |- - Role specifies the type of Kubernetes resource to limit the service discovery to. + role defines the type of Kubernetes resource to limit the service discovery to. Accepted values are: Node, Pod, Endpoints, EndpointSlice, Service, Ingress. enum: - Pod @@ -6882,13 +6895,13 @@ spec: - role x-kubernetes-list-type: map tlsConfig: - description: TLS configuration to connect to the Kubernetes API. + description: tlsConfig defines the TLS configuration to connect to the Kubernetes API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6910,7 +6923,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6933,10 +6946,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -6958,7 +6971,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -6981,10 +6994,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7007,7 +7020,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -7018,7 +7031,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -7028,7 +7041,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -7036,17 +7049,19 @@ spec: type: object type: array kumaSDConfigs: - description: KumaSDConfigs defines a list of Kuma service discovery configurations. + description: kumaSDConfigs defines a list of Kuma service discovery configurations. items: description: |- KumaSDConfig allow retrieving scrape targets from Kuma's control plane. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#kuma_sd_config properties: authorization: - description: Authorization header to use on every scrape request. + description: |- + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7069,7 +7084,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -7077,11 +7092,11 @@ spec: type: string type: object basicAuth: - description: BasicAuth information to use on every scrape request. + description: basicAuth defines information to use on every scrape request. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -7105,7 +7120,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -7129,38 +7144,36 @@ spec: x-kubernetes-map-type: atomic type: object clientID: - description: Client id is used by Kuma Control Plane to compute Monitoring Assignment for specific Prometheus backend. + description: clientID is used by Kuma Control Plane to compute Monitoring Assignment for specific Prometheus backend. type: string enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean fetchTimeout: - description: The time after which the monitoring assignments are refreshed. + description: fetchTimeout defines the time after which the monitoring assignments are refreshed. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string followRedirects: - description: Configure whether HTTP requests follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: |- - Optional OAuth 2.0 configuration. - Cannot be set at the same time as `authorization`, or `basicAuth`. + description: oauth2 defines the configuration to use on every scrape request. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7182,7 +7195,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7206,7 +7219,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -7232,12 +7245,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -7269,7 +7282,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -7277,29 +7290,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7321,7 +7334,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7344,10 +7357,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7369,7 +7382,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7392,10 +7405,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7418,7 +7431,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -7429,7 +7442,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -7439,11 +7452,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -7477,7 +7490,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -7485,30 +7498,32 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: - description: The time to wait between polling update requests. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string server: - description: Address of the Kuma Control Plane's MADS xDS server. + description: server defines the address of the Kuma Control Plane's MADS xDS server. minLength: 1 type: string tlsConfig: - description: TLS configuration to use on every scrape request + description: tlsConfig defines the TLS configuration to connect to the Consul API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7530,7 +7545,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7553,10 +7568,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7578,7 +7593,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7601,10 +7616,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7627,7 +7642,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -7638,7 +7653,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -7648,7 +7663,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -7657,31 +7672,31 @@ spec: type: array labelLimit: description: |- - Per-scrape limit on number of labels that will be accepted for a sample. + labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. format: int64 type: integer labelNameLengthLimit: description: |- - Per-scrape limit on length of labels name that will be accepted for a sample. + labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. format: int64 type: integer labelValueLengthLimit: description: |- - Per-scrape limit on length of labels value that will be accepted for a sample. + labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. format: int64 type: integer lightSailSDConfigs: - description: LightsailSDConfigs defines a list of Lightsail service discovery configurations. + description: lightSailSDConfigs defines a list of Lightsail service discovery configurations. items: description: |- LightSailSDConfig configurations allow retrieving scrape targets from AWS Lightsail instances. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#lightsail_sd_config properties: accessKey: - description: AccessKey is the AWS API key. + description: accessKey defines the AWS API key. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7704,11 +7719,11 @@ spec: x-kubernetes-map-type: atomic authorization: description: |- - Optional `authorization` HTTP header configuration. - Cannot be set at the same time as `basicAuth`, or `oauth2`. + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7731,7 +7746,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -7740,12 +7755,12 @@ spec: type: object basicAuth: description: |- - Optional HTTP basic authentication information. + basicAuth defines information to use on every scrape request. Cannot be set at the same time as `authorization`, or `oauth2`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -7769,7 +7784,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -7793,18 +7808,18 @@ spec: x-kubernetes-map-type: atomic type: object enableHTTP2: - description: Configure whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean endpoint: - description: Custom endpoint to be used. + description: endpoint defines the custom endpoint to be used. minLength: 1 type: string followRedirects: - description: Configure whether the HTTP requests should follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -7812,16 +7827,16 @@ spec: type: string oauth2: description: |- - Optional OAuth2.0 configuration. - Cannot be set at the same time as `basicAuth`, or `authorization`. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. + Cannot be set at the same time as `authorization`, or `basicAuth`. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7843,7 +7858,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -7867,7 +7882,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -7893,12 +7908,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -7930,7 +7945,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -7938,29 +7953,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -7982,7 +7997,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8005,10 +8020,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8030,7 +8045,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8053,10 +8068,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8079,7 +8094,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -8090,7 +8105,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -8100,11 +8115,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -8113,9 +8128,7 @@ spec: - tokenUrl type: object port: - description: |- - Port to scrape the metrics from. - If using the public IP address, this must instead be specified in the relabeling rule. + description: port defines the port to scrape metrics from. If using the public IP address, this must format: int32 maximum: 65535 minimum: 0 @@ -8146,7 +8159,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -8154,27 +8167,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: - description: Refresh interval to re-read the list of instances. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string region: - description: The AWS region. + description: region defines the AWS region. minLength: 1 type: string roleARN: - description: AWS Role ARN, an alternative to using AWS API keys. + description: roleARN defines the AWS Role ARN, an alternative to using AWS API keys. type: string secretKey: - description: SecretKey is the AWS API secret. + description: secretKey defines the AWS API secret. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8196,13 +8211,13 @@ spec: type: object x-kubernetes-map-type: atomic tlsConfig: - description: TLS configuration to connect to the Puppet DB. + description: tlsConfig defines the TLS configuration to connect to the Consul API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8224,7 +8239,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8247,10 +8262,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8272,7 +8287,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8295,10 +8310,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8321,7 +8336,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -8332,7 +8347,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -8342,23 +8357,25 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object type: array linodeSDConfigs: - description: LinodeSDConfigs defines a list of Linode service discovery configurations. + description: linodeSDConfigs defines a list of Linode service discovery configurations. items: description: |- LinodeSDConfig configurations allow retrieving scrape targets from Linode's Linode APIv4. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#linode_sd_config properties: authorization: - description: Authorization header configuration. + description: |- + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8381,7 +8398,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -8389,14 +8406,14 @@ spec: type: string type: object enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean followRedirects: - description: Configure whether HTTP requests follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -8404,16 +8421,16 @@ spec: type: string oauth2: description: |- - Optional OAuth 2.0 configuration. - Cannot be used at the same time as `authorization`. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. + Cannot be set at the same time as `authorization`, or `basicAuth`. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8435,7 +8452,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8459,7 +8476,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -8485,12 +8502,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -8522,7 +8539,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -8530,29 +8547,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8574,7 +8591,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8597,10 +8614,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8622,7 +8639,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8645,10 +8662,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8671,7 +8688,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -8682,7 +8699,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -8692,11 +8709,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -8705,7 +8722,7 @@ spec: - tokenUrl type: object port: - description: Default port to scrape metrics from. + description: port defines the port to scrape metrics from. If using the public IP address, this must format: int32 maximum: 65535 minimum: 0 @@ -8736,7 +8753,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -8744,34 +8761,36 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: - description: Time after which the linode instances are refreshed. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string region: - description: Optional region to filter on. + description: region defines the region to filter on. minLength: 1 type: string tagSeparator: - description: The string by which Linode Instance tags are joined into the tag label. + description: tagSeparator defines the string by which Linode Instance tags are joined into the tag label.el. minLength: 1 type: string tlsConfig: - description: TLS configuration applying to the target HTTP endpoint. + description: tlsConfig defines the TLS configuration to connect to the Consul API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8793,7 +8812,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8816,10 +8835,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8841,7 +8860,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8864,10 +8883,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8890,7 +8909,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -8901,7 +8920,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -8911,13 +8930,13 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object type: object type: array metricRelabelings: - description: MetricRelabelConfigs to apply to samples before ingestion. + description: metricRelabelings defines the metricRelabelings to apply to samples before ingestion. items: description: |- RelabelConfig allows dynamic rewriting of the label set for targets, alerts, @@ -8928,7 +8947,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -8960,27 +8979,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -8992,7 +9011,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -9003,12 +9022,12 @@ spec: minItems: 1 type: array metricsPath: - description: MetricsPath HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics). + description: metricsPath defines the HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics). minLength: 1 type: string nameEscapingScheme: description: |- - Metric name escaping mode to request through content negotiation. + nameEscapingScheme defines the metric name escaping mode to request through content negotiation. It requires Prometheus >= v3.4.0. enum: @@ -9019,7 +9038,7 @@ spec: type: string nameValidationScheme: description: |- - Specifies the validation scheme for metric and label names. + nameValidationScheme defines the validation scheme for metric and label names. It requires Prometheus >= v3.0.0. enum: @@ -9028,7 +9047,7 @@ spec: type: string nativeHistogramBucketLimit: description: |- - If there are more than this many buckets in a native histogram, + nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0. format: int64 @@ -9038,21 +9057,21 @@ spec: - type: integer - type: string description: |- - If the growth factor of one bucket to the next is smaller than this, + nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this, buckets will be merged to increase the factor sufficiently. It requires Prometheus >= v2.50.0. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string nomadSDConfigs: - description: NomadSDConfigs defines a list of Nomad service discovery configurations. + description: nomadSDConfigs defines a list of Nomad service discovery configurations. items: description: |- NomadSDConfig configurations allow retrieving scrape targets from Nomad's Service API. @@ -9060,14 +9079,16 @@ spec: properties: allowStale: description: |- - The information to access the Nomad API. It is to be defined + allowStale defines the information to access the Nomad API. It is to be defined as the Nomad documentation requires. type: boolean authorization: - description: Authorization header to use on every scrape request. + description: |- + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9090,7 +9111,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -9098,11 +9119,11 @@ spec: type: string type: object basicAuth: - description: BasicAuth information to use on every scrape request. + description: basicAuth defines information to use on every scrape request. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -9126,7 +9147,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -9150,33 +9171,34 @@ spec: x-kubernetes-map-type: atomic type: object enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean followRedirects: - description: Configure whether HTTP requests follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean namespace: + description: |- + namespace defines the Nomad namespace to query for service discovery. + When specified, only resources within this namespace will be discovered. type: string noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string oauth2: - description: |- - Optional OAuth 2.0 configuration. - Cannot be set at the same time as `authorization` or `basic_auth`. + description: oauth2 defines the configuration to use on every scrape request. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9198,7 +9220,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9222,7 +9244,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -9248,12 +9270,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -9285,7 +9307,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -9293,29 +9315,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9337,7 +9359,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9360,10 +9382,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9385,7 +9407,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9408,10 +9430,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9434,7 +9456,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -9445,7 +9467,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -9455,11 +9477,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -9493,7 +9515,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -9501,36 +9523,44 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: description: |- - Duration is a valid time duration that can be parsed by Prometheus model.ParseDuration() function. - Supported units: y, w, d, h, m, s, ms - Examples: `30s`, `1m`, `1h20m15s`, `15d` + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string region: + description: |- + region defines the Nomad region to query for service discovery. + When specified, only resources within this region will be discovered. type: string server: + description: |- + server defines the Nomad server address to connect to for service discovery. + This should be the full URL including protocol (e.g., "https://nomad.example.com:4646"). minLength: 1 type: string tagSeparator: + description: |- + tagSeparator defines the separator used to join multiple tags. + This determines how Nomad service tags are concatenated into Prometheus labels. type: string tlsConfig: - description: TLS configuration applying to the target HTTP endpoint. + description: tlsConfig defines the TLS configuration to connect to the Consul API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9552,7 +9582,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9575,10 +9605,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9600,7 +9630,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9623,10 +9653,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9649,7 +9679,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -9660,7 +9690,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -9670,7 +9700,7 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object required: @@ -9678,15 +9708,15 @@ spec: type: object type: array oauth2: - description: OAuth2 configuration to use on every scrape request. + description: oauth2 defines the configuration to use on every scrape request. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9708,7 +9738,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9732,7 +9762,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -9758,12 +9788,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -9795,7 +9825,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -9803,29 +9833,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9847,7 +9877,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9870,10 +9900,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -9895,7 +9925,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9918,10 +9948,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -9944,7 +9974,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -9955,7 +9985,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -9965,11 +9995,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -9978,7 +10008,7 @@ spec: - tokenUrl type: object openstackSDConfigs: - description: OpenStackSDConfigs defines a list of OpenStack service discovery configurations. + description: openstackSDConfigs defines a list of OpenStack service discovery configurations. items: description: |- OpenStackSDConfig allow retrieving scrape targets from OpenStack Nova instances. @@ -9986,15 +10016,15 @@ spec: properties: allTenants: description: |- - Whether the service discovery should list all instances for all projects. + allTenants defines whether the service discovery should list all instances for all projects. It is only relevant for the 'instance' role and usually requires admin permissions. type: boolean applicationCredentialId: - description: ApplicationCredentialID + description: applicationCredentialId defines the OpenStack applicationCredentialId. type: string applicationCredentialName: description: |- - The ApplicationCredentialID or ApplicationCredentialName fields are + applicationCredentialName defines the ApplicationCredentialID or ApplicationCredentialName fields are required if using an application credential to authenticate. Some providers allow you to create an application credential to authenticate rather than a password. @@ -10002,7 +10032,7 @@ spec: type: string applicationCredentialSecret: description: |- - The applicationCredentialSecret field is required if using an application + applicationCredentialSecret defines the requiered field if using an application credential to authenticate. properties: key: @@ -10025,7 +10055,7 @@ spec: type: object x-kubernetes-map-type: atomic availability: - description: Availability of the endpoint to connect to. + description: availability defines the availability of the endpoint to connect to. enum: - Public - public @@ -10035,24 +10065,24 @@ spec: - internal type: string domainID: - description: DomainID + description: domainID defines The OpenStack domainID. minLength: 1 type: string domainName: description: |- - At most one of domainId and domainName must be provided if using username + domainName defines at most one of domainId and domainName that must be provided if using username with Identity V3. Otherwise, either are optional. minLength: 1 type: string identityEndpoint: description: |- - IdentityEndpoint specifies the HTTP endpoint that is required to work with + identityEndpoint defines the HTTP endpoint that is required to work with the Identity API of the appropriate version. pattern: ^http(s)?:\/\/.+$ type: string password: description: |- - Password for the Identity V2 and V3 APIs. Consult with your provider's + password defines the password for the Identity V2 and V3 APIs. Consult with your provider's control panel to discover your account's preferred method of authentication. properties: key: @@ -10076,35 +10106,37 @@ spec: x-kubernetes-map-type: atomic port: description: |- - The port to scrape metrics from. If using the public IP address, this must + port defines the port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule. format: int32 maximum: 65535 minimum: 0 type: integer projectID: - description: ' ProjectID' + description: projectID defines the OpenStack projectID. minLength: 1 type: string projectName: description: |- - The ProjectId and ProjectName fields are optional for the Identity V2 API. + projectName defines an ptional field for the Identity V2 API. Some providers allow you to specify a ProjectName instead of the ProjectId. Some require both. Your provider's authentication policies will determine how these fields influence authentication. minLength: 1 type: string refreshInterval: - description: Refresh interval to re-read the instance list. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string region: - description: The OpenStack Region. + description: region defines the OpenStack Region. minLength: 1 type: string role: description: |- - The OpenStack role of entities that should be discovered. + role defines the OpenStack role of entities that should be discovered. Note: The `LoadBalancer` role requires Prometheus >= v3.2.0. enum: @@ -10113,13 +10145,13 @@ spec: - LoadBalancer type: string tlsConfig: - description: TLS configuration applying to the target HTTP endpoint. + description: tlsConfig defines the TLS configuration applying to the target HTTP endpoint. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10141,7 +10173,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10164,10 +10196,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10189,7 +10221,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10212,10 +10244,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10238,7 +10270,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -10249,7 +10281,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -10259,16 +10291,16 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object userid: - description: UserID + description: userid defines the OpenStack userid. minLength: 1 type: string username: description: |- - Username is required if using Identity V2 API. Consult with your provider's + username defines the username required if using Identity V2 API. Consult with your provider's control panel to discover your account's username. In Identity V3, either userid or a combination of username and domainId or domainName are needed @@ -10280,18 +10312,22 @@ spec: type: object type: array ovhcloudSDConfigs: - description: OVHCloudSDConfigs defines a list of OVHcloud service discovery configurations. + description: ovhcloudSDConfigs defines a list of OVHcloud service discovery configurations. items: description: |- OVHCloudSDConfig configurations allow retrieving scrape targets from OVHcloud's dedicated servers and VPS using their API. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#ovhcloud_sd_config properties: applicationKey: - description: Access key to use. https://api.ovh.com. + description: |- + applicationKey defines the access key to use for OVHCloud API authentication. + This is obtained from the OVHCloud API credentials at https://api.ovh.com. minLength: 1 type: string applicationSecret: - description: SecretKeySelector selects a key of a Secret. + description: |- + applicationSecret defines the secret key for OVHCloud API authentication. + This contains the application secret obtained during OVHCloud API credential creation. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10313,7 +10349,9 @@ spec: type: object x-kubernetes-map-type: atomic consumerKey: - description: SecretKeySelector selects a key of a Secret. + description: |- + consumerKey defines the consumer key for OVHCloud API authentication. + This is the third component of OVHCloud's three-key authentication system. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10335,15 +10373,21 @@ spec: type: object x-kubernetes-map-type: atomic endpoint: - description: Custom endpoint to be used. + description: |- + endpoint defines a custom API endpoint to be used. + When not specified, defaults to the standard OVHCloud API endpoint for the region. minLength: 1 type: string refreshInterval: - description: Refresh interval to re-read the resources list. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string service: - description: Service of the targets to retrieve. Must be `VPS` or `DedicatedServer`. + description: |- + service defines the service type of the targets to retrieve. + Must be either `VPS` or `DedicatedServer` to specify which OVHCloud resources to discover. enum: - VPS - DedicatedServer @@ -10360,7 +10404,7 @@ spec: items: type: string type: array - description: Optional HTTP URL parameters + description: params defines optional HTTP URL parameters type: object x-kubernetes-map-type: atomic proxyConnectHeader: @@ -10389,7 +10433,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -10397,16 +10441,16 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string puppetDBSDConfigs: - description: PuppetDBSDConfigs defines a list of PuppetDB service discovery configurations. + description: puppetDBSDConfigs defines a list of PuppetDB service discovery configurations. items: description: |- PuppetDBSDConfig configurations allow retrieving scrape targets from PuppetDB resources. @@ -10414,11 +10458,11 @@ spec: properties: authorization: description: |- - Optional `authorization` HTTP header configuration. - Cannot be set at the same time as `basicAuth`, or `oauth2`. + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10441,7 +10485,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -10450,12 +10494,12 @@ spec: type: object basicAuth: description: |- - Optional HTTP basic authentication information. + basicAuth defines information to use on every scrape request. Cannot be set at the same time as `authorization`, or `oauth2`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -10479,7 +10523,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -10503,20 +10547,20 @@ spec: x-kubernetes-map-type: atomic type: object enableHTTP2: - description: Configure whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean followRedirects: - description: Configure whether the HTTP requests should follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean includeParameters: description: |- - Whether to include the parameters as meta labels. + includeParameters defines whether to include the parameters as meta labels. Note: Enabling this exposes parameters in the Prometheus UI and API. Make sure that you don't have secrets exposed as parameters if you enable this. type: boolean noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -10524,16 +10568,16 @@ spec: type: string oauth2: description: |- - Optional OAuth2.0 configuration. - Cannot be set at the same time as `basicAuth`, or `authorization`. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. + Cannot be set at the same time as `authorization`, or `basicAuth`. properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10555,7 +10599,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10579,7 +10623,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -10605,12 +10649,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -10642,7 +10686,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -10650,29 +10694,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10694,7 +10738,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10717,10 +10761,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10742,7 +10786,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10765,10 +10809,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10791,7 +10835,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -10802,7 +10846,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -10812,11 +10856,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -10825,7 +10869,7 @@ spec: - tokenUrl type: object port: - description: Port to scrape the metrics from. + description: port defines the port to scrape metrics from. If using the public IP address, this must format: int32 maximum: 65535 minimum: 0 @@ -10856,7 +10900,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -10864,32 +10908,34 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string query: description: |- - Puppet Query Language (PQL) query. Only resources are supported. + query defines the Puppet Query Language (PQL) query. Only resources are supported. https://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html minLength: 1 type: string refreshInterval: - description: Refresh interval to re-read the list of resources. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string tlsConfig: - description: TLS configuration to connect to the Puppet DB. + description: tlsConfig defines the TLS configuration to connect to the Consul API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10911,7 +10957,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10934,10 +10980,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -10959,7 +11005,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -10982,10 +11028,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -11008,7 +11054,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -11019,7 +11065,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -11029,11 +11075,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object url: - description: The URL of the PuppetDB root query endpoint. + description: url defines the URL of the PuppetDB root query endpoint. minLength: 1 pattern: ^http(s)?://.+$ type: string @@ -11044,7 +11090,7 @@ spec: type: array relabelings: description: |- - RelabelConfigs defines how to rewrite the target's labels before scraping. + relabelings defines how to rewrite the target's labels before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields. The original scrape job's name is available via the `__tmp_prometheus_job_name` label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config @@ -11058,7 +11104,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -11090,27 +11136,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -11122,7 +11168,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -11133,50 +11179,50 @@ spec: minItems: 1 type: array sampleLimit: - description: SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. + description: sampleLimit defines per-scrape limit on number of scraped samples that will be accepted. format: int64 type: integer scalewaySDConfigs: - description: ScalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations. + description: scalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations. items: description: |- ScalewaySDConfig configurations allow retrieving scrape targets from Scaleway instances and baremetal services. See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scaleway_sd_config properties: accessKey: - description: Access key to use. https://console.scaleway.com/project/credentials + description: accessKey defines the access key to use. https://console.scaleway.com/project/credentials minLength: 1 type: string apiURL: - description: API URL to use when doing the server listing requests. + description: apiURL defines the API URL to use when doing the server listing requests. pattern: ^http(s)?://.+$ type: string enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean followRedirects: - description: Configure whether HTTP requests follow HTTP 3xx redirects. + description: followRedirects defines whether HTTP requests follow HTTP 3xx redirects. type: boolean nameFilter: - description: NameFilter specify a name filter (works as a LIKE) to apply on the server listing request. + description: nameFilter defines a name filter (works as a LIKE) to apply on the server listing request. minLength: 1 type: string noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: string port: - description: The port to scrape metrics from. + description: port defines the port to scrape metrics from. If using the public IP address, this must format: int32 maximum: 65535 minimum: 0 type: integer projectID: - description: Project ID of the targets. + description: projectID defines the Project ID of the targets. minLength: 1 type: string proxyConnectHeader: @@ -11205,7 +11251,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -11213,26 +11259,28 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string refreshInterval: - description: Refresh interval to re-read the list of instances. + description: |- + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string role: - description: Service of the targets to retrieve. Must be `Instance` or `Baremetal`. + description: role defines the service of the targets to retrieve. Must be `Instance` or `Baremetal`. enum: - Instance - Baremetal type: string secretKey: - description: Secret key to use when listing targets. + description: secretKey defines the secret key to use when listing targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -11254,7 +11302,7 @@ spec: type: object x-kubernetes-map-type: atomic tagsFilter: - description: TagsFilter specify a tag filter (a server needs to have all defined tags to be listed) to apply on the server listing request. + description: tagsFilter defines a tag filter (a server needs to have all defined tags to be listed) to apply on the server listing request. items: minLength: 1 type: string @@ -11262,13 +11310,13 @@ spec: type: array x-kubernetes-list-type: set tlsConfig: - description: TLS configuration to use on every scrape request + description: tlsConfig defines the TLS configuration to connect to the Consul API. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -11290,7 +11338,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -11313,10 +11361,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -11338,7 +11386,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -11361,10 +11409,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -11387,7 +11435,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -11398,7 +11446,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -11408,11 +11456,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object zone: - description: Zone is the availability zone of your targets (e.g. fr-par-1). + description: zone defines the availability zone of your targets (e.g. fr-par-1). minLength: 1 type: string required: @@ -11424,30 +11472,30 @@ spec: type: array scheme: description: |- - Configures the protocol scheme used for requests. + scheme defines the protocol scheme used for requests. If empty, Prometheus uses HTTP by default. enum: - HTTP - HTTPS type: string scrapeClass: - description: The scrape class to apply. + description: scrapeClass defines the scrape class to apply. minLength: 1 type: string scrapeClassicHistograms: description: |- - Whether to scrape a classic histogram that is also exposed as a native histogram. + scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0. Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration. type: boolean scrapeInterval: - description: ScrapeInterval is the interval between consecutive scrapes. + description: scrapeInterval defines the interval between consecutive scrapes. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string scrapeProtocols: description: |- - The protocols to negotiate during a scrape. It tells clients the + scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. @@ -11474,12 +11522,12 @@ spec: x-kubernetes-list-type: set scrapeTimeout: description: |- - ScrapeTimeout is the number of seconds to wait until a scrape request times out. + scrapeTimeout defines the number of seconds to wait until a scrape request times out. The value cannot be greater than the scrape interval otherwise the operator will reject the resource. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string staticConfigs: - description: StaticConfigs defines a list of static targets with a common label set. + description: staticConfigs defines a list of static targets with a common label set. items: description: |- StaticConfig defines a Prometheus static configuration. @@ -11488,11 +11536,11 @@ spec: labels: additionalProperties: type: string - description: Labels assigned to all metrics scraped from the targets. + description: labels defines labels assigned to all metrics scraped from the targets. type: object x-kubernetes-map-type: atomic targets: - description: List of targets for this static configuration. + description: targets defines the list of targets for this static configuration. items: description: |- Target represents a target for Prometheus to scrape @@ -11506,17 +11554,17 @@ spec: type: object type: array targetLimit: - description: TargetLimit defines a limit on the number of scraped targets that will be accepted. + description: targetLimit defines a limit on the number of scraped targets that will be accepted. format: int64 type: integer tlsConfig: - description: TLS configuration to use on every scrape request + description: tlsConfig defines the TLS configuration to use on every scrape request properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -11538,7 +11586,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -11561,10 +11609,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -11586,7 +11634,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -11609,10 +11657,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -11635,7 +11683,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -11646,7 +11694,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -11656,12 +11704,12 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object trackTimestampsStaleness: description: |- - TrackTimestampsStaleness whether Prometheus tracks staleness of + trackTimestampsStaleness defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if `honorTimestamps` is false. It requires Prometheus >= v2.48.0. diff --git a/monitoring-satellite/manifests/crds/prometheusOperator-0servicemonitorCustomResourceDefinition.yaml b/monitoring-satellite/manifests/crds/prometheusOperator-0servicemonitorCustomResourceDefinition.yaml index 335f4213..2ef53b43 100644 --- a/monitoring-satellite/manifests/crds/prometheusOperator-0servicemonitorCustomResourceDefinition.yaml +++ b/monitoring-satellite/manifests/crds/prometheusOperator-0servicemonitorCustomResourceDefinition.yaml @@ -3,7 +3,7 @@ kind: CustomResourceDefinition metadata: annotations: argocd.argoproj.io/sync-options: Replace=true - controller-gen.kubebuilder.io/version: v0.18.0 + controller-gen.kubebuilder.io/version: v0.19.0 operator.prometheus.io/version: 0.85.0 name: servicemonitors.monitoring.coreos.com spec: @@ -51,19 +51,19 @@ spec: type: object spec: description: |- - Specification of desired Service selection for target discovery by + spec defines the specification of desired Service selection for target discovery by Prometheus. properties: attachMetadata: description: |- - `attachMetadata` defines additional metadata which is added to the + attachMetadata defines additional metadata which is added to the discovered targets. It requires Prometheus >= v2.37.0. properties: node: description: |- - When set to true, Prometheus attaches node metadata to the discovered + node when set to true, Prometheus attaches node metadata to the discovered targets. The Prometheus service account must have the `list` and `watch` @@ -72,7 +72,7 @@ spec: type: object bodySizeLimit: description: |- - When defined, bodySizeLimit specifies a job level limit on the size + bodySizeLimit when defined, bodySizeLimit specifies a job level limit on the size of uncompressed response body that will be accepted by Prometheus. It requires Prometheus >= v2.28.0. @@ -80,12 +80,12 @@ spec: type: string convertClassicHistogramsToNHCB: description: |- - Whether to convert all scraped classic histograms into a native histogram with custom buckets. + convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. It requires Prometheus >= v3.0.0. type: boolean endpoints: description: |- - List of endpoints part of this ServiceMonitor. + endpoints defines the list of endpoints part of this ServiceMonitor. Defines how to scrape metrics from Kubernetes [Endpoints](https://kubernetes.io/docs/concepts/services-networking/service/#endpoints) objects. In most cases, an Endpoints object is backed by a Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) object with the same name and labels. items: @@ -95,13 +95,13 @@ spec: properties: authorization: description: |- - `authorization` configures the Authorization header credentials to use when + authorization configures the Authorization header credentials to use when scraping the target. Cannot be set at the same time as `basicAuth`, or `oauth2`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -124,7 +124,7 @@ spec: x-kubernetes-map-type: atomic type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -133,14 +133,14 @@ spec: type: object basicAuth: description: |- - `basicAuth` configures the Basic Authentication credentials to use when + basicAuth defines the Basic Authentication credentials to use when scraping the target. Cannot be set at the same time as `authorization`, or `oauth2`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -164,7 +164,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -189,13 +189,13 @@ spec: type: object bearerTokenFile: description: |- - File to read bearer token for scraping the target. + bearerTokenFile defines the file to read bearer token for scraping the target. Deprecated: use `authorization` instead. type: string bearerTokenSecret: description: |- - `bearerTokenSecret` specifies a key of a Secret containing the bearer + bearerTokenSecret defines a key of a Secret containing the bearer token for scraping targets. The secret needs to be in the same namespace as the ServiceMonitor object and readable by the Prometheus Operator. @@ -221,11 +221,11 @@ spec: type: object x-kubernetes-map-type: atomic enableHttp2: - description: '`enableHttp2` can be used to disable HTTP2 when scraping the target.' + description: enableHttp2 can be used to disable HTTP2 when scraping the target. type: boolean filterRunning: description: |- - When true, the pods which are not running (e.g. either in Failed or + filterRunning when true, the pods which are not running (e.g. either in Failed or Succeeded state) are dropped during the target discovery. If unset, the filtering is enabled. @@ -234,29 +234,29 @@ spec: type: boolean followRedirects: description: |- - `followRedirects` defines whether the scrape requests should follow HTTP + followRedirects defines whether the scrape requests should follow HTTP 3xx redirects. type: boolean honorLabels: description: |- - When true, `honorLabels` preserves the metric's labels when they collide + honorLabels defines when true the metric's labels when they collide with the target's labels. type: boolean honorTimestamps: description: |- - `honorTimestamps` controls whether Prometheus preserves the timestamps + honorTimestamps defines whether Prometheus preserves the timestamps when exposed by the target. type: boolean interval: description: |- - Interval at which Prometheus scrapes the metrics from the target. + interval at which Prometheus scrapes the metrics from the target. If empty, Prometheus uses the global scrape interval. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string metricRelabelings: description: |- - `metricRelabelings` configures the relabeling rules to apply to the + metricRelabelings defines the relabeling rules to apply to the samples before ingestion. items: description: |- @@ -268,7 +268,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -300,27 +300,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -332,7 +332,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -343,7 +343,7 @@ spec: type: array noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -351,7 +351,7 @@ spec: type: string oauth2: description: |- - `oauth2` configures the OAuth2 settings to use when scraping the target. + oauth2 defines the OAuth2 settings to use when scraping the target. It requires Prometheus >= 2.27.0. @@ -359,11 +359,11 @@ spec: properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -385,7 +385,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -409,7 +409,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -435,12 +435,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -472,7 +472,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -480,29 +480,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -524,7 +524,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -547,10 +547,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -572,7 +572,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -595,10 +595,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -621,7 +621,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -632,7 +632,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -642,11 +642,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -663,13 +663,13 @@ spec: type: object path: description: |- - HTTP path from which to scrape for metrics. + path defines the HTTP path from which to scrape for metrics. If empty, Prometheus uses the default value (e.g. `/metrics`). type: string port: description: |- - Name of the Service port which this endpoint refers to. + port defines the name of the Service port which this endpoint refers to. It takes precedence over `targetPort`. type: string @@ -699,7 +699,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -707,17 +707,17 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string relabelings: description: |- - `relabelings` configures the relabeling rules to apply the target's + relabelings defines the relabeling rules to apply the target's metadata labels. The Operator automatically adds relabelings for a few standard Kubernetes fields. @@ -735,7 +735,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -767,27 +767,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -799,7 +799,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -810,7 +810,7 @@ spec: type: array scheme: description: |- - HTTP scheme to use for scraping. + scheme defines the HTTP scheme to use for scraping. `http` and `https` are the expected values unless you rewrite the `__scheme__` label via relabeling. @@ -822,7 +822,7 @@ spec: type: string scrapeTimeout: description: |- - Timeout after which Prometheus considers the scrape to be failed. + scrapeTimeout defines the timeout after which Prometheus considers the scrape to be failed. If empty, Prometheus uses the global scrape timeout unless it is less than the target's scrape interval value in which the latter is used. @@ -834,17 +834,17 @@ spec: - type: integer - type: string description: |- - Name or number of the target port of the `Pod` object behind the + targetPort defines the name or number of the target port of the `Pod` object behind the Service. The port must be specified with the container's port property. x-kubernetes-int-or-string: true tlsConfig: - description: TLS configuration to use when scraping the target. + description: tlsConfig defines the TLS configuration to use when scraping the target. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -866,7 +866,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -889,13 +889,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -917,7 +917,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -940,16 +940,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -972,7 +972,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -983,7 +983,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -993,12 +993,12 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object trackTimestampsStaleness: description: |- - `trackTimestampsStaleness` defines whether Prometheus tracks staleness of + trackTimestampsStaleness defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if `honorTimestamps` is false. @@ -1008,7 +1008,7 @@ spec: type: array fallbackScrapeProtocol: description: |- - The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. + fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It requires Prometheus >= v3.0.0. enum: @@ -1020,7 +1020,7 @@ spec: type: string jobLabel: description: |- - `jobLabel` selects the label from the associated Kubernetes `Service` + jobLabel selects the label from the associated Kubernetes `Service` object which will be used as the `job` label for all metrics. For example if `jobLabel` is set to `foo` and the Kubernetes `Service` @@ -1033,7 +1033,7 @@ spec: type: string keepDroppedTargets: description: |- - Per-scrape limit on the number of targets dropped by relabeling + keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0. @@ -1041,44 +1041,44 @@ spec: type: integer labelLimit: description: |- - Per-scrape limit on number of labels that will be accepted for a sample. + labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample. It requires Prometheus >= v2.27.0. format: int64 type: integer labelNameLengthLimit: description: |- - Per-scrape limit on length of labels name that will be accepted for a sample. + labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. It requires Prometheus >= v2.27.0. format: int64 type: integer labelValueLengthLimit: description: |- - Per-scrape limit on length of labels value that will be accepted for a sample. + labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. It requires Prometheus >= v2.27.0. format: int64 type: integer namespaceSelector: description: |- - `namespaceSelector` defines in which namespace(s) Prometheus should discover the services. + namespaceSelector defines in which namespace(s) Prometheus should discover the services. By default, the services are discovered in the same namespace as the `ServiceMonitor` object but it is possible to select pods across different/all namespaces. properties: any: description: |- - Boolean describing whether all namespaces are selected in contrast to a + any defines the boolean describing whether all namespaces are selected in contrast to a list restricting them. type: boolean matchNames: - description: List of namespace names to select from. + description: matchNames defines the list of namespace names to select from. items: type: string type: array type: object nativeHistogramBucketLimit: description: |- - If there are more than this many buckets in a native histogram, + nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0. format: int64 @@ -1088,38 +1088,38 @@ spec: - type: integer - type: string description: |- - If the growth factor of one bucket to the next is smaller than this, + nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this, buckets will be merged to increase the factor sufficiently. It requires Prometheus >= v2.50.0. pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$ x-kubernetes-int-or-string: true podTargetLabels: description: |- - `podTargetLabels` defines the labels which are transferred from the + podTargetLabels defines the labels which are transferred from the associated Kubernetes `Pod` object onto the ingested metrics. items: type: string type: array sampleLimit: description: |- - `sampleLimit` defines a per-scrape limit on the number of scraped samples + sampleLimit defines a per-scrape limit on the number of scraped samples that will be accepted. format: int64 type: integer scrapeClass: - description: The scrape class to apply. + description: scrapeClass defines the scrape class to apply. minLength: 1 type: string scrapeClassicHistograms: description: |- - Whether to scrape a classic histogram that is also exposed as a native histogram. + scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0. Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration. type: boolean scrapeProtocols: description: |- - `scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the + scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. @@ -1144,7 +1144,7 @@ spec: type: array x-kubernetes-list-type: set selector: - description: Label selector to select the Kubernetes `Endpoints` objects to scrape metrics from. + description: selector defines the label selector to select the Kubernetes `Endpoints` objects to scrape metrics from. properties: matchExpressions: description: matchExpressions is a list of label selector requirements. The requirements are ANDed. @@ -1189,7 +1189,7 @@ spec: x-kubernetes-map-type: atomic selectorMechanism: description: |- - Mechanism used to select the endpoints to scrape. + selectorMechanism defines the mechanism used to select the endpoints to scrape. By default, the selection process relies on relabel configurations to filter the discovered targets. Alternatively, you can opt in for role selectors, which may offer better efficiency in large clusters. Which strategy is best for your use case needs to be carefully evaluated. @@ -1201,14 +1201,14 @@ spec: type: string targetLabels: description: |- - `targetLabels` defines the labels which are transferred from the + targetLabels defines the labels which are transferred from the associated Kubernetes `Service` object onto the ingested metrics. items: type: string type: array targetLimit: description: |- - `targetLimit` defines a limit on the number of scraped targets that will + targetLimit defines a limit on the number of scraped targets that will be accepted. format: int64 type: integer @@ -1218,7 +1218,7 @@ spec: type: object status: description: |- - This Status subresource is under active development and is updated only when the + status defines the status subresource is under active development and is updated only when the "StatusForConfigurationResources" feature gate is enabled. Most recent observed status of the ServiceMonitor. Read-only. @@ -1226,40 +1226,40 @@ spec: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status properties: bindings: - description: The list of workload resources (Prometheus or PrometheusAgent) which select the configuration resource. + description: bindings defines the list of workload resources (Prometheus or PrometheusAgent) which select the configuration resource. items: description: WorkloadBinding is a link between a configuration resource and a workload resource. properties: conditions: - description: The current state of the configuration resource when bound to the referenced Prometheus object. + description: conditions defines the current state of the configuration resource when bound to the referenced Prometheus object. items: description: ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager, or ThanosRuler. properties: lastTransitionTime: - description: LastTransitionTime is the time of the last update to the current status property. + description: lastTransitionTime defines the time of the last update to the current status property. format: date-time type: string message: - description: Human-readable message indicating details for the condition's last transition. + description: message defines the human-readable message indicating details for the condition's last transition. type: string observedGeneration: description: |- - ObservedGeneration represents the .metadata.generation that the + observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if `.metadata.generation` is currently 12, but the `.status.conditions[].observedGeneration` is 9, the condition is out of date with respect to the current state of the object. format: int64 type: integer reason: - description: Reason for the condition's last transition. + description: reason for the condition's last transition. type: string status: - description: Status of the condition. + description: status of the condition. minLength: 1 type: string type: description: |- - Type of the condition being reported. + type of the condition being reported. Currently, only "Accepted" is supported. enum: - Accepted @@ -1275,20 +1275,20 @@ spec: - type x-kubernetes-list-type: map group: - description: The group of the referenced resource. + description: group defines the group of the referenced resource. enum: - monitoring.coreos.com type: string name: - description: The name of the referenced object. + description: name defines the name of the referenced object. minLength: 1 type: string namespace: - description: The namespace of the referenced object. + description: namespace defines the namespace of the referenced object. minLength: 1 type: string resource: - description: The type of resource being referenced (e.g. Prometheus or PrometheusAgent). + description: resource defines the type of resource being referenced (e.g. Prometheus or PrometheusAgent). enum: - prometheuses - prometheusagents diff --git a/monitoring-satellite/manifests/crds/prometheusOperator-0thanosrulerCustomResourceDefinition.yaml b/monitoring-satellite/manifests/crds/prometheusOperator-0thanosrulerCustomResourceDefinition.yaml index 1627607f..05ae71bc 100644 --- a/monitoring-satellite/manifests/crds/prometheusOperator-0thanosrulerCustomResourceDefinition.yaml +++ b/monitoring-satellite/manifests/crds/prometheusOperator-0thanosrulerCustomResourceDefinition.yaml @@ -3,7 +3,7 @@ kind: CustomResourceDefinition metadata: annotations: argocd.argoproj.io/sync-options: Replace=true - controller-gen.kubebuilder.io/version: v0.18.0 + controller-gen.kubebuilder.io/version: v0.19.0 operator.prometheus.io/version: 0.85.0 name: thanosrulers.monitoring.coreos.com spec: @@ -75,12 +75,12 @@ spec: type: object spec: description: |- - Specification of the desired behavior of the ThanosRuler cluster. More info: + spec defines the specification of the desired behavior of the ThanosRuler cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status properties: additionalArgs: description: |- - AdditionalArgs allows setting additional arguments for the ThanosRuler container. + additionalArgs defines how to add additional arguments for the ThanosRuler container. It is intended for e.g. activating hidden flags which are not supported by the dedicated configuration options yet. The arguments are passed as-is to the ThanosRuler container which may cause issues if they are invalid or not supported @@ -92,18 +92,18 @@ spec: description: Argument as part of the AdditionalArgs list. properties: name: - description: Name of the argument, e.g. "scrape.discovery-reload-interval". + description: name of the argument, e.g. "scrape.discovery-reload-interval". minLength: 1 type: string value: - description: Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) + description: value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) type: string required: - name type: object type: array affinity: - description: If specified, the pod's scheduling constraints. + description: affinity defines when specified, the pod's scheduling constraints. properties: nodeAffinity: description: Describes node affinity scheduling rules for the pod. @@ -977,7 +977,7 @@ spec: type: object alertDropLabels: description: |- - Configures the label names which should be dropped in Thanos Ruler + alertDropLabels defines the label names which should be dropped in Thanos Ruler alerts. The replica label `thanos_ruler_replica` will always be dropped from the alerts. @@ -986,13 +986,13 @@ spec: type: array alertQueryUrl: description: |- - The external Query URL the Thanos Ruler will set in the 'Source' field + alertQueryUrl defines how Thanos Ruler will set in the 'Source' field of all alerts. Maps to the '--alert.query-url' CLI arg. type: string alertRelabelConfigFile: description: |- - Configures the path to the alert relabeling configuration file. + alertRelabelConfigFile defines the path to the alert relabeling configuration file. Alert relabel configuration must have the form as specified in the official Prometheus documentation: @@ -1004,7 +1004,7 @@ spec: type: string alertRelabelConfigs: description: |- - Configures alert relabeling in Thanos Ruler. + alertRelabelConfigs defines the alert relabeling in Thanos Ruler. Alert relabel configuration must have the form as specified in the official Prometheus documentation: @@ -1035,7 +1035,7 @@ spec: x-kubernetes-map-type: atomic alertmanagersConfig: description: |- - Configures the list of Alertmanager endpoints to send alerts to. + alertmanagersConfig defines the list of Alertmanager endpoints to send alerts to. The configuration format is defined at https://thanos.io/tip/components/rule.md/#alertmanager. @@ -1066,7 +1066,7 @@ spec: x-kubernetes-map-type: atomic alertmanagersUrl: description: |- - Configures the list of Alertmanager endpoints to send alerts to. + alertmanagersUrl defines the list of Alertmanager endpoints to send alerts to. For Thanos >= v0.10.0, it is recommended to use `alertmanagersConfig` instead. @@ -1076,7 +1076,7 @@ spec: type: array containers: description: |- - Containers allows injecting additional containers or modifying operator generated + containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or to change the behavior of an operator generated container. Containers described here modify an operator generated container if they share the same name and modifications are done via a @@ -2544,11 +2544,11 @@ spec: type: object type: array dnsConfig: - description: Defines the DNS configuration for the pods. + description: dnsConfig defines Defines the DNS configuration for the pods. properties: nameservers: description: |- - A list of DNS name server IP addresses. + nameservers defines the list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. items: minLength: 1 @@ -2557,7 +2557,7 @@ spec: x-kubernetes-list-type: set options: description: |- - A list of DNS resolver options. + options defines the list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Resolution options given in Options will override those that appear in the base DNSPolicy. @@ -2565,11 +2565,11 @@ spec: description: PodDNSConfigOption defines DNS resolver options of a pod. properties: name: - description: Name is required and must be unique. + description: name is required and must be unique. minLength: 1 type: string value: - description: Value is optional. + description: value is optional. type: string required: - name @@ -2580,7 +2580,7 @@ spec: x-kubernetes-list-type: map searches: description: |- - A list of DNS search domains for host-name lookup. + searches defines the list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. items: minLength: 1 @@ -2589,7 +2589,7 @@ spec: x-kubernetes-list-type: set type: object dnsPolicy: - description: Defines the DNS policy for the pods. + description: dnsPolicy defines the DNS policy for the pods. enum: - ClusterFirstWithHostNet - ClusterFirst @@ -2598,7 +2598,7 @@ spec: type: string enableFeatures: description: |- - Enable access to Thanos Ruler feature flags. By default, no features are enabled. + enableFeatures defines how to setup Thanos Ruler feature flags. By default, no features are enabled. Enabling features which are disabled by default is entirely outside the scope of what the maintainers will support and by doing so, you accept @@ -2613,22 +2613,22 @@ spec: type: array x-kubernetes-list-type: set enableServiceLinks: - description: Indicates whether information about services should be injected into pod's environment variables + description: enableServiceLinks defines whether information about services should be injected into pod's environment variables type: boolean enforcedNamespaceLabel: description: |- - EnforcedNamespaceLabel enforces adding a namespace label of origin for each alert + enforcedNamespaceLabel enforces adding a namespace label of origin for each alert and metric that is user created. The label value will always be the namespace of the object that is being created. type: string evaluationInterval: default: 15s - description: Interval between consecutive evaluations. + description: evaluationInterval defines the interval between consecutive evaluations. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string excludedFromEnforcement: description: |- - List of references to PrometheusRule objects + excludedFromEnforcement defines the list of references to PrometheusRule objects to be excluded from enforcing a namespace label of origin. Applies only if enforcedNamespaceLabel set to true. items: @@ -2636,21 +2636,21 @@ spec: properties: group: default: monitoring.coreos.com - description: Group of the referent. When not specified, it defaults to `monitoring.coreos.com` + description: group of the referent. When not specified, it defaults to `monitoring.coreos.com` enum: - monitoring.coreos.com type: string name: - description: Name of the referent. When not set, all resources in the namespace are matched. + description: name of the referent. When not set, all resources in the namespace are matched. type: string namespace: description: |- - Namespace of the referent. + namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ minLength: 1 type: string resource: - description: Resource of the referent. + description: resource of the referent. enum: - prometheusrules - servicemonitors @@ -2665,22 +2665,22 @@ spec: type: array externalPrefix: description: |- - The external URL the Thanos Ruler instances will be available under. This is + externalPrefix defines the Thanos Ruler instances will be available under. This is necessary to generate correct URLs. This is necessary if Thanos Ruler is not served from root of a DNS name. type: string grpcServerTlsConfig: description: |- - GRPCServerTLSConfig configures the gRPC server from which Thanos Querier reads + grpcServerTlsConfig defines the gRPC server from which Thanos Querier reads recorded rule data. Note: Currently only the CAFile, CertFile, and KeyFile fields are supported. Maps to the '--grpc-server-tls-*' CLI args. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2702,7 +2702,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2725,13 +2725,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -2753,7 +2753,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2776,16 +2776,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -2808,7 +2808,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -2819,7 +2819,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -2829,23 +2829,23 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object hostAliases: - description: Pods' hostAliases configuration + description: hostAliases defines pods' hostAliases configuration items: description: |- HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the pod's hosts file. properties: hostnames: - description: Hostnames for the above IP address. + description: hostnames defines hostnames for the above IP address. items: type: string type: array ip: - description: IP address of the host file entry. + description: ip defines the IP address of the host file entry. type: string required: - hostnames @@ -2857,7 +2857,7 @@ spec: x-kubernetes-list-type: map hostUsers: description: |- - HostUsers supports the user space in Kubernetes. + hostUsers supports the user space in Kubernetes. More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/ @@ -2865,11 +2865,11 @@ spec: Starting Kubernetes 1.33, the feature is enabled by default. type: boolean image: - description: Thanos container image URL. + description: image defines Thanos container image URL. type: string imagePullPolicy: description: |- - Image pull policy for the 'thanos', 'init-config-reloader' and 'config-reloader' containers. + imagePullPolicy defines for the 'thanos', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details. enum: - "" @@ -2879,7 +2879,7 @@ spec: type: string imagePullSecrets: description: |- - An optional list of references to secrets in the same namespace + imagePullSecrets defines an optional list of references to secrets in the same namespace to use for pulling thanos images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod items: @@ -2901,7 +2901,7 @@ spec: type: array initContainers: description: |- - InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. + initContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the ThanosRuler configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ @@ -4372,25 +4372,25 @@ spec: additionalProperties: type: string description: |- - Configures the external label pairs of the ThanosRuler resource. + labels defines the external label pairs of the ThanosRuler resource. A default replica label `thanos_ruler_replica` will be always added as a label with the value of the pod's name. type: object listenLocal: description: |- - ListenLocal makes the Thanos ruler listen on loopback, so that it + listenLocal defines the Thanos ruler listen on loopback, so that it does not bind against the Pod IP. type: boolean logFormat: - description: Log format for ThanosRuler to be configured with. + description: logFormat for ThanosRuler to be configured with. enum: - "" - logfmt - json type: string logLevel: - description: Log level for ThanosRuler to be configured with. + description: logLevel for ThanosRuler to be configured with. enum: - "" - debug @@ -4400,7 +4400,7 @@ spec: type: string minReadySeconds: description: |- - Minimum number of seconds for which a newly created pod should be ready + minReadySeconds defines the minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. If unset, pods will be considered available as soon as they are ready. @@ -4410,13 +4410,11 @@ spec: nodeSelector: additionalProperties: type: string - description: Define which Nodes the Pods are scheduled on. + description: nodeSelector defines which Nodes the Pods are scheduled on. type: object objectStorageConfig: description: |- - Configures object storage. - - The configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage + objectStorageConfig defines the configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage The operator performs no validation of the configuration. @@ -4443,7 +4441,7 @@ spec: x-kubernetes-map-type: atomic objectStorageConfigFile: description: |- - Configures the path of the object storage configuration file. + objectStorageConfigFile defines the path of the object storage configuration file. The configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage @@ -4453,12 +4451,12 @@ spec: type: string paused: description: |- - When a ThanosRuler deployment is paused, no actions except for deletion + paused defines when a ThanosRuler deployment is paused, no actions except for deletion will be performed on the underlying objects. type: boolean podMetadata: description: |- - PodMetadata configures labels and annotations which are propagated to the ThanosRuler pods. + podMetadata defines labels and annotations which are propagated to the ThanosRuler pods. The following items are reserved and cannot be overridden: * "app.kubernetes.io/name" label, set to "thanos-ruler". @@ -4471,7 +4469,7 @@ spec: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ @@ -4480,14 +4478,14 @@ spec: additionalProperties: type: string description: |- - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. @@ -4498,15 +4496,15 @@ spec: portName: default: web description: |- - Port name used for the pods and governing service. + portName defines the port name used for the pods and governing service. Defaults to `web`. type: string priorityClassName: - description: Priority class assigned to the Pods + description: priorityClassName defines the priority class assigned to the Pods type: string prometheusRulesExcludedFromEnforce: description: |- - PrometheusRulesExcludedFromEnforce - list of Prometheus rules to be excluded from enforcing + prometheusRulesExcludedFromEnforce defines a list of Prometheus rules to be excluded from enforcing of adding namespace labels. Works only if enforcedNamespaceLabel set to true. Make sure both ruleNamespace and ruleName are set for each pair Deprecated: use excludedFromEnforcement instead. @@ -4517,10 +4515,10 @@ spec: namespace label for alerts and metrics. properties: ruleName: - description: Name of the excluded PrometheusRule object. + description: ruleName defines the name of the excluded PrometheusRule object. type: string ruleNamespace: - description: Namespace of the excluded PrometheusRule object. + description: ruleNamespace defines the namespace of the excluded PrometheusRule object. type: string required: - ruleName @@ -4529,7 +4527,7 @@ spec: type: array queryConfig: description: |- - Configures the list of Thanos Query endpoints from which to query metrics. + queryConfig defines the list of Thanos Query endpoints from which to query metrics. The configuration format is defined at https://thanos.io/tip/components/rule.md/#query-api @@ -4560,7 +4558,7 @@ spec: x-kubernetes-map-type: atomic queryEndpoints: description: |- - Configures the list of Thanos Query endpoints from which to query metrics. + queryEndpoints defines the list of Thanos Query endpoints from which to query metrics. For Thanos >= v0.11.0, it is recommended to use `queryConfig` instead. @@ -4570,7 +4568,7 @@ spec: type: array remoteWrite: description: |- - Defines the list of remote write configurations. + remoteWrite defines the list of remote write configurations. When the list isn't empty, the ruler is configured with stateless mode. @@ -4582,14 +4580,14 @@ spec: properties: authorization: description: |- - Authorization section for the URL. + authorization section for the URL. It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. Cannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`. properties: credentials: - description: Selects a key of a Secret in the namespace that contains the credentials for authentication. + description: credentials defines a key of a Secret in the namespace that contains the credentials for authentication. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4611,11 +4609,11 @@ spec: type: object x-kubernetes-map-type: atomic credentialsFile: - description: File to read a secret from, mutually exclusive with `credentials`. + description: credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. type: string type: description: |- - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -4624,14 +4622,14 @@ spec: type: object azureAd: description: |- - AzureAD for the URL. + azureAd for the URL. It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0. Cannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`. properties: cloud: - description: The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'. + description: cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'. enum: - AzureChina - AzureGovernment @@ -4639,28 +4637,28 @@ spec: type: string managedIdentity: description: |- - ManagedIdentity defines the Azure User-assigned Managed identity. + managedIdentity defines the Azure User-assigned Managed identity. Cannot be set at the same time as `oauth` or `sdk`. properties: clientId: - description: The client id + description: clientId defines defines the Azure User-assigned Managed identity. type: string required: - clientId type: object oauth: description: |- - OAuth defines the oauth config that is being used to authenticate. + oauth defines the oauth config that is being used to authenticate. Cannot be set at the same time as `managedIdentity` or `sdk`. It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0. properties: clientId: - description: '`clientID` is the clientId of the Azure Active Directory application that is being used to authenticate.' + description: clientId defines the clientId of the Azure Active Directory application that is being used to authenticate. minLength: 1 type: string clientSecret: - description: '`clientSecret` specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.' + description: clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4682,7 +4680,7 @@ spec: type: object x-kubernetes-map-type: atomic tenantId: - description: '`tenantId` is the tenant ID of the Azure Active Directory application that is being used to authenticate.' + description: tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate. minLength: 1 pattern: ^[0-9a-zA-Z-.]+$ type: string @@ -4693,27 +4691,27 @@ spec: type: object sdk: description: |- - SDK defines the Azure SDK config that is being used to authenticate. + sdk defines the Azure SDK config that is being used to authenticate. See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication Cannot be set at the same time as `oauth` or `managedIdentity`. It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0. properties: tenantId: - description: '`tenantId` is the tenant ID of the azure active directory application that is being used to authenticate.' + description: tenantId defines the tenant ID of the azure active directory application that is being used to authenticate. pattern: ^[0-9a-zA-Z-.]+$ type: string type: object type: object basicAuth: description: |- - BasicAuth configuration for the URL. + basicAuth configuration for the URL. Cannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`. properties: password: description: |- - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. properties: key: @@ -4737,7 +4735,7 @@ spec: x-kubernetes-map-type: atomic username: description: |- - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. properties: key: @@ -4762,23 +4760,22 @@ spec: type: object bearerToken: description: |- + bearerToken is deprecated: this will be removed in a future release. *Warning: this field shouldn't be used because the token value appears in clear-text. Prefer using `authorization`.* - - Deprecated: this will be removed in a future release. type: string bearerTokenFile: description: |- - File from which to read bearer token for the URL. + bearerTokenFile defines the file from which to read bearer token for the URL. Deprecated: this will be removed in a future release. Prefer using `authorization`. type: string enableHTTP2: - description: Whether to enable HTTP2. + description: enableHTTP2 defines whether to enable HTTP2. type: boolean followRedirects: description: |- - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. type: boolean @@ -4786,14 +4783,14 @@ spec: additionalProperties: type: string description: |- - Custom HTTP headers to be sent along with each remote write request. + headers defines the custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can't be overwritten. It requires Prometheus >= v2.25.0 or Thanos >= v0.24.0. type: object messageVersion: description: |- - The Remote Write message's version to use when writing to the endpoint. + messageVersion defines the Remote Write message's version to use when writing to the endpoint. `Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0. `Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0. @@ -4810,34 +4807,34 @@ spec: - V2.0 type: string metadataConfig: - description: MetadataConfig configures the sending of series metadata to the remote storage. + description: metadataConfig defines how to send a series metadata to the remote storage. properties: maxSamplesPerSend: description: |- - MaxSamplesPerSend is the maximum number of metadata samples per send. + maxSamplesPerSend defines the maximum number of metadata samples per send. It requires Prometheus >= v2.29.0. format: int32 minimum: -1 type: integer send: - description: Defines whether metric metadata is sent to the remote storage or not. + description: send defines whether metric metadata is sent to the remote storage or not. type: boolean sendInterval: - description: Defines how frequently metric metadata is sent to the remote storage. + description: sendInterval defines how frequently metric metadata is sent to the remote storage. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string type: object name: description: |- - The name of the remote write queue, it must be unique if specified. The + name of the remote write queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate queues. It requires Prometheus >= v2.15.0 or Thanos >= 0.24.0. type: string noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -4845,7 +4842,7 @@ spec: type: string oauth2: description: |- - OAuth2 configuration for the URL. + oauth2 configuration for the URL. It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0. @@ -4853,11 +4850,11 @@ spec: properties: clientId: description: |- - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -4879,7 +4876,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -4903,7 +4900,7 @@ spec: type: object clientSecret: description: |- - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. properties: key: @@ -4929,12 +4926,12 @@ spec: additionalProperties: type: string description: |- - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. type: object noProxy: description: |- - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. @@ -4966,7 +4963,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -4974,29 +4971,29 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string scopes: - description: '`scopes` defines the OAuth2 scopes used for the token request.' + description: scopes defines the OAuth2 scopes used for the token request. items: type: string type: array tlsConfig: description: |- - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5018,7 +5015,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5041,10 +5038,10 @@ spec: x-kubernetes-map-type: atomic type: object cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5066,7 +5063,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5089,10 +5086,10 @@ spec: x-kubernetes-map-type: atomic type: object insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5115,7 +5112,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -5126,7 +5123,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -5136,11 +5133,11 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object tokenUrl: - description: '`tokenURL` configures the URL to fetch the token from.' + description: tokenUrl defines the URL to fetch the token from. minLength: 1 type: string required: @@ -5174,7 +5171,7 @@ spec: x-kubernetes-map-type: atomic type: array description: |- - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. @@ -5182,82 +5179,70 @@ spec: x-kubernetes-map-type: atomic proxyFromEnvironment: description: |- - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. type: boolean proxyUrl: - description: '`proxyURL` defines the HTTP proxy server to use.' + description: proxyUrl defines the HTTP proxy server to use. pattern: ^(http|https|socks5)://.+$ type: string queueConfig: - description: QueueConfig allows tuning of the remote write queue parameters. + description: queueConfig allows tuning of the remote write queue parameters. properties: batchSendDeadline: - description: BatchSendDeadline is the maximum time a sample will wait in buffer. + description: batchSendDeadline defines the maximum time a sample will wait in buffer. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string capacity: description: |- - Capacity is the number of samples to buffer per shard before we start + capacity defines the number of samples to buffer per shard before we start dropping them. type: integer maxBackoff: - description: MaxBackoff is the maximum retry delay. + description: maxBackoff defines the maximum retry delay. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string maxRetries: - description: MaxRetries is the maximum number of times to retry a batch on recoverable errors. + description: maxRetries defines the maximum number of times to retry a batch on recoverable errors. type: integer maxSamplesPerSend: - description: MaxSamplesPerSend is the maximum number of samples per send. + description: maxSamplesPerSend defines the maximum number of samples per send. type: integer maxShards: - description: MaxShards is the maximum number of shards, i.e. amount of concurrency. + description: maxShards defines the maximum number of shards, i.e. amount of concurrency. type: integer minBackoff: - description: MinBackoff is the initial retry delay. Gets doubled for every retry. + description: minBackoff defines the initial retry delay. Gets doubled for every retry. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string minShards: - description: MinShards is the minimum number of shards, i.e. amount of concurrency. + description: minShards defines the minimum number of shards, i.e. amount of concurrency. type: integer retryOnRateLimit: description: |- - Retry upon receiving a 429 status code from the remote-write storage. + retryOnRateLimit defines the retry upon receiving a 429 status code from the remote-write storage. This is an *experimental feature*, it may change in any upcoming release in a breaking way. type: boolean sampleAgeLimit: description: |- - SampleAgeLimit drops samples older than the limit. + sampleAgeLimit drops samples older than the limit. It requires Prometheus >= v2.50.0 or Thanos >= v0.32.0. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string type: object remoteTimeout: - description: Timeout for requests to the remote write endpoint. + description: remoteTimeout defines the timeout for requests to the remote write endpoint. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string roundRobinDNS: - description: |- - When enabled: - - The remote-write mechanism will resolve the hostname via DNS. - - It will randomly select one of the resolved IP addresses and connect to it. - - When disabled (default behavior): - - The Go standard library will handle hostname resolution. - - It will attempt connections to each resolved IP address sequentially. - - Note: The connection timeout applies to the entire resolution and connection process. - If disabled, the timeout is distributed across all connection attempts. - - It requires Prometheus >= v3.1.0 or Thanos >= v0.38.0. + description: "roundRobinDNS controls the DNS resolution behavior for remote-write connections.\nWhen enabled:\n - The remote-write mechanism will resolve the hostname via DNS.\n - It will randomly select one of the resolved IP addresses and connect to it.\n\nWhen disabled (default behavior):\n - The Go standard library will handle hostname resolution.\n - It will attempt connections to each resolved IP address sequentially.\n\nNote: The connection timeout applies to the entire resolution and connection process.\n\n\tIf disabled, the timeout is distributed across all connection attempts.\n\nIt requires Prometheus >= v3.1.0 or Thanos >= v0.38.0." type: boolean sendExemplars: description: |- - Enables sending of exemplars over remote write. Note that + sendExemplars enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the `spec.enableFeatures` option for exemplars to be scraped in the first place. @@ -5265,14 +5250,14 @@ spec: type: boolean sendNativeHistograms: description: |- - Enables sending of native histograms, also known as sparse histograms + sendNativeHistograms enables sending of native histograms, also known as sparse histograms over remote write. It requires Prometheus >= v2.40.0 or Thanos >= v0.30.0. type: boolean sigv4: description: |- - Sigv4 allows to configures AWS's Signature Verification 4 for the URL. + sigv4 defines the AWS's Signature Verification 4 for the URL. It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. @@ -5280,7 +5265,7 @@ spec: properties: accessKey: description: |- - AccessKey is the AWS API key. If not specified, the environment variable + accessKey defines the AWS API key. If not specified, the environment variable `AWS_ACCESS_KEY_ID` is used. properties: key: @@ -5303,17 +5288,17 @@ spec: type: object x-kubernetes-map-type: atomic profile: - description: Profile is the named AWS profile used to authenticate. + description: profile defines the named AWS profile used to authenticate. type: string region: - description: Region is the AWS region. If blank, the region from the default credentials chain used. + description: region defines the AWS region. If blank, the region from the default credentials chain used. type: string roleArn: - description: RoleArn is the named AWS profile used to authenticate. + description: roleArn defines the named AWS profile used to authenticate. type: string secretKey: description: |- - SecretKey is the AWS API secret. If not specified, the environment + secretKey defines the AWS API secret. If not specified, the environment variable `AWS_SECRET_ACCESS_KEY` is used. properties: key: @@ -5337,13 +5322,13 @@ spec: x-kubernetes-map-type: atomic type: object tlsConfig: - description: TLS Config to use for the URL. + description: tlsConfig to use for the URL. properties: ca: - description: Certificate authority used when verifying server certificates. + description: ca defines the Certificate authority used when verifying server certificates. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5365,7 +5350,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5388,13 +5373,13 @@ spec: x-kubernetes-map-type: atomic type: object caFile: - description: Path to the CA cert in the Prometheus container to use for the targets. + description: caFile defines the path to the CA cert in the Prometheus container to use for the targets. type: string cert: - description: Client certificate to present when doing client-authentication. + description: cert defines the Client certificate to present when doing client-authentication. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -5416,7 +5401,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5439,16 +5424,16 @@ spec: x-kubernetes-map-type: atomic type: object certFile: - description: Path to the client cert file in the Prometheus container for the targets. + description: certFile defines the path to the client cert file in the Prometheus container for the targets. type: string insecureSkipVerify: - description: Disable target certificate validation. + description: insecureSkipVerify defines how to disable target certificate validation. type: boolean keyFile: - description: Path to the client key file in the Prometheus container for the targets. + description: keyFile defines the path to the client key file in the Prometheus container for the targets. type: string keySecret: - description: Secret containing the client key file for the targets. + description: keySecret defines the Secret containing the client key file for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -5471,7 +5456,7 @@ spec: x-kubernetes-map-type: atomic maxVersion: description: |- - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. enum: @@ -5482,7 +5467,7 @@ spec: type: string minVersion: description: |- - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. enum: @@ -5492,15 +5477,15 @@ spec: - TLS13 type: string serverName: - description: Used to verify the hostname for the targets. + description: serverName is used to verify the hostname for the targets. type: string type: object url: - description: The URL of the endpoint to send samples to. + description: url defines the URL of the endpoint to send samples to. minLength: 1 type: string writeRelabelConfigs: - description: The list of remote write relabel configurations. + description: writeRelabelConfigs defines the list of remote write relabel configurations. items: description: |- RelabelConfig allows dynamic rewriting of the label set for targets, alerts, @@ -5511,7 +5496,7 @@ spec: action: default: replace description: |- - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. @@ -5543,27 +5528,27 @@ spec: type: string modulus: description: |- - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. format: int64 type: integer regex: - description: Regular expression against which the extracted value is matched. + description: regex defines the regular expression against which the extracted value is matched. type: string replacement: description: |- - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. type: string separator: - description: Separator is the string between concatenated SourceLabels. + description: separator defines the string between concatenated SourceLabels. type: string sourceLabels: description: |- - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. items: @@ -5575,7 +5560,7 @@ spec: type: array targetLabel: description: |- - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -5589,16 +5574,16 @@ spec: type: object type: array replicas: - description: Number of thanos ruler instances to deploy. + description: replicas defines the number of thanos ruler instances to deploy. format: int32 type: integer resendDelay: - description: Minimum amount of time to wait before resending an alert to Alertmanager. + description: resendDelay defines the minimum amount of time to wait before resending an alert to Alertmanager. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string resources: description: |- - Resources defines the resource requirements for single Pods. + resources defines the resource requirements for single Pods. If not provided, no requests/limits will be set properties: claims: @@ -5660,7 +5645,7 @@ spec: retention: default: 24h description: |- - Time duration ThanosRuler shall retain data for. Default is '24h', and + retention defines the time duration ThanosRuler shall retain data for. Default is '24h', and must match the regular expression `[0-9]+(ms|s|m|h|d|w|y)` (milliseconds seconds minutes hours days weeks years). @@ -5669,25 +5654,25 @@ spec: pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string routePrefix: - description: The route prefix ThanosRuler registers HTTP handlers for. This allows thanos UI to be served on a sub-path. + description: routePrefix defines the route prefix ThanosRuler registers HTTP handlers for. This allows thanos UI to be served on a sub-path. type: string ruleConcurrentEval: description: |- - How many rules can be evaluated concurrently. + ruleConcurrentEval defines how many rules can be evaluated concurrently. It requires Thanos >= v0.37.0. format: int32 minimum: 1 type: integer ruleGracePeriod: description: |- - Minimum duration between alert and restored "for" state. + ruleGracePeriod defines the minimum duration between alert and restored "for" state. This is maintained only for alerts with configured "for" time greater than grace period. It requires Thanos >= v0.30.0. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string ruleNamespaceSelector: description: |- - Namespaces to be selected for Rules discovery. If unspecified, only + ruleNamespaceSelector defines the namespaces to be selected for Rules discovery. If unspecified, only the same namespace as the ThanosRuler object is in is used. properties: matchExpressions: @@ -5733,19 +5718,19 @@ spec: x-kubernetes-map-type: atomic ruleOutageTolerance: description: |- - Max time to tolerate prometheus outage for restoring "for" state of alert. + ruleOutageTolerance defines the max time to tolerate prometheus outage for restoring "for" state of alert. It requires Thanos >= v0.30.0. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string ruleQueryOffset: description: |- - The default rule group's query offset duration to use. + ruleQueryOffset defines the default rule group's query offset duration to use. It requires Thanos >= v0.38.0. pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$ type: string ruleSelector: description: |- - PrometheusRule objects to be selected for rule evaluation. An empty + ruleSelector defines the PrometheusRule objects to be selected for rule evaluation. An empty label selector matches all objects. A null label selector matches no objects. properties: @@ -5792,7 +5777,7 @@ spec: x-kubernetes-map-type: atomic securityContext: description: |- - SecurityContext holds pod-level security attributes and common container settings. + securityContext defines the pod-level security attributes and common container settings. This defaults to the default PodSecurityContext. properties: appArmorProfile: @@ -6021,12 +6006,12 @@ spec: type: object serviceAccountName: description: |- - ServiceAccountName is the name of the ServiceAccount to use to run the + serviceAccountName defines the name of the ServiceAccount to use to run the Thanos Ruler Pods. type: string serviceName: description: |- - The name of the service name used by the underlying StatefulSet(s) as the governing service. + serviceName defines the name of the service name used by the underlying StatefulSet(s) as the governing service. If defined, the Service must be created before the ThanosRuler resource in the same namespace and it must define a selector that matches the pod labels. If empty, the operator will create and manage a headless service named `thanos-ruler-operated` for ThanosRuler resources. When deploying multiple ThanosRuler resources in the same namespace, it is recommended to specify a different value for each. @@ -6034,14 +6019,14 @@ spec: minLength: 1 type: string storage: - description: Storage spec to specify how storage shall be used. + description: storage defines the specification of how storage shall be used. properties: disableMountSubPath: - description: 'Deprecated: subPath usage will be removed in a future release.' + description: 'disableMountSubPath deprecated: subPath usage will be removed in a future release.' type: boolean emptyDir: description: |- - EmptyDirVolumeSource to be used by the StatefulSet. + emptyDir to be used by the StatefulSet. If specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir properties: @@ -6068,7 +6053,7 @@ spec: type: object ephemeral: description: |- - EphemeralVolumeSource to be used by the StatefulSet. + ephemeral to be used by the StatefulSet. This is a beta field in k8s 1.21 and GA in 1.15. For lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes @@ -6304,7 +6289,7 @@ spec: type: object volumeClaimTemplate: description: |- - Defines the PVC spec to be used by the Prometheus StatefulSets. + volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets. The easiest way to use a volume that cannot be automatically provisioned is to use a label selector alongside manually created PersistentVolumes. properties: @@ -6324,13 +6309,13 @@ spec: More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: - description: EmbeddedMetadata contains metadata relevant to an EmbeddedResource. + description: metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource. properties: annotations: additionalProperties: type: string description: |- - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ @@ -6339,14 +6324,14 @@ spec: additionalProperties: type: string description: |- - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ type: object name: description: |- - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. @@ -6356,7 +6341,7 @@ spec: type: object spec: description: |- - Defines the desired characteristics of a volume requested by a pod author. + spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims properties: accessModes: @@ -6548,7 +6533,7 @@ spec: type: string type: object status: - description: 'Deprecated: this field is never set.' + description: 'status is deprecated: this field is never set.' properties: accessModes: description: |- @@ -6656,7 +6641,7 @@ spec: type: object terminationGracePeriodSeconds: description: |- - Optional duration in seconds the pod needs to terminate gracefully. + terminationGracePeriodSeconds defines the optional duration in seconds the pod needs to terminate gracefully. Value must be non-negative integer. The value zero indicates stop immediately via the kill signal (no opportunity to shut down) which may lead to data corruption. @@ -6665,7 +6650,7 @@ spec: minimum: 0 type: integer tolerations: - description: If specified, the pod's tolerations. + description: tolerations defines when specified, the pod's tolerations. items: description: |- The pod this Toleration is attached to tolerates any taint that matches @@ -6704,7 +6689,7 @@ spec: type: object type: array topologySpreadConstraints: - description: If specified, the pod's topology spread constraints. + description: topologySpreadConstraints defines the pod's topology spread constraints. items: description: TopologySpreadConstraint specifies how to spread matching pods among the given topology. properties: @@ -6876,7 +6861,7 @@ spec: type: array tracingConfig: description: |- - Configures tracing. + tracingConfig defines the tracing configuration. The configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration @@ -6908,7 +6893,7 @@ spec: x-kubernetes-map-type: atomic tracingConfigFile: description: |- - Configures the path of the tracing configuration file. + tracingConfigFile defines the path of the tracing configuration file. The configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration @@ -6920,11 +6905,11 @@ spec: This field takes precedence over `tracingConfig`. type: string version: - description: Version of Thanos to be deployed. + description: version of Thanos to be deployed. type: string volumeMounts: description: |- - VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. + volumeMounts defines how the configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the ruler container, that are generated as a result of StorageSpec objects. items: @@ -6990,7 +6975,7 @@ spec: type: array volumes: description: |- - Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will + volumes defines how configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects. items: description: Volume represents a named volume in a pod that may be accessed by any container in the pod. @@ -8789,22 +8774,22 @@ spec: type: object type: array web: - description: Defines the configuration of the ThanosRuler web server. + description: web defines the configuration of the ThanosRuler web server. properties: httpConfig: - description: Defines HTTP parameters for web server. + description: httpConfig defines HTTP parameters for web server. properties: headers: - description: List of headers that can be added to HTTP responses. + description: headers defines a list of headers that can be added to HTTP responses. properties: contentSecurityPolicy: description: |- - Set the Content-Security-Policy header to HTTP responses. + contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank. type: string strictTransportSecurity: description: |- - Set the Strict-Transport-Security header to HTTP responses. + strictTransportSecurity defines the Strict-Transport-Security header to HTTP responses. Unset if blank. Please make sure that you use this with care as this header might force browsers to load Prometheus and the other applications hosted on the same @@ -8813,7 +8798,7 @@ spec: type: string xContentTypeOptions: description: |- - Set the X-Content-Type-Options header to HTTP responses. + xContentTypeOptions defines the X-Content-Type-Options header to HTTP responses. Unset if blank. Accepted value is nosniff. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options enum: @@ -8822,7 +8807,7 @@ spec: type: string xFrameOptions: description: |- - Set the X-Frame-Options header to HTTP responses. + xFrameOptions defines the X-Frame-Options header to HTTP responses. Unset if blank. Accepted values are deny and sameorigin. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options enum: @@ -8832,31 +8817,31 @@ spec: type: string xXSSProtection: description: |- - Set the X-XSS-Protection header to all responses. + xXSSProtection defines the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection type: string type: object http2: description: |- - Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. + http2 enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. When TLSConfig is not configured, HTTP/2 will be disabled. Whenever the value of the field changes, a rolling update will be triggered. type: boolean type: object tlsConfig: - description: Defines the TLS parameters for HTTPS. + description: tlsConfig defines the TLS parameters for HTTPS. properties: cert: description: |- - Secret or ConfigMap containing the TLS certificate for the web server. + cert defines the Secret or ConfigMap containing the TLS certificate for the web server. Either `keySecret` or `keyFile` must be defined. It is mutually exclusive with `certFile`. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8878,7 +8863,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8902,7 +8887,7 @@ spec: type: object certFile: description: |- - Path to the TLS certificate file in the container for the web server. + certFile defines the path to the TLS certificate file in the container for the web server. Either `keySecret` or `keyFile` must be defined. @@ -8910,7 +8895,7 @@ spec: type: string cipherSuites: description: |- - List of supported cipher suites for TLS versions up to TLS 1.2. + cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2. If not defined, the Go default cipher suites are used. Available cipher suites are documented in the Go documentation: @@ -8920,13 +8905,13 @@ spec: type: array client_ca: description: |- - Secret or ConfigMap containing the CA certificate for client certificate + client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server. It is mutually exclusive with `clientCAFile`. properties: configMap: - description: ConfigMap containing data to use for the targets. + description: configMap defines the ConfigMap containing data to use for the targets. properties: key: description: The key to select. @@ -8948,7 +8933,7 @@ spec: type: object x-kubernetes-map-type: atomic secret: - description: Secret containing data to use for the targets. + description: secret defines the Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. @@ -8972,21 +8957,21 @@ spec: type: object clientAuthType: description: |- - The server policy for client TLS authentication. + clientAuthType defines the server policy for client TLS authentication. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType type: string clientCAFile: description: |- - Path to the CA certificate file for client certificate authentication to + clientCAFile defines the path to the CA certificate file for client certificate authentication to the server. It is mutually exclusive with `client_ca`. type: string curvePreferences: description: |- - Elliptic curves that will be used in an ECDHE handshake, in preference + curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the Go documentation: @@ -8996,7 +8981,7 @@ spec: type: array keyFile: description: |- - Path to the TLS private key file in the container for the web server. + keyFile defines the path to the TLS private key file in the container for the web server. If defined, either `cert` or `certFile` must be defined. @@ -9004,7 +8989,7 @@ spec: type: string keySecret: description: |- - Secret containing the TLS private key for the web server. + keySecret defines the secret containing the TLS private key for the web server. Either `cert` or `certFile` must be defined. @@ -9030,14 +9015,14 @@ spec: type: object x-kubernetes-map-type: atomic maxVersion: - description: Maximum TLS version that is acceptable. + description: maxVersion defines the Maximum TLS version that is acceptable. type: string minVersion: - description: Minimum TLS version that is acceptable. + description: minVersion defines the minimum TLS version that is acceptable. type: string preferServerCipherSuites: description: |- - Controls whether the server selects the client's most preferred cipher + preferServerCipherSuites defines whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in @@ -9048,18 +9033,18 @@ spec: type: object status: description: |- - Most recent observed status of the ThanosRuler cluster. Read-only. + status defines the most recent observed status of the ThanosRuler cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status properties: availableReplicas: description: |- - Total number of available pods (ready for at least minReadySeconds) + availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this ThanosRuler deployment. format: int32 type: integer conditions: - description: The current state of the ThanosRuler object. + description: conditions defines the current state of the ThanosRuler object. items: description: |- Condition represents the state of the resources associated with the @@ -9070,11 +9055,11 @@ spec: format: date-time type: string message: - description: Human-readable message indicating details for the condition's last transition. + description: message defines human-readable message indicating details for the condition's last transition. type: string observedGeneration: description: |- - ObservedGeneration represents the .metadata.generation that the + observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if `.metadata.generation` is currently 12, but the `.status.conditions[].observedGeneration` is 9, the condition is out of date with respect to the current state of the @@ -9082,14 +9067,14 @@ spec: format: int64 type: integer reason: - description: Reason for the condition's last transition. + description: reason for the condition's last transition. type: string status: - description: Status of the condition. + description: status of the condition. minLength: 1 type: string type: - description: Type of the condition being reported. + description: type of the condition being reported. minLength: 1 type: string required: @@ -9103,31 +9088,25 @@ spec: x-kubernetes-list-type: map paused: description: |- - Represents whether any actions on the underlying managed objects are + paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed. type: boolean replicas: description: |- - Total number of non-terminated pods targeted by this ThanosRuler deployment + replicas defines the total number of non-terminated pods targeted by this ThanosRuler deployment (their labels match the selector). format: int32 type: integer unavailableReplicas: - description: Total number of unavailable pods targeted by this ThanosRuler deployment. + description: unavailableReplicas defines the total number of unavailable pods targeted by this ThanosRuler deployment. format: int32 type: integer updatedReplicas: description: |- - Total number of non-terminated pods targeted by this ThanosRuler deployment + updatedReplicas defines the total number of non-terminated pods targeted by this ThanosRuler deployment that have the desired version spec. format: int32 type: integer - required: - - availableReplicas - - paused - - replicas - - unavailableReplicas - - updatedReplicas type: object required: - spec diff --git a/vendor/github.com/prometheus-operator/kube-prometheus/jsonnet/kube-prometheus/versions.json b/vendor/github.com/prometheus-operator/kube-prometheus/jsonnet/kube-prometheus/versions.json index 05cdeed7..43d3e8b5 100644 --- a/vendor/github.com/prometheus-operator/kube-prometheus/jsonnet/kube-prometheus/versions.json +++ b/vendor/github.com/prometheus-operator/kube-prometheus/jsonnet/kube-prometheus/versions.json @@ -2,7 +2,7 @@ "alertmanager": "0.28.1", "blackboxExporter": "0.27.0", "grafana": "12.1.0", - "kubeStateMetrics": "2.16.0", + "kubeStateMetrics": "2.17.0", "nodeExporter": "1.9.1", "prometheus": "3.5.0", "prometheusAdapter": "0.12.0", diff --git a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/alertmanagerconfigs-crd.json b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/alertmanagerconfigs-crd.json index 9c43b66a..ea8295d0 100644 --- a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/alertmanagerconfigs-crd.json +++ b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/alertmanagerconfigs-crd.json @@ -3,7 +3,7 @@ "kind": "CustomResourceDefinition", "metadata": { "annotations": { - "controller-gen.kubebuilder.io/version": "v0.18.0", + "controller-gen.kubebuilder.io/version": "v0.19.0", "operator.prometheus.io/version": "0.85.0" }, "name": "alertmanagerconfigs.monitoring.coreos.com" @@ -42,27 +42,27 @@ "type": "object" }, "spec": { - "description": "AlertmanagerConfigSpec is a specification of the desired behavior of the\nAlertmanager configuration.\nBy default, the Alertmanager configuration only applies to alerts for which\nthe `namespace` label is equal to the namespace of the AlertmanagerConfig\nresource (see the `.spec.alertmanagerConfigMatcherStrategy` field of the\nAlertmanager CRD).", + "description": "spec defines the specification of AlertmanagerConfigSpec", "properties": { "inhibitRules": { - "description": "List of inhibition rules. The rules will only apply to alerts matching\nthe resource's namespace.", + "description": "inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching\nthe resource's namespace.", "items": { "description": "InhibitRule defines an inhibition rule that allows to mute alerts when other\nalerts are already firing.\nSee https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule", "properties": { "equal": { - "description": "Labels that must have an equal value in the source and target alert for\nthe inhibition to take effect.", + "description": "equal defines labels that must have an equal value in the source and target alert\nfor the inhibition to take effect. This ensures related alerts are properly grouped.", "items": { "type": "string" }, "type": "array" }, "sourceMatch": { - "description": "Matchers for which one or more alerts have to exist for the inhibition\nto take effect. The operator enforces that the alert matches the\nresource's namespace.", + "description": "sourceMatch defines matchers for which one or more alerts have to exist for the inhibition\nto take effect. The operator enforces that the alert matches the resource's namespace.\nThese are the \"trigger\" alerts that cause other alerts to be inhibited.", "items": { "description": "Matcher defines how to match on alert's labels.", "properties": { "matchType": { - "description": "Match operation available with AlertManager >= v0.22.0 and\ntakes precedence over Regex (deprecated) if non-empty.", + "description": "matchType defines the match operation available with AlertManager >= v0.22.0.\nTakes precedence over Regex (deprecated) if non-empty.\nValid values: \"=\" (equality), \"!=\" (inequality), \"=~\" (regex match), \"!~\" (regex non-match).", "enum": [ "!=", "=", @@ -72,16 +72,16 @@ "type": "string" }, "name": { - "description": "Label to match.", + "description": "name defines the label to match.\nThis specifies which alert label should be evaluated.", "minLength": 1, "type": "string" }, "regex": { - "description": "Whether to match on equality (false) or regular-expression (true).\nDeprecated: for AlertManager >= v0.22.0, `matchType` should be used instead.", + "description": "regex defines whether to match on equality (false) or regular-expression (true).\nDeprecated: for AlertManager >= v0.22.0, `matchType` should be used instead.", "type": "boolean" }, "value": { - "description": "Label value to match.", + "description": "value defines the label value to match.\nThis is the expected value for the specified label.", "type": "string" } }, @@ -93,12 +93,12 @@ "type": "array" }, "targetMatch": { - "description": "Matchers that have to be fulfilled in the alerts to be muted. The\noperator enforces that the alert matches the resource's namespace.", + "description": "targetMatch defines matchers that have to be fulfilled in the alerts to be muted.\nThe operator enforces that the alert matches the resource's namespace.\nWhen these conditions are met, matching alerts will be inhibited (silenced).", "items": { "description": "Matcher defines how to match on alert's labels.", "properties": { "matchType": { - "description": "Match operation available with AlertManager >= v0.22.0 and\ntakes precedence over Regex (deprecated) if non-empty.", + "description": "matchType defines the match operation available with AlertManager >= v0.22.0.\nTakes precedence over Regex (deprecated) if non-empty.\nValid values: \"=\" (equality), \"!=\" (inequality), \"=~\" (regex match), \"!~\" (regex non-match).", "enum": [ "!=", "=", @@ -108,16 +108,16 @@ "type": "string" }, "name": { - "description": "Label to match.", + "description": "name defines the label to match.\nThis specifies which alert label should be evaluated.", "minLength": 1, "type": "string" }, "regex": { - "description": "Whether to match on equality (false) or regular-expression (true).\nDeprecated: for AlertManager >= v0.22.0, `matchType` should be used instead.", + "description": "regex defines whether to match on equality (false) or regular-expression (true).\nDeprecated: for AlertManager >= v0.22.0, `matchType` should be used instead.", "type": "boolean" }, "value": { - "description": "Label value to match.", + "description": "value defines the label value to match.\nThis is the expected value for the specified label.", "type": "string" } }, @@ -134,32 +134,32 @@ "type": "array" }, "muteTimeIntervals": { - "description": "List of MuteTimeInterval specifying when the routes should be muted.", + "description": "muteTimeIntervals defines the list of MuteTimeInterval specifying when the routes should be muted.", "items": { "description": "MuteTimeInterval specifies the periods in time when notifications will be muted", "properties": { "name": { - "description": "Name of the time interval", + "description": "name of the time interval", "type": "string" }, "timeIntervals": { - "description": "TimeIntervals is a list of TimeInterval", + "description": "timeIntervals defines a list of TimeInterval", "items": { "description": "TimeInterval describes intervals of time", "properties": { "daysOfMonth": { - "description": "DaysOfMonth is a list of DayOfMonthRange", + "description": "daysOfMonth defines a list of DayOfMonthRange", "items": { "description": "DayOfMonthRange is an inclusive range of days of the month beginning at 1", "properties": { "end": { - "description": "End of the inclusive range", + "description": "end of the inclusive range", "maximum": 31, "minimum": -31, "type": "integer" }, "start": { - "description": "Start of the inclusive range", + "description": "start of the inclusive range", "maximum": 31, "minimum": -31, "type": "integer" @@ -170,7 +170,7 @@ "type": "array" }, "months": { - "description": "Months is a list of MonthRange", + "description": "months defines a list of MonthRange", "items": { "description": "MonthRange is an inclusive range of months of the year beginning in January\nMonths can be specified by name (e.g 'January') by numerical month (e.g '1') or as an inclusive range (e.g 'January:March', '1:3', '1:March')", "pattern": "^((?i)january|february|march|april|may|june|july|august|september|october|november|december|1[0-2]|[1-9])(?:((:((?i)january|february|march|april|may|june|july|august|september|october|november|december|1[0-2]|[1-9]))$)|$)", @@ -179,17 +179,17 @@ "type": "array" }, "times": { - "description": "Times is a list of TimeRange", + "description": "times defines a list of TimeRange", "items": { "description": "TimeRange defines a start and end time in 24hr format", "properties": { "endTime": { - "description": "EndTime is the end time in 24hr format.", + "description": "endTime defines the end time in 24hr format.", "pattern": "^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)", "type": "string" }, "startTime": { - "description": "StartTime is the start time in 24hr format.", + "description": "startTime defines the start time in 24hr format.", "pattern": "^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)", "type": "string" } @@ -199,7 +199,7 @@ "type": "array" }, "weekdays": { - "description": "Weekdays is a list of WeekdayRange", + "description": "weekdays defines a list of WeekdayRange", "items": { "description": "WeekdayRange is an inclusive range of days of the week beginning on Sunday\nDays can be specified by name (e.g 'Sunday') or as an inclusive range (e.g 'Monday:Friday')", "pattern": "^((?i)sun|mon|tues|wednes|thurs|fri|satur)day(?:((:(sun|mon|tues|wednes|thurs|fri|satur)day)$)|$)", @@ -208,7 +208,7 @@ "type": "array" }, "years": { - "description": "Years is a list of YearRange", + "description": "years defines a list of YearRange", "items": { "description": "YearRange is an inclusive range of years", "pattern": "^2\\d{3}(?::2\\d{3}|$)", @@ -230,17 +230,17 @@ "type": "array" }, "receivers": { - "description": "List of receivers.", + "description": "receivers defines the list of receivers.", "items": { "description": "Receiver defines one or more notification integrations.", "properties": { "discordConfigs": { - "description": "List of Discord configurations.", + "description": "discordConfigs defines the list of Slack configurations.", "items": { "description": "DiscordConfig configures notifications via Discord.\nSee https://prometheus.io/docs/alerting/latest/configuration/#discord_config", "properties": { "apiURL": { - "description": "The secret's key that contains the Discord webhook URL.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "apiURL defines the secret's key that contains the Discord webhook URL.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -263,23 +263,23 @@ "x-kubernetes-map-type": "atomic" }, "avatarURL": { - "description": "The avatar url of the message sender.", + "description": "avatarURL defines the avatar url of the message sender.", "pattern": "^https?://.+$", "type": "string" }, "content": { - "description": "The template of the content's body.", + "description": "content defines the template of the content's body.", "minLength": 1, "type": "string" }, "httpConfig": { - "description": "HTTP client configuration.", + "description": "httpConfig defines the HTTP client configuration.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -302,17 +302,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -335,7 +335,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -361,7 +361,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -384,21 +384,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -421,7 +421,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -447,7 +447,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -473,11 +473,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -507,34 +507,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -557,7 +557,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -583,10 +583,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -609,7 +609,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -635,11 +635,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -662,7 +662,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -672,7 +672,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -682,14 +682,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -728,31 +728,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -775,7 +775,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -801,10 +801,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -827,7 +827,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -853,11 +853,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -880,7 +880,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -890,7 +890,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -900,7 +900,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -910,19 +910,19 @@ "type": "object" }, "message": { - "description": "The template of the message's body.", + "description": "message defines the template of the message's body.", "type": "string" }, "sendResolved": { - "description": "Whether or not to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" }, "title": { - "description": "The template of the message's title.", + "description": "title defines the template of the message's title.", "type": "string" }, "username": { - "description": "The username of the message sender.", + "description": "username defines the username of the message sender.", "minLength": 1, "type": "string" } @@ -935,16 +935,16 @@ "type": "array" }, "emailConfigs": { - "description": "List of Email configurations.", + "description": "emailConfigs defines the list of Email configurations.", "items": { "description": "EmailConfig configures notifications via Email.", "properties": { "authIdentity": { - "description": "The identity to use for authentication.", + "description": "authIdentity defines the identity to use for SMTP authentication.\nThis is typically used with PLAIN authentication mechanism.", "type": "string" }, "authPassword": { - "description": "The secret's key that contains the password to use for authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "authPassword defines the secret's key that contains the password to use for authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -967,7 +967,7 @@ "x-kubernetes-map-type": "atomic" }, "authSecret": { - "description": "The secret's key that contains the CRAM-MD5 secret.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "authSecret defines the secret's key that contains the CRAM-MD5 secret.\nThis is used for CRAM-MD5 authentication mechanism.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -990,25 +990,25 @@ "x-kubernetes-map-type": "atomic" }, "authUsername": { - "description": "The username to use for authentication.", + "description": "authUsername defines the username to use for SMTP authentication.\nThis is used for SMTP AUTH when the server requires authentication.", "type": "string" }, "from": { - "description": "The sender address.", + "description": "from defines the sender address for email notifications.\nThis appears as the \"From\" field in the email header.", "type": "string" }, "headers": { - "description": "Further headers email header key/value pairs. Overrides any headers\npreviously set by the notification implementation.", + "description": "headers defines additional email header key/value pairs.\nThese override any headers previously set by the notification implementation.", "items": { "description": "KeyValue defines a (key, value) tuple.", "properties": { "key": { - "description": "Key of the tuple.", + "description": "key defines the key of the tuple.\nThis is the identifier or name part of the key-value pair.", "minLength": 1, "type": "string" }, "value": { - "description": "Value of the tuple.", + "description": "value defines the value of the tuple.\nThis is the data or content associated with the key.", "type": "string" } }, @@ -1021,37 +1021,37 @@ "type": "array" }, "hello": { - "description": "The hostname to identify to the SMTP server.", + "description": "hello defines the hostname to identify to the SMTP server.\nThis is used in the SMTP HELO/EHLO command during the connection handshake.", "type": "string" }, "html": { - "description": "The HTML body of the email notification.", + "description": "html defines the HTML body of the email notification.\nThis allows for rich formatting in the email content.", "type": "string" }, "requireTLS": { - "description": "The SMTP TLS requirement.\nNote that Go does not support unencrypted connections to remote SMTP endpoints.", + "description": "requireTLS defines the SMTP TLS requirement.\nNote that Go does not support unencrypted connections to remote SMTP endpoints.", "type": "boolean" }, "sendResolved": { - "description": "Whether or not to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" }, "smarthost": { - "description": "The SMTP host and port through which emails are sent. E.g. example.com:25", + "description": "smarthost defines the SMTP host and port through which emails are sent.\nFormat should be \"hostname:port\", e.g. \"smtp.example.com:587\".", "type": "string" }, "text": { - "description": "The text body of the email notification.", + "description": "text defines the plain text body of the email notification.\nThis provides a fallback for email clients that don't support HTML.", "type": "string" }, "tlsConfig": { - "description": "TLS configuration", + "description": "tlsConfig defines the TLS configuration for SMTP connections.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1074,7 +1074,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1100,10 +1100,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1126,7 +1126,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1152,11 +1152,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1179,7 +1179,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -1189,7 +1189,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -1199,14 +1199,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "to": { - "description": "The email address to send notifications to.", + "description": "to defines the email address to send notifications to.\nThis is the recipient address for alert notifications.", "type": "string" } }, @@ -1215,18 +1215,18 @@ "type": "array" }, "msteamsConfigs": { - "description": "List of MSTeams configurations.\nIt requires Alertmanager >= 0.26.0.", + "description": "msteamsConfigs defines the list of MSTeams configurations.\nIt requires Alertmanager >= 0.26.0.", "items": { "description": "MSTeamsConfig configures notifications via Microsoft Teams.\nIt requires Alertmanager >= 0.26.0.", "properties": { "httpConfig": { - "description": "HTTP client configuration.", + "description": "httpConfig defines the HTTP client configuration for Teams webhook requests.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1249,17 +1249,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1282,7 +1282,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1308,7 +1308,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1331,21 +1331,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1368,7 +1368,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1394,7 +1394,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1420,11 +1420,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -1454,34 +1454,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1504,7 +1504,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1530,10 +1530,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1556,7 +1556,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1582,11 +1582,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1609,7 +1609,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -1619,7 +1619,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -1629,14 +1629,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -1675,31 +1675,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1722,7 +1722,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1748,10 +1748,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1774,7 +1774,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1800,11 +1800,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1827,7 +1827,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -1837,7 +1837,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -1847,7 +1847,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -1857,23 +1857,23 @@ "type": "object" }, "sendResolved": { - "description": "Whether to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" }, "summary": { - "description": "Message summary template.\nIt requires Alertmanager >= 0.27.0.", + "description": "summary defines the message summary template for Teams notifications.\nThis provides a brief overview that appears in Teams notification previews.\nIt requires Alertmanager >= 0.27.0.", "type": "string" }, "text": { - "description": "Message body template.", + "description": "text defines the message body template for Teams notifications.\nThis contains the detailed content of the Teams message.", "type": "string" }, "title": { - "description": "Message title template.", + "description": "title defines the message title template for Teams notifications.\nThis appears as the main heading of the Teams message card.", "type": "string" }, "webhookUrl": { - "description": "MSTeams webhook URL.", + "description": "webhookUrl defines the MSTeams webhook URL for sending notifications.\nThis is the incoming webhook URL configured in your Teams channel.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1904,18 +1904,18 @@ "type": "array" }, "msteamsv2Configs": { - "description": "List of MSTeamsV2 configurations.\nIt requires Alertmanager >= 0.28.0.", + "description": "msteamsv2Configs defines the list of MSTeamsV2 configurations.\nIt requires Alertmanager >= 0.28.0.", "items": { - "description": "MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows\nSee https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config\nIt requires Alertmanager >= 0.28.0.", + "description": "MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows.\nSee https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config\nIt requires Alertmanager >= 0.28.0.", "properties": { "httpConfig": { - "description": "HTTP client configuration.", + "description": "httpConfig defines the HTTP client configuration for Teams webhook requests.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1938,17 +1938,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1971,7 +1971,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1997,7 +1997,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2020,21 +2020,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2057,7 +2057,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2083,7 +2083,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2109,11 +2109,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -2143,34 +2143,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2193,7 +2193,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2219,10 +2219,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2245,7 +2245,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2271,11 +2271,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2298,7 +2298,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -2308,7 +2308,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -2318,14 +2318,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -2364,31 +2364,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2411,7 +2411,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2437,10 +2437,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2463,7 +2463,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2489,11 +2489,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2516,7 +2516,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -2526,7 +2526,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -2536,7 +2536,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -2546,21 +2546,21 @@ "type": "object" }, "sendResolved": { - "description": "Whether to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" }, "text": { - "description": "Message body template.", + "description": "text defines the message body template for adaptive card notifications.\nThis contains the detailed content displayed in the Teams adaptive card format.", "minLength": 1, "type": "string" }, "title": { - "description": "Message title template.", + "description": "title defines the message title template for adaptive card notifications.\nThis appears as the main heading in the Teams adaptive card.", "minLength": 1, "type": "string" }, "webhookURL": { - "description": "MSTeams incoming webhook URL.", + "description": "webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications.\nThis webhook must support the newer adaptive cards format required by Teams flows.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2588,21 +2588,21 @@ "type": "array" }, "name": { - "description": "Name of the receiver. Must be unique across all items from the list.", + "description": "name defiens the name of the receiver. Must be unique across all items from the list.", "minLength": 1, "type": "string" }, "opsgenieConfigs": { - "description": "List of OpsGenie configurations.", + "description": "opsgenieConfigs defines the list of OpsGenie configurations.", "items": { "description": "OpsGenieConfig configures notifications via OpsGenie.\nSee https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config", "properties": { "actions": { - "description": "Comma separated list of actions that will be available for the alert.", + "description": "actions defines a comma separated list of actions that will be available for the alert.\nThese appear as action buttons in the OpsGenie interface.", "type": "string" }, "apiKey": { - "description": "The secret's key that contains the OpsGenie API key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "apiKey defines the secret's key that contains the OpsGenie API key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2625,25 +2625,25 @@ "x-kubernetes-map-type": "atomic" }, "apiURL": { - "description": "The URL to send OpsGenie API requests to.", + "description": "apiURL defines the URL to send OpsGenie API requests to.\nWhen not specified, defaults to the standard OpsGenie API endpoint.", "type": "string" }, "description": { - "description": "Description of the incident.", + "description": "description defines the detailed description of the incident.\nThis provides additional context beyond the message field.", "type": "string" }, "details": { - "description": "A set of arbitrary key/value pairs that provide further detail about the incident.", + "description": "details defines a set of arbitrary key/value pairs that provide further detail about the incident.\nThese appear as additional fields in the OpsGenie alert.", "items": { "description": "KeyValue defines a (key, value) tuple.", "properties": { "key": { - "description": "Key of the tuple.", + "description": "key defines the key of the tuple.\nThis is the identifier or name part of the key-value pair.", "minLength": 1, "type": "string" }, "value": { - "description": "Value of the tuple.", + "description": "value defines the value of the tuple.\nThis is the data or content associated with the key.", "type": "string" } }, @@ -2656,17 +2656,17 @@ "type": "array" }, "entity": { - "description": "Optional field that can be used to specify which domain alert is related to.", + "description": "entity defines an optional field that can be used to specify which domain alert is related to.\nThis helps group related alerts together in OpsGenie.", "type": "string" }, "httpConfig": { - "description": "HTTP client configuration.", + "description": "httpConfig defines the HTTP client configuration for OpsGenie API requests.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2689,17 +2689,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2722,7 +2722,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2748,7 +2748,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2771,21 +2771,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2808,7 +2808,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2834,7 +2834,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2860,11 +2860,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -2894,34 +2894,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2944,7 +2944,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2970,10 +2970,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2996,7 +2996,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3022,11 +3022,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3049,7 +3049,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -3059,7 +3059,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -3069,14 +3069,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -3115,31 +3115,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3162,7 +3162,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3188,10 +3188,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3214,7 +3214,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3240,11 +3240,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3267,7 +3267,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -3277,7 +3277,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -3287,7 +3287,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -3297,37 +3297,44 @@ "type": "object" }, "message": { - "description": "Alert text limited to 130 characters.", + "description": "message defines the alert text limited to 130 characters.\nThis appears as the main alert title in OpsGenie.", "type": "string" }, "note": { - "description": "Additional alert note.", + "description": "note defines an additional alert note.\nThis provides supplementary information about the alert.", "type": "string" }, "priority": { - "description": "Priority level of alert. Possible values are P1, P2, P3, P4, and P5.", + "description": "priority defines the priority level of alert.\nPossible values are P1, P2, P3, P4, and P5, where P1 is highest priority.", "type": "string" }, "responders": { - "description": "List of responders responsible for notifications.", + "description": "responders defines the list of responders responsible for notifications.\nThese determine who gets notified when the alert is created.", "items": { "description": "OpsGenieConfigResponder defines a responder to an incident.\nOne of `id`, `name` or `username` has to be defined.", "properties": { "id": { - "description": "ID of the responder.", + "description": "id defines the unique identifier of the responder.\nThis corresponds to the responder's ID within OpsGenie.", "type": "string" }, "name": { - "description": "Name of the responder.", + "description": "name defines the display name of the responder.\nThis is used when the responder is identified by name rather than ID.", "type": "string" }, "type": { - "description": "Type of responder.", + "description": "type defines the type of responder.\nValid values include \"user\", \"team\", \"schedule\", and \"escalation\".\nThis determines how OpsGenie interprets the other identifier fields.", + "enum": [ + "team", + "teams", + "user", + "escalation", + "schedule" + ], "minLength": 1, "type": "string" }, "username": { - "description": "Username of the responder.", + "description": "username defines the username of the responder.\nThis is typically used for user-type responders when identifying by username.", "type": "string" } }, @@ -3339,19 +3346,19 @@ "type": "array" }, "sendResolved": { - "description": "Whether or not to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" }, "source": { - "description": "Backlink to the sender of the notification.", + "description": "source defines the backlink to the sender of the notification.\nThis helps identify where the alert originated from.", "type": "string" }, "tags": { - "description": "Comma separated list of tags attached to the notifications.", + "description": "tags defines a comma separated list of tags attached to the notifications.\nThese help categorize and filter alerts within OpsGenie.", "type": "string" }, "updateAlerts": { - "description": "Whether to update message and description of the alert in OpsGenie if it already exists\nBy default, the alert is never updated in OpsGenie, the new message only appears in activity log.", + "description": "updateAlerts defines Whether to update message and description of the alert in OpsGenie if it already exists\nBy default, the alert is never updated in OpsGenie, the new message only appears in activity log.", "type": "boolean" } }, @@ -3360,42 +3367,42 @@ "type": "array" }, "pagerdutyConfigs": { - "description": "List of PagerDuty configurations.", + "description": "pagerdutyConfigs defines the List of PagerDuty configurations.", "items": { "description": "PagerDutyConfig configures notifications via PagerDuty.\nSee https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config", "properties": { "class": { - "description": "The class/type of the event.", + "description": "class defines the class/type of the event.", "type": "string" }, "client": { - "description": "Client identification.", + "description": "client defines the client identification.", "type": "string" }, "clientURL": { - "description": "Backlink to the sender of notification.", + "description": "clientURL defines the backlink to the sender of notification.", "type": "string" }, "component": { - "description": "The part or component of the affected system that is broken.", + "description": "component defines the part or component of the affected system that is broken.", "type": "string" }, "description": { - "description": "Description of the incident.", + "description": "description of the incident.", "type": "string" }, "details": { - "description": "Arbitrary key/value pairs that provide further detail about the incident.", + "description": "details defines the arbitrary key/value pairs that provide further detail about the incident.", "items": { "description": "KeyValue defines a (key, value) tuple.", "properties": { "key": { - "description": "Key of the tuple.", + "description": "key defines the key of the tuple.\nThis is the identifier or name part of the key-value pair.", "minLength": 1, "type": "string" }, "value": { - "description": "Value of the tuple.", + "description": "value defines the value of the tuple.\nThis is the data or content associated with the key.", "type": "string" } }, @@ -3408,17 +3415,17 @@ "type": "array" }, "group": { - "description": "A cluster or grouping of sources.", + "description": "group defines a cluster or grouping of sources.", "type": "string" }, "httpConfig": { - "description": "HTTP client configuration.", + "description": "httpConfig defines the HTTP client configuration.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3441,17 +3448,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3474,7 +3481,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3500,7 +3507,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3523,21 +3530,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3560,7 +3567,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3586,7 +3593,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3612,11 +3619,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -3646,34 +3653,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3696,7 +3703,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3722,10 +3729,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3748,7 +3755,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3774,11 +3781,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3801,7 +3808,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -3811,7 +3818,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -3821,14 +3828,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -3867,31 +3874,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3914,7 +3921,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3940,10 +3947,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3966,7 +3973,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3992,11 +3999,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4019,7 +4026,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -4029,7 +4036,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -4039,7 +4046,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -4049,20 +4056,20 @@ "type": "object" }, "pagerDutyImageConfigs": { - "description": "A list of image details to attach that provide further detail about an incident.", + "description": "pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident.", "items": { "description": "PagerDutyImageConfig attaches images to an incident", "properties": { "alt": { - "description": "Alt is the optional alternative text for the image.", + "description": "alt is the optional alternative text for the image.", "type": "string" }, "href": { - "description": "Optional URL; makes the image a clickable link.", + "description": "href defines the optional URL; makes the image a clickable link.", "type": "string" }, "src": { - "description": "Src of the image being attached to the incident", + "description": "src of the image being attached to the incident", "type": "string" } }, @@ -4071,16 +4078,16 @@ "type": "array" }, "pagerDutyLinkConfigs": { - "description": "A list of link details to attach that provide further detail about an incident.", + "description": "pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident.", "items": { "description": "PagerDutyLinkConfig attaches text links to an incident", "properties": { "alt": { - "description": "Text that describes the purpose of the link, and can be used as the link's text.", + "description": "alt defines the text that describes the purpose of the link, and can be used as the link's text.", "type": "string" }, "href": { - "description": "Href is the URL of the link to be attached", + "description": "href defines the URL of the link to be attached", "type": "string" } }, @@ -4089,7 +4096,7 @@ "type": "array" }, "routingKey": { - "description": "The secret's key that contains the PagerDuty integration key (when using\nEvents API v2). Either this field or `serviceKey` needs to be defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "routingKey defines the secret's key that contains the PagerDuty integration key (when using\nEvents API v2). Either this field or `serviceKey` needs to be defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4112,11 +4119,11 @@ "x-kubernetes-map-type": "atomic" }, "sendResolved": { - "description": "Whether or not to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" }, "serviceKey": { - "description": "The secret's key that contains the PagerDuty service key (when using\nintegration type \"Prometheus\"). Either this field or `routingKey` needs to\nbe defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "serviceKey defines the secret's key that contains the PagerDuty service key (when using\nintegration type \"Prometheus\"). Either this field or `routingKey` needs to\nbe defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4139,15 +4146,15 @@ "x-kubernetes-map-type": "atomic" }, "severity": { - "description": "Severity of the incident.", + "description": "severity of the incident.", "type": "string" }, "source": { - "description": "Unique location of the affected system.", + "description": "source defines the unique location of the affected system.", "type": "string" }, "url": { - "description": "The URL to send requests to.", + "description": "url defines the URL to send requests to.", "type": "string" } }, @@ -4156,31 +4163,31 @@ "type": "array" }, "pushoverConfigs": { - "description": "List of Pushover configurations.", + "description": "pushoverConfigs defines the list of Pushover configurations.", "items": { "description": "PushoverConfig configures notifications via Pushover.\nSee https://prometheus.io/docs/alerting/latest/configuration/#pushover_config", "properties": { "device": { - "description": "The name of a device to send the notification to", + "description": "device defines the name of a specific device to send the notification to.\nIf not specified, the notification is sent to all user's devices.", "type": "string" }, "expire": { - "description": "How long your notification will continue to be retried for, unless the user\nacknowledges the notification.", + "description": "expire defines how long your notification will continue to be retried for,\nunless the user acknowledges the notification. Only applies to priority 2 notifications.", "pattern": "^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$", "type": "string" }, "html": { - "description": "Whether notification message is HTML or plain text.", + "description": "html defines whether notification message is HTML or plain text.\nWhen true, the message can include HTML formatting tags.", "type": "boolean" }, "httpConfig": { - "description": "HTTP client configuration.", + "description": "httpConfig defines the HTTP client configuration for Pushover API requests.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4203,17 +4210,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4236,7 +4243,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4262,7 +4269,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4285,21 +4292,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4322,7 +4329,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4348,7 +4355,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4374,11 +4381,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -4408,34 +4415,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4458,7 +4465,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4484,10 +4491,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4510,7 +4517,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4536,11 +4543,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4563,7 +4570,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -4573,7 +4580,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -4583,14 +4590,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -4629,31 +4636,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4676,7 +4683,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4702,10 +4709,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4728,7 +4735,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4754,11 +4761,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4781,7 +4788,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -4791,7 +4798,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -4801,7 +4808,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -4811,32 +4818,32 @@ "type": "object" }, "message": { - "description": "Notification message.", + "description": "message defines the notification message content.\nThis is the main body text of the Pushover notification.", "type": "string" }, "priority": { - "description": "Priority, see https://pushover.net/api#priority", + "description": "priority defines the notification priority level.\nSee https://pushover.net/api#priority for valid values and behavior.", "type": "string" }, "retry": { - "description": "How often the Pushover servers will send the same notification to the user.\nMust be at least 30 seconds.", + "description": "retry defines how often the Pushover servers will send the same notification to the user.\nMust be at least 30 seconds. Only applies to priority 2 notifications.", "pattern": "^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$", "type": "string" }, "sendResolved": { - "description": "Whether or not to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" }, "sound": { - "description": "The name of one of the sounds supported by device clients to override the user's default sound choice", + "description": "sound defines the name of one of the sounds supported by device clients.\nThis overrides the user's default sound choice for this notification.", "type": "string" }, "title": { - "description": "Notification title.", + "description": "title defines the notification title displayed in the Pushover message.\nThis appears as the bold header text in the notification.", "type": "string" }, "token": { - "description": "The secret's key that contains the registered application's API token, see https://pushover.net/apps.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither `token` or `tokenFile` is required.", + "description": "token defines the secret's key that contains the registered application's API token.\nSee https://pushover.net/apps for application registration.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither `token` or `tokenFile` is required.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4859,24 +4866,24 @@ "x-kubernetes-map-type": "atomic" }, "tokenFile": { - "description": "The token file that contains the registered application's API token, see https://pushover.net/apps.\nEither `token` or `tokenFile` is required.\nIt requires Alertmanager >= v0.26.0.", + "description": "tokenFile defines the token file that contains the registered application's API token.\nSee https://pushover.net/apps for application registration.\nEither `token` or `tokenFile` is required.\nIt requires Alertmanager >= v0.26.0.", "type": "string" }, "ttl": { - "description": "The time to live definition for the alert notification", + "description": "ttl defines the time to live for the alert notification.\nThis determines how long the notification remains active before expiring.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "url": { - "description": "A supplementary URL shown alongside the message.", + "description": "url defines a supplementary URL shown alongside the message.\nThis creates a clickable link within the Pushover notification.", "type": "string" }, "urlTitle": { - "description": "A title for supplementary URL, otherwise just the URL is shown", + "description": "urlTitle defines a title for the supplementary URL.\nIf not specified, the raw URL is shown instead.", "type": "string" }, "userKey": { - "description": "The secret's key that contains the recipient user's user key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither `userKey` or `userKeyFile` is required.", + "description": "userKey defines the secret's key that contains the recipient user's user key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither `userKey` or `userKeyFile` is required.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4899,7 +4906,7 @@ "x-kubernetes-map-type": "atomic" }, "userKeyFile": { - "description": "The user key file that contains the recipient user's user key.\nEither `userKey` or `userKeyFile` is required.\nIt requires Alertmanager >= v0.26.0.", + "description": "userKeyFile defines the user key file that contains the recipient user's user key.\nEither `userKey` or `userKeyFile` is required.\nIt requires Alertmanager >= v0.26.0.", "type": "string" } }, @@ -4908,27 +4915,27 @@ "type": "array" }, "rocketchatConfigs": { - "description": "List of RocketChat configurations.\nIt requires Alertmanager >= 0.28.0.", + "description": "rocketchatConfigs defines the list of RocketChat configurations.\nIt requires Alertmanager >= 0.28.0.", "items": { "description": "RocketChatConfig configures notifications via RocketChat.\nIt requires Alertmanager >= 0.28.0.", "properties": { "actions": { - "description": "Actions to include in the message.", + "description": "actions defines interactive actions to include in the message.\nThese appear as buttons that users can click to trigger responses.", "items": { "description": "RocketChatActionConfig defines actions for RocketChat messages.", "properties": { "msg": { - "description": "The message to send when the button is clicked.", + "description": "msg defines the message to send when the button is clicked.\nThis allows the button to post a predefined message to the channel.", "minLength": 1, "type": "string" }, "text": { - "description": "The button text.", + "description": "text defines the button text displayed to users.\nThis is the label that appears on the interactive button.", "minLength": 1, "type": "string" }, "url": { - "description": "The URL the button links to.", + "description": "url defines the URL the button links to when clicked.\nThis creates a clickable button that opens the specified URL.", "pattern": "^https?://.+$", "type": "string" } @@ -4939,41 +4946,41 @@ "type": "array" }, "apiURL": { - "description": "The API URL for RocketChat.\nDefaults to https://open.rocket.chat/ if not specified.", + "description": "apiURL defines the API URL for RocketChat.\nDefaults to https://open.rocket.chat/ if not specified.", "pattern": "^https?://.+$", "type": "string" }, "channel": { - "description": "The channel to send alerts to.", + "description": "channel defines the channel to send alerts to.\nThis can be a channel name (e.g., \"#alerts\") or a direct message recipient.", "minLength": 1, "type": "string" }, "color": { - "description": "The message color.", + "description": "color defines the message color displayed in RocketChat.\nThis appears as a colored bar alongside the message.", "minLength": 1, "type": "string" }, "emoji": { - "description": "If provided, the avatar will be displayed as an emoji.", + "description": "emoji defines the emoji to be displayed as an avatar.\nIf provided, this emoji will be used instead of the default avatar or iconURL.", "minLength": 1, "type": "string" }, "fields": { - "description": "Additional fields for the message.", + "description": "fields defines additional fields for the message attachment.\nThese appear as structured key-value pairs within the message.", "items": { "description": "RocketChatFieldConfig defines additional fields for RocketChat messages.", "properties": { "short": { - "description": "Whether this field should be a short field.", + "description": "short defines whether this field should be a short field.\nWhen true, the field may be displayed inline with other short fields to save space.", "type": "boolean" }, "title": { - "description": "The title of this field.", + "description": "title defines the title of this field.\nThis appears as bold text labeling the field content.", "minLength": 1, "type": "string" }, "value": { - "description": "The value of this field, displayed underneath the title value.", + "description": "value defines the value of this field, displayed underneath the title.\nThis contains the actual data or content for the field.", "minLength": 1, "type": "string" } @@ -4984,13 +4991,13 @@ "type": "array" }, "httpConfig": { - "description": "HTTP client configuration.", + "description": "httpConfig defines the HTTP client configuration for RocketChat API requests.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5013,17 +5020,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5046,7 +5053,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5072,7 +5079,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5095,21 +5102,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5132,7 +5139,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5158,7 +5165,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5184,11 +5191,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -5218,34 +5225,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5268,7 +5275,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5294,10 +5301,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5320,7 +5327,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5346,11 +5353,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5373,7 +5380,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -5383,7 +5390,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -5393,14 +5400,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -5439,31 +5446,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5486,7 +5493,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5512,10 +5519,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5538,7 +5545,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5564,11 +5571,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5591,7 +5598,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -5601,7 +5608,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -5611,7 +5618,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -5621,49 +5628,49 @@ "type": "object" }, "iconURL": { - "description": "Icon URL for the message.", + "description": "iconURL defines the icon URL for the message avatar.\nThis displays a custom image as the message sender's avatar.", "pattern": "^https?://.+$", "type": "string" }, "imageURL": { - "description": "Image URL for the message.", + "description": "imageURL defines the image URL to display within the message.\nThis embeds an image directly in the message attachment.", "pattern": "^https?://.+$", "type": "string" }, "linkNames": { - "description": "Whether to enable link names.", + "description": "linkNames defines whether to enable automatic linking of usernames and channels.\nWhen true, @username and #channel references become clickable links.", "type": "boolean" }, "sendResolved": { - "description": "Whether to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" }, "shortFields": { - "description": "Whether to use short fields.", + "description": "shortFields defines whether to use short fields in the message layout.\nWhen true, fields may be displayed side by side to save space.", "type": "boolean" }, "text": { - "description": "The message text to send, it is optional because of attachments.", + "description": "text defines the message text to send.\nThis is optional because attachments can be used instead of or alongside text.", "minLength": 1, "type": "string" }, "thumbURL": { - "description": "Thumbnail URL for the message.", + "description": "thumbURL defines the thumbnail URL for the message.\nThis displays a small thumbnail image alongside the message content.", "pattern": "^https?://.+$", "type": "string" }, "title": { - "description": "The message title.", + "description": "title defines the message title displayed prominently in the message.\nThis appears as bold text at the top of the message attachment.", "minLength": 1, "type": "string" }, "titleLink": { - "description": "The title link for the message.", + "description": "titleLink defines the URL that the title will link to when clicked.\nThis makes the message title clickable in the RocketChat interface.", "minLength": 1, "type": "string" }, "token": { - "description": "The sender token.", + "description": "token defines the sender token for RocketChat authentication.\nThis is the personal access token or bot token used to authenticate API requests.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5686,7 +5693,7 @@ "x-kubernetes-map-type": "atomic" }, "tokenID": { - "description": "The sender token ID.", + "description": "tokenID defines the sender token ID for RocketChat authentication.\nThis is the user ID associated with the token used for API requests.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5718,29 +5725,33 @@ "type": "array" }, "slackConfigs": { - "description": "List of Slack configurations.", + "description": "slackConfigs defines the list of Slack configurations.", "items": { "description": "SlackConfig configures notifications via Slack.\nSee https://prometheus.io/docs/alerting/latest/configuration/#slack_config", "properties": { "actions": { - "description": "A list of Slack actions that are sent with each notification.", + "description": "actions defines a list of Slack actions that are sent with each notification.", "items": { "description": "SlackAction configures a single Slack action that is sent with each\nnotification.\nSee https://api.slack.com/docs/message-attachments#action_fields and\nhttps://api.slack.com/docs/message-buttons for more information.", "properties": { "confirm": { - "description": "SlackConfirmationField protect users from destructive actions or\nparticularly distinguished decisions by asking them to confirm their button\nclick one more time.\nSee https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields\nfor more information.", + "description": "confirm defines an optional confirmation dialog that appears before the action is executed.\nWhen set, users must confirm their intent before the action proceeds.", "properties": { "dismissText": { + "description": "dismissText defines the label for the cancel button in the dialog.\nWhen not specified, defaults to \"Cancel\". This button cancels the action.", "type": "string" }, "okText": { + "description": "okText defines the label for the confirmation button in the dialog.\nWhen not specified, defaults to \"Okay\". This button proceeds with the action.", "type": "string" }, "text": { + "description": "text defines the main message displayed in the confirmation dialog.\nThis should be a clear question or statement asking the user to confirm their action.", "minLength": 1, "type": "string" }, "title": { + "description": "title defines the title text displayed at the top of the confirmation dialog.\nWhen not specified, a default title will be used.", "type": "string" } }, @@ -5750,23 +5761,29 @@ "type": "object" }, "name": { + "description": "name defines a unique identifier for the action within the message.\nThis value is sent back to your application when the action is triggered.", "type": "string" }, "style": { + "description": "style defines the visual appearance of the action element.\nValid values include \"default\", \"primary\" (green), and \"danger\" (red).", "type": "string" }, "text": { + "description": "text defines the user-visible label displayed on the action element.\nFor buttons, this is the button text. For select menus, this is the placeholder text.", "minLength": 1, "type": "string" }, "type": { + "description": "type defines the type of interactive component.\nCommon values include \"button\" for clickable buttons and \"select\" for dropdown menus.", "minLength": 1, "type": "string" }, "url": { + "description": "url defines the URL to open when the action is triggered.\nOnly applicable for button-type actions. When set, clicking the button opens this URL.", "type": "string" }, "value": { + "description": "value defines the payload sent when the action is triggered.\nThis data is included in the callback sent to your application.", "type": "string" } }, @@ -5779,7 +5796,7 @@ "type": "array" }, "apiURL": { - "description": "The secret's key that contains the Slack webhook URL.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "apiURL defines the secret's key that contains the Slack webhook URL.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5802,31 +5819,37 @@ "x-kubernetes-map-type": "atomic" }, "callbackId": { + "description": "callbackId defines an identifier for the message used in interactive components.", "type": "string" }, "channel": { - "description": "The channel or user to send notifications to.", + "description": "channel defines the channel or user to send notifications to.", "type": "string" }, "color": { + "description": "color defines the color of the left border of the Slack message attachment.\nCan be a hex color code (e.g., \"#ff0000\") or a predefined color name.", "type": "string" }, "fallback": { + "description": "fallback defines a plain-text summary of the attachment for clients that don't support attachments.", "type": "string" }, "fields": { - "description": "A list of Slack fields that are sent with each notification.", + "description": "fields defines a list of Slack fields that are sent with each notification.", "items": { "description": "SlackField configures a single Slack field that is sent with each notification.\nEach field must contain a title, value, and optionally, a boolean value to indicate if the field\nis short enough to be displayed next to other fields designated as short.\nSee https://api.slack.com/docs/message-attachments#fields for more information.", "properties": { "short": { + "description": "short determines whether this field can be displayed alongside other short fields.\nWhen true, Slack may display this field side by side with other short fields.\nWhen false or not specified, the field takes the full width of the message.", "type": "boolean" }, "title": { + "description": "title defines the label or header text displayed for this field.\nThis appears as bold text above the field value in the Slack message.", "minLength": 1, "type": "string" }, "value": { + "description": "value defines the content or data displayed for this field.\nThis appears below the title and can contain plain text or Slack markdown.", "minLength": 1, "type": "string" } @@ -5840,16 +5863,17 @@ "type": "array" }, "footer": { + "description": "footer defines small text displayed at the bottom of the message attachment.", "type": "string" }, "httpConfig": { - "description": "HTTP client configuration.", + "description": "httpConfig defines the HTTP client configuration.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5872,17 +5896,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5905,7 +5929,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5931,7 +5955,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5954,21 +5978,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5991,7 +6015,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6017,7 +6041,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6043,11 +6067,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -6077,34 +6101,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6127,7 +6151,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6153,10 +6177,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6179,7 +6203,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6205,11 +6229,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6232,7 +6256,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -6242,7 +6266,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -6252,14 +6276,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -6298,31 +6322,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6345,7 +6369,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6371,10 +6395,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6397,7 +6421,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6423,11 +6447,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6450,7 +6474,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -6460,7 +6484,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -6470,7 +6494,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -6480,46 +6504,58 @@ "type": "object" }, "iconEmoji": { + "description": "iconEmoji defines the emoji to use as the bot's avatar (e.g., \":ghost:\").", "type": "string" }, "iconURL": { + "description": "iconURL defines the URL to an image to use as the bot's avatar.", "type": "string" }, "imageURL": { + "description": "imageURL defines the URL to an image file that will be displayed inside the message attachment.", "type": "string" }, "linkNames": { + "description": "linkNames enables automatic linking of channel names and usernames in the message.\nWhen true, @channel and @username will be converted to clickable links.", "type": "boolean" }, "mrkdwnIn": { + "description": "mrkdwnIn defines which fields should be parsed as Slack markdown.\nValid values include \"pretext\", \"text\", and \"fields\".", "items": { "type": "string" }, "type": "array" }, "pretext": { + "description": "pretext defines optional text that appears above the message attachment block.", "type": "string" }, "sendResolved": { - "description": "Whether or not to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" }, "shortFields": { + "description": "shortFields determines whether fields are displayed in a compact format.\nWhen true, fields are shown side by side when possible.", "type": "boolean" }, "text": { + "description": "text defines the main text content of the Slack message attachment.", "type": "string" }, "thumbURL": { + "description": "thumbURL defines the URL to an image file that will be displayed as a thumbnail\non the right side of the message attachment.", "type": "string" }, "title": { + "description": "title defines the title text displayed in the Slack message attachment.", "type": "string" }, "titleLink": { + "description": "titleLink defines the URL that the title will link to when clicked.", "type": "string" }, "username": { + "description": "username defines the slack bot user name.", "type": "string" } }, @@ -6528,29 +6564,29 @@ "type": "array" }, "snsConfigs": { - "description": "List of SNS configurations", + "description": "snsConfigs defines the list of SNS configurations", "items": { "description": "SNSConfig configures notifications via AWS SNS.\nSee https://prometheus.io/docs/alerting/latest/configuration/#sns_configs", "properties": { "apiURL": { - "description": "The SNS API URL i.e. https://sns.us-east-2.amazonaws.com.\nIf not specified, the SNS API URL from the SNS SDK will be used.", + "description": "apiURL defines the SNS API URL, e.g. https://sns.us-east-2.amazonaws.com.\nIf not specified, the SNS API URL from the SNS SDK will be used.", "type": "string" }, "attributes": { "additionalProperties": { "type": "string" }, - "description": "SNS message attributes.", + "description": "attributes defines SNS message attributes as key-value pairs.\nThese provide additional metadata that can be used for message filtering and routing.", "type": "object" }, "httpConfig": { - "description": "HTTP client configuration.", + "description": "httpConfig defines the HTTP client configuration for SNS API requests.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6573,17 +6609,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6606,7 +6642,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6632,7 +6668,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6655,21 +6691,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6692,7 +6728,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6718,7 +6754,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6744,11 +6780,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -6778,34 +6814,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6828,7 +6864,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6854,10 +6890,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6880,7 +6916,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6906,11 +6942,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6933,7 +6969,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -6943,7 +6979,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -6953,14 +6989,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -6999,31 +7035,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7046,7 +7082,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7072,10 +7108,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7098,7 +7134,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7124,11 +7160,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7151,7 +7187,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -7161,7 +7197,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -7171,7 +7207,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -7181,22 +7217,22 @@ "type": "object" }, "message": { - "description": "The message content of the SNS notification.", + "description": "message defines the message content of the SNS notification.\nThis is the actual notification text that will be sent to subscribers.", "type": "string" }, "phoneNumber": { - "description": "Phone number if message is delivered via SMS in E.164 format.\nIf you don't specify this value, you must specify a value for the TopicARN or TargetARN.", + "description": "phoneNumber defines the phone number if message is delivered via SMS in E.164 format.\nIf you don't specify this value, you must specify a value for the TopicARN or TargetARN.", "type": "string" }, "sendResolved": { - "description": "Whether or not to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" }, "sigv4": { - "description": "Configures AWS's Signature Verification 4 signing process to sign requests.", + "description": "sigv4 configures AWS's Signature Verification 4 signing process to sign requests.\nThis includes AWS credentials and region configuration for authentication.", "properties": { "accessKey": { - "description": "AccessKey is the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.", + "description": "accessKey defines the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7219,19 +7255,19 @@ "x-kubernetes-map-type": "atomic" }, "profile": { - "description": "Profile is the named AWS profile used to authenticate.", + "description": "profile defines the named AWS profile used to authenticate.", "type": "string" }, "region": { - "description": "Region is the AWS region. If blank, the region from the default credentials chain used.", + "description": "region defines the AWS region. If blank, the region from the default credentials chain used.", "type": "string" }, "roleArn": { - "description": "RoleArn is the named AWS profile used to authenticate.", + "description": "roleArn defines the named AWS profile used to authenticate.", "type": "string" }, "secretKey": { - "description": "SecretKey is the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.", + "description": "secretKey defines the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7257,15 +7293,15 @@ "type": "object" }, "subject": { - "description": "Subject line when the message is delivered to email endpoints.", + "description": "subject defines the subject line when the message is delivered to email endpoints.\nThis field is only used when sending to email subscribers of an SNS topic.", "type": "string" }, "targetARN": { - "description": "The mobile platform endpoint ARN if message is delivered via mobile notifications.\nIf you don't specify this value, you must specify a value for the topic_arn or PhoneNumber.", + "description": "targetARN defines the mobile platform endpoint ARN if message is delivered via mobile notifications.\nIf you don't specify this value, you must specify a value for the TopicARN or PhoneNumber.", "type": "string" }, "topicARN": { - "description": "SNS topic ARN, i.e. arn:aws:sns:us-east-2:698519295917:My-Topic\nIf you don't specify this value, you must specify a value for the PhoneNumber or TargetARN.", + "description": "topicARN defines the SNS topic ARN, e.g. arn:aws:sns:us-east-2:698519295917:My-Topic.\nIf you don't specify this value, you must specify a value for the PhoneNumber or TargetARN.", "type": "string" } }, @@ -7274,16 +7310,16 @@ "type": "array" }, "telegramConfigs": { - "description": "List of Telegram configurations.", + "description": "telegramConfigs defines the list of Telegram configurations.", "items": { "description": "TelegramConfig configures notifications via Telegram.\nSee https://prometheus.io/docs/alerting/latest/configuration/#telegram_config", "properties": { "apiURL": { - "description": "The Telegram API URL i.e. https://api.telegram.org.\nIf not specified, default API URL will be used.", + "description": "apiURL defines the Telegram API URL, e.g. https://api.telegram.org.\nIf not specified, the default Telegram API URL will be used.", "type": "string" }, "botToken": { - "description": "Telegram bot token. It is mutually exclusive with `botTokenFile`.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\n\nEither `botToken` or `botTokenFile` is required.", + "description": "botToken defines the Telegram bot token. It is mutually exclusive with `botTokenFile`.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither `botToken` or `botTokenFile` is required.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7306,26 +7342,26 @@ "x-kubernetes-map-type": "atomic" }, "botTokenFile": { - "description": "File to read the Telegram bot token from. It is mutually exclusive with `botToken`.\nEither `botToken` or `botTokenFile` is required.\n\nIt requires Alertmanager >= v0.26.0.", + "description": "botTokenFile defines the file to read the Telegram bot token from.\nIt is mutually exclusive with `botToken`.\nEither `botToken` or `botTokenFile` is required.\nIt requires Alertmanager >= v0.26.0.", "type": "string" }, "chatID": { - "description": "The Telegram chat ID.", + "description": "chatID defines the Telegram chat ID where messages will be sent.\nThis can be a user ID, group ID, or channel ID (with @ prefix for public channels).", "format": "int64", "type": "integer" }, "disableNotifications": { - "description": "Disable telegram notifications", + "description": "disableNotifications controls whether Telegram notifications are sent silently.\nWhen true, users will receive the message without notification sounds.", "type": "boolean" }, "httpConfig": { - "description": "HTTP client configuration.", + "description": "httpConfig defines the HTTP client configuration for Telegram API requests.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7348,17 +7384,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7381,7 +7417,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7407,7 +7443,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7430,21 +7466,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7467,7 +7503,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7493,7 +7529,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7519,11 +7555,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -7553,34 +7589,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7603,7 +7639,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7629,10 +7665,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7655,7 +7691,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7681,11 +7717,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7708,7 +7744,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -7718,7 +7754,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -7728,14 +7764,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -7774,31 +7810,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7821,7 +7857,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7847,10 +7883,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7873,7 +7909,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7899,11 +7935,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7926,7 +7962,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -7936,7 +7972,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -7946,7 +7982,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -7956,16 +7992,16 @@ "type": "object" }, "message": { - "description": "Message template", + "description": "message defines the message template for the Telegram notification.\nThis is the content that will be sent to the specified chat.", "type": "string" }, "messageThreadID": { - "description": "The Telegram Group Topic ID.\nIt requires Alertmanager >= 0.26.0.", + "description": "messageThreadID defines the Telegram Group Topic ID for threaded messages.\nThis allows sending messages to specific topics within Telegram groups.\nIt requires Alertmanager >= 0.26.0.", "format": "int64", "type": "integer" }, "parseMode": { - "description": "Parse mode for telegram message", + "description": "parseMode defines the parse mode for telegram message formatting.\nValid values are \"MarkdownV2\", \"Markdown\", and \"HTML\".\nThis determines how text formatting is interpreted in the message.", "enum": [ "MarkdownV2", "Markdown", @@ -7974,7 +8010,7 @@ "type": "string" }, "sendResolved": { - "description": "Whether to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" } }, @@ -7986,12 +8022,12 @@ "type": "array" }, "victoropsConfigs": { - "description": "List of VictorOps configurations.", + "description": "victoropsConfigs defines the list of VictorOps configurations.", "items": { "description": "VictorOpsConfig configures notifications via VictorOps.\nSee https://prometheus.io/docs/alerting/latest/configuration/#victorops_config", "properties": { "apiKey": { - "description": "The secret's key that contains the API key to use when talking to the VictorOps API.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "apiKey defines the secret's key that contains the API key to use when talking to the VictorOps API.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8014,21 +8050,21 @@ "x-kubernetes-map-type": "atomic" }, "apiUrl": { - "description": "The VictorOps API URL.", + "description": "apiUrl defines the VictorOps API URL.\nWhen not specified, defaults to the standard VictorOps API endpoint.", "type": "string" }, "customFields": { - "description": "Additional custom fields for notification.", + "description": "customFields defines additional custom fields for notification.\nThese provide extra metadata that will be included with the VictorOps incident.", "items": { "description": "KeyValue defines a (key, value) tuple.", "properties": { "key": { - "description": "Key of the tuple.", + "description": "key defines the key of the tuple.\nThis is the identifier or name part of the key-value pair.", "minLength": 1, "type": "string" }, "value": { - "description": "Value of the tuple.", + "description": "value defines the value of the tuple.\nThis is the data or content associated with the key.", "type": "string" } }, @@ -8041,17 +8077,17 @@ "type": "array" }, "entityDisplayName": { - "description": "Contains summary of the alerted problem.", + "description": "entityDisplayName contains a summary of the alerted problem.\nThis appears as the main title or identifier for the incident.", "type": "string" }, "httpConfig": { - "description": "The HTTP client's configuration.", + "description": "httpConfig defines the HTTP client's configuration for VictorOps API requests.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8074,17 +8110,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8107,7 +8143,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8133,7 +8169,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8156,21 +8192,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8193,7 +8229,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8219,7 +8255,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8245,11 +8281,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -8279,34 +8315,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8329,7 +8365,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8355,10 +8391,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8381,7 +8417,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8407,11 +8443,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8434,7 +8470,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -8444,7 +8480,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -8454,14 +8490,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -8500,31 +8536,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8547,7 +8583,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8573,10 +8609,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8599,7 +8635,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8625,11 +8661,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8652,7 +8688,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -8662,7 +8698,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -8672,7 +8708,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -8682,23 +8718,23 @@ "type": "object" }, "messageType": { - "description": "Describes the behavior of the alert (CRITICAL, WARNING, INFO).", + "description": "messageType describes the behavior of the alert.\nValid values are \"CRITICAL\", \"WARNING\", and \"INFO\".", "type": "string" }, "monitoringTool": { - "description": "The monitoring tool the state message is from.", + "description": "monitoringTool defines the monitoring tool the state message is from.\nThis helps identify the source system that generated the alert.", "type": "string" }, "routingKey": { - "description": "A key used to map the alert to a team.", + "description": "routingKey defines a key used to map the alert to a team.\nThis determines which VictorOps team will receive the alert notification.", "type": "string" }, "sendResolved": { - "description": "Whether or not to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" }, "stateMessage": { - "description": "Contains long explanation of the alerted problem.", + "description": "stateMessage contains a long explanation of the alerted problem.\nThis provides detailed context about the incident.", "type": "string" } }, @@ -8707,23 +8743,23 @@ "type": "array" }, "webexConfigs": { - "description": "List of Webex configurations.", + "description": "webexConfigs defines the list of Webex configurations.", "items": { "description": "WebexConfig configures notification via Cisco Webex\nSee https://prometheus.io/docs/alerting/latest/configuration/#webex_config", "properties": { "apiURL": { - "description": "The Webex Teams API URL i.e. https://webexapis.com/v1/messages\nProvide if different from the default API URL.", + "description": "apiURL defines the Webex Teams API URL i.e. https://webexapis.com/v1/messages", "pattern": "^https?://.+$", "type": "string" }, "httpConfig": { - "description": "The HTTP client's configuration.\nYou must supply the bot token via the `httpConfig.authorization` field.", + "description": "httpConfig defines the HTTP client's configuration.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8746,17 +8782,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8779,7 +8815,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8805,7 +8841,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8828,21 +8864,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8865,7 +8901,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8891,7 +8927,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8917,11 +8953,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -8951,34 +8987,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9001,7 +9037,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9027,10 +9063,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9053,7 +9089,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9079,11 +9115,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9106,7 +9142,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -9116,7 +9152,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -9126,14 +9162,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -9172,31 +9208,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9219,7 +9255,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9245,10 +9281,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9271,7 +9307,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9297,11 +9333,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9324,7 +9360,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -9334,7 +9370,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -9344,7 +9380,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -9354,16 +9390,16 @@ "type": "object" }, "message": { - "description": "Message template", + "description": "message defines the message template", "type": "string" }, "roomID": { - "description": "ID of the Webex Teams room where to send the messages.", + "description": "roomID defines the ID of the Webex Teams room where to send the messages.", "minLength": 1, "type": "string" }, "sendResolved": { - "description": "Whether to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" } }, @@ -9375,18 +9411,18 @@ "type": "array" }, "webhookConfigs": { - "description": "List of webhook configurations.", + "description": "webhookConfigs defines the List of webhook configurations.", "items": { "description": "WebhookConfig configures notifications via a generic receiver supporting the webhook payload.\nSee https://prometheus.io/docs/alerting/latest/configuration/#webhook_config", "properties": { "httpConfig": { - "description": "HTTP client configuration.", + "description": "httpConfig defines the HTTP client configuration for webhook requests.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9409,17 +9445,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9442,7 +9478,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9468,7 +9504,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9491,21 +9527,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9528,7 +9564,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9554,7 +9590,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9580,11 +9616,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -9614,34 +9650,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9664,7 +9700,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9690,10 +9726,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9716,7 +9752,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9742,11 +9778,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9769,7 +9805,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -9779,7 +9815,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -9789,14 +9825,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -9835,31 +9871,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9882,7 +9918,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9908,10 +9944,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9934,7 +9970,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9960,11 +9996,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9987,7 +10023,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -9997,7 +10033,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -10007,7 +10043,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -10017,26 +10053,26 @@ "type": "object" }, "maxAlerts": { - "description": "Maximum number of alerts to be sent per webhook message. When 0, all alerts are included.", + "description": "maxAlerts defines the maximum number of alerts to be sent per webhook message.\nWhen 0, all alerts are included in the webhook payload.", "format": "int32", "minimum": 0, "type": "integer" }, "sendResolved": { - "description": "Whether or not to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" }, "timeout": { - "description": "The maximum time to wait for a webhook request to complete, before failing the\nrequest and allowing it to be retried.\nIt requires Alertmanager >= v0.28.0.", + "description": "timeout defines the maximum time to wait for a webhook request to complete,\nbefore failing the request and allowing it to be retried.\nIt requires Alertmanager >= v0.28.0.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "url": { - "description": "The URL to send HTTP POST requests to. `urlSecret` takes precedence over\n`url`. One of `urlSecret` and `url` should be defined.", + "description": "url defines the URL to send HTTP POST requests to.\nurlSecret takes precedence over url. One of urlSecret and url should be defined.", "type": "string" }, "urlSecret": { - "description": "The secret's key that contains the webhook URL to send HTTP requests to.\n`urlSecret` takes precedence over `url`. One of `urlSecret` and `url`\nshould be defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "urlSecret defines the secret's key that contains the webhook URL to send HTTP requests to.\nurlSecret takes precedence over url. One of urlSecret and url should be defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10064,15 +10100,16 @@ "type": "array" }, "wechatConfigs": { - "description": "List of WeChat configurations.", + "description": "wechatConfigs defines the list of WeChat configurations.", "items": { "description": "WeChatConfig configures notifications via WeChat.\nSee https://prometheus.io/docs/alerting/latest/configuration/#wechat_config", "properties": { "agentID": { + "description": "agentID defines the application agent ID within WeChat Work.\nThis identifies which WeChat Work application will send the notifications.", "type": "string" }, "apiSecret": { - "description": "The secret's key that contains the WeChat API key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "apiSecret defines the secret's key that contains the WeChat API key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10095,21 +10132,21 @@ "x-kubernetes-map-type": "atomic" }, "apiURL": { - "description": "The WeChat API URL.", + "description": "apiURL defines the WeChat API URL.\nWhen not specified, defaults to the standard WeChat Work API endpoint.", "type": "string" }, "corpID": { - "description": "The corp id for authentication.", + "description": "corpID defines the corp id for authentication.\nThis is the unique identifier for your WeChat Work organization.", "type": "string" }, "httpConfig": { - "description": "HTTP client configuration.", + "description": "httpConfig defines the HTTP client configuration for WeChat API requests.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10132,17 +10169,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10165,7 +10202,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10191,7 +10228,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10214,21 +10251,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects specifies whether the client should follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10251,7 +10288,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10277,7 +10314,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10303,11 +10340,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -10337,34 +10374,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10387,7 +10424,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10413,10 +10450,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10439,7 +10476,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10465,11 +10502,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10492,7 +10529,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -10502,7 +10539,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -10512,14 +10549,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -10558,31 +10595,31 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyURL": { - "description": "Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.", + "description": "proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.", "type": "string" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10605,7 +10642,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10631,10 +10668,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10657,7 +10694,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10683,11 +10720,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10710,7 +10747,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -10720,7 +10757,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -10730,7 +10767,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -10740,23 +10777,27 @@ "type": "object" }, "message": { - "description": "API request data as defined by the WeChat API.", + "description": "message defines the API request data as defined by the WeChat API.\nThis contains the actual notification content to be sent.", "type": "string" }, "messageType": { + "description": "messageType defines the type of message to send.\nValid values include \"text\", \"markdown\", and other WeChat Work supported message types.", "type": "string" }, "sendResolved": { - "description": "Whether or not to notify about resolved alerts.", + "description": "sendResolved defines whether or not to notify about resolved alerts.", "type": "boolean" }, "toParty": { + "description": "toParty defines the target department(s) to receive the notification.\nCan be a single department ID or multiple department IDs separated by '|'.", "type": "string" }, "toTag": { + "description": "toTag defines the target tag(s) to receive the notification.\nCan be a single tag ID or multiple tag IDs separated by '|'.", "type": "string" }, "toUser": { + "description": "toUser defines the target user(s) to receive the notification.\nCan be a single user ID or multiple user IDs separated by '|'.", "type": "string" } }, @@ -10773,41 +10814,41 @@ "type": "array" }, "route": { - "description": "The Alertmanager route definition for alerts matching the resource's\nnamespace. If present, it will be added to the generated Alertmanager\nconfiguration as a first-level route.", + "description": "route defines the Alertmanager route definition for alerts matching the resource's\nnamespace. If present, it will be added to the generated Alertmanager\nconfiguration as a first-level route.", "properties": { "activeTimeIntervals": { - "description": "ActiveTimeIntervals is a list of MuteTimeInterval names when this route should be active.", + "description": "activeTimeIntervals is a list of MuteTimeInterval names when this route should be active.", "items": { "type": "string" }, "type": "array" }, "continue": { - "description": "Boolean indicating whether an alert should continue matching subsequent\nsibling nodes. It will always be overridden to true for the first-level\nroute by the Prometheus operator.", + "description": "continue defines the boolean indicating whether an alert should continue matching subsequent\nsibling nodes. It will always be overridden to true for the first-level\nroute by the Prometheus operator.", "type": "boolean" }, "groupBy": { - "description": "List of labels to group by.\nLabels must not be repeated (unique list).\nSpecial label \"...\" (aggregate by all possible labels), if provided, must be the only element in the list.", + "description": "groupBy defines the list of labels to group by.\nLabels must not be repeated (unique list).\nSpecial label \"...\" (aggregate by all possible labels), if provided, must be the only element in the list.", "items": { "type": "string" }, "type": "array" }, "groupInterval": { - "description": "How long to wait before sending an updated notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: \"5m\"", + "description": "groupInterval defines how long to wait before sending an updated notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: \"5m\"", "type": "string" }, "groupWait": { - "description": "How long to wait before sending the initial notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: \"30s\"", + "description": "groupWait defines how long to wait before sending the initial notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: \"30s\"", "type": "string" }, "matchers": { - "description": "List of matchers that the alert's labels should match. For the first\nlevel route, the operator removes any existing equality and regexp\nmatcher on the `namespace` label and adds a `namespace: ` matcher.", + "description": "matchers defines the list of matchers that the alert's labels should match. For the first\nlevel route, the operator removes any existing equality and regexp\nmatcher on the `namespace` label and adds a `namespace: ` matcher.", "items": { "description": "Matcher defines how to match on alert's labels.", "properties": { "matchType": { - "description": "Match operation available with AlertManager >= v0.22.0 and\ntakes precedence over Regex (deprecated) if non-empty.", + "description": "matchType defines the match operation available with AlertManager >= v0.22.0.\nTakes precedence over Regex (deprecated) if non-empty.\nValid values: \"=\" (equality), \"!=\" (inequality), \"=~\" (regex match), \"!~\" (regex non-match).", "enum": [ "!=", "=", @@ -10817,16 +10858,16 @@ "type": "string" }, "name": { - "description": "Label to match.", + "description": "name defines the label to match.\nThis specifies which alert label should be evaluated.", "minLength": 1, "type": "string" }, "regex": { - "description": "Whether to match on equality (false) or regular-expression (true).\nDeprecated: for AlertManager >= v0.22.0, `matchType` should be used instead.", + "description": "regex defines whether to match on equality (false) or regular-expression (true).\nDeprecated: for AlertManager >= v0.22.0, `matchType` should be used instead.", "type": "boolean" }, "value": { - "description": "Label value to match.", + "description": "value defines the label value to match.\nThis is the expected value for the specified label.", "type": "string" } }, @@ -10838,22 +10879,22 @@ "type": "array" }, "muteTimeIntervals": { - "description": "Note: this comment applies to the field definition above but appears\nbelow otherwise it gets included in the generated manifest.\nCRD schema doesn't support self-referential types for now (see\nhttps://github.com/kubernetes/kubernetes/issues/62872). We have to use\nan alternative type to circumvent the limitation. The downside is that\nthe Kube API can't validate the data beyond the fact that it is a valid\nJSON representation.\nMuteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,", + "description": "muteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,", "items": { "type": "string" }, "type": "array" }, "receiver": { - "description": "Name of the receiver for this route. If not empty, it should be listed in\nthe `receivers` field.", + "description": "receiver defines the name of the receiver for this route. If not empty, it should be listed in\nthe `receivers` field.", "type": "string" }, "repeatInterval": { - "description": "How long to wait before repeating the last notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: \"4h\"", + "description": "repeatInterval defines how long to wait before repeating the last notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: \"4h\"", "type": "string" }, "routes": { - "description": "Child routes.", + "description": "routes defines the child routes.", "items": { "x-kubernetes-preserve-unknown-fields": true }, diff --git a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/alertmanagerconfigs-v1beta1-crd.libsonnet b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/alertmanagerconfigs-v1beta1-crd.libsonnet index 807f1550..d5514c8b 100644 --- a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/alertmanagerconfigs-v1beta1-crd.libsonnet +++ b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/alertmanagerconfigs-v1beta1-crd.libsonnet @@ -18,27 +18,27 @@ type: 'object', }, spec: { - description: 'AlertmanagerConfigSpec is a specification of the desired behavior of the Alertmanager configuration.\nBy definition, the Alertmanager configuration only applies to alerts for which\nthe `namespace` label is equal to the namespace of the AlertmanagerConfig resource.', + description: 'spec defines the specification of AlertmanagerConfigSpec', properties: { inhibitRules: { - description: "List of inhibition rules. The rules will only apply to alerts matching\nthe resource's namespace.", + description: "inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching\nthe resource's namespace.", items: { description: 'InhibitRule defines an inhibition rule that allows to mute alerts when other\nalerts are already firing.\nSee https://prometheus.io/docs/alerting/latest/configuration/#inhibit_rule', properties: { equal: { - description: 'Labels that must have an equal value in the source and target alert for\nthe inhibition to take effect.', + description: 'equal defines labels that must have an equal value in the source and target alert\nfor the inhibition to take effect. This ensures related alerts are properly grouped.', items: { type: 'string', }, type: 'array', }, sourceMatch: { - description: "Matchers for which one or more alerts have to exist for the inhibition\nto take effect. The operator enforces that the alert matches the\nresource's namespace.", + description: "sourceMatch defines matchers for which one or more alerts have to exist for the inhibition\nto take effect. The operator enforces that the alert matches the resource's namespace.\nThese are the \"trigger\" alerts that cause other alerts to be inhibited.", items: { description: "Matcher defines how to match on alert's labels.", properties: { matchType: { - description: 'Match operator, one of `=` (equal to), `!=` (not equal to), `=~` (regex\nmatch) or `!~` (not regex match).\nNegative operators (`!=` and `!~`) require Alertmanager >= v0.22.0.', + description: 'matchType defines the match operation available with AlertManager >= v0.22.0.\nTakes precedence over Regex (deprecated) if non-empty.\nValid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match).', enum: [ '!=', '=', @@ -48,12 +48,12 @@ type: 'string', }, name: { - description: 'Label to match.', + description: 'name defines the label to match.\nThis specifies which alert label should be evaluated.', minLength: 1, type: 'string', }, value: { - description: 'Label value to match.', + description: 'value defines the label value to match.\nThis is the expected value for the specified label.', type: 'string', }, }, @@ -65,12 +65,12 @@ type: 'array', }, targetMatch: { - description: "Matchers that have to be fulfilled in the alerts to be muted. The\noperator enforces that the alert matches the resource's namespace.", + description: "targetMatch defines matchers that have to be fulfilled in the alerts to be muted.\nThe operator enforces that the alert matches the resource's namespace.\nWhen these conditions are met, matching alerts will be inhibited (silenced).", items: { description: "Matcher defines how to match on alert's labels.", properties: { matchType: { - description: 'Match operator, one of `=` (equal to), `!=` (not equal to), `=~` (regex\nmatch) or `!~` (not regex match).\nNegative operators (`!=` and `!~`) require Alertmanager >= v0.22.0.', + description: 'matchType defines the match operation available with AlertManager >= v0.22.0.\nTakes precedence over Regex (deprecated) if non-empty.\nValid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match).', enum: [ '!=', '=', @@ -80,12 +80,12 @@ type: 'string', }, name: { - description: 'Label to match.', + description: 'name defines the label to match.\nThis specifies which alert label should be evaluated.', minLength: 1, type: 'string', }, value: { - description: 'Label value to match.', + description: 'value defines the label value to match.\nThis is the expected value for the specified label.', type: 'string', }, }, @@ -102,17 +102,17 @@ type: 'array', }, receivers: { - description: 'List of receivers.', + description: 'receivers defines the list of receivers.', items: { description: 'Receiver defines one or more notification integrations.', properties: { discordConfigs: { - description: 'List of Slack configurations.', + description: 'discordConfigs defines the list of Slack configurations.', items: { description: 'DiscordConfig configures notifications via Discord.\nSee https://prometheus.io/docs/alerting/latest/configuration/#discord_config', properties: { apiURL: { - description: "The secret's key that contains the Discord webhook URL.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "apiURL defines the secret's key that contains the Discord webhook URL.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -135,23 +135,23 @@ 'x-kubernetes-map-type': 'atomic', }, avatarURL: { - description: 'The avatar url of the message sender.', + description: 'avatarURL defines the avatar url of the message sender.', pattern: '^https?://.+$', type: 'string', }, content: { - description: "The template of the content's body.", + description: "content defines the template of the content's body.", minLength: 1, type: 'string', }, httpConfig: { - description: 'HTTP client configuration.', + description: 'httpConfig defines HTTP client configuration.', properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -174,17 +174,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -207,7 +207,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -233,15 +233,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -253,21 +253,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -290,7 +290,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -316,7 +316,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -342,11 +342,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -376,34 +376,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -426,7 +426,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -452,10 +452,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -478,7 +478,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -504,11 +504,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -531,7 +531,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -541,7 +541,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -551,14 +551,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -597,31 +597,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -644,7 +644,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -670,10 +670,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -696,7 +696,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -722,11 +722,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -749,7 +749,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -759,7 +759,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -769,7 +769,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -779,19 +779,19 @@ type: 'object', }, message: { - description: "The template of the message's body.", + description: "message defines the template of the message's body.", type: 'string', }, sendResolved: { - description: 'Whether or not to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, title: { - description: "The template of the message's title.", + description: "title defines the template of the message's title.", type: 'string', }, username: { - description: 'The username of the message sender.', + description: 'username defines the username of the message sender.', minLength: 1, type: 'string', }, @@ -804,24 +804,24 @@ type: 'array', }, emailConfigs: { - description: 'List of Email configurations.', + description: 'emailConfigs defines the list of Email configurations.', items: { description: 'EmailConfig configures notifications via Email.', properties: { authIdentity: { - description: 'The identity to use for authentication.', + description: 'authIdentity defines the identity to use for SMTP authentication.\nThis is typically used with PLAIN authentication mechanism.', type: 'string', }, authPassword: { - description: "The secret's key that contains the password to use for authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "authPassword defines the secret's key that contains the password to use for authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -833,15 +833,15 @@ type: 'object', }, authSecret: { - description: "The secret's key that contains the CRAM-MD5 secret.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "authSecret defines the secret's key that contains the CRAM-MD5 secret.\nThis is used for CRAM-MD5 authentication mechanism.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -853,25 +853,25 @@ type: 'object', }, authUsername: { - description: 'The username to use for authentication.', + description: 'authUsername defines the username to use for SMTP authentication.\nThis is used for SMTP AUTH when the server requires authentication.', type: 'string', }, from: { - description: 'The sender address.', + description: 'from defines the sender address for email notifications.\nThis appears as the "From" field in the email header.', type: 'string', }, headers: { - description: 'Further headers email header key/value pairs. Overrides any headers\npreviously set by the notification implementation.', + description: 'headers defines additional email header key/value pairs.\nThese override any headers previously set by the notification implementation.', items: { description: 'KeyValue defines a (key, value) tuple.', properties: { key: { - description: 'Key of the tuple.', + description: 'key defines the key of the tuple.\nThis is the identifier or name part of the key-value pair.', minLength: 1, type: 'string', }, value: { - description: 'Value of the tuple.', + description: 'value defines the value of the tuple.\nThis is the data or content associated with the key.', type: 'string', }, }, @@ -884,37 +884,37 @@ type: 'array', }, hello: { - description: 'The hostname to identify to the SMTP server.', + description: 'hello defines the hostname to identify to the SMTP server.\nThis is used in the SMTP HELO/EHLO command during the connection handshake.', type: 'string', }, html: { - description: 'The HTML body of the email notification.', + description: 'html defines the HTML body of the email notification.\nThis allows for rich formatting in the email content.', type: 'string', }, requireTLS: { - description: 'The SMTP TLS requirement.\nNote that Go does not support unencrypted connections to remote SMTP endpoints.', + description: 'requireTLS defines the SMTP TLS requirement.\nNote that Go does not support unencrypted connections to remote SMTP endpoints.', type: 'boolean', }, sendResolved: { - description: 'Whether or not to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, smarthost: { - description: 'The SMTP host and port through which emails are sent. E.g. example.com:25', + description: 'smarthost defines the SMTP host and port through which emails are sent.\nFormat should be "hostname:port", e.g. "smtp.example.com:587".', type: 'string', }, text: { - description: 'The text body of the email notification.', + description: "text defines the plain text body of the email notification.\nThis provides a fallback for email clients that don't support HTML.", type: 'string', }, tlsConfig: { - description: 'TLS configuration', + description: 'tlsConfig defines the TLS configuration for SMTP connections.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -937,7 +937,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -963,10 +963,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -989,7 +989,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1015,11 +1015,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1042,7 +1042,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -1052,7 +1052,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -1062,14 +1062,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, to: { - description: 'The email address to send notifications to.', + description: 'to defines the email address to send notifications to.\nThis is the recipient address for alert notifications.', type: 'string', }, }, @@ -1078,18 +1078,18 @@ type: 'array', }, msteamsConfigs: { - description: 'List of MSTeams configurations.\nIt requires Alertmanager >= 0.26.0.', + description: 'msteamsConfigs defines the list of MSTeams configurations.\nIt requires Alertmanager >= 0.26.0.', items: { description: 'MSTeamsConfig configures notifications via Microsoft Teams.\nIt requires Alertmanager >= 0.26.0.', properties: { httpConfig: { - description: 'HTTP client configuration.', + description: 'httpConfig defines the HTTP client configuration for Teams webhook requests.', properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1112,17 +1112,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1145,7 +1145,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1171,15 +1171,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -1191,21 +1191,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -1228,7 +1228,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1254,7 +1254,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1280,11 +1280,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -1314,34 +1314,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -1364,7 +1364,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1390,10 +1390,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -1416,7 +1416,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1442,11 +1442,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1469,7 +1469,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -1479,7 +1479,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -1489,14 +1489,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -1535,31 +1535,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -1582,7 +1582,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1608,10 +1608,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -1634,7 +1634,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1660,11 +1660,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1687,7 +1687,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -1697,7 +1697,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -1707,7 +1707,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -1717,23 +1717,23 @@ type: 'object', }, sendResolved: { - description: 'Whether to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, summary: { - description: 'Message summary template.\nIt requires Alertmanager >= 0.27.0.', + description: 'summary defines the message summary template for Teams notifications.\nThis provides a brief overview that appears in Teams notification previews.\nIt requires Alertmanager >= 0.27.0.', type: 'string', }, text: { - description: 'Message body template.', + description: 'text defines the message body template for Teams notifications.\nThis contains the detailed content of the Teams message.', type: 'string', }, title: { - description: 'Message title template.', + description: 'title defines the message title template for Teams notifications.\nThis appears as the main heading of the Teams message card.', type: 'string', }, webhookUrl: { - description: 'MSTeams webhook URL.', + description: 'webhookUrl defines the MSTeams webhook URL for sending notifications.\nThis is the incoming webhook URL configured in your Teams channel.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1764,18 +1764,18 @@ type: 'array', }, msteamsv2Configs: { - description: 'List of MSTeamsV2 configurations.\nIt requires Alertmanager >= 0.28.0.', + description: 'msteamsv2Configs defines the list of MSTeamsV2 configurations.\nIt requires Alertmanager >= 0.28.0.', items: { - description: 'MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows\nSee https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config\nIt requires Alertmanager >= 0.28.0.', + description: 'MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows.\nSee https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config\nIt requires Alertmanager >= 0.28.0.', properties: { httpConfig: { - description: 'HTTP client configuration.', + description: 'httpConfig defines the HTTP client configuration for Teams webhook requests.', properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1798,17 +1798,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1831,7 +1831,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1857,15 +1857,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -1877,21 +1877,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -1914,7 +1914,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1940,7 +1940,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -1966,11 +1966,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -2000,34 +2000,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -2050,7 +2050,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2076,10 +2076,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -2102,7 +2102,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2128,11 +2128,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2155,7 +2155,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -2165,7 +2165,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -2175,14 +2175,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -2221,31 +2221,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -2268,7 +2268,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2294,10 +2294,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -2320,7 +2320,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2346,11 +2346,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2373,7 +2373,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -2383,7 +2383,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -2393,7 +2393,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -2403,21 +2403,21 @@ type: 'object', }, sendResolved: { - description: 'Whether to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, text: { - description: 'Message body template.', + description: 'text defines the message body template for adaptive card notifications.\nThis contains the detailed content displayed in the Teams adaptive card format.', minLength: 1, type: 'string', }, title: { - description: 'Message title template.', + description: 'title defines the message title template for adaptive card notifications.\nThis appears as the main heading in the Teams adaptive card.', minLength: 1, type: 'string', }, webhookURL: { - description: 'MSTeams incoming webhook URL.', + description: 'webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications.\nThis webhook must support the newer adaptive cards format required by Teams flows.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2445,29 +2445,29 @@ type: 'array', }, name: { - description: 'Name of the receiver. Must be unique across all items from the list.', + description: 'name defiens the name of the receiver. Must be unique across all items from the list.', minLength: 1, type: 'string', }, opsgenieConfigs: { - description: 'List of OpsGenie configurations.', + description: 'opsgenieConfigs defines the list of OpsGenie configurations.', items: { description: 'OpsGenieConfig configures notifications via OpsGenie.\nSee https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config', properties: { actions: { - description: 'Comma separated list of actions that will be available for the alert.', + description: 'actions defines a comma separated list of actions that will be available for the alert.\nThese appear as action buttons in the OpsGenie interface.', type: 'string', }, apiKey: { - description: "The secret's key that contains the OpsGenie API key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "apiKey defines the secret's key that contains the OpsGenie API key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -2479,25 +2479,25 @@ type: 'object', }, apiURL: { - description: 'The URL to send OpsGenie API requests to.', + description: 'apiURL defines the URL to send OpsGenie API requests to.\nWhen not specified, defaults to the standard OpsGenie API endpoint.', type: 'string', }, description: { - description: 'Description of the incident.', + description: 'description defines the detailed description of the incident.\nThis provides additional context beyond the message field.', type: 'string', }, details: { - description: 'A set of arbitrary key/value pairs that provide further detail about the incident.', + description: 'details defines a set of arbitrary key/value pairs that provide further detail about the incident.\nThese appear as additional fields in the OpsGenie alert.', items: { description: 'KeyValue defines a (key, value) tuple.', properties: { key: { - description: 'Key of the tuple.', + description: 'key defines the key of the tuple.\nThis is the identifier or name part of the key-value pair.', minLength: 1, type: 'string', }, value: { - description: 'Value of the tuple.', + description: 'value defines the value of the tuple.\nThis is the data or content associated with the key.', type: 'string', }, }, @@ -2510,17 +2510,17 @@ type: 'array', }, entity: { - description: 'Optional field that can be used to specify which domain alert is related to.', + description: 'entity defines an optional field that can be used to specify which domain alert is related to.\nThis helps group related alerts together in OpsGenie.', type: 'string', }, httpConfig: { - description: 'HTTP client configuration.', + description: 'httpConfig defines the HTTP client configuration for OpsGenie API requests.', properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2543,17 +2543,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2576,7 +2576,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2602,15 +2602,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -2622,21 +2622,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -2659,7 +2659,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2685,7 +2685,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2711,11 +2711,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -2745,34 +2745,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -2795,7 +2795,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2821,10 +2821,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -2847,7 +2847,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2873,11 +2873,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -2900,7 +2900,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -2910,7 +2910,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -2920,14 +2920,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -2966,31 +2966,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -3013,7 +3013,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3039,10 +3039,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -3065,7 +3065,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3091,11 +3091,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3118,7 +3118,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -3128,7 +3128,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -3138,7 +3138,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -3148,32 +3148,32 @@ type: 'object', }, message: { - description: 'Alert text limited to 130 characters.', + description: 'message defines the alert text limited to 130 characters.\nThis appears as the main alert title in OpsGenie.', type: 'string', }, note: { - description: 'Additional alert note.', + description: 'note defines an additional alert note.\nThis provides supplementary information about the alert.', type: 'string', }, priority: { - description: 'Priority level of alert. Possible values are P1, P2, P3, P4, and P5.', + description: 'priority defines the priority level of alert.\nPossible values are P1, P2, P3, P4, and P5, where P1 is highest priority.', type: 'string', }, responders: { - description: 'List of responders responsible for notifications.', + description: 'responders defines the list of responders responsible for notifications.\nThese determine who gets notified when the alert is created.', items: { description: 'OpsGenieConfigResponder defines a responder to an incident.\nOne of `id`, `name` or `username` has to be defined.', properties: { id: { - description: 'ID of the responder.', + description: "id defines the unique identifier of the responder.\nThis corresponds to the responder's ID within OpsGenie.", type: 'string', }, name: { - description: 'Name of the responder.', + description: 'name defines the display name of the responder.\nThis is used when the responder is identified by name rather than ID.', type: 'string', }, type: { - description: 'Type of responder.', + description: 'type defines the type of responder.\nValid values include "user", "team", "schedule", and "escalation".\nThis determines how OpsGenie interprets the other identifier fields.', enum: [ 'team', 'teams', @@ -3185,7 +3185,7 @@ type: 'string', }, username: { - description: 'Username of the responder.', + description: 'username defines the username of the responder.\nThis is typically used for user-type responders when identifying by username.', type: 'string', }, }, @@ -3197,15 +3197,15 @@ type: 'array', }, sendResolved: { - description: 'Whether or not to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, source: { - description: 'Backlink to the sender of the notification.', + description: 'source defines the backlink to the sender of the notification.\nThis helps identify where the alert originated from.', type: 'string', }, tags: { - description: 'Comma separated list of tags attached to the notifications.', + description: 'tags defines a comma separated list of tags attached to the notifications.\nThese help categorize and filter alerts within OpsGenie.', type: 'string', }, }, @@ -3214,42 +3214,42 @@ type: 'array', }, pagerdutyConfigs: { - description: 'List of PagerDuty configurations.', + description: 'pagerdutyConfigs defines the List of PagerDuty configurations.', items: { description: 'PagerDutyConfig configures notifications via PagerDuty.\nSee https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config', properties: { class: { - description: 'The class/type of the event.', + description: 'class defines the class/type of the event.', type: 'string', }, client: { - description: 'Client identification.', + description: 'client defines the client identification.', type: 'string', }, clientURL: { - description: 'Backlink to the sender of notification.', + description: 'clientURL defines the backlink to the sender of notification.', type: 'string', }, component: { - description: 'The part or component of the affected system that is broken.', + description: 'component defines the part or component of the affected system that is broken.', type: 'string', }, description: { - description: 'Description of the incident.', + description: 'description of the incident.', type: 'string', }, details: { - description: 'Arbitrary key/value pairs that provide further detail about the incident.', + description: 'details defines the arbitrary key/value pairs that provide further detail about the incident.', items: { description: 'KeyValue defines a (key, value) tuple.', properties: { key: { - description: 'Key of the tuple.', + description: 'key defines the key of the tuple.\nThis is the identifier or name part of the key-value pair.', minLength: 1, type: 'string', }, value: { - description: 'Value of the tuple.', + description: 'value defines the value of the tuple.\nThis is the data or content associated with the key.', type: 'string', }, }, @@ -3262,17 +3262,17 @@ type: 'array', }, group: { - description: 'A cluster or grouping of sources.', + description: 'group defines a cluster or grouping of sources.', type: 'string', }, httpConfig: { - description: 'HTTP client configuration.', + description: 'httpConfig defines the HTTP client configuration.', properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3295,17 +3295,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3328,7 +3328,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3354,15 +3354,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -3374,21 +3374,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -3411,7 +3411,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3437,7 +3437,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3463,11 +3463,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -3497,34 +3497,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -3547,7 +3547,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3573,10 +3573,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -3599,7 +3599,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3625,11 +3625,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3652,7 +3652,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -3662,7 +3662,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -3672,14 +3672,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -3718,31 +3718,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -3765,7 +3765,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3791,10 +3791,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -3817,7 +3817,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3843,11 +3843,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -3870,7 +3870,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -3880,7 +3880,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -3890,7 +3890,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -3900,20 +3900,20 @@ type: 'object', }, pagerDutyImageConfigs: { - description: 'A list of image details to attach that provide further detail about an incident.', + description: 'pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident.', items: { description: 'PagerDutyImageConfig attaches images to an incident', properties: { alt: { - description: 'Alt is the optional alternative text for the image.', + description: 'alt is the optional alternative text for the image.', type: 'string', }, href: { - description: 'Optional URL; makes the image a clickable link.', + description: 'href defines the optional URL; makes the image a clickable link.', type: 'string', }, src: { - description: 'Src of the image being attached to the incident', + description: 'src of the image being attached to the incident', type: 'string', }, }, @@ -3922,16 +3922,16 @@ type: 'array', }, pagerDutyLinkConfigs: { - description: 'A list of link details to attach that provide further detail about an incident.', + description: 'pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident.', items: { description: 'PagerDutyLinkConfig attaches text links to an incident', properties: { alt: { - description: "Text that describes the purpose of the link, and can be used as the link's text.", + description: "alt defines the text that describes the purpose of the link, and can be used as the link's text.", type: 'string', }, href: { - description: 'Href is the URL of the link to be attached', + description: 'href defines the URL of the link to be attached', type: 'string', }, }, @@ -3940,15 +3940,15 @@ type: 'array', }, routingKey: { - description: "The secret's key that contains the PagerDuty integration key (when using\nEvents API v2). Either this field or `serviceKey` needs to be defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "routingKey defines the secret's key that contains the PagerDuty integration key (when using\nEvents API v2). Either this field or `serviceKey` needs to be defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -3960,19 +3960,19 @@ type: 'object', }, sendResolved: { - description: 'Whether or not to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, serviceKey: { - description: "The secret's key that contains the PagerDuty service key (when using\nintegration type \"Prometheus\"). Either this field or `routingKey` needs to\nbe defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "serviceKey defines the secret's key that contains the PagerDuty service key (when using\nintegration type \"Prometheus\"). Either this field or `routingKey` needs to\nbe defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -3984,15 +3984,15 @@ type: 'object', }, severity: { - description: 'Severity of the incident.', + description: 'severity of the incident.', type: 'string', }, source: { - description: 'Unique location of the affected system.', + description: 'source defines the unique location of the affected system.', type: 'string', }, url: { - description: 'The URL to send requests to.', + description: 'url defines the URL to send requests to.', type: 'string', }, }, @@ -4001,31 +4001,31 @@ type: 'array', }, pushoverConfigs: { - description: 'List of Pushover configurations.', + description: 'pushoverConfigs defines the list of Pushover configurations.', items: { description: 'PushoverConfig configures notifications via Pushover.\nSee https://prometheus.io/docs/alerting/latest/configuration/#pushover_config', properties: { device: { - description: 'The name of a device to send the notification to', + description: "device defines the name of a specific device to send the notification to.\nIf not specified, the notification is sent to all user's devices.", type: 'string', }, expire: { - description: 'How long your notification will continue to be retried for, unless the user\nacknowledges the notification.', + description: 'expire defines how long your notification will continue to be retried for,\nunless the user acknowledges the notification. Only applies to priority 2 notifications.', pattern: '^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$', type: 'string', }, html: { - description: 'Whether notification message is HTML or plain text.', + description: 'html defines whether notification message is HTML or plain text.\nWhen true, the message can include HTML formatting tags.', type: 'boolean', }, httpConfig: { - description: 'HTTP client configuration.', + description: 'httpConfig defines the HTTP client configuration for Pushover API requests.', properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4048,17 +4048,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4081,7 +4081,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4107,15 +4107,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -4127,21 +4127,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -4164,7 +4164,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4190,7 +4190,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4216,11 +4216,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -4250,34 +4250,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -4300,7 +4300,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4326,10 +4326,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -4352,7 +4352,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4378,11 +4378,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4405,7 +4405,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -4415,7 +4415,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -4425,14 +4425,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -4471,31 +4471,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -4518,7 +4518,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4544,10 +4544,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -4570,7 +4570,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4596,11 +4596,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4623,7 +4623,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -4633,7 +4633,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -4643,7 +4643,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -4653,40 +4653,40 @@ type: 'object', }, message: { - description: 'Notification message.', + description: 'message defines the notification message content.\nThis is the main body text of the Pushover notification.', type: 'string', }, priority: { - description: 'Priority, see https://pushover.net/api#priority', + description: 'priority defines the notification priority level.\nSee https://pushover.net/api#priority for valid values and behavior.', type: 'string', }, retry: { - description: 'How often the Pushover servers will send the same notification to the user.\nMust be at least 30 seconds.', + description: 'retry defines how often the Pushover servers will send the same notification to the user.\nMust be at least 30 seconds. Only applies to priority 2 notifications.', pattern: '^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$', type: 'string', }, sendResolved: { - description: 'Whether or not to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, sound: { - description: "The name of one of the sounds supported by device clients to override the user's default sound choice", + description: "sound defines the name of one of the sounds supported by device clients.\nThis overrides the user's default sound choice for this notification.", type: 'string', }, title: { - description: 'Notification title.', + description: 'title defines the notification title displayed in the Pushover message.\nThis appears as the bold header text in the notification.', type: 'string', }, token: { - description: "The secret's key that contains the registered application's API token, see https://pushover.net/apps.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither `token` or `tokenFile` is required.", + description: "token defines the secret's key that contains the registered application's API token.\nSee https://pushover.net/apps for application registration.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither `token` or `tokenFile` is required.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -4698,32 +4698,32 @@ type: 'object', }, tokenFile: { - description: "The token file that contains the registered application's API token, see https://pushover.net/apps.\nEither `token` or `tokenFile` is required.\nIt requires Alertmanager >= v0.26.0.", + description: "tokenFile defines the token file that contains the registered application's API token.\nSee https://pushover.net/apps for application registration.\nEither `token` or `tokenFile` is required.\nIt requires Alertmanager >= v0.26.0.", type: 'string', }, ttl: { - description: 'The time to live definition for the alert notification', + description: 'ttl defines the time to live for the alert notification.\nThis determines how long the notification remains active before expiring.', pattern: '^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$', type: 'string', }, url: { - description: 'A supplementary URL shown alongside the message.', + description: 'url defines a supplementary URL shown alongside the message.\nThis creates a clickable link within the Pushover notification.', type: 'string', }, urlTitle: { - description: 'A title for supplementary URL, otherwise just the URL is shown', + description: 'urlTitle defines a title for the supplementary URL.\nIf not specified, the raw URL is shown instead.', type: 'string', }, userKey: { - description: "The secret's key that contains the recipient user's user key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither `userKey` or `userKeyFile` is required.", + description: "userKey defines the secret's key that contains the recipient user's user key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither `userKey` or `userKeyFile` is required.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -4735,7 +4735,7 @@ type: 'object', }, userKeyFile: { - description: "The user key file that contains the recipient user's user key.\nEither `userKey` or `userKeyFile` is required.\nIt requires Alertmanager >= v0.26.0.", + description: "userKeyFile defines the user key file that contains the recipient user's user key.\nEither `userKey` or `userKeyFile` is required.\nIt requires Alertmanager >= v0.26.0.", type: 'string', }, }, @@ -4744,27 +4744,27 @@ type: 'array', }, rocketchatConfigs: { - description: 'List of RocketChat configurations.\nIt requires Alertmanager >= 0.28.0.', + description: 'rocketchatConfigs defines the list of RocketChat configurations.\nIt requires Alertmanager >= 0.28.0.', items: { description: 'RocketChatConfig configures notifications via RocketChat.\nIt requires Alertmanager >= 0.28.0.', properties: { actions: { - description: 'Actions to include in the message.', + description: 'actions defines interactive actions to include in the message.\nThese appear as buttons that users can click to trigger responses.', items: { description: 'RocketChatActionConfig defines actions for RocketChat messages.', properties: { msg: { - description: 'The message to send when the button is clicked.', + description: 'msg defines the message to send when the button is clicked.\nThis allows the button to post a predefined message to the channel.', minLength: 1, type: 'string', }, text: { - description: 'The button text.', + description: 'text defines the button text displayed to users.\nThis is the label that appears on the interactive button.', minLength: 1, type: 'string', }, url: { - description: 'The URL the button links to.', + description: 'url defines the URL the button links to when clicked.\nThis creates a clickable button that opens the specified URL.', pattern: '^https?://.+$', type: 'string', }, @@ -4775,41 +4775,41 @@ type: 'array', }, apiURL: { - description: 'The API URL for RocketChat.\nDefaults to https://open.rocket.chat/ if not specified.', + description: 'apiURL defines the API URL for RocketChat.\nDefaults to https://open.rocket.chat/ if not specified.', pattern: '^https?://.+$', type: 'string', }, channel: { - description: 'The channel to send alerts to.', + description: 'channel defines the channel to send alerts to.\nThis can be a channel name (e.g., "#alerts") or a direct message recipient.', minLength: 1, type: 'string', }, color: { - description: 'The message color.', + description: 'color defines the message color displayed in RocketChat.\nThis appears as a colored bar alongside the message.', minLength: 1, type: 'string', }, emoji: { - description: 'If provided, the avatar will be displayed as an emoji.', + description: 'emoji defines the emoji to be displayed as an avatar.\nIf provided, this emoji will be used instead of the default avatar or iconURL.', minLength: 1, type: 'string', }, fields: { - description: 'Additional fields for the message.', + description: 'fields defines additional fields for the message attachment.\nThese appear as structured key-value pairs within the message.', items: { description: 'RocketChatFieldConfig defines a field for RocketChat messages.', properties: { short: { - description: 'Whether the field is displayed in a compact form.', + description: 'short defines whether this field should be a short field.\nWhen true, the field may be displayed inline with other short fields to save space.', type: 'boolean', }, title: { - description: 'The field title.', + description: 'title defines the title of this field.\nThis appears as bold text labeling the field content.', minLength: 1, type: 'string', }, value: { - description: 'The field value.', + description: 'value defines the value of this field, displayed underneath the title.\nThis contains the actual data or content for the field.', minLength: 1, type: 'string', }, @@ -4820,13 +4820,13 @@ type: 'array', }, httpConfig: { - description: 'HTTP client configuration.', + description: 'httpConfig defines the HTTP client configuration for RocketChat API requests.', properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4849,17 +4849,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4882,7 +4882,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4908,15 +4908,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -4928,21 +4928,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -4965,7 +4965,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -4991,7 +4991,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5017,11 +5017,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -5051,34 +5051,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -5101,7 +5101,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5127,10 +5127,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -5153,7 +5153,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5179,11 +5179,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5206,7 +5206,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -5216,7 +5216,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -5226,14 +5226,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -5272,31 +5272,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -5319,7 +5319,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5345,10 +5345,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -5371,7 +5371,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5397,11 +5397,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5424,7 +5424,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -5434,7 +5434,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -5444,7 +5444,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -5454,49 +5454,49 @@ type: 'object', }, iconURL: { - description: 'Icon URL for the message.', + description: "iconURL defines the icon URL for the message avatar.\nThis displays a custom image as the message sender's avatar.", pattern: '^https?://.+$', type: 'string', }, imageURL: { - description: 'Image URL for the message.', + description: 'imageURL defines the image URL to display within the message.\nThis embeds an image directly in the message attachment.', pattern: '^https?://.+$', type: 'string', }, linkNames: { - description: 'Whether to enable link names.', + description: 'linkNames defines whether to enable automatic linking of usernames and channels.\nWhen true, @username and #channel references become clickable links.', type: 'boolean', }, sendResolved: { - description: 'Whether to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, shortFields: { - description: 'Whether to use short fields.', + description: 'shortFields defines whether to use short fields in the message layout.\nWhen true, fields may be displayed side by side to save space.', type: 'boolean', }, text: { - description: 'The main message text.', + description: 'text defines the message text to send.\nThis is optional because attachments can be used instead of or alongside text.', minLength: 1, type: 'string', }, thumbURL: { - description: 'Thumbnail URL for the message.', + description: 'thumbURL defines the thumbnail URL for the message.\nThis displays a small thumbnail image alongside the message content.', pattern: '^https?://.+$', type: 'string', }, title: { - description: 'The message title.', + description: 'title defines the message title displayed prominently in the message.\nThis appears as bold text at the top of the message attachment.', minLength: 1, type: 'string', }, titleLink: { - description: 'The title link for the message.', + description: 'titleLink defines the URL that the title will link to when clicked.\nThis makes the message title clickable in the RocketChat interface.', minLength: 1, type: 'string', }, token: { - description: 'The sender token.', + description: 'token defines the sender token for RocketChat authentication.\nThis is the personal access token or bot token used to authenticate API requests.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5519,7 +5519,7 @@ 'x-kubernetes-map-type': 'atomic', }, tokenID: { - description: 'The sender token ID.', + description: 'tokenID defines the sender token ID for RocketChat authentication.\nThis is the user ID associated with the token used for API requests.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5551,29 +5551,33 @@ type: 'array', }, slackConfigs: { - description: 'List of Slack configurations.', + description: 'slackConfigs defines the list of Slack configurations.', items: { description: 'SlackConfig configures notifications via Slack.\nSee https://prometheus.io/docs/alerting/latest/configuration/#slack_config', properties: { actions: { - description: 'A list of Slack actions that are sent with each notification.', + description: 'actions defines a list of Slack actions that are sent with each notification.', items: { description: 'SlackAction configures a single Slack action that is sent with each\nnotification.\nSee https://api.slack.com/docs/message-attachments#action_fields and\nhttps://api.slack.com/docs/message-buttons for more information.', properties: { confirm: { - description: 'SlackConfirmationField protect users from destructive actions or\nparticularly distinguished decisions by asking them to confirm their button\nclick one more time.\nSee https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields\nfor more information.', + description: 'confirm defines an optional confirmation dialog that appears before the action is executed.\nWhen set, users must confirm their intent before the action proceeds.', properties: { dismissText: { + description: 'dismissText defines the label for the cancel button in the dialog.\nWhen not specified, defaults to "Cancel". This button cancels the action.', type: 'string', }, okText: { + description: 'okText defines the label for the confirmation button in the dialog.\nWhen not specified, defaults to "Okay". This button proceeds with the action.', type: 'string', }, text: { + description: 'text defines the main message displayed in the confirmation dialog.\nThis should be a clear question or statement asking the user to confirm their action.', minLength: 1, type: 'string', }, title: { + description: 'title defines the title text displayed at the top of the confirmation dialog.\nWhen not specified, a default title will be used.', type: 'string', }, }, @@ -5583,23 +5587,29 @@ type: 'object', }, name: { + description: 'name defines a unique identifier for the action within the message.\nThis value is sent back to your application when the action is triggered.', type: 'string', }, style: { + description: 'style defines the visual appearance of the action element.\nValid values include "default", "primary" (green), and "danger" (red).', type: 'string', }, text: { + description: 'text defines the user-visible label displayed on the action element.\nFor buttons, this is the button text. For select menus, this is the placeholder text.', minLength: 1, type: 'string', }, type: { + description: 'type defines the type of interactive component.\nCommon values include "button" for clickable buttons and "select" for dropdown menus.', minLength: 1, type: 'string', }, url: { + description: 'url defines the URL to open when the action is triggered.\nOnly applicable for button-type actions. When set, clicking the button opens this URL.', type: 'string', }, value: { + description: 'value defines the payload sent when the action is triggered.\nThis data is included in the callback sent to your application.', type: 'string', }, }, @@ -5612,15 +5622,15 @@ type: 'array', }, apiURL: { - description: "The secret's key that contains the Slack webhook URL.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "apiURL defines the secret's key that contains the Slack webhook URL.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -5632,31 +5642,37 @@ type: 'object', }, callbackId: { + description: 'callbackId defines an identifier for the message used in interactive components.', type: 'string', }, channel: { - description: 'The channel or user to send notifications to.', + description: 'channel defines the channel or user to send notifications to.', type: 'string', }, color: { + description: 'color defines the color of the left border of the Slack message attachment.\nCan be a hex color code (e.g., "#ff0000") or a predefined color name.', type: 'string', }, fallback: { + description: "fallback defines a plain-text summary of the attachment for clients that don't support attachments.", type: 'string', }, fields: { - description: 'A list of Slack fields that are sent with each notification.', + description: 'fields defines a list of Slack fields that are sent with each notification.', items: { description: 'SlackField configures a single Slack field that is sent with each notification.\nEach field must contain a title, value, and optionally, a boolean value to indicate if the field\nis short enough to be displayed next to other fields designated as short.\nSee https://api.slack.com/docs/message-attachments#fields for more information.', properties: { short: { + description: 'short determines whether this field can be displayed alongside other short fields.\nWhen true, Slack may display this field side by side with other short fields.\nWhen false or not specified, the field takes the full width of the message.', type: 'boolean', }, title: { + description: 'title defines the label or header text displayed for this field.\nThis appears as bold text above the field value in the Slack message.', minLength: 1, type: 'string', }, value: { + description: 'value defines the content or data displayed for this field.\nThis appears below the title and can contain plain text or Slack markdown.', minLength: 1, type: 'string', }, @@ -5670,16 +5686,17 @@ type: 'array', }, footer: { + description: 'footer defines small text displayed at the bottom of the message attachment.', type: 'string', }, httpConfig: { - description: 'HTTP client configuration.', + description: 'httpConfig defines the HTTP client configuration.', properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5702,17 +5719,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5735,7 +5752,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5761,15 +5778,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -5781,21 +5798,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -5818,7 +5835,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5844,7 +5861,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5870,11 +5887,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -5904,34 +5921,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -5954,7 +5971,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -5980,10 +5997,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -6006,7 +6023,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6032,11 +6049,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6059,7 +6076,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -6069,7 +6086,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -6079,14 +6096,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -6125,31 +6142,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -6172,7 +6189,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6198,10 +6215,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -6224,7 +6241,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6250,11 +6267,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6277,7 +6294,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -6287,7 +6304,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -6297,7 +6314,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -6307,46 +6324,58 @@ type: 'object', }, iconEmoji: { + description: "iconEmoji defines the emoji to use as the bot's avatar (e.g., \":ghost:\").", type: 'string', }, iconURL: { + description: "iconURL defines the URL to an image to use as the bot's avatar.", type: 'string', }, imageURL: { + description: 'imageURL defines the URL to an image file that will be displayed inside the message attachment.', type: 'string', }, linkNames: { + description: 'linkNames enables automatic linking of channel names and usernames in the message.\nWhen true, @channel and @username will be converted to clickable links.', type: 'boolean', }, mrkdwnIn: { + description: 'mrkdwnIn defines which fields should be parsed as Slack markdown.\nValid values include "pretext", "text", and "fields".', items: { type: 'string', }, type: 'array', }, pretext: { + description: 'pretext defines optional text that appears above the message attachment block.', type: 'string', }, sendResolved: { - description: 'Whether or not to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, shortFields: { + description: 'shortFields determines whether fields are displayed in a compact format.\nWhen true, fields are shown side by side when possible.', type: 'boolean', }, text: { + description: 'text defines the main text content of the Slack message attachment.', type: 'string', }, thumbURL: { + description: 'thumbURL defines the URL to an image file that will be displayed as a thumbnail\non the right side of the message attachment.', type: 'string', }, title: { + description: 'title defines the title text displayed in the Slack message attachment.', type: 'string', }, titleLink: { + description: 'titleLink defines the URL that the title will link to when clicked.', type: 'string', }, username: { + description: 'username defines the slack bot user name.', type: 'string', }, }, @@ -6355,29 +6384,29 @@ type: 'array', }, snsConfigs: { - description: 'List of SNS configurations', + description: 'snsConfigs defines the list of SNS configurations', items: { description: 'SNSConfig configures notifications via AWS SNS.\nSee https://prometheus.io/docs/alerting/latest/configuration/#sns_configs', properties: { apiURL: { - description: 'The SNS API URL i.e. https://sns.us-east-2.amazonaws.com.\nIf not specified, the SNS API URL from the SNS SDK will be used.', + description: 'apiURL defines the SNS API URL, e.g. https://sns.us-east-2.amazonaws.com.\nIf not specified, the SNS API URL from the SNS SDK will be used.', type: 'string', }, attributes: { additionalProperties: { type: 'string', }, - description: 'SNS message attributes.', + description: 'attributes defines SNS message attributes as key-value pairs.\nThese provide additional metadata that can be used for message filtering and routing.', type: 'object', }, httpConfig: { - description: 'HTTP client configuration.', + description: 'httpConfig defines the HTTP client configuration for SNS API requests.', properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6400,17 +6429,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6433,7 +6462,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6459,15 +6488,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -6479,21 +6508,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -6516,7 +6545,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6542,7 +6571,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6568,11 +6597,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -6602,34 +6631,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -6652,7 +6681,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6678,10 +6707,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -6704,7 +6733,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6730,11 +6759,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6757,7 +6786,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -6767,7 +6796,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -6777,14 +6806,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -6823,31 +6852,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -6870,7 +6899,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6896,10 +6925,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -6922,7 +6951,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6948,11 +6977,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -6975,7 +7004,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -6985,7 +7014,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -6995,7 +7024,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -7005,22 +7034,22 @@ type: 'object', }, message: { - description: 'The message content of the SNS notification.', + description: 'message defines the message content of the SNS notification.\nThis is the actual notification text that will be sent to subscribers.', type: 'string', }, phoneNumber: { - description: "Phone number if message is delivered via SMS in E.164 format.\nIf you don't specify this value, you must specify a value for the TopicARN or TargetARN.", + description: "phoneNumber defines the phone number if message is delivered via SMS in E.164 format.\nIf you don't specify this value, you must specify a value for the TopicARN or TargetARN.", type: 'string', }, sendResolved: { - description: 'Whether or not to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, sigv4: { - description: "Configures AWS's Signature Verification 4 signing process to sign requests.", + description: "sigv4 configures AWS's Signature Verification 4 signing process to sign requests.\nThis includes AWS credentials and region configuration for authentication.", properties: { accessKey: { - description: 'AccessKey is the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.', + description: 'accessKey defines the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7043,19 +7072,19 @@ 'x-kubernetes-map-type': 'atomic', }, profile: { - description: 'Profile is the named AWS profile used to authenticate.', + description: 'profile defines the named AWS profile used to authenticate.', type: 'string', }, region: { - description: 'Region is the AWS region. If blank, the region from the default credentials chain used.', + description: 'region defines the AWS region. If blank, the region from the default credentials chain used.', type: 'string', }, roleArn: { - description: 'RoleArn is the named AWS profile used to authenticate.', + description: 'roleArn defines the named AWS profile used to authenticate.', type: 'string', }, secretKey: { - description: 'SecretKey is the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.', + description: 'secretKey defines the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7081,15 +7110,15 @@ type: 'object', }, subject: { - description: 'Subject line when the message is delivered to email endpoints.', + description: 'subject defines the subject line when the message is delivered to email endpoints.\nThis field is only used when sending to email subscribers of an SNS topic.', type: 'string', }, targetARN: { - description: "The mobile platform endpoint ARN if message is delivered via mobile notifications.\nIf you don't specify this value, you must specify a value for the topic_arn or PhoneNumber.", + description: "targetARN defines the mobile platform endpoint ARN if message is delivered via mobile notifications.\nIf you don't specify this value, you must specify a value for the TopicARN or PhoneNumber.", type: 'string', }, topicARN: { - description: "SNS topic ARN, i.e. arn:aws:sns:us-east-2:698519295917:My-Topic\nIf you don't specify this value, you must specify a value for the PhoneNumber or TargetARN.", + description: "topicARN defines the SNS topic ARN, e.g. arn:aws:sns:us-east-2:698519295917:My-Topic.\nIf you don't specify this value, you must specify a value for the PhoneNumber or TargetARN.", type: 'string', }, }, @@ -7098,24 +7127,24 @@ type: 'array', }, telegramConfigs: { - description: 'List of Telegram configurations.', + description: 'telegramConfigs defines the list of Telegram configurations.', items: { description: 'TelegramConfig configures notifications via Telegram.\nSee https://prometheus.io/docs/alerting/latest/configuration/#telegram_config', properties: { apiURL: { - description: 'The Telegram API URL i.e. https://api.telegram.org.\nIf not specified, default API URL will be used.', + description: 'apiURL defines the Telegram API URL, e.g. https://api.telegram.org.\nIf not specified, the default Telegram API URL will be used.', type: 'string', }, botToken: { - description: 'Telegram bot token. It is mutually exclusive with `botTokenFile`.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\n\nEither `botToken` or `botTokenFile` is required.', + description: 'botToken defines the Telegram bot token. It is mutually exclusive with `botTokenFile`.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.\nEither `botToken` or `botTokenFile` is required.', properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -7127,26 +7156,26 @@ type: 'object', }, botTokenFile: { - description: 'File to read the Telegram bot token from. It is mutually exclusive with `botToken`.\nEither `botToken` or `botTokenFile` is required.\n\nIt requires Alertmanager >= v0.26.0.', + description: 'botTokenFile defines the file to read the Telegram bot token from.\nIt is mutually exclusive with `botToken`.\nEither `botToken` or `botTokenFile` is required.\nIt requires Alertmanager >= v0.26.0.', type: 'string', }, chatID: { - description: 'The Telegram chat ID.', + description: 'chatID defines the Telegram chat ID where messages will be sent.\nThis can be a user ID, group ID, or channel ID (with @ prefix for public channels).', format: 'int64', type: 'integer', }, disableNotifications: { - description: 'Disable telegram notifications', + description: 'disableNotifications controls whether Telegram notifications are sent silently.\nWhen true, users will receive the message without notification sounds.', type: 'boolean', }, httpConfig: { - description: 'HTTP client configuration.', + description: 'httpConfig defines the HTTP client configuration for Telegram API requests.', properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7169,17 +7198,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7202,7 +7231,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7228,15 +7257,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -7248,21 +7277,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -7285,7 +7314,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7311,7 +7340,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7337,11 +7366,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -7371,34 +7400,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -7421,7 +7450,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7447,10 +7476,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -7473,7 +7502,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7499,11 +7528,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7526,7 +7555,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -7536,7 +7565,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -7546,14 +7575,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -7592,31 +7621,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -7639,7 +7668,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7665,10 +7694,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -7691,7 +7720,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7717,11 +7746,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7744,7 +7773,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -7754,7 +7783,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -7764,7 +7793,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -7774,16 +7803,16 @@ type: 'object', }, message: { - description: 'Message template', + description: 'message defines the message template for the Telegram notification.\nThis is the content that will be sent to the specified chat.', type: 'string', }, messageThreadID: { - description: 'The Telegram Group Topic ID.\nIt requires Alertmanager >= 0.26.0.', + description: 'messageThreadID defines the Telegram Group Topic ID for threaded messages.\nThis allows sending messages to specific topics within Telegram groups.\nIt requires Alertmanager >= 0.26.0.', format: 'int64', type: 'integer', }, parseMode: { - description: 'Parse mode for telegram message', + description: 'parseMode defines the parse mode for telegram message formatting.\nValid values are "MarkdownV2", "Markdown", and "HTML".\nThis determines how text formatting is interpreted in the message.', enum: [ 'MarkdownV2', 'Markdown', @@ -7792,7 +7821,7 @@ type: 'string', }, sendResolved: { - description: 'Whether to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, }, @@ -7804,20 +7833,20 @@ type: 'array', }, victoropsConfigs: { - description: 'List of VictorOps configurations.', + description: 'victoropsConfigs defines the list of VictorOps configurations.', items: { description: 'VictorOpsConfig configures notifications via VictorOps.\nSee https://prometheus.io/docs/alerting/latest/configuration/#victorops_config', properties: { apiKey: { - description: "The secret's key that contains the API key to use when talking to the VictorOps API.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "apiKey defines the secret's key that contains the API key to use when talking to the VictorOps API.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -7829,21 +7858,21 @@ type: 'object', }, apiUrl: { - description: 'The VictorOps API URL.', + description: 'apiUrl defines the VictorOps API URL.\nWhen not specified, defaults to the standard VictorOps API endpoint.', type: 'string', }, customFields: { - description: 'Additional custom fields for notification.', + description: 'customFields defines additional custom fields for notification.\nThese provide extra metadata that will be included with the VictorOps incident.', items: { description: 'KeyValue defines a (key, value) tuple.', properties: { key: { - description: 'Key of the tuple.', + description: 'key defines the key of the tuple.\nThis is the identifier or name part of the key-value pair.', minLength: 1, type: 'string', }, value: { - description: 'Value of the tuple.', + description: 'value defines the value of the tuple.\nThis is the data or content associated with the key.', type: 'string', }, }, @@ -7856,17 +7885,17 @@ type: 'array', }, entityDisplayName: { - description: 'Contains summary of the alerted problem.', + description: 'entityDisplayName contains a summary of the alerted problem.\nThis appears as the main title or identifier for the incident.', type: 'string', }, httpConfig: { - description: "The HTTP client's configuration.", + description: "httpConfig defines the HTTP client's configuration for VictorOps API requests.", properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7889,17 +7918,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7922,7 +7951,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -7948,15 +7977,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -7968,21 +7997,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -8005,7 +8034,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8031,7 +8060,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8057,11 +8086,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -8091,34 +8120,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -8141,7 +8170,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8167,10 +8196,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -8193,7 +8222,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8219,11 +8248,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8246,7 +8275,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -8256,7 +8285,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -8266,14 +8295,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -8312,31 +8341,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -8359,7 +8388,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8385,10 +8414,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -8411,7 +8440,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8437,11 +8466,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8464,7 +8493,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -8474,7 +8503,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -8484,7 +8513,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -8494,23 +8523,23 @@ type: 'object', }, messageType: { - description: 'Describes the behavior of the alert (CRITICAL, WARNING, INFO).', + description: 'messageType describes the behavior of the alert.\nValid values are "CRITICAL", "WARNING", and "INFO".', type: 'string', }, monitoringTool: { - description: 'The monitoring tool the state message is from.', + description: 'monitoringTool defines the monitoring tool the state message is from.\nThis helps identify the source system that generated the alert.', type: 'string', }, routingKey: { - description: 'A key used to map the alert to a team.', + description: 'routingKey defines a key used to map the alert to a team.\nThis determines which VictorOps team will receive the alert notification.', type: 'string', }, sendResolved: { - description: 'Whether or not to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, stateMessage: { - description: 'Contains long explanation of the alerted problem.', + description: 'stateMessage contains a long explanation of the alerted problem.\nThis provides detailed context about the incident.', type: 'string', }, }, @@ -8519,23 +8548,23 @@ type: 'array', }, webexConfigs: { - description: 'List of Webex configurations.', + description: 'webexConfigs defines the list of Webex configurations.', items: { description: 'WebexConfig configures notification via Cisco Webex\nSee https://prometheus.io/docs/alerting/latest/configuration/#webex_config', properties: { apiURL: { - description: 'The Webex Teams API URL i.e. https://webexapis.com/v1/messages', + description: 'apiURL defines the Webex Teams API URL i.e. https://webexapis.com/v1/messages', pattern: '^https?://.+$', type: 'string', }, httpConfig: { - description: "The HTTP client's configuration.\nYou must use this configuration to supply the bot token as part of the HTTP `Authorization` header.", + description: "httpConfig defines the HTTP client's configuration.\nYou must use this configuration to supply the bot token as part of the HTTP `Authorization` header.", properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8558,17 +8587,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8591,7 +8620,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8617,15 +8646,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -8637,21 +8666,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -8674,7 +8703,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8700,7 +8729,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8726,11 +8755,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -8760,34 +8789,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -8810,7 +8839,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8836,10 +8865,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -8862,7 +8891,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8888,11 +8917,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -8915,7 +8944,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -8925,7 +8954,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -8935,14 +8964,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -8981,31 +9010,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -9028,7 +9057,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9054,10 +9083,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -9080,7 +9109,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9106,11 +9135,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9133,7 +9162,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -9143,7 +9172,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -9153,7 +9182,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -9163,16 +9192,16 @@ type: 'object', }, message: { - description: 'Message template', + description: 'message defines the message template', type: 'string', }, roomID: { - description: 'ID of the Webex Teams room where to send the messages.', + description: 'roomID defines the ID of the Webex Teams room where to send the messages.', minLength: 1, type: 'string', }, sendResolved: { - description: 'Whether to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, }, @@ -9184,18 +9213,18 @@ type: 'array', }, webhookConfigs: { - description: 'List of webhook configurations.', + description: 'webhookConfigs defines the List of webhook configurations.', items: { description: 'WebhookConfig configures notifications via a generic receiver supporting the webhook payload.\nSee https://prometheus.io/docs/alerting/latest/configuration/#webhook_config', properties: { httpConfig: { - description: 'HTTP client configuration.', + description: 'httpConfig defines the HTTP client configuration for webhook requests.', properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9218,17 +9247,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9251,7 +9280,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9277,15 +9306,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -9297,21 +9326,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -9334,7 +9363,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9360,7 +9389,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9386,11 +9415,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -9420,34 +9449,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -9470,7 +9499,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9496,10 +9525,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -9522,7 +9551,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9548,11 +9577,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9575,7 +9604,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -9585,7 +9614,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -9595,14 +9624,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -9641,31 +9670,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -9688,7 +9717,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9714,10 +9743,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -9740,7 +9769,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9766,11 +9795,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9793,7 +9822,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -9803,7 +9832,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -9813,7 +9842,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -9823,34 +9852,34 @@ type: 'object', }, maxAlerts: { - description: 'Maximum number of alerts to be sent per webhook message. When 0, all alerts are included.', + description: 'maxAlerts defines the maximum number of alerts to be sent per webhook message.\nWhen 0, all alerts are included in the webhook payload.', format: 'int32', minimum: 0, type: 'integer', }, sendResolved: { - description: 'Whether or not to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, timeout: { - description: 'The maximum time to wait for a webhook request to complete, before failing the\nrequest and allowing it to be retried.\nIt requires Alertmanager >= v0.28.0.', + description: 'timeout defines the maximum time to wait for a webhook request to complete,\nbefore failing the request and allowing it to be retried.\nIt requires Alertmanager >= v0.28.0.', pattern: '^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$', type: 'string', }, url: { - description: 'The URL to send HTTP POST requests to. `urlSecret` takes precedence over\n`url`. One of `urlSecret` and `url` should be defined.', + description: 'url defines the URL to send HTTP POST requests to.\nurlSecret takes precedence over url. One of urlSecret and url should be defined.', type: 'string', }, urlSecret: { - description: "The secret's key that contains the webhook URL to send HTTP requests to.\n`urlSecret` takes precedence over `url`. One of `urlSecret` and `url`\nshould be defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "urlSecret defines the secret's key that contains the webhook URL to send HTTP requests to.\nurlSecret takes precedence over url. One of urlSecret and url should be defined.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -9867,23 +9896,24 @@ type: 'array', }, wechatConfigs: { - description: 'List of WeChat configurations.', + description: 'wechatConfigs defines the list of WeChat configurations.', items: { description: 'WeChatConfig configures notifications via WeChat.\nSee https://prometheus.io/docs/alerting/latest/configuration/#wechat_config', properties: { agentID: { + description: 'agentID defines the application agent ID within WeChat Work.\nThis identifies which WeChat Work application will send the notifications.', type: 'string', }, apiSecret: { - description: "The secret's key that contains the WeChat API key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "apiSecret defines the secret's key that contains the WeChat API key.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -9895,21 +9925,21 @@ type: 'object', }, apiURL: { - description: 'The WeChat API URL.', + description: 'apiURL defines the WeChat API URL.\nWhen not specified, defaults to the standard WeChat Work API endpoint.', type: 'string', }, corpID: { - description: 'The corp id for authentication.', + description: 'corpID defines the corp id for authentication.\nThis is the unique identifier for your WeChat Work organization.', type: 'string', }, httpConfig: { - description: 'HTTP client configuration.', + description: 'httpConfig defines the HTTP client configuration for WeChat API requests.', properties: { authorization: { - description: 'Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', + description: 'authorization defines the authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.', properties: { credentials: { - description: 'Selects a key of a Secret in the namespace that contains the credentials for authentication.', + description: 'credentials defines a key of a Secret in the namespace that contains the credentials for authentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9932,17 +9962,17 @@ 'x-kubernetes-map-type': 'atomic', }, type: { - description: 'Defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', + description: 'type defines the authentication type. The value is case-insensitive.\n\n"Basic" is not a supported value.\n\nDefault: "Bearer"', type: 'string', }, }, type: 'object', }, basicAuth: { - description: 'BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', + description: 'basicAuth defines the basic authentication credentials for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.', properties: { password: { - description: '`password` specifies a key of a Secret containing the password for\nauthentication.', + description: 'password defines a key of a Secret containing the password for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9965,7 +9995,7 @@ 'x-kubernetes-map-type': 'atomic', }, username: { - description: '`username` specifies a key of a Secret containing the username for\nauthentication.', + description: 'username defines a key of a Secret containing the username for\nauthentication.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -9991,15 +10021,15 @@ type: 'object', }, bearerTokenSecret: { - description: "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", + description: "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the AlertmanagerConfig\nobject and accessible by the Prometheus Operator.", properties: { key: { - description: 'The key of the secret to select from. Must be a valid secret key.', + description: 'key defines the key of the secret to select from. Must be a valid secret key.', minLength: 1, type: 'string', }, name: { - description: "The name of the secret in the object's namespace to select from.", + description: "name defines the name of the secret in the object's namespace to select from.", minLength: 1, type: 'string', }, @@ -10011,21 +10041,21 @@ type: 'object', }, followRedirects: { - description: 'FollowRedirects specifies whether the client should follow HTTP 3xx redirects.', + description: 'followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nWhen true, the client will automatically follow redirect responses.', type: 'boolean', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, oauth2: { - description: 'OAuth2 client credentials used to fetch a token for the targets.', + description: 'oauth2 defines the OAuth2 client credentials used to fetch a token for the targets.\nThis enables OAuth2 authentication flow for HTTP requests.', properties: { clientId: { - description: "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + description: "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -10048,7 +10078,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -10074,7 +10104,7 @@ type: 'object', }, clientSecret: { - description: "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + description: "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -10100,11 +10130,11 @@ additionalProperties: { type: 'string', }, - description: '`endpointParams` configures the HTTP parameters to append to the token\nURL.', + description: 'endpointParams configures the HTTP parameters to append to the token\nURL.', type: 'object', }, noProxy: { - description: '`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'string', }, proxyConnectHeader: { @@ -10134,34 +10164,34 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, scopes: { - description: '`scopes` defines the OAuth2 scopes used for the token request.', + description: 'scopes defines the OAuth2 scopes used for the token request.', items: { type: 'string', }, type: 'array', }, tlsConfig: { - description: 'TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', + description: 'tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -10184,7 +10214,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -10210,10 +10240,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -10236,7 +10266,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -10262,11 +10292,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -10289,7 +10319,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -10299,7 +10329,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -10309,14 +10339,14 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, type: 'object', }, tokenUrl: { - description: '`tokenURL` configures the URL to fetch the token from.', + description: 'tokenUrl defines the URL to fetch the token from.', minLength: 1, type: 'string', }, @@ -10355,31 +10385,31 @@ }, type: 'array', }, - description: 'ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'object', 'x-kubernetes-map-type': 'atomic', }, proxyFromEnvironment: { - description: 'Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', + description: 'proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.', type: 'boolean', }, proxyURL: { - description: 'Optional proxy URL.\n\nIf defined, this field takes precedence over `proxyUrl`.', + description: 'proxyURL defines an optional proxy URL for HTTP requests.\nIf defined, this field takes precedence over `proxyUrl`.', type: 'string', }, proxyUrl: { - description: '`proxyURL` defines the HTTP proxy server to use.', + description: 'proxyUrl defines the HTTP proxy server to use.', pattern: '^(http|https|socks5)://.+$', type: 'string', }, tlsConfig: { - description: 'TLS configuration for the client.', + description: 'tlsConfig defines the TLS configuration for the client.\nThis includes settings for certificates, CA validation, and TLS protocol options.', properties: { ca: { - description: 'Certificate authority used when verifying server certificates.', + description: 'ca defines the Certificate authority used when verifying server certificates.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -10402,7 +10432,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -10428,10 +10458,10 @@ type: 'object', }, cert: { - description: 'Client certificate to present when doing client-authentication.', + description: 'cert defines the Client certificate to present when doing client-authentication.', properties: { configMap: { - description: 'ConfigMap containing data to use for the targets.', + description: 'configMap defines the ConfigMap containing data to use for the targets.', properties: { key: { description: 'The key to select.', @@ -10454,7 +10484,7 @@ 'x-kubernetes-map-type': 'atomic', }, secret: { - description: 'Secret containing data to use for the targets.', + description: 'secret defines the Secret containing data to use for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -10480,11 +10510,11 @@ type: 'object', }, insecureSkipVerify: { - description: 'Disable target certificate validation.', + description: 'insecureSkipVerify defines how to disable target certificate validation.', type: 'boolean', }, keySecret: { - description: 'Secret containing the client key file for the targets.', + description: 'keySecret defines the Secret containing the client key file for the targets.', properties: { key: { description: 'The key of the secret to select from. Must be a valid secret key.', @@ -10507,7 +10537,7 @@ 'x-kubernetes-map-type': 'atomic', }, maxVersion: { - description: 'Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', + description: 'maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.', enum: [ 'TLS10', 'TLS11', @@ -10517,7 +10547,7 @@ type: 'string', }, minVersion: { - description: 'Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', + description: 'minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.', enum: [ 'TLS10', 'TLS11', @@ -10527,7 +10557,7 @@ type: 'string', }, serverName: { - description: 'Used to verify the hostname for the targets.', + description: 'serverName is used to verify the hostname for the targets.', type: 'string', }, }, @@ -10537,23 +10567,27 @@ type: 'object', }, message: { - description: 'API request data as defined by the WeChat API.', + description: 'message defines the API request data as defined by the WeChat API.\nThis contains the actual notification content to be sent.', type: 'string', }, messageType: { + description: 'messageType defines the type of message to send.\nValid values include "text", "markdown", and other WeChat Work supported message types.', type: 'string', }, sendResolved: { - description: 'Whether or not to notify about resolved alerts.', + description: 'sendResolved defines whether or not to notify about resolved alerts.', type: 'boolean', }, toParty: { + description: "toParty defines the target department(s) to receive the notification.\nCan be a single department ID or multiple department IDs separated by '|'.", type: 'string', }, toTag: { + description: "toTag defines the target tag(s) to receive the notification.\nCan be a single tag ID or multiple tag IDs separated by '|'.", type: 'string', }, toUser: { + description: "toUser defines the target user(s) to receive the notification.\nCan be a single user ID or multiple user IDs separated by '|'.", type: 'string', }, }, @@ -10570,41 +10604,41 @@ type: 'array', }, route: { - description: "The Alertmanager route definition for alerts matching the resource's\nnamespace. If present, it will be added to the generated Alertmanager\nconfiguration as a first-level route.", + description: "route defines the Alertmanager route definition for alerts matching the resource's\nnamespace. If present, it will be added to the generated Alertmanager\nconfiguration as a first-level route.", properties: { activeTimeIntervals: { - description: 'ActiveTimeIntervals is a list of TimeInterval names when this route should be active.', + description: 'activeTimeIntervals is a list of TimeInterval names when this route should be active.', items: { type: 'string', }, type: 'array', }, continue: { - description: 'Boolean indicating whether an alert should continue matching subsequent\nsibling nodes. It will always be overridden to true for the first-level\nroute by the Prometheus operator.', + description: 'continue defines the boolean indicating whether an alert should continue matching subsequent\nsibling nodes. It will always be overridden to true for the first-level\nroute by the Prometheus operator.', type: 'boolean', }, groupBy: { - description: 'List of labels to group by.\nLabels must not be repeated (unique list).\nSpecial label "..." (aggregate by all possible labels), if provided, must be the only element in the list.', + description: 'groupBy defines the list of labels to group by.\nLabels must not be repeated (unique list).\nSpecial label "..." (aggregate by all possible labels), if provided, must be the only element in the list.', items: { type: 'string', }, type: 'array', }, groupInterval: { - description: 'How long to wait before sending an updated notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: "5m"', + description: 'groupInterval defines how long to wait before sending an updated notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: "5m"', type: 'string', }, groupWait: { - description: 'How long to wait before sending the initial notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: "30s"', + description: 'groupWait defines how long to wait before sending the initial notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: "30s"', type: 'string', }, matchers: { - description: "List of matchers that the alert's labels should match. For the first\nlevel route, the operator removes any existing equality and regexp\nmatcher on the `namespace` label and adds a `namespace: ` matcher.", + description: "matchers defines the list of matchers that the alert's labels should match. For the first\nlevel route, the operator removes any existing equality and regexp\nmatcher on the `namespace` label and adds a `namespace: ` matcher.", items: { description: "Matcher defines how to match on alert's labels.", properties: { matchType: { - description: 'Match operator, one of `=` (equal to), `!=` (not equal to), `=~` (regex\nmatch) or `!~` (not regex match).\nNegative operators (`!=` and `!~`) require Alertmanager >= v0.22.0.', + description: 'matchType defines the match operation available with AlertManager >= v0.22.0.\nTakes precedence over Regex (deprecated) if non-empty.\nValid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match).', enum: [ '!=', '=', @@ -10614,12 +10648,12 @@ type: 'string', }, name: { - description: 'Label to match.', + description: 'name defines the label to match.\nThis specifies which alert label should be evaluated.', minLength: 1, type: 'string', }, value: { - description: 'Label value to match.', + description: 'value defines the label value to match.\nThis is the expected value for the specified label.', type: 'string', }, }, @@ -10631,22 +10665,22 @@ type: 'array', }, muteTimeIntervals: { - description: "Note: this comment applies to the field definition above but appears\nbelow otherwise it gets included in the generated manifest.\nCRD schema doesn't support self-referential types for now (see\nhttps://github.com/kubernetes/kubernetes/issues/62872). We have to use\nan alternative type to circumvent the limitation. The downside is that\nthe Kube API can't validate the data beyond the fact that it is a valid\nJSON representation.\nMuteTimeIntervals is a list of TimeInterval names that will mute this route when matched.", + description: 'muteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched,', items: { type: 'string', }, type: 'array', }, receiver: { - description: 'Name of the receiver for this route. If not empty, it should be listed in\nthe `receivers` field.', + description: 'receiver defines the name of the receiver for this route. If not empty, it should be listed in\nthe `receivers` field.', type: 'string', }, repeatInterval: { - description: 'How long to wait before repeating the last notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: "4h"', + description: 'repeatInterval defines how long to wait before repeating the last notification.\nMust match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$`\nExample: "4h"', type: 'string', }, routes: { - description: 'Child routes.', + description: 'routes defines the child routes.', items: { 'x-kubernetes-preserve-unknown-fields': true, }, @@ -10656,32 +10690,32 @@ type: 'object', }, timeIntervals: { - description: 'List of TimeInterval specifying when the routes should be muted or active.', + description: 'timeIntervals defines the list of timeIntervals specifying when the routes should be muted.', items: { description: 'TimeInterval specifies the periods in time when notifications will be muted or active.', properties: { name: { - description: 'Name of the time interval.', + description: 'name of the time interval.', type: 'string', }, timeIntervals: { - description: 'TimeIntervals is a list of TimePeriod.', + description: 'timeIntervals defines a list of TimePeriod.', items: { description: 'TimePeriod describes periods of time.', properties: { daysOfMonth: { - description: 'DaysOfMonth is a list of DayOfMonthRange', + description: 'daysOfMonth defines a list of DayOfMonthRange', items: { description: 'DayOfMonthRange is an inclusive range of days of the month beginning at 1', properties: { end: { - description: 'End of the inclusive range', + description: 'end of the inclusive range', maximum: 31, minimum: -31, type: 'integer', }, start: { - description: 'Start of the inclusive range', + description: 'start of the inclusive range', maximum: 31, minimum: -31, type: 'integer', @@ -10692,7 +10726,7 @@ type: 'array', }, months: { - description: 'Months is a list of MonthRange', + description: 'months defines a list of MonthRange', items: { description: "MonthRange is an inclusive range of months of the year beginning in January\nMonths can be specified by name (e.g 'January') by numerical month (e.g '1') or as an inclusive range (e.g 'January:March', '1:3', '1:March')", pattern: '^((?i)january|february|march|april|may|june|july|august|september|october|november|december|1[0-2]|[1-9])(?:((:((?i)january|february|march|april|may|june|july|august|september|october|november|december|1[0-2]|[1-9]))$)|$)', @@ -10701,17 +10735,17 @@ type: 'array', }, times: { - description: 'Times is a list of TimeRange', + description: 'times defines a list of TimeRange', items: { description: 'TimeRange defines a start and end time in 24hr format', properties: { endTime: { - description: 'EndTime is the end time in 24hr format.', + description: 'endTime defines the end time in 24hr format.', pattern: '^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)', type: 'string', }, startTime: { - description: 'StartTime is the start time in 24hr format.', + description: 'startTime defines the start time in 24hr format.', pattern: '^((([01][0-9])|(2[0-3])):[0-5][0-9])$|(^24:00$)', type: 'string', }, @@ -10721,7 +10755,7 @@ type: 'array', }, weekdays: { - description: 'Weekdays is a list of WeekdayRange', + description: 'weekdays defines a list of WeekdayRange', items: { description: "WeekdayRange is an inclusive range of days of the week beginning on Sunday\nDays can be specified by name (e.g 'Sunday') or as an inclusive range (e.g 'Monday:Friday')", pattern: '^((?i)sun|mon|tues|wednes|thurs|fri|satur)day(?:((:(sun|mon|tues|wednes|thurs|fri|satur)day)$)|$)', @@ -10730,7 +10764,7 @@ type: 'array', }, years: { - description: 'Years is a list of YearRange', + description: 'years defines a list of YearRange', items: { description: 'YearRange is an inclusive range of years', pattern: '^2\\d{3}(?::2\\d{3}|$)', diff --git a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/alertmanagers-crd.json b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/alertmanagers-crd.json index 41d7506c..c02e0ba2 100644 --- a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/alertmanagers-crd.json +++ b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/alertmanagers-crd.json @@ -3,7 +3,7 @@ "kind": "CustomResourceDefinition", "metadata": { "annotations": { - "controller-gen.kubebuilder.io/version": "v0.18.0", + "controller-gen.kubebuilder.io/version": "v0.19.0", "operator.prometheus.io/version": "0.85.0" }, "name": "alertmanagers.monitoring.coreos.com" @@ -84,20 +84,20 @@ "type": "object" }, "spec": { - "description": "Specification of the desired behavior of the Alertmanager cluster. More info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", + "description": "spec defines the specification of the desired behavior of the Alertmanager cluster. More info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "additionalArgs": { - "description": "AdditionalArgs allows setting additional arguments for the 'Alertmanager' container.\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nAlertmanager container which may cause issues if they are invalid or not supported\nby the given Alertmanager version.", + "description": "additionalArgs allows setting additional arguments for the 'Alertmanager' container.\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nAlertmanager container which may cause issues if they are invalid or not supported\nby the given Alertmanager version.", "items": { "description": "Argument as part of the AdditionalArgs list.", "properties": { "name": { - "description": "Name of the argument, e.g. \"scrape.discovery-reload-interval\".", + "description": "name of the argument, e.g. \"scrape.discovery-reload-interval\".", "minLength": 1, "type": "string" }, "value": { - "description": "Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)", + "description": "value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)", "type": "string" } }, @@ -109,14 +109,14 @@ "type": "array" }, "additionalPeers": { - "description": "AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster.", + "description": "additionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster.", "items": { "type": "string" }, "type": "array" }, "affinity": { - "description": "If specified, the pod's scheduling constraints.", + "description": "affinity defines the pod's scheduling constraints.", "properties": { "nodeAffinity": { "description": "Describes node affinity scheduling rules for the pod.", @@ -871,11 +871,11 @@ "type": "object" }, "alertmanagerConfigMatcherStrategy": { - "description": "AlertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects\nprocess incoming alerts.", + "description": "alertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects\nprocess incoming alerts.", "properties": { "type": { "default": "OnNamespace", - "description": "AlertmanagerConfigMatcherStrategyType defines the strategy used by\nAlertmanagerConfig objects to match alerts in the routes and inhibition\nrules.\n\nThe default value is `OnNamespace`.", + "description": "type defines the strategy used by\nAlertmanagerConfig objects to match alerts in the routes and inhibition\nrules.\n\nThe default value is `OnNamespace`.", "enum": [ "OnNamespace", "OnNamespaceExceptForAlertmanagerNamespace", @@ -887,7 +887,7 @@ "type": "object" }, "alertmanagerConfigNamespaceSelector": { - "description": "Namespaces to be selected for AlertmanagerConfig discovery. If nil, only\ncheck own namespace.", + "description": "alertmanagerConfigNamespaceSelector defines the namespaces to be selected for AlertmanagerConfig discovery. If nil, only\ncheck own namespace.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -932,7 +932,7 @@ "x-kubernetes-map-type": "atomic" }, "alertmanagerConfigSelector": { - "description": "AlertmanagerConfigs to be selected for to merge and configure Alertmanager with.", + "description": "alertmanagerConfigSelector defines the selector to be used for to merge and configure Alertmanager with.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -977,19 +977,19 @@ "x-kubernetes-map-type": "atomic" }, "alertmanagerConfiguration": { - "description": "alertmanagerConfiguration specifies the configuration of Alertmanager.\n\nIf defined, it takes precedence over the `configSecret` field.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", + "description": "alertmanagerConfiguration defines the configuration of Alertmanager.\n\nIf defined, it takes precedence over the `configSecret` field.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "properties": { "global": { - "description": "Defines the global parameters of the Alertmanager configuration.", + "description": "global defines the global parameters of the Alertmanager configuration.", "properties": { "httpConfig": { - "description": "HTTP client configuration.", + "description": "httpConfig defines the default HTTP configuration.", "properties": { "authorization": { - "description": "Authorization header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", + "description": "authorization defines the header configuration for the client.\nThis is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1012,17 +1012,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", + "description": "basicAuth defines basicAuth for the client.\nThis is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1045,7 +1045,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1071,7 +1071,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "The secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the Alertmanager\nobject and accessible by the Prometheus Operator.", + "description": "bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client\nfor authentication.\nThe secret needs to be in the same namespace as the Alertmanager\nobject and accessible by the Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1094,21 +1094,21 @@ "x-kubernetes-map-type": "atomic" }, "followRedirects": { - "description": "FollowRedirects specifies whether the client should follow HTTP 3xx redirects.", + "description": "followRedirects defines whether the client should follow HTTP 3xx redirects.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 client credentials used to fetch a token for the targets.", + "description": "oauth2 defines the client credentials used to fetch a token for the targets.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1131,7 +1131,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1157,7 +1157,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1183,11 +1183,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -1217,34 +1217,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1267,7 +1267,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1293,10 +1293,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1319,7 +1319,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1345,11 +1345,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1372,7 +1372,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -1382,7 +1382,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -1392,14 +1392,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -1438,27 +1438,27 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration for the client.", + "description": "tlsConfig defines the TLSConfig for the client.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1481,7 +1481,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1507,10 +1507,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1533,7 +1533,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1559,11 +1559,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1586,7 +1586,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -1596,7 +1596,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -1606,7 +1606,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -1616,10 +1616,10 @@ "type": "object" }, "jira": { - "description": "The default configuration for Jira.", + "description": "jira defines the default configuration for Jira.", "properties": { "apiURL": { - "description": "The default Jira API URL.\n\nIt requires Alertmanager >= v0.28.0.", + "description": "apiURL defines the default Jira API URL.\n\nIt requires Alertmanager >= v0.28.0.", "pattern": "^(http|https)://.+$", "type": "string" } @@ -1627,7 +1627,7 @@ "type": "object" }, "opsGenieApiKey": { - "description": "The default OpsGenie API Key.", + "description": "opsGenieApiKey defines the default OpsGenie API Key.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1650,7 +1650,7 @@ "x-kubernetes-map-type": "atomic" }, "opsGenieApiUrl": { - "description": "The default OpsGenie API URL.", + "description": "opsGenieApiUrl defines the default OpsGenie API URL.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1673,24 +1673,24 @@ "x-kubernetes-map-type": "atomic" }, "pagerdutyUrl": { - "description": "The default Pagerduty URL.", + "description": "pagerdutyUrl defines the default Pagerduty URL.", "type": "string" }, "resolveTimeout": { - "description": "ResolveTimeout is the default value used by alertmanager if the alert does\nnot include EndsAt, after this time passes it can declare the alert as resolved if it has not been updated.\nThis has no impact on alerts from Prometheus, as they always include EndsAt.", + "description": "resolveTimeout defines the default value used by alertmanager if the alert does\nnot include EndsAt, after this time passes it can declare the alert as resolved if it has not been updated.\nThis has no impact on alerts from Prometheus, as they always include EndsAt.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "rocketChat": { - "description": "The default configuration for Rocket Chat.", + "description": "rocketChat defines the default configuration for Rocket Chat.", "properties": { "apiURL": { - "description": "The default Rocket Chat API URL.\n\nIt requires Alertmanager >= v0.28.0.", + "description": "apiURL defines the default Rocket Chat API URL.\n\nIt requires Alertmanager >= v0.28.0.", "pattern": "^(http|https)://.+$", "type": "string" }, "token": { - "description": "The default Rocket Chat token.\n\nIt requires Alertmanager >= v0.28.0.", + "description": "token defines the default Rocket Chat token.\n\nIt requires Alertmanager >= v0.28.0.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1713,7 +1713,7 @@ "x-kubernetes-map-type": "atomic" }, "tokenID": { - "description": "The default Rocket Chat Token ID.\n\nIt requires Alertmanager >= v0.28.0.", + "description": "tokenID defines the default Rocket Chat Token ID.\n\nIt requires Alertmanager >= v0.28.0.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1739,7 +1739,7 @@ "type": "object" }, "slackApiUrl": { - "description": "The default Slack API URL.", + "description": "slackApiUrl defines the default Slack API URL.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1762,14 +1762,14 @@ "x-kubernetes-map-type": "atomic" }, "smtp": { - "description": "Configures global SMTP parameters.", + "description": "smtp defines global SMTP parameters.", "properties": { "authIdentity": { - "description": "SMTP Auth using PLAIN", + "description": "authIdentity represents SMTP Auth using PLAIN", "type": "string" }, "authPassword": { - "description": "SMTP Auth using LOGIN and PLAIN.", + "description": "authPassword represents SMTP Auth using LOGIN and PLAIN.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1792,7 +1792,7 @@ "x-kubernetes-map-type": "atomic" }, "authSecret": { - "description": "SMTP Auth using CRAM-MD5.", + "description": "authSecret represents SMTP Auth using CRAM-MD5.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1815,31 +1815,31 @@ "x-kubernetes-map-type": "atomic" }, "authUsername": { - "description": "SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server.", + "description": "authUsername represents SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server.", "type": "string" }, "from": { - "description": "The default SMTP From header field.", + "description": "from defines the default SMTP From header field.", "type": "string" }, "hello": { - "description": "The default hostname to identify to the SMTP server.", + "description": "hello defines the default hostname to identify to the SMTP server.", "type": "string" }, "requireTLS": { - "description": "The default SMTP TLS requirement.\nNote that Go does not support unencrypted connections to remote SMTP endpoints.", + "description": "requireTLS defines the default SMTP TLS requirement.\nNote that Go does not support unencrypted connections to remote SMTP endpoints.", "type": "boolean" }, "smartHost": { - "description": "The default SMTP smarthost used for sending emails.", + "description": "smartHost defines the default SMTP smarthost used for sending emails.", "properties": { "host": { - "description": "Defines the host's address, it can be a DNS name or a literal IP address.", + "description": "host defines the host's address, it can be a DNS name or a literal IP address.", "minLength": 1, "type": "string" }, "port": { - "description": "Defines the host's port, it can be a literal port number or a port name.", + "description": "port defines the host's port, it can be a literal port number or a port name.", "minLength": 1, "type": "string" } @@ -1851,13 +1851,13 @@ "type": "object" }, "tlsConfig": { - "description": "The default TLS configuration for SMTP receivers", + "description": "tlsConfig defines the default TLS configuration for SMTP receivers", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1880,7 +1880,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1906,10 +1906,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1932,7 +1932,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1958,11 +1958,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1985,7 +1985,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -1995,7 +1995,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -2005,7 +2005,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -2015,10 +2015,10 @@ "type": "object" }, "telegram": { - "description": "The default Telegram config", + "description": "telegram defines the default Telegram config", "properties": { "apiURL": { - "description": "The default Telegram API URL.\n\nIt requires Alertmanager >= v0.24.0.", + "description": "apiURL defines he default Telegram API URL.\n\nIt requires Alertmanager >= v0.24.0.", "pattern": "^(http|https)://.+$", "type": "string" } @@ -2026,10 +2026,10 @@ "type": "object" }, "victorops": { - "description": "The default configuration for VictorOps.", + "description": "victorops defines the default configuration for VictorOps.", "properties": { "apiKey": { - "description": "The default VictorOps API Key.", + "description": "apiKey defines the default VictorOps API Key.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2052,7 +2052,7 @@ "x-kubernetes-map-type": "atomic" }, "apiURL": { - "description": "The default VictorOps API URL.", + "description": "apiURL defines the default VictorOps API URL.", "pattern": "^(http|https)://.+$", "type": "string" } @@ -2060,10 +2060,10 @@ "type": "object" }, "webex": { - "description": "The default configuration for Jira.", + "description": "webex defines the default configuration for Jira.", "properties": { "apiURL": { - "description": "The default Webex API URL.\n\nIt requires Alertmanager >= v0.25.0.", + "description": "apiURL defines the is the default Webex API URL.\n\nIt requires Alertmanager >= v0.25.0.", "pattern": "^(http|https)://.+$", "type": "string" } @@ -2071,15 +2071,15 @@ "type": "object" }, "wechat": { - "description": "The default WeChat Config", + "description": "wechat defines the default WeChat Config", "properties": { "apiCorpID": { - "description": "The default WeChat API Corporate ID.", + "description": "apiCorpID defines the default WeChat API Corporate ID.", "minLength": 1, "type": "string" }, "apiSecret": { - "description": "The default WeChat API Secret.", + "description": "apiSecret defines the default WeChat API Secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2102,7 +2102,7 @@ "x-kubernetes-map-type": "atomic" }, "apiURL": { - "description": "The default WeChat API URL.\nThe default value is \"https://qyapi.weixin.qq.com/cgi-bin/\"", + "description": "apiURL defines he default WeChat API URL.\nThe default value is \"https://qyapi.weixin.qq.com/cgi-bin/\"", "pattern": "^(http|https)://.+$", "type": "string" } @@ -2113,17 +2113,17 @@ "type": "object" }, "name": { - "description": "The name of the AlertmanagerConfig resource which is used to generate the Alertmanager configuration.\nIt must be defined in the same namespace as the Alertmanager object.\nThe operator will not enforce a `namespace` label for routes and inhibition rules.", + "description": "name defines the name of the AlertmanagerConfig custom resource which is used to generate the Alertmanager configuration.\nIt must be defined in the same namespace as the Alertmanager object.\nThe operator will not enforce a `namespace` label for routes and inhibition rules.", "minLength": 1, "type": "string" }, "templates": { - "description": "Custom notification templates.", + "description": "templates defines the custom notification templates.", "items": { "description": "SecretOrConfigMap allows to specify data as a Secret or ConfigMap. Fields are mutually exclusive.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2146,7 +2146,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2177,47 +2177,47 @@ "type": "object" }, "automountServiceAccountToken": { - "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod.\nIf the service account has `automountServiceAccountToken: true`, set the field to `false` to opt out of automounting API credentials.", + "description": "automountServiceAccountToken defines whether a service account token should be automatically mounted in the pod.\nIf the service account has `automountServiceAccountToken: true`, set the field to `false` to opt out of automounting API credentials.", "type": "boolean" }, "baseImage": { - "description": "Base image that is used to deploy pods, without tag.\nDeprecated: use 'image' instead.", + "description": "baseImage that is used to deploy pods, without tag.\nDeprecated: use 'image' instead.", "type": "string" }, "clusterAdvertiseAddress": { - "description": "ClusterAdvertiseAddress is the explicit address to advertise in cluster.\nNeeds to be provided for non RFC1918 [1] (public) addresses.\n[1] RFC1918: https://tools.ietf.org/html/rfc1918", + "description": "clusterAdvertiseAddress defines the explicit address to advertise in cluster.\nNeeds to be provided for non RFC1918 [1] (public) addresses.\n[1] RFC1918: https://tools.ietf.org/html/rfc1918", "type": "string" }, "clusterGossipInterval": { - "description": "Interval between gossip attempts.", + "description": "clusterGossipInterval defines the interval between gossip attempts.", "pattern": "^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "clusterLabel": { - "description": "Defines the identifier that uniquely identifies the Alertmanager cluster.\nYou should only set it when the Alertmanager cluster includes Alertmanager instances which are external to this Alertmanager resource. In practice, the addresses of the external instances are provided via the `.spec.additionalPeers` field.", + "description": "clusterLabel defines the identifier that uniquely identifies the Alertmanager cluster.\nYou should only set it when the Alertmanager cluster includes Alertmanager instances which are external to this Alertmanager resource. In practice, the addresses of the external instances are provided via the `.spec.additionalPeers` field.", "type": "string" }, "clusterPeerTimeout": { - "description": "Timeout for cluster peering.", + "description": "clusterPeerTimeout defines the timeout for cluster peering.", "pattern": "^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "clusterPushpullInterval": { - "description": "Interval between pushpull attempts.", + "description": "clusterPushpullInterval defines the interval between pushpull attempts.", "pattern": "^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "clusterTLS": { - "description": "Configures the mutual TLS configuration for the Alertmanager cluster's gossip protocol.\n\nIt requires Alertmanager >= 0.24.0.", + "description": "clusterTLS defines the mutual TLS configuration for the Alertmanager cluster's gossip protocol.\n\nIt requires Alertmanager >= 0.24.0.", "properties": { "client": { - "description": "Client-side configuration for mutual TLS.", + "description": "client defines the client-side configuration for mutual TLS.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2240,7 +2240,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2266,10 +2266,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2292,7 +2292,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2318,11 +2318,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2345,7 +2345,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -2355,7 +2355,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -2365,20 +2365,20 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "server": { - "description": "Server-side configuration for mutual TLS.", + "description": "server defines the server-side configuration for mutual TLS.", "properties": { "cert": { - "description": "Secret or ConfigMap containing the TLS certificate for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `certFile`.", + "description": "cert defines the Secret or ConfigMap containing the TLS certificate for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `certFile`.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2401,7 +2401,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2427,29 +2427,29 @@ "type": "object" }, "certFile": { - "description": "Path to the TLS certificate file in the container for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `cert`.", + "description": "certFile defines the path to the TLS certificate file in the container for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `cert`.", "type": "string" }, "cipherSuites": { - "description": "List of supported cipher suites for TLS versions up to TLS 1.2.\n\nIf not defined, the Go default cipher suites are used.\nAvailable cipher suites are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#pkg-constants", + "description": "cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2.\n\nIf not defined, the Go default cipher suites are used.\nAvailable cipher suites are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#pkg-constants", "items": { "type": "string" }, "type": "array" }, "clientAuthType": { - "description": "The server policy for client TLS authentication.\n\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType", + "description": "clientAuthType defines the server policy for client TLS authentication.\n\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType", "type": "string" }, "clientCAFile": { - "description": "Path to the CA certificate file for client certificate authentication to\nthe server.\n\nIt is mutually exclusive with `client_ca`.", + "description": "clientCAFile defines the path to the CA certificate file for client certificate authentication to\nthe server.\n\nIt is mutually exclusive with `client_ca`.", "type": "string" }, "client_ca": { - "description": "Secret or ConfigMap containing the CA certificate for client certificate\nauthentication to the server.\n\nIt is mutually exclusive with `clientCAFile`.", + "description": "client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate\nauthentication to the server.\n\nIt is mutually exclusive with `clientCAFile`.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2472,7 +2472,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2498,18 +2498,18 @@ "type": "object" }, "curvePreferences": { - "description": "Elliptic curves that will be used in an ECDHE handshake, in preference\norder.\n\nAvailable curves are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID", + "description": "curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference\norder.\n\nAvailable curves are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID", "items": { "type": "string" }, "type": "array" }, "keyFile": { - "description": "Path to the TLS private key file in the container for the web server.\n\nIf defined, either `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keySecret`.", + "description": "keyFile defines the path to the TLS private key file in the container for the web server.\n\nIf defined, either `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keySecret`.", "type": "string" }, "keySecret": { - "description": "Secret containing the TLS private key for the web server.\n\nEither `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keyFile`.", + "description": "keySecret defines the secret containing the TLS private key for the web server.\n\nEither `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keyFile`.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2532,15 +2532,15 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum TLS version that is acceptable.", + "description": "maxVersion defines the Maximum TLS version that is acceptable.", "type": "string" }, "minVersion": { - "description": "Minimum TLS version that is acceptable.", + "description": "minVersion defines the minimum TLS version that is acceptable.", "type": "string" }, "preferServerCipherSuites": { - "description": "Controls whether the server selects the client's most preferred cipher\nsuite, or the server's most preferred cipher suite.\n\nIf true then the server's preference, as expressed in\nthe order of elements in cipherSuites, is used.", + "description": "preferServerCipherSuites defines whether the server selects the client's most preferred cipher\nsuite, or the server's most preferred cipher suite.\n\nIf true then the server's preference, as expressed in\nthe order of elements in cipherSuites, is used.", "type": "boolean" } }, @@ -2554,18 +2554,18 @@ "type": "object" }, "configMaps": { - "description": "ConfigMaps is a list of ConfigMaps in the same namespace as the Alertmanager\nobject, which shall be mounted into the Alertmanager Pods.\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-`.\nThe ConfigMaps are mounted into `/etc/alertmanager/configmaps/` in the 'alertmanager' container.", + "description": "configMaps defines a list of ConfigMaps in the same namespace as the Alertmanager\nobject, which shall be mounted into the Alertmanager Pods.\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-`.\nThe ConfigMaps are mounted into `/etc/alertmanager/configmaps/` in the 'alertmanager' container.", "items": { "type": "string" }, "type": "array" }, "configSecret": { - "description": "ConfigSecret is the name of a Kubernetes Secret in the same namespace as the\nAlertmanager object, which contains the configuration for this Alertmanager\ninstance. If empty, it defaults to `alertmanager-`.\n\nThe Alertmanager configuration should be available under the\n`alertmanager.yaml` key. Additional keys from the original secret are\ncopied to the generated secret and mounted into the\n`/etc/alertmanager/config` directory in the `alertmanager` container.\n\nIf either the secret or the `alertmanager.yaml` key is missing, the\noperator provisions a minimal Alertmanager configuration with one empty\nreceiver (effectively dropping alert notifications).", + "description": "configSecret defines the name of a Kubernetes Secret in the same namespace as the\nAlertmanager object, which contains the configuration for this Alertmanager\ninstance. If empty, it defaults to `alertmanager-`.\n\nThe Alertmanager configuration should be available under the\n`alertmanager.yaml` key. Additional keys from the original secret are\ncopied to the generated secret and mounted into the\n`/etc/alertmanager/config` directory in the `alertmanager` container.\n\nIf either the secret or the `alertmanager.yaml` key is missing, the\noperator provisions a minimal Alertmanager configuration with one empty\nreceiver (effectively dropping alert notifications).", "type": "string" }, "containers": { - "description": "Containers allows injecting additional containers. This is meant to\nallow adding an authentication proxy to an Alertmanager pod.\nContainers described here modify an operator generated container if they\nshare the same name and modifications are done via a strategic merge\npatch. The current container names are: `alertmanager` and\n`config-reloader`. Overriding containers is entirely outside the scope\nof what the maintainers will support and by doing so, you accept that\nthis behaviour may break at any time without notice.", + "description": "containers allows injecting additional containers. This is meant to\nallow adding an authentication proxy to an Alertmanager pod.\nContainers described here modify an operator generated container if they\nshare the same name and modifications are done via a strategic merge\npatch. The current container names are: `alertmanager` and\n`config-reloader`. Overriding containers is entirely outside the scope\nof what the maintainers will support and by doing so, you accept that\nthis behaviour may break at any time without notice.", "items": { "description": "A single application container that you want to run within a pod.", "properties": { @@ -3903,10 +3903,10 @@ "type": "array" }, "dnsConfig": { - "description": "Defines the DNS configuration for the pods.", + "description": "dnsConfig defines the DNS configuration for the pods.", "properties": { "nameservers": { - "description": "A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.", + "description": "nameservers defines the list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.", "items": { "minLength": 1, "type": "string" @@ -3915,17 +3915,17 @@ "x-kubernetes-list-type": "set" }, "options": { - "description": "A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nResolution options given in Options\nwill override those that appear in the base DNSPolicy.", + "description": "options defines the list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nResolution options given in Options\nwill override those that appear in the base DNSPolicy.", "items": { "description": "PodDNSConfigOption defines DNS resolver options of a pod.", "properties": { "name": { - "description": "Name is required and must be unique.", + "description": "name is required and must be unique.", "minLength": 1, "type": "string" }, "value": { - "description": "Value is optional.", + "description": "value is optional.", "type": "string" } }, @@ -3941,7 +3941,7 @@ "x-kubernetes-list-type": "map" }, "searches": { - "description": "A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.", + "description": "searches defines the list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.", "items": { "minLength": 1, "type": "string" @@ -3953,7 +3953,7 @@ "type": "object" }, "dnsPolicy": { - "description": "Defines the DNS policy for the pods.", + "description": "dnsPolicy defines the DNS policy for the pods.", "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", @@ -3963,38 +3963,38 @@ "type": "string" }, "enableFeatures": { - "description": "Enable access to Alertmanager feature flags. By default, no features are enabled.\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\nIt requires Alertmanager >= 0.27.0.", + "description": "enableFeatures defines the Alertmanager's feature flags. By default, no features are enabled.\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\nIt requires Alertmanager >= 0.27.0.", "items": { "type": "string" }, "type": "array" }, "enableServiceLinks": { - "description": "Indicates whether information about services should be injected into pod's environment variables", + "description": "enableServiceLinks defines whether information about services should be injected into pod's environment variables", "type": "boolean" }, "externalUrl": { - "description": "The external URL the Alertmanager instances will be available under. This is\nnecessary to generate correct URLs. This is necessary if Alertmanager is not\nserved from root of a DNS name.", + "description": "externalUrl defines the URL used to access the Alertmanager web service. This is\nnecessary to generate correct URLs. This is necessary if Alertmanager is not\nserved from root of a DNS name.", "type": "string" }, "forceEnableClusterMode": { - "description": "ForceEnableClusterMode ensures Alertmanager does not deactivate the cluster mode when running with a single replica.\nUse case is e.g. spanning an Alertmanager cluster across Kubernetes clusters with a single replica in each.", + "description": "forceEnableClusterMode ensures Alertmanager does not deactivate the cluster mode when running with a single replica.\nUse case is e.g. spanning an Alertmanager cluster across Kubernetes clusters with a single replica in each.", "type": "boolean" }, "hostAliases": { - "description": "Pods' hostAliases configuration", + "description": "hostAliases Pods configuration", "items": { "description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the\npod's hosts file.", "properties": { "hostnames": { - "description": "Hostnames for the above IP address.", + "description": "hostnames defines hostnames for the above IP address.", "items": { "type": "string" }, "type": "array" }, "ip": { - "description": "IP address of the host file entry.", + "description": "ip defines the IP address of the host file entry.", "type": "string" } }, @@ -4011,15 +4011,15 @@ "x-kubernetes-list-type": "map" }, "hostUsers": { - "description": "HostUsers supports the user space in Kubernetes.\n\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/\n\nThe feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled.\nStarting Kubernetes 1.33, the feature is enabled by default.", + "description": "hostUsers supports the user space in Kubernetes.\n\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/\n\nThe feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled.\nStarting Kubernetes 1.33, the feature is enabled by default.", "type": "boolean" }, "image": { - "description": "Image if specified has precedence over baseImage, tag and sha\ncombinations. Specifying the version is still necessary to ensure the\nPrometheus Operator knows what version of Alertmanager is being\nconfigured.", + "description": "image if specified has precedence over baseImage, tag and sha\ncombinations. Specifying the version is still necessary to ensure the\nPrometheus Operator knows what version of Alertmanager is being\nconfigured.", "type": "string" }, "imagePullPolicy": { - "description": "Image pull policy for the 'alertmanager', 'init-config-reloader' and 'config-reloader' containers.\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.", + "description": "imagePullPolicy for the 'alertmanager', 'init-config-reloader' and 'config-reloader' containers.\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.", "enum": [ "", "Always", @@ -4029,7 +4029,7 @@ "type": "string" }, "imagePullSecrets": { - "description": "An optional list of references to secrets in the same namespace\nto use for pulling prometheus and alertmanager images from registries\nsee https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/", + "description": "imagePullSecrets An optional list of references to secrets in the same namespace\nto use for pulling prometheus and alertmanager images from registries\nsee https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/", "items": { "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { @@ -4045,7 +4045,7 @@ "type": "array" }, "initContainers": { - "description": "InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\nfetch secrets for injection into the Alertmanager configuration from external sources. Any\nerrors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator\ngenerated init containers if they share the same name and modifications are\ndone via a strategic merge patch. The current init container name is:\n`init-config-reloader`. Overriding init containers is entirely outside the\nscope of what the maintainers will support and by doing so, you accept that\nthis behaviour may break at any time without notice.", + "description": "initContainers allows adding initContainers to the pod definition. Those can be used to e.g.\nfetch secrets for injection into the Alertmanager configuration from external sources. Any\nerrors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator\ngenerated init containers if they share the same name and modifications are\ndone via a strategic merge patch. The current init container name is:\n`init-config-reloader`. Overriding init containers is entirely outside the\nscope of what the maintainers will support and by doing so, you accept that\nthis behaviour may break at any time without notice.", "items": { "description": "A single application container that you want to run within a pod.", "properties": { @@ -5383,15 +5383,15 @@ "type": "array" }, "limits": { - "description": "Defines the limits command line flags when starting Alertmanager.", + "description": "limits defines the limits command line flags when starting Alertmanager.", "properties": { "maxPerSilenceBytes": { - "description": "The maximum size of an individual silence as stored on disk. This corresponds to the Alertmanager's\n`--silences.max-per-silence-bytes` flag.\nIt requires Alertmanager >= v0.28.0.", + "description": "maxPerSilenceBytes defines the maximum size of an individual silence as stored on disk. This corresponds to the Alertmanager's\n`--silences.max-per-silence-bytes` flag.\nIt requires Alertmanager >= v0.28.0.", "pattern": "(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$", "type": "string" }, "maxSilences": { - "description": "The maximum number active and pending silences. This corresponds to the\nAlertmanager's `--silences.max-silences` flag.\nIt requires Alertmanager >= v0.28.0.", + "description": "maxSilences defines the maximum number active and pending silences. This corresponds to the\nAlertmanager's `--silences.max-silences` flag.\nIt requires Alertmanager >= v0.28.0.", "format": "int32", "minimum": 0, "type": "integer" @@ -5400,11 +5400,11 @@ "type": "object" }, "listenLocal": { - "description": "ListenLocal makes the Alertmanager server listen on loopback, so that it\ndoes not bind against the Pod IP. Note this is only for the Alertmanager\nUI, not the gossip communication.", + "description": "listenLocal defines the Alertmanager server listen on loopback, so that it\ndoes not bind against the Pod IP. Note this is only for the Alertmanager\nUI, not the gossip communication.", "type": "boolean" }, "logFormat": { - "description": "Log format for Alertmanager to be configured with.", + "description": "logFormat for Alertmanager to be configured with.", "enum": [ "", "logfmt", @@ -5413,7 +5413,7 @@ "type": "string" }, "logLevel": { - "description": "Log level for Alertmanager to be configured with.", + "description": "logLevel for Alertmanager to be configured with.", "enum": [ "", "debug", @@ -5424,7 +5424,7 @@ "type": "string" }, "minReadySeconds": { - "description": "Minimum number of seconds for which a newly created pod should be ready\nwithout any of its container crashing for it to be considered available.\n\nIf unset, pods will be considered available as soon as they are ready.", + "description": "minReadySeconds defines the minimum number of seconds for which a newly created pod should be ready\nwithout any of its container crashing for it to be considered available.\n\nIf unset, pods will be considered available as soon as they are ready.", "format": "int32", "minimum": 0, "type": "integer" @@ -5433,15 +5433,15 @@ "additionalProperties": { "type": "string" }, - "description": "Define which Nodes the Pods are scheduled on.", + "description": "nodeSelector defines which Nodes the Pods are scheduled on.", "type": "object" }, "paused": { - "description": "If set to true all actions on the underlying managed objects are not\ngoing to be performed, except for delete actions.", + "description": "paused if set to true all actions on the underlying managed objects are not\ngoing to be performed, except for delete actions.", "type": "boolean" }, "persistentVolumeClaimRetentionPolicy": { - "description": "The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet.\nThe default behavior is all PVCs are retained.\nThis is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26.\nIt requires enabling the StatefulSetAutoDeletePVC feature gate.", + "description": "persistentVolumeClaimRetentionPolicy controls if and how PVCs are deleted during the lifecycle of a StatefulSet.\nThe default behavior is all PVCs are retained.\nThis is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26.\nIt requires enabling the StatefulSetAutoDeletePVC feature gate.", "properties": { "whenDeleted": { "description": "WhenDeleted specifies what happens to PVCs created from StatefulSet\nVolumeClaimTemplates when the StatefulSet is deleted. The default policy\nof `Retain` causes PVCs to not be affected by StatefulSet deletion. The\n`Delete` policy causes those PVCs to be deleted.", @@ -5455,24 +5455,24 @@ "type": "object" }, "podMetadata": { - "description": "PodMetadata configures labels and annotations which are propagated to the Alertmanager pods.\n\nThe following items are reserved and cannot be overridden:\n* \"alertmanager\" label, set to the name of the Alertmanager instance.\n* \"app.kubernetes.io/instance\" label, set to the name of the Alertmanager instance.\n* \"app.kubernetes.io/managed-by\" label, set to \"prometheus-operator\".\n* \"app.kubernetes.io/name\" label, set to \"alertmanager\".\n* \"app.kubernetes.io/version\" label, set to the Alertmanager version.\n* \"kubectl.kubernetes.io/default-container\" annotation, set to \"alertmanager\".", + "description": "podMetadata defines labels and annotations which are propagated to the Alertmanager pods.\n\nThe following items are reserved and cannot be overridden:\n* \"alertmanager\" label, set to the name of the Alertmanager instance.\n* \"app.kubernetes.io/instance\" label, set to the name of the Alertmanager instance.\n* \"app.kubernetes.io/managed-by\" label, set to \"prometheus-operator\".\n* \"app.kubernetes.io/name\" label, set to \"alertmanager\".\n* \"app.kubernetes.io/version\" label, set to the Alertmanager version.\n* \"kubectl.kubernetes.io/default-container\" annotation, set to \"alertmanager\".", "properties": { "annotations": { "additionalProperties": { "type": "string" }, - "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", + "description": "annotations defines an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", + "description": "labels define the map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "type": "object" }, "name": { - "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", + "description": "name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", "type": "string" } }, @@ -5480,20 +5480,20 @@ }, "portName": { "default": "web", - "description": "Port name used for the pods and governing service.\nDefaults to `web`.", + "description": "portName defines the port's name for the pods and governing service.\nDefaults to `web`.", "type": "string" }, "priorityClassName": { - "description": "Priority class assigned to the Pods", + "description": "priorityClassName assigned to the Pods", "type": "string" }, "replicas": { - "description": "Size is the expected size of the alertmanager cluster. The controller will\neventually make the size of the running cluster equal to the expected\nsize.", + "description": "replicas defines the expected size of the alertmanager cluster. The controller will\neventually make the size of the running cluster equal to the expected\nsize.", "format": "int32", "type": "integer" }, "resources": { - "description": "Define resources requests and limits for single Pods.", + "description": "resources defines the resource requests and limits of the Pods.", "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis field depends on the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.", @@ -5557,23 +5557,23 @@ }, "retention": { "default": "120h", - "description": "Time duration Alertmanager shall retain data for. Default is '120h',\nand must match the regular expression `[0-9]+(ms|s|m|h)` (milliseconds seconds minutes hours).", + "description": "retention defines the time duration Alertmanager shall retain data for. Default is '120h',\nand must match the regular expression `[0-9]+(ms|s|m|h)` (milliseconds seconds minutes hours).", "pattern": "^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "routePrefix": { - "description": "The route prefix Alertmanager registers HTTP handlers for. This is useful,\nif using ExternalURL and a proxy is rewriting HTTP routes of a request,\nand the actual ExternalURL is still true, but the server serves requests\nunder a different route prefix. For example for use with `kubectl proxy`.", + "description": "routePrefix Alertmanager registers HTTP handlers for. This is useful,\nif using ExternalURL and a proxy is rewriting HTTP routes of a request,\nand the actual ExternalURL is still true, but the server serves requests\nunder a different route prefix. For example for use with `kubectl proxy`.", "type": "string" }, "secrets": { - "description": "Secrets is a list of Secrets in the same namespace as the Alertmanager\nobject, which shall be mounted into the Alertmanager Pods.\nEach Secret is added to the StatefulSet definition as a volume named `secret-`.\nThe Secrets are mounted into `/etc/alertmanager/secrets/` in the 'alertmanager' container.", + "description": "secrets is a list of Secrets in the same namespace as the Alertmanager\nobject, which shall be mounted into the Alertmanager Pods.\nEach Secret is added to the StatefulSet definition as a volume named `secret-`.\nThe Secrets are mounted into `/etc/alertmanager/secrets/` in the 'alertmanager' container.", "items": { "type": "string" }, "type": "array" }, "securityContext": { - "description": "SecurityContext holds pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext.", + "description": "securityContext holds pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext.", "properties": { "appArmorProfile": { "description": "appArmorProfile is the AppArmor options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.", @@ -5720,27 +5720,27 @@ "type": "object" }, "serviceAccountName": { - "description": "ServiceAccountName is the name of the ServiceAccount to use to run the\nPrometheus Pods.", + "description": "serviceAccountName is the name of the ServiceAccount to use to run the\nPrometheus Pods.", "type": "string" }, "serviceName": { - "description": "The name of the service name used by the underlying StatefulSet(s) as the governing service.\nIf defined, the Service must be created before the Alertmanager resource in the same namespace and it must define a selector that matches the pod labels.\nIf empty, the operator will create and manage a headless service named `alertmanager-operated` for Alermanager resources.\nWhen deploying multiple Alertmanager resources in the same namespace, it is recommended to specify a different value for each.\nSee https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details.", + "description": "serviceName defines the service name used by the underlying StatefulSet(s) as the governing service.\nIf defined, the Service must be created before the Alertmanager resource in the same namespace and it must define a selector that matches the pod labels.\nIf empty, the operator will create and manage a headless service named `alertmanager-operated` for Alermanager resources.\nWhen deploying multiple Alertmanager resources in the same namespace, it is recommended to specify a different value for each.\nSee https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details.", "minLength": 1, "type": "string" }, "sha": { - "description": "SHA of Alertmanager container image to be deployed. Defaults to the value of `version`.\nSimilar to a tag, but the SHA explicitly deploys an immutable container image.\nVersion and Tag are ignored if SHA is set.\nDeprecated: use 'image' instead. The image digest can be specified as part of the image URL.", + "description": "sha of Alertmanager container image to be deployed. Defaults to the value of `version`.\nSimilar to a tag, but the SHA explicitly deploys an immutable container image.\nVersion and Tag are ignored if SHA is set.\nDeprecated: use 'image' instead. The image digest can be specified as part of the image URL.", "type": "string" }, "storage": { - "description": "Storage is the definition of how storage will be used by the Alertmanager\ninstances.", + "description": "storage defines the definition of how storage will be used by the Alertmanager\ninstances.", "properties": { "disableMountSubPath": { - "description": "Deprecated: subPath usage will be removed in a future release.", + "description": "disableMountSubPath deprecated: subPath usage will be removed in a future release.", "type": "boolean" }, "emptyDir": { - "description": "EmptyDirVolumeSource to be used by the StatefulSet.\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir", + "description": "emptyDir to be used by the StatefulSet.\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir", "properties": { "medium": { "description": "medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", @@ -5763,7 +5763,7 @@ "type": "object" }, "ephemeral": { - "description": "EphemeralVolumeSource to be used by the StatefulSet.\nThis is a beta field in k8s 1.21 and GA in 1.15.\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes", + "description": "ephemeral to be used by the StatefulSet.\nThis is a beta field in k8s 1.21 and GA in 1.15.\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes", "properties": { "volumeClaimTemplate": { "description": "Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `-` where\n`` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\nRequired, must not be nil.", @@ -5944,7 +5944,7 @@ "type": "object" }, "volumeClaimTemplate": { - "description": "Defines the PVC spec to be used by the Prometheus StatefulSets.\nThe easiest way to use a volume that cannot be automatically provisioned\nis to use a label selector alongside manually created PersistentVolumes.", + "description": "volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets.\nThe easiest way to use a volume that cannot be automatically provisioned\nis to use a label selector alongside manually created PersistentVolumes.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", @@ -5955,31 +5955,31 @@ "type": "string" }, "metadata": { - "description": "EmbeddedMetadata contains metadata relevant to an EmbeddedResource.", + "description": "metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, - "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", + "description": "annotations defines an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", + "description": "labels define the map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "type": "object" }, "name": { - "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", + "description": "name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", "type": "string" } }, "type": "object" }, "spec": { - "description": "Defines the desired characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", + "description": "spec defines the specification of the characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "properties": { "accessModes": { "description": "accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", @@ -6141,7 +6141,7 @@ "type": "object" }, "status": { - "description": "Deprecated: this field is never set.", + "description": "status is deprecated: this field is never set.", "properties": { "accessModes": { "description": "accessModes contains the actual access modes the volume backing the PVC has.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", @@ -6271,17 +6271,17 @@ "type": "object" }, "tag": { - "description": "Tag of Alertmanager container image to be deployed. Defaults to the value of `version`.\nVersion is ignored if Tag is set.\nDeprecated: use 'image' instead. The image tag can be specified as part of the image URL.", + "description": "tag of Alertmanager container image to be deployed. Defaults to the value of `version`.\nVersion is ignored if Tag is set.\nDeprecated: use 'image' instead. The image tag can be specified as part of the image URL.", "type": "string" }, "terminationGracePeriodSeconds": { - "description": "Optional duration in seconds the pod needs to terminate gracefully.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down) which may lead to data corruption.\n\nDefaults to 120 seconds.", + "description": "terminationGracePeriodSeconds defines the Optional duration in seconds the pod needs to terminate gracefully.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down) which may lead to data corruption.\n\nDefaults to 120 seconds.", "format": "int64", "minimum": 0, "type": "integer" }, "tolerations": { - "description": "If specified, the pod's tolerations.", + "description": "tolerations defines the pod's tolerations.", "items": { "description": "The pod this Toleration is attached to tolerates any taint that matches\nthe triple using the matching operator .", "properties": { @@ -6312,7 +6312,7 @@ "type": "array" }, "topologySpreadConstraints": { - "description": "If specified, the pod's topology spread constraints.", + "description": "topologySpreadConstraints defines the Pod's topology spread constraints.", "items": { "description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.", "properties": { @@ -6406,11 +6406,11 @@ "type": "array" }, "version": { - "description": "Version the cluster should be on.", + "description": "version the cluster should be on.", "type": "string" }, "volumeMounts": { - "description": "VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\nVolumeMounts specified will be appended to other VolumeMounts in the alertmanager container,\nthat are generated as a result of StorageSpec objects.", + "description": "volumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\nVolumeMounts specified will be appended to other VolumeMounts in the alertmanager container,\nthat are generated as a result of StorageSpec objects.", "items": { "description": "VolumeMount describes a mounting of a Volume within a container.", "properties": { @@ -6452,7 +6452,7 @@ "type": "array" }, "volumes": { - "description": "Volumes allows configuration of additional volumes on the output StatefulSet definition.\nVolumes specified will be appended to other volumes that are generated as a result of\nStorageSpec objects.", + "description": "volumes allows configuration of additional volumes on the output StatefulSet definition.\nVolumes specified will be appended to other volumes that are generated as a result of\nStorageSpec objects.", "items": { "description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.", "properties": { @@ -7915,29 +7915,29 @@ "type": "array" }, "web": { - "description": "Defines the web command line flags when starting Alertmanager.", + "description": "web defines the web command line flags when starting Alertmanager.", "properties": { "getConcurrency": { - "description": "Maximum number of GET requests processed concurrently. This corresponds to the\nAlertmanager's `--web.get-concurrency` flag.", + "description": "getConcurrency defines the maximum number of GET requests processed concurrently. This corresponds to the\nAlertmanager's `--web.get-concurrency` flag.", "format": "int32", "type": "integer" }, "httpConfig": { - "description": "Defines HTTP parameters for web server.", + "description": "httpConfig defines HTTP parameters for web server.", "properties": { "headers": { - "description": "List of headers that can be added to HTTP responses.", + "description": "headers defines a list of headers that can be added to HTTP responses.", "properties": { "contentSecurityPolicy": { - "description": "Set the Content-Security-Policy header to HTTP responses.\nUnset if blank.", + "description": "contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses.\nUnset if blank.", "type": "string" }, "strictTransportSecurity": { - "description": "Set the Strict-Transport-Security header to HTTP responses.\nUnset if blank.\nPlease make sure that you use this with care as this header might force\nbrowsers to load Prometheus and the other applications hosted on the same\ndomain and subdomains over HTTPS.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security", + "description": "strictTransportSecurity defines the Strict-Transport-Security header to HTTP responses.\nUnset if blank.\nPlease make sure that you use this with care as this header might force\nbrowsers to load Prometheus and the other applications hosted on the same\ndomain and subdomains over HTTPS.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security", "type": "string" }, "xContentTypeOptions": { - "description": "Set the X-Content-Type-Options header to HTTP responses.\nUnset if blank. Accepted value is nosniff.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options", + "description": "xContentTypeOptions defines the X-Content-Type-Options header to HTTP responses.\nUnset if blank. Accepted value is nosniff.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options", "enum": [ "", "NoSniff" @@ -7945,7 +7945,7 @@ "type": "string" }, "xFrameOptions": { - "description": "Set the X-Frame-Options header to HTTP responses.\nUnset if blank. Accepted values are deny and sameorigin.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options", + "description": "xFrameOptions defines the X-Frame-Options header to HTTP responses.\nUnset if blank. Accepted values are deny and sameorigin.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options", "enum": [ "", "Deny", @@ -7954,32 +7954,32 @@ "type": "string" }, "xXSSProtection": { - "description": "Set the X-XSS-Protection header to all responses.\nUnset if blank.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection", + "description": "xXSSProtection defines the X-XSS-Protection header to all responses.\nUnset if blank.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection", "type": "string" } }, "type": "object" }, "http2": { - "description": "Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\nWhenever the value of the field changes, a rolling update will be triggered.", + "description": "http2 enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\nWhenever the value of the field changes, a rolling update will be triggered.", "type": "boolean" } }, "type": "object" }, "timeout": { - "description": "Timeout for HTTP requests. This corresponds to the Alertmanager's\n`--web.timeout` flag.", + "description": "timeout for HTTP requests. This corresponds to the Alertmanager's\n`--web.timeout` flag.", "format": "int32", "type": "integer" }, "tlsConfig": { - "description": "Defines the TLS parameters for HTTPS.", + "description": "tlsConfig defines the TLS parameters for HTTPS.", "properties": { "cert": { - "description": "Secret or ConfigMap containing the TLS certificate for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `certFile`.", + "description": "cert defines the Secret or ConfigMap containing the TLS certificate for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `certFile`.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8002,7 +8002,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8028,29 +8028,29 @@ "type": "object" }, "certFile": { - "description": "Path to the TLS certificate file in the container for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `cert`.", + "description": "certFile defines the path to the TLS certificate file in the container for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `cert`.", "type": "string" }, "cipherSuites": { - "description": "List of supported cipher suites for TLS versions up to TLS 1.2.\n\nIf not defined, the Go default cipher suites are used.\nAvailable cipher suites are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#pkg-constants", + "description": "cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2.\n\nIf not defined, the Go default cipher suites are used.\nAvailable cipher suites are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#pkg-constants", "items": { "type": "string" }, "type": "array" }, "clientAuthType": { - "description": "The server policy for client TLS authentication.\n\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType", + "description": "clientAuthType defines the server policy for client TLS authentication.\n\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType", "type": "string" }, "clientCAFile": { - "description": "Path to the CA certificate file for client certificate authentication to\nthe server.\n\nIt is mutually exclusive with `client_ca`.", + "description": "clientCAFile defines the path to the CA certificate file for client certificate authentication to\nthe server.\n\nIt is mutually exclusive with `client_ca`.", "type": "string" }, "client_ca": { - "description": "Secret or ConfigMap containing the CA certificate for client certificate\nauthentication to the server.\n\nIt is mutually exclusive with `clientCAFile`.", + "description": "client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate\nauthentication to the server.\n\nIt is mutually exclusive with `clientCAFile`.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8073,7 +8073,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8099,18 +8099,18 @@ "type": "object" }, "curvePreferences": { - "description": "Elliptic curves that will be used in an ECDHE handshake, in preference\norder.\n\nAvailable curves are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID", + "description": "curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference\norder.\n\nAvailable curves are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID", "items": { "type": "string" }, "type": "array" }, "keyFile": { - "description": "Path to the TLS private key file in the container for the web server.\n\nIf defined, either `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keySecret`.", + "description": "keyFile defines the path to the TLS private key file in the container for the web server.\n\nIf defined, either `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keySecret`.", "type": "string" }, "keySecret": { - "description": "Secret containing the TLS private key for the web server.\n\nEither `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keyFile`.", + "description": "keySecret defines the secret containing the TLS private key for the web server.\n\nEither `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keyFile`.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8133,15 +8133,15 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum TLS version that is acceptable.", + "description": "maxVersion defines the Maximum TLS version that is acceptable.", "type": "string" }, "minVersion": { - "description": "Minimum TLS version that is acceptable.", + "description": "minVersion defines the minimum TLS version that is acceptable.", "type": "string" }, "preferServerCipherSuites": { - "description": "Controls whether the server selects the client's most preferred cipher\nsuite, or the server's most preferred cipher suite.\n\nIf true then the server's preference, as expressed in\nthe order of elements in cipherSuites, is used.", + "description": "preferServerCipherSuites defines whether the server selects the client's most preferred cipher\nsuite, or the server's most preferred cipher suite.\n\nIf true then the server's preference, as expressed in\nthe order of elements in cipherSuites, is used.", "type": "boolean" } }, @@ -8154,15 +8154,15 @@ "type": "object" }, "status": { - "description": "Most recent observed status of the Alertmanager cluster. Read-only.\nMore info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", + "description": "status defines the most recent observed status of the Alertmanager cluster. Read-only.\nMore info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "availableReplicas": { - "description": "Total number of available pods (ready for at least minReadySeconds)\ntargeted by this Alertmanager cluster.", + "description": "availableReplicas defines the total number of available pods (ready for at least minReadySeconds)\ntargeted by this Alertmanager cluster.", "format": "int32", "type": "integer" }, "conditions": { - "description": "The current state of the Alertmanager object.", + "description": "conditions defines the current state of the Alertmanager object.", "items": { "description": "Condition represents the state of the resources associated with the\nPrometheus, Alertmanager or ThanosRuler resource.", "properties": { @@ -8172,25 +8172,25 @@ "type": "string" }, "message": { - "description": "Human-readable message indicating details for the condition's last transition.", + "description": "message defines human-readable message indicating details for the condition's last transition.", "type": "string" }, "observedGeneration": { - "description": "ObservedGeneration represents the .metadata.generation that the\ncondition was set based upon. For instance, if `.metadata.generation` is\ncurrently 12, but the `.status.conditions[].observedGeneration` is 9, the\ncondition is out of date with respect to the current state of the\ninstance.", + "description": "observedGeneration defines the .metadata.generation that the\ncondition was set based upon. For instance, if `.metadata.generation` is\ncurrently 12, but the `.status.conditions[].observedGeneration` is 9, the\ncondition is out of date with respect to the current state of the\ninstance.", "format": "int64", "type": "integer" }, "reason": { - "description": "Reason for the condition's last transition.", + "description": "reason for the condition's last transition.", "type": "string" }, "status": { - "description": "Status of the condition.", + "description": "status of the condition.", "minLength": 1, "type": "string" }, "type": { - "description": "Type of the condition being reported.", + "description": "type of the condition being reported.", "minLength": 1, "type": "string" } @@ -8209,36 +8209,29 @@ "x-kubernetes-list-type": "map" }, "paused": { - "description": "Represents whether any actions on the underlying managed objects are\nbeing performed. Only delete actions will be performed.", + "description": "paused defines whether any actions on the underlying managed objects are\nbeing performed. Only delete actions will be performed.", "type": "boolean" }, "replicas": { - "description": "Total number of non-terminated pods targeted by this Alertmanager\nobject (their labels match the selector).", + "description": "replicas defines the total number of non-terminated pods targeted by this Alertmanager\nobject (their labels match the selector).", "format": "int32", "type": "integer" }, "selector": { - "description": "The selector used to match the pods targeted by this Alertmanager object.", + "description": "selector used to match the pods targeted by this Alertmanager object.", "type": "string" }, "unavailableReplicas": { - "description": "Total number of unavailable pods targeted by this Alertmanager object.", + "description": "unavailableReplicas defines the total number of unavailable pods targeted by this Alertmanager object.", "format": "int32", "type": "integer" }, "updatedReplicas": { - "description": "Total number of non-terminated pods targeted by this Alertmanager\nobject that have the desired version spec.", + "description": "updatedReplicas defines the total number of non-terminated pods targeted by this Alertmanager\nobject that have the desired version spec.", "format": "int32", "type": "integer" } }, - "required": [ - "availableReplicas", - "paused", - "replicas", - "unavailableReplicas", - "updatedReplicas" - ], "type": "object" } }, diff --git a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/podmonitors-crd.json b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/podmonitors-crd.json index e65fe218..cfbc68e6 100644 --- a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/podmonitors-crd.json +++ b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/podmonitors-crd.json @@ -3,7 +3,7 @@ "kind": "CustomResourceDefinition", "metadata": { "annotations": { - "controller-gen.kubebuilder.io/version": "v0.18.0", + "controller-gen.kubebuilder.io/version": "v0.19.0", "operator.prometheus.io/version": "0.85.0" }, "name": "podmonitors.monitoring.coreos.com" @@ -42,29 +42,29 @@ "type": "object" }, "spec": { - "description": "Specification of desired Pod selection for target discovery by Prometheus.", + "description": "spec defines the specification of desired Pod selection for target discovery by Prometheus.", "properties": { "attachMetadata": { - "description": "`attachMetadata` defines additional metadata which is added to the\ndiscovered targets.\n\nIt requires Prometheus >= v2.35.0.", + "description": "attachMetadata defines additional metadata which is added to the\ndiscovered targets.\n\nIt requires Prometheus >= v2.35.0.", "properties": { "node": { - "description": "When set to true, Prometheus attaches node metadata to the discovered\ntargets.\n\nThe Prometheus service account must have the `list` and `watch`\npermissions on the `Nodes` objects.", + "description": "node when set to true, Prometheus attaches node metadata to the discovered\ntargets.\n\nThe Prometheus service account must have the `list` and `watch`\npermissions on the `Nodes` objects.", "type": "boolean" } }, "type": "object" }, "bodySizeLimit": { - "description": "When defined, bodySizeLimit specifies a job level limit on the size\nof uncompressed response body that will be accepted by Prometheus.\n\nIt requires Prometheus >= v2.28.0.", + "description": "bodySizeLimit when defined specifies a job level limit on the size\nof uncompressed response body that will be accepted by Prometheus.\n\nIt requires Prometheus >= v2.28.0.", "pattern": "(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$", "type": "string" }, "convertClassicHistogramsToNHCB": { - "description": "Whether to convert all scraped classic histograms into a native histogram with custom buckets.\nIt requires Prometheus >= v3.0.0.", + "description": "convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets.\nIt requires Prometheus >= v3.0.0.", "type": "boolean" }, "fallbackScrapeProtocol": { - "description": "The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\n\nIt requires Prometheus >= v3.0.0.", + "description": "fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\n\nIt requires Prometheus >= v3.0.0.", "enum": [ "PrometheusProto", "OpenMetricsText0.0.1", @@ -75,38 +75,38 @@ "type": "string" }, "jobLabel": { - "description": "The label to use to retrieve the job name from.\n`jobLabel` selects the label from the associated Kubernetes `Pod`\nobject which will be used as the `job` label for all metrics.\n\nFor example if `jobLabel` is set to `foo` and the Kubernetes `Pod`\nobject is labeled with `foo: bar`, then Prometheus adds the `job=\"bar\"`\nlabel to all ingested metrics.\n\nIf the value of this field is empty, the `job` label of the metrics\ndefaults to the namespace and name of the PodMonitor object (e.g. `/`).", + "description": "jobLabel defines the label to use to retrieve the job name from.\n`jobLabel` selects the label from the associated Kubernetes `Pod`\nobject which will be used as the `job` label for all metrics.\n\nFor example if `jobLabel` is set to `foo` and the Kubernetes `Pod`\nobject is labeled with `foo: bar`, then Prometheus adds the `job=\"bar\"`\nlabel to all ingested metrics.\n\nIf the value of this field is empty, the `job` label of the metrics\ndefaults to the namespace and name of the PodMonitor object (e.g. `/`).", "type": "string" }, "keepDroppedTargets": { - "description": "Per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\nIt requires Prometheus >= v2.47.0.", + "description": "keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\nIt requires Prometheus >= v2.47.0.", "format": "int64", "type": "integer" }, "labelLimit": { - "description": "Per-scrape limit on number of labels that will be accepted for a sample.\n\nIt requires Prometheus >= v2.27.0.", + "description": "labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample.\n\nIt requires Prometheus >= v2.27.0.", "format": "int64", "type": "integer" }, "labelNameLengthLimit": { - "description": "Per-scrape limit on length of labels name that will be accepted for a sample.\n\nIt requires Prometheus >= v2.27.0.", + "description": "labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample.\n\nIt requires Prometheus >= v2.27.0.", "format": "int64", "type": "integer" }, "labelValueLengthLimit": { - "description": "Per-scrape limit on length of labels value that will be accepted for a sample.\n\nIt requires Prometheus >= v2.27.0.", + "description": "labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample.\n\nIt requires Prometheus >= v2.27.0.", "format": "int64", "type": "integer" }, "namespaceSelector": { - "description": "`namespaceSelector` defines in which namespace(s) Prometheus should discover the pods.\nBy default, the pods are discovered in the same namespace as the `PodMonitor` object but it is possible to select pods across different/all namespaces.", + "description": "namespaceSelector defines in which namespace(s) Prometheus should discover the pods.\nBy default, the pods are discovered in the same namespace as the `PodMonitor` object but it is possible to select pods across different/all namespaces.", "properties": { "any": { - "description": "Boolean describing whether all namespaces are selected in contrast to a\nlist restricting them.", + "description": "any defines the boolean describing whether all namespaces are selected in contrast to a\nlist restricting them.", "type": "boolean" }, "matchNames": { - "description": "List of namespace names to select from.", + "description": "matchNames defines the list of namespace names to select from.", "items": { "type": "string" }, @@ -116,7 +116,7 @@ "type": "object" }, "nativeHistogramBucketLimit": { - "description": "If there are more than this many buckets in a native histogram,\nbuckets will be merged to stay within the limit.\nIt requires Prometheus >= v2.45.0.", + "description": "nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram,\nbuckets will be merged to stay within the limit.\nIt requires Prometheus >= v2.45.0.", "format": "int64", "type": "integer" }, @@ -129,20 +129,20 @@ "type": "string" } ], - "description": "If the growth factor of one bucket to the next is smaller than this,\nbuckets will be merged to increase the factor sufficiently.\nIt requires Prometheus >= v2.50.0.", + "description": "nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this,\nbuckets will be merged to increase the factor sufficiently.\nIt requires Prometheus >= v2.50.0.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "podMetricsEndpoints": { - "description": "Defines how to scrape metrics from the selected pods.", + "description": "podMetricsEndpoints defines how to scrape metrics from the selected pods.", "items": { "description": "PodMetricsEndpoint defines an endpoint serving Prometheus metrics to be scraped by\nPrometheus.", "properties": { "authorization": { - "description": "`authorization` configures the Authorization header credentials to use when\nscraping the target.\n\nCannot be set at the same time as `basicAuth`, or `oauth2`.", + "description": "authorization defines the Authorization header credentials to use when\nscraping the target.\n\nCannot be set at the same time as `basicAuth`, or `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -165,17 +165,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "`basicAuth` configures the Basic Authentication credentials to use when\nscraping the target.\n\nCannot be set at the same time as `authorization`, or `oauth2`.", + "description": "basicAuth defines the Basic Authentication credentials to use when\nscraping the target.\n\nCannot be set at the same time as `authorization`, or `oauth2`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -198,7 +198,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -224,7 +224,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "`bearerTokenSecret` specifies a key of a Secret containing the bearer\ntoken for scraping targets. The secret needs to be in the same namespace\nas the PodMonitor object and readable by the Prometheus Operator.\n\nDeprecated: use `authorization` instead.", + "description": "bearerTokenSecret defines a key of a Secret containing the bearer\ntoken for scraping targets. The secret needs to be in the same namespace\nas the PodMonitor object and readable by the Prometheus Operator.\n\nDeprecated: use `authorization` instead.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -247,38 +247,38 @@ "x-kubernetes-map-type": "atomic" }, "enableHttp2": { - "description": "`enableHttp2` can be used to disable HTTP2 when scraping the target.", + "description": "enableHttp2 can be used to disable HTTP2 when scraping the target.", "type": "boolean" }, "filterRunning": { - "description": "When true, the pods which are not running (e.g. either in Failed or\nSucceeded state) are dropped during the target discovery.\n\nIf unset, the filtering is enabled.\n\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase", + "description": "filterRunning when true, the pods which are not running (e.g. either in Failed or\nSucceeded state) are dropped during the target discovery.\n\nIf unset, the filtering is enabled.\n\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase", "type": "boolean" }, "followRedirects": { - "description": "`followRedirects` defines whether the scrape requests should follow HTTP\n3xx redirects.", + "description": "followRedirects defines whether the scrape requests should follow HTTP\n3xx redirects.", "type": "boolean" }, "honorLabels": { - "description": "When true, `honorLabels` preserves the metric's labels when they collide\nwith the target's labels.", + "description": "honorLabels when true preserves the metric's labels when they collide\nwith the target's labels.", "type": "boolean" }, "honorTimestamps": { - "description": "`honorTimestamps` controls whether Prometheus preserves the timestamps\nwhen exposed by the target.", + "description": "honorTimestamps defines whether Prometheus preserves the timestamps\nwhen exposed by the target.", "type": "boolean" }, "interval": { - "description": "Interval at which Prometheus scrapes the metrics from the target.\n\nIf empty, Prometheus uses the global scrape interval.", + "description": "interval at which Prometheus scrapes the metrics from the target.\n\nIf empty, Prometheus uses the global scrape interval.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "metricRelabelings": { - "description": "`metricRelabelings` configures the relabeling rules to apply to the\nsamples before ingestion.", + "description": "metricRelabelings defines the relabeling rules to apply to the\nsamples before ingestion.", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -306,24 +306,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -332,7 +332,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -341,17 +341,17 @@ "type": "array" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "`oauth2` configures the OAuth2 settings to use when scraping the target.\n\nIt requires Prometheus >= 2.27.0.\n\nCannot be set at the same time as `authorization`, or `basicAuth`.", + "description": "oauth2 defines the OAuth2 settings to use when scraping the target.\n\nIt requires Prometheus >= 2.27.0.\n\nCannot be set at the same time as `authorization`, or `basicAuth`.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -374,7 +374,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -400,7 +400,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -426,11 +426,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -460,34 +460,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -510,7 +510,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -536,10 +536,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -562,7 +562,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -588,11 +588,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -615,7 +615,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -625,7 +625,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -635,14 +635,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -661,19 +661,19 @@ }, "type": "array" }, - "description": "`params` define optional HTTP URL parameters.", + "description": "params define optional HTTP URL parameters.", "type": "object" }, "path": { - "description": "HTTP path from which to scrape for metrics.\n\nIf empty, Prometheus uses the default value (e.g. `/metrics`).", + "description": "path defines the HTTP path from which to scrape for metrics.\n\nIf empty, Prometheus uses the default value (e.g. `/metrics`).", "type": "string" }, "port": { - "description": "The `Pod` port name which exposes the endpoint.\n\nIt takes precedence over the `portNumber` and `targetPort` fields.", + "description": "port defines the `Pod` port name which exposes the endpoint.\n\nIt takes precedence over the `portNumber` and `targetPort` fields.", "type": "string" }, "portNumber": { - "description": "The `Pod` port number which exposes the endpoint.", + "description": "portNumber defines the `Pod` port number which exposes the endpoint.", "format": "int32", "maximum": 65535, "minimum": 1, @@ -706,27 +706,27 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "relabelings": { - "description": "`relabelings` configures the relabeling rules to apply the target's\nmetadata labels.\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\n\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", + "description": "relabelings defines the relabeling rules to apply the target's\nmetadata labels.\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\n\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -754,24 +754,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -780,7 +780,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -789,7 +789,7 @@ "type": "array" }, "scheme": { - "description": "HTTP scheme to use for scraping.\n\n`http` and `https` are the expected values unless you rewrite the\n`__scheme__` label via relabeling.\n\nIf empty, Prometheus uses the default value `http`.", + "description": "scheme defines the HTTP scheme to use for scraping.\n\n`http` and `https` are the expected values unless you rewrite the\n`__scheme__` label via relabeling.\n\nIf empty, Prometheus uses the default value `http`.", "enum": [ "http", "https" @@ -797,7 +797,7 @@ "type": "string" }, "scrapeTimeout": { - "description": "Timeout after which Prometheus considers the scrape to be failed.\n\nIf empty, Prometheus uses the global scrape timeout unless it is less\nthan the target's scrape interval value in which the latter is used.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.", + "description": "scrapeTimeout defines the timeout after which Prometheus considers the scrape to be failed.\n\nIf empty, Prometheus uses the global scrape timeout unless it is less\nthan the target's scrape interval value in which the latter is used.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, @@ -810,17 +810,17 @@ "type": "string" } ], - "description": "Name or number of the target port of the `Pod` object behind the Service, the\nport must be specified with container port property.\n\nDeprecated: use 'port' or 'portNumber' instead.", + "description": "targetPort defines the name or number of the target port of the `Pod` object behind the Service, the\nport must be specified with container port property.\n\nDeprecated: use 'port' or 'portNumber' instead.", "x-kubernetes-int-or-string": true }, "tlsConfig": { - "description": "TLS configuration to use when scraping the target.", + "description": "tlsConfig defines the TLS configuration to use when scraping the target.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -843,7 +843,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -869,10 +869,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -895,7 +895,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -921,11 +921,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -948,7 +948,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -958,7 +958,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -968,14 +968,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "trackTimestampsStaleness": { - "description": "`trackTimestampsStaleness` defines whether Prometheus tracks staleness of\nthe metrics that have an explicit timestamp present in scraped data.\nHas no effect if `honorTimestamps` is false.\n\nIt requires Prometheus >= v2.48.0.", + "description": "trackTimestampsStaleness defines whether Prometheus tracks staleness of\nthe metrics that have an explicit timestamp present in scraped data.\nHas no effect if `honorTimestamps` is false.\n\nIt requires Prometheus >= v2.48.0.", "type": "boolean" } }, @@ -984,28 +984,28 @@ "type": "array" }, "podTargetLabels": { - "description": "`podTargetLabels` defines the labels which are transferred from the\nassociated Kubernetes `Pod` object onto the ingested metrics.", + "description": "podTargetLabels defines the labels which are transferred from the\nassociated Kubernetes `Pod` object onto the ingested metrics.", "items": { "type": "string" }, "type": "array" }, "sampleLimit": { - "description": "`sampleLimit` defines a per-scrape limit on the number of scraped samples\nthat will be accepted.", + "description": "sampleLimit defines a per-scrape limit on the number of scraped samples\nthat will be accepted.", "format": "int64", "type": "integer" }, "scrapeClass": { - "description": "The scrape class to apply.", + "description": "scrapeClass defines the scrape class to apply.", "minLength": 1, "type": "string" }, "scrapeClassicHistograms": { - "description": "Whether to scrape a classic histogram that is also exposed as a native histogram.\nIt requires Prometheus >= v2.45.0.\n\nNotice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.", + "description": "scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram.\nIt requires Prometheus >= v2.45.0.\n\nNotice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.", "type": "boolean" }, "scrapeProtocols": { - "description": "`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0.", + "description": "scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0.", "items": { "description": "ScrapeProtocol represents a protocol used by Prometheus for scraping metrics.\nSupported values are:\n* `OpenMetricsText0.0.1`\n* `OpenMetricsText1.0.0`\n* `PrometheusProto`\n* `PrometheusText0.0.4`\n* `PrometheusText1.0.0`", "enum": [ @@ -1021,7 +1021,7 @@ "x-kubernetes-list-type": "set" }, "selector": { - "description": "Label selector to select the Kubernetes `Pod` objects to scrape metrics from.", + "description": "selector defines the label selector to select the Kubernetes `Pod` objects to scrape metrics from.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -1066,7 +1066,7 @@ "x-kubernetes-map-type": "atomic" }, "selectorMechanism": { - "description": "Mechanism used to select the endpoints to scrape.\nBy default, the selection process relies on relabel configurations to filter the discovered targets.\nAlternatively, you can opt in for role selectors, which may offer better efficiency in large clusters.\nWhich strategy is best for your use case needs to be carefully evaluated.\n\nIt requires Prometheus >= v2.17.0.", + "description": "selectorMechanism defines the mechanism used to select the endpoints to scrape.\nBy default, the selection process relies on relabel configurations to filter the discovered targets.\nAlternatively, you can opt in for role selectors, which may offer better efficiency in large clusters.\nWhich strategy is best for your use case needs to be carefully evaluated.\n\nIt requires Prometheus >= v2.17.0.", "enum": [ "RelabelConfig", "RoleSelector" @@ -1074,7 +1074,7 @@ "type": "string" }, "targetLimit": { - "description": "`targetLimit` defines a limit on the number of scraped targets that will\nbe accepted.", + "description": "targetLimit defines a limit on the number of scraped targets that will\nbe accepted.", "format": "int64", "type": "integer" } diff --git a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/probes-crd.json b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/probes-crd.json index a50769db..f3bc46b5 100644 --- a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/probes-crd.json +++ b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/probes-crd.json @@ -3,7 +3,7 @@ "kind": "CustomResourceDefinition", "metadata": { "annotations": { - "controller-gen.kubebuilder.io/version": "v0.18.0", + "controller-gen.kubebuilder.io/version": "v0.19.0", "operator.prometheus.io/version": "0.85.0" }, "name": "probes.monitoring.coreos.com" @@ -42,13 +42,13 @@ "type": "object" }, "spec": { - "description": "Specification of desired Ingress selection for target discovery by Prometheus.", + "description": "spec defines the specification of desired Ingress selection for target discovery by Prometheus.", "properties": { "authorization": { - "description": "Authorization section for this endpoint", + "description": "authorization section for this endpoint", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -71,17 +71,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth allow an endpoint to authenticate over basic authentication.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoint", + "description": "basicAuth allow an endpoint to authenticate over basic authentication.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoint", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -104,7 +104,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -130,7 +130,7 @@ "type": "object" }, "bearerTokenSecret": { - "description": "Secret to mount to read bearer token for scraping targets. The secret\nneeds to be in the same namespace as the probe and accessible by\nthe Prometheus Operator.", + "description": "bearerTokenSecret defines the secret to mount to read bearer token for scraping targets. The secret\nneeds to be in the same namespace as the probe and accessible by\nthe Prometheus Operator.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -153,11 +153,11 @@ "x-kubernetes-map-type": "atomic" }, "convertClassicHistogramsToNHCB": { - "description": "Whether to convert all scraped classic histograms into a native histogram with custom buckets.\nIt requires Prometheus >= v3.0.0.", + "description": "convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets.\nIt requires Prometheus >= v3.0.0.", "type": "boolean" }, "fallbackScrapeProtocol": { - "description": "The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\n\nIt requires Prometheus >= v3.0.0.", + "description": "fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\n\nIt requires Prometheus >= v3.0.0.", "enum": [ "PrometheusProto", "OpenMetricsText0.0.1", @@ -168,42 +168,42 @@ "type": "string" }, "interval": { - "description": "Interval at which targets are probed using the configured prober.\nIf not specified Prometheus' global scrape interval is used.", + "description": "interval at which targets are probed using the configured prober.\nIf not specified Prometheus' global scrape interval is used.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "jobName": { - "description": "The job name assigned to scraped metrics by default.", + "description": "jobName assigned to scraped metrics by default.", "type": "string" }, "keepDroppedTargets": { - "description": "Per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\nIt requires Prometheus >= v2.47.0.", + "description": "keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\nIt requires Prometheus >= v2.47.0.", "format": "int64", "type": "integer" }, "labelLimit": { - "description": "Per-scrape limit on number of labels that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer.", + "description": "labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer.", "format": "int64", "type": "integer" }, "labelNameLengthLimit": { - "description": "Per-scrape limit on length of labels name that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer.", + "description": "labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer.", "format": "int64", "type": "integer" }, "labelValueLengthLimit": { - "description": "Per-scrape limit on length of labels value that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer.", + "description": "labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer.", "format": "int64", "type": "integer" }, "metricRelabelings": { - "description": "MetricRelabelConfigs to apply to samples before ingestion.", + "description": "metricRelabelings defines the RelabelConfig to apply to samples before ingestion.", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -231,24 +231,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -257,7 +257,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -266,11 +266,11 @@ "type": "array" }, "module": { - "description": "The module to use for probing specifying how to probe the target.\nExample module configuring in the blackbox exporter:\nhttps://github.com/prometheus/blackbox_exporter/blob/master/example.yml", + "description": "module to use for probing specifying how to probe the target.\nExample module configuring in the blackbox exporter:\nhttps://github.com/prometheus/blackbox_exporter/blob/master/example.yml", "type": "string" }, "nativeHistogramBucketLimit": { - "description": "If there are more than this many buckets in a native histogram,\nbuckets will be merged to stay within the limit.\nIt requires Prometheus >= v2.45.0.", + "description": "nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram,\nbuckets will be merged to stay within the limit.\nIt requires Prometheus >= v2.45.0.", "format": "int64", "type": "integer" }, @@ -283,18 +283,18 @@ "type": "string" } ], - "description": "If the growth factor of one bucket to the next is smaller than this,\nbuckets will be merged to increase the factor sufficiently.\nIt requires Prometheus >= v2.50.0.", + "description": "nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this,\nbuckets will be merged to increase the factor sufficiently.\nIt requires Prometheus >= v2.50.0.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "oauth2": { - "description": "OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.", + "description": "oauth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -317,7 +317,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -343,7 +343,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -369,11 +369,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -403,34 +403,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -453,7 +453,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -479,10 +479,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -505,7 +505,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -531,11 +531,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -558,7 +558,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -568,7 +568,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -578,14 +578,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -598,17 +598,17 @@ "type": "object" }, "params": { - "description": "The list of HTTP query parameters for the scrape.\nPlease note that the `.spec.module` field takes precedence over the `module` parameter from this list when both are defined.\nThe module name must be added using Module under ProbeSpec.", + "description": "params defines the list of HTTP query parameters for the scrape.\nPlease note that the `.spec.module` field takes precedence over the `module` parameter from this list when both are defined.\nThe module name must be added using Module under ProbeSpec.", "items": { "description": "ProbeParam defines specification of extra parameters for a Probe.", "properties": { "name": { - "description": "The parameter name", + "description": "name defines the parameter name", "minLength": 1, "type": "string" }, "values": { - "description": "The parameter values", + "description": "values defines the parameter values", "items": { "minLength": 1, "type": "string" @@ -630,15 +630,15 @@ "x-kubernetes-list-type": "map" }, "prober": { - "description": "Specification for the prober to use for probing targets.\nThe prober.URL parameter is required. Targets cannot be probed if left empty.", + "description": "prober defines the pecification for the prober to use for probing targets.\nThe prober.URL parameter is required. Targets cannot be probed if left empty.", "properties": { "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "path": { "default": "/probe", - "description": "Path to collect metrics from.\nDefaults to `/probe`.", + "description": "path to collect metrics from.\nDefaults to `/probe`.", "type": "string" }, "proxyConnectHeader": { @@ -668,21 +668,21 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scheme": { - "description": "HTTP scheme to use for scraping.\n`http` and `https` are the expected values unless you rewrite the `__scheme__` label via relabeling.\nIf empty, Prometheus uses the default value `http`.", + "description": "scheme defines the HTTP scheme to use for scraping.\n`http` and `https` are the expected values unless you rewrite the `__scheme__` label via relabeling.\nIf empty, Prometheus uses the default value `http`.", "enum": [ "http", "https" @@ -690,7 +690,7 @@ "type": "string" }, "url": { - "description": "Mandatory URL of the prober.", + "description": "url defines the mandatory URL of the prober.", "type": "string" } }, @@ -700,21 +700,21 @@ "type": "object" }, "sampleLimit": { - "description": "SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.", + "description": "sampleLimit defines per-scrape limit on number of scraped samples that will be accepted.", "format": "int64", "type": "integer" }, "scrapeClass": { - "description": "The scrape class to apply.", + "description": "scrapeClass defines the scrape class to apply.", "minLength": 1, "type": "string" }, "scrapeClassicHistograms": { - "description": "Whether to scrape a classic histogram that is also exposed as a native histogram.\nIt requires Prometheus >= v2.45.0.\n\nNotice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.", + "description": "scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram.\nIt requires Prometheus >= v2.45.0.\n\nNotice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.", "type": "boolean" }, "scrapeProtocols": { - "description": "`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0.", + "description": "scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0.", "items": { "description": "ScrapeProtocol represents a protocol used by Prometheus for scraping metrics.\nSupported values are:\n* `OpenMetricsText0.0.1`\n* `OpenMetricsText1.0.0`\n* `PrometheusProto`\n* `PrometheusText0.0.4`\n* `PrometheusText1.0.0`", "enum": [ @@ -730,30 +730,30 @@ "x-kubernetes-list-type": "set" }, "scrapeTimeout": { - "description": "Timeout for scraping metrics from the Prometheus exporter.\nIf not specified, the Prometheus global scrape timeout is used.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.", + "description": "scrapeTimeout defines the timeout for scraping metrics from the Prometheus exporter.\nIf not specified, the Prometheus global scrape timeout is used.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "targetLimit": { - "description": "TargetLimit defines a limit on the number of scraped targets that will be accepted.", + "description": "targetLimit defines a limit on the number of scraped targets that will be accepted.", "format": "int64", "type": "integer" }, "targets": { - "description": "Targets defines a set of static or dynamically discovered targets to probe.", + "description": "targets defines a set of static or dynamically discovered targets to probe.", "properties": { "ingress": { "description": "ingress defines the Ingress objects to probe and the relabeling\nconfiguration.\nIf `staticConfig` is also defined, `staticConfig` takes precedence.", "properties": { "namespaceSelector": { - "description": "From which namespaces to select Ingress objects.", + "description": "namespaceSelector defines from which namespaces to select Ingress objects.", "properties": { "any": { - "description": "Boolean describing whether all namespaces are selected in contrast to a\nlist restricting them.", + "description": "any defines the boolean describing whether all namespaces are selected in contrast to a\nlist restricting them.", "type": "boolean" }, "matchNames": { - "description": "List of namespace names to select from.", + "description": "matchNames defines the list of namespace names to select from.", "items": { "type": "string" }, @@ -763,13 +763,13 @@ "type": "object" }, "relabelingConfigs": { - "description": "RelabelConfigs to apply to the label set of the target before it gets\nscraped.\nThe original ingress address is available via the\n`__tmp_prometheus_ingress_address` label. It can be used to customize the\nprobed URL.\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", + "description": "relabelingConfigs to apply to the label set of the target before it gets\nscraped.\nThe original ingress address is available via the\n`__tmp_prometheus_ingress_address` label. It can be used to customize the\nprobed URL.\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -797,24 +797,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -823,7 +823,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -832,7 +832,7 @@ "type": "array" }, "selector": { - "description": "Selector to select the Ingress objects.", + "description": "selector to select the Ingress objects.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -886,17 +886,17 @@ "additionalProperties": { "type": "string" }, - "description": "Labels assigned to all metrics scraped from the targets.", + "description": "labels defines all labels assigned to all metrics scraped from the targets.", "type": "object" }, "relabelingConfigs": { - "description": "RelabelConfigs to apply to the label set of the targets before it gets\nscraped.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", + "description": "relabelingConfigs defines relabelings to be apply to the label set of the targets before it gets\nscraped.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -924,24 +924,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -950,7 +950,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -959,7 +959,7 @@ "type": "array" }, "static": { - "description": "The list of hosts to probe.", + "description": "static defines the list of hosts to probe.", "items": { "type": "string" }, @@ -972,13 +972,13 @@ "type": "object" }, "tlsConfig": { - "description": "TLS configuration to use when scraping the endpoint.", + "description": "tlsConfig defines the TLS configuration to use when scraping the endpoint.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1001,7 +1001,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1027,10 +1027,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1053,7 +1053,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1079,11 +1079,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1106,7 +1106,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -1116,7 +1116,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -1126,7 +1126,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, diff --git a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/prometheusagents-crd.json b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/prometheusagents-crd.json index 6041d817..8eab9f36 100644 --- a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/prometheusagents-crd.json +++ b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/prometheusagents-crd.json @@ -3,7 +3,7 @@ "kind": "CustomResourceDefinition", "metadata": { "annotations": { - "controller-gen.kubebuilder.io/version": "v0.18.0", + "controller-gen.kubebuilder.io/version": "v0.19.0", "operator.prometheus.io/version": "0.85.0" }, "name": "prometheusagents.monitoring.coreos.com" @@ -84,20 +84,20 @@ "type": "object" }, "spec": { - "description": "Specification of the desired behavior of the Prometheus agent. More info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", + "description": "spec defines the specification of the desired behavior of the Prometheus agent. More info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "additionalArgs": { - "description": "AdditionalArgs allows setting additional arguments for the 'prometheus' container.\n\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nPrometheus container which may cause issues if they are invalid or not supported\nby the given Prometheus version.\n\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged.", + "description": "additionalArgs allows setting additional arguments for the 'prometheus' container.\n\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nPrometheus container which may cause issues if they are invalid or not supported\nby the given Prometheus version.\n\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged.", "items": { "description": "Argument as part of the AdditionalArgs list.", "properties": { "name": { - "description": "Name of the argument, e.g. \"scrape.discovery-reload-interval\".", + "description": "name of the argument, e.g. \"scrape.discovery-reload-interval\".", "minLength": 1, "type": "string" }, "value": { - "description": "Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)", + "description": "value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)", "type": "string" } }, @@ -109,7 +109,7 @@ "type": "array" }, "additionalScrapeConfigs": { - "description": "AdditionalScrapeConfigs allows specifying a key of a Secret containing\nadditional Prometheus scrape configurations. Scrape configurations\nspecified are appended to the configurations generated by the Prometheus\nOperator. Job configurations specified must have the form as specified\nin the official Prometheus documentation:\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config.\nAs scrape configs are appended, the user is responsible to make sure it\nis valid. Note that using this feature may expose the possibility to\nbreak upgrades of Prometheus. It is advised to review Prometheus release\nnotes to ensure that no incompatible scrape configs are going to break\nPrometheus after the upgrade.", + "description": "additionalScrapeConfigs allows specifying a key of a Secret containing\nadditional Prometheus scrape configurations. Scrape configurations\nspecified are appended to the configurations generated by the Prometheus\nOperator. Job configurations specified must have the form as specified\nin the official Prometheus documentation:\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config.\nAs scrape configs are appended, the user is responsible to make sure it\nis valid. Note that using this feature may expose the possibility to\nbreak upgrades of Prometheus. It is advised to review Prometheus release\nnotes to ensure that no incompatible scrape configs are going to break\nPrometheus after the upgrade.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -132,7 +132,7 @@ "x-kubernetes-map-type": "atomic" }, "affinity": { - "description": "Defines the Pods' affinity scheduling rules if specified.", + "description": "affinity defines the Pods' affinity scheduling rules if specified.", "properties": { "nodeAffinity": { "description": "Describes node affinity scheduling rules for the pod.", @@ -887,13 +887,13 @@ "type": "object" }, "apiserverConfig": { - "description": "APIServerConfig allows specifying a host and auth methods to access the\nKuberntees API server.\nIf null, Prometheus is assumed to run inside of the cluster: it will\ndiscover the API servers automatically and use the Pod's CA certificate\nand bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.", + "description": "apiserverConfig allows specifying a host and auth methods to access the\nKuberntees API server.\nIf null, Prometheus is assumed to run inside of the cluster: it will\ndiscover the API servers automatically and use the Pod's CA certificate\nand bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.", "properties": { "authorization": { - "description": "Authorization section for the API server.\n\nCannot be set at the same time as `basicAuth`, `bearerToken`, or\n`bearerTokenFile`.", + "description": "authorization section for the API server.\n\nCannot be set at the same time as `basicAuth`, `bearerToken`, or\n`bearerTokenFile`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -916,21 +916,21 @@ "x-kubernetes-map-type": "atomic" }, "credentialsFile": { - "description": "File to read a secret from, mutually exclusive with `credentials`.", + "description": "credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`.", "type": "string" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth configuration for the API server.\n\nCannot be set at the same time as `authorization`, `bearerToken`, or\n`bearerTokenFile`.", + "description": "basicAuth configuration for the API server.\n\nCannot be set at the same time as `authorization`, `bearerToken`, or\n`bearerTokenFile`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -953,7 +953,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -979,19 +979,19 @@ "type": "object" }, "bearerToken": { - "description": "*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\nDeprecated: this will be removed in a future release.", + "description": "bearerToken is deprecated: this will be removed in a future release.\n *Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*", "type": "string" }, "bearerTokenFile": { - "description": "File to read bearer token for accessing apiserver.\n\nCannot be set at the same time as `basicAuth`, `authorization`, or `bearerToken`.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", + "description": "bearerTokenFile defines the file to read bearer token for accessing apiserver.\n\nCannot be set at the same time as `basicAuth`, `authorization`, or `bearerToken`.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", "type": "string" }, "host": { - "description": "Kubernetes API address consisting of a hostname or IP address followed\nby an optional port number.", + "description": "host defines the Kubernetes API address consisting of a hostname or IP address followed\nby an optional port number.", "type": "string" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -1021,27 +1021,27 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS Config to use for the API server.", + "description": "tlsConfig to use for the API server.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1064,7 +1064,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1090,14 +1090,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1120,7 +1120,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1146,19 +1146,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1181,7 +1181,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -1191,7 +1191,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -1201,7 +1201,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -1214,32 +1214,33 @@ "type": "object" }, "arbitraryFSAccessThroughSMs": { - "description": "When true, ServiceMonitor, PodMonitor and Probe object are forbidden to\nreference arbitrary files on the file system of the 'prometheus'\ncontainer.\nWhen a ServiceMonitor's endpoint specifies a `bearerTokenFile` value\n(e.g. '/var/run/secrets/kubernetes.io/serviceaccount/token'), a\nmalicious target can get access to the Prometheus service account's\ntoken in the Prometheus' scrape request. Setting\n`spec.arbitraryFSAccessThroughSM` to 'true' would prevent the attack.\nUsers should instead provide the credentials using the\n`spec.bearerTokenSecret` field.", + "description": "arbitraryFSAccessThroughSMs when true, ServiceMonitor, PodMonitor and Probe object are forbidden to\nreference arbitrary files on the file system of the 'prometheus'\ncontainer.\nWhen a ServiceMonitor's endpoint specifies a `bearerTokenFile` value\n(e.g. '/var/run/secrets/kubernetes.io/serviceaccount/token'), a\nmalicious target can get access to the Prometheus service account's\ntoken in the Prometheus' scrape request. Setting\n`spec.arbitraryFSAccessThroughSM` to 'true' would prevent the attack.\nUsers should instead provide the credentials using the\n`spec.bearerTokenSecret` field.", "properties": { "deny": { + "description": "deny prevents service monitors from accessing arbitrary files on the file system.\nWhen true, service monitors cannot use file-based configurations like BearerTokenFile\nthat could potentially access sensitive files. When false (default), such access is allowed.\nSetting this to true enhances security by preventing potential credential theft attacks.", "type": "boolean" } }, "type": "object" }, "automountServiceAccountToken": { - "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod.\nIf the field isn't set, the operator mounts the service account token by default.\n\n**Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery.\nIt is possible to use strategic merge patch to project the service account token into the 'prometheus' container.", + "description": "automountServiceAccountToken defines whether a service account token should be automatically mounted in the pod.\nIf the field isn't set, the operator mounts the service account token by default.\n\n**Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery.\nIt is possible to use strategic merge patch to project the service account token into the 'prometheus' container.", "type": "boolean" }, "bodySizeLimit": { - "description": "BodySizeLimit defines per-scrape on response body size.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit.", + "description": "bodySizeLimit defines per-scrape on response body size.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit.", "pattern": "(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$", "type": "string" }, "configMaps": { - "description": "ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-`.\nThe ConfigMaps are mounted into /etc/prometheus/configmaps/ in the 'prometheus' container.", + "description": "configMaps defines a list of ConfigMaps in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-`.\nThe ConfigMaps are mounted into /etc/prometheus/configmaps/ in the 'prometheus' container.", "items": { "type": "string" }, "type": "array" }, "containers": { - "description": "Containers allows injecting additional containers or modifying operator\ngenerated containers. This can be used to allow adding an authentication\nproxy to the Pods or to change the behavior of an operator generated\ncontainer. Containers described here modify an operator generated\ncontainer if they share the same name and modifications are done via a\nstrategic merge patch.\n\nThe names of containers managed by the operator are:\n* `prometheus`\n* `config-reloader`\n* `thanos-sidecar`\n\nOverriding containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice.", + "description": "containers allows injecting additional containers or modifying operator\ngenerated containers. This can be used to allow adding an authentication\nproxy to the Pods or to change the behavior of an operator generated\ncontainer. Containers described here modify an operator generated\ncontainer if they share the same name and modifications are done via a\nstrategic merge patch.\n\nThe names of containers managed by the operator are:\n* `prometheus`\n* `config-reloader`\n* `thanos-sidecar`\n\nOverriding containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice.", "items": { "description": "A single application container that you want to run within a pod.", "properties": { @@ -2577,14 +2578,14 @@ "type": "array" }, "convertClassicHistogramsToNHCB": { - "description": "Whether to convert all scraped classic histograms into a native\nhistogram with custom buckets.\n\nIt requires Prometheus >= v3.4.0.", + "description": "convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native\nhistogram with custom buckets.\n\nIt requires Prometheus >= v3.4.0.", "type": "boolean" }, "dnsConfig": { - "description": "Defines the DNS configuration for the pods.", + "description": "dnsConfig defines the DNS configuration for the pods.", "properties": { "nameservers": { - "description": "A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.", + "description": "nameservers defines the list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.", "items": { "minLength": 1, "type": "string" @@ -2593,17 +2594,17 @@ "x-kubernetes-list-type": "set" }, "options": { - "description": "A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nResolution options given in Options\nwill override those that appear in the base DNSPolicy.", + "description": "options defines the list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nResolution options given in Options\nwill override those that appear in the base DNSPolicy.", "items": { "description": "PodDNSConfigOption defines DNS resolver options of a pod.", "properties": { "name": { - "description": "Name is required and must be unique.", + "description": "name is required and must be unique.", "minLength": 1, "type": "string" }, "value": { - "description": "Value is optional.", + "description": "value is optional.", "type": "string" } }, @@ -2619,7 +2620,7 @@ "x-kubernetes-list-type": "map" }, "searches": { - "description": "A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.", + "description": "searches defines the list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.", "items": { "minLength": 1, "type": "string" @@ -2631,7 +2632,7 @@ "type": "object" }, "dnsPolicy": { - "description": "Defines the DNS policy for the pods.", + "description": "dnsPolicy defines the DNS policy for the pods.", "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", @@ -2641,7 +2642,7 @@ "type": "string" }, "enableFeatures": { - "description": "Enable access to Prometheus feature flags. By default, no features are enabled.\n\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\nFor more information see https://prometheus.io/docs/prometheus/latest/feature_flags/", + "description": "enableFeatures enables access to Prometheus feature flags. By default, no features are enabled.\n\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\nFor more information see https://prometheus.io/docs/prometheus/latest/feature_flags/", "items": { "minLength": 1, "type": "string" @@ -2650,80 +2651,80 @@ "x-kubernetes-list-type": "set" }, "enableOTLPReceiver": { - "description": "Enable Prometheus to be used as a receiver for the OTLP Metrics protocol.\n\nNote that the OTLP receiver endpoint is automatically enabled if `.spec.otlpConfig` is defined.\n\nIt requires Prometheus >= v2.47.0.", + "description": "enableOTLPReceiver defines the Prometheus to be used as a receiver for the OTLP Metrics protocol.\n\nNote that the OTLP receiver endpoint is automatically enabled if `.spec.otlpConfig` is defined.\n\nIt requires Prometheus >= v2.47.0.", "type": "boolean" }, "enableRemoteWriteReceiver": { - "description": "Enable Prometheus to be used as a receiver for the Prometheus remote\nwrite protocol.\n\nWARNING: This is not considered an efficient way of ingesting samples.\nUse it with caution for specific low-volume use cases.\nIt is not suitable for replacing the ingestion via scraping and turning\nPrometheus into a push-based metrics collection system.\nFor more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver\n\nIt requires Prometheus >= v2.33.0.", + "description": "enableRemoteWriteReceiver defines the Prometheus to be used as a receiver for the Prometheus remote\nwrite protocol.\n\nWARNING: This is not considered an efficient way of ingesting samples.\nUse it with caution for specific low-volume use cases.\nIt is not suitable for replacing the ingestion via scraping and turning\nPrometheus into a push-based metrics collection system.\nFor more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver\n\nIt requires Prometheus >= v2.33.0.", "type": "boolean" }, "enableServiceLinks": { - "description": "Indicates whether information about services should be injected into pod's environment variables", + "description": "enableServiceLinks defines whether information about services should be injected into pod's environment variables", "type": "boolean" }, "enforcedBodySizeLimit": { - "description": "When defined, enforcedBodySizeLimit specifies a global limit on the size\nof uncompressed response body that will be accepted by Prometheus.\nTargets responding with a body larger than this many bytes will cause\nthe scrape to fail.\n\nIt requires Prometheus >= v2.28.0.\n\nWhen both `enforcedBodySizeLimit` and `bodySizeLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined bodySizeLimit value will inherit the global bodySizeLimit value (Prometheus >= 2.45.0) or the enforcedBodySizeLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedBodySizeLimit` is greater than the `bodySizeLimit`, the `bodySizeLimit` will be set to `enforcedBodySizeLimit`.\n* Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value.\n* Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit.", + "description": "enforcedBodySizeLimit when defined specifies a global limit on the size\nof uncompressed response body that will be accepted by Prometheus.\nTargets responding with a body larger than this many bytes will cause\nthe scrape to fail.\n\nIt requires Prometheus >= v2.28.0.\n\nWhen both `enforcedBodySizeLimit` and `bodySizeLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined bodySizeLimit value will inherit the global bodySizeLimit value (Prometheus >= 2.45.0) or the enforcedBodySizeLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedBodySizeLimit` is greater than the `bodySizeLimit`, the `bodySizeLimit` will be set to `enforcedBodySizeLimit`.\n* Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value.\n* Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit.", "pattern": "(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$", "type": "string" }, "enforcedKeepDroppedTargets": { - "description": "When defined, enforcedKeepDroppedTargets specifies a global limit on the number of targets\ndropped by relabeling that will be kept in memory. The value overrides\nany `spec.keepDroppedTargets` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is\ngreater than zero and less than `spec.enforcedKeepDroppedTargets`.\n\nIt requires Prometheus >= v2.47.0.\n\nWhen both `enforcedKeepDroppedTargets` and `keepDroppedTargets` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined keepDroppedTargets value will inherit the global keepDroppedTargets value (Prometheus >= 2.45.0) or the enforcedKeepDroppedTargets value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedKeepDroppedTargets` is greater than the `keepDroppedTargets`, the `keepDroppedTargets` will be set to `enforcedKeepDroppedTargets`.\n* Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value.\n* Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets.", + "description": "enforcedKeepDroppedTargets when defined specifies a global limit on the number of targets\ndropped by relabeling that will be kept in memory. The value overrides\nany `spec.keepDroppedTargets` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is\ngreater than zero and less than `spec.enforcedKeepDroppedTargets`.\n\nIt requires Prometheus >= v2.47.0.\n\nWhen both `enforcedKeepDroppedTargets` and `keepDroppedTargets` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined keepDroppedTargets value will inherit the global keepDroppedTargets value (Prometheus >= 2.45.0) or the enforcedKeepDroppedTargets value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedKeepDroppedTargets` is greater than the `keepDroppedTargets`, the `keepDroppedTargets` will be set to `enforcedKeepDroppedTargets`.\n* Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value.\n* Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets.", "format": "int64", "type": "integer" }, "enforcedLabelLimit": { - "description": "When defined, enforcedLabelLimit specifies a global limit on the number\nof labels per sample. The value overrides any `spec.labelLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is\ngreater than zero and less than `spec.enforcedLabelLimit`.\n\nIt requires Prometheus >= v2.27.0.\n\nWhen both `enforcedLabelLimit` and `labelLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelLimit value will inherit the global labelLimit value (Prometheus >= 2.45.0) or the enforcedLabelLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelLimit` is greater than the `labelLimit`, the `labelLimit` will be set to `enforcedLabelLimit`.\n* Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value.\n* Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit.", + "description": "enforcedLabelLimit when defined specifies a global limit on the number\nof labels per sample. The value overrides any `spec.labelLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is\ngreater than zero and less than `spec.enforcedLabelLimit`.\n\nIt requires Prometheus >= v2.27.0.\n\nWhen both `enforcedLabelLimit` and `labelLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelLimit value will inherit the global labelLimit value (Prometheus >= 2.45.0) or the enforcedLabelLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelLimit` is greater than the `labelLimit`, the `labelLimit` will be set to `enforcedLabelLimit`.\n* Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value.\n* Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit.", "format": "int64", "type": "integer" }, "enforcedLabelNameLengthLimit": { - "description": "When defined, enforcedLabelNameLengthLimit specifies a global limit on the length\nof labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelNameLengthLimit`.\n\nIt requires Prometheus >= v2.27.0.\n\nWhen both `enforcedLabelNameLengthLimit` and `labelNameLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelNameLengthLimit value will inherit the global labelNameLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelNameLengthLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelNameLengthLimit` is greater than the `labelNameLengthLimit`, the `labelNameLengthLimit` will be set to `enforcedLabelNameLengthLimit`.\n* Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value.\n* Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit.", + "description": "enforcedLabelNameLengthLimit when defined specifies a global limit on the length\nof labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelNameLengthLimit`.\n\nIt requires Prometheus >= v2.27.0.\n\nWhen both `enforcedLabelNameLengthLimit` and `labelNameLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelNameLengthLimit value will inherit the global labelNameLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelNameLengthLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelNameLengthLimit` is greater than the `labelNameLengthLimit`, the `labelNameLengthLimit` will be set to `enforcedLabelNameLengthLimit`.\n* Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value.\n* Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit.", "format": "int64", "type": "integer" }, "enforcedLabelValueLengthLimit": { - "description": "When not null, enforcedLabelValueLengthLimit defines a global limit on the length\nof labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelValueLengthLimit`.\n\nIt requires Prometheus >= v2.27.0.\n\nWhen both `enforcedLabelValueLengthLimit` and `labelValueLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelValueLengthLimit value will inherit the global labelValueLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelValueLengthLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelValueLengthLimit` is greater than the `labelValueLengthLimit`, the `labelValueLengthLimit` will be set to `enforcedLabelValueLengthLimit`.\n* Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value.\n* Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit.", + "description": "enforcedLabelValueLengthLimit when not null defines a global limit on the length\nof labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelValueLengthLimit`.\n\nIt requires Prometheus >= v2.27.0.\n\nWhen both `enforcedLabelValueLengthLimit` and `labelValueLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelValueLengthLimit value will inherit the global labelValueLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelValueLengthLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelValueLengthLimit` is greater than the `labelValueLengthLimit`, the `labelValueLengthLimit` will be set to `enforcedLabelValueLengthLimit`.\n* Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value.\n* Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit.", "format": "int64", "type": "integer" }, "enforcedNamespaceLabel": { - "description": "When not empty, a label will be added to:\n\n1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects.\n2. All metrics generated from recording rules defined in `PrometheusRule` objects.\n3. All alerts generated from alerting rules defined in `PrometheusRule` objects.\n4. All vector selectors of PromQL expressions defined in `PrometheusRule` objects.\n\nThe label will not added for objects referenced in `spec.excludedFromEnforcement`.\n\nThe label's name is this field's value.\nThe label's value is the namespace of the `ServiceMonitor`,\n`PodMonitor`, `Probe`, `PrometheusRule` or `ScrapeConfig` object.", + "description": "enforcedNamespaceLabel when not empty, a label will be added to:\n\n1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects.\n2. All metrics generated from recording rules defined in `PrometheusRule` objects.\n3. All alerts generated from alerting rules defined in `PrometheusRule` objects.\n4. All vector selectors of PromQL expressions defined in `PrometheusRule` objects.\n\nThe label will not added for objects referenced in `spec.excludedFromEnforcement`.\n\nThe label's name is this field's value.\nThe label's value is the namespace of the `ServiceMonitor`,\n`PodMonitor`, `Probe`, `PrometheusRule` or `ScrapeConfig` object.", "type": "string" }, "enforcedSampleLimit": { - "description": "When defined, enforcedSampleLimit specifies a global limit on the number\nof scraped samples that will be accepted. This overrides any\n`spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects\nunless `spec.sampleLimit` is greater than zero and less than\n`spec.enforcedSampleLimit`.\n\nIt is meant to be used by admins to keep the overall number of\nsamples/series under a desired limit.\n\nWhen both `enforcedSampleLimit` and `sampleLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined sampleLimit value will inherit the global sampleLimit value (Prometheus >= 2.45.0) or the enforcedSampleLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedSampleLimit` is greater than the `sampleLimit`, the `sampleLimit` will be set to `enforcedSampleLimit`.\n* Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value.\n* Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit.", + "description": "enforcedSampleLimit when defined specifies a global limit on the number\nof scraped samples that will be accepted. This overrides any\n`spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects\nunless `spec.sampleLimit` is greater than zero and less than\n`spec.enforcedSampleLimit`.\n\nIt is meant to be used by admins to keep the overall number of\nsamples/series under a desired limit.\n\nWhen both `enforcedSampleLimit` and `sampleLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined sampleLimit value will inherit the global sampleLimit value (Prometheus >= 2.45.0) or the enforcedSampleLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedSampleLimit` is greater than the `sampleLimit`, the `sampleLimit` will be set to `enforcedSampleLimit`.\n* Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value.\n* Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit.", "format": "int64", "type": "integer" }, "enforcedTargetLimit": { - "description": "When defined, enforcedTargetLimit specifies a global limit on the number\nof scraped targets. The value overrides any `spec.targetLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is\ngreater than zero and less than `spec.enforcedTargetLimit`.\n\nIt is meant to be used by admins to to keep the overall number of\ntargets under a desired limit.\n\nWhen both `enforcedTargetLimit` and `targetLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined targetLimit value will inherit the global targetLimit value (Prometheus >= 2.45.0) or the enforcedTargetLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedTargetLimit` is greater than the `targetLimit`, the `targetLimit` will be set to `enforcedTargetLimit`.\n* Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value.\n* Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit.", + "description": "enforcedTargetLimit when defined specifies a global limit on the number\nof scraped targets. The value overrides any `spec.targetLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is\ngreater than zero and less than `spec.enforcedTargetLimit`.\n\nIt is meant to be used by admins to to keep the overall number of\ntargets under a desired limit.\n\nWhen both `enforcedTargetLimit` and `targetLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined targetLimit value will inherit the global targetLimit value (Prometheus >= 2.45.0) or the enforcedTargetLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedTargetLimit` is greater than the `targetLimit`, the `targetLimit` will be set to `enforcedTargetLimit`.\n* Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value.\n* Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit.", "format": "int64", "type": "integer" }, "excludedFromEnforcement": { - "description": "List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\n\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true.", + "description": "excludedFromEnforcement defines the list of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\n\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true.", "items": { "description": "ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.", "properties": { "group": { "default": "monitoring.coreos.com", - "description": "Group of the referent. When not specified, it defaults to `monitoring.coreos.com`", + "description": "group of the referent. When not specified, it defaults to `monitoring.coreos.com`", "enum": [ "monitoring.coreos.com" ], "type": "string" }, "name": { - "description": "Name of the referent. When not set, all resources in the namespace are matched.", + "description": "name of the referent. When not set, all resources in the namespace are matched.", "type": "string" }, "namespace": { - "description": "Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/", + "description": "namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/", "minLength": 1, "type": "string" }, "resource": { - "description": "Resource of the referent.", + "description": "resource of the referent.", "enum": [ "prometheusrules", "servicemonitors", @@ -2746,27 +2747,27 @@ "additionalProperties": { "type": "string" }, - "description": "The labels to add to any time series or alerts when communicating with\nexternal systems (federation, remote storage, Alertmanager).\nLabels defined by `spec.replicaExternalLabelName` and\n`spec.prometheusExternalLabelName` take precedence over this list.", + "description": "externalLabels defines the labels to add to any time series or alerts when communicating with\nexternal systems (federation, remote storage, Alertmanager).\nLabels defined by `spec.replicaExternalLabelName` and\n`spec.prometheusExternalLabelName` take precedence over this list.", "type": "object" }, "externalUrl": { - "description": "The external URL under which the Prometheus service is externally\navailable. This is necessary to generate correct URLs (for instance if\nPrometheus is accessible behind an Ingress resource).", + "description": "externalUrl defines the external URL under which the Prometheus service is externally\navailable. This is necessary to generate correct URLs (for instance if\nPrometheus is accessible behind an Ingress resource).", "type": "string" }, "hostAliases": { - "description": "Optional list of hosts and IPs that will be injected into the Pod's\nhosts file if specified.", + "description": "hostAliases defines the optional list of hosts and IPs that will be injected into the Pod's\nhosts file if specified.", "items": { "description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the\npod's hosts file.", "properties": { "hostnames": { - "description": "Hostnames for the above IP address.", + "description": "hostnames defines hostnames for the above IP address.", "items": { "type": "string" }, "type": "array" }, "ip": { - "description": "IP address of the host file entry.", + "description": "ip defines the IP address of the host file entry.", "type": "string" } }, @@ -2783,23 +2784,23 @@ "x-kubernetes-list-type": "map" }, "hostNetwork": { - "description": "Use the host's network namespace if true.\n\nMake sure to understand the security implications if you want to enable\nit (https://kubernetes.io/docs/concepts/configuration/overview/ ).\n\nWhen hostNetwork is enabled, this will set the DNS policy to\n`ClusterFirstWithHostNet` automatically (unless `.spec.DNSPolicy` is set\nto a different value).", + "description": "hostNetwork defines the host's network namespace if true.\n\nMake sure to understand the security implications if you want to enable\nit (https://kubernetes.io/docs/concepts/configuration/overview/ ).\n\nWhen hostNetwork is enabled, this will set the DNS policy to\n`ClusterFirstWithHostNet` automatically (unless `.spec.DNSPolicy` is set\nto a different value).", "type": "boolean" }, "hostUsers": { - "description": "HostUsers supports the user space in Kubernetes.\n\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/\n\nThe feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled.\nStarting Kubernetes 1.33, the feature is enabled by default.", + "description": "hostUsers supports the user space in Kubernetes.\n\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/\n\nThe feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled.\nStarting Kubernetes 1.33, the feature is enabled by default.", "type": "boolean" }, "ignoreNamespaceSelectors": { - "description": "When true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor\nand Probe objects will be ignored. They will only discover targets\nwithin the namespace of the PodMonitor, ServiceMonitor and Probe\nobject.", + "description": "ignoreNamespaceSelectors when true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor\nand Probe objects will be ignored. They will only discover targets\nwithin the namespace of the PodMonitor, ServiceMonitor and Probe\nobject.", "type": "boolean" }, "image": { - "description": "Container image name for Prometheus. If specified, it takes precedence\nover the `spec.baseImage`, `spec.tag` and `spec.sha` fields.\n\nSpecifying `spec.version` is still necessary to ensure the Prometheus\nOperator knows which version of Prometheus is being configured.\n\nIf neither `spec.image` nor `spec.baseImage` are defined, the operator\nwill use the latest upstream version of Prometheus available at the time\nwhen the operator was released.", + "description": "image defines the container image name for Prometheus. If specified, it takes precedence\nover the `spec.baseImage`, `spec.tag` and `spec.sha` fields.\n\nSpecifying `spec.version` is still necessary to ensure the Prometheus\nOperator knows which version of Prometheus is being configured.\n\nIf neither `spec.image` nor `spec.baseImage` are defined, the operator\nwill use the latest upstream version of Prometheus available at the time\nwhen the operator was released.", "type": "string" }, "imagePullPolicy": { - "description": "Image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers.\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.", + "description": "imagePullPolicy defines the image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers.\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.", "enum": [ "", "Always", @@ -2809,7 +2810,7 @@ "type": "string" }, "imagePullSecrets": { - "description": "An optional list of references to Secrets in the same namespace\nto use for pulling images from registries.\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod", + "description": "imagePullSecrets defines an optional list of references to Secrets in the same namespace\nto use for pulling images from registries.\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod", "items": { "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { @@ -2825,7 +2826,7 @@ "type": "array" }, "initContainers": { - "description": "InitContainers allows injecting initContainers to the Pod definition. Those\ncan be used to e.g. fetch secrets for injection into the Prometheus\nconfiguration from external sources. Any errors during the execution of\nan initContainer will lead to a restart of the Pod. More info:\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator generated init\ncontainers if they share the same name and modifications are done via a\nstrategic merge patch.\n\nThe names of init container name managed by the operator are:\n* `init-config-reloader`.\n\nOverriding init containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice.", + "description": "initContainers allows injecting initContainers to the Pod definition. Those\ncan be used to e.g. fetch secrets for injection into the Prometheus\nconfiguration from external sources. Any errors during the execution of\nan initContainer will lead to a restart of the Pod. More info:\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator generated init\ncontainers if they share the same name and modifications are done via a\nstrategic merge patch.\n\nThe names of init container name managed by the operator are:\n* `init-config-reloader`.\n\nOverriding init containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice.", "items": { "description": "A single application container that you want to run within a pod.", "properties": { @@ -4163,31 +4164,31 @@ "type": "array" }, "keepDroppedTargets": { - "description": "Per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\nIt requires Prometheus >= v2.47.0.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets.", + "description": "keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\nIt requires Prometheus >= v2.47.0.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets.", "format": "int64", "type": "integer" }, "labelLimit": { - "description": "Per-scrape limit on number of labels that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit.", + "description": "labelLimit defines per-scrape limit on number of labels that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit.", "format": "int64", "type": "integer" }, "labelNameLengthLimit": { - "description": "Per-scrape limit on length of labels name that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit.", + "description": "labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit.", "format": "int64", "type": "integer" }, "labelValueLengthLimit": { - "description": "Per-scrape limit on length of labels value that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit.", + "description": "labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit.", "format": "int64", "type": "integer" }, "listenLocal": { - "description": "When true, the Prometheus server listens on the loopback address\ninstead of the Pod IP's address.", + "description": "listenLocal when true, the Prometheus server listens on the loopback address\ninstead of the Pod IP's address.", "type": "boolean" }, "logFormat": { - "description": "Log format for Log level for Prometheus and the config-reloader sidecar.", + "description": "logFormat for Log level for Prometheus and the config-reloader sidecar.", "enum": [ "", "logfmt", @@ -4196,7 +4197,7 @@ "type": "string" }, "logLevel": { - "description": "Log level for Prometheus and the config-reloader sidecar.", + "description": "logLevel for Prometheus and the config-reloader sidecar.", "enum": [ "", "debug", @@ -4207,19 +4208,19 @@ "type": "string" }, "maximumStartupDurationSeconds": { - "description": "Defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete.\nIf set, the value should be greater than 60 (seconds). Otherwise it will be equal to 600 seconds (15 minutes).", + "description": "maximumStartupDurationSeconds defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete.\nIf set, the value should be greater than 60 (seconds). Otherwise it will be equal to 600 seconds (15 minutes).", "format": "int32", "minimum": 60, "type": "integer" }, "minReadySeconds": { - "description": "Minimum number of seconds for which a newly created Pod should be ready\nwithout any of its container crashing for it to be considered available.\n\nIf unset, pods will be considered available as soon as they are ready.", + "description": "minReadySeconds defines the minimum number of seconds for which a newly created Pod should be ready\nwithout any of its container crashing for it to be considered available.\n\nIf unset, pods will be considered available as soon as they are ready.", "format": "int32", "minimum": 0, "type": "integer" }, "mode": { - "description": "Mode defines how the Prometheus operator deploys the PrometheusAgent pod(s).\n\n(Alpha) Using this field requires the `PrometheusAgentDaemonSet` feature gate to be enabled.", + "description": "mode defines how the Prometheus operator deploys the PrometheusAgent pod(s).\n\n(Alpha) Using this field requires the `PrometheusAgentDaemonSet` feature gate to be enabled.", "enum": [ "StatefulSet", "DaemonSet" @@ -4227,7 +4228,7 @@ "type": "string" }, "nameEscapingScheme": { - "description": "Specifies the character escaping scheme that will be requested when scraping\nfor metric and label names that do not conform to the legacy Prometheus\ncharacter set.\n\nIt requires Prometheus >= v3.4.0.", + "description": "nameEscapingScheme defines the character escaping scheme that will be requested when scraping\nfor metric and label names that do not conform to the legacy Prometheus\ncharacter set.\n\nIt requires Prometheus >= v3.4.0.", "enum": [ "AllowUTF8", "Underscores", @@ -4237,7 +4238,7 @@ "type": "string" }, "nameValidationScheme": { - "description": "Specifies the validation scheme for metric and label names.\n\nIt requires Prometheus >= v2.55.0.", + "description": "nameValidationScheme defines the validation scheme for metric and label names.\n\nIt requires Prometheus >= v2.55.0.", "enum": [ "UTF8", "Legacy" @@ -4248,18 +4249,18 @@ "additionalProperties": { "type": "string" }, - "description": "Defines on which Nodes the Pods are scheduled.", + "description": "nodeSelector defines on which Nodes the Pods are scheduled.", "type": "object" }, "otlp": { - "description": "Settings related to the OTLP receiver feature.\nIt requires Prometheus >= v2.55.0.", + "description": "otlp defines the settings related to the OTLP receiver feature.\nIt requires Prometheus >= v2.55.0.", "properties": { "convertHistogramsToNHCB": { - "description": "Configures optional translation of OTLP explicit bucket histograms into native histograms with custom buckets.\nIt requires Prometheus >= v3.4.0.", + "description": "convertHistogramsToNHCB defines optional translation of OTLP explicit bucket histograms into native histograms with custom buckets.\nIt requires Prometheus >= v3.4.0.", "type": "boolean" }, "ignoreResourceAttributes": { - "description": "List of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true.\n\nIt requires `promoteAllResourceAttributes` to be true.\nIt requires Prometheus >= v3.5.0.", + "description": "ignoreResourceAttributes defines the list of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true.\n\nIt requires `promoteAllResourceAttributes` to be true.\nIt requires Prometheus >= v3.5.0.", "items": { "minLength": 1, "type": "string" @@ -4269,15 +4270,15 @@ "x-kubernetes-list-type": "set" }, "keepIdentifyingResourceAttributes": { - "description": "Enables adding `service.name`, `service.namespace` and `service.instance.id`\nresource attributes to the `target_info` metric, on top of converting them into the `instance` and `job` labels.\n\nIt requires Prometheus >= v3.1.0.", + "description": "keepIdentifyingResourceAttributes enables adding `service.name`, `service.namespace` and `service.instance.id`\nresource attributes to the `target_info` metric, on top of converting them into the `instance` and `job` labels.\n\nIt requires Prometheus >= v3.1.0.", "type": "boolean" }, "promoteAllResourceAttributes": { - "description": "Promote all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`.\n\nCannot be true when `promoteResourceAttributes` is defined.\nIt requires Prometheus >= v3.5.0.", + "description": "promoteAllResourceAttributes promotes all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`.\n\nCannot be true when `promoteResourceAttributes` is defined.\nIt requires Prometheus >= v3.5.0.", "type": "boolean" }, "promoteResourceAttributes": { - "description": "List of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none.\nCannot be defined when `promoteAllResourceAttributes` is true.", + "description": "promoteResourceAttributes defines the list of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none.\nCannot be defined when `promoteAllResourceAttributes` is true.", "items": { "minLength": 1, "type": "string" @@ -4287,7 +4288,7 @@ "x-kubernetes-list-type": "set" }, "translationStrategy": { - "description": "Configures how the OTLP receiver endpoint translates the incoming metrics.\n\nIt requires Prometheus >= v3.0.0.", + "description": "translationStrategy defines how the OTLP receiver endpoint translates the incoming metrics.\n\nIt requires Prometheus >= v3.0.0.", "enum": [ "NoUTF8EscapingWithSuffixes", "UnderscoreEscapingWithSuffixes", @@ -4299,19 +4300,19 @@ "type": "object" }, "overrideHonorLabels": { - "description": "When true, Prometheus resolves label conflicts by renaming the labels in the scraped data\n to “exported_” for all targets created from ServiceMonitor, PodMonitor and\nScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies.\nIn practice,`overrideHonorLaels:true` enforces `honorLabels:false`\nfor all ServiceMonitor, PodMonitor and ScrapeConfig objects.", + "description": "overrideHonorLabels when true, Prometheus resolves label conflicts by renaming the labels in the scraped data\n to “exported_” for all targets created from ServiceMonitor, PodMonitor and\nScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies.\nIn practice,`overrideHonorLaels:true` enforces `honorLabels:false`\nfor all ServiceMonitor, PodMonitor and ScrapeConfig objects.", "type": "boolean" }, "overrideHonorTimestamps": { - "description": "When true, Prometheus ignores the timestamps for all the targets created\nfrom service and pod monitors.\nOtherwise the HonorTimestamps field of the service or pod monitor applies.", + "description": "overrideHonorTimestamps when true, Prometheus ignores the timestamps for all the targets created\nfrom service and pod monitors.\nOtherwise the HonorTimestamps field of the service or pod monitor applies.", "type": "boolean" }, "paused": { - "description": "When a Prometheus deployment is paused, no actions except for deletion\nwill be performed on the underlying objects.", + "description": "paused defines when a Prometheus deployment is paused, no actions except for deletion\nwill be performed on the underlying objects.", "type": "boolean" }, "persistentVolumeClaimRetentionPolicy": { - "description": "The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet.\nThe default behavior is all PVCs are retained.\nThis is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26.\nIt requires enabling the StatefulSetAutoDeletePVC feature gate.", + "description": "persistentVolumeClaimRetentionPolicy defines the field controls if and how PVCs are deleted during the lifecycle of a StatefulSet.\nThe default behavior is all PVCs are retained.\nThis is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26.\nIt requires enabling the StatefulSetAutoDeletePVC feature gate.", "properties": { "whenDeleted": { "description": "WhenDeleted specifies what happens to PVCs created from StatefulSet\nVolumeClaimTemplates when the StatefulSet is deleted. The default policy\nof `Retain` causes PVCs to not be affected by StatefulSet deletion. The\n`Delete` policy causes those PVCs to be deleted.", @@ -4325,31 +4326,31 @@ "type": "object" }, "podMetadata": { - "description": "PodMetadata configures labels and annotations which are propagated to the Prometheus pods.\n\nThe following items are reserved and cannot be overridden:\n* \"prometheus\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/instance\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/managed-by\" label, set to \"prometheus-operator\".\n* \"app.kubernetes.io/name\" label, set to \"prometheus\".\n* \"app.kubernetes.io/version\" label, set to the Prometheus version.\n* \"operator.prometheus.io/name\" label, set to the name of the Prometheus object.\n* \"operator.prometheus.io/shard\" label, set to the shard number of the Prometheus object.\n* \"kubectl.kubernetes.io/default-container\" annotation, set to \"prometheus\".", + "description": "podMetadata defines labels and annotations which are propagated to the Prometheus pods.\n\nThe following items are reserved and cannot be overridden:\n* \"prometheus\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/instance\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/managed-by\" label, set to \"prometheus-operator\".\n* \"app.kubernetes.io/name\" label, set to \"prometheus\".\n* \"app.kubernetes.io/version\" label, set to the Prometheus version.\n* \"operator.prometheus.io/name\" label, set to the name of the Prometheus object.\n* \"operator.prometheus.io/shard\" label, set to the shard number of the Prometheus object.\n* \"kubectl.kubernetes.io/default-container\" annotation, set to \"prometheus\".", "properties": { "annotations": { "additionalProperties": { "type": "string" }, - "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", + "description": "annotations defines an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", + "description": "labels define the map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "type": "object" }, "name": { - "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", + "description": "name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", "type": "string" } }, "type": "object" }, "podMonitorNamespaceSelector": { - "description": "Namespaces to match for PodMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only.", + "description": "podMonitorNamespaceSelector defines the namespaces to match for PodMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -4394,7 +4395,7 @@ "x-kubernetes-map-type": "atomic" }, "podMonitorSelector": { - "description": "PodMonitors to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", + "description": "podMonitorSelector defines the podMonitors to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -4439,7 +4440,7 @@ "x-kubernetes-map-type": "atomic" }, "podTargetLabels": { - "description": "PodTargetLabels are appended to the `spec.podTargetLabels` field of all\nPodMonitor and ServiceMonitor objects.", + "description": "podTargetLabels are appended to the `spec.podTargetLabels` field of all\nPodMonitor and ServiceMonitor objects.", "items": { "type": "string" }, @@ -4447,15 +4448,15 @@ }, "portName": { "default": "web", - "description": "Port name used for the pods and governing service.\nDefault: \"web\"", + "description": "portName used for the pods and governing service.\nDefault: \"web\"", "type": "string" }, "priorityClassName": { - "description": "Priority class assigned to the Pods.", + "description": "priorityClassName assigned to the Pods.", "type": "string" }, "probeNamespaceSelector": { - "description": "Namespaces to match for Probe discovery. An empty label\nselector matches all namespaces. A null label selector matches the\ncurrent namespace only.", + "description": "probeNamespaceSelector defines the namespaces to match for Probe discovery. An empty label\nselector matches all namespaces. A null label selector matches the\ncurrent namespace only.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -4500,7 +4501,7 @@ "x-kubernetes-map-type": "atomic" }, "probeSelector": { - "description": "Probes to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", + "description": "probeSelector defines the probes to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -4545,11 +4546,11 @@ "x-kubernetes-map-type": "atomic" }, "prometheusExternalLabelName": { - "description": "Name of Prometheus external label used to denote the Prometheus instance\nname. The external label will _not_ be added when the field is set to\nthe empty string (`\"\"`).\n\nDefault: \"prometheus\"", + "description": "prometheusExternalLabelName defines the name of Prometheus external label used to denote the Prometheus instance\nname. The external label will _not_ be added when the field is set to\nthe empty string (`\"\"`).\n\nDefault: \"prometheus\"", "type": "string" }, "reloadStrategy": { - "description": "Defines the strategy used to reload the Prometheus configuration.\nIf not specified, the configuration is reloaded using the /-/reload HTTP endpoint.", + "description": "reloadStrategy defines the strategy used to reload the Prometheus configuration.\nIf not specified, the configuration is reloaded using the /-/reload HTTP endpoint.", "enum": [ "HTTP", "ProcessSignal" @@ -4557,15 +4558,15 @@ "type": "string" }, "remoteWrite": { - "description": "Defines the list of remote write configurations.", + "description": "remoteWrite defines the list of remote write configurations.", "items": { "description": "RemoteWriteSpec defines the configuration to write samples from Prometheus\nto a remote endpoint.", "properties": { "authorization": { - "description": "Authorization section for the URL.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`.", + "description": "authorization section for the URL.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4588,21 +4589,21 @@ "x-kubernetes-map-type": "atomic" }, "credentialsFile": { - "description": "File to read a secret from, mutually exclusive with `credentials`.", + "description": "credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`.", "type": "string" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "azureAd": { - "description": "AzureAD for the URL.\n\nIt requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`.", + "description": "azureAd for the URL.\n\nIt requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`.", "properties": { "cloud": { - "description": "The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'.", + "description": "cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'.", "enum": [ "AzureChina", "AzureGovernment", @@ -4611,10 +4612,10 @@ "type": "string" }, "managedIdentity": { - "description": "ManagedIdentity defines the Azure User-assigned Managed identity.\nCannot be set at the same time as `oauth` or `sdk`.", + "description": "managedIdentity defines the Azure User-assigned Managed identity.\nCannot be set at the same time as `oauth` or `sdk`.", "properties": { "clientId": { - "description": "The client id", + "description": "clientId defines defines the Azure User-assigned Managed identity.", "type": "string" } }, @@ -4624,15 +4625,15 @@ "type": "object" }, "oauth": { - "description": "OAuth defines the oauth config that is being used to authenticate.\nCannot be set at the same time as `managedIdentity` or `sdk`.\n\nIt requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.", + "description": "oauth defines the oauth config that is being used to authenticate.\nCannot be set at the same time as `managedIdentity` or `sdk`.\n\nIt requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.", "properties": { "clientId": { - "description": "`clientID` is the clientId of the Azure Active Directory application that is being used to authenticate.", + "description": "clientId defines the clientId of the Azure Active Directory application that is being used to authenticate.", "minLength": 1, "type": "string" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.", + "description": "clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4655,7 +4656,7 @@ "x-kubernetes-map-type": "atomic" }, "tenantId": { - "description": "`tenantId` is the tenant ID of the Azure Active Directory application that is being used to authenticate.", + "description": "tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate.", "minLength": 1, "pattern": "^[0-9a-zA-Z-.]+$", "type": "string" @@ -4669,10 +4670,10 @@ "type": "object" }, "sdk": { - "description": "SDK defines the Azure SDK config that is being used to authenticate.\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication\nCannot be set at the same time as `oauth` or `managedIdentity`.\n\nIt requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.", + "description": "sdk defines the Azure SDK config that is being used to authenticate.\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication\nCannot be set at the same time as `oauth` or `managedIdentity`.\n\nIt requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.", "properties": { "tenantId": { - "description": "`tenantId` is the tenant ID of the azure active directory application that is being used to authenticate.", + "description": "tenantId defines the tenant ID of the azure active directory application that is being used to authenticate.", "pattern": "^[0-9a-zA-Z-.]+$", "type": "string" } @@ -4683,10 +4684,10 @@ "type": "object" }, "basicAuth": { - "description": "BasicAuth configuration for the URL.\n\nCannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`.", + "description": "basicAuth configuration for the URL.\n\nCannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4709,7 +4710,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4735,30 +4736,30 @@ "type": "object" }, "bearerToken": { - "description": "*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\nDeprecated: this will be removed in a future release.", + "description": "bearerToken is deprecated: this will be removed in a future release.\n*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*", "type": "string" }, "bearerTokenFile": { - "description": "File from which to read bearer token for the URL.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", + "description": "bearerTokenFile defines the file from which to read bearer token for the URL.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", "type": "string" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.", "type": "boolean" }, "headers": { "additionalProperties": { "type": "string" }, - "description": "Custom HTTP headers to be sent along with each remote write request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\n\nIt requires Prometheus >= v2.25.0 or Thanos >= v0.24.0.", + "description": "headers defines the custom HTTP headers to be sent along with each remote write request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\n\nIt requires Prometheus >= v2.25.0 or Thanos >= v0.24.0.", "type": "object" }, "messageVersion": { - "description": "The Remote Write message's version to use when writing to the endpoint.\n\n`Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0.\n`Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0.\n\nWhen `Version2.0` is selected, Prometheus will automatically be\nconfigured to append the metadata of scraped metrics to the WAL.\n\nBefore setting this field, consult with your remote storage provider\nwhat message version it supports.\n\nIt requires Prometheus >= v2.54.0 or Thanos >= v0.37.0.", + "description": "messageVersion defines the Remote Write message's version to use when writing to the endpoint.\n\n`Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0.\n`Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0.\n\nWhen `Version2.0` is selected, Prometheus will automatically be\nconfigured to append the metadata of scraped metrics to the WAL.\n\nBefore setting this field, consult with your remote storage provider\nwhat message version it supports.\n\nIt requires Prometheus >= v2.54.0 or Thanos >= v0.37.0.", "enum": [ "V1.0", "V2.0" @@ -4766,20 +4767,20 @@ "type": "string" }, "metadataConfig": { - "description": "MetadataConfig configures the sending of series metadata to the remote storage.", + "description": "metadataConfig defines how to send a series metadata to the remote storage.", "properties": { "maxSamplesPerSend": { - "description": "MaxSamplesPerSend is the maximum number of metadata samples per send.\n\nIt requires Prometheus >= v2.29.0.", + "description": "maxSamplesPerSend defines the maximum number of metadata samples per send.\n\nIt requires Prometheus >= v2.29.0.", "format": "int32", "minimum": -1, "type": "integer" }, "send": { - "description": "Defines whether metric metadata is sent to the remote storage or not.", + "description": "send defines whether metric metadata is sent to the remote storage or not.", "type": "boolean" }, "sendInterval": { - "description": "Defines how frequently metric metadata is sent to the remote storage.", + "description": "sendInterval defines how frequently metric metadata is sent to the remote storage.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" } @@ -4787,21 +4788,21 @@ "type": "object" }, "name": { - "description": "The name of the remote write queue, it must be unique if specified. The\nname is used in metrics and logging in order to differentiate queues.\n\nIt requires Prometheus >= v2.15.0 or Thanos >= 0.24.0.", + "description": "name of the remote write queue, it must be unique if specified. The\nname is used in metrics and logging in order to differentiate queues.\n\nIt requires Prometheus >= v2.15.0 or Thanos >= 0.24.0.", "type": "string" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 configuration for the URL.\n\nIt requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`.", + "description": "oauth2 configuration for the URL.\n\nIt requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4824,7 +4825,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4850,7 +4851,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4876,11 +4877,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -4910,34 +4911,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4960,7 +4961,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4986,10 +4987,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5012,7 +5013,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5038,11 +5039,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5065,7 +5066,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -5075,7 +5076,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -5085,14 +5086,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -5131,63 +5132,63 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "queueConfig": { - "description": "QueueConfig allows tuning of the remote write queue parameters.", + "description": "queueConfig allows tuning of the remote write queue parameters.", "properties": { "batchSendDeadline": { - "description": "BatchSendDeadline is the maximum time a sample will wait in buffer.", + "description": "batchSendDeadline defines the maximum time a sample will wait in buffer.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "capacity": { - "description": "Capacity is the number of samples to buffer per shard before we start\ndropping them.", + "description": "capacity defines the number of samples to buffer per shard before we start\ndropping them.", "type": "integer" }, "maxBackoff": { - "description": "MaxBackoff is the maximum retry delay.", + "description": "maxBackoff defines the maximum retry delay.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "maxRetries": { - "description": "MaxRetries is the maximum number of times to retry a batch on recoverable errors.", + "description": "maxRetries defines the maximum number of times to retry a batch on recoverable errors.", "type": "integer" }, "maxSamplesPerSend": { - "description": "MaxSamplesPerSend is the maximum number of samples per send.", + "description": "maxSamplesPerSend defines the maximum number of samples per send.", "type": "integer" }, "maxShards": { - "description": "MaxShards is the maximum number of shards, i.e. amount of concurrency.", + "description": "maxShards defines the maximum number of shards, i.e. amount of concurrency.", "type": "integer" }, "minBackoff": { - "description": "MinBackoff is the initial retry delay. Gets doubled for every retry.", + "description": "minBackoff defines the initial retry delay. Gets doubled for every retry.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "minShards": { - "description": "MinShards is the minimum number of shards, i.e. amount of concurrency.", + "description": "minShards defines the minimum number of shards, i.e. amount of concurrency.", "type": "integer" }, "retryOnRateLimit": { - "description": "Retry upon receiving a 429 status code from the remote-write storage.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", + "description": "retryOnRateLimit defines the retry upon receiving a 429 status code from the remote-write storage.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "type": "boolean" }, "sampleAgeLimit": { - "description": "SampleAgeLimit drops samples older than the limit.\nIt requires Prometheus >= v2.50.0 or Thanos >= v0.32.0.", + "description": "sampleAgeLimit drops samples older than the limit.\nIt requires Prometheus >= v2.50.0 or Thanos >= v0.32.0.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" } @@ -5195,27 +5196,27 @@ "type": "object" }, "remoteTimeout": { - "description": "Timeout for requests to the remote write endpoint.", + "description": "remoteTimeout defines the timeout for requests to the remote write endpoint.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "roundRobinDNS": { - "description": "When enabled:\n - The remote-write mechanism will resolve the hostname via DNS.\n - It will randomly select one of the resolved IP addresses and connect to it.\n\nWhen disabled (default behavior):\n - The Go standard library will handle hostname resolution.\n - It will attempt connections to each resolved IP address sequentially.\n\nNote: The connection timeout applies to the entire resolution and connection process.\n If disabled, the timeout is distributed across all connection attempts.\n\nIt requires Prometheus >= v3.1.0 or Thanos >= v0.38.0.", + "description": "roundRobinDNS controls the DNS resolution behavior for remote-write connections.\nWhen enabled:\n - The remote-write mechanism will resolve the hostname via DNS.\n - It will randomly select one of the resolved IP addresses and connect to it.\n\nWhen disabled (default behavior):\n - The Go standard library will handle hostname resolution.\n - It will attempt connections to each resolved IP address sequentially.\n\nNote: The connection timeout applies to the entire resolution and connection process.\n\n\tIf disabled, the timeout is distributed across all connection attempts.\n\nIt requires Prometheus >= v3.1.0 or Thanos >= v0.38.0.", "type": "boolean" }, "sendExemplars": { - "description": "Enables sending of exemplars over remote write. Note that\nexemplar-storage itself must be enabled using the `spec.enableFeatures`\noption for exemplars to be scraped in the first place.\n\nIt requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.", + "description": "sendExemplars enables sending of exemplars over remote write. Note that\nexemplar-storage itself must be enabled using the `spec.enableFeatures`\noption for exemplars to be scraped in the first place.\n\nIt requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.", "type": "boolean" }, "sendNativeHistograms": { - "description": "Enables sending of native histograms, also known as sparse histograms\nover remote write.\n\nIt requires Prometheus >= v2.40.0 or Thanos >= v0.30.0.", + "description": "sendNativeHistograms enables sending of native histograms, also known as sparse histograms\nover remote write.\n\nIt requires Prometheus >= v2.40.0 or Thanos >= v0.30.0.", "type": "boolean" }, "sigv4": { - "description": "Sigv4 allows to configures AWS's Signature Verification 4 for the URL.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`.", + "description": "sigv4 defines the AWS's Signature Verification 4 for the URL.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`.", "properties": { "accessKey": { - "description": "AccessKey is the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.", + "description": "accessKey defines the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5238,19 +5239,19 @@ "x-kubernetes-map-type": "atomic" }, "profile": { - "description": "Profile is the named AWS profile used to authenticate.", + "description": "profile defines the named AWS profile used to authenticate.", "type": "string" }, "region": { - "description": "Region is the AWS region. If blank, the region from the default credentials chain used.", + "description": "region defines the AWS region. If blank, the region from the default credentials chain used.", "type": "string" }, "roleArn": { - "description": "RoleArn is the named AWS profile used to authenticate.", + "description": "roleArn defines the named AWS profile used to authenticate.", "type": "string" }, "secretKey": { - "description": "SecretKey is the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.", + "description": "secretKey defines the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5276,13 +5277,13 @@ "type": "object" }, "tlsConfig": { - "description": "TLS Config to use for the URL.", + "description": "tlsConfig to use for the URL.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5305,7 +5306,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5331,14 +5332,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5361,7 +5362,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5387,19 +5388,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5422,7 +5423,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -5432,7 +5433,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -5442,25 +5443,25 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "url": { - "description": "The URL of the endpoint to send samples to.", + "description": "url defines the URL of the endpoint to send samples to.", "minLength": 1, "type": "string" }, "writeRelabelConfigs": { - "description": "The list of remote write relabel configurations.", + "description": "writeRelabelConfigs defines the list of remote write relabel configurations.", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -5488,24 +5489,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -5514,7 +5515,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -5531,7 +5532,7 @@ "type": "array" }, "remoteWriteReceiverMessageVersions": { - "description": "List of the protobuf message versions to accept when receiving the\nremote writes.\n\nIt requires Prometheus >= v2.54.0.", + "description": "remoteWriteReceiverMessageVersions list of the protobuf message versions to accept when receiving the\nremote writes.\n\nIt requires Prometheus >= v2.54.0.", "items": { "enum": [ "V1.0", @@ -5544,16 +5545,16 @@ "x-kubernetes-list-type": "set" }, "replicaExternalLabelName": { - "description": "Name of Prometheus external label used to denote the replica name.\nThe external label will _not_ be added when the field is set to the\nempty string (`\"\"`).\n\nDefault: \"prometheus_replica\"", + "description": "replicaExternalLabelName defines the name of Prometheus external label used to denote the replica name.\nThe external label will _not_ be added when the field is set to the\nempty string (`\"\"`).\n\nDefault: \"prometheus_replica\"", "type": "string" }, "replicas": { - "description": "Number of replicas of each shard to deploy for a Prometheus deployment.\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\ncreated.\n\nDefault: 1", + "description": "replicas defines the number of replicas of each shard to deploy for a Prometheus deployment.\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\ncreated.\n\nDefault: 1", "format": "int32", "type": "integer" }, "resources": { - "description": "Defines the resources requests and limits of the 'prometheus' container.", + "description": "resources defines the resources requests and limits of the 'prometheus' container.", "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis field depends on the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.", @@ -5616,14 +5617,14 @@ "type": "object" }, "routePrefix": { - "description": "The route prefix Prometheus registers HTTP handlers for.\n\nThis is useful when using `spec.externalURL`, and a proxy is rewriting\nHTTP routes of a request, and the actual ExternalURL is still true, but\nthe server serves requests under a different route prefix. For example\nfor use with `kubectl proxy`.", + "description": "routePrefix defines the route prefix Prometheus registers HTTP handlers for.\n\nThis is useful when using `spec.externalURL`, and a proxy is rewriting\nHTTP routes of a request, and the actual ExternalURL is still true, but\nthe server serves requests under a different route prefix. For example\nfor use with `kubectl proxy`.", "type": "string" }, "runtime": { - "description": "RuntimeConfig configures the values for the Prometheus process behavior", + "description": "runtime defines the values for the Prometheus process behavior", "properties": { "goGC": { - "description": "The Go garbage collection target percentage. Lowering this number may increase the CPU usage.\nSee: https://tip.golang.org/doc/gc-guide#GOGC", + "description": "goGC defines the Go garbage collection target percentage. Lowering this number may increase the CPU usage.\nSee: https://tip.golang.org/doc/gc-guide#GOGC", "format": "int32", "minimum": -1, "type": "integer" @@ -5632,29 +5633,29 @@ "type": "object" }, "sampleLimit": { - "description": "SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit.", + "description": "sampleLimit defines per-scrape limit on number of scraped samples that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit.", "format": "int64", "type": "integer" }, "scrapeClasses": { - "description": "List of scrape classes to expose to scraping objects such as\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", + "description": "scrapeClasses defines the list of scrape classes to expose to scraping objects such as\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "items": { "properties": { "attachMetadata": { - "description": "AttachMetadata configures additional metadata to the discovered targets.\nWhen the scrape object defines its own configuration, it takes\nprecedence over the scrape class configuration.", + "description": "attachMetadata defines additional metadata to the discovered targets.\nWhen the scrape object defines its own configuration, it takes\nprecedence over the scrape class configuration.", "properties": { "node": { - "description": "When set to true, Prometheus attaches node metadata to the discovered\ntargets.\n\nThe Prometheus service account must have the `list` and `watch`\npermissions on the `Nodes` objects.", + "description": "node when set to true, Prometheus attaches node metadata to the discovered\ntargets.\n\nThe Prometheus service account must have the `list` and `watch`\npermissions on the `Nodes` objects.", "type": "boolean" } }, "type": "object" }, "authorization": { - "description": "Authorization section for the ScrapeClass.\nIt will only apply if the scrape resource doesn't specify any Authorization.", + "description": "authorization section for the ScrapeClass.\nIt will only apply if the scrape resource doesn't specify any Authorization.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5677,22 +5678,22 @@ "x-kubernetes-map-type": "atomic" }, "credentialsFile": { - "description": "File to read a secret from, mutually exclusive with `credentials`.", + "description": "credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`.", "type": "string" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "default": { - "description": "Default indicates that the scrape applies to all scrape objects that\ndon't configure an explicit scrape class name.\n\nOnly one scrape class can be set as the default.", + "description": "default defines that the scrape applies to all scrape objects that\ndon't configure an explicit scrape class name.\n\nOnly one scrape class can be set as the default.", "type": "boolean" }, "fallbackScrapeProtocol": { - "description": "The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\nIt will only apply if the scrape resource doesn't specify any FallbackScrapeProtocol\n\nIt requires Prometheus >= v3.0.0.", + "description": "fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\nIt will only apply if the scrape resource doesn't specify any FallbackScrapeProtocol\n\nIt requires Prometheus >= v3.0.0.", "enum": [ "PrometheusProto", "OpenMetricsText0.0.1", @@ -5703,13 +5704,13 @@ "type": "string" }, "metricRelabelings": { - "description": "MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\n\nThe Operator adds the scrape class metric relabelings defined here.\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs", + "description": "metricRelabelings defines the relabeling rules to apply to all samples before ingestion.\n\nThe Operator adds the scrape class metric relabelings defined here.\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -5737,24 +5738,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -5763,7 +5764,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -5772,18 +5773,18 @@ "type": "array" }, "name": { - "description": "Name of the scrape class.", + "description": "name of the scrape class.", "minLength": 1, "type": "string" }, "relabelings": { - "description": "Relabelings configures the relabeling rules to apply to all scrape targets.\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\nThen the Operator adds the scrape class relabelings defined here.\nThen the Operator adds the target-specific relabelings defined in the scrape object.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", + "description": "relabelings defines the relabeling rules to apply to all scrape targets.\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\nThen the Operator adds the scrape class relabelings defined here.\nThen the Operator adds the target-specific relabelings defined in the scrape object.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -5811,24 +5812,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -5837,7 +5838,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -5846,13 +5847,13 @@ "type": "array" }, "tlsConfig": { - "description": "TLSConfig defines the TLS settings to use for the scrape. When the\nscrape objects define their own CA, certificate and/or key, they take\nprecedence over the corresponding scrape class fields.\n\nFor now only the `caFile`, `certFile` and `keyFile` fields are supported.", + "description": "tlsConfig defines the TLS settings to use for the scrape. When the\nscrape objects define their own CA, certificate and/or key, they take\nprecedence over the corresponding scrape class fields.\n\nFor now only the `caFile`, `certFile` and `keyFile` fields are supported.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5875,7 +5876,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5901,14 +5902,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5931,7 +5932,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5957,19 +5958,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5992,7 +5993,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -6002,7 +6003,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -6012,7 +6013,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -6031,11 +6032,11 @@ "x-kubernetes-list-type": "map" }, "scrapeClassicHistograms": { - "description": "Whether to scrape a classic histogram that is also exposed as a native histogram.\n\nNotice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.\n\nIt requires Prometheus >= v3.5.0.", + "description": "scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram.\n\nNotice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.\n\nIt requires Prometheus >= v3.5.0.", "type": "boolean" }, "scrapeConfigNamespaceSelector": { - "description": "Namespaces to match for ScrapeConfig discovery. An empty label selector\nmatches all namespaces. A null label selector matches the current\nnamespace only.\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level.", + "description": "scrapeConfigNamespaceSelector defines the namespaces to match for ScrapeConfig discovery. An empty label selector\nmatches all namespaces. A null label selector matches the current\nnamespace only.\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -6080,7 +6081,7 @@ "x-kubernetes-map-type": "atomic" }, "scrapeConfigSelector": { - "description": "ScrapeConfigs to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level.", + "description": "scrapeConfigSelector defines the scrapeConfigs to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -6125,18 +6126,18 @@ "x-kubernetes-map-type": "atomic" }, "scrapeFailureLogFile": { - "description": "File to which scrape failures are logged.\nReloading the configuration will reopen the file.\n\nIf the filename has an empty path, e.g. 'file.log', The Prometheus Pods\nwill mount the file into an emptyDir volume at `/var/log/prometheus`.\nIf a full path is provided, e.g. '/var/log/prometheus/file.log', you\nmust mount a volume in the specified directory and it must be writable.\nIt requires Prometheus >= v2.55.0.", + "description": "scrapeFailureLogFile defines the file to which scrape failures are logged.\nReloading the configuration will reopen the file.\n\nIf the filename has an empty path, e.g. 'file.log', The Prometheus Pods\nwill mount the file into an emptyDir volume at `/var/log/prometheus`.\nIf a full path is provided, e.g. '/var/log/prometheus/file.log', you\nmust mount a volume in the specified directory and it must be writable.\nIt requires Prometheus >= v2.55.0.", "minLength": 1, "type": "string" }, "scrapeInterval": { "default": "30s", - "description": "Interval between consecutive scrapes.\n\nDefault: \"30s\"", + "description": "scrapeInterval defines interval between consecutive scrapes.\n\nDefault: \"30s\"", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "scrapeProtocols": { - "description": "The protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0.\n\n`PrometheusText1.0.0` requires Prometheus >= v3.0.0.", + "description": "scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0.\n\n`PrometheusText1.0.0` requires Prometheus >= v3.0.0.", "items": { "description": "ScrapeProtocol represents a protocol used by Prometheus for scraping metrics.\nSupported values are:\n* `OpenMetricsText0.0.1`\n* `OpenMetricsText1.0.0`\n* `PrometheusProto`\n* `PrometheusText0.0.4`\n* `PrometheusText1.0.0`", "enum": [ @@ -6152,12 +6153,12 @@ "x-kubernetes-list-type": "set" }, "scrapeTimeout": { - "description": "Number of seconds to wait until a scrape request times out.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.", + "description": "scrapeTimeout defines the number of seconds to wait until a scrape request times out.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "secrets": { - "description": "Secrets is a list of Secrets in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach Secret is added to the StatefulSet definition as a volume named `secret-`.\nThe Secrets are mounted into /etc/prometheus/secrets/ in the 'prometheus' container.", + "description": "secrets defines a list of Secrets in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach Secret is added to the StatefulSet definition as a volume named `secret-`.\nThe Secrets are mounted into /etc/prometheus/secrets/ in the 'prometheus' container.", "items": { "type": "string" }, @@ -6165,7 +6166,7 @@ "x-kubernetes-list-type": "set" }, "securityContext": { - "description": "SecurityContext holds pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext.", + "description": "securityContext holds pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext.", "properties": { "appArmorProfile": { "description": "appArmorProfile is the AppArmor options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.", @@ -6312,11 +6313,11 @@ "type": "object" }, "serviceAccountName": { - "description": "ServiceAccountName is the name of the ServiceAccount to use to run the\nPrometheus Pods.", + "description": "serviceAccountName is the name of the ServiceAccount to use to run the\nPrometheus Pods.", "type": "string" }, "serviceDiscoveryRole": { - "description": "Defines the service discovery role used to discover targets from\n`ServiceMonitor` objects and Alertmanager endpoints.\n\nIf set, the value should be either \"Endpoints\" or \"EndpointSlice\".\nIf unset, the operator assumes the \"Endpoints\" role.", + "description": "serviceDiscoveryRole defines the service discovery role used to discover targets from\n`ServiceMonitor` objects and Alertmanager endpoints.\n\nIf set, the value should be either \"Endpoints\" or \"EndpointSlice\".\nIf unset, the operator assumes the \"Endpoints\" role.", "enum": [ "Endpoints", "EndpointSlice" @@ -6324,7 +6325,7 @@ "type": "string" }, "serviceMonitorNamespaceSelector": { - "description": "Namespaces to match for ServicedMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only.", + "description": "serviceMonitorNamespaceSelector defines the namespaces to match for ServicedMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -6369,7 +6370,7 @@ "x-kubernetes-map-type": "atomic" }, "serviceMonitorSelector": { - "description": "ServiceMonitors to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", + "description": "serviceMonitorSelector defines the serviceMonitors to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -6414,24 +6415,24 @@ "x-kubernetes-map-type": "atomic" }, "serviceName": { - "description": "The name of the service name used by the underlying StatefulSet(s) as the governing service.\nIf defined, the Service must be created before the Prometheus/PrometheusAgent resource in the same namespace and it must define a selector that matches the pod labels.\nIf empty, the operator will create and manage a headless service named `prometheus-operated` for Prometheus resources,\nor `prometheus-agent-operated` for PrometheusAgent resources.\nWhen deploying multiple Prometheus/PrometheusAgent resources in the same namespace, it is recommended to specify a different value for each.\nSee https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details.", + "description": "serviceName defines the name of the service name used by the underlying StatefulSet(s) as the governing service.\nIf defined, the Service must be created before the Prometheus/PrometheusAgent resource in the same namespace and it must define a selector that matches the pod labels.\nIf empty, the operator will create and manage a headless service named `prometheus-operated` for Prometheus resources,\nor `prometheus-agent-operated` for PrometheusAgent resources.\nWhen deploying multiple Prometheus/PrometheusAgent resources in the same namespace, it is recommended to specify a different value for each.\nSee https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details.", "minLength": 1, "type": "string" }, "shards": { - "description": "Number of shards to distribute the scraped targets onto.\n\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\nbeing created.\n\nWhen not defined, the operator assumes only one shard.\n\nNote that scaling down shards will not reshard data onto the remaining\ninstances, it must be manually moved. Increasing shards will not reshard\ndata either but it will continue to be available from the same\ninstances. To query globally, use either\n* Thanos sidecar + querier for query federation and Thanos Ruler for rules.\n* Remote-write to send metrics to a central location.\n\nBy default, the sharding of targets is performed on:\n* The `__address__` target's metadata label for PodMonitor,\nServiceMonitor and ScrapeConfig resources.\n* The `__param_target__` label for Probe resources.\n\nUsers can define their own sharding implementation by setting the\n`__tmp_hash` label during the target discovery with relabeling\nconfiguration (either in the monitoring resources or via scrape class).\n\nYou can also disable sharding on a specific target by setting the\n`__tmp_disable_sharding` label with relabeling configuration. When\nthe label value isn't empty, all Prometheus shards will scrape the target.", + "description": "shards defines the number of shards to distribute the scraped targets onto.\n\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\nbeing created.\n\nWhen not defined, the operator assumes only one shard.\n\nNote that scaling down shards will not reshard data onto the remaining\ninstances, it must be manually moved. Increasing shards will not reshard\ndata either but it will continue to be available from the same\ninstances. To query globally, use either\n* Thanos sidecar + querier for query federation and Thanos Ruler for rules.\n* Remote-write to send metrics to a central location.\n\nBy default, the sharding of targets is performed on:\n* The `__address__` target's metadata label for PodMonitor,\nServiceMonitor and ScrapeConfig resources.\n* The `__param_target__` label for Probe resources.\n\nUsers can define their own sharding implementation by setting the\n`__tmp_hash` label during the target discovery with relabeling\nconfiguration (either in the monitoring resources or via scrape class).\n\nYou can also disable sharding on a specific target by setting the\n`__tmp_disable_sharding` label with relabeling configuration. When\nthe label value isn't empty, all Prometheus shards will scrape the target.", "format": "int32", "type": "integer" }, "storage": { - "description": "Storage defines the storage used by Prometheus.", + "description": "storage defines the storage used by Prometheus.", "properties": { "disableMountSubPath": { - "description": "Deprecated: subPath usage will be removed in a future release.", + "description": "disableMountSubPath deprecated: subPath usage will be removed in a future release.", "type": "boolean" }, "emptyDir": { - "description": "EmptyDirVolumeSource to be used by the StatefulSet.\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir", + "description": "emptyDir to be used by the StatefulSet.\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir", "properties": { "medium": { "description": "medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", @@ -6454,7 +6455,7 @@ "type": "object" }, "ephemeral": { - "description": "EphemeralVolumeSource to be used by the StatefulSet.\nThis is a beta field in k8s 1.21 and GA in 1.15.\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes", + "description": "ephemeral to be used by the StatefulSet.\nThis is a beta field in k8s 1.21 and GA in 1.15.\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes", "properties": { "volumeClaimTemplate": { "description": "Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `-` where\n`` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\nRequired, must not be nil.", @@ -6635,7 +6636,7 @@ "type": "object" }, "volumeClaimTemplate": { - "description": "Defines the PVC spec to be used by the Prometheus StatefulSets.\nThe easiest way to use a volume that cannot be automatically provisioned\nis to use a label selector alongside manually created PersistentVolumes.", + "description": "volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets.\nThe easiest way to use a volume that cannot be automatically provisioned\nis to use a label selector alongside manually created PersistentVolumes.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", @@ -6646,31 +6647,31 @@ "type": "string" }, "metadata": { - "description": "EmbeddedMetadata contains metadata relevant to an EmbeddedResource.", + "description": "metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, - "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", + "description": "annotations defines an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", + "description": "labels define the map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "type": "object" }, "name": { - "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", + "description": "name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", "type": "string" } }, "type": "object" }, "spec": { - "description": "Defines the desired characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", + "description": "spec defines the specification of the characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "properties": { "accessModes": { "description": "accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", @@ -6832,7 +6833,7 @@ "type": "object" }, "status": { - "description": "Deprecated: this field is never set.", + "description": "status is deprecated: this field is never set.", "properties": { "accessModes": { "description": "accessModes contains the actual access modes the volume backing the PVC has.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", @@ -6962,18 +6963,18 @@ "type": "object" }, "targetLimit": { - "description": "TargetLimit defines a limit on the number of scraped targets that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit.", + "description": "targetLimit defines a limit on the number of scraped targets that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit.", "format": "int64", "type": "integer" }, "terminationGracePeriodSeconds": { - "description": "Optional duration in seconds the pod needs to terminate gracefully.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down) which may lead to data corruption.\n\nDefaults to 600 seconds.", + "description": "terminationGracePeriodSeconds defines the optional duration in seconds the pod needs to terminate gracefully.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down) which may lead to data corruption.\n\nDefaults to 600 seconds.", "format": "int64", "minimum": 0, "type": "integer" }, "tolerations": { - "description": "Defines the Pods' tolerations if specified.", + "description": "tolerations defines the Pods' tolerations if specified.", "items": { "description": "The pod this Toleration is attached to tolerates any taint that matches\nthe triple using the matching operator .", "properties": { @@ -7004,11 +7005,11 @@ "type": "array" }, "topologySpreadConstraints": { - "description": "Defines the pod's topology spread constraints if specified.", + "description": "topologySpreadConstraints defines the pod's topology spread constraints if specified.", "items": { "properties": { "additionalLabelSelectors": { - "description": "Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint.", + "description": "additionalLabelSelectors Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint.", "enum": [ "OnResource", "OnShard" @@ -7105,10 +7106,10 @@ "type": "array" }, "tracingConfig": { - "description": "TracingConfig configures tracing in Prometheus.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", + "description": "tracingConfig defines tracing in Prometheus.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "properties": { "clientType": { - "description": "Client used to export the traces. Supported values are `http` or `grpc`.", + "description": "clientType defines the client used to export the traces. Supported values are `http` or `grpc`.", "enum": [ "http", "grpc" @@ -7116,14 +7117,14 @@ "type": "string" }, "compression": { - "description": "Compression key for supported compression types. The only supported value is `gzip`.", + "description": "compression key for supported compression types. The only supported value is `gzip`.", "enum": [ "gzip" ], "type": "string" }, "endpoint": { - "description": "Endpoint to send the traces to. Should be provided in format :.", + "description": "endpoint to send the traces to. Should be provided in format :.", "minLength": 1, "type": "string" }, @@ -7131,11 +7132,11 @@ "additionalProperties": { "type": "string" }, - "description": "Key-value pairs to be used as headers associated with gRPC or HTTP requests.", + "description": "headers defines the key-value pairs to be used as headers associated with gRPC or HTTP requests.", "type": "object" }, "insecure": { - "description": "If disabled, the client will use a secure connection.", + "description": "insecure if disabled, the client will use a secure connection.", "type": "boolean" }, "samplingFraction": { @@ -7147,23 +7148,23 @@ "type": "string" } ], - "description": "Sets the probability a given trace will be sampled. Must be a float from 0 through 1.", + "description": "samplingFraction defines the probability a given trace will be sampled. Must be a float from 0 through 1.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "timeout": { - "description": "Maximum time the exporter will wait for each batch export.", + "description": "timeout defines the maximum time the exporter will wait for each batch export.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "tlsConfig": { - "description": "TLS Config to use when sending traces.", + "description": "tlsConfig to use when sending traces.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7186,7 +7187,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7212,14 +7213,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7242,7 +7243,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7268,19 +7269,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7303,7 +7304,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -7313,7 +7314,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -7323,7 +7324,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -7336,10 +7337,10 @@ "type": "object" }, "tsdb": { - "description": "Defines the runtime reloadable configuration of the timeseries database(TSDB).\nIt requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0.", + "description": "tsdb defines the runtime reloadable configuration of the timeseries database(TSDB).\nIt requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0.", "properties": { "outOfOrderTimeWindow": { - "description": "Configures how old an out-of-order/out-of-bounds sample can be with\nrespect to the TSDB max time.\n\nAn out-of-order/out-of-bounds sample is ingested into the TSDB as long as\nthe timestamp of the sample is >= (TSDB.MaxTime - outOfOrderTimeWindow).\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.\n\nIt requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0.", + "description": "outOfOrderTimeWindow defines how old an out-of-order/out-of-bounds sample can be with\nrespect to the TSDB max time.\n\nAn out-of-order/out-of-bounds sample is ingested into the TSDB as long as\nthe timestamp of the sample is >= (TSDB.MaxTime - outOfOrderTimeWindow).\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.\n\nIt requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" } @@ -7347,11 +7348,11 @@ "type": "object" }, "version": { - "description": "Version of Prometheus being deployed. The operator uses this information\nto generate the Prometheus StatefulSet + configuration files.\n\nIf not specified, the operator assumes the latest upstream version of\nPrometheus available at the time when the version of the operator was\nreleased.", + "description": "version of Prometheus being deployed. The operator uses this information\nto generate the Prometheus StatefulSet + configuration files.\n\nIf not specified, the operator assumes the latest upstream version of\nPrometheus available at the time when the version of the operator was\nreleased.", "type": "string" }, "volumeMounts": { - "description": "VolumeMounts allows the configuration of additional VolumeMounts.\n\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\ncontainer, that are generated as a result of StorageSpec objects.", + "description": "volumeMounts allows the configuration of additional VolumeMounts.\n\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\ncontainer, that are generated as a result of StorageSpec objects.", "items": { "description": "VolumeMount describes a mounting of a Volume within a container.", "properties": { @@ -7393,7 +7394,7 @@ "type": "array" }, "volumes": { - "description": "Volumes allows the configuration of additional volumes on the output\nStatefulSet definition. Volumes specified will be appended to other\nvolumes that are generated as a result of StorageSpec objects.", + "description": "volumes allows the configuration of additional volumes on the output\nStatefulSet definition. Volumes specified will be appended to other\nvolumes that are generated as a result of StorageSpec objects.", "items": { "description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.", "properties": { @@ -8856,28 +8857,28 @@ "type": "array" }, "walCompression": { - "description": "Configures compression of the write-ahead log (WAL) using Snappy.\n\nWAL compression is enabled by default for Prometheus >= 2.20.0\n\nRequires Prometheus v2.11.0 and above.", + "description": "walCompression defines the compression of the write-ahead log (WAL) using Snappy.\n\nWAL compression is enabled by default for Prometheus >= 2.20.0\n\nRequires Prometheus v2.11.0 and above.", "type": "boolean" }, "web": { - "description": "Defines the configuration of the Prometheus web server.", + "description": "web defines the configuration of the Prometheus web server.", "properties": { "httpConfig": { - "description": "Defines HTTP parameters for web server.", + "description": "httpConfig defines HTTP parameters for web server.", "properties": { "headers": { - "description": "List of headers that can be added to HTTP responses.", + "description": "headers defines a list of headers that can be added to HTTP responses.", "properties": { "contentSecurityPolicy": { - "description": "Set the Content-Security-Policy header to HTTP responses.\nUnset if blank.", + "description": "contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses.\nUnset if blank.", "type": "string" }, "strictTransportSecurity": { - "description": "Set the Strict-Transport-Security header to HTTP responses.\nUnset if blank.\nPlease make sure that you use this with care as this header might force\nbrowsers to load Prometheus and the other applications hosted on the same\ndomain and subdomains over HTTPS.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security", + "description": "strictTransportSecurity defines the Strict-Transport-Security header to HTTP responses.\nUnset if blank.\nPlease make sure that you use this with care as this header might force\nbrowsers to load Prometheus and the other applications hosted on the same\ndomain and subdomains over HTTPS.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security", "type": "string" }, "xContentTypeOptions": { - "description": "Set the X-Content-Type-Options header to HTTP responses.\nUnset if blank. Accepted value is nosniff.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options", + "description": "xContentTypeOptions defines the X-Content-Type-Options header to HTTP responses.\nUnset if blank. Accepted value is nosniff.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options", "enum": [ "", "NoSniff" @@ -8885,7 +8886,7 @@ "type": "string" }, "xFrameOptions": { - "description": "Set the X-Frame-Options header to HTTP responses.\nUnset if blank. Accepted values are deny and sameorigin.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options", + "description": "xFrameOptions defines the X-Frame-Options header to HTTP responses.\nUnset if blank. Accepted values are deny and sameorigin.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options", "enum": [ "", "Deny", @@ -8894,37 +8895,37 @@ "type": "string" }, "xXSSProtection": { - "description": "Set the X-XSS-Protection header to all responses.\nUnset if blank.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection", + "description": "xXSSProtection defines the X-XSS-Protection header to all responses.\nUnset if blank.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection", "type": "string" } }, "type": "object" }, "http2": { - "description": "Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\nWhenever the value of the field changes, a rolling update will be triggered.", + "description": "http2 enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\nWhenever the value of the field changes, a rolling update will be triggered.", "type": "boolean" } }, "type": "object" }, "maxConnections": { - "description": "Defines the maximum number of simultaneous connections\nA zero value means that Prometheus doesn't accept any incoming connection.", + "description": "maxConnections defines the maximum number of simultaneous connections\nA zero value means that Prometheus doesn't accept any incoming connection.", "format": "int32", "minimum": 0, "type": "integer" }, "pageTitle": { - "description": "The prometheus web page title.", + "description": "pageTitle defines the prometheus web page title.", "type": "string" }, "tlsConfig": { - "description": "Defines the TLS parameters for HTTPS.", + "description": "tlsConfig defines the TLS parameters for HTTPS.", "properties": { "cert": { - "description": "Secret or ConfigMap containing the TLS certificate for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `certFile`.", + "description": "cert defines the Secret or ConfigMap containing the TLS certificate for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `certFile`.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8947,7 +8948,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8973,29 +8974,29 @@ "type": "object" }, "certFile": { - "description": "Path to the TLS certificate file in the container for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `cert`.", + "description": "certFile defines the path to the TLS certificate file in the container for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `cert`.", "type": "string" }, "cipherSuites": { - "description": "List of supported cipher suites for TLS versions up to TLS 1.2.\n\nIf not defined, the Go default cipher suites are used.\nAvailable cipher suites are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#pkg-constants", + "description": "cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2.\n\nIf not defined, the Go default cipher suites are used.\nAvailable cipher suites are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#pkg-constants", "items": { "type": "string" }, "type": "array" }, "clientAuthType": { - "description": "The server policy for client TLS authentication.\n\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType", + "description": "clientAuthType defines the server policy for client TLS authentication.\n\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType", "type": "string" }, "clientCAFile": { - "description": "Path to the CA certificate file for client certificate authentication to\nthe server.\n\nIt is mutually exclusive with `client_ca`.", + "description": "clientCAFile defines the path to the CA certificate file for client certificate authentication to\nthe server.\n\nIt is mutually exclusive with `client_ca`.", "type": "string" }, "client_ca": { - "description": "Secret or ConfigMap containing the CA certificate for client certificate\nauthentication to the server.\n\nIt is mutually exclusive with `clientCAFile`.", + "description": "client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate\nauthentication to the server.\n\nIt is mutually exclusive with `clientCAFile`.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9018,7 +9019,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9044,18 +9045,18 @@ "type": "object" }, "curvePreferences": { - "description": "Elliptic curves that will be used in an ECDHE handshake, in preference\norder.\n\nAvailable curves are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID", + "description": "curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference\norder.\n\nAvailable curves are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID", "items": { "type": "string" }, "type": "array" }, "keyFile": { - "description": "Path to the TLS private key file in the container for the web server.\n\nIf defined, either `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keySecret`.", + "description": "keyFile defines the path to the TLS private key file in the container for the web server.\n\nIf defined, either `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keySecret`.", "type": "string" }, "keySecret": { - "description": "Secret containing the TLS private key for the web server.\n\nEither `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keyFile`.", + "description": "keySecret defines the secret containing the TLS private key for the web server.\n\nEither `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keyFile`.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9078,15 +9079,15 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum TLS version that is acceptable.", + "description": "maxVersion defines the Maximum TLS version that is acceptable.", "type": "string" }, "minVersion": { - "description": "Minimum TLS version that is acceptable.", + "description": "minVersion defines the minimum TLS version that is acceptable.", "type": "string" }, "preferServerCipherSuites": { - "description": "Controls whether the server selects the client's most preferred cipher\nsuite, or the server's most preferred cipher suite.\n\nIf true then the server's preference, as expressed in\nthe order of elements in cipherSuites, is used.", + "description": "preferServerCipherSuites defines whether the server selects the client's most preferred cipher\nsuite, or the server's most preferred cipher suite.\n\nIf true then the server's preference, as expressed in\nthe order of elements in cipherSuites, is used.", "type": "boolean" } }, @@ -9125,15 +9126,15 @@ ] }, "status": { - "description": "Most recent observed status of the Prometheus cluster. Read-only.\nMore info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", + "description": "status defines the most recent observed status of the Prometheus cluster. Read-only.\nMore info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "availableReplicas": { - "description": "Total number of available pods (ready for at least minReadySeconds)\ntargeted by this Prometheus deployment.", + "description": "availableReplicas defines the total number of available pods (ready for at least minReadySeconds)\ntargeted by this Prometheus deployment.", "format": "int32", "type": "integer" }, "conditions": { - "description": "The current state of the Prometheus deployment.", + "description": "conditions defines the current state of the Prometheus deployment.", "items": { "description": "Condition represents the state of the resources associated with the\nPrometheus, Alertmanager or ThanosRuler resource.", "properties": { @@ -9143,25 +9144,25 @@ "type": "string" }, "message": { - "description": "Human-readable message indicating details for the condition's last transition.", + "description": "message defines human-readable message indicating details for the condition's last transition.", "type": "string" }, "observedGeneration": { - "description": "ObservedGeneration represents the .metadata.generation that the\ncondition was set based upon. For instance, if `.metadata.generation` is\ncurrently 12, but the `.status.conditions[].observedGeneration` is 9, the\ncondition is out of date with respect to the current state of the\ninstance.", + "description": "observedGeneration defines the .metadata.generation that the\ncondition was set based upon. For instance, if `.metadata.generation` is\ncurrently 12, but the `.status.conditions[].observedGeneration` is 9, the\ncondition is out of date with respect to the current state of the\ninstance.", "format": "int64", "type": "integer" }, "reason": { - "description": "Reason for the condition's last transition.", + "description": "reason for the condition's last transition.", "type": "string" }, "status": { - "description": "Status of the condition.", + "description": "status of the condition.", "minLength": 1, "type": "string" }, "type": { - "description": "Type of the condition being reported.", + "description": "type of the condition being reported.", "minLength": 1, "type": "string" } @@ -9180,43 +9181,43 @@ "x-kubernetes-list-type": "map" }, "paused": { - "description": "Represents whether any actions on the underlying managed objects are\nbeing performed. Only delete actions will be performed.", + "description": "paused defines whether any actions on the underlying managed objects are\nbeing performed. Only delete actions will be performed.", "type": "boolean" }, "replicas": { - "description": "Total number of non-terminated pods targeted by this Prometheus deployment\n(their labels match the selector).", + "description": "replicas defines the total number of non-terminated pods targeted by this Prometheus deployment\n(their labels match the selector).", "format": "int32", "type": "integer" }, "selector": { - "description": "The selector used to match the pods targeted by this Prometheus resource.", + "description": "selector used to match the pods targeted by this Prometheus resource.", "type": "string" }, "shardStatuses": { - "description": "The list has one entry per shard. Each entry provides a summary of the shard status.", + "description": "shardStatuses defines the list has one entry per shard. Each entry provides a summary of the shard status.", "items": { "properties": { "availableReplicas": { - "description": "Total number of available pods (ready for at least minReadySeconds)\ntargeted by this shard.", + "description": "availableReplicas defines the total number of available pods (ready for at least minReadySeconds)\ntargeted by this shard.", "format": "int32", "type": "integer" }, "replicas": { - "description": "Total number of pods targeted by this shard.", + "description": "replicas defines the total number of pods targeted by this shard.", "format": "int32", "type": "integer" }, "shardID": { - "description": "Identifier of the shard.", + "description": "shardID defines the identifier of the shard.", "type": "string" }, "unavailableReplicas": { - "description": "Total number of unavailable pods targeted by this shard.", + "description": "unavailableReplicas defines the Total number of unavailable pods targeted by this shard.", "format": "int32", "type": "integer" }, "updatedReplicas": { - "description": "Total number of non-terminated pods targeted by this shard\nthat have the desired spec.", + "description": "updatedReplicas defines the total number of non-terminated pods targeted by this shard\nthat have the desired spec.", "format": "int32", "type": "integer" } @@ -9237,28 +9238,21 @@ "x-kubernetes-list-type": "map" }, "shards": { - "description": "Shards is the most recently observed number of shards.", + "description": "shards defines the most recently observed number of shards.", "format": "int32", "type": "integer" }, "unavailableReplicas": { - "description": "Total number of unavailable pods targeted by this Prometheus deployment.", + "description": "unavailableReplicas defines the total number of unavailable pods targeted by this Prometheus deployment.", "format": "int32", "type": "integer" }, "updatedReplicas": { - "description": "Total number of non-terminated pods targeted by this Prometheus deployment\nthat have the desired version spec.", + "description": "updatedReplicas defines the total number of non-terminated pods targeted by this Prometheus deployment\nthat have the desired version spec.", "format": "int32", "type": "integer" } }, - "required": [ - "availableReplicas", - "paused", - "replicas", - "unavailableReplicas", - "updatedReplicas" - ], "type": "object" } }, diff --git a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/prometheuses-crd.json b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/prometheuses-crd.json index 8e9d7321..e015e995 100644 --- a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/prometheuses-crd.json +++ b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/prometheuses-crd.json @@ -3,7 +3,7 @@ "kind": "CustomResourceDefinition", "metadata": { "annotations": { - "controller-gen.kubebuilder.io/version": "v0.18.0", + "controller-gen.kubebuilder.io/version": "v0.19.0", "operator.prometheus.io/version": "0.85.0" }, "name": "prometheuses.monitoring.coreos.com" @@ -84,10 +84,10 @@ "type": "object" }, "spec": { - "description": "Specification of the desired behavior of the Prometheus cluster. More info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", + "description": "spec defines the specification of the desired behavior of the Prometheus cluster. More info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "additionalAlertManagerConfigs": { - "description": "AdditionalAlertManagerConfigs specifies a key of a Secret containing\nadditional Prometheus Alertmanager configurations. The Alertmanager\nconfigurations are appended to the configuration generated by the\nPrometheus Operator. They must be formatted according to the official\nPrometheus documentation:\n\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config\n\nThe user is responsible for making sure that the configurations are valid\n\nNote that using this feature may expose the possibility to break\nupgrades of Prometheus. It is advised to review Prometheus release notes\nto ensure that no incompatible AlertManager configs are going to break\nPrometheus after the upgrade.", + "description": "additionalAlertManagerConfigs defines a key of a Secret containing\nadditional Prometheus Alertmanager configurations. The Alertmanager\nconfigurations are appended to the configuration generated by the\nPrometheus Operator. They must be formatted according to the official\nPrometheus documentation:\n\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config\n\nThe user is responsible for making sure that the configurations are valid\n\nNote that using this feature may expose the possibility to break\nupgrades of Prometheus. It is advised to review Prometheus release notes\nto ensure that no incompatible AlertManager configs are going to break\nPrometheus after the upgrade.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -110,7 +110,7 @@ "x-kubernetes-map-type": "atomic" }, "additionalAlertRelabelConfigs": { - "description": "AdditionalAlertRelabelConfigs specifies a key of a Secret containing\nadditional Prometheus alert relabel configurations. The alert relabel\nconfigurations are appended to the configuration generated by the\nPrometheus Operator. They must be formatted according to the official\nPrometheus documentation:\n\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs\n\nThe user is responsible for making sure that the configurations are valid\n\nNote that using this feature may expose the possibility to break\nupgrades of Prometheus. It is advised to review Prometheus release notes\nto ensure that no incompatible alert relabel configs are going to break\nPrometheus after the upgrade.", + "description": "additionalAlertRelabelConfigs defines a key of a Secret containing\nadditional Prometheus alert relabel configurations. The alert relabel\nconfigurations are appended to the configuration generated by the\nPrometheus Operator. They must be formatted according to the official\nPrometheus documentation:\n\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs\n\nThe user is responsible for making sure that the configurations are valid\n\nNote that using this feature may expose the possibility to break\nupgrades of Prometheus. It is advised to review Prometheus release notes\nto ensure that no incompatible alert relabel configs are going to break\nPrometheus after the upgrade.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -133,17 +133,17 @@ "x-kubernetes-map-type": "atomic" }, "additionalArgs": { - "description": "AdditionalArgs allows setting additional arguments for the 'prometheus' container.\n\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nPrometheus container which may cause issues if they are invalid or not supported\nby the given Prometheus version.\n\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged.", + "description": "additionalArgs allows setting additional arguments for the 'prometheus' container.\n\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nPrometheus container which may cause issues if they are invalid or not supported\nby the given Prometheus version.\n\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged.", "items": { "description": "Argument as part of the AdditionalArgs list.", "properties": { "name": { - "description": "Name of the argument, e.g. \"scrape.discovery-reload-interval\".", + "description": "name of the argument, e.g. \"scrape.discovery-reload-interval\".", "minLength": 1, "type": "string" }, "value": { - "description": "Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)", + "description": "value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)", "type": "string" } }, @@ -155,7 +155,7 @@ "type": "array" }, "additionalScrapeConfigs": { - "description": "AdditionalScrapeConfigs allows specifying a key of a Secret containing\nadditional Prometheus scrape configurations. Scrape configurations\nspecified are appended to the configurations generated by the Prometheus\nOperator. Job configurations specified must have the form as specified\nin the official Prometheus documentation:\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config.\nAs scrape configs are appended, the user is responsible to make sure it\nis valid. Note that using this feature may expose the possibility to\nbreak upgrades of Prometheus. It is advised to review Prometheus release\nnotes to ensure that no incompatible scrape configs are going to break\nPrometheus after the upgrade.", + "description": "additionalScrapeConfigs allows specifying a key of a Secret containing\nadditional Prometheus scrape configurations. Scrape configurations\nspecified are appended to the configurations generated by the Prometheus\nOperator. Job configurations specified must have the form as specified\nin the official Prometheus documentation:\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config.\nAs scrape configs are appended, the user is responsible to make sure it\nis valid. Note that using this feature may expose the possibility to\nbreak upgrades of Prometheus. It is advised to review Prometheus release\nnotes to ensure that no incompatible scrape configs are going to break\nPrometheus after the upgrade.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -178,7 +178,7 @@ "x-kubernetes-map-type": "atomic" }, "affinity": { - "description": "Defines the Pods' affinity scheduling rules if specified.", + "description": "affinity defines the Pods' affinity scheduling rules if specified.", "properties": { "nodeAffinity": { "description": "Describes node affinity scheduling rules for the pod.", @@ -933,21 +933,21 @@ "type": "object" }, "alerting": { - "description": "Defines the settings related to Alertmanager.", + "description": "alerting defines the settings related to Alertmanager.", "properties": { "alertmanagers": { - "description": "Alertmanager endpoints where Prometheus should send alerts to.", + "description": "alertmanagers endpoints where Prometheus should send alerts to.", "items": { "description": "AlertmanagerEndpoints defines a selection of a single Endpoints object\ncontaining Alertmanager IPs to fire alerts against.", "properties": { "alertRelabelings": { - "description": "Relabeling configs applied before sending alerts to a specific Alertmanager.\nIt requires Prometheus >= v2.51.0.", + "description": "alertRelabelings defines the relabeling configs applied before sending alerts to a specific Alertmanager.\nIt requires Prometheus >= v2.51.0.", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -975,24 +975,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -1001,7 +1001,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -1010,7 +1010,7 @@ "type": "array" }, "apiVersion": { - "description": "Version of the Alertmanager API that Prometheus uses to send alerts.\nIt can be \"V1\" or \"V2\".\nThe field has no effect for Prometheus >= v3.0.0 because only the v2 API is supported.", + "description": "apiVersion defines the version of the Alertmanager API that Prometheus uses to send alerts.\nIt can be \"V1\" or \"V2\".\nThe field has no effect for Prometheus >= v3.0.0 because only the v2 API is supported.", "enum": [ "v1", "V1", @@ -1020,10 +1020,10 @@ "type": "string" }, "authorization": { - "description": "Authorization section for Alertmanager.\n\nCannot be set at the same time as `basicAuth`, `bearerTokenFile` or `sigv4`.", + "description": "authorization section for Alertmanager.\n\nCannot be set at the same time as `basicAuth`, `bearerTokenFile` or `sigv4`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1046,17 +1046,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth configuration for Alertmanager.\n\nCannot be set at the same time as `bearerTokenFile`, `authorization` or `sigv4`.", + "description": "basicAuth configuration for Alertmanager.\n\nCannot be set at the same time as `bearerTokenFile`, `authorization` or `sigv4`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1079,7 +1079,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1105,29 +1105,29 @@ "type": "object" }, "bearerTokenFile": { - "description": "File to read bearer token for Alertmanager.\n\nCannot be set at the same time as `basicAuth`, `authorization`, or `sigv4`.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", + "description": "bearerTokenFile defines the file to read bearer token for Alertmanager.\n\nCannot be set at the same time as `basicAuth`, `authorization`, or `sigv4`.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", "type": "string" }, "enableHttp2": { - "description": "Whether to enable HTTP2.", + "description": "enableHttp2 defines whether to enable HTTP2.", "type": "boolean" }, "name": { - "description": "Name of the Endpoints object in the namespace.", + "description": "name of the Endpoints object in the namespace.", "minLength": 1, "type": "string" }, "namespace": { - "description": "Namespace of the Endpoints object.\n\nIf not set, the object will be discovered in the namespace of the\nPrometheus object.", + "description": "namespace of the Endpoints object.\n\nIf not set, the object will be discovered in the namespace of the\nPrometheus object.", "minLength": 1, "type": "string" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "pathPrefix": { - "description": "Prefix for the HTTP path alerts are pushed to.", + "description": "pathPrefix defines the prefix for the HTTP path alerts are pushed to.", "type": "string" }, "port": { @@ -1139,7 +1139,7 @@ "type": "string" } ], - "description": "Port on which the Alertmanager API is exposed.", + "description": "port on which the Alertmanager API is exposed.", "x-kubernetes-int-or-string": true }, "proxyConnectHeader": { @@ -1169,27 +1169,27 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "relabelings": { - "description": "Relabel configuration applied to the discovered Alertmanagers.", + "description": "relabelings defines the relabel configuration applied to the discovered Alertmanagers.", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -1217,24 +1217,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -1243,7 +1243,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -1252,14 +1252,14 @@ "type": "array" }, "scheme": { - "description": "Scheme to use when firing alerts.", + "description": "scheme to use when firing alerts.", "type": "string" }, "sigv4": { - "description": "Sigv4 allows to configures AWS's Signature Verification 4 for the URL.\n\nIt requires Prometheus >= v2.48.0.\n\nCannot be set at the same time as `basicAuth`, `bearerTokenFile` or `authorization`.", + "description": "sigv4 defines AWS's Signature Verification 4 for the URL.\n\nIt requires Prometheus >= v2.48.0.\n\nCannot be set at the same time as `basicAuth`, `bearerTokenFile` or `authorization`.", "properties": { "accessKey": { - "description": "AccessKey is the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.", + "description": "accessKey defines the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1282,19 +1282,19 @@ "x-kubernetes-map-type": "atomic" }, "profile": { - "description": "Profile is the named AWS profile used to authenticate.", + "description": "profile defines the named AWS profile used to authenticate.", "type": "string" }, "region": { - "description": "Region is the AWS region. If blank, the region from the default credentials chain used.", + "description": "region defines the AWS region. If blank, the region from the default credentials chain used.", "type": "string" }, "roleArn": { - "description": "RoleArn is the named AWS profile used to authenticate.", + "description": "roleArn defines the named AWS profile used to authenticate.", "type": "string" }, "secretKey": { - "description": "SecretKey is the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.", + "description": "secretKey defines the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1320,18 +1320,18 @@ "type": "object" }, "timeout": { - "description": "Timeout is a per-target Alertmanager timeout when pushing alerts.", + "description": "timeout defines a per-target Alertmanager timeout when pushing alerts.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "tlsConfig": { - "description": "TLS Config to use for Alertmanager.", + "description": "tlsConfig to use for Alertmanager.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1354,7 +1354,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1380,14 +1380,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1410,7 +1410,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1436,19 +1436,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1471,7 +1471,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -1481,7 +1481,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -1491,7 +1491,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -1513,17 +1513,17 @@ "type": "object" }, "allowOverlappingBlocks": { - "description": "AllowOverlappingBlocks enables vertical compaction and vertical query\nmerge in Prometheus.\n\nDeprecated: this flag has no effect for Prometheus >= 2.39.0 where overlapping blocks are enabled by default.", + "description": "allowOverlappingBlocks enables vertical compaction and vertical query\nmerge in Prometheus.\n\nDeprecated: this flag has no effect for Prometheus >= 2.39.0 where overlapping blocks are enabled by default.", "type": "boolean" }, "apiserverConfig": { - "description": "APIServerConfig allows specifying a host and auth methods to access the\nKuberntees API server.\nIf null, Prometheus is assumed to run inside of the cluster: it will\ndiscover the API servers automatically and use the Pod's CA certificate\nand bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.", + "description": "apiserverConfig allows specifying a host and auth methods to access the\nKuberntees API server.\nIf null, Prometheus is assumed to run inside of the cluster: it will\ndiscover the API servers automatically and use the Pod's CA certificate\nand bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.", "properties": { "authorization": { - "description": "Authorization section for the API server.\n\nCannot be set at the same time as `basicAuth`, `bearerToken`, or\n`bearerTokenFile`.", + "description": "authorization section for the API server.\n\nCannot be set at the same time as `basicAuth`, `bearerToken`, or\n`bearerTokenFile`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1546,21 +1546,21 @@ "x-kubernetes-map-type": "atomic" }, "credentialsFile": { - "description": "File to read a secret from, mutually exclusive with `credentials`.", + "description": "credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`.", "type": "string" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth configuration for the API server.\n\nCannot be set at the same time as `authorization`, `bearerToken`, or\n`bearerTokenFile`.", + "description": "basicAuth configuration for the API server.\n\nCannot be set at the same time as `authorization`, `bearerToken`, or\n`bearerTokenFile`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1583,7 +1583,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1609,19 +1609,19 @@ "type": "object" }, "bearerToken": { - "description": "*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\nDeprecated: this will be removed in a future release.", + "description": "bearerToken is deprecated: this will be removed in a future release.\n *Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*", "type": "string" }, "bearerTokenFile": { - "description": "File to read bearer token for accessing apiserver.\n\nCannot be set at the same time as `basicAuth`, `authorization`, or `bearerToken`.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", + "description": "bearerTokenFile defines the file to read bearer token for accessing apiserver.\n\nCannot be set at the same time as `basicAuth`, `authorization`, or `bearerToken`.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", "type": "string" }, "host": { - "description": "Kubernetes API address consisting of a hostname or IP address followed\nby an optional port number.", + "description": "host defines the Kubernetes API address consisting of a hostname or IP address followed\nby an optional port number.", "type": "string" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -1651,27 +1651,27 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS Config to use for the API server.", + "description": "tlsConfig to use for the API server.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1694,7 +1694,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1720,14 +1720,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1750,7 +1750,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1776,19 +1776,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1811,7 +1811,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -1821,7 +1821,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -1831,7 +1831,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -1844,36 +1844,37 @@ "type": "object" }, "arbitraryFSAccessThroughSMs": { - "description": "When true, ServiceMonitor, PodMonitor and Probe object are forbidden to\nreference arbitrary files on the file system of the 'prometheus'\ncontainer.\nWhen a ServiceMonitor's endpoint specifies a `bearerTokenFile` value\n(e.g. '/var/run/secrets/kubernetes.io/serviceaccount/token'), a\nmalicious target can get access to the Prometheus service account's\ntoken in the Prometheus' scrape request. Setting\n`spec.arbitraryFSAccessThroughSM` to 'true' would prevent the attack.\nUsers should instead provide the credentials using the\n`spec.bearerTokenSecret` field.", + "description": "arbitraryFSAccessThroughSMs when true, ServiceMonitor, PodMonitor and Probe object are forbidden to\nreference arbitrary files on the file system of the 'prometheus'\ncontainer.\nWhen a ServiceMonitor's endpoint specifies a `bearerTokenFile` value\n(e.g. '/var/run/secrets/kubernetes.io/serviceaccount/token'), a\nmalicious target can get access to the Prometheus service account's\ntoken in the Prometheus' scrape request. Setting\n`spec.arbitraryFSAccessThroughSM` to 'true' would prevent the attack.\nUsers should instead provide the credentials using the\n`spec.bearerTokenSecret` field.", "properties": { "deny": { + "description": "deny prevents service monitors from accessing arbitrary files on the file system.\nWhen true, service monitors cannot use file-based configurations like BearerTokenFile\nthat could potentially access sensitive files. When false (default), such access is allowed.\nSetting this to true enhances security by preventing potential credential theft attacks.", "type": "boolean" } }, "type": "object" }, "automountServiceAccountToken": { - "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod.\nIf the field isn't set, the operator mounts the service account token by default.\n\n**Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery.\nIt is possible to use strategic merge patch to project the service account token into the 'prometheus' container.", + "description": "automountServiceAccountToken defines whether a service account token should be automatically mounted in the pod.\nIf the field isn't set, the operator mounts the service account token by default.\n\n**Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery.\nIt is possible to use strategic merge patch to project the service account token into the 'prometheus' container.", "type": "boolean" }, "baseImage": { - "description": "Deprecated: use 'spec.image' instead.", + "description": "baseImage is deprecated: use 'spec.image' instead.", "type": "string" }, "bodySizeLimit": { - "description": "BodySizeLimit defines per-scrape on response body size.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit.", + "description": "bodySizeLimit defines per-scrape on response body size.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit.", "pattern": "(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$", "type": "string" }, "configMaps": { - "description": "ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-`.\nThe ConfigMaps are mounted into /etc/prometheus/configmaps/ in the 'prometheus' container.", + "description": "configMaps defines a list of ConfigMaps in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-`.\nThe ConfigMaps are mounted into /etc/prometheus/configmaps/ in the 'prometheus' container.", "items": { "type": "string" }, "type": "array" }, "containers": { - "description": "Containers allows injecting additional containers or modifying operator\ngenerated containers. This can be used to allow adding an authentication\nproxy to the Pods or to change the behavior of an operator generated\ncontainer. Containers described here modify an operator generated\ncontainer if they share the same name and modifications are done via a\nstrategic merge patch.\n\nThe names of containers managed by the operator are:\n* `prometheus`\n* `config-reloader`\n* `thanos-sidecar`\n\nOverriding containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice.", + "description": "containers allows injecting additional containers or modifying operator\ngenerated containers. This can be used to allow adding an authentication\nproxy to the Pods or to change the behavior of an operator generated\ncontainer. Containers described here modify an operator generated\ncontainer if they share the same name and modifications are done via a\nstrategic merge patch.\n\nThe names of containers managed by the operator are:\n* `prometheus`\n* `config-reloader`\n* `thanos-sidecar`\n\nOverriding containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice.", "items": { "description": "A single application container that you want to run within a pod.", "properties": { @@ -3211,18 +3212,18 @@ "type": "array" }, "convertClassicHistogramsToNHCB": { - "description": "Whether to convert all scraped classic histograms into a native\nhistogram with custom buckets.\n\nIt requires Prometheus >= v3.4.0.", + "description": "convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native\nhistogram with custom buckets.\n\nIt requires Prometheus >= v3.4.0.", "type": "boolean" }, "disableCompaction": { - "description": "When true, the Prometheus compaction is disabled.\nWhen `spec.thanos.objectStorageConfig` or `spec.objectStorageConfigFile` are defined, the operator automatically\ndisables block compaction to avoid race conditions during block uploads (as the Thanos documentation recommends).", + "description": "disableCompaction when true, the Prometheus compaction is disabled.\nWhen `spec.thanos.objectStorageConfig` or `spec.objectStorageConfigFile` are defined, the operator automatically\ndisables block compaction to avoid race conditions during block uploads (as the Thanos documentation recommends).", "type": "boolean" }, "dnsConfig": { - "description": "Defines the DNS configuration for the pods.", + "description": "dnsConfig defines the DNS configuration for the pods.", "properties": { "nameservers": { - "description": "A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.", + "description": "nameservers defines the list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.", "items": { "minLength": 1, "type": "string" @@ -3231,17 +3232,17 @@ "x-kubernetes-list-type": "set" }, "options": { - "description": "A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nResolution options given in Options\nwill override those that appear in the base DNSPolicy.", + "description": "options defines the list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nResolution options given in Options\nwill override those that appear in the base DNSPolicy.", "items": { "description": "PodDNSConfigOption defines DNS resolver options of a pod.", "properties": { "name": { - "description": "Name is required and must be unique.", + "description": "name is required and must be unique.", "minLength": 1, "type": "string" }, "value": { - "description": "Value is optional.", + "description": "value is optional.", "type": "string" } }, @@ -3257,7 +3258,7 @@ "x-kubernetes-list-type": "map" }, "searches": { - "description": "A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.", + "description": "searches defines the list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.", "items": { "minLength": 1, "type": "string" @@ -3269,7 +3270,7 @@ "type": "object" }, "dnsPolicy": { - "description": "Defines the DNS policy for the pods.", + "description": "dnsPolicy defines the DNS policy for the pods.", "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", @@ -3279,11 +3280,11 @@ "type": "string" }, "enableAdminAPI": { - "description": "Enables access to the Prometheus web admin API.\n\nWARNING: Enabling the admin APIs enables mutating endpoints, to delete data,\nshutdown Prometheus, and more. Enabling this should be done with care and the\nuser is advised to add additional authentication authorization via a proxy to\nensure only clients authorized to perform these actions can do so.\n\nFor more information:\nhttps://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis", + "description": "enableAdminAPI defines access to the Prometheus web admin API.\n\nWARNING: Enabling the admin APIs enables mutating endpoints, to delete data,\nshutdown Prometheus, and more. Enabling this should be done with care and the\nuser is advised to add additional authentication authorization via a proxy to\nensure only clients authorized to perform these actions can do so.\n\nFor more information:\nhttps://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis", "type": "boolean" }, "enableFeatures": { - "description": "Enable access to Prometheus feature flags. By default, no features are enabled.\n\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\nFor more information see https://prometheus.io/docs/prometheus/latest/feature_flags/", + "description": "enableFeatures enables access to Prometheus feature flags. By default, no features are enabled.\n\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\nFor more information see https://prometheus.io/docs/prometheus/latest/feature_flags/", "items": { "minLength": 1, "type": "string" @@ -3292,86 +3293,86 @@ "x-kubernetes-list-type": "set" }, "enableOTLPReceiver": { - "description": "Enable Prometheus to be used as a receiver for the OTLP Metrics protocol.\n\nNote that the OTLP receiver endpoint is automatically enabled if `.spec.otlpConfig` is defined.\n\nIt requires Prometheus >= v2.47.0.", + "description": "enableOTLPReceiver defines the Prometheus to be used as a receiver for the OTLP Metrics protocol.\n\nNote that the OTLP receiver endpoint is automatically enabled if `.spec.otlpConfig` is defined.\n\nIt requires Prometheus >= v2.47.0.", "type": "boolean" }, "enableRemoteWriteReceiver": { - "description": "Enable Prometheus to be used as a receiver for the Prometheus remote\nwrite protocol.\n\nWARNING: This is not considered an efficient way of ingesting samples.\nUse it with caution for specific low-volume use cases.\nIt is not suitable for replacing the ingestion via scraping and turning\nPrometheus into a push-based metrics collection system.\nFor more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver\n\nIt requires Prometheus >= v2.33.0.", + "description": "enableRemoteWriteReceiver defines the Prometheus to be used as a receiver for the Prometheus remote\nwrite protocol.\n\nWARNING: This is not considered an efficient way of ingesting samples.\nUse it with caution for specific low-volume use cases.\nIt is not suitable for replacing the ingestion via scraping and turning\nPrometheus into a push-based metrics collection system.\nFor more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver\n\nIt requires Prometheus >= v2.33.0.", "type": "boolean" }, "enableServiceLinks": { - "description": "Indicates whether information about services should be injected into pod's environment variables", + "description": "enableServiceLinks defines whether information about services should be injected into pod's environment variables", "type": "boolean" }, "enforcedBodySizeLimit": { - "description": "When defined, enforcedBodySizeLimit specifies a global limit on the size\nof uncompressed response body that will be accepted by Prometheus.\nTargets responding with a body larger than this many bytes will cause\nthe scrape to fail.\n\nIt requires Prometheus >= v2.28.0.\n\nWhen both `enforcedBodySizeLimit` and `bodySizeLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined bodySizeLimit value will inherit the global bodySizeLimit value (Prometheus >= 2.45.0) or the enforcedBodySizeLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedBodySizeLimit` is greater than the `bodySizeLimit`, the `bodySizeLimit` will be set to `enforcedBodySizeLimit`.\n* Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value.\n* Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit.", + "description": "enforcedBodySizeLimit when defined specifies a global limit on the size\nof uncompressed response body that will be accepted by Prometheus.\nTargets responding with a body larger than this many bytes will cause\nthe scrape to fail.\n\nIt requires Prometheus >= v2.28.0.\n\nWhen both `enforcedBodySizeLimit` and `bodySizeLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined bodySizeLimit value will inherit the global bodySizeLimit value (Prometheus >= 2.45.0) or the enforcedBodySizeLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedBodySizeLimit` is greater than the `bodySizeLimit`, the `bodySizeLimit` will be set to `enforcedBodySizeLimit`.\n* Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value.\n* Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit.", "pattern": "(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$", "type": "string" }, "enforcedKeepDroppedTargets": { - "description": "When defined, enforcedKeepDroppedTargets specifies a global limit on the number of targets\ndropped by relabeling that will be kept in memory. The value overrides\nany `spec.keepDroppedTargets` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is\ngreater than zero and less than `spec.enforcedKeepDroppedTargets`.\n\nIt requires Prometheus >= v2.47.0.\n\nWhen both `enforcedKeepDroppedTargets` and `keepDroppedTargets` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined keepDroppedTargets value will inherit the global keepDroppedTargets value (Prometheus >= 2.45.0) or the enforcedKeepDroppedTargets value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedKeepDroppedTargets` is greater than the `keepDroppedTargets`, the `keepDroppedTargets` will be set to `enforcedKeepDroppedTargets`.\n* Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value.\n* Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets.", + "description": "enforcedKeepDroppedTargets when defined specifies a global limit on the number of targets\ndropped by relabeling that will be kept in memory. The value overrides\nany `spec.keepDroppedTargets` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is\ngreater than zero and less than `spec.enforcedKeepDroppedTargets`.\n\nIt requires Prometheus >= v2.47.0.\n\nWhen both `enforcedKeepDroppedTargets` and `keepDroppedTargets` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined keepDroppedTargets value will inherit the global keepDroppedTargets value (Prometheus >= 2.45.0) or the enforcedKeepDroppedTargets value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedKeepDroppedTargets` is greater than the `keepDroppedTargets`, the `keepDroppedTargets` will be set to `enforcedKeepDroppedTargets`.\n* Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value.\n* Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets.", "format": "int64", "type": "integer" }, "enforcedLabelLimit": { - "description": "When defined, enforcedLabelLimit specifies a global limit on the number\nof labels per sample. The value overrides any `spec.labelLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is\ngreater than zero and less than `spec.enforcedLabelLimit`.\n\nIt requires Prometheus >= v2.27.0.\n\nWhen both `enforcedLabelLimit` and `labelLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelLimit value will inherit the global labelLimit value (Prometheus >= 2.45.0) or the enforcedLabelLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelLimit` is greater than the `labelLimit`, the `labelLimit` will be set to `enforcedLabelLimit`.\n* Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value.\n* Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit.", + "description": "enforcedLabelLimit when defined specifies a global limit on the number\nof labels per sample. The value overrides any `spec.labelLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is\ngreater than zero and less than `spec.enforcedLabelLimit`.\n\nIt requires Prometheus >= v2.27.0.\n\nWhen both `enforcedLabelLimit` and `labelLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelLimit value will inherit the global labelLimit value (Prometheus >= 2.45.0) or the enforcedLabelLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelLimit` is greater than the `labelLimit`, the `labelLimit` will be set to `enforcedLabelLimit`.\n* Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value.\n* Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit.", "format": "int64", "type": "integer" }, "enforcedLabelNameLengthLimit": { - "description": "When defined, enforcedLabelNameLengthLimit specifies a global limit on the length\nof labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelNameLengthLimit`.\n\nIt requires Prometheus >= v2.27.0.\n\nWhen both `enforcedLabelNameLengthLimit` and `labelNameLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelNameLengthLimit value will inherit the global labelNameLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelNameLengthLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelNameLengthLimit` is greater than the `labelNameLengthLimit`, the `labelNameLengthLimit` will be set to `enforcedLabelNameLengthLimit`.\n* Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value.\n* Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit.", + "description": "enforcedLabelNameLengthLimit when defined specifies a global limit on the length\nof labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelNameLengthLimit`.\n\nIt requires Prometheus >= v2.27.0.\n\nWhen both `enforcedLabelNameLengthLimit` and `labelNameLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelNameLengthLimit value will inherit the global labelNameLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelNameLengthLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelNameLengthLimit` is greater than the `labelNameLengthLimit`, the `labelNameLengthLimit` will be set to `enforcedLabelNameLengthLimit`.\n* Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value.\n* Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit.", "format": "int64", "type": "integer" }, "enforcedLabelValueLengthLimit": { - "description": "When not null, enforcedLabelValueLengthLimit defines a global limit on the length\nof labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelValueLengthLimit`.\n\nIt requires Prometheus >= v2.27.0.\n\nWhen both `enforcedLabelValueLengthLimit` and `labelValueLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelValueLengthLimit value will inherit the global labelValueLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelValueLengthLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelValueLengthLimit` is greater than the `labelValueLengthLimit`, the `labelValueLengthLimit` will be set to `enforcedLabelValueLengthLimit`.\n* Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value.\n* Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit.", + "description": "enforcedLabelValueLengthLimit when not null defines a global limit on the length\nof labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelValueLengthLimit`.\n\nIt requires Prometheus >= v2.27.0.\n\nWhen both `enforcedLabelValueLengthLimit` and `labelValueLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelValueLengthLimit value will inherit the global labelValueLengthLimit value (Prometheus >= 2.45.0) or the enforcedLabelValueLengthLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedLabelValueLengthLimit` is greater than the `labelValueLengthLimit`, the `labelValueLengthLimit` will be set to `enforcedLabelValueLengthLimit`.\n* Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value.\n* Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit.", "format": "int64", "type": "integer" }, "enforcedNamespaceLabel": { - "description": "When not empty, a label will be added to:\n\n1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects.\n2. All metrics generated from recording rules defined in `PrometheusRule` objects.\n3. All alerts generated from alerting rules defined in `PrometheusRule` objects.\n4. All vector selectors of PromQL expressions defined in `PrometheusRule` objects.\n\nThe label will not added for objects referenced in `spec.excludedFromEnforcement`.\n\nThe label's name is this field's value.\nThe label's value is the namespace of the `ServiceMonitor`,\n`PodMonitor`, `Probe`, `PrometheusRule` or `ScrapeConfig` object.", + "description": "enforcedNamespaceLabel when not empty, a label will be added to:\n\n1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects.\n2. All metrics generated from recording rules defined in `PrometheusRule` objects.\n3. All alerts generated from alerting rules defined in `PrometheusRule` objects.\n4. All vector selectors of PromQL expressions defined in `PrometheusRule` objects.\n\nThe label will not added for objects referenced in `spec.excludedFromEnforcement`.\n\nThe label's name is this field's value.\nThe label's value is the namespace of the `ServiceMonitor`,\n`PodMonitor`, `Probe`, `PrometheusRule` or `ScrapeConfig` object.", "type": "string" }, "enforcedSampleLimit": { - "description": "When defined, enforcedSampleLimit specifies a global limit on the number\nof scraped samples that will be accepted. This overrides any\n`spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects\nunless `spec.sampleLimit` is greater than zero and less than\n`spec.enforcedSampleLimit`.\n\nIt is meant to be used by admins to keep the overall number of\nsamples/series under a desired limit.\n\nWhen both `enforcedSampleLimit` and `sampleLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined sampleLimit value will inherit the global sampleLimit value (Prometheus >= 2.45.0) or the enforcedSampleLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedSampleLimit` is greater than the `sampleLimit`, the `sampleLimit` will be set to `enforcedSampleLimit`.\n* Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value.\n* Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit.", + "description": "enforcedSampleLimit when defined specifies a global limit on the number\nof scraped samples that will be accepted. This overrides any\n`spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects\nunless `spec.sampleLimit` is greater than zero and less than\n`spec.enforcedSampleLimit`.\n\nIt is meant to be used by admins to keep the overall number of\nsamples/series under a desired limit.\n\nWhen both `enforcedSampleLimit` and `sampleLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined sampleLimit value will inherit the global sampleLimit value (Prometheus >= 2.45.0) or the enforcedSampleLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedSampleLimit` is greater than the `sampleLimit`, the `sampleLimit` will be set to `enforcedSampleLimit`.\n* Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value.\n* Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit.", "format": "int64", "type": "integer" }, "enforcedTargetLimit": { - "description": "When defined, enforcedTargetLimit specifies a global limit on the number\nof scraped targets. The value overrides any `spec.targetLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is\ngreater than zero and less than `spec.enforcedTargetLimit`.\n\nIt is meant to be used by admins to to keep the overall number of\ntargets under a desired limit.\n\nWhen both `enforcedTargetLimit` and `targetLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined targetLimit value will inherit the global targetLimit value (Prometheus >= 2.45.0) or the enforcedTargetLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedTargetLimit` is greater than the `targetLimit`, the `targetLimit` will be set to `enforcedTargetLimit`.\n* Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value.\n* Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit.", + "description": "enforcedTargetLimit when defined specifies a global limit on the number\nof scraped targets. The value overrides any `spec.targetLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is\ngreater than zero and less than `spec.enforcedTargetLimit`.\n\nIt is meant to be used by admins to to keep the overall number of\ntargets under a desired limit.\n\nWhen both `enforcedTargetLimit` and `targetLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined targetLimit value will inherit the global targetLimit value (Prometheus >= 2.45.0) or the enforcedTargetLimit value (Prometheus < v2.45.0).\n If Prometheus version is >= 2.45.0 and the `enforcedTargetLimit` is greater than the `targetLimit`, the `targetLimit` will be set to `enforcedTargetLimit`.\n* Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value.\n* Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit.", "format": "int64", "type": "integer" }, "evaluationInterval": { "default": "30s", - "description": "Interval between rule evaluations.\nDefault: \"30s\"", + "description": "evaluationInterval defines the interval between rule evaluations.\nDefault: \"30s\"", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "excludedFromEnforcement": { - "description": "List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\n\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true.", + "description": "excludedFromEnforcement defines the list of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\n\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true.", "items": { "description": "ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.", "properties": { "group": { "default": "monitoring.coreos.com", - "description": "Group of the referent. When not specified, it defaults to `monitoring.coreos.com`", + "description": "group of the referent. When not specified, it defaults to `monitoring.coreos.com`", "enum": [ "monitoring.coreos.com" ], "type": "string" }, "name": { - "description": "Name of the referent. When not set, all resources in the namespace are matched.", + "description": "name of the referent. When not set, all resources in the namespace are matched.", "type": "string" }, "namespace": { - "description": "Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/", + "description": "namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/", "minLength": 1, "type": "string" }, "resource": { - "description": "Resource of the referent.", + "description": "resource of the referent.", "enum": [ "prometheusrules", "servicemonitors", @@ -3391,10 +3392,10 @@ "type": "array" }, "exemplars": { - "description": "Exemplars related settings that are runtime reloadable.\nIt requires to enable the `exemplar-storage` feature flag to be effective.", + "description": "exemplars related settings that are runtime reloadable.\nIt requires to enable the `exemplar-storage` feature flag to be effective.", "properties": { "maxSize": { - "description": "Maximum number of exemplars stored in memory for all series.\n\nexemplar-storage itself must be enabled using the `spec.enableFeature`\noption for exemplars to be scraped in the first place.\n\nIf not set, Prometheus uses its default value. A value of zero or less\nthan zero disables the storage.", + "description": "maxSize defines the maximum number of exemplars stored in memory for all series.\n\nexemplar-storage itself must be enabled using the `spec.enableFeature`\noption for exemplars to be scraped in the first place.\n\nIf not set, Prometheus uses its default value. A value of zero or less\nthan zero disables the storage.", "format": "int64", "type": "integer" } @@ -3405,27 +3406,27 @@ "additionalProperties": { "type": "string" }, - "description": "The labels to add to any time series or alerts when communicating with\nexternal systems (federation, remote storage, Alertmanager).\nLabels defined by `spec.replicaExternalLabelName` and\n`spec.prometheusExternalLabelName` take precedence over this list.", + "description": "externalLabels defines the labels to add to any time series or alerts when communicating with\nexternal systems (federation, remote storage, Alertmanager).\nLabels defined by `spec.replicaExternalLabelName` and\n`spec.prometheusExternalLabelName` take precedence over this list.", "type": "object" }, "externalUrl": { - "description": "The external URL under which the Prometheus service is externally\navailable. This is necessary to generate correct URLs (for instance if\nPrometheus is accessible behind an Ingress resource).", + "description": "externalUrl defines the external URL under which the Prometheus service is externally\navailable. This is necessary to generate correct URLs (for instance if\nPrometheus is accessible behind an Ingress resource).", "type": "string" }, "hostAliases": { - "description": "Optional list of hosts and IPs that will be injected into the Pod's\nhosts file if specified.", + "description": "hostAliases defines the optional list of hosts and IPs that will be injected into the Pod's\nhosts file if specified.", "items": { "description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the\npod's hosts file.", "properties": { "hostnames": { - "description": "Hostnames for the above IP address.", + "description": "hostnames defines hostnames for the above IP address.", "items": { "type": "string" }, "type": "array" }, "ip": { - "description": "IP address of the host file entry.", + "description": "ip defines the IP address of the host file entry.", "type": "string" } }, @@ -3442,23 +3443,23 @@ "x-kubernetes-list-type": "map" }, "hostNetwork": { - "description": "Use the host's network namespace if true.\n\nMake sure to understand the security implications if you want to enable\nit (https://kubernetes.io/docs/concepts/configuration/overview/ ).\n\nWhen hostNetwork is enabled, this will set the DNS policy to\n`ClusterFirstWithHostNet` automatically (unless `.spec.DNSPolicy` is set\nto a different value).", + "description": "hostNetwork defines the host's network namespace if true.\n\nMake sure to understand the security implications if you want to enable\nit (https://kubernetes.io/docs/concepts/configuration/overview/ ).\n\nWhen hostNetwork is enabled, this will set the DNS policy to\n`ClusterFirstWithHostNet` automatically (unless `.spec.DNSPolicy` is set\nto a different value).", "type": "boolean" }, "hostUsers": { - "description": "HostUsers supports the user space in Kubernetes.\n\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/\n\nThe feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled.\nStarting Kubernetes 1.33, the feature is enabled by default.", + "description": "hostUsers supports the user space in Kubernetes.\n\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/\n\nThe feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled.\nStarting Kubernetes 1.33, the feature is enabled by default.", "type": "boolean" }, "ignoreNamespaceSelectors": { - "description": "When true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor\nand Probe objects will be ignored. They will only discover targets\nwithin the namespace of the PodMonitor, ServiceMonitor and Probe\nobject.", + "description": "ignoreNamespaceSelectors when true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor\nand Probe objects will be ignored. They will only discover targets\nwithin the namespace of the PodMonitor, ServiceMonitor and Probe\nobject.", "type": "boolean" }, "image": { - "description": "Container image name for Prometheus. If specified, it takes precedence\nover the `spec.baseImage`, `spec.tag` and `spec.sha` fields.\n\nSpecifying `spec.version` is still necessary to ensure the Prometheus\nOperator knows which version of Prometheus is being configured.\n\nIf neither `spec.image` nor `spec.baseImage` are defined, the operator\nwill use the latest upstream version of Prometheus available at the time\nwhen the operator was released.", + "description": "image defines the container image name for Prometheus. If specified, it takes precedence\nover the `spec.baseImage`, `spec.tag` and `spec.sha` fields.\n\nSpecifying `spec.version` is still necessary to ensure the Prometheus\nOperator knows which version of Prometheus is being configured.\n\nIf neither `spec.image` nor `spec.baseImage` are defined, the operator\nwill use the latest upstream version of Prometheus available at the time\nwhen the operator was released.", "type": "string" }, "imagePullPolicy": { - "description": "Image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers.\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.", + "description": "imagePullPolicy defines the image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers.\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.", "enum": [ "", "Always", @@ -3468,7 +3469,7 @@ "type": "string" }, "imagePullSecrets": { - "description": "An optional list of references to Secrets in the same namespace\nto use for pulling images from registries.\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod", + "description": "imagePullSecrets defines an optional list of references to Secrets in the same namespace\nto use for pulling images from registries.\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod", "items": { "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { @@ -3484,7 +3485,7 @@ "type": "array" }, "initContainers": { - "description": "InitContainers allows injecting initContainers to the Pod definition. Those\ncan be used to e.g. fetch secrets for injection into the Prometheus\nconfiguration from external sources. Any errors during the execution of\nan initContainer will lead to a restart of the Pod. More info:\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator generated init\ncontainers if they share the same name and modifications are done via a\nstrategic merge patch.\n\nThe names of init container name managed by the operator are:\n* `init-config-reloader`.\n\nOverriding init containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice.", + "description": "initContainers allows injecting initContainers to the Pod definition. Those\ncan be used to e.g. fetch secrets for injection into the Prometheus\nconfiguration from external sources. Any errors during the execution of\nan initContainer will lead to a restart of the Pod. More info:\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator generated init\ncontainers if they share the same name and modifications are done via a\nstrategic merge patch.\n\nThe names of init container name managed by the operator are:\n* `init-config-reloader`.\n\nOverriding init containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice.", "items": { "description": "A single application container that you want to run within a pod.", "properties": { @@ -4822,31 +4823,31 @@ "type": "array" }, "keepDroppedTargets": { - "description": "Per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\nIt requires Prometheus >= v2.47.0.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets.", + "description": "keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\nIt requires Prometheus >= v2.47.0.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets.", "format": "int64", "type": "integer" }, "labelLimit": { - "description": "Per-scrape limit on number of labels that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit.", + "description": "labelLimit defines per-scrape limit on number of labels that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit.", "format": "int64", "type": "integer" }, "labelNameLengthLimit": { - "description": "Per-scrape limit on length of labels name that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit.", + "description": "labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit.", "format": "int64", "type": "integer" }, "labelValueLengthLimit": { - "description": "Per-scrape limit on length of labels value that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit.", + "description": "labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit.", "format": "int64", "type": "integer" }, "listenLocal": { - "description": "When true, the Prometheus server listens on the loopback address\ninstead of the Pod IP's address.", + "description": "listenLocal when true, the Prometheus server listens on the loopback address\ninstead of the Pod IP's address.", "type": "boolean" }, "logFormat": { - "description": "Log format for Log level for Prometheus and the config-reloader sidecar.", + "description": "logFormat for Log level for Prometheus and the config-reloader sidecar.", "enum": [ "", "logfmt", @@ -4855,7 +4856,7 @@ "type": "string" }, "logLevel": { - "description": "Log level for Prometheus and the config-reloader sidecar.", + "description": "logLevel for Prometheus and the config-reloader sidecar.", "enum": [ "", "debug", @@ -4866,19 +4867,19 @@ "type": "string" }, "maximumStartupDurationSeconds": { - "description": "Defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete.\nIf set, the value should be greater than 60 (seconds). Otherwise it will be equal to 600 seconds (15 minutes).", + "description": "maximumStartupDurationSeconds defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete.\nIf set, the value should be greater than 60 (seconds). Otherwise it will be equal to 600 seconds (15 minutes).", "format": "int32", "minimum": 60, "type": "integer" }, "minReadySeconds": { - "description": "Minimum number of seconds for which a newly created Pod should be ready\nwithout any of its container crashing for it to be considered available.\n\nIf unset, pods will be considered available as soon as they are ready.", + "description": "minReadySeconds defines the minimum number of seconds for which a newly created Pod should be ready\nwithout any of its container crashing for it to be considered available.\n\nIf unset, pods will be considered available as soon as they are ready.", "format": "int32", "minimum": 0, "type": "integer" }, "nameEscapingScheme": { - "description": "Specifies the character escaping scheme that will be requested when scraping\nfor metric and label names that do not conform to the legacy Prometheus\ncharacter set.\n\nIt requires Prometheus >= v3.4.0.", + "description": "nameEscapingScheme defines the character escaping scheme that will be requested when scraping\nfor metric and label names that do not conform to the legacy Prometheus\ncharacter set.\n\nIt requires Prometheus >= v3.4.0.", "enum": [ "AllowUTF8", "Underscores", @@ -4888,7 +4889,7 @@ "type": "string" }, "nameValidationScheme": { - "description": "Specifies the validation scheme for metric and label names.\n\nIt requires Prometheus >= v2.55.0.", + "description": "nameValidationScheme defines the validation scheme for metric and label names.\n\nIt requires Prometheus >= v2.55.0.", "enum": [ "UTF8", "Legacy" @@ -4899,18 +4900,18 @@ "additionalProperties": { "type": "string" }, - "description": "Defines on which Nodes the Pods are scheduled.", + "description": "nodeSelector defines on which Nodes the Pods are scheduled.", "type": "object" }, "otlp": { - "description": "Settings related to the OTLP receiver feature.\nIt requires Prometheus >= v2.55.0.", + "description": "otlp defines the settings related to the OTLP receiver feature.\nIt requires Prometheus >= v2.55.0.", "properties": { "convertHistogramsToNHCB": { - "description": "Configures optional translation of OTLP explicit bucket histograms into native histograms with custom buckets.\nIt requires Prometheus >= v3.4.0.", + "description": "convertHistogramsToNHCB defines optional translation of OTLP explicit bucket histograms into native histograms with custom buckets.\nIt requires Prometheus >= v3.4.0.", "type": "boolean" }, "ignoreResourceAttributes": { - "description": "List of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true.\n\nIt requires `promoteAllResourceAttributes` to be true.\nIt requires Prometheus >= v3.5.0.", + "description": "ignoreResourceAttributes defines the list of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true.\n\nIt requires `promoteAllResourceAttributes` to be true.\nIt requires Prometheus >= v3.5.0.", "items": { "minLength": 1, "type": "string" @@ -4920,15 +4921,15 @@ "x-kubernetes-list-type": "set" }, "keepIdentifyingResourceAttributes": { - "description": "Enables adding `service.name`, `service.namespace` and `service.instance.id`\nresource attributes to the `target_info` metric, on top of converting them into the `instance` and `job` labels.\n\nIt requires Prometheus >= v3.1.0.", + "description": "keepIdentifyingResourceAttributes enables adding `service.name`, `service.namespace` and `service.instance.id`\nresource attributes to the `target_info` metric, on top of converting them into the `instance` and `job` labels.\n\nIt requires Prometheus >= v3.1.0.", "type": "boolean" }, "promoteAllResourceAttributes": { - "description": "Promote all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`.\n\nCannot be true when `promoteResourceAttributes` is defined.\nIt requires Prometheus >= v3.5.0.", + "description": "promoteAllResourceAttributes promotes all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`.\n\nCannot be true when `promoteResourceAttributes` is defined.\nIt requires Prometheus >= v3.5.0.", "type": "boolean" }, "promoteResourceAttributes": { - "description": "List of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none.\nCannot be defined when `promoteAllResourceAttributes` is true.", + "description": "promoteResourceAttributes defines the list of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none.\nCannot be defined when `promoteAllResourceAttributes` is true.", "items": { "minLength": 1, "type": "string" @@ -4938,7 +4939,7 @@ "x-kubernetes-list-type": "set" }, "translationStrategy": { - "description": "Configures how the OTLP receiver endpoint translates the incoming metrics.\n\nIt requires Prometheus >= v3.0.0.", + "description": "translationStrategy defines how the OTLP receiver endpoint translates the incoming metrics.\n\nIt requires Prometheus >= v3.0.0.", "enum": [ "NoUTF8EscapingWithSuffixes", "UnderscoreEscapingWithSuffixes", @@ -4950,19 +4951,19 @@ "type": "object" }, "overrideHonorLabels": { - "description": "When true, Prometheus resolves label conflicts by renaming the labels in the scraped data\n to “exported_” for all targets created from ServiceMonitor, PodMonitor and\nScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies.\nIn practice,`overrideHonorLaels:true` enforces `honorLabels:false`\nfor all ServiceMonitor, PodMonitor and ScrapeConfig objects.", + "description": "overrideHonorLabels when true, Prometheus resolves label conflicts by renaming the labels in the scraped data\n to “exported_” for all targets created from ServiceMonitor, PodMonitor and\nScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies.\nIn practice,`overrideHonorLaels:true` enforces `honorLabels:false`\nfor all ServiceMonitor, PodMonitor and ScrapeConfig objects.", "type": "boolean" }, "overrideHonorTimestamps": { - "description": "When true, Prometheus ignores the timestamps for all the targets created\nfrom service and pod monitors.\nOtherwise the HonorTimestamps field of the service or pod monitor applies.", + "description": "overrideHonorTimestamps when true, Prometheus ignores the timestamps for all the targets created\nfrom service and pod monitors.\nOtherwise the HonorTimestamps field of the service or pod monitor applies.", "type": "boolean" }, "paused": { - "description": "When a Prometheus deployment is paused, no actions except for deletion\nwill be performed on the underlying objects.", + "description": "paused defines when a Prometheus deployment is paused, no actions except for deletion\nwill be performed on the underlying objects.", "type": "boolean" }, "persistentVolumeClaimRetentionPolicy": { - "description": "The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet.\nThe default behavior is all PVCs are retained.\nThis is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26.\nIt requires enabling the StatefulSetAutoDeletePVC feature gate.", + "description": "persistentVolumeClaimRetentionPolicy defines the field controls if and how PVCs are deleted during the lifecycle of a StatefulSet.\nThe default behavior is all PVCs are retained.\nThis is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26.\nIt requires enabling the StatefulSetAutoDeletePVC feature gate.", "properties": { "whenDeleted": { "description": "WhenDeleted specifies what happens to PVCs created from StatefulSet\nVolumeClaimTemplates when the StatefulSet is deleted. The default policy\nof `Retain` causes PVCs to not be affected by StatefulSet deletion. The\n`Delete` policy causes those PVCs to be deleted.", @@ -4976,31 +4977,31 @@ "type": "object" }, "podMetadata": { - "description": "PodMetadata configures labels and annotations which are propagated to the Prometheus pods.\n\nThe following items are reserved and cannot be overridden:\n* \"prometheus\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/instance\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/managed-by\" label, set to \"prometheus-operator\".\n* \"app.kubernetes.io/name\" label, set to \"prometheus\".\n* \"app.kubernetes.io/version\" label, set to the Prometheus version.\n* \"operator.prometheus.io/name\" label, set to the name of the Prometheus object.\n* \"operator.prometheus.io/shard\" label, set to the shard number of the Prometheus object.\n* \"kubectl.kubernetes.io/default-container\" annotation, set to \"prometheus\".", + "description": "podMetadata defines labels and annotations which are propagated to the Prometheus pods.\n\nThe following items are reserved and cannot be overridden:\n* \"prometheus\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/instance\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/managed-by\" label, set to \"prometheus-operator\".\n* \"app.kubernetes.io/name\" label, set to \"prometheus\".\n* \"app.kubernetes.io/version\" label, set to the Prometheus version.\n* \"operator.prometheus.io/name\" label, set to the name of the Prometheus object.\n* \"operator.prometheus.io/shard\" label, set to the shard number of the Prometheus object.\n* \"kubectl.kubernetes.io/default-container\" annotation, set to \"prometheus\".", "properties": { "annotations": { "additionalProperties": { "type": "string" }, - "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", + "description": "annotations defines an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", + "description": "labels define the map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "type": "object" }, "name": { - "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", + "description": "name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", "type": "string" } }, "type": "object" }, "podMonitorNamespaceSelector": { - "description": "Namespaces to match for PodMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only.", + "description": "podMonitorNamespaceSelector defines the namespaces to match for PodMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -5045,7 +5046,7 @@ "x-kubernetes-map-type": "atomic" }, "podMonitorSelector": { - "description": "PodMonitors to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", + "description": "podMonitorSelector defines the podMonitors to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -5090,7 +5091,7 @@ "x-kubernetes-map-type": "atomic" }, "podTargetLabels": { - "description": "PodTargetLabels are appended to the `spec.podTargetLabels` field of all\nPodMonitor and ServiceMonitor objects.", + "description": "podTargetLabels are appended to the `spec.podTargetLabels` field of all\nPodMonitor and ServiceMonitor objects.", "items": { "type": "string" }, @@ -5098,15 +5099,15 @@ }, "portName": { "default": "web", - "description": "Port name used for the pods and governing service.\nDefault: \"web\"", + "description": "portName used for the pods and governing service.\nDefault: \"web\"", "type": "string" }, "priorityClassName": { - "description": "Priority class assigned to the Pods.", + "description": "priorityClassName assigned to the Pods.", "type": "string" }, "probeNamespaceSelector": { - "description": "Namespaces to match for Probe discovery. An empty label\nselector matches all namespaces. A null label selector matches the\ncurrent namespace only.", + "description": "probeNamespaceSelector defines the namespaces to match for Probe discovery. An empty label\nselector matches all namespaces. A null label selector matches the\ncurrent namespace only.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -5151,7 +5152,7 @@ "x-kubernetes-map-type": "atomic" }, "probeSelector": { - "description": "Probes to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", + "description": "probeSelector defines the probes to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -5196,20 +5197,20 @@ "x-kubernetes-map-type": "atomic" }, "prometheusExternalLabelName": { - "description": "Name of Prometheus external label used to denote the Prometheus instance\nname. The external label will _not_ be added when the field is set to\nthe empty string (`\"\"`).\n\nDefault: \"prometheus\"", + "description": "prometheusExternalLabelName defines the name of Prometheus external label used to denote the Prometheus instance\nname. The external label will _not_ be added when the field is set to\nthe empty string (`\"\"`).\n\nDefault: \"prometheus\"", "type": "string" }, "prometheusRulesExcludedFromEnforce": { - "description": "Defines the list of PrometheusRule objects to which the namespace label\nenforcement doesn't apply.\nThis is only relevant when `spec.enforcedNamespaceLabel` is set to true.\nDeprecated: use `spec.excludedFromEnforcement` instead.", + "description": "prometheusRulesExcludedFromEnforce defines the list of PrometheusRule objects to which the namespace label\nenforcement doesn't apply.\nThis is only relevant when `spec.enforcedNamespaceLabel` is set to true.\nDeprecated: use `spec.excludedFromEnforcement` instead.", "items": { "description": "PrometheusRuleExcludeConfig enables users to configure excluded\nPrometheusRule names and their namespaces to be ignored while enforcing\nnamespace label for alerts and metrics.", "properties": { "ruleName": { - "description": "Name of the excluded PrometheusRule object.", + "description": "ruleName defines the name of the excluded PrometheusRule object.", "type": "string" }, "ruleNamespace": { - "description": "Namespace of the excluded PrometheusRule object.", + "description": "ruleNamespace defines the namespace of the excluded PrometheusRule object.", "type": "string" } }, @@ -5222,25 +5223,25 @@ "type": "array" }, "query": { - "description": "QuerySpec defines the configuration of the Promethus query service.", + "description": "query defines the configuration of the Promethus query service.", "properties": { "lookbackDelta": { - "description": "The delta difference allowed for retrieving metrics during expression evaluations.", + "description": "lookbackDelta defines the delta difference allowed for retrieving metrics during expression evaluations.", "type": "string" }, "maxConcurrency": { - "description": "Number of concurrent queries that can be run at once.", + "description": "maxConcurrency defines the number of concurrent queries that can be run at once.", "format": "int32", "minimum": 1, "type": "integer" }, "maxSamples": { - "description": "Maximum number of samples a single query can load into memory. Note that\nqueries will fail if they would load more samples than this into memory,\nso this also limits the number of samples a query can return.", + "description": "maxSamples defines the maximum number of samples a single query can load into memory. Note that\nqueries will fail if they would load more samples than this into memory,\nso this also limits the number of samples a query can return.", "format": "int32", "type": "integer" }, "timeout": { - "description": "Maximum time a query may take before being aborted.", + "description": "timeout defines the maximum time a query may take before being aborted.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" } @@ -5252,7 +5253,7 @@ "type": "string" }, "reloadStrategy": { - "description": "Defines the strategy used to reload the Prometheus configuration.\nIf not specified, the configuration is reloaded using the /-/reload HTTP endpoint.", + "description": "reloadStrategy defines the strategy used to reload the Prometheus configuration.\nIf not specified, the configuration is reloaded using the /-/reload HTTP endpoint.", "enum": [ "HTTP", "ProcessSignal" @@ -5260,15 +5261,15 @@ "type": "string" }, "remoteRead": { - "description": "Defines the list of remote read configurations.", + "description": "remoteRead defines the list of remote read configurations.", "items": { "description": "RemoteReadSpec defines the configuration for Prometheus to read back samples\nfrom a remote endpoint.", "properties": { "authorization": { - "description": "Authorization section for the URL.\n\nIt requires Prometheus >= v2.26.0.\n\nCannot be set at the same time as `basicAuth`, or `oauth2`.", + "description": "authorization section for the URL.\n\nIt requires Prometheus >= v2.26.0.\n\nCannot be set at the same time as `basicAuth`, or `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5291,21 +5292,21 @@ "x-kubernetes-map-type": "atomic" }, "credentialsFile": { - "description": "File to read a secret from, mutually exclusive with `credentials`.", + "description": "credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`.", "type": "string" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth configuration for the URL.\n\nCannot be set at the same time as `authorization`, or `oauth2`.", + "description": "basicAuth configuration for the URL.\n\nCannot be set at the same time as `authorization`, or `oauth2`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5328,7 +5329,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5354,44 +5355,44 @@ "type": "object" }, "bearerToken": { - "description": "*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\nDeprecated: this will be removed in a future release.", + "description": "bearerToken is deprecated: this will be removed in a future release.\n*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*", "type": "string" }, "bearerTokenFile": { - "description": "File from which to read the bearer token for the URL.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", + "description": "bearerTokenFile defines the file from which to read the bearer token for the URL.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", "type": "string" }, "filterExternalLabels": { - "description": "Whether to use the external labels as selectors for the remote read endpoint.\n\nIt requires Prometheus >= v2.34.0.", + "description": "filterExternalLabels defines whether to use the external labels as selectors for the remote read endpoint.\n\nIt requires Prometheus >= v2.34.0.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.\n\nIt requires Prometheus >= v2.26.0.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\n\nIt requires Prometheus >= v2.26.0.", "type": "boolean" }, "headers": { "additionalProperties": { "type": "string" }, - "description": "Custom HTTP headers to be sent along with each remote read request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\nOnly valid in Prometheus versions 2.26.0 and newer.", + "description": "headers defines the custom HTTP headers to be sent along with each remote read request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\nOnly valid in Prometheus versions 2.26.0 and newer.", "type": "object" }, "name": { - "description": "The name of the remote read queue, it must be unique if specified. The\nname is used in metrics and logging in order to differentiate read\nconfigurations.\n\nIt requires Prometheus >= v2.15.0.", + "description": "name of the remote read queue, it must be unique if specified. The\nname is used in metrics and logging in order to differentiate read\nconfigurations.\n\nIt requires Prometheus >= v2.15.0.", "type": "string" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 configuration for the URL.\n\nIt requires Prometheus >= v2.27.0.\n\nCannot be set at the same time as `authorization`, or `basicAuth`.", + "description": "oauth2 configuration for the URL.\n\nIt requires Prometheus >= v2.27.0.\n\nCannot be set at the same time as `authorization`, or `basicAuth`.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5414,7 +5415,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5440,7 +5441,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5466,11 +5467,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -5500,34 +5501,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5550,7 +5551,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5576,10 +5577,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5602,7 +5603,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5628,11 +5629,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5655,7 +5656,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -5665,7 +5666,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -5675,14 +5676,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -5721,25 +5722,25 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "readRecent": { - "description": "Whether reads should be made for queries for time ranges that\nthe local storage should have complete data for.", + "description": "readRecent defines whether reads should be made for queries for time ranges that\nthe local storage should have complete data for.", "type": "boolean" }, "remoteTimeout": { - "description": "Timeout for requests to the remote read endpoint.", + "description": "remoteTimeout defines the timeout for requests to the remote read endpoint.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, @@ -5747,17 +5748,17 @@ "additionalProperties": { "type": "string" }, - "description": "An optional list of equality matchers which have to be present\nin a selector to query the remote read endpoint.", + "description": "requiredMatchers defines an optional list of equality matchers which have to be present\nin a selector to query the remote read endpoint.", "type": "object" }, "tlsConfig": { - "description": "TLS Config to use for the URL.", + "description": "tlsConfig to use for the URL.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5780,7 +5781,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5806,14 +5807,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5836,7 +5837,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5862,19 +5863,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5897,7 +5898,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -5907,7 +5908,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -5917,14 +5918,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "url": { - "description": "The URL of the endpoint to query from.", + "description": "url defines the URL of the endpoint to query from.", "type": "string" } }, @@ -5936,15 +5937,15 @@ "type": "array" }, "remoteWrite": { - "description": "Defines the list of remote write configurations.", + "description": "remoteWrite defines the list of remote write configurations.", "items": { "description": "RemoteWriteSpec defines the configuration to write samples from Prometheus\nto a remote endpoint.", "properties": { "authorization": { - "description": "Authorization section for the URL.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`.", + "description": "authorization section for the URL.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5967,21 +5968,21 @@ "x-kubernetes-map-type": "atomic" }, "credentialsFile": { - "description": "File to read a secret from, mutually exclusive with `credentials`.", + "description": "credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`.", "type": "string" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "azureAd": { - "description": "AzureAD for the URL.\n\nIt requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`.", + "description": "azureAd for the URL.\n\nIt requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`.", "properties": { "cloud": { - "description": "The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'.", + "description": "cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'.", "enum": [ "AzureChina", "AzureGovernment", @@ -5990,10 +5991,10 @@ "type": "string" }, "managedIdentity": { - "description": "ManagedIdentity defines the Azure User-assigned Managed identity.\nCannot be set at the same time as `oauth` or `sdk`.", + "description": "managedIdentity defines the Azure User-assigned Managed identity.\nCannot be set at the same time as `oauth` or `sdk`.", "properties": { "clientId": { - "description": "The client id", + "description": "clientId defines defines the Azure User-assigned Managed identity.", "type": "string" } }, @@ -6003,15 +6004,15 @@ "type": "object" }, "oauth": { - "description": "OAuth defines the oauth config that is being used to authenticate.\nCannot be set at the same time as `managedIdentity` or `sdk`.\n\nIt requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.", + "description": "oauth defines the oauth config that is being used to authenticate.\nCannot be set at the same time as `managedIdentity` or `sdk`.\n\nIt requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.", "properties": { "clientId": { - "description": "`clientID` is the clientId of the Azure Active Directory application that is being used to authenticate.", + "description": "clientId defines the clientId of the Azure Active Directory application that is being used to authenticate.", "minLength": 1, "type": "string" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.", + "description": "clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6034,7 +6035,7 @@ "x-kubernetes-map-type": "atomic" }, "tenantId": { - "description": "`tenantId` is the tenant ID of the Azure Active Directory application that is being used to authenticate.", + "description": "tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate.", "minLength": 1, "pattern": "^[0-9a-zA-Z-.]+$", "type": "string" @@ -6048,10 +6049,10 @@ "type": "object" }, "sdk": { - "description": "SDK defines the Azure SDK config that is being used to authenticate.\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication\nCannot be set at the same time as `oauth` or `managedIdentity`.\n\nIt requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.", + "description": "sdk defines the Azure SDK config that is being used to authenticate.\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication\nCannot be set at the same time as `oauth` or `managedIdentity`.\n\nIt requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.", "properties": { "tenantId": { - "description": "`tenantId` is the tenant ID of the azure active directory application that is being used to authenticate.", + "description": "tenantId defines the tenant ID of the azure active directory application that is being used to authenticate.", "pattern": "^[0-9a-zA-Z-.]+$", "type": "string" } @@ -6062,10 +6063,10 @@ "type": "object" }, "basicAuth": { - "description": "BasicAuth configuration for the URL.\n\nCannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`.", + "description": "basicAuth configuration for the URL.\n\nCannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6088,7 +6089,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6114,30 +6115,30 @@ "type": "object" }, "bearerToken": { - "description": "*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\nDeprecated: this will be removed in a future release.", + "description": "bearerToken is deprecated: this will be removed in a future release.\n*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*", "type": "string" }, "bearerTokenFile": { - "description": "File from which to read bearer token for the URL.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", + "description": "bearerTokenFile defines the file from which to read bearer token for the URL.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", "type": "string" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.", "type": "boolean" }, "headers": { "additionalProperties": { "type": "string" }, - "description": "Custom HTTP headers to be sent along with each remote write request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\n\nIt requires Prometheus >= v2.25.0 or Thanos >= v0.24.0.", + "description": "headers defines the custom HTTP headers to be sent along with each remote write request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\n\nIt requires Prometheus >= v2.25.0 or Thanos >= v0.24.0.", "type": "object" }, "messageVersion": { - "description": "The Remote Write message's version to use when writing to the endpoint.\n\n`Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0.\n`Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0.\n\nWhen `Version2.0` is selected, Prometheus will automatically be\nconfigured to append the metadata of scraped metrics to the WAL.\n\nBefore setting this field, consult with your remote storage provider\nwhat message version it supports.\n\nIt requires Prometheus >= v2.54.0 or Thanos >= v0.37.0.", + "description": "messageVersion defines the Remote Write message's version to use when writing to the endpoint.\n\n`Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0.\n`Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0.\n\nWhen `Version2.0` is selected, Prometheus will automatically be\nconfigured to append the metadata of scraped metrics to the WAL.\n\nBefore setting this field, consult with your remote storage provider\nwhat message version it supports.\n\nIt requires Prometheus >= v2.54.0 or Thanos >= v0.37.0.", "enum": [ "V1.0", "V2.0" @@ -6145,20 +6146,20 @@ "type": "string" }, "metadataConfig": { - "description": "MetadataConfig configures the sending of series metadata to the remote storage.", + "description": "metadataConfig defines how to send a series metadata to the remote storage.", "properties": { "maxSamplesPerSend": { - "description": "MaxSamplesPerSend is the maximum number of metadata samples per send.\n\nIt requires Prometheus >= v2.29.0.", + "description": "maxSamplesPerSend defines the maximum number of metadata samples per send.\n\nIt requires Prometheus >= v2.29.0.", "format": "int32", "minimum": -1, "type": "integer" }, "send": { - "description": "Defines whether metric metadata is sent to the remote storage or not.", + "description": "send defines whether metric metadata is sent to the remote storage or not.", "type": "boolean" }, "sendInterval": { - "description": "Defines how frequently metric metadata is sent to the remote storage.", + "description": "sendInterval defines how frequently metric metadata is sent to the remote storage.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" } @@ -6166,21 +6167,21 @@ "type": "object" }, "name": { - "description": "The name of the remote write queue, it must be unique if specified. The\nname is used in metrics and logging in order to differentiate queues.\n\nIt requires Prometheus >= v2.15.0 or Thanos >= 0.24.0.", + "description": "name of the remote write queue, it must be unique if specified. The\nname is used in metrics and logging in order to differentiate queues.\n\nIt requires Prometheus >= v2.15.0 or Thanos >= 0.24.0.", "type": "string" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 configuration for the URL.\n\nIt requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`.", + "description": "oauth2 configuration for the URL.\n\nIt requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6203,7 +6204,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6229,7 +6230,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6255,11 +6256,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -6289,34 +6290,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6339,7 +6340,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6365,10 +6366,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6391,7 +6392,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6417,11 +6418,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6444,7 +6445,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -6454,7 +6455,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -6464,14 +6465,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -6510,63 +6511,63 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "queueConfig": { - "description": "QueueConfig allows tuning of the remote write queue parameters.", + "description": "queueConfig allows tuning of the remote write queue parameters.", "properties": { "batchSendDeadline": { - "description": "BatchSendDeadline is the maximum time a sample will wait in buffer.", + "description": "batchSendDeadline defines the maximum time a sample will wait in buffer.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "capacity": { - "description": "Capacity is the number of samples to buffer per shard before we start\ndropping them.", + "description": "capacity defines the number of samples to buffer per shard before we start\ndropping them.", "type": "integer" }, "maxBackoff": { - "description": "MaxBackoff is the maximum retry delay.", + "description": "maxBackoff defines the maximum retry delay.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "maxRetries": { - "description": "MaxRetries is the maximum number of times to retry a batch on recoverable errors.", + "description": "maxRetries defines the maximum number of times to retry a batch on recoverable errors.", "type": "integer" }, "maxSamplesPerSend": { - "description": "MaxSamplesPerSend is the maximum number of samples per send.", + "description": "maxSamplesPerSend defines the maximum number of samples per send.", "type": "integer" }, "maxShards": { - "description": "MaxShards is the maximum number of shards, i.e. amount of concurrency.", + "description": "maxShards defines the maximum number of shards, i.e. amount of concurrency.", "type": "integer" }, "minBackoff": { - "description": "MinBackoff is the initial retry delay. Gets doubled for every retry.", + "description": "minBackoff defines the initial retry delay. Gets doubled for every retry.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "minShards": { - "description": "MinShards is the minimum number of shards, i.e. amount of concurrency.", + "description": "minShards defines the minimum number of shards, i.e. amount of concurrency.", "type": "integer" }, "retryOnRateLimit": { - "description": "Retry upon receiving a 429 status code from the remote-write storage.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", + "description": "retryOnRateLimit defines the retry upon receiving a 429 status code from the remote-write storage.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "type": "boolean" }, "sampleAgeLimit": { - "description": "SampleAgeLimit drops samples older than the limit.\nIt requires Prometheus >= v2.50.0 or Thanos >= v0.32.0.", + "description": "sampleAgeLimit drops samples older than the limit.\nIt requires Prometheus >= v2.50.0 or Thanos >= v0.32.0.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" } @@ -6574,27 +6575,27 @@ "type": "object" }, "remoteTimeout": { - "description": "Timeout for requests to the remote write endpoint.", + "description": "remoteTimeout defines the timeout for requests to the remote write endpoint.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "roundRobinDNS": { - "description": "When enabled:\n - The remote-write mechanism will resolve the hostname via DNS.\n - It will randomly select one of the resolved IP addresses and connect to it.\n\nWhen disabled (default behavior):\n - The Go standard library will handle hostname resolution.\n - It will attempt connections to each resolved IP address sequentially.\n\nNote: The connection timeout applies to the entire resolution and connection process.\n If disabled, the timeout is distributed across all connection attempts.\n\nIt requires Prometheus >= v3.1.0 or Thanos >= v0.38.0.", + "description": "roundRobinDNS controls the DNS resolution behavior for remote-write connections.\nWhen enabled:\n - The remote-write mechanism will resolve the hostname via DNS.\n - It will randomly select one of the resolved IP addresses and connect to it.\n\nWhen disabled (default behavior):\n - The Go standard library will handle hostname resolution.\n - It will attempt connections to each resolved IP address sequentially.\n\nNote: The connection timeout applies to the entire resolution and connection process.\n\n\tIf disabled, the timeout is distributed across all connection attempts.\n\nIt requires Prometheus >= v3.1.0 or Thanos >= v0.38.0.", "type": "boolean" }, "sendExemplars": { - "description": "Enables sending of exemplars over remote write. Note that\nexemplar-storage itself must be enabled using the `spec.enableFeatures`\noption for exemplars to be scraped in the first place.\n\nIt requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.", + "description": "sendExemplars enables sending of exemplars over remote write. Note that\nexemplar-storage itself must be enabled using the `spec.enableFeatures`\noption for exemplars to be scraped in the first place.\n\nIt requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.", "type": "boolean" }, "sendNativeHistograms": { - "description": "Enables sending of native histograms, also known as sparse histograms\nover remote write.\n\nIt requires Prometheus >= v2.40.0 or Thanos >= v0.30.0.", + "description": "sendNativeHistograms enables sending of native histograms, also known as sparse histograms\nover remote write.\n\nIt requires Prometheus >= v2.40.0 or Thanos >= v0.30.0.", "type": "boolean" }, "sigv4": { - "description": "Sigv4 allows to configures AWS's Signature Verification 4 for the URL.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`.", + "description": "sigv4 defines the AWS's Signature Verification 4 for the URL.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`.", "properties": { "accessKey": { - "description": "AccessKey is the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.", + "description": "accessKey defines the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6617,19 +6618,19 @@ "x-kubernetes-map-type": "atomic" }, "profile": { - "description": "Profile is the named AWS profile used to authenticate.", + "description": "profile defines the named AWS profile used to authenticate.", "type": "string" }, "region": { - "description": "Region is the AWS region. If blank, the region from the default credentials chain used.", + "description": "region defines the AWS region. If blank, the region from the default credentials chain used.", "type": "string" }, "roleArn": { - "description": "RoleArn is the named AWS profile used to authenticate.", + "description": "roleArn defines the named AWS profile used to authenticate.", "type": "string" }, "secretKey": { - "description": "SecretKey is the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.", + "description": "secretKey defines the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6655,13 +6656,13 @@ "type": "object" }, "tlsConfig": { - "description": "TLS Config to use for the URL.", + "description": "tlsConfig to use for the URL.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6684,7 +6685,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6710,14 +6711,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6740,7 +6741,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6766,19 +6767,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6801,7 +6802,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -6811,7 +6812,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -6821,25 +6822,25 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "url": { - "description": "The URL of the endpoint to send samples to.", + "description": "url defines the URL of the endpoint to send samples to.", "minLength": 1, "type": "string" }, "writeRelabelConfigs": { - "description": "The list of remote write relabel configurations.", + "description": "writeRelabelConfigs defines the list of remote write relabel configurations.", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -6867,24 +6868,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -6893,7 +6894,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -6910,7 +6911,7 @@ "type": "array" }, "remoteWriteReceiverMessageVersions": { - "description": "List of the protobuf message versions to accept when receiving the\nremote writes.\n\nIt requires Prometheus >= v2.54.0.", + "description": "remoteWriteReceiverMessageVersions list of the protobuf message versions to accept when receiving the\nremote writes.\n\nIt requires Prometheus >= v2.54.0.", "items": { "enum": [ "V1.0", @@ -6923,16 +6924,16 @@ "x-kubernetes-list-type": "set" }, "replicaExternalLabelName": { - "description": "Name of Prometheus external label used to denote the replica name.\nThe external label will _not_ be added when the field is set to the\nempty string (`\"\"`).\n\nDefault: \"prometheus_replica\"", + "description": "replicaExternalLabelName defines the name of Prometheus external label used to denote the replica name.\nThe external label will _not_ be added when the field is set to the\nempty string (`\"\"`).\n\nDefault: \"prometheus_replica\"", "type": "string" }, "replicas": { - "description": "Number of replicas of each shard to deploy for a Prometheus deployment.\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\ncreated.\n\nDefault: 1", + "description": "replicas defines the number of replicas of each shard to deploy for a Prometheus deployment.\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\ncreated.\n\nDefault: 1", "format": "int32", "type": "integer" }, "resources": { - "description": "Defines the resources requests and limits of the 'prometheus' container.", + "description": "resources defines the resources requests and limits of the 'prometheus' container.", "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis field depends on the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.", @@ -6995,21 +6996,21 @@ "type": "object" }, "retention": { - "description": "How long to retain the Prometheus data.\n\nDefault: \"24h\" if `spec.retention` and `spec.retentionSize` are empty.", + "description": "retention defines how long to retain the Prometheus data.\n\nDefault: \"24h\" if `spec.retention` and `spec.retentionSize` are empty.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "retentionSize": { - "description": "Maximum number of bytes used by the Prometheus data.", + "description": "retentionSize defines the maximum number of bytes used by the Prometheus data.", "pattern": "(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$", "type": "string" }, "routePrefix": { - "description": "The route prefix Prometheus registers HTTP handlers for.\n\nThis is useful when using `spec.externalURL`, and a proxy is rewriting\nHTTP routes of a request, and the actual ExternalURL is still true, but\nthe server serves requests under a different route prefix. For example\nfor use with `kubectl proxy`.", + "description": "routePrefix defines the route prefix Prometheus registers HTTP handlers for.\n\nThis is useful when using `spec.externalURL`, and a proxy is rewriting\nHTTP routes of a request, and the actual ExternalURL is still true, but\nthe server serves requests under a different route prefix. For example\nfor use with `kubectl proxy`.", "type": "string" }, "ruleNamespaceSelector": { - "description": "Namespaces to match for PrometheusRule discovery. An empty label selector\nmatches all namespaces. A null label selector matches the current\nnamespace only.", + "description": "ruleNamespaceSelector defines the namespaces to match for PrometheusRule discovery. An empty label selector\nmatches all namespaces. A null label selector matches the current\nnamespace only.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -7054,12 +7055,12 @@ "x-kubernetes-map-type": "atomic" }, "ruleQueryOffset": { - "description": "Defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past.\nIt requires Prometheus >= v2.53.0.", + "description": "ruleQueryOffset defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past.\nIt requires Prometheus >= v2.53.0.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "ruleSelector": { - "description": "PrometheusRule objects to be selected for rule evaluation. An empty\nlabel selector matches all objects. A null label selector matches no\nobjects.", + "description": "ruleSelector defines the prometheusRule objects to be selected for rule evaluation. An empty\nlabel selector matches all objects. A null label selector matches no\nobjects.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -7104,21 +7105,21 @@ "x-kubernetes-map-type": "atomic" }, "rules": { - "description": "Defines the configuration of the Prometheus rules' engine.", + "description": "rules defines the configuration of the Prometheus rules' engine.", "properties": { "alert": { - "description": "Defines the parameters of the Prometheus rules' engine.\n\nAny update to these parameters trigger a restart of the pods.", + "description": "alert defines the parameters of the Prometheus rules' engine.\n\nAny update to these parameters trigger a restart of the pods.", "properties": { "forGracePeriod": { - "description": "Minimum duration between alert and restored 'for' state.\n\nThis is maintained only for alerts with a configured 'for' time greater\nthan the grace period.", + "description": "forGracePeriod defines the minimum duration between alert and restored 'for' state.\n\nThis is maintained only for alerts with a configured 'for' time greater\nthan the grace period.", "type": "string" }, "forOutageTolerance": { - "description": "Max time to tolerate prometheus outage for restoring 'for' state of\nalert.", + "description": "forOutageTolerance defines the max time to tolerate prometheus outage for restoring 'for' state of\nalert.", "type": "string" }, "resendDelay": { - "description": "Minimum amount of time to wait before resending an alert to\nAlertmanager.", + "description": "resendDelay defines the minimum amount of time to wait before resending an alert to\nAlertmanager.", "type": "string" } }, @@ -7128,10 +7129,10 @@ "type": "object" }, "runtime": { - "description": "RuntimeConfig configures the values for the Prometheus process behavior", + "description": "runtime defines the values for the Prometheus process behavior", "properties": { "goGC": { - "description": "The Go garbage collection target percentage. Lowering this number may increase the CPU usage.\nSee: https://tip.golang.org/doc/gc-guide#GOGC", + "description": "goGC defines the Go garbage collection target percentage. Lowering this number may increase the CPU usage.\nSee: https://tip.golang.org/doc/gc-guide#GOGC", "format": "int32", "minimum": -1, "type": "integer" @@ -7140,29 +7141,29 @@ "type": "object" }, "sampleLimit": { - "description": "SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit.", + "description": "sampleLimit defines per-scrape limit on number of scraped samples that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit.", "format": "int64", "type": "integer" }, "scrapeClasses": { - "description": "List of scrape classes to expose to scraping objects such as\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", + "description": "scrapeClasses defines the list of scrape classes to expose to scraping objects such as\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "items": { "properties": { "attachMetadata": { - "description": "AttachMetadata configures additional metadata to the discovered targets.\nWhen the scrape object defines its own configuration, it takes\nprecedence over the scrape class configuration.", + "description": "attachMetadata defines additional metadata to the discovered targets.\nWhen the scrape object defines its own configuration, it takes\nprecedence over the scrape class configuration.", "properties": { "node": { - "description": "When set to true, Prometheus attaches node metadata to the discovered\ntargets.\n\nThe Prometheus service account must have the `list` and `watch`\npermissions on the `Nodes` objects.", + "description": "node when set to true, Prometheus attaches node metadata to the discovered\ntargets.\n\nThe Prometheus service account must have the `list` and `watch`\npermissions on the `Nodes` objects.", "type": "boolean" } }, "type": "object" }, "authorization": { - "description": "Authorization section for the ScrapeClass.\nIt will only apply if the scrape resource doesn't specify any Authorization.", + "description": "authorization section for the ScrapeClass.\nIt will only apply if the scrape resource doesn't specify any Authorization.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7185,22 +7186,22 @@ "x-kubernetes-map-type": "atomic" }, "credentialsFile": { - "description": "File to read a secret from, mutually exclusive with `credentials`.", + "description": "credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`.", "type": "string" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "default": { - "description": "Default indicates that the scrape applies to all scrape objects that\ndon't configure an explicit scrape class name.\n\nOnly one scrape class can be set as the default.", + "description": "default defines that the scrape applies to all scrape objects that\ndon't configure an explicit scrape class name.\n\nOnly one scrape class can be set as the default.", "type": "boolean" }, "fallbackScrapeProtocol": { - "description": "The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\nIt will only apply if the scrape resource doesn't specify any FallbackScrapeProtocol\n\nIt requires Prometheus >= v3.0.0.", + "description": "fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\nIt will only apply if the scrape resource doesn't specify any FallbackScrapeProtocol\n\nIt requires Prometheus >= v3.0.0.", "enum": [ "PrometheusProto", "OpenMetricsText0.0.1", @@ -7211,13 +7212,13 @@ "type": "string" }, "metricRelabelings": { - "description": "MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\n\nThe Operator adds the scrape class metric relabelings defined here.\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs", + "description": "metricRelabelings defines the relabeling rules to apply to all samples before ingestion.\n\nThe Operator adds the scrape class metric relabelings defined here.\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -7245,24 +7246,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -7271,7 +7272,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -7280,18 +7281,18 @@ "type": "array" }, "name": { - "description": "Name of the scrape class.", + "description": "name of the scrape class.", "minLength": 1, "type": "string" }, "relabelings": { - "description": "Relabelings configures the relabeling rules to apply to all scrape targets.\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\nThen the Operator adds the scrape class relabelings defined here.\nThen the Operator adds the target-specific relabelings defined in the scrape object.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", + "description": "relabelings defines the relabeling rules to apply to all scrape targets.\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\nThen the Operator adds the scrape class relabelings defined here.\nThen the Operator adds the target-specific relabelings defined in the scrape object.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -7319,24 +7320,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -7345,7 +7346,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -7354,13 +7355,13 @@ "type": "array" }, "tlsConfig": { - "description": "TLSConfig defines the TLS settings to use for the scrape. When the\nscrape objects define their own CA, certificate and/or key, they take\nprecedence over the corresponding scrape class fields.\n\nFor now only the `caFile`, `certFile` and `keyFile` fields are supported.", + "description": "tlsConfig defines the TLS settings to use for the scrape. When the\nscrape objects define their own CA, certificate and/or key, they take\nprecedence over the corresponding scrape class fields.\n\nFor now only the `caFile`, `certFile` and `keyFile` fields are supported.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7383,7 +7384,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7409,14 +7410,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7439,7 +7440,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7465,19 +7466,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7500,7 +7501,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -7510,7 +7511,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -7520,7 +7521,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -7539,11 +7540,11 @@ "x-kubernetes-list-type": "map" }, "scrapeClassicHistograms": { - "description": "Whether to scrape a classic histogram that is also exposed as a native histogram.\n\nNotice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.\n\nIt requires Prometheus >= v3.5.0.", + "description": "scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram.\n\nNotice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.\n\nIt requires Prometheus >= v3.5.0.", "type": "boolean" }, "scrapeConfigNamespaceSelector": { - "description": "Namespaces to match for ScrapeConfig discovery. An empty label selector\nmatches all namespaces. A null label selector matches the current\nnamespace only.\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level.", + "description": "scrapeConfigNamespaceSelector defines the namespaces to match for ScrapeConfig discovery. An empty label selector\nmatches all namespaces. A null label selector matches the current\nnamespace only.\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -7588,7 +7589,7 @@ "x-kubernetes-map-type": "atomic" }, "scrapeConfigSelector": { - "description": "ScrapeConfigs to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level.", + "description": "scrapeConfigSelector defines the scrapeConfigs to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -7633,18 +7634,18 @@ "x-kubernetes-map-type": "atomic" }, "scrapeFailureLogFile": { - "description": "File to which scrape failures are logged.\nReloading the configuration will reopen the file.\n\nIf the filename has an empty path, e.g. 'file.log', The Prometheus Pods\nwill mount the file into an emptyDir volume at `/var/log/prometheus`.\nIf a full path is provided, e.g. '/var/log/prometheus/file.log', you\nmust mount a volume in the specified directory and it must be writable.\nIt requires Prometheus >= v2.55.0.", + "description": "scrapeFailureLogFile defines the file to which scrape failures are logged.\nReloading the configuration will reopen the file.\n\nIf the filename has an empty path, e.g. 'file.log', The Prometheus Pods\nwill mount the file into an emptyDir volume at `/var/log/prometheus`.\nIf a full path is provided, e.g. '/var/log/prometheus/file.log', you\nmust mount a volume in the specified directory and it must be writable.\nIt requires Prometheus >= v2.55.0.", "minLength": 1, "type": "string" }, "scrapeInterval": { "default": "30s", - "description": "Interval between consecutive scrapes.\n\nDefault: \"30s\"", + "description": "scrapeInterval defines interval between consecutive scrapes.\n\nDefault: \"30s\"", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "scrapeProtocols": { - "description": "The protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0.\n\n`PrometheusText1.0.0` requires Prometheus >= v3.0.0.", + "description": "scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0.\n\n`PrometheusText1.0.0` requires Prometheus >= v3.0.0.", "items": { "description": "ScrapeProtocol represents a protocol used by Prometheus for scraping metrics.\nSupported values are:\n* `OpenMetricsText0.0.1`\n* `OpenMetricsText1.0.0`\n* `PrometheusProto`\n* `PrometheusText0.0.4`\n* `PrometheusText1.0.0`", "enum": [ @@ -7660,12 +7661,12 @@ "x-kubernetes-list-type": "set" }, "scrapeTimeout": { - "description": "Number of seconds to wait until a scrape request times out.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.", + "description": "scrapeTimeout defines the number of seconds to wait until a scrape request times out.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "secrets": { - "description": "Secrets is a list of Secrets in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach Secret is added to the StatefulSet definition as a volume named `secret-`.\nThe Secrets are mounted into /etc/prometheus/secrets/ in the 'prometheus' container.", + "description": "secrets defines a list of Secrets in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach Secret is added to the StatefulSet definition as a volume named `secret-`.\nThe Secrets are mounted into /etc/prometheus/secrets/ in the 'prometheus' container.", "items": { "type": "string" }, @@ -7673,7 +7674,7 @@ "x-kubernetes-list-type": "set" }, "securityContext": { - "description": "SecurityContext holds pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext.", + "description": "securityContext holds pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext.", "properties": { "appArmorProfile": { "description": "appArmorProfile is the AppArmor options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.", @@ -7820,11 +7821,11 @@ "type": "object" }, "serviceAccountName": { - "description": "ServiceAccountName is the name of the ServiceAccount to use to run the\nPrometheus Pods.", + "description": "serviceAccountName is the name of the ServiceAccount to use to run the\nPrometheus Pods.", "type": "string" }, "serviceDiscoveryRole": { - "description": "Defines the service discovery role used to discover targets from\n`ServiceMonitor` objects and Alertmanager endpoints.\n\nIf set, the value should be either \"Endpoints\" or \"EndpointSlice\".\nIf unset, the operator assumes the \"Endpoints\" role.", + "description": "serviceDiscoveryRole defines the service discovery role used to discover targets from\n`ServiceMonitor` objects and Alertmanager endpoints.\n\nIf set, the value should be either \"Endpoints\" or \"EndpointSlice\".\nIf unset, the operator assumes the \"Endpoints\" role.", "enum": [ "Endpoints", "EndpointSlice" @@ -7832,7 +7833,7 @@ "type": "string" }, "serviceMonitorNamespaceSelector": { - "description": "Namespaces to match for ServicedMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only.", + "description": "serviceMonitorNamespaceSelector defines the namespaces to match for ServicedMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -7877,7 +7878,7 @@ "x-kubernetes-map-type": "atomic" }, "serviceMonitorSelector": { - "description": "ServiceMonitors to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", + "description": "serviceMonitorSelector defines the serviceMonitors to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -7922,22 +7923,22 @@ "x-kubernetes-map-type": "atomic" }, "serviceName": { - "description": "The name of the service name used by the underlying StatefulSet(s) as the governing service.\nIf defined, the Service must be created before the Prometheus/PrometheusAgent resource in the same namespace and it must define a selector that matches the pod labels.\nIf empty, the operator will create and manage a headless service named `prometheus-operated` for Prometheus resources,\nor `prometheus-agent-operated` for PrometheusAgent resources.\nWhen deploying multiple Prometheus/PrometheusAgent resources in the same namespace, it is recommended to specify a different value for each.\nSee https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details.", + "description": "serviceName defines the name of the service name used by the underlying StatefulSet(s) as the governing service.\nIf defined, the Service must be created before the Prometheus/PrometheusAgent resource in the same namespace and it must define a selector that matches the pod labels.\nIf empty, the operator will create and manage a headless service named `prometheus-operated` for Prometheus resources,\nor `prometheus-agent-operated` for PrometheusAgent resources.\nWhen deploying multiple Prometheus/PrometheusAgent resources in the same namespace, it is recommended to specify a different value for each.\nSee https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details.", "minLength": 1, "type": "string" }, "sha": { - "description": "Deprecated: use 'spec.image' instead. The image's digest can be specified as part of the image name.", + "description": "sha is deprecated: use 'spec.image' instead. The image's digest can be specified as part of the image name.", "type": "string" }, "shardRetentionPolicy": { - "description": "ShardRetentionPolicy defines the retention policy for the Prometheus shards.\n(Alpha) Using this field requires the 'PrometheusShardRetentionPolicy' feature gate to be enabled.\n\nThe final goals for this feature can be seen at https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/proposals/202310-shard-autoscaling.md#graceful-scale-down-of-prometheus-servers,\nhowever, the feature is not yet fully implemented in this PR. The limitation being:\n* Retention duration is not settable, for now, shards are retained forever.", + "description": "shardRetentionPolicy defines the retention policy for the Prometheus shards.\n(Alpha) Using this field requires the 'PrometheusShardRetentionPolicy' feature gate to be enabled.\n\nThe final goals for this feature can be seen at https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/proposals/202310-shard-autoscaling.md#graceful-scale-down-of-prometheus-servers,\nhowever, the feature is not yet fully implemented in this PR. The limitation being:\n* Retention duration is not settable, for now, shards are retained forever.", "properties": { "retain": { - "description": "Defines the config for retention when the retention policy is set to `Retain`.\nThis field is ineffective as of now.", + "description": "retain defines the config for retention when the retention policy is set to `Retain`.\nThis field is ineffective as of now.", "properties": { "retentionPeriod": { - "description": "Duration is a valid time duration that can be parsed by Prometheus model.ParseDuration() function.\nSupported units: y, w, d, h, m, s, ms\nExamples: `30s`, `1m`, `1h20m15s`, `15d`", + "description": "retentionPeriod defines the retentionPeriod for shard retention policy.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" } @@ -7948,7 +7949,7 @@ "type": "object" }, "whenScaled": { - "description": "Defines the retention policy when the Prometheus shards are scaled down.\n* `Delete`, the operator will delete the pods from the scaled-down shard(s).\n* `Retain`, the operator will keep the pods from the scaled-down shard(s), so the data can still be queried.\n\nIf not defined, the operator assumes the `Delete` value.", + "description": "whenScaled defines the retention policy when the Prometheus shards are scaled down.\n* `Delete`, the operator will delete the pods from the scaled-down shard(s).\n* `Retain`, the operator will keep the pods from the scaled-down shard(s), so the data can still be queried.\n\nIf not defined, the operator assumes the `Delete` value.", "enum": [ "Retain", "Delete" @@ -7959,19 +7960,19 @@ "type": "object" }, "shards": { - "description": "Number of shards to distribute the scraped targets onto.\n\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\nbeing created.\n\nWhen not defined, the operator assumes only one shard.\n\nNote that scaling down shards will not reshard data onto the remaining\ninstances, it must be manually moved. Increasing shards will not reshard\ndata either but it will continue to be available from the same\ninstances. To query globally, use either\n* Thanos sidecar + querier for query federation and Thanos Ruler for rules.\n* Remote-write to send metrics to a central location.\n\nBy default, the sharding of targets is performed on:\n* The `__address__` target's metadata label for PodMonitor,\nServiceMonitor and ScrapeConfig resources.\n* The `__param_target__` label for Probe resources.\n\nUsers can define their own sharding implementation by setting the\n`__tmp_hash` label during the target discovery with relabeling\nconfiguration (either in the monitoring resources or via scrape class).\n\nYou can also disable sharding on a specific target by setting the\n`__tmp_disable_sharding` label with relabeling configuration. When\nthe label value isn't empty, all Prometheus shards will scrape the target.", + "description": "shards defines the number of shards to distribute the scraped targets onto.\n\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\nbeing created.\n\nWhen not defined, the operator assumes only one shard.\n\nNote that scaling down shards will not reshard data onto the remaining\ninstances, it must be manually moved. Increasing shards will not reshard\ndata either but it will continue to be available from the same\ninstances. To query globally, use either\n* Thanos sidecar + querier for query federation and Thanos Ruler for rules.\n* Remote-write to send metrics to a central location.\n\nBy default, the sharding of targets is performed on:\n* The `__address__` target's metadata label for PodMonitor,\nServiceMonitor and ScrapeConfig resources.\n* The `__param_target__` label for Probe resources.\n\nUsers can define their own sharding implementation by setting the\n`__tmp_hash` label during the target discovery with relabeling\nconfiguration (either in the monitoring resources or via scrape class).\n\nYou can also disable sharding on a specific target by setting the\n`__tmp_disable_sharding` label with relabeling configuration. When\nthe label value isn't empty, all Prometheus shards will scrape the target.", "format": "int32", "type": "integer" }, "storage": { - "description": "Storage defines the storage used by Prometheus.", + "description": "storage defines the storage used by Prometheus.", "properties": { "disableMountSubPath": { - "description": "Deprecated: subPath usage will be removed in a future release.", + "description": "disableMountSubPath deprecated: subPath usage will be removed in a future release.", "type": "boolean" }, "emptyDir": { - "description": "EmptyDirVolumeSource to be used by the StatefulSet.\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir", + "description": "emptyDir to be used by the StatefulSet.\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir", "properties": { "medium": { "description": "medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", @@ -7994,7 +7995,7 @@ "type": "object" }, "ephemeral": { - "description": "EphemeralVolumeSource to be used by the StatefulSet.\nThis is a beta field in k8s 1.21 and GA in 1.15.\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes", + "description": "ephemeral to be used by the StatefulSet.\nThis is a beta field in k8s 1.21 and GA in 1.15.\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes", "properties": { "volumeClaimTemplate": { "description": "Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `-` where\n`` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\nRequired, must not be nil.", @@ -8175,7 +8176,7 @@ "type": "object" }, "volumeClaimTemplate": { - "description": "Defines the PVC spec to be used by the Prometheus StatefulSets.\nThe easiest way to use a volume that cannot be automatically provisioned\nis to use a label selector alongside manually created PersistentVolumes.", + "description": "volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets.\nThe easiest way to use a volume that cannot be automatically provisioned\nis to use a label selector alongside manually created PersistentVolumes.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", @@ -8186,31 +8187,31 @@ "type": "string" }, "metadata": { - "description": "EmbeddedMetadata contains metadata relevant to an EmbeddedResource.", + "description": "metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, - "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", + "description": "annotations defines an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", + "description": "labels define the map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "type": "object" }, "name": { - "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", + "description": "name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", "type": "string" } }, "type": "object" }, "spec": { - "description": "Defines the desired characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", + "description": "spec defines the specification of the characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "properties": { "accessModes": { "description": "accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", @@ -8372,7 +8373,7 @@ "type": "object" }, "status": { - "description": "Deprecated: this field is never set.", + "description": "status is deprecated: this field is never set.", "properties": { "accessModes": { "description": "accessModes contains the actual access modes the volume backing the PVC has.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", @@ -8502,35 +8503,35 @@ "type": "object" }, "tag": { - "description": "Deprecated: use 'spec.image' instead. The image's tag can be specified as part of the image name.", + "description": "tag is deprecated: use 'spec.image' instead. The image's tag can be specified as part of the image name.", "type": "string" }, "targetLimit": { - "description": "TargetLimit defines a limit on the number of scraped targets that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit.", + "description": "targetLimit defines a limit on the number of scraped targets that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit.", "format": "int64", "type": "integer" }, "terminationGracePeriodSeconds": { - "description": "Optional duration in seconds the pod needs to terminate gracefully.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down) which may lead to data corruption.\n\nDefaults to 600 seconds.", + "description": "terminationGracePeriodSeconds defines the optional duration in seconds the pod needs to terminate gracefully.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down) which may lead to data corruption.\n\nDefaults to 600 seconds.", "format": "int64", "minimum": 0, "type": "integer" }, "thanos": { - "description": "Defines the configuration of the optional Thanos sidecar.", + "description": "thanos defines the configuration of the optional Thanos sidecar.", "properties": { "additionalArgs": { - "description": "AdditionalArgs allows setting additional arguments for the Thanos container.\nThe arguments are passed as-is to the Thanos container which may cause issues\nif they are invalid or not supported the given Thanos version.\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged.", + "description": "additionalArgs allows setting additional arguments for the Thanos container.\nThe arguments are passed as-is to the Thanos container which may cause issues\nif they are invalid or not supported the given Thanos version.\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged.", "items": { "description": "Argument as part of the AdditionalArgs list.", "properties": { "name": { - "description": "Name of the argument, e.g. \"scrape.discovery-reload-interval\".", + "description": "name of the argument, e.g. \"scrape.discovery-reload-interval\".", "minLength": 1, "type": "string" }, "value": { - "description": "Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)", + "description": "value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)", "type": "string" } }, @@ -8542,37 +8543,37 @@ "type": "array" }, "baseImage": { - "description": "Deprecated: use 'image' instead.", + "description": "baseImage is deprecated: use 'image' instead.", "type": "string" }, "blockSize": { "default": "2h", - "description": "BlockDuration controls the size of TSDB blocks produced by Prometheus.\nThe default value is 2h to match the upstream Prometheus defaults.\n\nWARNING: Changing the block duration can impact the performance and\nefficiency of the entire Prometheus/Thanos stack due to how it interacts\nwith memory and Thanos compactors. It is recommended to keep this value\nset to a multiple of 120 times your longest scrape or rule interval. For\nexample, 30s * 120 = 1h.", + "description": "blockSize controls the size of TSDB blocks produced by Prometheus.\nThe default value is 2h to match the upstream Prometheus defaults.\n\nWARNING: Changing the block duration can impact the performance and\nefficiency of the entire Prometheus/Thanos stack due to how it interacts\nwith memory and Thanos compactors. It is recommended to keep this value\nset to a multiple of 120 times your longest scrape or rule interval. For\nexample, 30s * 120 = 1h.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "getConfigInterval": { - "description": "How often to retrieve the Prometheus configuration.", + "description": "getConfigInterval defines how often to retrieve the Prometheus configuration.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "getConfigTimeout": { - "description": "Maximum time to wait when retrieving the Prometheus configuration.", + "description": "getConfigTimeout defines the maximum time to wait when retrieving the Prometheus configuration.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "grpcListenLocal": { - "description": "When true, the Thanos sidecar listens on the loopback interface instead\nof the Pod IP's address for the gRPC endpoints.\n\nIt has no effect if `listenLocal` is true.", + "description": "grpcListenLocal defines when true, the Thanos sidecar listens on the loopback interface instead\nof the Pod IP's address for the gRPC endpoints.\n\nIt has no effect if `listenLocal` is true.", "type": "boolean" }, "grpcServerTlsConfig": { - "description": "Configures the TLS parameters for the gRPC server providing the StoreAPI.\n\nNote: Currently only the `caFile`, `certFile`, and `keyFile` fields are supported.", + "description": "grpcServerTlsConfig defines the TLS parameters for the gRPC server providing the StoreAPI.\n\nNote: Currently only the `caFile`, `certFile`, and `keyFile` fields are supported.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8595,7 +8596,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8621,14 +8622,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8651,7 +8652,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8677,19 +8678,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8712,7 +8713,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -8722,7 +8723,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -8732,26 +8733,26 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "httpListenLocal": { - "description": "When true, the Thanos sidecar listens on the loopback interface instead\nof the Pod IP's address for the HTTP endpoints.\n\nIt has no effect if `listenLocal` is true.", + "description": "httpListenLocal when true, the Thanos sidecar listens on the loopback interface instead\nof the Pod IP's address for the HTTP endpoints.\n\nIt has no effect if `listenLocal` is true.", "type": "boolean" }, "image": { - "description": "Container image name for Thanos. If specified, it takes precedence over\nthe `spec.thanos.baseImage`, `spec.thanos.tag` and `spec.thanos.sha`\nfields.\n\nSpecifying `spec.thanos.version` is still necessary to ensure the\nPrometheus Operator knows which version of Thanos is being configured.\n\nIf neither `spec.thanos.image` nor `spec.thanos.baseImage` are defined,\nthe operator will use the latest upstream version of Thanos available at\nthe time when the operator was released.", + "description": "image defines the container image name for Thanos. If specified, it takes precedence over\nthe `spec.thanos.baseImage`, `spec.thanos.tag` and `spec.thanos.sha`\nfields.\n\nSpecifying `spec.thanos.version` is still necessary to ensure the\nPrometheus Operator knows which version of Thanos is being configured.\n\nIf neither `spec.thanos.image` nor `spec.thanos.baseImage` are defined,\nthe operator will use the latest upstream version of Thanos available at\nthe time when the operator was released.", "type": "string" }, "listenLocal": { - "description": "Deprecated: use `grpcListenLocal` and `httpListenLocal` instead.", + "description": "listenLocal is deprecated: use `grpcListenLocal` and `httpListenLocal` instead.", "type": "boolean" }, "logFormat": { - "description": "Log format for the Thanos sidecar.", + "description": "logFormat for the Thanos sidecar.", "enum": [ "", "logfmt", @@ -8760,7 +8761,7 @@ "type": "string" }, "logLevel": { - "description": "Log level for the Thanos sidecar.", + "description": "logLevel for the Thanos sidecar.", "enum": [ "", "debug", @@ -8771,11 +8772,11 @@ "type": "string" }, "minTime": { - "description": "Defines the start of time range limit served by the Thanos sidecar's StoreAPI.\nThe field's value should be a constant time in RFC3339 format or a time\nduration relative to current time, such as -1d or 2h45m. Valid duration\nunits are ms, s, m, h, d, w, y.", + "description": "minTime defines the start of time range limit served by the Thanos sidecar's StoreAPI.\nThe field's value should be a constant time in RFC3339 format or a time\nduration relative to current time, such as -1d or 2h45m. Valid duration\nunits are ms, s, m, h, d, w, y.", "type": "string" }, "objectStorageConfig": { - "description": "Defines the Thanos sidecar's configuration to upload TSDB blocks to object storage.\n\nMore info: https://thanos.io/tip/thanos/storage.md/\n\nobjectStorageConfigFile takes precedence over this field.", + "description": "objectStorageConfig defines the Thanos sidecar's configuration to upload TSDB blocks to object storage.\n\nMore info: https://thanos.io/tip/thanos/storage.md/\n\nobjectStorageConfigFile takes precedence over this field.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8798,16 +8799,16 @@ "x-kubernetes-map-type": "atomic" }, "objectStorageConfigFile": { - "description": "Defines the Thanos sidecar's configuration file to upload TSDB blocks to object storage.\n\nMore info: https://thanos.io/tip/thanos/storage.md/\n\nThis field takes precedence over objectStorageConfig.", + "description": "objectStorageConfigFile defines the Thanos sidecar's configuration file to upload TSDB blocks to object storage.\n\nMore info: https://thanos.io/tip/thanos/storage.md/\n\nThis field takes precedence over objectStorageConfig.", "type": "string" }, "readyTimeout": { - "description": "ReadyTimeout is the maximum time that the Thanos sidecar will wait for\nPrometheus to start.", + "description": "readyTimeout defines the maximum time that the Thanos sidecar will wait for\nPrometheus to start.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "resources": { - "description": "Defines the resources requests and limits of the Thanos sidecar.", + "description": "resources defines the resources requests and limits of the Thanos sidecar.", "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis field depends on the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.", @@ -8870,15 +8871,15 @@ "type": "object" }, "sha": { - "description": "Deprecated: use 'image' instead. The image digest can be specified as part of the image name.", + "description": "sha is deprecated: use 'image' instead. The image digest can be specified as part of the image name.", "type": "string" }, "tag": { - "description": "Deprecated: use 'image' instead. The image's tag can be specified as as part of the image name.", + "description": "tag is deprecated: use 'image' instead. The image's tag can be specified as as part of the image name.", "type": "string" }, "tracingConfig": { - "description": "Defines the tracing configuration for the Thanos sidecar.\n\n`tracingConfigFile` takes precedence over this field.\n\nMore info: https://thanos.io/tip/thanos/tracing.md/\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", + "description": "tracingConfig defines the tracing configuration for the Thanos sidecar.\n\n`tracingConfigFile` takes precedence over this field.\n\nMore info: https://thanos.io/tip/thanos/tracing.md/\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8901,15 +8902,15 @@ "x-kubernetes-map-type": "atomic" }, "tracingConfigFile": { - "description": "Defines the tracing configuration file for the Thanos sidecar.\n\nThis field takes precedence over `tracingConfig`.\n\nMore info: https://thanos.io/tip/thanos/tracing.md/\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", + "description": "tracingConfigFile defines the tracing configuration file for the Thanos sidecar.\n\nThis field takes precedence over `tracingConfig`.\n\nMore info: https://thanos.io/tip/thanos/tracing.md/\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "type": "string" }, "version": { - "description": "Version of Thanos being deployed. The operator uses this information\nto generate the Prometheus StatefulSet + configuration files.\n\nIf not specified, the operator assumes the latest upstream release of\nThanos available at the time when the version of the operator was\nreleased.", + "description": "version of Thanos being deployed. The operator uses this information\nto generate the Prometheus StatefulSet + configuration files.\n\nIf not specified, the operator assumes the latest upstream release of\nThanos available at the time when the version of the operator was\nreleased.", "type": "string" }, "volumeMounts": { - "description": "VolumeMounts allows configuration of additional VolumeMounts for Thanos.\nVolumeMounts specified will be appended to other VolumeMounts in the\n'thanos-sidecar' container.", + "description": "volumeMounts allows configuration of additional VolumeMounts for Thanos.\nVolumeMounts specified will be appended to other VolumeMounts in the\n'thanos-sidecar' container.", "items": { "description": "VolumeMount describes a mounting of a Volume within a container.", "properties": { @@ -8954,7 +8955,7 @@ "type": "object" }, "tolerations": { - "description": "Defines the Pods' tolerations if specified.", + "description": "tolerations defines the Pods' tolerations if specified.", "items": { "description": "The pod this Toleration is attached to tolerates any taint that matches\nthe triple using the matching operator .", "properties": { @@ -8985,11 +8986,11 @@ "type": "array" }, "topologySpreadConstraints": { - "description": "Defines the pod's topology spread constraints if specified.", + "description": "topologySpreadConstraints defines the pod's topology spread constraints if specified.", "items": { "properties": { "additionalLabelSelectors": { - "description": "Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint.", + "description": "additionalLabelSelectors Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint.", "enum": [ "OnResource", "OnShard" @@ -9086,10 +9087,10 @@ "type": "array" }, "tracingConfig": { - "description": "TracingConfig configures tracing in Prometheus.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", + "description": "tracingConfig defines tracing in Prometheus.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "properties": { "clientType": { - "description": "Client used to export the traces. Supported values are `http` or `grpc`.", + "description": "clientType defines the client used to export the traces. Supported values are `http` or `grpc`.", "enum": [ "http", "grpc" @@ -9097,14 +9098,14 @@ "type": "string" }, "compression": { - "description": "Compression key for supported compression types. The only supported value is `gzip`.", + "description": "compression key for supported compression types. The only supported value is `gzip`.", "enum": [ "gzip" ], "type": "string" }, "endpoint": { - "description": "Endpoint to send the traces to. Should be provided in format :.", + "description": "endpoint to send the traces to. Should be provided in format :.", "minLength": 1, "type": "string" }, @@ -9112,11 +9113,11 @@ "additionalProperties": { "type": "string" }, - "description": "Key-value pairs to be used as headers associated with gRPC or HTTP requests.", + "description": "headers defines the key-value pairs to be used as headers associated with gRPC or HTTP requests.", "type": "object" }, "insecure": { - "description": "If disabled, the client will use a secure connection.", + "description": "insecure if disabled, the client will use a secure connection.", "type": "boolean" }, "samplingFraction": { @@ -9128,23 +9129,23 @@ "type": "string" } ], - "description": "Sets the probability a given trace will be sampled. Must be a float from 0 through 1.", + "description": "samplingFraction defines the probability a given trace will be sampled. Must be a float from 0 through 1.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "timeout": { - "description": "Maximum time the exporter will wait for each batch export.", + "description": "timeout defines the maximum time the exporter will wait for each batch export.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "tlsConfig": { - "description": "TLS Config to use when sending traces.", + "description": "tlsConfig to use when sending traces.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9167,7 +9168,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9193,14 +9194,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9223,7 +9224,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9249,19 +9250,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9284,7 +9285,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -9294,7 +9295,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -9304,7 +9305,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -9317,10 +9318,10 @@ "type": "object" }, "tsdb": { - "description": "Defines the runtime reloadable configuration of the timeseries database(TSDB).\nIt requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0.", + "description": "tsdb defines the runtime reloadable configuration of the timeseries database(TSDB).\nIt requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0.", "properties": { "outOfOrderTimeWindow": { - "description": "Configures how old an out-of-order/out-of-bounds sample can be with\nrespect to the TSDB max time.\n\nAn out-of-order/out-of-bounds sample is ingested into the TSDB as long as\nthe timestamp of the sample is >= (TSDB.MaxTime - outOfOrderTimeWindow).\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.\n\nIt requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0.", + "description": "outOfOrderTimeWindow defines how old an out-of-order/out-of-bounds sample can be with\nrespect to the TSDB max time.\n\nAn out-of-order/out-of-bounds sample is ingested into the TSDB as long as\nthe timestamp of the sample is >= (TSDB.MaxTime - outOfOrderTimeWindow).\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.\n\nIt requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" } @@ -9328,11 +9329,11 @@ "type": "object" }, "version": { - "description": "Version of Prometheus being deployed. The operator uses this information\nto generate the Prometheus StatefulSet + configuration files.\n\nIf not specified, the operator assumes the latest upstream version of\nPrometheus available at the time when the version of the operator was\nreleased.", + "description": "version of Prometheus being deployed. The operator uses this information\nto generate the Prometheus StatefulSet + configuration files.\n\nIf not specified, the operator assumes the latest upstream version of\nPrometheus available at the time when the version of the operator was\nreleased.", "type": "string" }, "volumeMounts": { - "description": "VolumeMounts allows the configuration of additional VolumeMounts.\n\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\ncontainer, that are generated as a result of StorageSpec objects.", + "description": "volumeMounts allows the configuration of additional VolumeMounts.\n\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\ncontainer, that are generated as a result of StorageSpec objects.", "items": { "description": "VolumeMount describes a mounting of a Volume within a container.", "properties": { @@ -9374,7 +9375,7 @@ "type": "array" }, "volumes": { - "description": "Volumes allows the configuration of additional volumes on the output\nStatefulSet definition. Volumes specified will be appended to other\nvolumes that are generated as a result of StorageSpec objects.", + "description": "volumes allows the configuration of additional volumes on the output\nStatefulSet definition. Volumes specified will be appended to other\nvolumes that are generated as a result of StorageSpec objects.", "items": { "description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.", "properties": { @@ -10837,28 +10838,28 @@ "type": "array" }, "walCompression": { - "description": "Configures compression of the write-ahead log (WAL) using Snappy.\n\nWAL compression is enabled by default for Prometheus >= 2.20.0\n\nRequires Prometheus v2.11.0 and above.", + "description": "walCompression defines the compression of the write-ahead log (WAL) using Snappy.\n\nWAL compression is enabled by default for Prometheus >= 2.20.0\n\nRequires Prometheus v2.11.0 and above.", "type": "boolean" }, "web": { - "description": "Defines the configuration of the Prometheus web server.", + "description": "web defines the configuration of the Prometheus web server.", "properties": { "httpConfig": { - "description": "Defines HTTP parameters for web server.", + "description": "httpConfig defines HTTP parameters for web server.", "properties": { "headers": { - "description": "List of headers that can be added to HTTP responses.", + "description": "headers defines a list of headers that can be added to HTTP responses.", "properties": { "contentSecurityPolicy": { - "description": "Set the Content-Security-Policy header to HTTP responses.\nUnset if blank.", + "description": "contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses.\nUnset if blank.", "type": "string" }, "strictTransportSecurity": { - "description": "Set the Strict-Transport-Security header to HTTP responses.\nUnset if blank.\nPlease make sure that you use this with care as this header might force\nbrowsers to load Prometheus and the other applications hosted on the same\ndomain and subdomains over HTTPS.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security", + "description": "strictTransportSecurity defines the Strict-Transport-Security header to HTTP responses.\nUnset if blank.\nPlease make sure that you use this with care as this header might force\nbrowsers to load Prometheus and the other applications hosted on the same\ndomain and subdomains over HTTPS.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security", "type": "string" }, "xContentTypeOptions": { - "description": "Set the X-Content-Type-Options header to HTTP responses.\nUnset if blank. Accepted value is nosniff.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options", + "description": "xContentTypeOptions defines the X-Content-Type-Options header to HTTP responses.\nUnset if blank. Accepted value is nosniff.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options", "enum": [ "", "NoSniff" @@ -10866,7 +10867,7 @@ "type": "string" }, "xFrameOptions": { - "description": "Set the X-Frame-Options header to HTTP responses.\nUnset if blank. Accepted values are deny and sameorigin.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options", + "description": "xFrameOptions defines the X-Frame-Options header to HTTP responses.\nUnset if blank. Accepted values are deny and sameorigin.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options", "enum": [ "", "Deny", @@ -10875,37 +10876,37 @@ "type": "string" }, "xXSSProtection": { - "description": "Set the X-XSS-Protection header to all responses.\nUnset if blank.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection", + "description": "xXSSProtection defines the X-XSS-Protection header to all responses.\nUnset if blank.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection", "type": "string" } }, "type": "object" }, "http2": { - "description": "Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\nWhenever the value of the field changes, a rolling update will be triggered.", + "description": "http2 enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\nWhenever the value of the field changes, a rolling update will be triggered.", "type": "boolean" } }, "type": "object" }, "maxConnections": { - "description": "Defines the maximum number of simultaneous connections\nA zero value means that Prometheus doesn't accept any incoming connection.", + "description": "maxConnections defines the maximum number of simultaneous connections\nA zero value means that Prometheus doesn't accept any incoming connection.", "format": "int32", "minimum": 0, "type": "integer" }, "pageTitle": { - "description": "The prometheus web page title.", + "description": "pageTitle defines the prometheus web page title.", "type": "string" }, "tlsConfig": { - "description": "Defines the TLS parameters for HTTPS.", + "description": "tlsConfig defines the TLS parameters for HTTPS.", "properties": { "cert": { - "description": "Secret or ConfigMap containing the TLS certificate for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `certFile`.", + "description": "cert defines the Secret or ConfigMap containing the TLS certificate for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `certFile`.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10928,7 +10929,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10954,29 +10955,29 @@ "type": "object" }, "certFile": { - "description": "Path to the TLS certificate file in the container for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `cert`.", + "description": "certFile defines the path to the TLS certificate file in the container for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `cert`.", "type": "string" }, "cipherSuites": { - "description": "List of supported cipher suites for TLS versions up to TLS 1.2.\n\nIf not defined, the Go default cipher suites are used.\nAvailable cipher suites are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#pkg-constants", + "description": "cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2.\n\nIf not defined, the Go default cipher suites are used.\nAvailable cipher suites are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#pkg-constants", "items": { "type": "string" }, "type": "array" }, "clientAuthType": { - "description": "The server policy for client TLS authentication.\n\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType", + "description": "clientAuthType defines the server policy for client TLS authentication.\n\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType", "type": "string" }, "clientCAFile": { - "description": "Path to the CA certificate file for client certificate authentication to\nthe server.\n\nIt is mutually exclusive with `client_ca`.", + "description": "clientCAFile defines the path to the CA certificate file for client certificate authentication to\nthe server.\n\nIt is mutually exclusive with `client_ca`.", "type": "string" }, "client_ca": { - "description": "Secret or ConfigMap containing the CA certificate for client certificate\nauthentication to the server.\n\nIt is mutually exclusive with `clientCAFile`.", + "description": "client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate\nauthentication to the server.\n\nIt is mutually exclusive with `clientCAFile`.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10999,7 +11000,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -11025,18 +11026,18 @@ "type": "object" }, "curvePreferences": { - "description": "Elliptic curves that will be used in an ECDHE handshake, in preference\norder.\n\nAvailable curves are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID", + "description": "curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference\norder.\n\nAvailable curves are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID", "items": { "type": "string" }, "type": "array" }, "keyFile": { - "description": "Path to the TLS private key file in the container for the web server.\n\nIf defined, either `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keySecret`.", + "description": "keyFile defines the path to the TLS private key file in the container for the web server.\n\nIf defined, either `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keySecret`.", "type": "string" }, "keySecret": { - "description": "Secret containing the TLS private key for the web server.\n\nEither `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keyFile`.", + "description": "keySecret defines the secret containing the TLS private key for the web server.\n\nEither `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keyFile`.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -11059,15 +11060,15 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum TLS version that is acceptable.", + "description": "maxVersion defines the Maximum TLS version that is acceptable.", "type": "string" }, "minVersion": { - "description": "Minimum TLS version that is acceptable.", + "description": "minVersion defines the minimum TLS version that is acceptable.", "type": "string" }, "preferServerCipherSuites": { - "description": "Controls whether the server selects the client's most preferred cipher\nsuite, or the server's most preferred cipher suite.\n\nIf true then the server's preference, as expressed in\nthe order of elements in cipherSuites, is used.", + "description": "preferServerCipherSuites defines whether the server selects the client's most preferred cipher\nsuite, or the server's most preferred cipher suite.\n\nIf true then the server's preference, as expressed in\nthe order of elements in cipherSuites, is used.", "type": "boolean" } }, @@ -11080,15 +11081,15 @@ "type": "object" }, "status": { - "description": "Most recent observed status of the Prometheus cluster. Read-only.\nMore info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", + "description": "status defines the most recent observed status of the Prometheus cluster. Read-only.\nMore info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "availableReplicas": { - "description": "Total number of available pods (ready for at least minReadySeconds)\ntargeted by this Prometheus deployment.", + "description": "availableReplicas defines the total number of available pods (ready for at least minReadySeconds)\ntargeted by this Prometheus deployment.", "format": "int32", "type": "integer" }, "conditions": { - "description": "The current state of the Prometheus deployment.", + "description": "conditions defines the current state of the Prometheus deployment.", "items": { "description": "Condition represents the state of the resources associated with the\nPrometheus, Alertmanager or ThanosRuler resource.", "properties": { @@ -11098,25 +11099,25 @@ "type": "string" }, "message": { - "description": "Human-readable message indicating details for the condition's last transition.", + "description": "message defines human-readable message indicating details for the condition's last transition.", "type": "string" }, "observedGeneration": { - "description": "ObservedGeneration represents the .metadata.generation that the\ncondition was set based upon. For instance, if `.metadata.generation` is\ncurrently 12, but the `.status.conditions[].observedGeneration` is 9, the\ncondition is out of date with respect to the current state of the\ninstance.", + "description": "observedGeneration defines the .metadata.generation that the\ncondition was set based upon. For instance, if `.metadata.generation` is\ncurrently 12, but the `.status.conditions[].observedGeneration` is 9, the\ncondition is out of date with respect to the current state of the\ninstance.", "format": "int64", "type": "integer" }, "reason": { - "description": "Reason for the condition's last transition.", + "description": "reason for the condition's last transition.", "type": "string" }, "status": { - "description": "Status of the condition.", + "description": "status of the condition.", "minLength": 1, "type": "string" }, "type": { - "description": "Type of the condition being reported.", + "description": "type of the condition being reported.", "minLength": 1, "type": "string" } @@ -11135,43 +11136,43 @@ "x-kubernetes-list-type": "map" }, "paused": { - "description": "Represents whether any actions on the underlying managed objects are\nbeing performed. Only delete actions will be performed.", + "description": "paused defines whether any actions on the underlying managed objects are\nbeing performed. Only delete actions will be performed.", "type": "boolean" }, "replicas": { - "description": "Total number of non-terminated pods targeted by this Prometheus deployment\n(their labels match the selector).", + "description": "replicas defines the total number of non-terminated pods targeted by this Prometheus deployment\n(their labels match the selector).", "format": "int32", "type": "integer" }, "selector": { - "description": "The selector used to match the pods targeted by this Prometheus resource.", + "description": "selector used to match the pods targeted by this Prometheus resource.", "type": "string" }, "shardStatuses": { - "description": "The list has one entry per shard. Each entry provides a summary of the shard status.", + "description": "shardStatuses defines the list has one entry per shard. Each entry provides a summary of the shard status.", "items": { "properties": { "availableReplicas": { - "description": "Total number of available pods (ready for at least minReadySeconds)\ntargeted by this shard.", + "description": "availableReplicas defines the total number of available pods (ready for at least minReadySeconds)\ntargeted by this shard.", "format": "int32", "type": "integer" }, "replicas": { - "description": "Total number of pods targeted by this shard.", + "description": "replicas defines the total number of pods targeted by this shard.", "format": "int32", "type": "integer" }, "shardID": { - "description": "Identifier of the shard.", + "description": "shardID defines the identifier of the shard.", "type": "string" }, "unavailableReplicas": { - "description": "Total number of unavailable pods targeted by this shard.", + "description": "unavailableReplicas defines the Total number of unavailable pods targeted by this shard.", "format": "int32", "type": "integer" }, "updatedReplicas": { - "description": "Total number of non-terminated pods targeted by this shard\nthat have the desired spec.", + "description": "updatedReplicas defines the total number of non-terminated pods targeted by this shard\nthat have the desired spec.", "format": "int32", "type": "integer" } @@ -11192,28 +11193,21 @@ "x-kubernetes-list-type": "map" }, "shards": { - "description": "Shards is the most recently observed number of shards.", + "description": "shards defines the most recently observed number of shards.", "format": "int32", "type": "integer" }, "unavailableReplicas": { - "description": "Total number of unavailable pods targeted by this Prometheus deployment.", + "description": "unavailableReplicas defines the total number of unavailable pods targeted by this Prometheus deployment.", "format": "int32", "type": "integer" }, "updatedReplicas": { - "description": "Total number of non-terminated pods targeted by this Prometheus deployment\nthat have the desired version spec.", + "description": "updatedReplicas defines the total number of non-terminated pods targeted by this Prometheus deployment\nthat have the desired version spec.", "format": "int32", "type": "integer" } }, - "required": [ - "availableReplicas", - "paused", - "replicas", - "unavailableReplicas", - "updatedReplicas" - ], "type": "object" } }, diff --git a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/prometheusrules-crd.json b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/prometheusrules-crd.json index aa8e52b3..6760b4b4 100644 --- a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/prometheusrules-crd.json +++ b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/prometheusrules-crd.json @@ -3,7 +3,7 @@ "kind": "CustomResourceDefinition", "metadata": { "annotations": { - "controller-gen.kubebuilder.io/version": "v0.18.0", + "controller-gen.kubebuilder.io/version": "v0.19.0", "operator.prometheus.io/version": "0.85.0" }, "name": "prometheusrules.monitoring.coreos.com" @@ -42,15 +42,15 @@ "type": "object" }, "spec": { - "description": "Specification of desired alerting rule definitions for Prometheus.", + "description": "spec defines the specification of desired alerting rule definitions for Prometheus.", "properties": { "groups": { - "description": "Content of Prometheus rule file", + "description": "groups defines the content of Prometheus rule file", "items": { "description": "RuleGroup is a list of sequentially evaluated recording and alerting rules.", "properties": { "interval": { - "description": "Interval determines how often rules in the group are evaluated.", + "description": "interval defines how often rules in the group are evaluated.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, @@ -58,42 +58,42 @@ "additionalProperties": { "type": "string" }, - "description": "Labels to add or overwrite before storing the result for its rules.\nThe labels defined at the rule level take precedence.\n\nIt requires Prometheus >= 3.0.0.\nThe field is ignored for Thanos Ruler.", + "description": "labels define the labels to add or overwrite before storing the result for its rules.\nThe labels defined at the rule level take precedence.\n\nIt requires Prometheus >= 3.0.0.\nThe field is ignored for Thanos Ruler.", "type": "object" }, "limit": { - "description": "Limit the number of alerts an alerting rule and series a recording\nrule can produce.\nLimit is supported starting with Prometheus >= 2.31 and Thanos Ruler >= 0.24.", + "description": "limit defines the number of alerts an alerting rule and series a recording\nrule can produce.\nLimit is supported starting with Prometheus >= 2.31 and Thanos Ruler >= 0.24.", "type": "integer" }, "name": { - "description": "Name of the rule group.", + "description": "name defines the name of the rule group.", "minLength": 1, "type": "string" }, "partial_response_strategy": { - "description": "PartialResponseStrategy is only used by ThanosRuler and will\nbe ignored by Prometheus instances.\nMore info: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response", + "description": "partial_response_strategy is only used by ThanosRuler and will\nbe ignored by Prometheus instances.\nMore info: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response", "pattern": "^(?i)(abort|warn)?$", "type": "string" }, "query_offset": { - "description": "Defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past.\n\nIt requires Prometheus >= v2.53.0.\nIt is not supported for ThanosRuler.", + "description": "query_offset defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past.\n\nIt requires Prometheus >= v2.53.0.\nIt is not supported for ThanosRuler.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "rules": { - "description": "List of alerting and recording rules.", + "description": "rules defines the list of alerting and recording rules.", "items": { "description": "Rule describes an alerting or recording rule\nSee Prometheus documentation: [alerting](https://www.prometheus.io/docs/prometheus/latest/configuration/alerting_rules/) or [recording](https://www.prometheus.io/docs/prometheus/latest/configuration/recording_rules/#recording-rules) rule", "properties": { "alert": { - "description": "Name of the alert. Must be a valid label value.\nOnly one of `record` and `alert` must be set.", + "description": "alert defines the name of the alert. Must be a valid label value.\nOnly one of `record` and `alert` must be set.", "type": "string" }, "annotations": { "additionalProperties": { "type": "string" }, - "description": "Annotations to add to each alert.\nOnly valid for alerting rules.", + "description": "annotations defines annotations to add to each alert.\nOnly valid for alerting rules.", "type": "object" }, "expr": { @@ -105,16 +105,16 @@ "type": "string" } ], - "description": "PromQL expression to evaluate.", + "description": "expr defines the PromQL expression to evaluate.", "x-kubernetes-int-or-string": true }, "for": { - "description": "Alerts are considered firing once they have been returned for this long.", + "description": "for defines how alerts are considered firing once they have been returned for this long.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "keep_firing_for": { - "description": "KeepFiringFor defines how long an alert will continue firing after the condition that triggered it has cleared.", + "description": "keep_firing_for defines how long an alert will continue firing after the condition that triggered it has cleared.", "minLength": 1, "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" @@ -123,11 +123,11 @@ "additionalProperties": { "type": "string" }, - "description": "Labels to add or overwrite.", + "description": "labels defines labels to add or overwrite.", "type": "object" }, "record": { - "description": "Name of the time series to output to. Must be a valid metric name.\nOnly one of `record` and `alert` must be set.", + "description": "record defines the name of the time series to output to. Must be a valid metric name.\nOnly one of `record` and `alert` must be set.", "type": "string" } }, diff --git a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/scrapeconfigs-crd.json b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/scrapeconfigs-crd.json index 72196458..a7bfef6f 100644 --- a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/scrapeconfigs-crd.json +++ b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/scrapeconfigs-crd.json @@ -3,7 +3,7 @@ "kind": "CustomResourceDefinition", "metadata": { "annotations": { - "controller-gen.kubebuilder.io/version": "v0.18.0", + "controller-gen.kubebuilder.io/version": "v0.19.0", "operator.prometheus.io/version": "0.85.0" }, "name": "scrapeconfigs.monitoring.coreos.com" @@ -42,13 +42,13 @@ "type": "object" }, "spec": { - "description": "ScrapeConfigSpec is a specification of the desired configuration for a scrape configuration.", + "description": "spec defines the specification of ScrapeConfigSpec.", "properties": { "authorization": { - "description": "Authorization header to use on every scrape request.", + "description": "authorization defines the header to use on every scrape request.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -71,19 +71,19 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "azureSDConfigs": { - "description": "AzureSDConfigs defines a list of Azure service discovery configurations.", + "description": "azureSDConfigs defines a list of Azure service discovery configurations.", "items": { "description": "AzureSDConfig allow retrieving scrape targets from Azure VMs.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#azure_sd_config", "properties": { "authenticationMethod": { - "description": "# The authentication method, either `OAuth` or `ManagedIdentity` or `SDK`.\nSee https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview\nSDK authentication method uses environment variables by default.\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication", + "description": "authenticationMethod defines the authentication method, either `OAuth` or `ManagedIdentity` or `SDK`.\nSee https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview\nSDK authentication method uses environment variables by default.\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication", "enum": [ "OAuth", "ManagedIdentity", @@ -92,10 +92,10 @@ "type": "string" }, "authorization": { - "description": "Authorization header configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as `oAuth2`, or `basicAuth`.", + "description": "authorization defines the authorization header configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as `oAuth2`, or `basicAuth`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -118,17 +118,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth information to authenticate against the target HTTP endpoint.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoints\nCannot be set at the same time as `authorization`, or `oAuth2`.", + "description": "basicAuth defines the information to authenticate against the target HTTP endpoint.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoints\nCannot be set at the same time as `authorization`, or `oAuth2`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -151,7 +151,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -177,12 +177,12 @@ "type": "object" }, "clientID": { - "description": "Optional client ID. Only required with the OAuth authentication method.", + "description": "clientID defines client ID. Only required with the OAuth authentication method.", "minLength": 1, "type": "string" }, "clientSecret": { - "description": "Optional client secret. Only required with the OAuth authentication method.", + "description": "clientSecret defines client secret. Only required with the OAuth authentication method.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -205,30 +205,30 @@ "x-kubernetes-map-type": "atomic" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "environment": { - "description": "The Azure environment.", + "description": "environment defines the Azure environment.", "minLength": 1, "type": "string" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as `authorization`, or `basicAuth`.", + "description": "oauth2 defines the configuration to use on every scrape request.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -251,7 +251,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -277,7 +277,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -303,11 +303,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -337,34 +337,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -387,7 +387,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -413,10 +413,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -439,7 +439,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -465,11 +465,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -492,7 +492,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -502,7 +502,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -512,14 +512,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -532,7 +532,7 @@ "type": "object" }, "port": { - "description": "The port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule.", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule.", "format": "int32", "maximum": 65535, "minimum": 0, @@ -565,47 +565,47 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "resourceGroup": { - "description": "Optional resource group name. Limits discovery to this resource group.\nRequires Prometheus v2.35.0 and above", + "description": "resourceGroup defines resource group name. Limits discovery to this resource group.\nRequires Prometheus v2.35.0 and above", "minLength": 1, "type": "string" }, "subscriptionID": { - "description": "The subscription ID. Always required.", + "description": "subscriptionID defines subscription ID. Always required.", "minLength": 1, "type": "string" }, "tenantID": { - "description": "Optional tenant ID. Only required with the OAuth authentication method.", + "description": "tenantID defines tenant ID. Only required with the OAuth authentication method.", "minLength": 1, "type": "string" }, "tlsConfig": { - "description": "TLS configuration applying to the target HTTP endpoint.", + "description": "tlsConfig defies the TLS configuration applying to the target HTTP endpoint.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -628,7 +628,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -654,10 +654,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -680,7 +680,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -706,11 +706,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -733,7 +733,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -743,7 +743,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -753,7 +753,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -768,10 +768,10 @@ "type": "array" }, "basicAuth": { - "description": "BasicAuth information to use on every scrape request.", + "description": "basicAuth defines information to use on every scrape request.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -794,7 +794,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -820,19 +820,19 @@ "type": "object" }, "consulSDConfigs": { - "description": "ConsulSDConfigs defines a list of Consul service discovery configurations.", + "description": "consulSDConfigs defines a list of Consul service discovery configurations.", "items": { "description": "ConsulSDConfig defines a Consul service discovery configuration\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config", "properties": { "allowStale": { - "description": "Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul.\nIf unset, Prometheus uses its default value.", + "description": "allowStale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul.\nIf unset, Prometheus uses its default value.", "type": "boolean" }, "authorization": { - "description": "Optional Authorization header configuration to authenticate against the Consul Server.\nCannot be set at the same time as `basicAuth`, or `oauth2`.", + "description": "authorization defines the header configuration to authenticate against the Consul Server.\nCannot be set at the same time as `basicAuth`, or `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -855,17 +855,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "Optional BasicAuth information to authenticate against the Consul Server.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoints\nCannot be set at the same time as `authorization`, or `oauth2`.", + "description": "basicAuth defines the information to authenticate against the Consul Server.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoints\nCannot be set at the same time as `authorization`, or `oauth2`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -888,7 +888,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -914,48 +914,48 @@ "type": "object" }, "datacenter": { - "description": "Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter.", + "description": "datacenter defines the consul Datacenter name, if not provided it will use the local Consul Agent Datacenter.", "minLength": 1, "type": "string" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.\nIf unset, Prometheus uses its default value.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "filter": { - "description": "Filter expression used to filter the catalog results.\nSee https://www.consul.io/api-docs/catalog#list-services\nIt requires Prometheus >= 3.0.0.", + "description": "filter defines the filter expression used to filter the catalog results.\nSee https://www.consul.io/api-docs/catalog#list-services\nIt requires Prometheus >= 3.0.0.", "minLength": 1, "type": "string" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.\nIf unset, Prometheus uses its default value.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "namespace": { - "description": "Namespaces are only supported in Consul Enterprise.\n\nIt requires Prometheus >= 2.28.0.", + "description": "namespace are only supported in Consul Enterprise.\n\nIt requires Prometheus >= 2.28.0.", "minLength": 1, "type": "string" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "nodeMeta": { "additionalProperties": { "type": "string" }, - "description": "Node metadata key/value pairs to filter nodes for a given service.\nStarting with Consul 1.14, it is recommended to use `filter` with the `NodeMeta` selector instead.", + "description": "nodeMeta defines the node metadata key/value pairs to filter nodes for a given service.\nStarting with Consul 1.14, it is recommended to use `filter` with the `NodeMeta` selector instead.", "type": "object", "x-kubernetes-map-type": "atomic" }, "oauth2": { - "description": "Optional OAuth2.0 configuration.\nCannot be set at the same time as `basicAuth`, or `authorization`.", + "description": "oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as `authorization`, or `basicAuth`.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -978,7 +978,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1004,7 +1004,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1030,11 +1030,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -1064,34 +1064,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1114,7 +1114,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1140,10 +1140,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1166,7 +1166,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1192,11 +1192,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1219,7 +1219,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -1229,7 +1229,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -1239,14 +1239,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -1259,12 +1259,12 @@ "type": "object" }, "partition": { - "description": "Admin Partitions are only supported in Consul Enterprise.", + "description": "partition defines the admin Partitions are only supported in Consul Enterprise.", "minLength": 1, "type": "string" }, "pathPrefix": { - "description": "Prefix for URIs for when consul is behind an API gateway (reverse proxy).\n\nIt requires Prometheus >= 2.45.0.", + "description": "pathPrefix defines the prefix for URIs for when consul is behind an API gateway (reverse proxy).\n\nIt requires Prometheus >= 2.45.0.", "minLength": 1, "type": "string" }, @@ -1295,26 +1295,26 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "The time after which the provided names are refreshed.\nOn large setup it might be a good idea to increase this value because the catalog will change all the time.\nIf unset, Prometheus uses its default value.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "scheme": { - "description": "HTTP Scheme default \"http\"", + "description": "scheme defines the HTTP Scheme default \"http\"", "enum": [ "HTTP", "HTTPS" @@ -1322,12 +1322,12 @@ "type": "string" }, "server": { - "description": "Consul server address. A valid string consisting of a hostname or IP followed by an optional port number.", + "description": "server defines the consul server address. A valid string consisting of a hostname or IP followed by an optional port number.", "minLength": 1, "type": "string" }, "services": { - "description": "A list of services for which targets are retrieved. If omitted, all services are scraped.", + "description": "services defines a list of services for which targets are retrieved. If omitted, all services are scraped.", "items": { "type": "string" }, @@ -1335,12 +1335,12 @@ "x-kubernetes-list-type": "set" }, "tagSeparator": { - "description": "The string by which Consul tags are joined into the tag label.\nIf unset, Prometheus uses its default value.", + "description": "tagSeparator defines the string by which Consul tags are joined into the tag label.\nIf unset, Prometheus uses its default value.", "minLength": 1, "type": "string" }, "tags": { - "description": "An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list.\nStarting with Consul 1.14, it is recommended to use `filter` with the `ServiceTags` selector instead.", + "description": "tags defines an optional list of tags used to filter nodes for a given service. Services must contain all tags in the list.\nStarting with Consul 1.14, it is recommended to use `filter` with the `ServiceTags` selector instead.", "items": { "type": "string" }, @@ -1348,13 +1348,13 @@ "x-kubernetes-list-type": "set" }, "tlsConfig": { - "description": "TLS configuration to connect to the Consul API.", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1377,7 +1377,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1403,10 +1403,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1429,7 +1429,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1455,11 +1455,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1482,7 +1482,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -1492,7 +1492,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -1502,14 +1502,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenRef": { - "description": "Consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent.", + "description": "tokenRef defines the consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1540,19 +1540,19 @@ "type": "array" }, "convertClassicHistogramsToNHCB": { - "description": "Whether to convert all scraped classic histograms into a native histogram with custom buckets.\nIt requires Prometheus >= v3.0.0.", + "description": "convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets.\nIt requires Prometheus >= v3.0.0.", "type": "boolean" }, "digitalOceanSDConfigs": { - "description": "DigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations.", + "description": "digitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations.", "items": { "description": "DigitalOceanSDConfig allow retrieving scrape targets from DigitalOcean's Droplets API.\nThis service discovery uses the public IPv4 address by default, by that can be changed with relabeling\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#digitalocean_sd_config", "properties": { "authorization": { - "description": "Authorization header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as `oauth2`.", + "description": "authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1575,32 +1575,32 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization`.", + "description": "oauth2 defines the configuration to use on every scrape request.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1623,7 +1623,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1649,7 +1649,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1675,11 +1675,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -1709,34 +1709,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1759,7 +1759,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1785,10 +1785,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1811,7 +1811,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1837,11 +1837,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -1864,7 +1864,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -1874,7 +1874,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -1884,14 +1884,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -1904,7 +1904,7 @@ "type": "object" }, "port": { - "description": "The port to scrape metrics from.", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must", "format": "int32", "maximum": 65535, "minimum": 0, @@ -1937,32 +1937,32 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "Refresh interval to re-read the instance list.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration applying to the target HTTP endpoint.", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -1985,7 +1985,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2011,10 +2011,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2037,7 +2037,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2063,11 +2063,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2090,7 +2090,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -2100,7 +2100,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -2110,7 +2110,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -2122,12 +2122,12 @@ "type": "array" }, "dnsSDConfigs": { - "description": "DNSSDConfigs defines a list of DNS service discovery configurations.", + "description": "dnsSDConfigs defines a list of DNS service discovery configurations.", "items": { "description": "DNSSDConfig allows specifying a set of DNS domain names which are periodically queried to discover a list of targets.\nThe DNS servers to be contacted are read from /etc/resolv.conf.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dns_sd_config", "properties": { "names": { - "description": "A list of DNS domain names to be queried.", + "description": "names defines a list of DNS domain names to be queried.", "items": { "minLength": 1, "type": "string" @@ -2136,19 +2136,19 @@ "type": "array" }, "port": { - "description": "The port number used if the query type is not SRV\nIgnored for SRV records", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must\nIgnored for SRV records", "format": "int32", "maximum": 65535, "minimum": 0, "type": "integer" }, "refreshInterval": { - "description": "RefreshInterval configures the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "type": { - "description": "The type of DNS query to perform. One of SRV, A, AAAA, MX or NS.\nIf not set, Prometheus uses its default value.\n\nWhen set to NS, it requires Prometheus >= v2.49.0.\nWhen set to MX, it requires Prometheus >= v2.38.0", + "description": "type defines the type of DNS query to perform. One of SRV, A, AAAA, MX or NS.\nIf not set, Prometheus uses its default value.\n\nWhen set to NS, it requires Prometheus >= v2.49.0.\nWhen set to MX, it requires Prometheus >= v2.38.0", "enum": [ "A", "AAAA", @@ -2167,15 +2167,15 @@ "type": "array" }, "dockerSDConfigs": { - "description": "DockerSDConfigs defines a list of Docker service discovery configurations.", + "description": "dockerSDConfigs defines a list of Docker service discovery configurations.", "items": { "description": "Docker SD configurations allow retrieving scrape targets from Docker Engine hosts.\nThis SD discovers \"containers\" and will create a target for each network IP and\nport the container is configured to expose.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#docker_sd_config", "properties": { "authorization": { - "description": "Authorization header configuration to authenticate against the Docker API.\nCannot be set at the same time as `oauth2`.", + "description": "authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2198,17 +2198,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth information to use on every scrape request.", + "description": "basicAuth defines information to use on every scrape request.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2231,7 +2231,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2257,20 +2257,20 @@ "type": "object" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "filters": { - "description": "Optional filters to limit the discovery process to a subset of the available resources.", + "description": "filters defines filters to limit the discovery process to a subset of the available resources.", "items": { "description": "Filter name and value pairs to limit the discovery process to a subset of available resources.", "properties": { "name": { - "description": "Name of the Filter.", + "description": "name of the Filter.", "type": "string" }, "values": { - "description": "Value to filter on.", + "description": "values defines values to filter on.", "items": { "minLength": 1, "type": "string" @@ -2293,35 +2293,35 @@ "x-kubernetes-list-type": "map" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "host": { - "description": "Address of the docker daemon", + "description": "host defines the address of the docker daemon", "minLength": 1, "type": "string" }, "hostNetworkingHost": { - "description": "The host to use if the container is in host networking mode.", + "description": "hostNetworkingHost defines the host to use if the container is in host networking mode.", "minLength": 1, "type": "string" }, "matchFirstNetwork": { - "description": "Configure whether to match the first network if the container has multiple networks defined.\nIf unset, Prometheus uses true by default.\nIt requires Prometheus >= v2.54.1.", + "description": "matchFirstNetwork defines whether to match the first network if the container has multiple networks defined.\nIf unset, Prometheus uses true by default.\nIt requires Prometheus >= v2.54.1.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization`.", + "description": "oauth2 defines the configuration to use on every scrape request.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2344,7 +2344,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2370,7 +2370,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2396,11 +2396,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -2430,34 +2430,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2480,7 +2480,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2506,10 +2506,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2532,7 +2532,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2558,11 +2558,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2585,7 +2585,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -2595,7 +2595,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -2605,14 +2605,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -2625,7 +2625,7 @@ "type": "object" }, "port": { - "description": "The port to scrape metrics from.", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must", "format": "int32", "maximum": 65535, "minimum": 0, @@ -2658,32 +2658,32 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "Time after which the container is refreshed.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration applying to the target HTTP endpoint.", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2706,7 +2706,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2732,10 +2732,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2758,7 +2758,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2784,11 +2784,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2811,7 +2811,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -2821,7 +2821,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -2831,7 +2831,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -2846,15 +2846,15 @@ "type": "array" }, "dockerSwarmSDConfigs": { - "description": "DockerswarmSDConfigs defines a list of Dockerswarm service discovery configurations.", + "description": "dockerSwarmSDConfigs defines a list of Dockerswarm service discovery configurations.", "items": { "description": "DockerSwarmSDConfig configurations allow retrieving scrape targets from Docker Swarm engine.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#dockerswarm_sd_config", "properties": { "authorization": { - "description": "Authorization header configuration to authenticate against the target HTTP endpoint.", + "description": "authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2877,17 +2877,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "Optional HTTP basic authentication information.", + "description": "basicAuth defines information to use on every scrape request.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2910,7 +2910,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2936,20 +2936,20 @@ "type": "object" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "filters": { - "description": "Optional filters to limit the discovery process to a subset of available\nresources.\nThe available filters are listed in the upstream documentation:\nServices: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList\nTasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList\nNodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList", + "description": "filters defines the filters to limit the discovery process to a subset of available\nresources.\nThe available filters are listed in the upstream documentation:\nServices: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList\nTasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList\nNodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList", "items": { "description": "Filter name and value pairs to limit the discovery process to a subset of available resources.", "properties": { "name": { - "description": "Name of the Filter.", + "description": "name of the Filter.", "type": "string" }, "values": { - "description": "Value to filter on.", + "description": "values defines values to filter on.", "items": { "minLength": 1, "type": "string" @@ -2972,26 +2972,26 @@ "x-kubernetes-list-type": "map" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "host": { - "description": "Address of the Docker daemon", + "description": "host defines the address of the Docker daemon", "pattern": "^[a-zA-Z][a-zA-Z0-9+.-]*://.+$", "type": "string" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization`, or `basicAuth`.", + "description": "oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as `authorization`, or `basicAuth`.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3014,7 +3014,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3040,7 +3040,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3066,11 +3066,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -3100,34 +3100,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3150,7 +3150,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3176,10 +3176,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3202,7 +3202,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3228,11 +3228,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3255,7 +3255,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -3265,7 +3265,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -3275,14 +3275,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -3295,7 +3295,7 @@ "type": "object" }, "port": { - "description": "The port to scrape metrics from, when `role` is nodes, and for discovered\ntasks and services that don't have published ports.", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must\ntasks and services that don't have published ports.", "format": "int32", "maximum": 65535, "minimum": 0, @@ -3328,26 +3328,26 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "The time after which the service discovery data is refreshed.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "role": { - "description": "Role of the targets to retrieve. Must be `Services`, `Tasks`, or `Nodes`.", + "description": "role of the targets to retrieve. Must be `Services`, `Tasks`, or `Nodes`.", "enum": [ "Services", "Tasks", @@ -3356,13 +3356,13 @@ "type": "string" }, "tlsConfig": { - "description": "TLS configuration to use on every scrape request", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3385,7 +3385,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3411,10 +3411,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3437,7 +3437,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3463,11 +3463,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3490,7 +3490,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -3500,7 +3500,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -3510,7 +3510,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -3526,12 +3526,12 @@ "type": "array" }, "ec2SDConfigs": { - "description": "EC2SDConfigs defines a list of EC2 service discovery configurations.", + "description": "ec2SDConfigs defines a list of EC2 service discovery configurations.", "items": { "description": "EC2SDConfig allow retrieving scrape targets from AWS EC2 instances.\nThe private IP address is used by default, but may be changed to the public IP address with relabeling.\nThe IAM credentials used must have the ec2:DescribeInstances permission to discover scrape targets\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#ec2_sd_config\n\nThe EC2 service discovery requires AWS API keys or role ARN for authentication.\nBasicAuth, Authorization and OAuth2 fields are not present on purpose.", "properties": { "accessKey": { - "description": "AccessKey is the AWS API key.", + "description": "accessKey defines the AWS API key.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3554,20 +3554,20 @@ "x-kubernetes-map-type": "atomic" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.\nIt requires Prometheus >= v2.41.0", + "description": "enableHTTP2 defines whether to enable HTTP2.\nIt requires Prometheus >= v2.41.0", "type": "boolean" }, "filters": { - "description": "Filters can be used optionally to filter the instance list by other criteria.\nAvailable filter criteria can be found here:\nhttps://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html\nFilter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html\nIt requires Prometheus >= v2.3.0", + "description": "filters can be used optionally to filter the instance list by other criteria.\nAvailable filter criteria can be found here:\nhttps://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html\nFilter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html\nIt requires Prometheus >= v2.3.0", "items": { "description": "Filter name and value pairs to limit the discovery process to a subset of available resources.", "properties": { "name": { - "description": "Name of the Filter.", + "description": "name of the Filter.", "type": "string" }, "values": { - "description": "Value to filter on.", + "description": "values defines values to filter on.", "items": { "minLength": 1, "type": "string" @@ -3590,15 +3590,15 @@ "x-kubernetes-list-type": "map" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.\nIt requires Prometheus >= v2.41.0", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\nIt requires Prometheus >= v2.41.0", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "port": { - "description": "The port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule.", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule.", "format": "int32", "maximum": 65535, "minimum": 0, @@ -3631,36 +3631,36 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "region": { - "description": "The AWS region.", + "description": "region defines the AWS region.", "minLength": 1, "type": "string" }, "roleARN": { - "description": "AWS Role ARN, an alternative to using AWS API keys.", + "description": "roleARN defines an alternative to using AWS API keys.", "minLength": 1, "type": "string" }, "secretKey": { - "description": "SecretKey is the AWS API secret.", + "description": "secretKey defines the AWS API secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3683,13 +3683,13 @@ "x-kubernetes-map-type": "atomic" }, "tlsConfig": { - "description": "TLS configuration to connect to the AWS EC2 API.\nIt requires Prometheus >= v2.41.0", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.\nIt requires Prometheus >= v2.41.0", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3712,7 +3712,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3738,10 +3738,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3764,7 +3764,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3790,11 +3790,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3817,7 +3817,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -3827,7 +3827,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -3837,7 +3837,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -3849,23 +3849,23 @@ "type": "array" }, "enableCompression": { - "description": "When false, Prometheus will request uncompressed response from the scraped target.\n\nIt requires Prometheus >= v2.49.0.\n\nIf unset, Prometheus uses true by default.", + "description": "enableCompression when false, Prometheus will request uncompressed response from the scraped target.\n\nIt requires Prometheus >= v2.49.0.\n\nIf unset, Prometheus uses true by default.", "type": "boolean" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "eurekaSDConfigs": { - "description": "EurekaSDConfigs defines a list of Eureka service discovery configurations.", + "description": "eurekaSDConfigs defines a list of Eureka service discovery configurations.", "items": { "description": "Eureka SD configurations allow retrieving scrape targets using the Eureka REST API.\nPrometheus will periodically check the REST endpoint and create a target for every app instance.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#eureka_sd_config", "properties": { "authorization": { - "description": "Authorization header to use on every scrape request.", + "description": "authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3888,17 +3888,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth information to use on every scrape request.", + "description": "basicAuth defines the BasicAuth information to use on every scrape request.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3921,7 +3921,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -3947,25 +3947,25 @@ "type": "object" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization` or `basic_auth`.", + "description": "oauth2 defines the configuration to use on every scrape request.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -3988,7 +3988,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4014,7 +4014,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4040,11 +4040,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -4074,34 +4074,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4124,7 +4124,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4150,10 +4150,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4176,7 +4176,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4202,11 +4202,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4229,7 +4229,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -4239,7 +4239,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -4249,14 +4249,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -4295,38 +4295,38 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "Refresh interval to re-read the instance list.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "server": { - "description": "The URL to connect to the Eureka server.", + "description": "server defines the URL to connect to the Eureka server.", "minLength": 1, "pattern": "^http(s)?://.+$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration applying to the target HTTP endpoint.", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4349,7 +4349,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4375,10 +4375,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4401,7 +4401,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4427,11 +4427,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4454,7 +4454,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -4464,7 +4464,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -4474,7 +4474,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -4489,7 +4489,7 @@ "type": "array" }, "fallbackScrapeProtocol": { - "description": "The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\n\nIt requires Prometheus >= v3.0.0.", + "description": "fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\n\nIt requires Prometheus >= v3.0.0.", "enum": [ "PrometheusProto", "OpenMetricsText0.0.1", @@ -4500,12 +4500,12 @@ "type": "string" }, "fileSDConfigs": { - "description": "FileSDConfigs defines a list of file service discovery configurations.", + "description": "fileSDConfigs defines a list of file service discovery configurations.", "items": { "description": "FileSDConfig defines a Prometheus file service discovery configuration\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#file_sd_config", "properties": { "files": { - "description": "List of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the\nprometheus-operator project makes no guarantees about the working directory where the configuration file is\nstored.\nFiles must be mounted using Prometheus.ConfigMaps or Prometheus.Secrets.", + "description": "files defines the list of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the\nprometheus-operator project makes no guarantees about the working directory where the configuration file is\nstored.\nFiles must be mounted using Prometheus.ConfigMaps or Prometheus.Secrets.", "items": { "description": "SDFile represents a file used for service discovery", "pattern": "^[^*]*(\\*[^/]*)?\\.(json|yml|yaml|JSON|YML|YAML)$", @@ -4516,7 +4516,7 @@ "x-kubernetes-list-type": "set" }, "refreshInterval": { - "description": "RefreshInterval configures the refresh interval at which Prometheus will reload the content of the files.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" } @@ -4529,39 +4529,39 @@ "type": "array" }, "gceSDConfigs": { - "description": "GCESDConfigs defines a list of GCE service discovery configurations.", + "description": "gceSDConfigs defines a list of GCE service discovery configurations.", "items": { "description": "GCESDConfig configures scrape targets from GCP GCE instances.\nThe private IP address is used by default, but may be changed to\nthe public IP address with relabeling.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#gce_sd_config\n\nThe GCE service discovery will load the Google Cloud credentials\nfrom the file specified by the GOOGLE_APPLICATION_CREDENTIALS environment variable.\nSee https://cloud.google.com/kubernetes-engine/docs/tutorials/authenticating-to-cloud-platform\n\nA pre-requisite for using GCESDConfig is that a Secret containing valid\nGoogle Cloud credentials is mounted into the Prometheus or PrometheusAgent\npod via the `.spec.secrets` field and that the GOOGLE_APPLICATION_CREDENTIALS\nenvironment variable is set to /etc/prometheus/secrets//.", "properties": { "filter": { - "description": "Filter can be used optionally to filter the instance list by other criteria\nSyntax of this filter is described in the filter query parameter section:\nhttps://cloud.google.com/compute/docs/reference/latest/instances/list", + "description": "filter defines the filter that can be used optionally to filter the instance list by other criteria\nSyntax of this filter is described in the filter query parameter section:\nhttps://cloud.google.com/compute/docs/reference/latest/instances/list", "minLength": 1, "type": "string" }, "port": { - "description": "The port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule.", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule.", "format": "int32", "maximum": 65535, "minimum": 0, "type": "integer" }, "project": { - "description": "The Google Cloud Project ID", + "description": "project defines the Google Cloud Project ID", "minLength": 1, "type": "string" }, "refreshInterval": { - "description": "RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "tagSeparator": { - "description": "The tag separator is used to separate the tags on concatenation", + "description": "tagSeparator defines the tag separator is used to separate the tags on concatenation", "minLength": 1, "type": "string" }, "zone": { - "description": "The zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs.", + "description": "zone defines the zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs.", "minLength": 1, "type": "string" } @@ -4575,15 +4575,15 @@ "type": "array" }, "hetznerSDConfigs": { - "description": "HetznerSDConfigs defines a list of Hetzner service discovery configurations.", + "description": "hetznerSDConfigs defines a list of Hetzner service discovery configurations.", "items": { "description": "HetznerSDConfig allow retrieving scrape targets from Hetzner Cloud API and Robot API.\nThis service discovery uses the public IPv4 address by default, but that can be changed with relabeling\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#hetzner_sd_config", "properties": { "authorization": { - "description": "Authorization header configuration, required when role is hcloud.\nRole robot does not support bearer token authentication.", + "description": "authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4606,17 +4606,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth information to use on every scrape request, required when role is robot.\nRole hcloud does not support basic auth.", + "description": "basicAuth defines information to use on every scrape request.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4639,7 +4639,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4665,30 +4665,30 @@ "type": "object" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "labelSelector": { - "description": "Label selector used to filter the servers when fetching them from the API.\nIt requires Prometheus >= v3.5.0.", + "description": "labelSelector defines the label selector used to filter the servers when fetching them from the API.\nIt requires Prometheus >= v3.5.0.", "minLength": 1, "type": "string" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Optional OAuth 2.0 configuration.\nCannot be used at the same time as `basic_auth` or `authorization`.", + "description": "oauth2 defines the configuration to use on every scrape request.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4711,7 +4711,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4737,7 +4737,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4763,11 +4763,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -4797,34 +4797,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4847,7 +4847,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4873,10 +4873,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4899,7 +4899,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4925,11 +4925,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4952,7 +4952,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -4962,7 +4962,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -4972,14 +4972,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -4992,7 +4992,7 @@ "type": "object" }, "port": { - "description": "The port to scrape metrics from.", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must", "format": "int32", "maximum": 65535, "minimum": 0, @@ -5025,26 +5025,26 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "The time after which the servers are refreshed.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "role": { - "description": "The Hetzner role of entities that should be discovered.", + "description": "role defines the Hetzner role of entities that should be discovered.", "enum": [ "hcloud", "Hcloud", @@ -5054,13 +5054,13 @@ "type": "string" }, "tlsConfig": { - "description": "TLS configuration to use on every scrape request.", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5083,7 +5083,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5109,10 +5109,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5135,7 +5135,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5161,11 +5161,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5188,7 +5188,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -5198,7 +5198,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -5208,7 +5208,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -5223,23 +5223,23 @@ "type": "array" }, "honorLabels": { - "description": "HonorLabels chooses the metric's labels on collisions with target labels.", + "description": "honorLabels defines when true the metric's labels when they collide\nwith the target's labels.", "type": "boolean" }, "honorTimestamps": { - "description": "HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data.", + "description": "honorTimestamps defines whether Prometheus preserves the timestamps\nwhen exposed by the target.", "type": "boolean" }, "httpSDConfigs": { - "description": "HTTPSDConfigs defines a list of HTTP service discovery configurations.", + "description": "httpSDConfigs defines a list of HTTP service discovery configurations.", "items": { "description": "HTTPSDConfig defines a prometheus HTTP service discovery configuration\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#http_sd_config", "properties": { "authorization": { - "description": "Authorization header configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as `oAuth2`, or `basicAuth`.", + "description": "authorization defines the authorization header configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as `oAuth2`, or `basicAuth`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5262,17 +5262,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth information to authenticate against the target HTTP endpoint.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoints\nCannot be set at the same time as `authorization`, or `oAuth2`.", + "description": "basicAuth defines information to use on every scrape request.\nMore info: https://prometheus.io/docs/operating/configuration/#endpoints\nCannot be set at the same time as `authorization`, or `oAuth2`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5295,7 +5295,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5321,25 +5321,25 @@ "type": "object" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as `authorization`, or `basicAuth`.", + "description": "oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as `authorization`, or `basicAuth`.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5362,7 +5362,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5388,7 +5388,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5414,11 +5414,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -5448,34 +5448,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5498,7 +5498,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5524,10 +5524,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5550,7 +5550,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5576,11 +5576,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5603,7 +5603,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -5613,7 +5613,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -5623,14 +5623,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -5669,32 +5669,32 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "RefreshInterval configures the refresh interval at which Prometheus will re-query the\nendpoint to update the target list.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration applying to the target HTTP endpoint.", + "description": "tlsConfig defines the TLS configuration applying to the target HTTP endpoint.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5717,7 +5717,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5743,10 +5743,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5769,7 +5769,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5795,11 +5795,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5822,7 +5822,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -5832,7 +5832,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -5842,14 +5842,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "url": { - "description": "URL from which the targets are fetched.", + "description": "url defines the URL from which the targets are fetched.", "minLength": 1, "pattern": "^http(s)?://.+$", "type": "string" @@ -5863,15 +5863,15 @@ "type": "array" }, "ionosSDConfigs": { - "description": "IonosSDConfigs defines a list of IONOS service discovery configurations.", + "description": "ionosSDConfigs defines a list of IONOS service discovery configurations.", "items": { "description": "IonosSDConfig configurations allow retrieving scrape targets from IONOS resources.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#ionos_sd_config", "properties": { "authorization": { - "description": "Authorization` header configuration, required when using IONOS.", + "description": "authorization defines the header configuration to authenticate against the IONOS.\nCannot be set at the same time as `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5894,37 +5894,37 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "datacenterID": { - "description": "The unique ID of the IONOS data center.", + "description": "datacenterID defines the unique ID of the IONOS data center.", "minLength": 1, "type": "string" }, "enableHTTP2": { - "description": "Configure whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether the HTTP requests should follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Configure whether to enable OAuth2.", + "description": "oauth2 defines the configuration to use on every scrape request.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -5947,7 +5947,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5973,7 +5973,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -5999,11 +5999,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -6033,34 +6033,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6083,7 +6083,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6109,10 +6109,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6135,7 +6135,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6161,11 +6161,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6188,7 +6188,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -6198,7 +6198,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -6208,14 +6208,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -6228,7 +6228,7 @@ "type": "object" }, "port": { - "description": "Port to scrape the metrics from.", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must", "format": "int32", "maximum": 65535, "minimum": 0, @@ -6261,32 +6261,32 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "Refresh interval to re-read the list of resources.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the IONOS API.", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6309,7 +6309,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6335,10 +6335,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6361,7 +6361,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6387,11 +6387,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6414,7 +6414,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -6424,7 +6424,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -6434,7 +6434,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -6450,40 +6450,40 @@ "type": "array" }, "jobName": { - "description": "The value of the `job` label assigned to the scraped metrics by default.\n\nThe `job_name` field in the rendered scrape configuration is always controlled by the\noperator to prevent duplicate job names, which Prometheus does not allow. Instead the\n`job` label is set by means of relabeling configs.", + "description": "jobName defines the value of the `job` label assigned to the scraped metrics by default.\n\nThe `job_name` field in the rendered scrape configuration is always controlled by the\noperator to prevent duplicate job names, which Prometheus does not allow. Instead the\n`job` label is set by means of relabeling configs.", "minLength": 1, "type": "string" }, "keepDroppedTargets": { - "description": "Per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\nIt requires Prometheus >= v2.47.0.", + "description": "keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\nIt requires Prometheus >= v2.47.0.", "format": "int64", "type": "integer" }, "kubernetesSDConfigs": { - "description": "KubernetesSDConfigs defines a list of Kubernetes service discovery configurations.", + "description": "kubernetesSDConfigs defines a list of Kubernetes service discovery configurations.", "items": { "description": "KubernetesSDConfig allows retrieving scrape targets from Kubernetes' REST API.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#kubernetes_sd_config", "properties": { "apiServer": { - "description": "The API server address consisting of a hostname or IP address followed\nby an optional port number.\nIf left empty, Prometheus is assumed to run inside\nof the cluster. It will discover API servers automatically and use the pod's\nCA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.", + "description": "apiServer defines the API server address consisting of a hostname or IP address followed\nby an optional port number.\nIf left empty, Prometheus is assumed to run inside\nof the cluster. It will discover API servers automatically and use the pod's\nCA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.", "minLength": 1, "type": "string" }, "attachMetadata": { - "description": "Optional metadata to attach to discovered targets.\nIt requires Prometheus >= v2.35.0 when using the `Pod` role and\nPrometheus >= v2.37.0 for `Endpoints` and `Endpointslice` roles.", + "description": "attachMetadata defines the metadata to attach to discovered targets.\nIt requires Prometheus >= v2.35.0 when using the `Pod` role and\nPrometheus >= v2.37.0 for `Endpoints` and `Endpointslice` roles.", "properties": { "node": { - "description": "Attaches node metadata to discovered targets.\nWhen set to true, Prometheus must have the `get` permission on the\n`Nodes` objects.\nOnly valid for Pod, Endpoint and Endpointslice roles.", + "description": "node attaches node metadata to discovered targets.\nWhen set to true, Prometheus must have the `get` permission on the\n`Nodes` objects.\nOnly valid for Pod, Endpoint and Endpointslice roles.", "type": "boolean" } }, "type": "object" }, "authorization": { - "description": "Authorization header to use on every scrape request.\nCannot be set at the same time as `basicAuth`, or `oauth2`.", + "description": "authorization defines the authorization header to use on every scrape request.\nCannot be set at the same time as `basicAuth`, or `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6506,17 +6506,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth information to use on every scrape request.\nCannot be set at the same time as `authorization`, or `oauth2`.", + "description": "basicAuth defines information to use on every scrape request.\nCannot be set at the same time as `authorization`, or `oauth2`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6539,7 +6539,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6565,18 +6565,18 @@ "type": "object" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "namespaces": { - "description": "Optional namespace discovery. If omitted, Prometheus discovers targets across all namespaces.", + "description": "namespaces defines the namespace discovery. If omitted, Prometheus discovers targets across all namespaces.", "properties": { "names": { - "description": "List of namespaces where to watch for resources.\nIf empty and `ownNamespace` isn't true, Prometheus watches for resources in all namespaces.", + "description": "names defines a list of namespaces where to watch for resources.\nIf empty and `ownNamespace` isn't true, Prometheus watches for resources in all namespaces.", "items": { "type": "string" }, @@ -6584,24 +6584,24 @@ "x-kubernetes-list-type": "set" }, "ownNamespace": { - "description": "Includes the namespace in which the Prometheus pod runs to the list of watched namespaces.", + "description": "ownNamespace includes the namespace in which the Prometheus pod runs to the list of watched namespaces.", "type": "boolean" } }, "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization`, or `basicAuth`.", + "description": "oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as `authorization`, or `basicAuth`.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6624,7 +6624,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6650,7 +6650,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6676,11 +6676,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -6710,34 +6710,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6760,7 +6760,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6786,10 +6786,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -6812,7 +6812,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6838,11 +6838,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6865,7 +6865,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -6875,7 +6875,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -6885,14 +6885,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -6931,21 +6931,21 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "role": { - "description": "Role of the Kubernetes entities that should be discovered.\nRole `Endpointslice` requires Prometheus >= v2.21.0", + "description": "role defines the Kubernetes role of the entities that should be discovered.\nRole `Endpointslice` requires Prometheus >= v2.21.0", "enum": [ "Pod", "Endpoints", @@ -6957,22 +6957,22 @@ "type": "string" }, "selectors": { - "description": "Selector to select objects.\nIt requires Prometheus >= v2.17.0", + "description": "selectors defines the selector to select objects.\nIt requires Prometheus >= v2.17.0", "items": { "description": "K8SSelectorConfig is Kubernetes Selector Config", "properties": { "field": { - "description": "An optional field selector to limit the service discovery to resources which have fields with specific values.\ne.g: `metadata.name=foobar`", + "description": "field defines an optional field selector to limit the service discovery to resources which have fields with specific values.\ne.g: `metadata.name=foobar`", "minLength": 1, "type": "string" }, "label": { - "description": "An optional label selector to limit the service discovery to resources with specific labels and label values.\ne.g: `node.kubernetes.io/instance-type=master`", + "description": "label defines an optional label selector to limit the service discovery to resources with specific labels and label values.\ne.g: `node.kubernetes.io/instance-type=master`", "minLength": 1, "type": "string" }, "role": { - "description": "Role specifies the type of Kubernetes resource to limit the service discovery to.\nAccepted values are: Node, Pod, Endpoints, EndpointSlice, Service, Ingress.", + "description": "role defines the type of Kubernetes resource to limit the service discovery to.\nAccepted values are: Node, Pod, Endpoints, EndpointSlice, Service, Ingress.", "enum": [ "Pod", "Endpoints", @@ -6996,13 +6996,13 @@ "x-kubernetes-list-type": "map" }, "tlsConfig": { - "description": "TLS configuration to connect to the Kubernetes API.", + "description": "tlsConfig defines the TLS configuration to connect to the Kubernetes API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7025,7 +7025,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7051,10 +7051,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7077,7 +7077,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7103,11 +7103,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7130,7 +7130,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -7140,7 +7140,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -7150,7 +7150,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -7165,15 +7165,15 @@ "type": "array" }, "kumaSDConfigs": { - "description": "KumaSDConfigs defines a list of Kuma service discovery configurations.", + "description": "kumaSDConfigs defines a list of Kuma service discovery configurations.", "items": { "description": "KumaSDConfig allow retrieving scrape targets from Kuma's control plane.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#kuma_sd_config", "properties": { "authorization": { - "description": "Authorization header to use on every scrape request.", + "description": "authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7196,17 +7196,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth information to use on every scrape request.", + "description": "basicAuth defines information to use on every scrape request.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7229,7 +7229,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7255,34 +7255,34 @@ "type": "object" }, "clientID": { - "description": "Client id is used by Kuma Control Plane to compute Monitoring Assignment for specific Prometheus backend.", + "description": "clientID is used by Kuma Control Plane to compute Monitoring Assignment for specific Prometheus backend.", "type": "string" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "fetchTimeout": { - "description": "The time after which the monitoring assignments are refreshed.", + "description": "fetchTimeout defines the time after which the monitoring assignments are refreshed.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization`, or `basicAuth`.", + "description": "oauth2 defines the configuration to use on every scrape request.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7305,7 +7305,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7331,7 +7331,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7357,11 +7357,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -7391,34 +7391,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7441,7 +7441,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7467,10 +7467,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7493,7 +7493,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7519,11 +7519,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7546,7 +7546,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -7556,7 +7556,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -7566,14 +7566,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -7612,37 +7612,37 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "The time to wait between polling update requests.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "server": { - "description": "Address of the Kuma Control Plane's MADS xDS server.", + "description": "server defines the address of the Kuma Control Plane's MADS xDS server.", "minLength": 1, "type": "string" }, "tlsConfig": { - "description": "TLS configuration to use on every scrape request", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7665,7 +7665,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7691,10 +7691,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7717,7 +7717,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7743,11 +7743,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7770,7 +7770,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -7780,7 +7780,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -7790,7 +7790,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -7805,27 +7805,27 @@ "type": "array" }, "labelLimit": { - "description": "Per-scrape limit on number of labels that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer.", + "description": "labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer.", "format": "int64", "type": "integer" }, "labelNameLengthLimit": { - "description": "Per-scrape limit on length of labels name that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer.", + "description": "labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer.", "format": "int64", "type": "integer" }, "labelValueLengthLimit": { - "description": "Per-scrape limit on length of labels value that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer.", + "description": "labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample.\nOnly valid in Prometheus versions 2.27.0 and newer.", "format": "int64", "type": "integer" }, "lightSailSDConfigs": { - "description": "LightsailSDConfigs defines a list of Lightsail service discovery configurations.", + "description": "lightSailSDConfigs defines a list of Lightsail service discovery configurations.", "items": { "description": "LightSailSDConfig configurations allow retrieving scrape targets from AWS Lightsail instances.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#lightsail_sd_config", "properties": { "accessKey": { - "description": "AccessKey is the AWS API key.", + "description": "accessKey defines the AWS API key.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7848,10 +7848,10 @@ "x-kubernetes-map-type": "atomic" }, "authorization": { - "description": "Optional `authorization` HTTP header configuration.\nCannot be set at the same time as `basicAuth`, or `oauth2`.", + "description": "authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7874,17 +7874,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "Optional HTTP basic authentication information.\nCannot be set at the same time as `authorization`, or `oauth2`.", + "description": "basicAuth defines information to use on every scrape request.\nCannot be set at the same time as `authorization`, or `oauth2`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7907,7 +7907,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7933,30 +7933,30 @@ "type": "object" }, "enableHTTP2": { - "description": "Configure whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "endpoint": { - "description": "Custom endpoint to be used.", + "description": "endpoint defines the custom endpoint to be used.", "minLength": 1, "type": "string" }, "followRedirects": { - "description": "Configure whether the HTTP requests should follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Optional OAuth2.0 configuration.\nCannot be set at the same time as `basicAuth`, or `authorization`.", + "description": "oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as `authorization`, or `basicAuth`.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7979,7 +7979,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8005,7 +8005,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8031,11 +8031,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -8065,34 +8065,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8115,7 +8115,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8141,10 +8141,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8167,7 +8167,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8193,11 +8193,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8220,7 +8220,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -8230,7 +8230,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -8240,14 +8240,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -8260,7 +8260,7 @@ "type": "object" }, "port": { - "description": "Port to scrape the metrics from.\nIf using the public IP address, this must instead be specified in the relabeling rule.", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must", "format": "int32", "maximum": 65535, "minimum": 0, @@ -8293,35 +8293,35 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "Refresh interval to re-read the list of instances.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "region": { - "description": "The AWS region.", + "description": "region defines the AWS region.", "minLength": 1, "type": "string" }, "roleARN": { - "description": "AWS Role ARN, an alternative to using AWS API keys.", + "description": "roleARN defines the AWS Role ARN, an alternative to using AWS API keys.", "type": "string" }, "secretKey": { - "description": "SecretKey is the AWS API secret.", + "description": "secretKey defines the AWS API secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8344,13 +8344,13 @@ "x-kubernetes-map-type": "atomic" }, "tlsConfig": { - "description": "TLS configuration to connect to the Puppet DB.", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8373,7 +8373,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8399,10 +8399,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8425,7 +8425,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8451,11 +8451,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8478,7 +8478,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -8488,7 +8488,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -8498,7 +8498,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -8510,15 +8510,15 @@ "type": "array" }, "linodeSDConfigs": { - "description": "LinodeSDConfigs defines a list of Linode service discovery configurations.", + "description": "linodeSDConfigs defines a list of Linode service discovery configurations.", "items": { "description": "LinodeSDConfig configurations allow retrieving scrape targets from Linode's Linode APIv4.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#linode_sd_config", "properties": { "authorization": { - "description": "Authorization header configuration.", + "description": "authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8541,32 +8541,32 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Optional OAuth 2.0 configuration.\nCannot be used at the same time as `authorization`.", + "description": "oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as `authorization`, or `basicAuth`.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8589,7 +8589,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8615,7 +8615,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8641,11 +8641,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -8675,34 +8675,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8725,7 +8725,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8751,10 +8751,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8777,7 +8777,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8803,11 +8803,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8830,7 +8830,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -8840,7 +8840,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -8850,14 +8850,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -8870,7 +8870,7 @@ "type": "object" }, "port": { - "description": "Default port to scrape metrics from.", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must", "format": "int32", "maximum": 65535, "minimum": 0, @@ -8903,42 +8903,42 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "Time after which the linode instances are refreshed.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "region": { - "description": "Optional region to filter on.", + "description": "region defines the region to filter on.", "minLength": 1, "type": "string" }, "tagSeparator": { - "description": "The string by which Linode Instance tags are joined into the tag label.", + "description": "tagSeparator defines the string by which Linode Instance tags are joined into the tag label.el.", "minLength": 1, "type": "string" }, "tlsConfig": { - "description": "TLS configuration applying to the target HTTP endpoint.", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -8961,7 +8961,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -8987,10 +8987,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9013,7 +9013,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9039,11 +9039,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9066,7 +9066,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -9076,7 +9076,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -9086,7 +9086,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -9098,13 +9098,13 @@ "type": "array" }, "metricRelabelings": { - "description": "MetricRelabelConfigs to apply to samples before ingestion.", + "description": "metricRelabelings defines the metricRelabelings to apply to samples before ingestion.", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -9132,24 +9132,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -9158,7 +9158,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -9168,12 +9168,12 @@ "type": "array" }, "metricsPath": { - "description": "MetricsPath HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics).", + "description": "metricsPath defines the HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics).", "minLength": 1, "type": "string" }, "nameEscapingScheme": { - "description": "Metric name escaping mode to request through content negotiation.\n\nIt requires Prometheus >= v3.4.0.", + "description": "nameEscapingScheme defines the metric name escaping mode to request through content negotiation.\n\nIt requires Prometheus >= v3.4.0.", "enum": [ "AllowUTF8", "Underscores", @@ -9183,7 +9183,7 @@ "type": "string" }, "nameValidationScheme": { - "description": "Specifies the validation scheme for metric and label names.\n\nIt requires Prometheus >= v3.0.0.", + "description": "nameValidationScheme defines the validation scheme for metric and label names.\n\nIt requires Prometheus >= v3.0.0.", "enum": [ "UTF8", "Legacy" @@ -9191,7 +9191,7 @@ "type": "string" }, "nativeHistogramBucketLimit": { - "description": "If there are more than this many buckets in a native histogram,\nbuckets will be merged to stay within the limit.\nIt requires Prometheus >= v2.45.0.", + "description": "nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram,\nbuckets will be merged to stay within the limit.\nIt requires Prometheus >= v2.45.0.", "format": "int64", "type": "integer" }, @@ -9204,28 +9204,28 @@ "type": "string" } ], - "description": "If the growth factor of one bucket to the next is smaller than this,\nbuckets will be merged to increase the factor sufficiently.\nIt requires Prometheus >= v2.50.0.", + "description": "nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this,\nbuckets will be merged to increase the factor sufficiently.\nIt requires Prometheus >= v2.50.0.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "nomadSDConfigs": { - "description": "NomadSDConfigs defines a list of Nomad service discovery configurations.", + "description": "nomadSDConfigs defines a list of Nomad service discovery configurations.", "items": { "description": "NomadSDConfig configurations allow retrieving scrape targets from Nomad's Service API.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#nomad_sd_config", "properties": { "allowStale": { - "description": "The information to access the Nomad API. It is to be defined\nas the Nomad documentation requires.", + "description": "allowStale defines the information to access the Nomad API. It is to be defined\nas the Nomad documentation requires.", "type": "boolean" }, "authorization": { - "description": "Authorization header to use on every scrape request.", + "description": "authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9248,17 +9248,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "BasicAuth information to use on every scrape request.", + "description": "basicAuth defines information to use on every scrape request.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9281,7 +9281,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9307,28 +9307,29 @@ "type": "object" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "namespace": { + "description": "namespace defines the Nomad namespace to query for service discovery.\nWhen specified, only resources within this namespace will be discovered.", "type": "string" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Optional OAuth 2.0 configuration.\nCannot be set at the same time as `authorization` or `basic_auth`.", + "description": "oauth2 defines the configuration to use on every scrape request.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9351,7 +9352,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9377,7 +9378,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9403,11 +9404,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -9437,34 +9438,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9487,7 +9488,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9513,10 +9514,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9539,7 +9540,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9565,11 +9566,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9592,7 +9593,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -9602,7 +9603,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -9612,14 +9613,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -9658,42 +9659,45 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "Duration is a valid time duration that can be parsed by Prometheus model.ParseDuration() function.\nSupported units: y, w, d, h, m, s, ms\nExamples: `30s`, `1m`, `1h20m15s`, `15d`", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "region": { + "description": "region defines the Nomad region to query for service discovery.\nWhen specified, only resources within this region will be discovered.", "type": "string" }, "server": { + "description": "server defines the Nomad server address to connect to for service discovery.\nThis should be the full URL including protocol (e.g., \"https://nomad.example.com:4646\").", "minLength": 1, "type": "string" }, "tagSeparator": { + "description": "tagSeparator defines the separator used to join multiple tags.\nThis determines how Nomad service tags are concatenated into Prometheus labels.", "type": "string" }, "tlsConfig": { - "description": "TLS configuration applying to the target HTTP endpoint.", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9716,7 +9720,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9742,10 +9746,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9768,7 +9772,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9794,11 +9798,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9821,7 +9825,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -9831,7 +9835,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -9841,7 +9845,7 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, @@ -9856,13 +9860,13 @@ "type": "array" }, "oauth2": { - "description": "OAuth2 configuration to use on every scrape request.", + "description": "oauth2 defines the configuration to use on every scrape request.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -9885,7 +9889,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9911,7 +9915,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -9937,11 +9941,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -9971,34 +9975,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10021,7 +10025,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10047,10 +10051,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10073,7 +10077,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10099,11 +10103,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10126,7 +10130,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -10136,7 +10140,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -10146,14 +10150,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -10166,25 +10170,25 @@ "type": "object" }, "openstackSDConfigs": { - "description": "OpenStackSDConfigs defines a list of OpenStack service discovery configurations.", + "description": "openstackSDConfigs defines a list of OpenStack service discovery configurations.", "items": { "description": "OpenStackSDConfig allow retrieving scrape targets from OpenStack Nova instances.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#openstack_sd_config", "properties": { "allTenants": { - "description": "Whether the service discovery should list all instances for all projects.\nIt is only relevant for the 'instance' role and usually requires admin permissions.", + "description": "allTenants defines whether the service discovery should list all instances for all projects.\nIt is only relevant for the 'instance' role and usually requires admin permissions.", "type": "boolean" }, "applicationCredentialId": { - "description": "ApplicationCredentialID", + "description": "applicationCredentialId defines the OpenStack applicationCredentialId.", "type": "string" }, "applicationCredentialName": { - "description": "The ApplicationCredentialID or ApplicationCredentialName fields are\nrequired if using an application credential to authenticate. Some providers\nallow you to create an application credential to authenticate rather than a\npassword.", + "description": "applicationCredentialName defines the ApplicationCredentialID or ApplicationCredentialName fields are\nrequired if using an application credential to authenticate. Some providers\nallow you to create an application credential to authenticate rather than a\npassword.", "minLength": 1, "type": "string" }, "applicationCredentialSecret": { - "description": "The applicationCredentialSecret field is required if using an application\ncredential to authenticate.", + "description": "applicationCredentialSecret defines the requiered field if using an application\ncredential to authenticate.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10207,7 +10211,7 @@ "x-kubernetes-map-type": "atomic" }, "availability": { - "description": "Availability of the endpoint to connect to.", + "description": "availability defines the availability of the endpoint to connect to.", "enum": [ "Public", "public", @@ -10219,22 +10223,22 @@ "type": "string" }, "domainID": { - "description": "DomainID", + "description": "domainID defines The OpenStack domainID.", "minLength": 1, "type": "string" }, "domainName": { - "description": "At most one of domainId and domainName must be provided if using username\nwith Identity V3. Otherwise, either are optional.", + "description": "domainName defines at most one of domainId and domainName that must be provided if using username\nwith Identity V3. Otherwise, either are optional.", "minLength": 1, "type": "string" }, "identityEndpoint": { - "description": "IdentityEndpoint specifies the HTTP endpoint that is required to work with\nthe Identity API of the appropriate version.", + "description": "identityEndpoint defines the HTTP endpoint that is required to work with\nthe Identity API of the appropriate version.", "pattern": "^http(s)?:\\/\\/.+$", "type": "string" }, "password": { - "description": "Password for the Identity V2 and V3 APIs. Consult with your provider's\ncontrol panel to discover your account's preferred method of authentication.", + "description": "password defines the password for the Identity V2 and V3 APIs. Consult with your provider's\ncontrol panel to discover your account's preferred method of authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10257,34 +10261,34 @@ "x-kubernetes-map-type": "atomic" }, "port": { - "description": "The port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule.", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must\ninstead be specified in the relabeling rule.", "format": "int32", "maximum": 65535, "minimum": 0, "type": "integer" }, "projectID": { - "description": " ProjectID", + "description": "projectID defines the OpenStack projectID.", "minLength": 1, "type": "string" }, "projectName": { - "description": "The ProjectId and ProjectName fields are optional for the Identity V2 API.\nSome providers allow you to specify a ProjectName instead of the ProjectId.\nSome require both. Your provider's authentication policies will determine\nhow these fields influence authentication.", + "description": "projectName defines an ptional field for the Identity V2 API.\nSome providers allow you to specify a ProjectName instead of the ProjectId.\nSome require both. Your provider's authentication policies will determine\nhow these fields influence authentication.", "minLength": 1, "type": "string" }, "refreshInterval": { - "description": "Refresh interval to re-read the instance list.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "region": { - "description": "The OpenStack Region.", + "description": "region defines the OpenStack Region.", "minLength": 1, "type": "string" }, "role": { - "description": "The OpenStack role of entities that should be discovered.\n\nNote: The `LoadBalancer` role requires Prometheus >= v3.2.0.", + "description": "role defines the OpenStack role of entities that should be discovered.\n\nNote: The `LoadBalancer` role requires Prometheus >= v3.2.0.", "enum": [ "Instance", "Hypervisor", @@ -10293,13 +10297,13 @@ "type": "string" }, "tlsConfig": { - "description": "TLS configuration applying to the target HTTP endpoint.", + "description": "tlsConfig defines the TLS configuration applying to the target HTTP endpoint.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10322,7 +10326,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10348,10 +10352,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10374,7 +10378,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10400,11 +10404,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10427,7 +10431,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -10437,7 +10441,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -10447,19 +10451,19 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "userid": { - "description": "UserID", + "description": "userid defines the OpenStack userid.", "minLength": 1, "type": "string" }, "username": { - "description": "Username is required if using Identity V2 API. Consult with your provider's\ncontrol panel to discover your account's username.\nIn Identity V3, either userid or a combination of username\nand domainId or domainName are needed", + "description": "username defines the username required if using Identity V2 API. Consult with your provider's\ncontrol panel to discover your account's username.\nIn Identity V3, either userid or a combination of username\nand domainId or domainName are needed", "minLength": 1, "type": "string" } @@ -10473,17 +10477,17 @@ "type": "array" }, "ovhcloudSDConfigs": { - "description": "OVHCloudSDConfigs defines a list of OVHcloud service discovery configurations.", + "description": "ovhcloudSDConfigs defines a list of OVHcloud service discovery configurations.", "items": { "description": "OVHCloudSDConfig configurations allow retrieving scrape targets from OVHcloud's dedicated servers and VPS using their API.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#ovhcloud_sd_config", "properties": { "applicationKey": { - "description": "Access key to use. https://api.ovh.com.", + "description": "applicationKey defines the access key to use for OVHCloud API authentication.\nThis is obtained from the OVHCloud API credentials at https://api.ovh.com.", "minLength": 1, "type": "string" }, "applicationSecret": { - "description": "SecretKeySelector selects a key of a Secret.", + "description": "applicationSecret defines the secret key for OVHCloud API authentication.\nThis contains the application secret obtained during OVHCloud API credential creation.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10506,7 +10510,7 @@ "x-kubernetes-map-type": "atomic" }, "consumerKey": { - "description": "SecretKeySelector selects a key of a Secret.", + "description": "consumerKey defines the consumer key for OVHCloud API authentication.\nThis is the third component of OVHCloud's three-key authentication system.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10529,17 +10533,17 @@ "x-kubernetes-map-type": "atomic" }, "endpoint": { - "description": "Custom endpoint to be used.", + "description": "endpoint defines a custom API endpoint to be used.\nWhen not specified, defaults to the standard OVHCloud API endpoint for the region.", "minLength": 1, "type": "string" }, "refreshInterval": { - "description": "Refresh interval to re-read the resources list.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "service": { - "description": "Service of the targets to retrieve. Must be `VPS` or `DedicatedServer`.", + "description": "service defines the service type of the targets to retrieve.\nMust be either `VPS` or `DedicatedServer` to specify which OVHCloud resources to discover.", "enum": [ "VPS", "DedicatedServer" @@ -10564,7 +10568,7 @@ }, "type": "array" }, - "description": "Optional HTTP URL parameters", + "description": "params defines optional HTTP URL parameters", "type": "object", "x-kubernetes-map-type": "atomic" }, @@ -10595,29 +10599,29 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "puppetDBSDConfigs": { - "description": "PuppetDBSDConfigs defines a list of PuppetDB service discovery configurations.", + "description": "puppetDBSDConfigs defines a list of PuppetDB service discovery configurations.", "items": { "description": "PuppetDBSDConfig configurations allow retrieving scrape targets from PuppetDB resources.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#puppetdb_sd_config", "properties": { "authorization": { - "description": "Optional `authorization` HTTP header configuration.\nCannot be set at the same time as `basicAuth`, or `oauth2`.", + "description": "authorization defines the header configuration to authenticate against the DigitalOcean API.\nCannot be set at the same time as `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10640,17 +10644,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "Optional HTTP basic authentication information.\nCannot be set at the same time as `authorization`, or `oauth2`.", + "description": "basicAuth defines information to use on every scrape request.\nCannot be set at the same time as `authorization`, or `oauth2`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10673,7 +10677,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10699,29 +10703,29 @@ "type": "object" }, "enableHTTP2": { - "description": "Configure whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether the HTTP requests should follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "includeParameters": { - "description": "Whether to include the parameters as meta labels.\nNote: Enabling this exposes parameters in the Prometheus UI and API. Make sure\nthat you don't have secrets exposed as parameters if you enable this.", + "description": "includeParameters defines whether to include the parameters as meta labels.\nNote: Enabling this exposes parameters in the Prometheus UI and API. Make sure\nthat you don't have secrets exposed as parameters if you enable this.", "type": "boolean" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "Optional OAuth2.0 configuration.\nCannot be set at the same time as `basicAuth`, or `authorization`.", + "description": "oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint.\nCannot be set at the same time as `authorization`, or `basicAuth`.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10744,7 +10748,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10770,7 +10774,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10796,11 +10800,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -10830,34 +10834,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10880,7 +10884,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10906,10 +10910,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -10932,7 +10936,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10958,11 +10962,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -10985,7 +10989,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -10995,7 +10999,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -11005,14 +11009,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -11025,7 +11029,7 @@ "type": "object" }, "port": { - "description": "Port to scrape the metrics from.", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must", "format": "int32", "maximum": 65535, "minimum": 0, @@ -11058,37 +11062,37 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "query": { - "description": "Puppet Query Language (PQL) query. Only resources are supported.\nhttps://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html", + "description": "query defines the Puppet Query Language (PQL) query. Only resources are supported.\nhttps://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html", "minLength": 1, "type": "string" }, "refreshInterval": { - "description": "Refresh interval to re-read the list of resources.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "tlsConfig": { - "description": "TLS configuration to connect to the Puppet DB.", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -11111,7 +11115,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -11137,10 +11141,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -11163,7 +11167,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -11189,11 +11193,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -11216,7 +11220,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -11226,7 +11230,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -11236,14 +11240,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "url": { - "description": "The URL of the PuppetDB root query endpoint.", + "description": "url defines the URL of the PuppetDB root query endpoint.", "minLength": 1, "pattern": "^http(s)?://.+$", "type": "string" @@ -11258,13 +11262,13 @@ "type": "array" }, "relabelings": { - "description": "RelabelConfigs defines how to rewrite the target's labels before scraping.\nPrometheus Operator automatically adds relabelings for a few standard Kubernetes fields.\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", + "description": "relabelings defines how to rewrite the target's labels before scraping.\nPrometheus Operator automatically adds relabelings for a few standard Kubernetes fields.\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -11292,24 +11296,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -11318,7 +11322,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -11328,51 +11332,51 @@ "type": "array" }, "sampleLimit": { - "description": "SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.", + "description": "sampleLimit defines per-scrape limit on number of scraped samples that will be accepted.", "format": "int64", "type": "integer" }, "scalewaySDConfigs": { - "description": "ScalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations.", + "description": "scalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations.", "items": { "description": "ScalewaySDConfig configurations allow retrieving scrape targets from Scaleway instances and baremetal services.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scaleway_sd_config", "properties": { "accessKey": { - "description": "Access key to use. https://console.scaleway.com/project/credentials", + "description": "accessKey defines the access key to use. https://console.scaleway.com/project/credentials", "minLength": 1, "type": "string" }, "apiURL": { - "description": "API URL to use when doing the server listing requests.", + "description": "apiURL defines the API URL to use when doing the server listing requests.", "pattern": "^http(s)?://.+$", "type": "string" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.", "type": "boolean" }, "nameFilter": { - "description": "NameFilter specify a name filter (works as a LIKE) to apply on the server listing request.", + "description": "nameFilter defines a name filter (works as a LIKE) to apply on the server listing request.", "minLength": 1, "type": "string" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "port": { - "description": "The port to scrape metrics from.", + "description": "port defines the port to scrape metrics from. If using the public IP address, this must", "format": "int32", "maximum": 65535, "minimum": 0, "type": "integer" }, "projectID": { - "description": "Project ID of the targets.", + "description": "projectID defines the Project ID of the targets.", "minLength": 1, "type": "string" }, @@ -11403,26 +11407,26 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "refreshInterval": { - "description": "Refresh interval to re-read the list of instances.", + "description": "refreshInterval defines the time after which the provided names are refreshed.\nIf not set, Prometheus uses its default value.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "role": { - "description": "Service of the targets to retrieve. Must be `Instance` or `Baremetal`.", + "description": "role defines the service of the targets to retrieve. Must be `Instance` or `Baremetal`.", "enum": [ "Instance", "Baremetal" @@ -11430,7 +11434,7 @@ "type": "string" }, "secretKey": { - "description": "Secret key to use when listing targets.", + "description": "secretKey defines the secret key to use when listing targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -11453,7 +11457,7 @@ "x-kubernetes-map-type": "atomic" }, "tagsFilter": { - "description": "TagsFilter specify a tag filter (a server needs to have all defined tags to be listed) to apply on the server listing request.", + "description": "tagsFilter defines a tag filter (a server needs to have all defined tags to be listed) to apply on the server listing request.", "items": { "minLength": 1, "type": "string" @@ -11463,13 +11467,13 @@ "x-kubernetes-list-type": "set" }, "tlsConfig": { - "description": "TLS configuration to use on every scrape request", + "description": "tlsConfig defines the TLS configuration to connect to the Consul API.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -11492,7 +11496,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -11518,10 +11522,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -11544,7 +11548,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -11570,11 +11574,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -11597,7 +11601,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -11607,7 +11611,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -11617,14 +11621,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "zone": { - "description": "Zone is the availability zone of your targets (e.g. fr-par-1).", + "description": "zone defines the availability zone of your targets (e.g. fr-par-1).", "minLength": 1, "type": "string" } @@ -11640,7 +11644,7 @@ "type": "array" }, "scheme": { - "description": "Configures the protocol scheme used for requests.\nIf empty, Prometheus uses HTTP by default.", + "description": "scheme defines the protocol scheme used for requests.\nIf empty, Prometheus uses HTTP by default.", "enum": [ "HTTP", "HTTPS" @@ -11648,21 +11652,21 @@ "type": "string" }, "scrapeClass": { - "description": "The scrape class to apply.", + "description": "scrapeClass defines the scrape class to apply.", "minLength": 1, "type": "string" }, "scrapeClassicHistograms": { - "description": "Whether to scrape a classic histogram that is also exposed as a native histogram.\nIt requires Prometheus >= v2.45.0.\n\nNotice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.", + "description": "scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram.\nIt requires Prometheus >= v2.45.0.\n\nNotice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.", "type": "boolean" }, "scrapeInterval": { - "description": "ScrapeInterval is the interval between consecutive scrapes.", + "description": "scrapeInterval defines the interval between consecutive scrapes.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "scrapeProtocols": { - "description": "The protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0.", + "description": "scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0.", "items": { "description": "ScrapeProtocol represents a protocol used by Prometheus for scraping metrics.\nSupported values are:\n* `OpenMetricsText0.0.1`\n* `OpenMetricsText1.0.0`\n* `PrometheusProto`\n* `PrometheusText0.0.4`\n* `PrometheusText1.0.0`", "enum": [ @@ -11679,12 +11683,12 @@ "x-kubernetes-list-type": "set" }, "scrapeTimeout": { - "description": "ScrapeTimeout is the number of seconds to wait until a scrape request times out.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.", + "description": "scrapeTimeout defines the number of seconds to wait until a scrape request times out.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "staticConfigs": { - "description": "StaticConfigs defines a list of static targets with a common label set.", + "description": "staticConfigs defines a list of static targets with a common label set.", "items": { "description": "StaticConfig defines a Prometheus static configuration.\nSee https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config", "properties": { @@ -11692,12 +11696,12 @@ "additionalProperties": { "type": "string" }, - "description": "Labels assigned to all metrics scraped from the targets.", + "description": "labels defines labels assigned to all metrics scraped from the targets.", "type": "object", "x-kubernetes-map-type": "atomic" }, "targets": { - "description": "List of targets for this static configuration.", + "description": "targets defines the list of targets for this static configuration.", "items": { "description": "Target represents a target for Prometheus to scrape\nkubebuilder:validation:MinLength:=1", "type": "string" @@ -11715,18 +11719,18 @@ "type": "array" }, "targetLimit": { - "description": "TargetLimit defines a limit on the number of scraped targets that will be accepted.", + "description": "targetLimit defines a limit on the number of scraped targets that will be accepted.", "format": "int64", "type": "integer" }, "tlsConfig": { - "description": "TLS configuration to use on every scrape request", + "description": "tlsConfig defines the TLS configuration to use on every scrape request", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -11749,7 +11753,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -11775,10 +11779,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -11801,7 +11805,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -11827,11 +11831,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -11854,7 +11858,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -11864,7 +11868,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -11874,14 +11878,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "trackTimestampsStaleness": { - "description": "TrackTimestampsStaleness whether Prometheus tracks staleness of\nthe metrics that have an explicit timestamp present in scraped data.\nHas no effect if `honorTimestamps` is false.\nIt requires Prometheus >= v2.48.0.", + "description": "trackTimestampsStaleness defines whether Prometheus tracks staleness of\nthe metrics that have an explicit timestamp present in scraped data.\nHas no effect if `honorTimestamps` is false.\nIt requires Prometheus >= v2.48.0.", "type": "boolean" } }, diff --git a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/servicemonitors-crd.json b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/servicemonitors-crd.json index 2d32e6df..ff0e7413 100644 --- a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/servicemonitors-crd.json +++ b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/servicemonitors-crd.json @@ -3,7 +3,7 @@ "kind": "CustomResourceDefinition", "metadata": { "annotations": { - "controller-gen.kubebuilder.io/version": "v0.18.0", + "controller-gen.kubebuilder.io/version": "v0.19.0", "operator.prometheus.io/version": "0.85.0" }, "name": "servicemonitors.monitoring.coreos.com" @@ -42,37 +42,37 @@ "type": "object" }, "spec": { - "description": "Specification of desired Service selection for target discovery by\nPrometheus.", + "description": "spec defines the specification of desired Service selection for target discovery by\nPrometheus.", "properties": { "attachMetadata": { - "description": "`attachMetadata` defines additional metadata which is added to the\ndiscovered targets.\n\nIt requires Prometheus >= v2.37.0.", + "description": "attachMetadata defines additional metadata which is added to the\ndiscovered targets.\n\nIt requires Prometheus >= v2.37.0.", "properties": { "node": { - "description": "When set to true, Prometheus attaches node metadata to the discovered\ntargets.\n\nThe Prometheus service account must have the `list` and `watch`\npermissions on the `Nodes` objects.", + "description": "node when set to true, Prometheus attaches node metadata to the discovered\ntargets.\n\nThe Prometheus service account must have the `list` and `watch`\npermissions on the `Nodes` objects.", "type": "boolean" } }, "type": "object" }, "bodySizeLimit": { - "description": "When defined, bodySizeLimit specifies a job level limit on the size\nof uncompressed response body that will be accepted by Prometheus.\n\nIt requires Prometheus >= v2.28.0.", + "description": "bodySizeLimit when defined, bodySizeLimit specifies a job level limit on the size\nof uncompressed response body that will be accepted by Prometheus.\n\nIt requires Prometheus >= v2.28.0.", "pattern": "(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$", "type": "string" }, "convertClassicHistogramsToNHCB": { - "description": "Whether to convert all scraped classic histograms into a native histogram with custom buckets.\nIt requires Prometheus >= v3.0.0.", + "description": "convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets.\nIt requires Prometheus >= v3.0.0.", "type": "boolean" }, "endpoints": { - "description": "List of endpoints part of this ServiceMonitor.\nDefines how to scrape metrics from Kubernetes [Endpoints](https://kubernetes.io/docs/concepts/services-networking/service/#endpoints) objects.\nIn most cases, an Endpoints object is backed by a Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) object with the same name and labels.", + "description": "endpoints defines the list of endpoints part of this ServiceMonitor.\nDefines how to scrape metrics from Kubernetes [Endpoints](https://kubernetes.io/docs/concepts/services-networking/service/#endpoints) objects.\nIn most cases, an Endpoints object is backed by a Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) object with the same name and labels.", "items": { "description": "Endpoint defines an endpoint serving Prometheus metrics to be scraped by\nPrometheus.", "properties": { "authorization": { - "description": "`authorization` configures the Authorization header credentials to use when\nscraping the target.\n\nCannot be set at the same time as `basicAuth`, or `oauth2`.", + "description": "authorization configures the Authorization header credentials to use when\nscraping the target.\n\nCannot be set at the same time as `basicAuth`, or `oauth2`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -95,17 +95,17 @@ "x-kubernetes-map-type": "atomic" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "basicAuth": { - "description": "`basicAuth` configures the Basic Authentication credentials to use when\nscraping the target.\n\nCannot be set at the same time as `authorization`, or `oauth2`.", + "description": "basicAuth defines the Basic Authentication credentials to use when\nscraping the target.\n\nCannot be set at the same time as `authorization`, or `oauth2`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -128,7 +128,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -154,11 +154,11 @@ "type": "object" }, "bearerTokenFile": { - "description": "File to read bearer token for scraping the target.\n\nDeprecated: use `authorization` instead.", + "description": "bearerTokenFile defines the file to read bearer token for scraping the target.\n\nDeprecated: use `authorization` instead.", "type": "string" }, "bearerTokenSecret": { - "description": "`bearerTokenSecret` specifies a key of a Secret containing the bearer\ntoken for scraping targets. The secret needs to be in the same namespace\nas the ServiceMonitor object and readable by the Prometheus Operator.\n\nDeprecated: use `authorization` instead.", + "description": "bearerTokenSecret defines a key of a Secret containing the bearer\ntoken for scraping targets. The secret needs to be in the same namespace\nas the ServiceMonitor object and readable by the Prometheus Operator.\n\nDeprecated: use `authorization` instead.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -181,38 +181,38 @@ "x-kubernetes-map-type": "atomic" }, "enableHttp2": { - "description": "`enableHttp2` can be used to disable HTTP2 when scraping the target.", + "description": "enableHttp2 can be used to disable HTTP2 when scraping the target.", "type": "boolean" }, "filterRunning": { - "description": "When true, the pods which are not running (e.g. either in Failed or\nSucceeded state) are dropped during the target discovery.\n\nIf unset, the filtering is enabled.\n\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase", + "description": "filterRunning when true, the pods which are not running (e.g. either in Failed or\nSucceeded state) are dropped during the target discovery.\n\nIf unset, the filtering is enabled.\n\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase", "type": "boolean" }, "followRedirects": { - "description": "`followRedirects` defines whether the scrape requests should follow HTTP\n3xx redirects.", + "description": "followRedirects defines whether the scrape requests should follow HTTP\n3xx redirects.", "type": "boolean" }, "honorLabels": { - "description": "When true, `honorLabels` preserves the metric's labels when they collide\nwith the target's labels.", + "description": "honorLabels defines when true the metric's labels when they collide\nwith the target's labels.", "type": "boolean" }, "honorTimestamps": { - "description": "`honorTimestamps` controls whether Prometheus preserves the timestamps\nwhen exposed by the target.", + "description": "honorTimestamps defines whether Prometheus preserves the timestamps\nwhen exposed by the target.", "type": "boolean" }, "interval": { - "description": "Interval at which Prometheus scrapes the metrics from the target.\n\nIf empty, Prometheus uses the global scrape interval.", + "description": "interval at which Prometheus scrapes the metrics from the target.\n\nIf empty, Prometheus uses the global scrape interval.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "metricRelabelings": { - "description": "`metricRelabelings` configures the relabeling rules to apply to the\nsamples before ingestion.", + "description": "metricRelabelings defines the relabeling rules to apply to the\nsamples before ingestion.", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -240,24 +240,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -266,7 +266,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -275,17 +275,17 @@ "type": "array" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "`oauth2` configures the OAuth2 settings to use when scraping the target.\n\nIt requires Prometheus >= 2.27.0.\n\nCannot be set at the same time as `authorization`, or `basicAuth`.", + "description": "oauth2 defines the OAuth2 settings to use when scraping the target.\n\nIt requires Prometheus >= 2.27.0.\n\nCannot be set at the same time as `authorization`, or `basicAuth`.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -308,7 +308,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -334,7 +334,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -360,11 +360,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -394,34 +394,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -444,7 +444,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -470,10 +470,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -496,7 +496,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -522,11 +522,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -549,7 +549,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -559,7 +559,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -569,14 +569,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -599,11 +599,11 @@ "type": "object" }, "path": { - "description": "HTTP path from which to scrape for metrics.\n\nIf empty, Prometheus uses the default value (e.g. `/metrics`).", + "description": "path defines the HTTP path from which to scrape for metrics.\n\nIf empty, Prometheus uses the default value (e.g. `/metrics`).", "type": "string" }, "port": { - "description": "Name of the Service port which this endpoint refers to.\n\nIt takes precedence over `targetPort`.", + "description": "port defines the name of the Service port which this endpoint refers to.\n\nIt takes precedence over `targetPort`.", "type": "string" }, "proxyConnectHeader": { @@ -633,27 +633,27 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "relabelings": { - "description": "`relabelings` configures the relabeling rules to apply the target's\nmetadata labels.\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\n\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", + "description": "relabelings defines the relabeling rules to apply the target's\nmetadata labels.\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields.\n\nThe original scrape job's name is available via the `__tmp_prometheus_job_name` label.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -681,24 +681,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -707,7 +707,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -716,7 +716,7 @@ "type": "array" }, "scheme": { - "description": "HTTP scheme to use for scraping.\n\n`http` and `https` are the expected values unless you rewrite the\n`__scheme__` label via relabeling.\n\nIf empty, Prometheus uses the default value `http`.", + "description": "scheme defines the HTTP scheme to use for scraping.\n\n`http` and `https` are the expected values unless you rewrite the\n`__scheme__` label via relabeling.\n\nIf empty, Prometheus uses the default value `http`.", "enum": [ "http", "https" @@ -724,7 +724,7 @@ "type": "string" }, "scrapeTimeout": { - "description": "Timeout after which Prometheus considers the scrape to be failed.\n\nIf empty, Prometheus uses the global scrape timeout unless it is less\nthan the target's scrape interval value in which the latter is used.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.", + "description": "scrapeTimeout defines the timeout after which Prometheus considers the scrape to be failed.\n\nIf empty, Prometheus uses the global scrape timeout unless it is less\nthan the target's scrape interval value in which the latter is used.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, @@ -737,17 +737,17 @@ "type": "string" } ], - "description": "Name or number of the target port of the `Pod` object behind the\nService. The port must be specified with the container's port property.", + "description": "targetPort defines the name or number of the target port of the `Pod` object behind the\nService. The port must be specified with the container's port property.", "x-kubernetes-int-or-string": true }, "tlsConfig": { - "description": "TLS configuration to use when scraping the target.", + "description": "tlsConfig defines the TLS configuration to use when scraping the target.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -770,7 +770,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -796,14 +796,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -826,7 +826,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -852,19 +852,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -887,7 +887,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -897,7 +897,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -907,14 +907,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "trackTimestampsStaleness": { - "description": "`trackTimestampsStaleness` defines whether Prometheus tracks staleness of\nthe metrics that have an explicit timestamp present in scraped data.\nHas no effect if `honorTimestamps` is false.\n\nIt requires Prometheus >= v2.48.0.", + "description": "trackTimestampsStaleness defines whether Prometheus tracks staleness of\nthe metrics that have an explicit timestamp present in scraped data.\nHas no effect if `honorTimestamps` is false.\n\nIt requires Prometheus >= v2.48.0.", "type": "boolean" } }, @@ -923,7 +923,7 @@ "type": "array" }, "fallbackScrapeProtocol": { - "description": "The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\n\nIt requires Prometheus >= v3.0.0.", + "description": "fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\n\nIt requires Prometheus >= v3.0.0.", "enum": [ "PrometheusProto", "OpenMetricsText0.0.1", @@ -934,38 +934,38 @@ "type": "string" }, "jobLabel": { - "description": "`jobLabel` selects the label from the associated Kubernetes `Service`\nobject which will be used as the `job` label for all metrics.\n\nFor example if `jobLabel` is set to `foo` and the Kubernetes `Service`\nobject is labeled with `foo: bar`, then Prometheus adds the `job=\"bar\"`\nlabel to all ingested metrics.\n\nIf the value of this field is empty or if the label doesn't exist for\nthe given Service, the `job` label of the metrics defaults to the name\nof the associated Kubernetes `Service`.", + "description": "jobLabel selects the label from the associated Kubernetes `Service`\nobject which will be used as the `job` label for all metrics.\n\nFor example if `jobLabel` is set to `foo` and the Kubernetes `Service`\nobject is labeled with `foo: bar`, then Prometheus adds the `job=\"bar\"`\nlabel to all ingested metrics.\n\nIf the value of this field is empty or if the label doesn't exist for\nthe given Service, the `job` label of the metrics defaults to the name\nof the associated Kubernetes `Service`.", "type": "string" }, "keepDroppedTargets": { - "description": "Per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\nIt requires Prometheus >= v2.47.0.", + "description": "keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\nIt requires Prometheus >= v2.47.0.", "format": "int64", "type": "integer" }, "labelLimit": { - "description": "Per-scrape limit on number of labels that will be accepted for a sample.\n\nIt requires Prometheus >= v2.27.0.", + "description": "labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample.\n\nIt requires Prometheus >= v2.27.0.", "format": "int64", "type": "integer" }, "labelNameLengthLimit": { - "description": "Per-scrape limit on length of labels name that will be accepted for a sample.\n\nIt requires Prometheus >= v2.27.0.", + "description": "labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample.\n\nIt requires Prometheus >= v2.27.0.", "format": "int64", "type": "integer" }, "labelValueLengthLimit": { - "description": "Per-scrape limit on length of labels value that will be accepted for a sample.\n\nIt requires Prometheus >= v2.27.0.", + "description": "labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample.\n\nIt requires Prometheus >= v2.27.0.", "format": "int64", "type": "integer" }, "namespaceSelector": { - "description": "`namespaceSelector` defines in which namespace(s) Prometheus should discover the services.\nBy default, the services are discovered in the same namespace as the `ServiceMonitor` object but it is possible to select pods across different/all namespaces.", + "description": "namespaceSelector defines in which namespace(s) Prometheus should discover the services.\nBy default, the services are discovered in the same namespace as the `ServiceMonitor` object but it is possible to select pods across different/all namespaces.", "properties": { "any": { - "description": "Boolean describing whether all namespaces are selected in contrast to a\nlist restricting them.", + "description": "any defines the boolean describing whether all namespaces are selected in contrast to a\nlist restricting them.", "type": "boolean" }, "matchNames": { - "description": "List of namespace names to select from.", + "description": "matchNames defines the list of namespace names to select from.", "items": { "type": "string" }, @@ -975,7 +975,7 @@ "type": "object" }, "nativeHistogramBucketLimit": { - "description": "If there are more than this many buckets in a native histogram,\nbuckets will be merged to stay within the limit.\nIt requires Prometheus >= v2.45.0.", + "description": "nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram,\nbuckets will be merged to stay within the limit.\nIt requires Prometheus >= v2.45.0.", "format": "int64", "type": "integer" }, @@ -988,33 +988,33 @@ "type": "string" } ], - "description": "If the growth factor of one bucket to the next is smaller than this,\nbuckets will be merged to increase the factor sufficiently.\nIt requires Prometheus >= v2.50.0.", + "description": "nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this,\nbuckets will be merged to increase the factor sufficiently.\nIt requires Prometheus >= v2.50.0.", "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "x-kubernetes-int-or-string": true }, "podTargetLabels": { - "description": "`podTargetLabels` defines the labels which are transferred from the\nassociated Kubernetes `Pod` object onto the ingested metrics.", + "description": "podTargetLabels defines the labels which are transferred from the\nassociated Kubernetes `Pod` object onto the ingested metrics.", "items": { "type": "string" }, "type": "array" }, "sampleLimit": { - "description": "`sampleLimit` defines a per-scrape limit on the number of scraped samples\nthat will be accepted.", + "description": "sampleLimit defines a per-scrape limit on the number of scraped samples\nthat will be accepted.", "format": "int64", "type": "integer" }, "scrapeClass": { - "description": "The scrape class to apply.", + "description": "scrapeClass defines the scrape class to apply.", "minLength": 1, "type": "string" }, "scrapeClassicHistograms": { - "description": "Whether to scrape a classic histogram that is also exposed as a native histogram.\nIt requires Prometheus >= v2.45.0.\n\nNotice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.", + "description": "scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram.\nIt requires Prometheus >= v2.45.0.\n\nNotice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.", "type": "boolean" }, "scrapeProtocols": { - "description": "`scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0.", + "description": "scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus >= v2.49.0.", "items": { "description": "ScrapeProtocol represents a protocol used by Prometheus for scraping metrics.\nSupported values are:\n* `OpenMetricsText0.0.1`\n* `OpenMetricsText1.0.0`\n* `PrometheusProto`\n* `PrometheusText0.0.4`\n* `PrometheusText1.0.0`", "enum": [ @@ -1030,7 +1030,7 @@ "x-kubernetes-list-type": "set" }, "selector": { - "description": "Label selector to select the Kubernetes `Endpoints` objects to scrape metrics from.", + "description": "selector defines the label selector to select the Kubernetes `Endpoints` objects to scrape metrics from.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -1075,7 +1075,7 @@ "x-kubernetes-map-type": "atomic" }, "selectorMechanism": { - "description": "Mechanism used to select the endpoints to scrape.\nBy default, the selection process relies on relabel configurations to filter the discovered targets.\nAlternatively, you can opt in for role selectors, which may offer better efficiency in large clusters.\nWhich strategy is best for your use case needs to be carefully evaluated.\n\nIt requires Prometheus >= v2.17.0.", + "description": "selectorMechanism defines the mechanism used to select the endpoints to scrape.\nBy default, the selection process relies on relabel configurations to filter the discovered targets.\nAlternatively, you can opt in for role selectors, which may offer better efficiency in large clusters.\nWhich strategy is best for your use case needs to be carefully evaluated.\n\nIt requires Prometheus >= v2.17.0.", "enum": [ "RelabelConfig", "RoleSelector" @@ -1083,14 +1083,14 @@ "type": "string" }, "targetLabels": { - "description": "`targetLabels` defines the labels which are transferred from the\nassociated Kubernetes `Service` object onto the ingested metrics.", + "description": "targetLabels defines the labels which are transferred from the\nassociated Kubernetes `Service` object onto the ingested metrics.", "items": { "type": "string" }, "type": "array" }, "targetLimit": { - "description": "`targetLimit` defines a limit on the number of scraped targets that will\nbe accepted.", + "description": "targetLimit defines a limit on the number of scraped targets that will\nbe accepted.", "format": "int64", "type": "integer" } @@ -1102,43 +1102,43 @@ "type": "object" }, "status": { - "description": "This Status subresource is under active development and is updated only when the\n\"StatusForConfigurationResources\" feature gate is enabled.\n\nMost recent observed status of the ServiceMonitor. Read-only.\nMore info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", + "description": "status defines the status subresource is under active development and is updated only when the\n\"StatusForConfigurationResources\" feature gate is enabled.\n\nMost recent observed status of the ServiceMonitor. Read-only.\nMore info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "bindings": { - "description": "The list of workload resources (Prometheus or PrometheusAgent) which select the configuration resource.", + "description": "bindings defines the list of workload resources (Prometheus or PrometheusAgent) which select the configuration resource.", "items": { "description": "WorkloadBinding is a link between a configuration resource and a workload resource.", "properties": { "conditions": { - "description": "The current state of the configuration resource when bound to the referenced Prometheus object.", + "description": "conditions defines the current state of the configuration resource when bound to the referenced Prometheus object.", "items": { "description": "ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager, or ThanosRuler.", "properties": { "lastTransitionTime": { - "description": "LastTransitionTime is the time of the last update to the current status property.", + "description": "lastTransitionTime defines the time of the last update to the current status property.", "format": "date-time", "type": "string" }, "message": { - "description": "Human-readable message indicating details for the condition's last transition.", + "description": "message defines the human-readable message indicating details for the condition's last transition.", "type": "string" }, "observedGeneration": { - "description": "ObservedGeneration represents the .metadata.generation that the\ncondition was set based upon. For instance, if `.metadata.generation` is\ncurrently 12, but the `.status.conditions[].observedGeneration` is 9, the\ncondition is out of date with respect to the current state of the object.", + "description": "observedGeneration defines the .metadata.generation that the\ncondition was set based upon. For instance, if `.metadata.generation` is\ncurrently 12, but the `.status.conditions[].observedGeneration` is 9, the\ncondition is out of date with respect to the current state of the object.", "format": "int64", "type": "integer" }, "reason": { - "description": "Reason for the condition's last transition.", + "description": "reason for the condition's last transition.", "type": "string" }, "status": { - "description": "Status of the condition.", + "description": "status of the condition.", "minLength": 1, "type": "string" }, "type": { - "description": "Type of the condition being reported.\nCurrently, only \"Accepted\" is supported.", + "description": "type of the condition being reported.\nCurrently, only \"Accepted\" is supported.", "enum": [ "Accepted" ], @@ -1160,24 +1160,24 @@ "x-kubernetes-list-type": "map" }, "group": { - "description": "The group of the referenced resource.", + "description": "group defines the group of the referenced resource.", "enum": [ "monitoring.coreos.com" ], "type": "string" }, "name": { - "description": "The name of the referenced object.", + "description": "name defines the name of the referenced object.", "minLength": 1, "type": "string" }, "namespace": { - "description": "The namespace of the referenced object.", + "description": "namespace defines the namespace of the referenced object.", "minLength": 1, "type": "string" }, "resource": { - "description": "The type of resource being referenced (e.g. Prometheus or PrometheusAgent).", + "description": "resource defines the type of resource being referenced (e.g. Prometheus or PrometheusAgent).", "enum": [ "prometheuses", "prometheusagents" diff --git a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/thanosrulers-crd.json b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/thanosrulers-crd.json index 1516e9ed..0919f5e4 100644 --- a/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/thanosrulers-crd.json +++ b/vendor/github.com/prometheus-operator/prometheus-operator/jsonnet/prometheus-operator/thanosrulers-crd.json @@ -3,7 +3,7 @@ "kind": "CustomResourceDefinition", "metadata": { "annotations": { - "controller-gen.kubebuilder.io/version": "v0.18.0", + "controller-gen.kubebuilder.io/version": "v0.19.0", "operator.prometheus.io/version": "0.85.0" }, "name": "thanosrulers.monitoring.coreos.com" @@ -84,20 +84,20 @@ "type": "object" }, "spec": { - "description": "Specification of the desired behavior of the ThanosRuler cluster. More info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", + "description": "spec defines the specification of the desired behavior of the ThanosRuler cluster. More info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "additionalArgs": { - "description": "AdditionalArgs allows setting additional arguments for the ThanosRuler container.\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nThanosRuler container which may cause issues if they are invalid or not supported\nby the given ThanosRuler version.\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument the reconciliation will\nfail and an error will be logged.", + "description": "additionalArgs defines how to add additional arguments for the ThanosRuler container.\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nThanosRuler container which may cause issues if they are invalid or not supported\nby the given ThanosRuler version.\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument the reconciliation will\nfail and an error will be logged.", "items": { "description": "Argument as part of the AdditionalArgs list.", "properties": { "name": { - "description": "Name of the argument, e.g. \"scrape.discovery-reload-interval\".", + "description": "name of the argument, e.g. \"scrape.discovery-reload-interval\".", "minLength": 1, "type": "string" }, "value": { - "description": "Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)", + "description": "value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)", "type": "string" } }, @@ -109,7 +109,7 @@ "type": "array" }, "affinity": { - "description": "If specified, the pod's scheduling constraints.", + "description": "affinity defines when specified, the pod's scheduling constraints.", "properties": { "nodeAffinity": { "description": "Describes node affinity scheduling rules for the pod.", @@ -864,22 +864,22 @@ "type": "object" }, "alertDropLabels": { - "description": "Configures the label names which should be dropped in Thanos Ruler\nalerts.\n\nThe replica label `thanos_ruler_replica` will always be dropped from the alerts.", + "description": "alertDropLabels defines the label names which should be dropped in Thanos Ruler\nalerts.\n\nThe replica label `thanos_ruler_replica` will always be dropped from the alerts.", "items": { "type": "string" }, "type": "array" }, "alertQueryUrl": { - "description": "The external Query URL the Thanos Ruler will set in the 'Source' field\nof all alerts.\nMaps to the '--alert.query-url' CLI arg.", + "description": "alertQueryUrl defines how Thanos Ruler will set in the 'Source' field\nof all alerts.\nMaps to the '--alert.query-url' CLI arg.", "type": "string" }, "alertRelabelConfigFile": { - "description": "Configures the path to the alert relabeling configuration file.\n\nAlert relabel configuration must have the form as specified in the\nofficial Prometheus documentation:\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs\n\nThe operator performs no validation of the configuration file.\n\nThis field takes precedence over `alertRelabelConfig`.", + "description": "alertRelabelConfigFile defines the path to the alert relabeling configuration file.\n\nAlert relabel configuration must have the form as specified in the\nofficial Prometheus documentation:\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs\n\nThe operator performs no validation of the configuration file.\n\nThis field takes precedence over `alertRelabelConfig`.", "type": "string" }, "alertRelabelConfigs": { - "description": "Configures alert relabeling in Thanos Ruler.\n\nAlert relabel configuration must have the form as specified in the\nofficial Prometheus documentation:\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs\n\nThe operator performs no validation of the configuration.\n\n`alertRelabelConfigFile` takes precedence over this field.", + "description": "alertRelabelConfigs defines the alert relabeling in Thanos Ruler.\n\nAlert relabel configuration must have the form as specified in the\nofficial Prometheus documentation:\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs\n\nThe operator performs no validation of the configuration.\n\n`alertRelabelConfigFile` takes precedence over this field.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -902,7 +902,7 @@ "x-kubernetes-map-type": "atomic" }, "alertmanagersConfig": { - "description": "Configures the list of Alertmanager endpoints to send alerts to.\n\nThe configuration format is defined at https://thanos.io/tip/components/rule.md/#alertmanager.\n\nIt requires Thanos >= v0.10.0.\n\nThe operator performs no validation of the configuration.\n\nThis field takes precedence over `alertmanagersUrl`.", + "description": "alertmanagersConfig defines the list of Alertmanager endpoints to send alerts to.\n\nThe configuration format is defined at https://thanos.io/tip/components/rule.md/#alertmanager.\n\nIt requires Thanos >= v0.10.0.\n\nThe operator performs no validation of the configuration.\n\nThis field takes precedence over `alertmanagersUrl`.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -925,14 +925,14 @@ "x-kubernetes-map-type": "atomic" }, "alertmanagersUrl": { - "description": "Configures the list of Alertmanager endpoints to send alerts to.\n\nFor Thanos >= v0.10.0, it is recommended to use `alertmanagersConfig` instead.\n\n`alertmanagersConfig` takes precedence over this field.", + "description": "alertmanagersUrl defines the list of Alertmanager endpoints to send alerts to.\n\nFor Thanos >= v0.10.0, it is recommended to use `alertmanagersConfig` instead.\n\n`alertmanagersConfig` takes precedence over this field.", "items": { "type": "string" }, "type": "array" }, "containers": { - "description": "Containers allows injecting additional containers or modifying operator generated\ncontainers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or\nto change the behavior of an operator generated container. Containers described here modify\nan operator generated container if they share the same name and modifications are done via a\nstrategic merge patch. The current container names are: `thanos-ruler` and `config-reloader`.\nOverriding containers is entirely outside the scope of what the maintainers will support and by doing\nso, you accept that this behaviour may break at any time without notice.", + "description": "containers allows injecting additional containers or modifying operator generated\ncontainers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or\nto change the behavior of an operator generated container. Containers described here modify\nan operator generated container if they share the same name and modifications are done via a\nstrategic merge patch. The current container names are: `thanos-ruler` and `config-reloader`.\nOverriding containers is entirely outside the scope of what the maintainers will support and by doing\nso, you accept that this behaviour may break at any time without notice.", "items": { "description": "A single application container that you want to run within a pod.", "properties": { @@ -2270,10 +2270,10 @@ "type": "array" }, "dnsConfig": { - "description": "Defines the DNS configuration for the pods.", + "description": "dnsConfig defines Defines the DNS configuration for the pods.", "properties": { "nameservers": { - "description": "A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.", + "description": "nameservers defines the list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.", "items": { "minLength": 1, "type": "string" @@ -2282,17 +2282,17 @@ "x-kubernetes-list-type": "set" }, "options": { - "description": "A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nResolution options given in Options\nwill override those that appear in the base DNSPolicy.", + "description": "options defines the list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nResolution options given in Options\nwill override those that appear in the base DNSPolicy.", "items": { "description": "PodDNSConfigOption defines DNS resolver options of a pod.", "properties": { "name": { - "description": "Name is required and must be unique.", + "description": "name is required and must be unique.", "minLength": 1, "type": "string" }, "value": { - "description": "Value is optional.", + "description": "value is optional.", "type": "string" } }, @@ -2308,7 +2308,7 @@ "x-kubernetes-list-type": "map" }, "searches": { - "description": "A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.", + "description": "searches defines the list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.", "items": { "minLength": 1, "type": "string" @@ -2320,7 +2320,7 @@ "type": "object" }, "dnsPolicy": { - "description": "Defines the DNS policy for the pods.", + "description": "dnsPolicy defines the DNS policy for the pods.", "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", @@ -2330,7 +2330,7 @@ "type": "string" }, "enableFeatures": { - "description": "Enable access to Thanos Ruler feature flags. By default, no features are enabled.\n\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\nFor more information see https://thanos.io/tip/components/rule.md/\n\nIt requires Thanos >= 0.39.0.", + "description": "enableFeatures defines how to setup Thanos Ruler feature flags. By default, no features are enabled.\n\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\nFor more information see https://thanos.io/tip/components/rule.md/\n\nIt requires Thanos >= 0.39.0.", "items": { "minLength": 1, "type": "string" @@ -2339,43 +2339,43 @@ "x-kubernetes-list-type": "set" }, "enableServiceLinks": { - "description": "Indicates whether information about services should be injected into pod's environment variables", + "description": "enableServiceLinks defines whether information about services should be injected into pod's environment variables", "type": "boolean" }, "enforcedNamespaceLabel": { - "description": "EnforcedNamespaceLabel enforces adding a namespace label of origin for each alert\nand metric that is user created. The label value will always be the namespace of the object that is\nbeing created.", + "description": "enforcedNamespaceLabel enforces adding a namespace label of origin for each alert\nand metric that is user created. The label value will always be the namespace of the object that is\nbeing created.", "type": "string" }, "evaluationInterval": { "default": "15s", - "description": "Interval between consecutive evaluations.", + "description": "evaluationInterval defines the interval between consecutive evaluations.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "excludedFromEnforcement": { - "description": "List of references to PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\nApplies only if enforcedNamespaceLabel set to true.", + "description": "excludedFromEnforcement defines the list of references to PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\nApplies only if enforcedNamespaceLabel set to true.", "items": { "description": "ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.", "properties": { "group": { "default": "monitoring.coreos.com", - "description": "Group of the referent. When not specified, it defaults to `monitoring.coreos.com`", + "description": "group of the referent. When not specified, it defaults to `monitoring.coreos.com`", "enum": [ "monitoring.coreos.com" ], "type": "string" }, "name": { - "description": "Name of the referent. When not set, all resources in the namespace are matched.", + "description": "name of the referent. When not set, all resources in the namespace are matched.", "type": "string" }, "namespace": { - "description": "Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/", + "description": "namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/", "minLength": 1, "type": "string" }, "resource": { - "description": "Resource of the referent.", + "description": "resource of the referent.", "enum": [ "prometheusrules", "servicemonitors", @@ -2395,17 +2395,17 @@ "type": "array" }, "externalPrefix": { - "description": "The external URL the Thanos Ruler instances will be available under. This is\nnecessary to generate correct URLs. This is necessary if Thanos Ruler is not\nserved from root of a DNS name.", + "description": "externalPrefix defines the Thanos Ruler instances will be available under. This is\nnecessary to generate correct URLs. This is necessary if Thanos Ruler is not\nserved from root of a DNS name.", "type": "string" }, "grpcServerTlsConfig": { - "description": "GRPCServerTLSConfig configures the gRPC server from which Thanos Querier reads\nrecorded rule data.\nNote: Currently only the CAFile, CertFile, and KeyFile fields are supported.\nMaps to the '--grpc-server-tls-*' CLI args.", + "description": "grpcServerTlsConfig defines the gRPC server from which Thanos Querier reads\nrecorded rule data.\nNote: Currently only the CAFile, CertFile, and KeyFile fields are supported.\nMaps to the '--grpc-server-tls-*' CLI args.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2428,7 +2428,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2454,14 +2454,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -2484,7 +2484,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2510,19 +2510,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -2545,7 +2545,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -2555,7 +2555,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -2565,26 +2565,26 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "hostAliases": { - "description": "Pods' hostAliases configuration", + "description": "hostAliases defines pods' hostAliases configuration", "items": { "description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the\npod's hosts file.", "properties": { "hostnames": { - "description": "Hostnames for the above IP address.", + "description": "hostnames defines hostnames for the above IP address.", "items": { "type": "string" }, "type": "array" }, "ip": { - "description": "IP address of the host file entry.", + "description": "ip defines the IP address of the host file entry.", "type": "string" } }, @@ -2601,15 +2601,15 @@ "x-kubernetes-list-type": "map" }, "hostUsers": { - "description": "HostUsers supports the user space in Kubernetes.\n\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/\n\nThe feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled.\nStarting Kubernetes 1.33, the feature is enabled by default.", + "description": "hostUsers supports the user space in Kubernetes.\n\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/\n\nThe feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled.\nStarting Kubernetes 1.33, the feature is enabled by default.", "type": "boolean" }, "image": { - "description": "Thanos container image URL.", + "description": "image defines Thanos container image URL.", "type": "string" }, "imagePullPolicy": { - "description": "Image pull policy for the 'thanos', 'init-config-reloader' and 'config-reloader' containers.\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.", + "description": "imagePullPolicy defines for the 'thanos', 'init-config-reloader' and 'config-reloader' containers.\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.", "enum": [ "", "Always", @@ -2619,7 +2619,7 @@ "type": "string" }, "imagePullSecrets": { - "description": "An optional list of references to secrets in the same namespace\nto use for pulling thanos images from registries\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod", + "description": "imagePullSecrets defines an optional list of references to secrets in the same namespace\nto use for pulling thanos images from registries\nsee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod", "items": { "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { @@ -2635,7 +2635,7 @@ "type": "array" }, "initContainers": { - "description": "InitContainers allows adding initContainers to the pod definition. Those can be used to e.g.\nfetch secrets for injection into the ThanosRuler configuration from external sources. Any\nerrors during the execution of an initContainer will lead to a restart of the Pod.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nUsing initContainers for any use case other then secret fetching is entirely outside the scope\nof what the maintainers will support and by doing so, you accept that this behaviour may break\nat any time without notice.", + "description": "initContainers allows adding initContainers to the pod definition. Those can be used to e.g.\nfetch secrets for injection into the ThanosRuler configuration from external sources. Any\nerrors during the execution of an initContainer will lead to a restart of the Pod.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nUsing initContainers for any use case other then secret fetching is entirely outside the scope\nof what the maintainers will support and by doing so, you accept that this behaviour may break\nat any time without notice.", "items": { "description": "A single application container that you want to run within a pod.", "properties": { @@ -3976,15 +3976,15 @@ "additionalProperties": { "type": "string" }, - "description": "Configures the external label pairs of the ThanosRuler resource.\n\nA default replica label `thanos_ruler_replica` will be always added as a\nlabel with the value of the pod's name.", + "description": "labels defines the external label pairs of the ThanosRuler resource.\n\nA default replica label `thanos_ruler_replica` will be always added as a\nlabel with the value of the pod's name.", "type": "object" }, "listenLocal": { - "description": "ListenLocal makes the Thanos ruler listen on loopback, so that it\ndoes not bind against the Pod IP.", + "description": "listenLocal defines the Thanos ruler listen on loopback, so that it\ndoes not bind against the Pod IP.", "type": "boolean" }, "logFormat": { - "description": "Log format for ThanosRuler to be configured with.", + "description": "logFormat for ThanosRuler to be configured with.", "enum": [ "", "logfmt", @@ -3993,7 +3993,7 @@ "type": "string" }, "logLevel": { - "description": "Log level for ThanosRuler to be configured with.", + "description": "logLevel for ThanosRuler to be configured with.", "enum": [ "", "debug", @@ -4004,7 +4004,7 @@ "type": "string" }, "minReadySeconds": { - "description": "Minimum number of seconds for which a newly created pod should be ready\nwithout any of its container crashing for it to be considered available.\n\nIf unset, pods will be considered available as soon as they are ready.", + "description": "minReadySeconds defines the minimum number of seconds for which a newly created pod should be ready\nwithout any of its container crashing for it to be considered available.\n\nIf unset, pods will be considered available as soon as they are ready.", "format": "int32", "minimum": 0, "type": "integer" @@ -4013,11 +4013,11 @@ "additionalProperties": { "type": "string" }, - "description": "Define which Nodes the Pods are scheduled on.", + "description": "nodeSelector defines which Nodes the Pods are scheduled on.", "type": "object" }, "objectStorageConfig": { - "description": "Configures object storage.\n\nThe configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage\n\nThe operator performs no validation of the configuration.\n\n`objectStorageConfigFile` takes precedence over this field.", + "description": "objectStorageConfig defines the configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage\n\nThe operator performs no validation of the configuration.\n\n`objectStorageConfigFile` takes precedence over this field.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4040,32 +4040,32 @@ "x-kubernetes-map-type": "atomic" }, "objectStorageConfigFile": { - "description": "Configures the path of the object storage configuration file.\n\nThe configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage\n\nThe operator performs no validation of the configuration file.\n\nThis field takes precedence over `objectStorageConfig`.", + "description": "objectStorageConfigFile defines the path of the object storage configuration file.\n\nThe configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage\n\nThe operator performs no validation of the configuration file.\n\nThis field takes precedence over `objectStorageConfig`.", "type": "string" }, "paused": { - "description": "When a ThanosRuler deployment is paused, no actions except for deletion\nwill be performed on the underlying objects.", + "description": "paused defines when a ThanosRuler deployment is paused, no actions except for deletion\nwill be performed on the underlying objects.", "type": "boolean" }, "podMetadata": { - "description": "PodMetadata configures labels and annotations which are propagated to the ThanosRuler pods.\n\nThe following items are reserved and cannot be overridden:\n* \"app.kubernetes.io/name\" label, set to \"thanos-ruler\".\n* \"app.kubernetes.io/managed-by\" label, set to \"prometheus-operator\".\n* \"app.kubernetes.io/instance\" label, set to the name of the ThanosRuler instance.\n* \"thanos-ruler\" label, set to the name of the ThanosRuler instance.\n* \"kubectl.kubernetes.io/default-container\" annotation, set to \"thanos-ruler\".", + "description": "podMetadata defines labels and annotations which are propagated to the ThanosRuler pods.\n\nThe following items are reserved and cannot be overridden:\n* \"app.kubernetes.io/name\" label, set to \"thanos-ruler\".\n* \"app.kubernetes.io/managed-by\" label, set to \"prometheus-operator\".\n* \"app.kubernetes.io/instance\" label, set to the name of the ThanosRuler instance.\n* \"thanos-ruler\" label, set to the name of the ThanosRuler instance.\n* \"kubectl.kubernetes.io/default-container\" annotation, set to \"thanos-ruler\".", "properties": { "annotations": { "additionalProperties": { "type": "string" }, - "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", + "description": "annotations defines an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", + "description": "labels define the map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "type": "object" }, "name": { - "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", + "description": "name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", "type": "string" } }, @@ -4073,24 +4073,24 @@ }, "portName": { "default": "web", - "description": "Port name used for the pods and governing service.\nDefaults to `web`.", + "description": "portName defines the port name used for the pods and governing service.\nDefaults to `web`.", "type": "string" }, "priorityClassName": { - "description": "Priority class assigned to the Pods", + "description": "priorityClassName defines the priority class assigned to the Pods", "type": "string" }, "prometheusRulesExcludedFromEnforce": { - "description": "PrometheusRulesExcludedFromEnforce - list of Prometheus rules to be excluded from enforcing\nof adding namespace labels. Works only if enforcedNamespaceLabel set to true.\nMake sure both ruleNamespace and ruleName are set for each pair\nDeprecated: use excludedFromEnforcement instead.", + "description": "prometheusRulesExcludedFromEnforce defines a list of Prometheus rules to be excluded from enforcing\nof adding namespace labels. Works only if enforcedNamespaceLabel set to true.\nMake sure both ruleNamespace and ruleName are set for each pair\nDeprecated: use excludedFromEnforcement instead.", "items": { "description": "PrometheusRuleExcludeConfig enables users to configure excluded\nPrometheusRule names and their namespaces to be ignored while enforcing\nnamespace label for alerts and metrics.", "properties": { "ruleName": { - "description": "Name of the excluded PrometheusRule object.", + "description": "ruleName defines the name of the excluded PrometheusRule object.", "type": "string" }, "ruleNamespace": { - "description": "Namespace of the excluded PrometheusRule object.", + "description": "ruleNamespace defines the namespace of the excluded PrometheusRule object.", "type": "string" } }, @@ -4103,7 +4103,7 @@ "type": "array" }, "queryConfig": { - "description": "Configures the list of Thanos Query endpoints from which to query metrics.\n\nThe configuration format is defined at https://thanos.io/tip/components/rule.md/#query-api\n\nIt requires Thanos >= v0.11.0.\n\nThe operator performs no validation of the configuration.\n\nThis field takes precedence over `queryEndpoints`.", + "description": "queryConfig defines the list of Thanos Query endpoints from which to query metrics.\n\nThe configuration format is defined at https://thanos.io/tip/components/rule.md/#query-api\n\nIt requires Thanos >= v0.11.0.\n\nThe operator performs no validation of the configuration.\n\nThis field takes precedence over `queryEndpoints`.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4126,22 +4126,22 @@ "x-kubernetes-map-type": "atomic" }, "queryEndpoints": { - "description": "Configures the list of Thanos Query endpoints from which to query metrics.\n\nFor Thanos >= v0.11.0, it is recommended to use `queryConfig` instead.\n\n`queryConfig` takes precedence over this field.", + "description": "queryEndpoints defines the list of Thanos Query endpoints from which to query metrics.\n\nFor Thanos >= v0.11.0, it is recommended to use `queryConfig` instead.\n\n`queryConfig` takes precedence over this field.", "items": { "type": "string" }, "type": "array" }, "remoteWrite": { - "description": "Defines the list of remote write configurations.\n\nWhen the list isn't empty, the ruler is configured with stateless mode.\n\nIt requires Thanos >= 0.24.0.", + "description": "remoteWrite defines the list of remote write configurations.\n\nWhen the list isn't empty, the ruler is configured with stateless mode.\n\nIt requires Thanos >= 0.24.0.", "items": { "description": "RemoteWriteSpec defines the configuration to write samples from Prometheus\nto a remote endpoint.", "properties": { "authorization": { - "description": "Authorization section for the URL.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`.", + "description": "authorization section for the URL.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`.", "properties": { "credentials": { - "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", + "description": "credentials defines a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4164,21 +4164,21 @@ "x-kubernetes-map-type": "atomic" }, "credentialsFile": { - "description": "File to read a secret from, mutually exclusive with `credentials`.", + "description": "credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`.", "type": "string" }, "type": { - "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", + "description": "type defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": "string" } }, "type": "object" }, "azureAd": { - "description": "AzureAD for the URL.\n\nIt requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`.", + "description": "azureAd for the URL.\n\nIt requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`.", "properties": { "cloud": { - "description": "The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'.", + "description": "cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'.", "enum": [ "AzureChina", "AzureGovernment", @@ -4187,10 +4187,10 @@ "type": "string" }, "managedIdentity": { - "description": "ManagedIdentity defines the Azure User-assigned Managed identity.\nCannot be set at the same time as `oauth` or `sdk`.", + "description": "managedIdentity defines the Azure User-assigned Managed identity.\nCannot be set at the same time as `oauth` or `sdk`.", "properties": { "clientId": { - "description": "The client id", + "description": "clientId defines defines the Azure User-assigned Managed identity.", "type": "string" } }, @@ -4200,15 +4200,15 @@ "type": "object" }, "oauth": { - "description": "OAuth defines the oauth config that is being used to authenticate.\nCannot be set at the same time as `managedIdentity` or `sdk`.\n\nIt requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.", + "description": "oauth defines the oauth config that is being used to authenticate.\nCannot be set at the same time as `managedIdentity` or `sdk`.\n\nIt requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.", "properties": { "clientId": { - "description": "`clientID` is the clientId of the Azure Active Directory application that is being used to authenticate.", + "description": "clientId defines the clientId of the Azure Active Directory application that is being used to authenticate.", "minLength": 1, "type": "string" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.", + "description": "clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4231,7 +4231,7 @@ "x-kubernetes-map-type": "atomic" }, "tenantId": { - "description": "`tenantId` is the tenant ID of the Azure Active Directory application that is being used to authenticate.", + "description": "tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate.", "minLength": 1, "pattern": "^[0-9a-zA-Z-.]+$", "type": "string" @@ -4245,10 +4245,10 @@ "type": "object" }, "sdk": { - "description": "SDK defines the Azure SDK config that is being used to authenticate.\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication\nCannot be set at the same time as `oauth` or `managedIdentity`.\n\nIt requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.", + "description": "sdk defines the Azure SDK config that is being used to authenticate.\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication\nCannot be set at the same time as `oauth` or `managedIdentity`.\n\nIt requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.", "properties": { "tenantId": { - "description": "`tenantId` is the tenant ID of the azure active directory application that is being used to authenticate.", + "description": "tenantId defines the tenant ID of the azure active directory application that is being used to authenticate.", "pattern": "^[0-9a-zA-Z-.]+$", "type": "string" } @@ -4259,10 +4259,10 @@ "type": "object" }, "basicAuth": { - "description": "BasicAuth configuration for the URL.\n\nCannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`.", + "description": "basicAuth configuration for the URL.\n\nCannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`.", "properties": { "password": { - "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", + "description": "password defines a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4285,7 +4285,7 @@ "x-kubernetes-map-type": "atomic" }, "username": { - "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", + "description": "username defines a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4311,30 +4311,30 @@ "type": "object" }, "bearerToken": { - "description": "*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\nDeprecated: this will be removed in a future release.", + "description": "bearerToken is deprecated: this will be removed in a future release.\n*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*", "type": "string" }, "bearerTokenFile": { - "description": "File from which to read bearer token for the URL.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", + "description": "bearerTokenFile defines the file from which to read bearer token for the URL.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", "type": "string" }, "enableHTTP2": { - "description": "Whether to enable HTTP2.", + "description": "enableHTTP2 defines whether to enable HTTP2.", "type": "boolean" }, "followRedirects": { - "description": "Configure whether HTTP requests follow HTTP 3xx redirects.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.", + "description": "followRedirects defines whether HTTP requests follow HTTP 3xx redirects.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.", "type": "boolean" }, "headers": { "additionalProperties": { "type": "string" }, - "description": "Custom HTTP headers to be sent along with each remote write request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\n\nIt requires Prometheus >= v2.25.0 or Thanos >= v0.24.0.", + "description": "headers defines the custom HTTP headers to be sent along with each remote write request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\n\nIt requires Prometheus >= v2.25.0 or Thanos >= v0.24.0.", "type": "object" }, "messageVersion": { - "description": "The Remote Write message's version to use when writing to the endpoint.\n\n`Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0.\n`Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0.\n\nWhen `Version2.0` is selected, Prometheus will automatically be\nconfigured to append the metadata of scraped metrics to the WAL.\n\nBefore setting this field, consult with your remote storage provider\nwhat message version it supports.\n\nIt requires Prometheus >= v2.54.0 or Thanos >= v0.37.0.", + "description": "messageVersion defines the Remote Write message's version to use when writing to the endpoint.\n\n`Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0.\n`Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0.\n\nWhen `Version2.0` is selected, Prometheus will automatically be\nconfigured to append the metadata of scraped metrics to the WAL.\n\nBefore setting this field, consult with your remote storage provider\nwhat message version it supports.\n\nIt requires Prometheus >= v2.54.0 or Thanos >= v0.37.0.", "enum": [ "V1.0", "V2.0" @@ -4342,20 +4342,20 @@ "type": "string" }, "metadataConfig": { - "description": "MetadataConfig configures the sending of series metadata to the remote storage.", + "description": "metadataConfig defines how to send a series metadata to the remote storage.", "properties": { "maxSamplesPerSend": { - "description": "MaxSamplesPerSend is the maximum number of metadata samples per send.\n\nIt requires Prometheus >= v2.29.0.", + "description": "maxSamplesPerSend defines the maximum number of metadata samples per send.\n\nIt requires Prometheus >= v2.29.0.", "format": "int32", "minimum": -1, "type": "integer" }, "send": { - "description": "Defines whether metric metadata is sent to the remote storage or not.", + "description": "send defines whether metric metadata is sent to the remote storage or not.", "type": "boolean" }, "sendInterval": { - "description": "Defines how frequently metric metadata is sent to the remote storage.", + "description": "sendInterval defines how frequently metric metadata is sent to the remote storage.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" } @@ -4363,21 +4363,21 @@ "type": "object" }, "name": { - "description": "The name of the remote write queue, it must be unique if specified. The\nname is used in metrics and logging in order to differentiate queues.\n\nIt requires Prometheus >= v2.15.0 or Thanos >= 0.24.0.", + "description": "name of the remote write queue, it must be unique if specified. The\nname is used in metrics and logging in order to differentiate queues.\n\nIt requires Prometheus >= v2.15.0 or Thanos >= 0.24.0.", "type": "string" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "oauth2": { - "description": "OAuth2 configuration for the URL.\n\nIt requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`.", + "description": "oauth2 configuration for the URL.\n\nIt requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`.", "properties": { "clientId": { - "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", + "description": "clientId defines a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4400,7 +4400,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4426,7 +4426,7 @@ "type": "object" }, "clientSecret": { - "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", + "description": "clientSecret defines a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4452,11 +4452,11 @@ "additionalProperties": { "type": "string" }, - "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", + "description": "endpointParams configures the HTTP parameters to append to the token\nURL.", "type": "object" }, "noProxy": { - "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "string" }, "proxyConnectHeader": { @@ -4486,34 +4486,34 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "scopes": { - "description": "`scopes` defines the OAuth2 scopes used for the token request.", + "description": "scopes defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": "array" }, "tlsConfig": { - "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", + "description": "tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus >= v2.43.0.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4536,7 +4536,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4562,10 +4562,10 @@ "type": "object" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4588,7 +4588,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4614,11 +4614,11 @@ "type": "object" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4641,7 +4641,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -4651,7 +4651,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -4661,14 +4661,14 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "tokenUrl": { - "description": "`tokenURL` configures the URL to fetch the token from.", + "description": "tokenUrl defines the URL to fetch the token from.", "minLength": 1, "type": "string" } @@ -4707,63 +4707,63 @@ }, "type": "array" }, - "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "object", "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { - "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", + "description": "proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.", "type": "boolean" }, "proxyUrl": { - "description": "`proxyURL` defines the HTTP proxy server to use.", + "description": "proxyUrl defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": "string" }, "queueConfig": { - "description": "QueueConfig allows tuning of the remote write queue parameters.", + "description": "queueConfig allows tuning of the remote write queue parameters.", "properties": { "batchSendDeadline": { - "description": "BatchSendDeadline is the maximum time a sample will wait in buffer.", + "description": "batchSendDeadline defines the maximum time a sample will wait in buffer.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "capacity": { - "description": "Capacity is the number of samples to buffer per shard before we start\ndropping them.", + "description": "capacity defines the number of samples to buffer per shard before we start\ndropping them.", "type": "integer" }, "maxBackoff": { - "description": "MaxBackoff is the maximum retry delay.", + "description": "maxBackoff defines the maximum retry delay.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "maxRetries": { - "description": "MaxRetries is the maximum number of times to retry a batch on recoverable errors.", + "description": "maxRetries defines the maximum number of times to retry a batch on recoverable errors.", "type": "integer" }, "maxSamplesPerSend": { - "description": "MaxSamplesPerSend is the maximum number of samples per send.", + "description": "maxSamplesPerSend defines the maximum number of samples per send.", "type": "integer" }, "maxShards": { - "description": "MaxShards is the maximum number of shards, i.e. amount of concurrency.", + "description": "maxShards defines the maximum number of shards, i.e. amount of concurrency.", "type": "integer" }, "minBackoff": { - "description": "MinBackoff is the initial retry delay. Gets doubled for every retry.", + "description": "minBackoff defines the initial retry delay. Gets doubled for every retry.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "minShards": { - "description": "MinShards is the minimum number of shards, i.e. amount of concurrency.", + "description": "minShards defines the minimum number of shards, i.e. amount of concurrency.", "type": "integer" }, "retryOnRateLimit": { - "description": "Retry upon receiving a 429 status code from the remote-write storage.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", + "description": "retryOnRateLimit defines the retry upon receiving a 429 status code from the remote-write storage.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "type": "boolean" }, "sampleAgeLimit": { - "description": "SampleAgeLimit drops samples older than the limit.\nIt requires Prometheus >= v2.50.0 or Thanos >= v0.32.0.", + "description": "sampleAgeLimit drops samples older than the limit.\nIt requires Prometheus >= v2.50.0 or Thanos >= v0.32.0.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" } @@ -4771,27 +4771,27 @@ "type": "object" }, "remoteTimeout": { - "description": "Timeout for requests to the remote write endpoint.", + "description": "remoteTimeout defines the timeout for requests to the remote write endpoint.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "roundRobinDNS": { - "description": "When enabled:\n - The remote-write mechanism will resolve the hostname via DNS.\n - It will randomly select one of the resolved IP addresses and connect to it.\n\nWhen disabled (default behavior):\n - The Go standard library will handle hostname resolution.\n - It will attempt connections to each resolved IP address sequentially.\n\nNote: The connection timeout applies to the entire resolution and connection process.\n If disabled, the timeout is distributed across all connection attempts.\n\nIt requires Prometheus >= v3.1.0 or Thanos >= v0.38.0.", + "description": "roundRobinDNS controls the DNS resolution behavior for remote-write connections.\nWhen enabled:\n - The remote-write mechanism will resolve the hostname via DNS.\n - It will randomly select one of the resolved IP addresses and connect to it.\n\nWhen disabled (default behavior):\n - The Go standard library will handle hostname resolution.\n - It will attempt connections to each resolved IP address sequentially.\n\nNote: The connection timeout applies to the entire resolution and connection process.\n\n\tIf disabled, the timeout is distributed across all connection attempts.\n\nIt requires Prometheus >= v3.1.0 or Thanos >= v0.38.0.", "type": "boolean" }, "sendExemplars": { - "description": "Enables sending of exemplars over remote write. Note that\nexemplar-storage itself must be enabled using the `spec.enableFeatures`\noption for exemplars to be scraped in the first place.\n\nIt requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.", + "description": "sendExemplars enables sending of exemplars over remote write. Note that\nexemplar-storage itself must be enabled using the `spec.enableFeatures`\noption for exemplars to be scraped in the first place.\n\nIt requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.", "type": "boolean" }, "sendNativeHistograms": { - "description": "Enables sending of native histograms, also known as sparse histograms\nover remote write.\n\nIt requires Prometheus >= v2.40.0 or Thanos >= v0.30.0.", + "description": "sendNativeHistograms enables sending of native histograms, also known as sparse histograms\nover remote write.\n\nIt requires Prometheus >= v2.40.0 or Thanos >= v0.30.0.", "type": "boolean" }, "sigv4": { - "description": "Sigv4 allows to configures AWS's Signature Verification 4 for the URL.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`.", + "description": "sigv4 defines the AWS's Signature Verification 4 for the URL.\n\nIt requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`.", "properties": { "accessKey": { - "description": "AccessKey is the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.", + "description": "accessKey defines the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4814,19 +4814,19 @@ "x-kubernetes-map-type": "atomic" }, "profile": { - "description": "Profile is the named AWS profile used to authenticate.", + "description": "profile defines the named AWS profile used to authenticate.", "type": "string" }, "region": { - "description": "Region is the AWS region. If blank, the region from the default credentials chain used.", + "description": "region defines the AWS region. If blank, the region from the default credentials chain used.", "type": "string" }, "roleArn": { - "description": "RoleArn is the named AWS profile used to authenticate.", + "description": "roleArn defines the named AWS profile used to authenticate.", "type": "string" }, "secretKey": { - "description": "SecretKey is the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.", + "description": "secretKey defines the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4852,13 +4852,13 @@ "type": "object" }, "tlsConfig": { - "description": "TLS Config to use for the URL.", + "description": "tlsConfig to use for the URL.", "properties": { "ca": { - "description": "Certificate authority used when verifying server certificates.", + "description": "ca defines the Certificate authority used when verifying server certificates.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4881,7 +4881,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4907,14 +4907,14 @@ "type": "object" }, "caFile": { - "description": "Path to the CA cert in the Prometheus container to use for the targets.", + "description": "caFile defines the path to the CA cert in the Prometheus container to use for the targets.", "type": "string" }, "cert": { - "description": "Client certificate to present when doing client-authentication.", + "description": "cert defines the Client certificate to present when doing client-authentication.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -4937,7 +4937,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4963,19 +4963,19 @@ "type": "object" }, "certFile": { - "description": "Path to the client cert file in the Prometheus container for the targets.", + "description": "certFile defines the path to the client cert file in the Prometheus container for the targets.", "type": "string" }, "insecureSkipVerify": { - "description": "Disable target certificate validation.", + "description": "insecureSkipVerify defines how to disable target certificate validation.", "type": "boolean" }, "keyFile": { - "description": "Path to the client key file in the Prometheus container for the targets.", + "description": "keyFile defines the path to the client key file in the Prometheus container for the targets.", "type": "string" }, "keySecret": { - "description": "Secret containing the client key file for the targets.", + "description": "keySecret defines the Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -4998,7 +4998,7 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", + "description": "maxVersion defines the maximum acceptable TLS version.\n\nIt requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.", "enum": [ "TLS10", "TLS11", @@ -5008,7 +5008,7 @@ "type": "string" }, "minVersion": { - "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", + "description": "minVersion defines the minimum acceptable TLS version.\n\nIt requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.", "enum": [ "TLS10", "TLS11", @@ -5018,25 +5018,25 @@ "type": "string" }, "serverName": { - "description": "Used to verify the hostname for the targets.", + "description": "serverName is used to verify the hostname for the targets.", "type": "string" } }, "type": "object" }, "url": { - "description": "The URL of the endpoint to send samples to.", + "description": "url defines the URL of the endpoint to send samples to.", "minLength": 1, "type": "string" }, "writeRelabelConfigs": { - "description": "The list of remote write relabel configurations.", + "description": "writeRelabelConfigs defines the list of remote write relabel configurations.", "items": { "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", - "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", + "description": "action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", @@ -5064,24 +5064,24 @@ "type": "string" }, "modulus": { - "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", + "description": "modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": "integer" }, "regex": { - "description": "Regular expression against which the extracted value is matched.", + "description": "regex defines the regular expression against which the extracted value is matched.", "type": "string" }, "replacement": { - "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", + "description": "replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": "string" }, "separator": { - "description": "Separator is the string between concatenated SourceLabels.", + "description": "separator defines the string between concatenated SourceLabels.", "type": "string" }, "sourceLabels": { - "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", + "description": "sourceLabels defines the source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", @@ -5090,7 +5090,7 @@ "type": "array" }, "targetLabel": { - "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", + "description": "targetLabel defines the label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": "string" } }, @@ -5107,17 +5107,17 @@ "type": "array" }, "replicas": { - "description": "Number of thanos ruler instances to deploy.", + "description": "replicas defines the number of thanos ruler instances to deploy.", "format": "int32", "type": "integer" }, "resendDelay": { - "description": "Minimum amount of time to wait before resending an alert to Alertmanager.", + "description": "resendDelay defines the minimum amount of time to wait before resending an alert to Alertmanager.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "resources": { - "description": "Resources defines the resource requirements for single Pods.\nIf not provided, no requests/limits will be set", + "description": "resources defines the resource requirements for single Pods.\nIf not provided, no requests/limits will be set", "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis field depends on the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.", @@ -5181,27 +5181,27 @@ }, "retention": { "default": "24h", - "description": "Time duration ThanosRuler shall retain data for. Default is '24h', and\nmust match the regular expression `[0-9]+(ms|s|m|h|d|w|y)` (milliseconds\nseconds minutes hours days weeks years).\n\nThe field has no effect when remote-write is configured since the Ruler\noperates in stateless mode.", + "description": "retention defines the time duration ThanosRuler shall retain data for. Default is '24h', and\nmust match the regular expression `[0-9]+(ms|s|m|h|d|w|y)` (milliseconds\nseconds minutes hours days weeks years).\n\nThe field has no effect when remote-write is configured since the Ruler\noperates in stateless mode.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "routePrefix": { - "description": "The route prefix ThanosRuler registers HTTP handlers for. This allows thanos UI to be served on a sub-path.", + "description": "routePrefix defines the route prefix ThanosRuler registers HTTP handlers for. This allows thanos UI to be served on a sub-path.", "type": "string" }, "ruleConcurrentEval": { - "description": "How many rules can be evaluated concurrently.\nIt requires Thanos >= v0.37.0.", + "description": "ruleConcurrentEval defines how many rules can be evaluated concurrently.\nIt requires Thanos >= v0.37.0.", "format": "int32", "minimum": 1, "type": "integer" }, "ruleGracePeriod": { - "description": "Minimum duration between alert and restored \"for\" state.\nThis is maintained only for alerts with configured \"for\" time greater than grace period.\nIt requires Thanos >= v0.30.0.", + "description": "ruleGracePeriod defines the minimum duration between alert and restored \"for\" state.\nThis is maintained only for alerts with configured \"for\" time greater than grace period.\nIt requires Thanos >= v0.30.0.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "ruleNamespaceSelector": { - "description": "Namespaces to be selected for Rules discovery. If unspecified, only\nthe same namespace as the ThanosRuler object is in is used.", + "description": "ruleNamespaceSelector defines the namespaces to be selected for Rules discovery. If unspecified, only\nthe same namespace as the ThanosRuler object is in is used.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -5246,17 +5246,17 @@ "x-kubernetes-map-type": "atomic" }, "ruleOutageTolerance": { - "description": "Max time to tolerate prometheus outage for restoring \"for\" state of alert.\nIt requires Thanos >= v0.30.0.", + "description": "ruleOutageTolerance defines the max time to tolerate prometheus outage for restoring \"for\" state of alert.\nIt requires Thanos >= v0.30.0.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "ruleQueryOffset": { - "description": "The default rule group's query offset duration to use.\nIt requires Thanos >= v0.38.0.", + "description": "ruleQueryOffset defines the default rule group's query offset duration to use.\nIt requires Thanos >= v0.38.0.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" }, "ruleSelector": { - "description": "PrometheusRule objects to be selected for rule evaluation. An empty\nlabel selector matches all objects. A null label selector matches no\nobjects.", + "description": "ruleSelector defines the PrometheusRule objects to be selected for rule evaluation. An empty\nlabel selector matches all objects. A null label selector matches no\nobjects.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", @@ -5301,7 +5301,7 @@ "x-kubernetes-map-type": "atomic" }, "securityContext": { - "description": "SecurityContext holds pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext.", + "description": "securityContext defines the pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext.", "properties": { "appArmorProfile": { "description": "appArmorProfile is the AppArmor options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.", @@ -5448,23 +5448,23 @@ "type": "object" }, "serviceAccountName": { - "description": "ServiceAccountName is the name of the ServiceAccount to use to run the\nThanos Ruler Pods.", + "description": "serviceAccountName defines the name of the ServiceAccount to use to run the\nThanos Ruler Pods.", "type": "string" }, "serviceName": { - "description": "The name of the service name used by the underlying StatefulSet(s) as the governing service.\nIf defined, the Service must be created before the ThanosRuler resource in the same namespace and it must define a selector that matches the pod labels.\nIf empty, the operator will create and manage a headless service named `thanos-ruler-operated` for ThanosRuler resources.\nWhen deploying multiple ThanosRuler resources in the same namespace, it is recommended to specify a different value for each.\nSee https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details.", + "description": "serviceName defines the name of the service name used by the underlying StatefulSet(s) as the governing service.\nIf defined, the Service must be created before the ThanosRuler resource in the same namespace and it must define a selector that matches the pod labels.\nIf empty, the operator will create and manage a headless service named `thanos-ruler-operated` for ThanosRuler resources.\nWhen deploying multiple ThanosRuler resources in the same namespace, it is recommended to specify a different value for each.\nSee https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details.", "minLength": 1, "type": "string" }, "storage": { - "description": "Storage spec to specify how storage shall be used.", + "description": "storage defines the specification of how storage shall be used.", "properties": { "disableMountSubPath": { - "description": "Deprecated: subPath usage will be removed in a future release.", + "description": "disableMountSubPath deprecated: subPath usage will be removed in a future release.", "type": "boolean" }, "emptyDir": { - "description": "EmptyDirVolumeSource to be used by the StatefulSet.\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir", + "description": "emptyDir to be used by the StatefulSet.\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir", "properties": { "medium": { "description": "medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", @@ -5487,7 +5487,7 @@ "type": "object" }, "ephemeral": { - "description": "EphemeralVolumeSource to be used by the StatefulSet.\nThis is a beta field in k8s 1.21 and GA in 1.15.\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes", + "description": "ephemeral to be used by the StatefulSet.\nThis is a beta field in k8s 1.21 and GA in 1.15.\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes", "properties": { "volumeClaimTemplate": { "description": "Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `-` where\n`` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\nRequired, must not be nil.", @@ -5668,7 +5668,7 @@ "type": "object" }, "volumeClaimTemplate": { - "description": "Defines the PVC spec to be used by the Prometheus StatefulSets.\nThe easiest way to use a volume that cannot be automatically provisioned\nis to use a label selector alongside manually created PersistentVolumes.", + "description": "volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets.\nThe easiest way to use a volume that cannot be automatically provisioned\nis to use a label selector alongside manually created PersistentVolumes.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", @@ -5679,31 +5679,31 @@ "type": "string" }, "metadata": { - "description": "EmbeddedMetadata contains metadata relevant to an EmbeddedResource.", + "description": "metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, - "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", + "description": "annotations defines an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", "type": "object" }, "labels": { "additionalProperties": { "type": "string" }, - "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", + "description": "labels define the map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "type": "object" }, "name": { - "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", + "description": "name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", "type": "string" } }, "type": "object" }, "spec": { - "description": "Defines the desired characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", + "description": "spec defines the specification of the characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "properties": { "accessModes": { "description": "accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", @@ -5865,7 +5865,7 @@ "type": "object" }, "status": { - "description": "Deprecated: this field is never set.", + "description": "status is deprecated: this field is never set.", "properties": { "accessModes": { "description": "accessModes contains the actual access modes the volume backing the PVC has.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", @@ -5995,13 +5995,13 @@ "type": "object" }, "terminationGracePeriodSeconds": { - "description": "Optional duration in seconds the pod needs to terminate gracefully.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down) which may lead to data corruption.\n\nDefaults to 120 seconds.", + "description": "terminationGracePeriodSeconds defines the optional duration in seconds the pod needs to terminate gracefully.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down) which may lead to data corruption.\n\nDefaults to 120 seconds.", "format": "int64", "minimum": 0, "type": "integer" }, "tolerations": { - "description": "If specified, the pod's tolerations.", + "description": "tolerations defines when specified, the pod's tolerations.", "items": { "description": "The pod this Toleration is attached to tolerates any taint that matches\nthe triple using the matching operator .", "properties": { @@ -6032,7 +6032,7 @@ "type": "array" }, "topologySpreadConstraints": { - "description": "If specified, the pod's topology spread constraints.", + "description": "topologySpreadConstraints defines the pod's topology spread constraints.", "items": { "description": "TopologySpreadConstraint specifies how to spread matching pods among the given topology.", "properties": { @@ -6126,7 +6126,7 @@ "type": "array" }, "tracingConfig": { - "description": "Configures tracing.\n\nThe configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.\n\nThe operator performs no validation of the configuration.\n\n`tracingConfigFile` takes precedence over this field.", + "description": "tracingConfig defines the tracing configuration.\n\nThe configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.\n\nThe operator performs no validation of the configuration.\n\n`tracingConfigFile` takes precedence over this field.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -6149,15 +6149,15 @@ "x-kubernetes-map-type": "atomic" }, "tracingConfigFile": { - "description": "Configures the path of the tracing configuration file.\n\nThe configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.\n\nThe operator performs no validation of the configuration file.\n\nThis field takes precedence over `tracingConfig`.", + "description": "tracingConfigFile defines the path of the tracing configuration file.\n\nThe configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.\n\nThe operator performs no validation of the configuration file.\n\nThis field takes precedence over `tracingConfig`.", "type": "string" }, "version": { - "description": "Version of Thanos to be deployed.", + "description": "version of Thanos to be deployed.", "type": "string" }, "volumeMounts": { - "description": "VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition.\nVolumeMounts specified will be appended to other VolumeMounts in the ruler container,\nthat are generated as a result of StorageSpec objects.", + "description": "volumeMounts defines how the configuration of additional VolumeMounts on the output StatefulSet definition.\nVolumeMounts specified will be appended to other VolumeMounts in the ruler container,\nthat are generated as a result of StorageSpec objects.", "items": { "description": "VolumeMount describes a mounting of a Volume within a container.", "properties": { @@ -6199,7 +6199,7 @@ "type": "array" }, "volumes": { - "description": "Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will\nbe appended to other volumes that are generated as a result of StorageSpec objects.", + "description": "volumes defines how configuration of additional volumes on the output StatefulSet definition. Volumes specified will\nbe appended to other volumes that are generated as a result of StorageSpec objects.", "items": { "description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.", "properties": { @@ -7662,24 +7662,24 @@ "type": "array" }, "web": { - "description": "Defines the configuration of the ThanosRuler web server.", + "description": "web defines the configuration of the ThanosRuler web server.", "properties": { "httpConfig": { - "description": "Defines HTTP parameters for web server.", + "description": "httpConfig defines HTTP parameters for web server.", "properties": { "headers": { - "description": "List of headers that can be added to HTTP responses.", + "description": "headers defines a list of headers that can be added to HTTP responses.", "properties": { "contentSecurityPolicy": { - "description": "Set the Content-Security-Policy header to HTTP responses.\nUnset if blank.", + "description": "contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses.\nUnset if blank.", "type": "string" }, "strictTransportSecurity": { - "description": "Set the Strict-Transport-Security header to HTTP responses.\nUnset if blank.\nPlease make sure that you use this with care as this header might force\nbrowsers to load Prometheus and the other applications hosted on the same\ndomain and subdomains over HTTPS.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security", + "description": "strictTransportSecurity defines the Strict-Transport-Security header to HTTP responses.\nUnset if blank.\nPlease make sure that you use this with care as this header might force\nbrowsers to load Prometheus and the other applications hosted on the same\ndomain and subdomains over HTTPS.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security", "type": "string" }, "xContentTypeOptions": { - "description": "Set the X-Content-Type-Options header to HTTP responses.\nUnset if blank. Accepted value is nosniff.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options", + "description": "xContentTypeOptions defines the X-Content-Type-Options header to HTTP responses.\nUnset if blank. Accepted value is nosniff.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options", "enum": [ "", "NoSniff" @@ -7687,7 +7687,7 @@ "type": "string" }, "xFrameOptions": { - "description": "Set the X-Frame-Options header to HTTP responses.\nUnset if blank. Accepted values are deny and sameorigin.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options", + "description": "xFrameOptions defines the X-Frame-Options header to HTTP responses.\nUnset if blank. Accepted values are deny and sameorigin.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options", "enum": [ "", "Deny", @@ -7696,27 +7696,27 @@ "type": "string" }, "xXSSProtection": { - "description": "Set the X-XSS-Protection header to all responses.\nUnset if blank.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection", + "description": "xXSSProtection defines the X-XSS-Protection header to all responses.\nUnset if blank.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection", "type": "string" } }, "type": "object" }, "http2": { - "description": "Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\nWhenever the value of the field changes, a rolling update will be triggered.", + "description": "http2 enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\nWhenever the value of the field changes, a rolling update will be triggered.", "type": "boolean" } }, "type": "object" }, "tlsConfig": { - "description": "Defines the TLS parameters for HTTPS.", + "description": "tlsConfig defines the TLS parameters for HTTPS.", "properties": { "cert": { - "description": "Secret or ConfigMap containing the TLS certificate for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `certFile`.", + "description": "cert defines the Secret or ConfigMap containing the TLS certificate for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `certFile`.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7739,7 +7739,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7765,29 +7765,29 @@ "type": "object" }, "certFile": { - "description": "Path to the TLS certificate file in the container for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `cert`.", + "description": "certFile defines the path to the TLS certificate file in the container for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `cert`.", "type": "string" }, "cipherSuites": { - "description": "List of supported cipher suites for TLS versions up to TLS 1.2.\n\nIf not defined, the Go default cipher suites are used.\nAvailable cipher suites are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#pkg-constants", + "description": "cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2.\n\nIf not defined, the Go default cipher suites are used.\nAvailable cipher suites are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#pkg-constants", "items": { "type": "string" }, "type": "array" }, "clientAuthType": { - "description": "The server policy for client TLS authentication.\n\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType", + "description": "clientAuthType defines the server policy for client TLS authentication.\n\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType", "type": "string" }, "clientCAFile": { - "description": "Path to the CA certificate file for client certificate authentication to\nthe server.\n\nIt is mutually exclusive with `client_ca`.", + "description": "clientCAFile defines the path to the CA certificate file for client certificate authentication to\nthe server.\n\nIt is mutually exclusive with `client_ca`.", "type": "string" }, "client_ca": { - "description": "Secret or ConfigMap containing the CA certificate for client certificate\nauthentication to the server.\n\nIt is mutually exclusive with `clientCAFile`.", + "description": "client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate\nauthentication to the server.\n\nIt is mutually exclusive with `clientCAFile`.", "properties": { "configMap": { - "description": "ConfigMap containing data to use for the targets.", + "description": "configMap defines the ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", @@ -7810,7 +7810,7 @@ "x-kubernetes-map-type": "atomic" }, "secret": { - "description": "Secret containing data to use for the targets.", + "description": "secret defines the Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7836,18 +7836,18 @@ "type": "object" }, "curvePreferences": { - "description": "Elliptic curves that will be used in an ECDHE handshake, in preference\norder.\n\nAvailable curves are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID", + "description": "curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference\norder.\n\nAvailable curves are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID", "items": { "type": "string" }, "type": "array" }, "keyFile": { - "description": "Path to the TLS private key file in the container for the web server.\n\nIf defined, either `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keySecret`.", + "description": "keyFile defines the path to the TLS private key file in the container for the web server.\n\nIf defined, either `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keySecret`.", "type": "string" }, "keySecret": { - "description": "Secret containing the TLS private key for the web server.\n\nEither `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keyFile`.", + "description": "keySecret defines the secret containing the TLS private key for the web server.\n\nEither `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keyFile`.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", @@ -7870,15 +7870,15 @@ "x-kubernetes-map-type": "atomic" }, "maxVersion": { - "description": "Maximum TLS version that is acceptable.", + "description": "maxVersion defines the Maximum TLS version that is acceptable.", "type": "string" }, "minVersion": { - "description": "Minimum TLS version that is acceptable.", + "description": "minVersion defines the minimum TLS version that is acceptable.", "type": "string" }, "preferServerCipherSuites": { - "description": "Controls whether the server selects the client's most preferred cipher\nsuite, or the server's most preferred cipher suite.\n\nIf true then the server's preference, as expressed in\nthe order of elements in cipherSuites, is used.", + "description": "preferServerCipherSuites defines whether the server selects the client's most preferred cipher\nsuite, or the server's most preferred cipher suite.\n\nIf true then the server's preference, as expressed in\nthe order of elements in cipherSuites, is used.", "type": "boolean" } }, @@ -7891,15 +7891,15 @@ "type": "object" }, "status": { - "description": "Most recent observed status of the ThanosRuler cluster. Read-only.\nMore info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", + "description": "status defines the most recent observed status of the ThanosRuler cluster. Read-only.\nMore info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "availableReplicas": { - "description": "Total number of available pods (ready for at least minReadySeconds)\ntargeted by this ThanosRuler deployment.", + "description": "availableReplicas defines the total number of available pods (ready for at least minReadySeconds)\ntargeted by this ThanosRuler deployment.", "format": "int32", "type": "integer" }, "conditions": { - "description": "The current state of the ThanosRuler object.", + "description": "conditions defines the current state of the ThanosRuler object.", "items": { "description": "Condition represents the state of the resources associated with the\nPrometheus, Alertmanager or ThanosRuler resource.", "properties": { @@ -7909,25 +7909,25 @@ "type": "string" }, "message": { - "description": "Human-readable message indicating details for the condition's last transition.", + "description": "message defines human-readable message indicating details for the condition's last transition.", "type": "string" }, "observedGeneration": { - "description": "ObservedGeneration represents the .metadata.generation that the\ncondition was set based upon. For instance, if `.metadata.generation` is\ncurrently 12, but the `.status.conditions[].observedGeneration` is 9, the\ncondition is out of date with respect to the current state of the\ninstance.", + "description": "observedGeneration defines the .metadata.generation that the\ncondition was set based upon. For instance, if `.metadata.generation` is\ncurrently 12, but the `.status.conditions[].observedGeneration` is 9, the\ncondition is out of date with respect to the current state of the\ninstance.", "format": "int64", "type": "integer" }, "reason": { - "description": "Reason for the condition's last transition.", + "description": "reason for the condition's last transition.", "type": "string" }, "status": { - "description": "Status of the condition.", + "description": "status of the condition.", "minLength": 1, "type": "string" }, "type": { - "description": "Type of the condition being reported.", + "description": "type of the condition being reported.", "minLength": 1, "type": "string" } @@ -7946,32 +7946,25 @@ "x-kubernetes-list-type": "map" }, "paused": { - "description": "Represents whether any actions on the underlying managed objects are\nbeing performed. Only delete actions will be performed.", + "description": "paused defines whether any actions on the underlying managed objects are\nbeing performed. Only delete actions will be performed.", "type": "boolean" }, "replicas": { - "description": "Total number of non-terminated pods targeted by this ThanosRuler deployment\n(their labels match the selector).", + "description": "replicas defines the total number of non-terminated pods targeted by this ThanosRuler deployment\n(their labels match the selector).", "format": "int32", "type": "integer" }, "unavailableReplicas": { - "description": "Total number of unavailable pods targeted by this ThanosRuler deployment.", + "description": "unavailableReplicas defines the total number of unavailable pods targeted by this ThanosRuler deployment.", "format": "int32", "type": "integer" }, "updatedReplicas": { - "description": "Total number of non-terminated pods targeted by this ThanosRuler deployment\nthat have the desired version spec.", + "description": "updatedReplicas defines the total number of non-terminated pods targeted by this ThanosRuler deployment\nthat have the desired version spec.", "format": "int32", "type": "integer" } }, - "required": [ - "availableReplicas", - "paused", - "replicas", - "unavailableReplicas", - "updatedReplicas" - ], "type": "object" } },