manifests/setup.yaml (3,925 lines of code) (raw):

# Copyright 2022 Google LLC # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # NOTE: This file is autogenerated. apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: controller-gen.kubebuilder.io/version: v0.17.1-0.20250103184936-50893dee96da name: clusternodemonitorings.monitoring.googleapis.com spec: group: monitoring.googleapis.com names: kind: ClusterNodeMonitoring listKind: ClusterNodeMonitoringList plural: clusternodemonitorings singular: clusternodemonitoring scope: Cluster versions: - name: v1 schema: openAPIV3Schema: description: ClusterNodeMonitoring defines monitoring for a set of nodes. properties: apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: description: |- Specification of desired node selection for target discovery by Prometheus. properties: endpoints: description: The endpoints to scrape on the selected nodes. items: description: |- ScrapeNodeEndpoint specifies a Prometheus metrics endpoint on a node to scrape. It contains all the fields used in the ScrapeEndpoint except for port and HTTPClientConfig. properties: interval: default: 1m description: Interval at which to scrape metrics. Must be a valid Prometheus duration. format: duration type: string metricRelabeling: description: |- Relabeling rules for metrics scraped from this endpoint. Relabeling rules that override protected target labels (project_id, location, cluster, namespace, job, instance, or __address__) are not permitted. The labelmap action is not permitted in general. items: description: RelabelingRule defines a single Prometheus relabeling rule. properties: action: description: Action to perform based on regex matching. Defaults to 'replace'. enum: - replace - lowercase - uppercase - keep - drop - keepequal - dropequal - hashmod - labeldrop - labelkeep type: string modulus: description: Modulus to take of the hash of the source label values. format: int64 type: integer regex: description: Regular expression against which the extracted value is matched. Defaults to '(.*)'. maxLength: 10000 type: string replacement: description: |- Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Defaults to '$1'. type: string separator: description: Separator placed between concatenated source label values. Defaults to ';'. type: string sourceLabels: description: |- The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions. items: pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ type: string maxItems: 100 type: array targetLabel: description: |- Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ type: string x-kubernetes-validations: - messageExpression: '''cannot relabel onto protected label "%s"''.format([self])' rule: self != 'project_id' && self != 'location' && self != 'cluster' && self != 'namespace' && self != 'job' && self != 'instance' && self != 'top_level_controller' && self != 'top_level_controller_type' && self != '__address__' type: object x-kubernetes-validations: - rule: '!has(self.action) || self.action != ''labeldrop'' || has(self.regex)' maxItems: 250 type: array params: additionalProperties: items: type: string type: array description: HTTP GET params to use when scraping. type: object path: description: HTTP path to scrape metrics from. Defaults to "/metrics". type: string scheme: description: Protocol scheme to use to scrape. enum: - http - https type: string timeout: description: |- Timeout for metrics scrapes. Must be a valid Prometheus duration. Must not be larger then the scrape interval. format: duration type: string tls: description: TLS configures the scrape request's TLS settings. properties: insecureSkipVerify: description: InsecureSkipVerify disables target certificate validation. type: boolean type: object required: - interval type: object x-kubernetes-validations: - messageExpression: '''scrape timeout (%s) must not be greater than scrape interval (%s)''.format([self.timeout, self.interval])' rule: '!has(self.timeout) || self.timeout <= self.interval' maxItems: 10 minItems: 1 type: array limits: description: Limits to apply at scrape time. properties: labelNameLength: description: |- Maximum label name length. Uses Prometheus default if left unspecified. format: int64 type: integer labelValueLength: description: |- Maximum label value length. Uses Prometheus default if left unspecified. format: int64 type: integer labels: description: |- Maximum number of labels accepted for a single sample. Uses Prometheus default if left unspecified. format: int64 type: integer samples: description: |- Maximum number of samples accepted within a single scrape. Uses Prometheus default if left unspecified. format: int64 type: integer type: object selector: description: |- Label selector that specifies which nodes are selected for this monitoring configuration. If left empty all nodes are selected. properties: matchExpressions: description: matchExpressions is a list of label selector requirements. The requirements are ANDed. items: description: |- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. properties: key: description: key is the label key that the selector applies to. type: string operator: description: |- operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. type: string values: description: |- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. items: type: string type: array x-kubernetes-list-type: atomic required: - key - operator type: object type: array x-kubernetes-list-type: atomic matchLabels: additionalProperties: type: string description: |- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. type: object type: object x-kubernetes-map-type: atomic required: - endpoints type: object status: description: Most recently observed status of the resource. properties: conditions: description: Represents the latest available observations of a podmonitor's current state. items: description: MonitoringCondition describes the condition of a PodMonitoring. properties: lastTransitionTime: description: Last time the condition transitioned from one status to another. format: date-time type: string lastUpdateTime: description: The last time this condition was updated. format: date-time type: string message: description: A human-readable message indicating details about the transition. type: string reason: description: The reason for the condition's last transition. type: string status: description: Status of the condition, one of True, False, Unknown. type: string type: description: MonitoringConditionType is the type of MonitoringCondition. type: string required: - status - type type: object type: array observedGeneration: description: The generation observed by the controller. format: int64 type: integer type: object required: - spec type: object served: true storage: true subresources: status: {} --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: controller-gen.kubebuilder.io/version: v0.17.1-0.20250103184936-50893dee96da name: clusterpodmonitorings.monitoring.googleapis.com spec: group: monitoring.googleapis.com names: kind: ClusterPodMonitoring listKind: ClusterPodMonitoringList plural: clusterpodmonitorings singular: clusterpodmonitoring scope: Cluster versions: - name: v1 schema: openAPIV3Schema: description: |- ClusterPodMonitoring defines monitoring for a set of pods, scoped to all pods within the cluster. properties: apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: description: |- Specification of desired Pod selection for target discovery by Prometheus. properties: endpoints: description: The endpoints to scrape on the selected pods. items: description: ScrapeEndpoint specifies a Prometheus metrics endpoint to scrape. properties: authorization: description: Authorization is the HTTP authorization credentials for the targets. properties: credentials: description: Credentials uses the secret as the credentials (token) for the authentication header. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object type: description: |- Type is the authentication type. Defaults to Bearer. Basic will cause an error, as the BasicAuth object should be used instead. type: string x-kubernetes-validations: - message: authorization type cannot be set to "basic", use "basic_auth" instead rule: self != 'Basic' type: object basicAuth: description: BasicAuth is the HTTP basic authentication credentials for the targets. properties: password: description: Password uses the secret as the BasicAuth password. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object username: description: Username is the BasicAuth username. type: string type: object interval: description: Interval at which to scrape metrics. Must be a valid Prometheus duration. format: duration type: string metricRelabeling: description: |- Relabeling rules for metrics scraped from this endpoint. Relabeling rules that override protected target labels (project_id, location, cluster, namespace, job, instance, top_level_controller, top_level_controller_type, or __address__) are not permitted. The labelmap action is not permitted in general. items: description: RelabelingRule defines a single Prometheus relabeling rule. properties: action: description: Action to perform based on regex matching. Defaults to 'replace'. enum: - replace - lowercase - uppercase - keep - drop - keepequal - dropequal - hashmod - labeldrop - labelkeep type: string modulus: description: Modulus to take of the hash of the source label values. format: int64 type: integer regex: description: Regular expression against which the extracted value is matched. Defaults to '(.*)'. maxLength: 10000 type: string replacement: description: |- Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Defaults to '$1'. type: string separator: description: Separator placed between concatenated source label values. Defaults to ';'. type: string sourceLabels: description: |- The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions. items: pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ type: string maxItems: 100 type: array targetLabel: description: |- Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ type: string x-kubernetes-validations: - messageExpression: '''cannot relabel onto protected label "%s"''.format([self])' rule: self != 'project_id' && self != 'location' && self != 'cluster' && self != 'namespace' && self != 'job' && self != 'instance' && self != 'top_level_controller' && self != 'top_level_controller_type' && self != '__address__' type: object x-kubernetes-validations: - rule: '!has(self.action) || self.action != ''labeldrop'' || has(self.regex)' maxItems: 250 type: array oauth2: description: OAuth2 is the OAuth2 client credentials used to fetch a token for the targets. properties: clientID: description: ClientID is the public identifier for the client. type: string clientSecret: description: ClientSecret uses the secret as the client secret token. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object endpointParams: additionalProperties: type: string description: EndpointParams are additional parameters to append to the token URL. type: object proxyUrl: description: |- ProxyURL is the HTTP proxy server to use to connect to the targets. Encoded passwords are not supported. maxLength: 2000 type: string x-kubernetes-validations: - rule: isURL(self) && !self.matches('@') scopes: description: Scopes represents the scopes for the token request. items: type: string type: array tlsConfig: description: TLS configures the token request's TLS settings. properties: ca: description: |- SecretSelector references a secret from a secret provider e.g. Kubernetes Secret. Only one provider can be used at a time. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object cert: description: Cert uses the secret as the certificate for client authentication to the server. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object insecureSkipVerify: description: InsecureSkipVerify disables target certificate validation. type: boolean key: description: Key uses the secret as the private key for client authentication to the server. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object maxVersion: description: |- MaxVersion is the maximum TLS version. Accepted values: TLS10 (TLS 1.0), TLS11 (TLS 1.1), TLS12 (TLS 1.2), TLS13 (TLS 1.3). If unset, Prometheus will use Go default minimum version, which is TLS 1.2. See MinVersion in https://pkg.go.dev/crypto/tls#Config. enum: - TLS10 - TLS11 - TLS12 - TLS13 type: string minVersion: description: |- MinVersion is the minimum TLS version. Accepted values: TLS10 (TLS 1.0), TLS11 (TLS 1.1), TLS12 (TLS 1.2), TLS13 (TLS 1.3). If unset, Prometheus will use Go default minimum version, which is TLS 1.2. See MinVersion in https://pkg.go.dev/crypto/tls#Config. enum: - TLS10 - TLS11 - TLS12 - TLS13 type: string serverName: description: ServerName is used to verify the hostname for the targets. type: string type: object x-kubernetes-validations: - message: client cert and client key must be provided together, when either is provided rule: has(self.cert) == has(self.key) tokenURL: description: TokenURL is the URL to fetch the token from. type: string type: object params: additionalProperties: items: type: string type: array description: HTTP GET params to use when scraping. type: object path: description: HTTP path to scrape metrics from. Defaults to "/metrics". type: string port: anyOf: - type: integer - type: string description: |- Name or number of the port to scrape. The container metadata label is only populated if the port is referenced by name because port numbers are not unique across containers. maxLength: 253 minLength: 1 pattern: ^[a-z0-9]([a-z0-9-]{0,251}[a-z0-9])?$ x-kubernetes-int-or-string: true x-kubernetes-validations: - message: Port is required rule: self != 0 proxyUrl: description: |- ProxyURL is the HTTP proxy server to use to connect to the targets. Encoded passwords are not supported. maxLength: 2000 type: string x-kubernetes-validations: - rule: isURL(self) && !self.matches('@') scheme: description: Protocol scheme to use to scrape. enum: - http - https type: string timeout: description: |- Timeout for metrics scrapes. Must be a valid Prometheus duration. Must not be larger than the scrape interval. format: duration type: string tls: description: TLS configures the scrape request's TLS settings. properties: ca: description: |- SecretSelector references a secret from a secret provider e.g. Kubernetes Secret. Only one provider can be used at a time. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object cert: description: Cert uses the secret as the certificate for client authentication to the server. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object insecureSkipVerify: description: InsecureSkipVerify disables target certificate validation. type: boolean key: description: Key uses the secret as the private key for client authentication to the server. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object maxVersion: description: |- MaxVersion is the maximum TLS version. Accepted values: TLS10 (TLS 1.0), TLS11 (TLS 1.1), TLS12 (TLS 1.2), TLS13 (TLS 1.3). If unset, Prometheus will use Go default minimum version, which is TLS 1.2. See MinVersion in https://pkg.go.dev/crypto/tls#Config. enum: - TLS10 - TLS11 - TLS12 - TLS13 type: string minVersion: description: |- MinVersion is the minimum TLS version. Accepted values: TLS10 (TLS 1.0), TLS11 (TLS 1.1), TLS12 (TLS 1.2), TLS13 (TLS 1.3). If unset, Prometheus will use Go default minimum version, which is TLS 1.2. See MinVersion in https://pkg.go.dev/crypto/tls#Config. enum: - TLS10 - TLS11 - TLS12 - TLS13 type: string serverName: description: ServerName is used to verify the hostname for the targets. type: string type: object x-kubernetes-validations: - message: client cert and client key must be provided together, when either is provided rule: has(self.cert) == has(self.key) required: - interval - port type: object x-kubernetes-validations: - messageExpression: '''scrape timeout (%s) must not be greater than scrape interval (%s)''.format([self.timeout, self.interval])' rule: '!has(self.timeout) || self.timeout <= self.interval' - rule: '((has(self.authorization) ? 1 : 0) + (has(self.basicAuth) ? 1 : 0) + (has(self.oauth2) ? 1 : 0)) <= 1' maxItems: 10 minItems: 1 type: array filterRunning: description: |- FilterRunning will drop any pods that are in the "Failed" or "Succeeded" pod lifecycle. See: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase Specifically, this prevents scraping Succeeded pods from K8s jobs, which could contribute to noisy logs or irrelevant metrics. Additionally, it can mitigate issues with reusing stale target labels in cases where Pod IPs are reused (e.g. spot containers). See: https://github.com/GoogleCloudPlatform/prometheus-engine/issues/145 type: boolean limits: description: Limits to apply at scrape time. properties: labelNameLength: description: |- Maximum label name length. Uses Prometheus default if left unspecified. format: int64 type: integer labelValueLength: description: |- Maximum label value length. Uses Prometheus default if left unspecified. format: int64 type: integer labels: description: |- Maximum number of labels accepted for a single sample. Uses Prometheus default if left unspecified. format: int64 type: integer samples: description: |- Maximum number of samples accepted within a single scrape. Uses Prometheus default if left unspecified. format: int64 type: integer type: object selector: description: |- Label selector that specifies which pods are selected for this monitoring configuration. properties: matchExpressions: description: matchExpressions is a list of label selector requirements. The requirements are ANDed. items: description: |- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. properties: key: description: key is the label key that the selector applies to. type: string operator: description: |- operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. type: string values: description: |- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. items: type: string type: array x-kubernetes-list-type: atomic required: - key - operator type: object type: array x-kubernetes-list-type: atomic matchLabels: additionalProperties: type: string description: |- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. type: object type: object x-kubernetes-map-type: atomic targetLabels: description: |- Labels to add to the Prometheus target for discovered endpoints. The `instance` label is always set to `<pod_name>:<port>` or `<node_name>:<port>` if the scraped pod is controlled by a DaemonSet. properties: fromPod: description: |- Labels to transfer from the Kubernetes Pod to Prometheus target labels. Mappings are applied in order. items: description: |- LabelMapping specifies how to transfer a label from a Kubernetes resource onto a Prometheus target. properties: from: description: Kubernetes resource label to remap. type: string to: description: |- Remapped Prometheus target label. Defaults to the same name as `From`. pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ type: string x-kubernetes-validations: - messageExpression: '''cannot relabel onto protected label "%s"''.format([self])' rule: self != 'project_id' && self != 'location' && self != 'cluster' && self != 'namespace' && self != 'job' && self != 'instance' && self != 'top_level_controller' && self != 'top_level_controller_type' && self != '__address__' required: - from type: object maxItems: 100 type: array metadata: default: - container - namespace - pod - top_level_controller_name - top_level_controller_type description: |- Pod metadata labels that are set on all scraped targets. Permitted keys are `container`, `namespace`, `node`, `pod`, `top_level_controller_name` and `top_level_controller_type`. The `container` label is only populated if the scrape port is referenced by name. Defaults to [container, namespace, pod, top_level_controller_name, top_level_controller_type]. If set to null, it will be interpreted as [namespace]. This is for backwards-compatibility only. items: enum: - container - namespace - node - pod - top_level_controller_name - top_level_controller_type type: string type: array x-kubernetes-list-type: set type: object required: - endpoints - selector type: object status: description: Most recently observed status of the resource. properties: conditions: description: Represents the latest available observations of a podmonitor's current state. items: description: MonitoringCondition describes the condition of a PodMonitoring. properties: lastTransitionTime: description: Last time the condition transitioned from one status to another. format: date-time type: string lastUpdateTime: description: The last time this condition was updated. format: date-time type: string message: description: A human-readable message indicating details about the transition. type: string reason: description: The reason for the condition's last transition. type: string status: description: Status of the condition, one of True, False, Unknown. type: string type: description: MonitoringConditionType is the type of MonitoringCondition. type: string required: - status - type type: object type: array endpointStatuses: description: Represents the latest available observations of target state for each ScrapeEndpoint. items: properties: activeTargets: description: Total number of active targets. format: int64 type: integer collectorsFraction: description: |- Fraction of collectors included in status, bounded [0,1]. Ideally, this should always be 1. Anything less can be considered a problem and should be investigated. type: string lastUpdateTime: description: Last time this status was updated. format: date-time type: string name: description: The name of the ScrapeEndpoint. type: string sampleGroups: description: A fixed sample of targets grouped by error type. items: properties: count: description: Total count of similar errors. format: int32 type: integer sampleTargets: description: Targets emitting the error message. items: properties: health: description: Health status. type: string labels: additionalProperties: description: A LabelValue is an associated value for a LabelName. type: string description: The label set, keys and values, of the target. type: object lastError: description: Error message. type: string lastScrapeDurationSeconds: description: Scrape duration in seconds. type: string type: object type: array type: object type: array unhealthyTargets: description: Total number of active, unhealthy targets. format: int64 type: integer required: - name type: object type: array observedGeneration: description: The generation observed by the controller. format: int64 type: integer type: object required: - spec type: object served: true storage: true subresources: status: {} - deprecated: true name: v1alpha1 schema: openAPIV3Schema: description: ClusterPodMonitoring defines monitoring for a set of pods. properties: apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: description: |- Specification of desired Pod selection for target discovery by Prometheus. properties: endpoints: description: The endpoints to scrape on the selected pods. items: description: ScrapeEndpoint specifies a Prometheus metrics endpoint to scrape. properties: interval: description: Interval at which to scrape metrics. Must be a valid Prometheus duration. type: string metricRelabeling: description: |- Relabeling rules for metrics scraped from this endpoint. Relabeling rules that override protected target labels (project_id, location, cluster, namespace, job, instance, or __address__) are not permitted. The labelmap action is not permitted in general. items: description: RelabelingRule defines a single Prometheus relabeling rule. properties: action: description: Action to perform based on regex matching. Defaults to 'replace'. type: string modulus: description: Modulus to take of the hash of the source label values. format: int64 type: integer regex: description: Regular expression against which the extracted value is matched. Defaults to '(.*)'. type: string replacement: description: |- Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Defaults to '$1'. type: string separator: description: Separator placed between concatenated source label values. Defaults to ';'. type: string sourceLabels: description: |- The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions. items: type: string type: array targetLabel: description: |- Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. type: string type: object type: array params: additionalProperties: items: type: string type: array description: HTTP GET params to use when scraping. type: object path: description: HTTP path to scrape metrics from. Defaults to "/metrics". type: string port: anyOf: - type: integer - type: string description: Name or number of the port to scrape. x-kubernetes-int-or-string: true proxyUrl: description: Proxy URL to scrape through. Encoded passwords are not supported. type: string scheme: description: Protocol scheme to use to scrape. type: string timeout: description: |- Timeout for metrics scrapes. Must be a valid Prometheus duration. Must not be larger then the scrape interval. type: string required: - port type: object type: array limits: description: Limits to apply at scrape time. properties: labelNameLength: description: |- Maximum label name length. Uses Prometheus default if left unspecified. format: int64 type: integer labelValueLength: description: |- Maximum label value length. Uses Prometheus default if left unspecified. format: int64 type: integer labels: description: |- Maximum number of labels accepted for a single sample. Uses Prometheus default if left unspecified. format: int64 type: integer samples: description: |- Maximum number of samples accepted within a single scrape. Uses Prometheus default if left unspecified. format: int64 type: integer type: object selector: description: |- Label selector that specifies which pods are selected for this monitoring configuration. properties: matchExpressions: description: matchExpressions is a list of label selector requirements. The requirements are ANDed. items: description: |- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. properties: key: description: key is the label key that the selector applies to. type: string operator: description: |- operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. type: string values: description: |- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. items: type: string type: array x-kubernetes-list-type: atomic required: - key - operator type: object type: array x-kubernetes-list-type: atomic matchLabels: additionalProperties: type: string description: |- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. type: object type: object x-kubernetes-map-type: atomic targetLabels: description: Labels to add to the Prometheus target for discovered endpoints properties: fromPod: description: |- Labels to transfer from the Kubernetes Pod to Prometheus target labels. Mappings are applied in order. items: description: |- LabelMapping specifies how to transfer a label from a Kubernetes resource onto a Prometheus target. properties: from: description: Kubenetes resource label to remap. type: string to: description: |- Remapped Prometheus target label. Defaults to the same name as `From`. type: string required: - from type: object type: array metadata: description: |- Pod metadata labels that are set on all scraped targets. Permitted keys are `pod`, `container`, and `node` for PodMonitoring and `pod`, `container`, `node`, and `namespace` for ClusterPodMonitoring. Defaults to [pod, container] for PodMonitoring and [namespace, pod, container] for ClusterPodMonitoring. If set to null, it will be interpreted as the empty list for PodMonitoring and to [namespace] for ClusterPodMonitoring. This is for backwards-compatibility only. items: type: string type: array type: object required: - endpoints - selector type: object status: description: Most recently observed status of the resource. properties: conditions: description: Represents the latest available observations of a podmonitor's current state. items: description: MonitoringCondition describes a condition of a PodMonitoring. properties: lastTransitionTime: description: Last time the condition transitioned from one status to another. format: date-time type: string lastUpdateTime: description: The last time this condition was updated. format: date-time type: string message: description: A human-readable message indicating details about the transition. type: string reason: description: The reason for the condition's last transition. type: string status: description: Status of the condition, one of True, False, Unknown. type: string type: description: MonitoringConditionType is the type of MonitoringCondition. type: string required: - status - type type: object type: array observedGeneration: description: The generation observed by the controller. format: int64 type: integer type: object required: - spec type: object served: true storage: false subresources: status: {} --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: controller-gen.kubebuilder.io/version: v0.17.1-0.20250103184936-50893dee96da name: clusterrules.monitoring.googleapis.com spec: group: monitoring.googleapis.com names: kind: ClusterRules listKind: ClusterRulesList plural: clusterrules singular: clusterrules scope: Cluster versions: - name: v1 schema: openAPIV3Schema: description: |- ClusterRules defines Prometheus alerting and recording rules that are scoped to the current cluster. Only metric data from the current cluster is processed and all rule results have their project_id and cluster label preserved for query processing. If the location label is not preserved by the rule, it defaults to the cluster's location. properties: apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: description: Specification of rules to record and alert on. properties: groups: description: A list of Prometheus rule groups. items: description: |- RuleGroup declares rules in the Prometheus format: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/ properties: interval: default: 1m description: The interval at which to evaluate the rules. Must be a valid Prometheus duration. format: duration type: string name: description: The name of the rule group. type: string rules: description: A list of rules that are executed sequentially as part of this group. items: description: |- Rule is a single rule in the Prometheus format: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/ properties: alert: description: |- Name of the alert to evaluate the expression as. Only one of `record` and `alert` must be set. type: string annotations: additionalProperties: type: string description: |- A set of annotations to attach to alerts produced by the query expression. Only valid if `alert` is set. type: object expr: description: The PromQL expression to evaluate. type: string for: description: |- The duration to wait before a firing alert produced by this rule is sent to Alertmanager. Only valid if `alert` is set. format: duration type: string labels: additionalProperties: type: string description: A set of labels to attach to the result of the query expression. type: object record: description: |- Record the result of the expression to this metric name. Only one of `record` and `alert` must be set. pattern: ^[a-zA-Z_:][a-zA-Z0-9_:]*$ type: string required: - expr type: object x-kubernetes-validations: - message: Must set exactly one of Record or Alert rule: '(has(self.record) ? 1 : 0) + (has(self.alert) ? 1 : 0) == 1' - message: Annotations are only allowed for alerting rules rule: '!has(self.annotations) || has(self.alert)' minItems: 1 type: array required: - name - rules type: object type: array required: - groups type: object status: description: Most recently observed status of the resource. properties: conditions: description: Represents the latest available observations of a podmonitor's current state. items: description: MonitoringCondition describes the condition of a PodMonitoring. properties: lastTransitionTime: description: Last time the condition transitioned from one status to another. format: date-time type: string lastUpdateTime: description: The last time this condition was updated. format: date-time type: string message: description: A human-readable message indicating details about the transition. type: string reason: description: The reason for the condition's last transition. type: string status: description: Status of the condition, one of True, False, Unknown. type: string type: description: MonitoringConditionType is the type of MonitoringCondition. type: string required: - status - type type: object type: array observedGeneration: description: The generation observed by the controller. format: int64 type: integer type: object required: - spec type: object served: true storage: true subresources: status: {} - deprecated: true name: v1alpha1 schema: openAPIV3Schema: description: |- ClusterRules defines Prometheus alerting and recording rules that are scoped to the current cluster. Only metric data from the current cluster is processed and all rule results have their project_id and cluster label preserved for query processing. If the location label is not preserved by the rule, it defaults to the cluster's location. properties: apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: description: Specification of rules to record and alert on. properties: groups: description: A list of Prometheus rule groups. items: description: |- RuleGroup declares rules in the Prometheus format: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/ properties: interval: description: The interval at which to evaluate the rules. Must be a valid Prometheus duration. type: string name: description: The name of the rule group. type: string rules: description: A list of rules that are executed sequentially as part of this group. items: description: |- Rule is a single rule in the Prometheus format: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/ properties: alert: description: |- Name of the alert to evaluate the expression as. Only one of `record` and `alert` must be set. type: string annotations: additionalProperties: type: string description: |- A set of annotations to attach to alerts produced by the query expression. Only valid if `alert` is set. type: object expr: description: The PromQL expression to evaluate. type: string for: description: |- The duration to wait before a firing alert produced by this rule is sent to Alertmanager. Only valid if `alert` is set. type: string labels: additionalProperties: type: string description: A set of labels to attach to the result of the query expression. type: object record: description: |- Record the result of the expression to this metric name. Only one of `record` and `alert` must be set. type: string required: - expr type: object type: array required: - interval - name - rules type: object type: array required: - groups type: object status: description: Most recently observed status of the resource. type: object required: - spec type: object served: true storage: false subresources: status: {} --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: controller-gen.kubebuilder.io/version: v0.17.1-0.20250103184936-50893dee96da name: globalrules.monitoring.googleapis.com spec: group: monitoring.googleapis.com names: kind: GlobalRules listKind: GlobalRulesList plural: globalrules singular: globalrules scope: Cluster versions: - name: v1 schema: openAPIV3Schema: description: |- GlobalRules defines Prometheus alerting and recording rules that are scoped to all data in the queried project. If the project_id or location labels are not preserved by the rule, they default to the values of the cluster. properties: apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: description: Specification of rules to record and alert on. properties: groups: description: A list of Prometheus rule groups. items: description: |- RuleGroup declares rules in the Prometheus format: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/ properties: interval: default: 1m description: The interval at which to evaluate the rules. Must be a valid Prometheus duration. format: duration type: string name: description: The name of the rule group. type: string rules: description: A list of rules that are executed sequentially as part of this group. items: description: |- Rule is a single rule in the Prometheus format: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/ properties: alert: description: |- Name of the alert to evaluate the expression as. Only one of `record` and `alert` must be set. type: string annotations: additionalProperties: type: string description: |- A set of annotations to attach to alerts produced by the query expression. Only valid if `alert` is set. type: object expr: description: The PromQL expression to evaluate. type: string for: description: |- The duration to wait before a firing alert produced by this rule is sent to Alertmanager. Only valid if `alert` is set. format: duration type: string labels: additionalProperties: type: string description: A set of labels to attach to the result of the query expression. type: object record: description: |- Record the result of the expression to this metric name. Only one of `record` and `alert` must be set. pattern: ^[a-zA-Z_:][a-zA-Z0-9_:]*$ type: string required: - expr type: object x-kubernetes-validations: - message: Must set exactly one of Record or Alert rule: '(has(self.record) ? 1 : 0) + (has(self.alert) ? 1 : 0) == 1' - message: Annotations are only allowed for alerting rules rule: '!has(self.annotations) || has(self.alert)' minItems: 1 type: array required: - name - rules type: object type: array required: - groups type: object status: description: Most recently observed status of the resource. properties: conditions: description: Represents the latest available observations of a podmonitor's current state. items: description: MonitoringCondition describes the condition of a PodMonitoring. properties: lastTransitionTime: description: Last time the condition transitioned from one status to another. format: date-time type: string lastUpdateTime: description: The last time this condition was updated. format: date-time type: string message: description: A human-readable message indicating details about the transition. type: string reason: description: The reason for the condition's last transition. type: string status: description: Status of the condition, one of True, False, Unknown. type: string type: description: MonitoringConditionType is the type of MonitoringCondition. type: string required: - status - type type: object type: array observedGeneration: description: The generation observed by the controller. format: int64 type: integer type: object required: - spec type: object served: true storage: true subresources: status: {} - deprecated: true name: v1alpha1 schema: openAPIV3Schema: description: |- GlobalRules defines Prometheus alerting and recording rules that are scoped to all data in the queried project. If the project_id or location labels are not preserved by the rule, they default to the values of the cluster. properties: apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: description: Specification of rules to record and alert on. properties: groups: description: A list of Prometheus rule groups. items: description: |- RuleGroup declares rules in the Prometheus format: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/ properties: interval: description: The interval at which to evaluate the rules. Must be a valid Prometheus duration. type: string name: description: The name of the rule group. type: string rules: description: A list of rules that are executed sequentially as part of this group. items: description: |- Rule is a single rule in the Prometheus format: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/ properties: alert: description: |- Name of the alert to evaluate the expression as. Only one of `record` and `alert` must be set. type: string annotations: additionalProperties: type: string description: |- A set of annotations to attach to alerts produced by the query expression. Only valid if `alert` is set. type: object expr: description: The PromQL expression to evaluate. type: string for: description: |- The duration to wait before a firing alert produced by this rule is sent to Alertmanager. Only valid if `alert` is set. type: string labels: additionalProperties: type: string description: A set of labels to attach to the result of the query expression. type: object record: description: |- Record the result of the expression to this metric name. Only one of `record` and `alert` must be set. type: string required: - expr type: object type: array required: - interval - name - rules type: object type: array required: - groups type: object status: description: Most recently observed status of the resource. type: object required: - spec type: object served: true storage: false subresources: status: {} --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: controller-gen.kubebuilder.io/version: v0.17.1-0.20250103184936-50893dee96da name: operatorconfigs.monitoring.googleapis.com spec: group: monitoring.googleapis.com names: kind: OperatorConfig listKind: OperatorConfigList plural: operatorconfigs singular: operatorconfig scope: Namespaced versions: - name: v1 schema: openAPIV3Schema: description: OperatorConfig defines configuration of the gmp-operator. properties: apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string collection: description: |- Collection specifies how the operator configures collection, including scraping and an integrated export to Google Cloud Monitoring. properties: compression: description: Compression enables compression of metrics collection data enum: - none - gzip type: string credentials: description: |- A reference to GCP service account credentials with which Prometheus collectors are run. It needs to have metric write permissions for all project IDs to which data is written. Within GKE, this can typically be left empty if the compute default service account has the required permissions. properties: key: description: The key of the secret to select from. Must be a valid secret key. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the Secret or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic externalLabels: additionalProperties: type: string description: |- ExternalLabels specifies external labels that are attached to all scraped data before being written to Google Cloud Monitoring or any other additional exports specified in the OperatorConfig. The precedence behavior matches that of Prometheus. type: object filter: description: Filter limits which metric data is sent to Cloud Monitoring (it doesn't apply to additional exports). properties: matchOneOf: description: |- A list of Prometheus time series matchers. Every time series must match at least one of the matchers to be exported. This field can be used equivalently to the match[] parameter of the Prometheus federation endpoint to selectively export data. Example: `["{job!='foobar'}", "{__name__!~'container_foo.*|container_bar.*'}"]` items: type: string type: array type: object kubeletScraping: description: Configuration to scrape the metric endpoints of the Kubelets. properties: interval: description: The interval at which the metric endpoints are scraped. type: string tlsInsecureSkipVerify: description: |- TLSInsecureSkipVerify disables verifying the target cert. This can be useful for clusters provisioned with kubeadm. type: boolean required: - interval type: object type: object exports: description: |- Exports is an EXPERIMENTAL feature that specifies additional, optional endpoints to export to, on top of Google Cloud Monitoring collection. Note: To disable integrated export to Google Cloud Monitoring specify a non-matching filter in the "collection.filter" field. items: properties: url: description: The URL of the endpoint that supports Prometheus Remote Write to export samples to. type: string required: - url type: object type: array features: description: Features holds configuration for optional managed-collection features. properties: config: description: Settings for the collector configuration propagation. properties: compression: description: |- Compression enables compression of the config data propagated by the operator to collectors and the rule-evaluator. It is recommended to use the gzip option when using a large number of ClusterPodMonitoring, PodMonitoring, GlobalRules, ClusterRules, and/or Rules. enum: - none - gzip type: string type: object targetStatus: description: Configuration of target status reporting. properties: enabled: description: Enable target status reporting. type: boolean type: object type: object kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string managedAlertmanager: default: configSecret: key: alertmanager.yaml name: alertmanager description: ManagedAlertmanager holds information for configuring the managed instance of Alertmanager. properties: configSecret: description: |- ConfigSecret refers to the name of a single-key Secret in the public namespace that holds the managed Alertmanager config file. properties: key: description: The key of the secret to select from. Must be a valid secret key. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the Secret or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic externalURL: description: |- ExternalURL is the URL under which Alertmanager is externally reachable (for example, if Alertmanager is served via a reverse proxy). Used for generating relative and absolute links back to Alertmanager itself. If the URL has a path portion, it will be used to prefix all HTTP endpoints served by Alertmanager, otherwise relevant URL components will be derived automatically. If no URL is provided, Alertmanager will point to the Google Cloud Metric Explorer page. type: string type: object metadata: type: object rules: description: Rules specifies how the operator configures and deploys rule-evaluator. properties: alerting: description: Alerting contains how the rule-evaluator configures alerting. properties: alertmanagers: description: Alertmanagers contains endpoint configuration for designated Alertmanagers. items: description: |- AlertmanagerEndpoints defines a selection of a single Endpoints object containing alertmanager IPs to fire alerts against. properties: apiVersion: description: |- Version of the Alertmanager API that rule-evaluator uses to send alerts. It can be "v1" or "v2". type: string authorization: description: Authorization section for this alertmanager endpoint properties: credentials: description: The secret's key that contains the credentials of the request properties: key: description: The key of the secret to select from. Must be a valid secret key. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the Secret or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic type: description: |- Set the authentication type. Defaults to Bearer, Basic will cause an error type: string type: object name: description: Name of Endpoints object in Namespace. type: string namespace: description: Namespace of Endpoints object. type: string pathPrefix: description: Prefix for the HTTP path alerts are pushed to. type: string port: anyOf: - type: integer - type: string description: Port the Alertmanager API is exposed on. x-kubernetes-int-or-string: true scheme: description: Scheme to use when firing alerts. type: string timeout: description: Timeout is a per-target Alertmanager timeout when pushing alerts. type: string tls: description: TLS Config to use for alertmanager connection. properties: ca: description: Struct containing the CA cert to use for the targets. properties: configMap: description: ConfigMap containing data to use for the targets. properties: key: description: The key to select. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the ConfigMap or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic secret: description: Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the Secret or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic type: object cert: description: Struct containing the client cert file for the targets. properties: configMap: description: ConfigMap containing data to use for the targets. properties: key: description: The key to select. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the ConfigMap or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic secret: description: Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the Secret or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic type: object insecureSkipVerify: description: Disable target certificate validation. type: boolean keySecret: description: 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. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the Secret or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic maxVersion: description: |- Maximum TLS version. Accepted values: TLS10 (TLS 1.0), TLS11 (TLS 1.1), TLS12 (TLS 1.2), TLS13 (TLS 1.3). If unset, Prometheus will use Go default minimum version, which is TLS 1.2. See MinVersion in https://pkg.go.dev/crypto/tls#Config. type: string minVersion: description: |- Minimum TLS version. Accepted values: TLS10 (TLS 1.0), TLS11 (TLS 1.1), TLS12 (TLS 1.2), TLS13 (TLS 1.3). If unset, Prometheus will use Go default minimum version, which is TLS 1.2. See MinVersion in https://pkg.go.dev/crypto/tls#Config. type: string serverName: description: Used to verify the hostname for the targets. type: string type: object required: - name - namespace - port type: object type: array type: object credentials: description: |- A reference to GCP service account credentials with which the rule evaluator container is run. It needs to have metric read permissions against queryProjectId and metric write permissions against all projects to which rule results are written. Within GKE, this can typically be left empty if the compute default service account has the required permissions. properties: key: description: The key of the secret to select from. Must be a valid secret key. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the Secret or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic externalLabels: additionalProperties: type: string description: |- ExternalLabels specifies external labels that are attached to any rule results and alerts produced by rules. The precedence behavior matches that of Prometheus. type: object generatorUrl: description: |- The base URL used for the generator URL in the alert notification payload. Should point to an instance of a query frontend that gives access to queryProjectID. type: string queryProjectID: description: |- QueryProjectID is the GCP project ID to evaluate rules against. If left blank, the rule-evaluator will try attempt to infer the Project ID from the environment. type: string type: object scaling: description: Scaling contains configuration options for scaling GMP. properties: vpa: description: VPASpec defines configuration options for vertical pod autoscaling. properties: enabled: description: |- Enabled configures whether the operator configures Vertical Pod Autoscaling for GMP workloads. In GKE, installing Vertical Pod Autoscaling requires a cluster restart, and therefore it also results in an operator restart. In other environments, the operator may need to be restarted to enable VPA to run the following check again and watch for the objects. type: boolean type: object type: object type: object served: true storage: true - deprecated: true name: v1alpha1 schema: openAPIV3Schema: description: OperatorConfig defines configuration of the gmp-operator. properties: apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string collection: description: Collection specifies how the operator configures collection. properties: credentials: description: |- A reference to GCP service account credentials with which Prometheus collectors are run. It needs to have metric write permissions for all project IDs to which data is written. Within GKE, this can typically be left empty if the compute default service account has the required permissions. properties: key: description: The key of the secret to select from. Must be a valid secret key. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the Secret or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic externalLabels: additionalProperties: type: string description: |- ExternalLabels specifies external labels that are attached to all scraped data before being written to Cloud Monitoring. The precedence behavior matches that of Prometheus. type: object filter: description: Filter limits which metric data is sent to Cloud Monitoring. properties: matchOneOf: description: |- A list Prometheus time series matchers. Every time series must match at least one of the matchers to be exported. This field can be used equivalently to the match[] parameter of the Prometheus federation endpoint to selectively export data. Example: `["{job='prometheus'}", "{__name__=~'job:.*'}"]` items: type: string type: array type: object type: object kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object rules: description: Rules specifies how the operator configures and deployes rule-evaluator. properties: alerting: description: Alerting contains how the rule-evaluator configures alerting. properties: alertmanagers: description: Alertmanagers contains endpoint configuration for designated Alertmanagers. items: description: |- AlertmanagerEndpoints defines a selection of a single Endpoints object containing alertmanager IPs to fire alerts against. properties: apiVersion: description: |- Version of the Alertmanager API that rule-evaluator uses to send alerts. It can be "v1" or "v2". type: string authorization: description: Authorization section for this alertmanager endpoint properties: credentials: description: The secret's key that contains the credentials of the request properties: key: description: The key of the secret to select from. Must be a valid secret key. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the Secret or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic type: description: |- Set the authentication type. Defaults to Bearer, Basic will cause an error type: string type: object name: description: Name of Endpoints object in Namespace. type: string namespace: description: Namespace of Endpoints object. type: string pathPrefix: description: Prefix for the HTTP path alerts are pushed to. type: string port: anyOf: - type: integer - type: string description: Port the Alertmanager API is exposed on. x-kubernetes-int-or-string: true scheme: description: Scheme to use when firing alerts. type: string timeout: description: Timeout is a per-target Alertmanager timeout when pushing alerts. type: string tls: description: TLS Config to use for alertmanager connection. properties: ca: description: Struct containing the CA cert to use for the targets. properties: configMap: description: ConfigMap containing data to use for the targets. properties: key: description: The key to select. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the ConfigMap or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic secret: description: Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the Secret or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic type: object cert: description: Struct containing the client cert file for the targets. properties: configMap: description: ConfigMap containing data to use for the targets. properties: key: description: The key to select. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the ConfigMap or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic secret: description: Secret containing data to use for the targets. properties: key: description: The key of the secret to select from. Must be a valid secret key. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the Secret or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic type: object insecureSkipVerify: description: Disable target certificate validation. type: boolean keySecret: description: 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. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the Secret or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic serverName: description: Used to verify the hostname for the targets. type: string type: object required: - name - namespace - port type: object type: array type: object credentials: description: |- A reference to GCP service account credentials with which the rule evaluator container is run. It needs to have metric read permissions against queryProjectId and metric write permissions against all projects to which rule results are written. Within GKE, this can typically be left empty if the compute default service account has the required permissions. properties: key: description: The key of the secret to select from. Must be a valid secret key. type: string name: default: "" description: |- Name of the referent. This field is effectively required, but due to backwards compatibility is allowed to be empty. Instances of this type with an empty value here are almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names type: string optional: description: Specify whether the Secret or its key must be defined type: boolean required: - key type: object x-kubernetes-map-type: atomic externalLabels: additionalProperties: type: string description: |- ExternalLabels specifies external labels that are attached to any rule results and alerts produced by rules. The precedence behavior matches that of Prometheus. type: object queryProjectID: description: |- QueryProjectID is the GCP project ID to evaluate rules against. If left blank, the rule-evaluator will try attempt to infer the Project ID from the environment. type: string type: object type: object served: true storage: false --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: controller-gen.kubebuilder.io/version: v0.17.1-0.20250103184936-50893dee96da name: podmonitorings.monitoring.googleapis.com spec: group: monitoring.googleapis.com names: kind: PodMonitoring listKind: PodMonitoringList plural: podmonitorings singular: podmonitoring scope: Namespaced versions: - name: v1 schema: openAPIV3Schema: description: |- PodMonitoring defines monitoring for a set of pods, scoped to pods within the PodMonitoring's namespace. properties: apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: description: |- Specification of desired Pod selection for target discovery by Prometheus. properties: endpoints: description: The endpoints to scrape on the selected pods. items: description: ScrapeEndpoint specifies a Prometheus metrics endpoint to scrape. properties: authorization: description: Authorization is the HTTP authorization credentials for the targets. properties: credentials: description: Credentials uses the secret as the credentials (token) for the authentication header. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object type: description: |- Type is the authentication type. Defaults to Bearer. Basic will cause an error, as the BasicAuth object should be used instead. type: string x-kubernetes-validations: - message: authorization type cannot be set to "basic", use "basic_auth" instead rule: self != 'Basic' type: object basicAuth: description: BasicAuth is the HTTP basic authentication credentials for the targets. properties: password: description: Password uses the secret as the BasicAuth password. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object username: description: Username is the BasicAuth username. type: string type: object interval: description: Interval at which to scrape metrics. Must be a valid Prometheus duration. format: duration type: string metricRelabeling: description: |- Relabeling rules for metrics scraped from this endpoint. Relabeling rules that override protected target labels (project_id, location, cluster, namespace, job, instance, top_level_controller, top_level_controller_type, or __address__) are not permitted. The labelmap action is not permitted in general. items: description: RelabelingRule defines a single Prometheus relabeling rule. properties: action: description: Action to perform based on regex matching. Defaults to 'replace'. enum: - replace - lowercase - uppercase - keep - drop - keepequal - dropequal - hashmod - labeldrop - labelkeep type: string modulus: description: Modulus to take of the hash of the source label values. format: int64 type: integer regex: description: Regular expression against which the extracted value is matched. Defaults to '(.*)'. maxLength: 10000 type: string replacement: description: |- Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Defaults to '$1'. type: string separator: description: Separator placed between concatenated source label values. Defaults to ';'. type: string sourceLabels: description: |- The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions. items: pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ type: string maxItems: 100 type: array targetLabel: description: |- Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ type: string x-kubernetes-validations: - messageExpression: '''cannot relabel onto protected label "%s"''.format([self])' rule: self != 'project_id' && self != 'location' && self != 'cluster' && self != 'namespace' && self != 'job' && self != 'instance' && self != 'top_level_controller' && self != 'top_level_controller_type' && self != '__address__' type: object x-kubernetes-validations: - rule: '!has(self.action) || self.action != ''labeldrop'' || has(self.regex)' maxItems: 250 type: array oauth2: description: OAuth2 is the OAuth2 client credentials used to fetch a token for the targets. properties: clientID: description: ClientID is the public identifier for the client. type: string clientSecret: description: ClientSecret uses the secret as the client secret token. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object endpointParams: additionalProperties: type: string description: EndpointParams are additional parameters to append to the token URL. type: object proxyUrl: description: |- ProxyURL is the HTTP proxy server to use to connect to the targets. Encoded passwords are not supported. maxLength: 2000 type: string x-kubernetes-validations: - rule: isURL(self) && !self.matches('@') scopes: description: Scopes represents the scopes for the token request. items: type: string type: array tlsConfig: description: TLS configures the token request's TLS settings. properties: ca: description: |- SecretSelector references a secret from a secret provider e.g. Kubernetes Secret. Only one provider can be used at a time. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object cert: description: Cert uses the secret as the certificate for client authentication to the server. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object insecureSkipVerify: description: InsecureSkipVerify disables target certificate validation. type: boolean key: description: Key uses the secret as the private key for client authentication to the server. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object maxVersion: description: |- MaxVersion is the maximum TLS version. Accepted values: TLS10 (TLS 1.0), TLS11 (TLS 1.1), TLS12 (TLS 1.2), TLS13 (TLS 1.3). If unset, Prometheus will use Go default minimum version, which is TLS 1.2. See MinVersion in https://pkg.go.dev/crypto/tls#Config. enum: - TLS10 - TLS11 - TLS12 - TLS13 type: string minVersion: description: |- MinVersion is the minimum TLS version. Accepted values: TLS10 (TLS 1.0), TLS11 (TLS 1.1), TLS12 (TLS 1.2), TLS13 (TLS 1.3). If unset, Prometheus will use Go default minimum version, which is TLS 1.2. See MinVersion in https://pkg.go.dev/crypto/tls#Config. enum: - TLS10 - TLS11 - TLS12 - TLS13 type: string serverName: description: ServerName is used to verify the hostname for the targets. type: string type: object x-kubernetes-validations: - message: client cert and client key must be provided together, when either is provided rule: has(self.cert) == has(self.key) tokenURL: description: TokenURL is the URL to fetch the token from. type: string type: object params: additionalProperties: items: type: string type: array description: HTTP GET params to use when scraping. type: object path: description: HTTP path to scrape metrics from. Defaults to "/metrics". type: string port: anyOf: - type: integer - type: string description: |- Name or number of the port to scrape. The container metadata label is only populated if the port is referenced by name because port numbers are not unique across containers. maxLength: 253 minLength: 1 pattern: ^[a-z0-9]([a-z0-9-]{0,251}[a-z0-9])?$ x-kubernetes-int-or-string: true x-kubernetes-validations: - message: Port is required rule: self != 0 proxyUrl: description: |- ProxyURL is the HTTP proxy server to use to connect to the targets. Encoded passwords are not supported. maxLength: 2000 type: string x-kubernetes-validations: - rule: isURL(self) && !self.matches('@') scheme: description: Protocol scheme to use to scrape. enum: - http - https type: string timeout: description: |- Timeout for metrics scrapes. Must be a valid Prometheus duration. Must not be larger than the scrape interval. format: duration type: string tls: description: TLS configures the scrape request's TLS settings. properties: ca: description: |- SecretSelector references a secret from a secret provider e.g. Kubernetes Secret. Only one provider can be used at a time. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object cert: description: Cert uses the secret as the certificate for client authentication to the server. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object insecureSkipVerify: description: InsecureSkipVerify disables target certificate validation. type: boolean key: description: Key uses the secret as the private key for client authentication to the server. properties: secret: description: Secret represents reference to a given key from certain Secret in a given namespace. properties: key: description: Key of the secret to select from. Must be a valid secret key. type: string name: description: Name of the secret to select from. type: string namespace: description: |- Namespace of the secret to select from. If empty the parent resource namespace will be chosen. type: string required: - key - name type: object type: object maxVersion: description: |- MaxVersion is the maximum TLS version. Accepted values: TLS10 (TLS 1.0), TLS11 (TLS 1.1), TLS12 (TLS 1.2), TLS13 (TLS 1.3). If unset, Prometheus will use Go default minimum version, which is TLS 1.2. See MinVersion in https://pkg.go.dev/crypto/tls#Config. enum: - TLS10 - TLS11 - TLS12 - TLS13 type: string minVersion: description: |- MinVersion is the minimum TLS version. Accepted values: TLS10 (TLS 1.0), TLS11 (TLS 1.1), TLS12 (TLS 1.2), TLS13 (TLS 1.3). If unset, Prometheus will use Go default minimum version, which is TLS 1.2. See MinVersion in https://pkg.go.dev/crypto/tls#Config. enum: - TLS10 - TLS11 - TLS12 - TLS13 type: string serverName: description: ServerName is used to verify the hostname for the targets. type: string type: object x-kubernetes-validations: - message: client cert and client key must be provided together, when either is provided rule: has(self.cert) == has(self.key) required: - interval - port type: object x-kubernetes-validations: - messageExpression: '''scrape timeout (%s) must not be greater than scrape interval (%s)''.format([self.timeout, self.interval])' rule: '!has(self.timeout) || self.timeout <= self.interval' - rule: '((has(self.authorization) ? 1 : 0) + (has(self.basicAuth) ? 1 : 0) + (has(self.oauth2) ? 1 : 0)) <= 1' maxItems: 10 minItems: 1 type: array filterRunning: description: |- FilterRunning will drop any pods that are in the "Failed" or "Succeeded" pod lifecycle. See: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase type: boolean limits: description: Limits to apply at scrape time. properties: labelNameLength: description: |- Maximum label name length. Uses Prometheus default if left unspecified. format: int64 type: integer labelValueLength: description: |- Maximum label value length. Uses Prometheus default if left unspecified. format: int64 type: integer labels: description: |- Maximum number of labels accepted for a single sample. Uses Prometheus default if left unspecified. format: int64 type: integer samples: description: |- Maximum number of samples accepted within a single scrape. Uses Prometheus default if left unspecified. format: int64 type: integer type: object selector: description: |- Label selector that specifies which pods are selected for this monitoring configuration. properties: matchExpressions: description: matchExpressions is a list of label selector requirements. The requirements are ANDed. items: description: |- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. properties: key: description: key is the label key that the selector applies to. type: string operator: description: |- operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. type: string values: description: |- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. items: type: string type: array x-kubernetes-list-type: atomic required: - key - operator type: object type: array x-kubernetes-list-type: atomic matchLabels: additionalProperties: type: string description: |- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. type: object type: object x-kubernetes-map-type: atomic targetLabels: description: |- Labels to add to the Prometheus target for discovered endpoints. The `instance` label is always set to `<pod_name>:<port>` or `<node_name>:<port>` if the scraped pod is controlled by a DaemonSet. properties: fromPod: description: |- Labels to transfer from the Kubernetes Pod to Prometheus target labels. Mappings are applied in order. items: description: |- LabelMapping specifies how to transfer a label from a Kubernetes resource onto a Prometheus target. properties: from: description: Kubernetes resource label to remap. type: string to: description: |- Remapped Prometheus target label. Defaults to the same name as `From`. pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$ type: string x-kubernetes-validations: - messageExpression: '''cannot relabel onto protected label "%s"''.format([self])' rule: self != 'project_id' && self != 'location' && self != 'cluster' && self != 'namespace' && self != 'job' && self != 'instance' && self != 'top_level_controller' && self != 'top_level_controller_type' && self != '__address__' required: - from type: object maxItems: 100 type: array metadata: default: - container - pod - top_level_controller_name - top_level_controller_type description: |- Pod metadata labels that are set on all scraped targets. Permitted keys are `container`, `node`, `pod`, `top_level_controller_name`, and `top_level_controller_type`. The `container` label is only populated if the scrape port is referenced by name. Defaults to [container, pod, top_level_controller_name, top_level_controller_type]. If set to null, it will be interpreted as the empty list. This is for backwards-compatibility only. items: enum: - container - node - pod - top_level_controller_name - top_level_controller_type type: string type: array x-kubernetes-list-type: set type: object required: - endpoints - selector type: object status: description: Most recently observed status of the resource. properties: conditions: description: Represents the latest available observations of a podmonitor's current state. items: description: MonitoringCondition describes the condition of a PodMonitoring. properties: lastTransitionTime: description: Last time the condition transitioned from one status to another. format: date-time type: string lastUpdateTime: description: The last time this condition was updated. format: date-time type: string message: description: A human-readable message indicating details about the transition. type: string reason: description: The reason for the condition's last transition. type: string status: description: Status of the condition, one of True, False, Unknown. type: string type: description: MonitoringConditionType is the type of MonitoringCondition. type: string required: - status - type type: object type: array endpointStatuses: description: Represents the latest available observations of target state for each ScrapeEndpoint. items: properties: activeTargets: description: Total number of active targets. format: int64 type: integer collectorsFraction: description: |- Fraction of collectors included in status, bounded [0,1]. Ideally, this should always be 1. Anything less can be considered a problem and should be investigated. type: string lastUpdateTime: description: Last time this status was updated. format: date-time type: string name: description: The name of the ScrapeEndpoint. type: string sampleGroups: description: A fixed sample of targets grouped by error type. items: properties: count: description: Total count of similar errors. format: int32 type: integer sampleTargets: description: Targets emitting the error message. items: properties: health: description: Health status. type: string labels: additionalProperties: description: A LabelValue is an associated value for a LabelName. type: string description: The label set, keys and values, of the target. type: object lastError: description: Error message. type: string lastScrapeDurationSeconds: description: Scrape duration in seconds. type: string type: object type: array type: object type: array unhealthyTargets: description: Total number of active, unhealthy targets. format: int64 type: integer required: - name type: object type: array observedGeneration: description: The generation observed by the controller. format: int64 type: integer type: object required: - spec type: object x-kubernetes-validations: - message: Namespace not allowed on PodMonitoring secret references. reason: FieldValueForbidden rule: self.spec.endpoints.all(e, !has(e.authorization) || !has(e.authorization.credentials) || !has(e.authorization.credentials.secret) || !has(e.authorization.credentials.secret.__namespace__)) - message: Namespace not allowed on PodMonitoring secret references. reason: FieldValueForbidden rule: self.spec.endpoints.all(e, !has(e.basicAuth) || !has(e.basicAuth.password) || !has(e.basicAuth.password.secret) || !has(e.basicAuth.password.secret.__namespace__)) - message: Namespace not allowed on PodMonitoring secret references. reason: FieldValueForbidden rule: self.spec.endpoints.all(e, !has(e.tls) || !has(e.tls.ca) || !has(e.tls.ca.secret) || !has(e.tls.ca.secret.__namespace__)) - message: Namespace not allowed on PodMonitoring secret references. reason: FieldValueForbidden rule: self.spec.endpoints.all(e, !has(e.tls) || !has(e.tls.cert) || !has(e.tls.cert.secret) || !has(e.tls.cert.secret.__namespace__)) - message: Namespace not allowed on PodMonitoring secret references. reason: FieldValueForbidden rule: self.spec.endpoints.all(e, !has(e.tls) || !has(e.tls.key) || !has(e.tls.key.secret) || !has(e.tls.key.secret.__namespace__)) - message: Namespace not allowed on PodMonitoring secret references. reason: FieldValueForbidden rule: self.spec.endpoints.all(e, !has(e.oauth2) || !has(e.oauth2.clientSecret) || !has(e.oauth2.clientSecret.secret) || !has(e.oauth2.clientSecret.secret.__namespace__)) served: true storage: true subresources: status: {} - deprecated: true name: v1alpha1 schema: openAPIV3Schema: description: PodMonitoring defines monitoring for a set of pods. properties: apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: description: |- Specification of desired Pod selection for target discovery by Prometheus. properties: endpoints: description: The endpoints to scrape on the selected pods. items: description: ScrapeEndpoint specifies a Prometheus metrics endpoint to scrape. properties: interval: description: Interval at which to scrape metrics. Must be a valid Prometheus duration. type: string metricRelabeling: description: |- Relabeling rules for metrics scraped from this endpoint. Relabeling rules that override protected target labels (project_id, location, cluster, namespace, job, instance, or __address__) are not permitted. The labelmap action is not permitted in general. items: description: RelabelingRule defines a single Prometheus relabeling rule. properties: action: description: Action to perform based on regex matching. Defaults to 'replace'. type: string modulus: description: Modulus to take of the hash of the source label values. format: int64 type: integer regex: description: Regular expression against which the extracted value is matched. Defaults to '(.*)'. type: string replacement: description: |- Replacement value against which a regex replace is performed if the regular expression matches. Regex capture groups are available. Defaults to '$1'. type: string separator: description: Separator placed between concatenated source label values. Defaults to ';'. type: string sourceLabels: description: |- The source labels select values from existing labels. Their content is concatenated using the configured separator and matched against the configured regular expression for the replace, keep, and drop actions. items: type: string type: array targetLabel: description: |- Label to which the resulting value is written in a replace action. It is mandatory for replace actions. Regex capture groups are available. type: string type: object type: array params: additionalProperties: items: type: string type: array description: HTTP GET params to use when scraping. type: object path: description: HTTP path to scrape metrics from. Defaults to "/metrics". type: string port: anyOf: - type: integer - type: string description: Name or number of the port to scrape. x-kubernetes-int-or-string: true proxyUrl: description: Proxy URL to scrape through. Encoded passwords are not supported. type: string scheme: description: Protocol scheme to use to scrape. type: string timeout: description: |- Timeout for metrics scrapes. Must be a valid Prometheus duration. Must not be larger then the scrape interval. type: string required: - port type: object type: array limits: description: Limits to apply at scrape time. properties: labelNameLength: description: |- Maximum label name length. Uses Prometheus default if left unspecified. format: int64 type: integer labelValueLength: description: |- Maximum label value length. Uses Prometheus default if left unspecified. format: int64 type: integer labels: description: |- Maximum number of labels accepted for a single sample. Uses Prometheus default if left unspecified. format: int64 type: integer samples: description: |- Maximum number of samples accepted within a single scrape. Uses Prometheus default if left unspecified. format: int64 type: integer type: object selector: description: |- Label selector that specifies which pods are selected for this monitoring configuration. properties: matchExpressions: description: matchExpressions is a list of label selector requirements. The requirements are ANDed. items: description: |- A label selector requirement is a selector that contains values, a key, and an operator that relates the key and values. properties: key: description: key is the label key that the selector applies to. type: string operator: description: |- operator represents a key's relationship to a set of values. Valid operators are In, NotIn, Exists and DoesNotExist. type: string values: description: |- values is an array of string values. If the operator is In or NotIn, the values array must be non-empty. If the operator is Exists or DoesNotExist, the values array must be empty. This array is replaced during a strategic merge patch. items: type: string type: array x-kubernetes-list-type: atomic required: - key - operator type: object type: array x-kubernetes-list-type: atomic matchLabels: additionalProperties: type: string description: |- matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels map is equivalent to an element of matchExpressions, whose key field is "key", the operator is "In", and the values array contains only "value". The requirements are ANDed. type: object type: object x-kubernetes-map-type: atomic targetLabels: description: Labels to add to the Prometheus target for discovered endpoints. properties: fromPod: description: |- Labels to transfer from the Kubernetes Pod to Prometheus target labels. Mappings are applied in order. items: description: |- LabelMapping specifies how to transfer a label from a Kubernetes resource onto a Prometheus target. properties: from: description: Kubenetes resource label to remap. type: string to: description: |- Remapped Prometheus target label. Defaults to the same name as `From`. type: string required: - from type: object type: array metadata: description: |- Pod metadata labels that are set on all scraped targets. Permitted keys are `pod`, `container`, and `node` for PodMonitoring and `pod`, `container`, `node`, and `namespace` for ClusterPodMonitoring. Defaults to [pod, container] for PodMonitoring and [namespace, pod, container] for ClusterPodMonitoring. If set to null, it will be interpreted as the empty list for PodMonitoring and to [namespace] for ClusterPodMonitoring. This is for backwards-compatibility only. items: type: string type: array type: object required: - endpoints - selector type: object status: description: Most recently observed status of the resource. properties: conditions: description: Represents the latest available observations of a podmonitor's current state. items: description: MonitoringCondition describes a condition of a PodMonitoring. properties: lastTransitionTime: description: Last time the condition transitioned from one status to another. format: date-time type: string lastUpdateTime: description: The last time this condition was updated. format: date-time type: string message: description: A human-readable message indicating details about the transition. type: string reason: description: The reason for the condition's last transition. type: string status: description: Status of the condition, one of True, False, Unknown. type: string type: description: MonitoringConditionType is the type of MonitoringCondition. type: string required: - status - type type: object type: array observedGeneration: description: The generation observed by the controller. format: int64 type: integer type: object required: - spec type: object served: true storage: false subresources: status: {} --- apiVersion: apiextensions.k8s.io/v1 kind: CustomResourceDefinition metadata: annotations: controller-gen.kubebuilder.io/version: v0.17.1-0.20250103184936-50893dee96da name: rules.monitoring.googleapis.com spec: group: monitoring.googleapis.com names: kind: Rules listKind: RulesList plural: rules singular: rules scope: Namespaced versions: - name: v1 schema: openAPIV3Schema: description: |- Rules defines Prometheus alerting and recording rules that are scoped to the namespace of the resource. Only metric data from this namespace is processed and all rule results have their project_id, cluster, and namespace label preserved for query processing. If the location label is not preserved by the rule, it defaults to the cluster's location. properties: apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: description: Specification of rules to record and alert on. properties: groups: description: A list of Prometheus rule groups. items: description: |- RuleGroup declares rules in the Prometheus format: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/ properties: interval: default: 1m description: The interval at which to evaluate the rules. Must be a valid Prometheus duration. format: duration type: string name: description: The name of the rule group. type: string rules: description: A list of rules that are executed sequentially as part of this group. items: description: |- Rule is a single rule in the Prometheus format: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/ properties: alert: description: |- Name of the alert to evaluate the expression as. Only one of `record` and `alert` must be set. type: string annotations: additionalProperties: type: string description: |- A set of annotations to attach to alerts produced by the query expression. Only valid if `alert` is set. type: object expr: description: The PromQL expression to evaluate. type: string for: description: |- The duration to wait before a firing alert produced by this rule is sent to Alertmanager. Only valid if `alert` is set. format: duration type: string labels: additionalProperties: type: string description: A set of labels to attach to the result of the query expression. type: object record: description: |- Record the result of the expression to this metric name. Only one of `record` and `alert` must be set. pattern: ^[a-zA-Z_:][a-zA-Z0-9_:]*$ type: string required: - expr type: object x-kubernetes-validations: - message: Must set exactly one of Record or Alert rule: '(has(self.record) ? 1 : 0) + (has(self.alert) ? 1 : 0) == 1' - message: Annotations are only allowed for alerting rules rule: '!has(self.annotations) || has(self.alert)' minItems: 1 type: array required: - name - rules type: object type: array required: - groups type: object status: description: Most recently observed status of the resource. properties: conditions: description: Represents the latest available observations of a podmonitor's current state. items: description: MonitoringCondition describes the condition of a PodMonitoring. properties: lastTransitionTime: description: Last time the condition transitioned from one status to another. format: date-time type: string lastUpdateTime: description: The last time this condition was updated. format: date-time type: string message: description: A human-readable message indicating details about the transition. type: string reason: description: The reason for the condition's last transition. type: string status: description: Status of the condition, one of True, False, Unknown. type: string type: description: MonitoringConditionType is the type of MonitoringCondition. type: string required: - status - type type: object type: array observedGeneration: description: The generation observed by the controller. format: int64 type: integer type: object required: - spec type: object served: true storage: true subresources: status: {} - deprecated: true name: v1alpha1 schema: openAPIV3Schema: description: |- Rules defines Prometheus alerting and recording rules that are scoped to the namespace of the resource. Only metric data from this namespace is processed and all rule results have their project_id, cluster, and namespace label preserved for query processing. If the location label is not preserved by the rule, it defaults to the cluster's location. properties: apiVersion: description: |- APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources type: string kind: description: |- Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds type: string metadata: type: object spec: description: Specification of rules to record and alert on. properties: groups: description: A list of Prometheus rule groups. items: description: |- RuleGroup declares rules in the Prometheus format: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/ properties: interval: description: The interval at which to evaluate the rules. Must be a valid Prometheus duration. type: string name: description: The name of the rule group. type: string rules: description: A list of rules that are executed sequentially as part of this group. items: description: |- Rule is a single rule in the Prometheus format: https://prometheus.io/docs/prometheus/latest/configuration/recording_rules/ properties: alert: description: |- Name of the alert to evaluate the expression as. Only one of `record` and `alert` must be set. type: string annotations: additionalProperties: type: string description: |- A set of annotations to attach to alerts produced by the query expression. Only valid if `alert` is set. type: object expr: description: The PromQL expression to evaluate. type: string for: description: |- The duration to wait before a firing alert produced by this rule is sent to Alertmanager. Only valid if `alert` is set. type: string labels: additionalProperties: type: string description: A set of labels to attach to the result of the query expression. type: object record: description: |- Record the result of the expression to this metric name. Only one of `record` and `alert` must be set. type: string required: - expr type: object type: array required: - interval - name - rules type: object type: array required: - groups type: object status: description: Most recently observed status of the resource. type: object required: - spec type: object served: true storage: false subresources: status: {}