diff --git a/docs/examples/src/charts/charts.k b/docs/examples/src/charts/charts.k index bc319dbf..dc9699fa 100644 --- a/docs/examples/src/charts/charts.k +++ b/docs/examples/src/charts/charts.k @@ -29,7 +29,7 @@ charts: helm.Charts = { crdPaths = ["**/crds/crds/*.yaml"] repoURL = "https://prometheus-community.github.io/helm-charts" schemaGenerator = "AUTO" - targetRevision = "69.8.2" + targetRevision = "80.4.1" } simple_chart: { chart = "simple-chart" diff --git a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_alertmanager.k b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_alertmanager.k index 9ba7a8ad..c937ddd0 100644 --- a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_alertmanager.k +++ b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_alertmanager.k @@ -40,13 +40,19 @@ schema Alertmanager: schema MonitoringCoreosComV1AlertmanagerSpec: r""" - Specification of the desired behavior of the Alertmanager cluster. More info: + spec defines the specification of the desired behavior of the Alertmanager cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Attributes ---------- + additionalArgs : [MonitoringCoreosComV1AlertmanagerSpecAdditionalArgsItems0], default is Undefined, optional + additionalArgs allows setting additional arguments for the 'Alertmanager' container. + It is intended for e.g. activating hidden flags which are not supported by + the dedicated configuration options yet. The arguments are passed as-is to the + Alertmanager container which may cause issues if they are invalid or not supported + by the given Alertmanager version. additionalPeers : [str], default is Undefined, optional - AdditionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster. + additionalPeers allows injecting a set of additional Alertmanagers to peer with to form a highly available cluster. affinity : MonitoringCoreosComV1AlertmanagerSpecAffinity, default is Undefined, optional affinity alertmanagerConfigMatcherStrategy : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigMatcherStrategy, default is Undefined, optional @@ -58,31 +64,33 @@ schema MonitoringCoreosComV1AlertmanagerSpec: alertmanagerConfiguration : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfiguration, default is Undefined, optional alertmanager configuration automountServiceAccountToken : bool, default is Undefined, optional - AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod. + automountServiceAccountToken defines whether a service account token should be automatically mounted in the pod. If the service account has `automountServiceAccountToken: true`, set the field to `false` to opt out of automounting API credentials. baseImage : str, default is Undefined, optional - Base image that is used to deploy pods, without tag. + baseImage that is used to deploy pods, without tag. Deprecated: use 'image' instead. clusterAdvertiseAddress : str, default is Undefined, optional - ClusterAdvertiseAddress is the explicit address to advertise in cluster. + clusterAdvertiseAddress defines the explicit address to advertise in cluster. Needs to be provided for non RFC1918 [1] (public) addresses. [1] RFC1918: https://tools.ietf.org/html/rfc1918 clusterGossipInterval : str, default is Undefined, optional - Interval between gossip attempts. + clusterGossipInterval defines the interval between gossip attempts. clusterLabel : str, default is Undefined, optional - Defines the identifier that uniquely identifies the Alertmanager cluster. + clusterLabel defines the identifier that uniquely identifies the Alertmanager cluster. You should only set it when the Alertmanager cluster includes Alertmanager instances which are external to this Alertmanager resource. In practice, the addresses of the external instances are provided via the `.spec.additionalPeers` field. clusterPeerTimeout : str, default is Undefined, optional - Timeout for cluster peering. + clusterPeerTimeout defines the timeout for cluster peering. clusterPushpullInterval : str, default is Undefined, optional - Interval between pushpull attempts. + clusterPushpullInterval defines the interval between pushpull attempts. + clusterTLS : MonitoringCoreosComV1AlertmanagerSpecClusterTLS, default is Undefined, optional + cluster TLS configMaps : [str], default is Undefined, optional - ConfigMaps is a list of ConfigMaps in the same namespace as the Alertmanager + configMaps defines a list of ConfigMaps in the same namespace as the Alertmanager object, which shall be mounted into the Alertmanager Pods. Each ConfigMap is added to the StatefulSet definition as a volume named `configmap-`. The ConfigMaps are mounted into `/etc/alertmanager/configmaps/` in the 'alertmanager' container. configSecret : str, default is Undefined, optional - ConfigSecret is the name of a Kubernetes Secret in the same namespace as the + configSecret defines the name of a Kubernetes Secret in the same namespace as the Alertmanager object, which contains the configuration for this Alertmanager instance. If empty, it defaults to `alertmanager-`. @@ -95,7 +103,7 @@ schema MonitoringCoreosComV1AlertmanagerSpec: operator provisions a minimal Alertmanager configuration with one empty receiver (effectively dropping alert notifications). containers : [MonitoringCoreosComV1AlertmanagerSpecContainersItems0], default is Undefined, optional - Containers allows injecting additional containers. This is meant to + containers allows injecting additional containers. This is meant to allow adding an authentication proxy to an Alertmanager pod. Containers described here modify an operator generated container if they share the same name and modifications are done via a strategic merge @@ -106,37 +114,46 @@ schema MonitoringCoreosComV1AlertmanagerSpec: dnsConfig : MonitoringCoreosComV1AlertmanagerSpecDNSConfig, default is Undefined, optional dns config dnsPolicy : str, default is Undefined, optional - Defines the DNS policy for the pods. + dnsPolicy defines the DNS policy for the pods. enableFeatures : [str], default is Undefined, optional - Enable access to Alertmanager feature flags. By default, no features are enabled. + enableFeatures defines the Alertmanager's feature flags. By default, no features are enabled. Enabling features which are disabled by default is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. It requires Alertmanager >= 0.27.0. + enableServiceLinks : bool, default is Undefined, optional + enableServiceLinks defines whether information about services should be injected into pod's environment variables externalUrl : str, default is Undefined, optional - The external URL the Alertmanager instances will be available under. This is + externalUrl defines the URL used to access the Alertmanager web service. This is necessary to generate correct URLs. This is necessary if Alertmanager is not served from root of a DNS name. forceEnableClusterMode : bool, default is Undefined, optional - ForceEnableClusterMode ensures Alertmanager does not deactivate the cluster mode when running with a single replica. + forceEnableClusterMode ensures Alertmanager does not deactivate the cluster mode when running with a single replica. Use case is e.g. spanning an Alertmanager cluster across Kubernetes clusters with a single replica in each. hostAliases : [MonitoringCoreosComV1AlertmanagerSpecHostAliasesItems0], default is Undefined, optional - Pods' hostAliases configuration + hostAliases Pods configuration + hostUsers : bool, default is Undefined, optional + hostUsers supports the user space in Kubernetes. + + More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/ + + The feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled. + Starting Kubernetes 1.33, the feature is enabled by default. image : str, default is Undefined, optional - Image if specified has precedence over baseImage, tag and sha + image if specified has precedence over baseImage, tag and sha combinations. Specifying the version is still necessary to ensure the Prometheus Operator knows what version of Alertmanager is being configured. imagePullPolicy : str, default is Undefined, optional - Image pull policy for the 'alertmanager', 'init-config-reloader' and 'config-reloader' containers. + imagePullPolicy for the 'alertmanager', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details. imagePullSecrets : [MonitoringCoreosComV1AlertmanagerSpecImagePullSecretsItems0], default is Undefined, optional - An optional list of references to secrets in the same namespace + imagePullSecrets An optional list of references to secrets in the same namespace to use for pulling prometheus and alertmanager images from registries - see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod + see https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ initContainers : [MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0], default is Undefined, optional - InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. + initContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the Alertmanager configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ InitContainers described here modify an operator @@ -145,85 +162,100 @@ schema MonitoringCoreosComV1AlertmanagerSpec: `init-config-reloader`. Overriding init containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. + limits : MonitoringCoreosComV1AlertmanagerSpecLimits, default is Undefined, optional + limits listenLocal : bool, default is Undefined, optional - ListenLocal makes the Alertmanager server listen on loopback, so that it + listenLocal defines the Alertmanager server listen on loopback, so that it does not bind against the Pod IP. Note this is only for the Alertmanager UI, not the gossip communication. logFormat : str, default is Undefined, optional - Log format for Alertmanager to be configured with. + logFormat for Alertmanager to be configured with. logLevel : str, default is Undefined, optional - Log level for Alertmanager to be configured with. + logLevel for Alertmanager to be configured with. minReadySeconds : int, default is Undefined, optional - Minimum number of seconds for which a newly created pod should be ready + minReadySeconds defines the minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. - Defaults to 0 (pod will be considered available as soon as it is ready) - This is an alpha field from kubernetes 1.22 until 1.24 which requires enabling the StatefulSetMinReadySeconds feature gate. + + If unset, pods will be considered available as soon as they are ready. nodeSelector : {str:str}, default is Undefined, optional - Define which Nodes the Pods are scheduled on. + nodeSelector defines which Nodes the Pods are scheduled on. paused : bool, default is Undefined, optional - If set to true all actions on the underlying managed objects are not - goint to be performed, except for delete actions. + paused if set to true all actions on the underlying managed objects are not + going to be performed, except for delete actions. persistentVolumeClaimRetentionPolicy : MonitoringCoreosComV1AlertmanagerSpecPersistentVolumeClaimRetentionPolicy, default is Undefined, optional persistent volume claim retention policy podMetadata : MonitoringCoreosComV1AlertmanagerSpecPodMetadata, default is Undefined, optional pod metadata portName : str, default is "web", optional - Port name used for the pods and governing service. + portName defines the port's name for the pods and governing service. Defaults to `web`. priorityClassName : str, default is Undefined, optional - Priority class assigned to the Pods + priorityClassName assigned to the Pods replicas : int, default is Undefined, optional - Size is the expected size of the alertmanager cluster. The controller will + replicas defines the expected size of the alertmanager cluster. The controller will eventually make the size of the running cluster equal to the expected size. resources : MonitoringCoreosComV1AlertmanagerSpecResources, default is Undefined, optional resources retention : str, default is "120h", optional - Time duration Alertmanager shall retain data for. Default is '120h', + retention defines the time duration Alertmanager shall retain data for. Default is '120h', and must match the regular expression `[0-9]+(ms|s|m|h)` (milliseconds seconds minutes hours). routePrefix : str, default is Undefined, optional - The route prefix Alertmanager registers HTTP handlers for. This is useful, + routePrefix Alertmanager registers HTTP handlers for. This is useful, if using ExternalURL and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but the server serves requests under a different route prefix. For example for use with `kubectl proxy`. secrets : [str], default is Undefined, optional - Secrets is a list of Secrets in the same namespace as the Alertmanager + secrets is a list of Secrets in the same namespace as the Alertmanager object, which shall be mounted into the Alertmanager Pods. Each Secret is added to the StatefulSet definition as a volume named `secret-`. The Secrets are mounted into `/etc/alertmanager/secrets/` in the 'alertmanager' container. securityContext : MonitoringCoreosComV1AlertmanagerSpecSecurityContext, default is Undefined, optional security context serviceAccountName : str, default is Undefined, optional - ServiceAccountName is the name of the ServiceAccount to use to run the + serviceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods. + serviceName : str, default is Undefined, optional + serviceName defines the service name used by the underlying StatefulSet(s) as the governing service. + If defined, the Service must be created before the Alertmanager resource in the same namespace and it must define a selector that matches the pod labels. + If empty, the operator will create and manage a headless service named `alertmanager-operated` for Alertmanager resources. + When deploying multiple Alertmanager resources in the same namespace, it is recommended to specify a different value for each. + See https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details. sha : str, default is Undefined, optional - SHA of Alertmanager container image to be deployed. Defaults to the value of `version`. + sha of Alertmanager container image to be deployed. Defaults to the value of `version`. Similar to a tag, but the SHA explicitly deploys an immutable container image. Version and Tag are ignored if SHA is set. Deprecated: use 'image' instead. The image digest can be specified as part of the image URL. storage : MonitoringCoreosComV1AlertmanagerSpecStorage, default is Undefined, optional storage tag : str, default is Undefined, optional - Tag of Alertmanager container image to be deployed. Defaults to the value of `version`. + tag of Alertmanager container image to be deployed. Defaults to the value of `version`. Version is ignored if Tag is set. Deprecated: use 'image' instead. The image tag can be specified as part of the image URL. + terminationGracePeriodSeconds : int, default is Undefined, optional + terminationGracePeriodSeconds defines the Optional duration in seconds the pod needs to terminate gracefully. + Value must be non-negative integer. The value zero indicates stop immediately via + the kill signal (no opportunity to shut down) which may lead to data corruption. + + Defaults to 120 seconds. tolerations : [MonitoringCoreosComV1AlertmanagerSpecTolerationsItems0], default is Undefined, optional - If specified, the pod's tolerations. + tolerations defines the pod's tolerations. topologySpreadConstraints : [MonitoringCoreosComV1AlertmanagerSpecTopologySpreadConstraintsItems0], default is Undefined, optional - If specified, the pod's topology spread constraints. + topologySpreadConstraints defines the Pod's topology spread constraints. version : str, default is Undefined, optional - Version the cluster should be on. + version the cluster should be on. volumeMounts : [MonitoringCoreosComV1AlertmanagerSpecVolumeMountsItems0], default is Undefined, optional - VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. + volumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the alertmanager container, that are generated as a result of StorageSpec objects. volumes : [MonitoringCoreosComV1AlertmanagerSpecVolumesItems0], default is Undefined, optional - Volumes allows configuration of additional volumes on the output StatefulSet definition. + volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects. web : MonitoringCoreosComV1AlertmanagerSpecWeb, default is Undefined, optional web """ + additionalArgs?: [MonitoringCoreosComV1AlertmanagerSpecAdditionalArgsItems0] additionalPeers?: [str] affinity?: MonitoringCoreosComV1AlertmanagerSpecAffinity alertmanagerConfigMatcherStrategy?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigMatcherStrategy @@ -237,19 +269,23 @@ schema MonitoringCoreosComV1AlertmanagerSpec: clusterLabel?: str clusterPeerTimeout?: str clusterPushpullInterval?: str + clusterTLS?: MonitoringCoreosComV1AlertmanagerSpecClusterTLS configMaps?: [str] configSecret?: str containers?: [MonitoringCoreosComV1AlertmanagerSpecContainersItems0] dnsConfig?: MonitoringCoreosComV1AlertmanagerSpecDNSConfig dnsPolicy?: "ClusterFirstWithHostNet" | "ClusterFirst" | "Default" | "None" enableFeatures?: [str] + enableServiceLinks?: bool externalUrl?: str forceEnableClusterMode?: bool hostAliases?: [MonitoringCoreosComV1AlertmanagerSpecHostAliasesItems0] + hostUsers?: bool image?: str imagePullPolicy?: "" | "Always" | "Never" | "IfNotPresent" imagePullSecrets?: [MonitoringCoreosComV1AlertmanagerSpecImagePullSecretsItems0] initContainers?: [MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0] + limits?: MonitoringCoreosComV1AlertmanagerSpecLimits listenLocal?: bool logFormat?: "" | "logfmt" | "json" logLevel?: "" | "debug" | "info" | "warn" | "error" @@ -267,9 +303,11 @@ schema MonitoringCoreosComV1AlertmanagerSpec: secrets?: [str] securityContext?: MonitoringCoreosComV1AlertmanagerSpecSecurityContext serviceAccountName?: str + serviceName?: str sha?: str storage?: MonitoringCoreosComV1AlertmanagerSpecStorage tag?: str + terminationGracePeriodSeconds?: int tolerations?: [MonitoringCoreosComV1AlertmanagerSpecTolerationsItems0] topologySpreadConstraints?: [MonitoringCoreosComV1AlertmanagerSpecTopologySpreadConstraintsItems0] version?: str @@ -281,11 +319,32 @@ schema MonitoringCoreosComV1AlertmanagerSpec: _regex_match(str(clusterGossipInterval), r"^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if clusterGossipInterval _regex_match(str(clusterPeerTimeout), r"^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if clusterPeerTimeout _regex_match(str(clusterPushpullInterval), r"^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if clusterPushpullInterval + minReadySeconds >= 0 if minReadySeconds not in [None, Undefined] _regex_match(str(retention), r"^(0|(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if retention + len(serviceName) >= 1 if serviceName + terminationGracePeriodSeconds >= 0 if terminationGracePeriodSeconds not in [None, Undefined] + +schema MonitoringCoreosComV1AlertmanagerSpecAdditionalArgsItems0: + r""" + Argument as part of the AdditionalArgs list. + + Attributes + ---------- + name : str, default is Undefined, required + name of the argument, e.g. "scrape.discovery-reload-interval". + value : str, default is Undefined, optional + value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) + """ + name: str + + value?: str + + check: + len(name) >= 1 schema MonitoringCoreosComV1AlertmanagerSpecAffinity: r""" - If specified, the pod's scheduling constraints. + affinity defines the pod's scheduling constraints. Attributes ---------- @@ -544,7 +603,6 @@ schema MonitoringCoreosComV1AlertmanagerSpecAffinityPodAffinityPreferredDuringSc pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -554,7 +612,6 @@ schema MonitoringCoreosComV1AlertmanagerSpecAffinityPodAffinityPreferredDuringSc pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1AlertmanagerSpecAffinityPodAffinityPreferredDuringSchedulingIgnoredDuringExecutionItems0PodAffinityTermNamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -683,7 +740,6 @@ schema MonitoringCoreosComV1AlertmanagerSpecAffinityPodAffinityRequiredDuringSch pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -693,7 +749,6 @@ schema MonitoringCoreosComV1AlertmanagerSpecAffinityPodAffinityRequiredDuringSch pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1AlertmanagerSpecAffinityPodAffinityRequiredDuringSchedulingIgnoredDuringExecutionItems0NamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -813,8 +868,8 @@ schema MonitoringCoreosComV1AlertmanagerSpecAffinityPodAntiAffinity: most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), - compute a sum by iterating through the elements of this field and adding - "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the + compute a sum by iterating through the elements of this field and subtracting + "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. requiredDuringSchedulingIgnoredDuringExecution : [MonitoringCoreosComV1AlertmanagerSpecAffinityPodAntiAffinityRequiredDuringSchedulingIgnoredDuringExecutionItems0], default is Undefined, optional If the anti-affinity requirements specified by this field are not met at @@ -861,7 +916,6 @@ schema MonitoringCoreosComV1AlertmanagerSpecAffinityPodAntiAffinityPreferredDuri pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -871,7 +925,6 @@ schema MonitoringCoreosComV1AlertmanagerSpecAffinityPodAntiAffinityPreferredDuri pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1AlertmanagerSpecAffinityPodAntiAffinityPreferredDuringSchedulingIgnoredDuringExecutionItems0PodAffinityTermNamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -1000,7 +1053,6 @@ schema MonitoringCoreosComV1AlertmanagerSpecAffinityPodAntiAffinityRequiredDurin pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -1010,7 +1062,6 @@ schema MonitoringCoreosComV1AlertmanagerSpecAffinityPodAntiAffinityRequiredDurin pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1AlertmanagerSpecAffinityPodAntiAffinityRequiredDuringSchedulingIgnoredDuringExecutionItems0NamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -1119,23 +1170,23 @@ schema MonitoringCoreosComV1AlertmanagerSpecAffinityPodAntiAffinityRequiredDurin schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigMatcherStrategy: r""" - AlertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects + alertmanagerConfigMatcherStrategy defines how AlertmanagerConfig objects process incoming alerts. Attributes ---------- $type : str, default is "OnNamespace", optional - AlertmanagerConfigMatcherStrategyType defines the strategy used by + type defines the strategy used by AlertmanagerConfig objects to match alerts in the routes and inhibition rules. The default value is `OnNamespace`. """ - $type?: "OnNamespace" | "None" = "OnNamespace" + $type?: "OnNamespace" | "OnNamespaceExceptForAlertmanagerNamespace" | "None" = "OnNamespace" schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigNamespaceSelector: r""" - Namespaces to be selected for AlertmanagerConfig discovery. If nil, only + alertmanagerConfigNamespaceSelector defines the namespaces to be selected for AlertmanagerConfig discovery. If nil, only check own namespace. Attributes @@ -1176,7 +1227,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigNamespaceSelectorM schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigSelector: r""" - AlertmanagerConfigs to be selected for to merge and configure Alertmanager with. + alertmanagerConfigSelector defines the selector to be used for to merge and configure Alertmanager with. Attributes ---------- @@ -1216,7 +1267,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigSelectorMatchExpre schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfiguration: r""" - alertmanagerConfiguration specifies the configuration of Alertmanager. + alertmanagerConfiguration defines the configuration of Alertmanager. If defined, it takes precedence over the `configSecret` field. @@ -1228,11 +1279,11 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfiguration: global : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobal, default is Undefined, optional global name : str, default is Undefined, optional - The name of the AlertmanagerConfig resource which is used to generate the Alertmanager configuration. + name defines the name of the AlertmanagerConfig custom resource which is used to generate the Alertmanager configuration. It must be defined in the same namespace as the Alertmanager object. The operator will not enforce a `namespace` label for routes and inhibition rules. templates : [MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0], default is Undefined, optional - Custom notification templates. + templates defines the custom notification templates. """ global?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobal name?: str @@ -1243,41 +1294,60 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfiguration: schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobal: r""" - Defines the global parameters of the Alertmanager configuration. + global defines the global parameters of the Alertmanager configuration. Attributes ---------- httpConfig : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfig, default is Undefined, optional http config + jira : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalJira, default is Undefined, optional + jira opsGenieApiKey : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalOpsGenieAPIKey, default is Undefined, optional ops genie Api key opsGenieApiUrl : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalOpsGenieAPIURL, default is Undefined, optional ops genie Api Url pagerdutyUrl : str, default is Undefined, optional - The default Pagerduty URL. + pagerdutyUrl defines the default Pagerduty URL. resolveTimeout : str, default is Undefined, optional - ResolveTimeout is the default value used by alertmanager if the alert does + resolveTimeout defines the default value used by alertmanager if the alert does not include EndsAt, after this time passes it can declare the alert as resolved if it has not been updated. This has no impact on alerts from Prometheus, as they always include EndsAt. + rocketChat : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalRocketChat, default is Undefined, optional + rocket chat slackApiUrl : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSlackAPIURL, default is Undefined, optional slack Api Url smtp : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTP, default is Undefined, optional smtp + telegram : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalTelegram, default is Undefined, optional + telegram + victorops : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalVictorops, default is Undefined, optional + victorops + webex : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalWebex, default is Undefined, optional + webex + wechat : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalWechat, default is Undefined, optional + wechat """ httpConfig?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfig + jira?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalJira opsGenieApiKey?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalOpsGenieAPIKey opsGenieApiUrl?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalOpsGenieAPIURL pagerdutyUrl?: str resolveTimeout?: str + rocketChat?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalRocketChat slackApiUrl?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSlackAPIURL smtp?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTP + telegram?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalTelegram + victorops?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalVictorops + webex?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalWebex + wechat?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalWechat check: + _regex_match(str(pagerdutyUrl), r"^(http|https)://.+$") if pagerdutyUrl _regex_match(str(resolveTimeout), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if resolveTimeout schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfig: r""" - HTTP client configuration. + httpConfig defines the default HTTP configuration. Attributes ---------- @@ -1287,33 +1357,37 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC basic auth bearerTokenSecret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigBearerTokenSecret, default is Undefined, optional bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. followRedirects : bool, default is Undefined, optional - FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + followRedirects defines whether the client should follow HTTP 3xx + redirects. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. tlsConfig : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfig, default is Undefined, optional tls config """ authorization?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigAuthorization basicAuth?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigBasicAuth bearerTokenSecret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigBearerTokenSecret + enableHttp2?: bool followRedirects?: bool noProxy?: str oauth2?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2 @@ -1323,19 +1397,21 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC tlsConfig?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigAuthorization: r""" - Authorization header configuration for the client. - This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. + authorization configures the Authorization header credentials used by + the client. + + Cannot be set at the same time as `basicAuth`, `bearerTokenSecret` or `oauth2`. Attributes ---------- credentials : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -1346,7 +1422,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -1368,8 +1444,10 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigBasicAuth: r""" - BasicAuth for the client. - This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. + basicAuth defines the Basic Authentication credentials used by the + client. + + Cannot be set at the same time as `authorization`, `bearerTokenSecret` or `oauth2`. Attributes ---------- @@ -1383,7 +1461,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -1406,7 +1484,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -1429,10 +1507,14 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigBearerTokenSecret: r""" - The secret's key that contains the bearer token to be used by the client - for authentication. - The secret needs to be in the same namespace as the Alertmanager - object and accessible by the Prometheus Operator. + bearerTokenSecret defines a key of a Secret containing the bearer token + used by the client for authentication. The secret needs to be in the + same namespace as the custom resource and readable by the Prometheus + Operator. + + Cannot be set at the same time as `authorization`, `basicAuth` or `oauth2`. + + Deprecated: use `authorization` instead. Attributes ---------- @@ -1454,7 +1536,11 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2: r""" - OAuth2 client credentials used to fetch a token for the targets. + oauth2 defines the OAuth2 settings used by the client. + + It requires Prometheus >= 2.27.0. + + Cannot be set at the same time as `authorization`, `basicAuth` or `bearerTokenSecret`. Attributes ---------- @@ -1463,31 +1549,31 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC clientSecret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2ClientID @@ -1503,12 +1589,12 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -1523,7 +1609,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1545,7 +1631,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1567,7 +1653,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -1612,7 +1698,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -1622,19 +1708,19 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC cert : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2TLSConfigCa cert?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2TLSConfigCert @@ -1646,7 +1732,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -1660,7 +1746,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1682,7 +1768,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1704,7 +1790,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -1718,7 +1804,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1740,7 +1826,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1762,7 +1848,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -1801,59 +1887,842 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC """ key: str - name?: str = "" - optional?: bool + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfig: + r""" + tlsConfig defines the TLS configuration used by the client. + + Attributes + ---------- + ca : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCa, default is Undefined, optional + ca + cert : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCert, default is Undefined, optional + cert + insecureSkipVerify : bool, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigKeySecret, default is Undefined, optional + key secret + maxVersion : str, default is Undefined, optional + maxVersion defines the maximum acceptable TLS version. + + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. + minVersion : str, default is Undefined, optional + minVersion defines the minimum acceptable TLS version. + + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. + serverName : str, default is Undefined, optional + serverName is used to verify the hostname for the targets. + """ + ca?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCa + cert?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCert + insecureSkipVerify?: bool + keySecret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigKeySecret + maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + serverName?: str + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCa: + r""" + ca defines the Certificate authority used when verifying server certificates. + + Attributes + ---------- + configMap : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCaConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCaSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCaConfigMap + secret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCaSecret + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCaConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCaSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCert: + r""" + cert defines the Client certificate to present when doing client-authentication. + + Attributes + ---------- + configMap : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCertConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCertSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCertConfigMap + secret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCertSecret + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCertConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCertSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigKeySecret: + r""" + keySecret defines the Secret containing the client key file for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalJira: + r""" + jira defines the default configuration for Jira. + + Attributes + ---------- + apiURL : str, default is Undefined, optional + apiURL defines the default Jira API URL. + + It requires Alertmanager >= v0.28.0. + """ + apiURL?: str + + check: + _regex_match(str(apiURL), r"^(http|https)://.+$") if apiURL + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalOpsGenieAPIKey: + r""" + opsGenieApiKey defines the default OpsGenie API Key. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalOpsGenieAPIURL: + r""" + opsGenieApiUrl defines the default OpsGenie API URL. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalRocketChat: + r""" + rocketChat defines the default configuration for Rocket Chat. + + Attributes + ---------- + apiURL : str, default is Undefined, optional + apiURL defines the default Rocket Chat API URL. + + It requires Alertmanager >= v0.28.0. + token : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalRocketChatToken, default is Undefined, optional + token + tokenID : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalRocketChatTokenID, default is Undefined, optional + token ID + """ + apiURL?: str + token?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalRocketChatToken + tokenID?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalRocketChatTokenID + + check: + _regex_match(str(apiURL), r"^(http|https)://.+$") if apiURL + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalRocketChatToken: + r""" + token defines the default Rocket Chat token. + + It requires Alertmanager >= v0.28.0. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalRocketChatTokenID: + r""" + tokenID defines the default Rocket Chat Token ID. + + It requires Alertmanager >= v0.28.0. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTP: + r""" + smtp defines global SMTP parameters. + + Attributes + ---------- + authIdentity : str, default is Undefined, optional + authIdentity represents SMTP Auth using PLAIN + authPassword : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPAuthPassword, default is Undefined, optional + auth password + authSecret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPAuthSecret, default is Undefined, optional + auth secret + authUsername : str, default is Undefined, optional + authUsername represents SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server. + from : str, default is Undefined, optional + from defines the default SMTP From header field. + hello : str, default is Undefined, optional + hello defines the default hostname to identify to the SMTP server. + requireTLS : bool, default is Undefined, optional + requireTLS defines the default SMTP TLS requirement. + Note that Go does not support unencrypted connections to remote SMTP endpoints. + smartHost : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPSmartHost, default is Undefined, optional + smart host + tlsConfig : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfig, default is Undefined, optional + tls config + """ + authIdentity?: str + authPassword?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPAuthPassword + authSecret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPAuthSecret + authUsername?: str + from?: str + hello?: str + requireTLS?: bool + smartHost?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPSmartHost + tlsConfig?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfig + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPAuthPassword: + r""" + authPassword represents SMTP Auth using LOGIN and PLAIN. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPAuthSecret: + r""" + authSecret represents SMTP Auth using CRAM-MD5. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPSmartHost: + r""" + smartHost defines the default SMTP smarthost used for sending emails. + + Attributes + ---------- + host : str, default is Undefined, required + host defines the host's address, it can be a DNS name or a literal IP address. + port : str, default is Undefined, required + port defines the host's port, it can be a literal port number or a port name. + """ + host: str + + port: str + + check: + len(host) >= 1 + len(port) >= 1 + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfig: + r""" + tlsConfig defines the default TLS configuration for SMTP receivers + + Attributes + ---------- + ca : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCa, default is Undefined, optional + ca + cert : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCert, default is Undefined, optional + cert + insecureSkipVerify : bool, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigKeySecret, default is Undefined, optional + key secret + maxVersion : str, default is Undefined, optional + maxVersion defines the maximum acceptable TLS version. + + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. + minVersion : str, default is Undefined, optional + minVersion defines the minimum acceptable TLS version. + + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. + serverName : str, default is Undefined, optional + serverName is used to verify the hostname for the targets. + """ + ca?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCa + cert?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCert + insecureSkipVerify?: bool + keySecret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigKeySecret + maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + serverName?: str + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCa: + r""" + ca defines the Certificate authority used when verifying server certificates. + + Attributes + ---------- + configMap : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCaConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCaSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCaConfigMap + secret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCaSecret + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCaConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCaSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCert: + r""" + cert defines the Client certificate to present when doing client-authentication. + + Attributes + ---------- + configMap : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCertConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCertSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCertConfigMap + secret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCertSecret + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCertConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigCertSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPTLSConfigKeySecret: + r""" + keySecret defines the Secret containing the client key file for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSlackAPIURL: + r""" + slackApiUrl defines the default Slack API URL. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalTelegram: + r""" + telegram defines the default Telegram config + + Attributes + ---------- + apiURL : str, default is Undefined, optional + apiURL defines he default Telegram API URL. + + It requires Alertmanager >= v0.24.0. + """ + apiURL?: str + + check: + _regex_match(str(apiURL), r"^(http|https)://.+$") if apiURL + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalVictorops: + r""" + victorops defines the default configuration for VictorOps. + + Attributes + ---------- + apiKey : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalVictoropsAPIKey, default is Undefined, optional + api key + apiURL : str, default is Undefined, optional + apiURL defines the default VictorOps API URL. + """ + apiKey?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalVictoropsAPIKey + apiURL?: str + + check: + _regex_match(str(apiURL), r"^(http|https)://.+$") if apiURL + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalVictoropsAPIKey: + r""" + apiKey defines the default VictorOps API Key. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalWebex: + r""" + webex defines the default configuration for Jira. + + Attributes + ---------- + apiURL : str, default is Undefined, optional + apiURL defines the is the default Webex API URL. + + It requires Alertmanager >= v0.25.0. + """ + apiURL?: str + + check: + _regex_match(str(apiURL), r"^(http|https)://.+$") if apiURL + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalWechat: + r""" + wechat defines the default WeChat Config + + Attributes + ---------- + apiCorpID : str, default is Undefined, optional + apiCorpID defines the default WeChat API Corporate ID. + apiSecret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalWechatAPISecret, default is Undefined, optional + api secret + apiURL : str, default is Undefined, optional + apiURL defines he default WeChat API URL. + The default value is "https://qyapi.weixin.qq.com/cgi-bin/" + """ + apiCorpID?: str + apiSecret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalWechatAPISecret + apiURL?: str + + check: + len(apiCorpID) >= 1 if apiCorpID + _regex_match(str(apiURL), r"^(http|https)://.+$") if apiURL + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalWechatAPISecret: + r""" + apiSecret defines the default WeChat API Secret. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0: + r""" + SecretOrConfigMap allows to specify data as a Secret or ConfigMap. Fields are mutually exclusive. + + Attributes + ---------- + configMap : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0ConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0Secret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0ConfigMap + secret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0Secret + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0ConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0Secret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLS: + r""" + clusterTLS defines the mutual TLS configuration for the Alertmanager cluster's gossip protocol. + + It requires Alertmanager >= 0.24.0. + + Attributes + ---------- + client : MonitoringCoreosComV1AlertmanagerSpecClusterTLSClient, default is Undefined, required + client + server : MonitoringCoreosComV1AlertmanagerSpecClusterTLSServer, default is Undefined, required + server + """ + client: MonitoringCoreosComV1AlertmanagerSpecClusterTLSClient + + server: MonitoringCoreosComV1AlertmanagerSpecClusterTLSServer -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfig: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSClient: r""" - TLS configuration for the client. + client defines the client-side configuration for mutual TLS. Attributes ---------- - ca : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCa, default is Undefined, optional + ca : MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCa, default is Undefined, optional ca - cert : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCert, default is Undefined, optional + cert : MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. - keySecret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigKeySecret, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ - ca?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCa - cert?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCert + ca?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCa + cert?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCert insecureSkipVerify?: bool - keySecret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigKeySecret + keySecret?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientKeySecret maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" serverName?: str -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCa: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- - configMap : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCaConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCaConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCaSecret, default is Undefined, optional + secret : MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCaSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCaConfigMap - secret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCaSecret + configMap?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCaConfigMap + secret?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCaSecret -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCaConfigMap: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1873,9 +2742,9 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC name?: str = "" optional?: bool -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCaSecret: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1895,23 +2764,23 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC name?: str = "" optional?: bool -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCert: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- - configMap : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCertConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCertConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCertSecret, default is Undefined, optional + secret : MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCertSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCertConfigMap - secret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCertSecret + configMap?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCertConfigMap + secret?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCertSecret -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCertConfigMap: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1931,9 +2800,9 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC name?: str = "" optional?: bool -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigCertSecret: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1953,9 +2822,9 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC name?: str = "" optional?: bool -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPConfigTLSConfigKeySecret: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSClientKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -1975,91 +2844,102 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalHTTPC name?: str = "" optional?: bool -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalOpsGenieAPIKey: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSServer: r""" - The default OpsGenie API Key. + server defines the server-side configuration for mutual TLS. Attributes ---------- - key : str, default is Undefined, required - The key of the secret to select from. Must be a valid secret key. - name : str, default is Undefined, optional - 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 - optional : bool, default is Undefined, optional - Specify whether the Secret or its key must be defined - """ - key: str + cert : MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerCert, default is Undefined, optional + cert + certFile : str, default is Undefined, optional + certFile defines the path to the TLS certificate file in the container for the web server. - name?: str = "" - optional?: bool + Either `keySecret` or `keyFile` must be defined. -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalOpsGenieAPIURL: - r""" - The default OpsGenie API URL. + It is mutually exclusive with `cert`. + cipherSuites : [str], default is Undefined, optional + cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2. - Attributes - ---------- - key : str, default is Undefined, required - The key of the secret to select from. Must be a valid secret key. - name : str, default is Undefined, optional - 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 - optional : bool, default is Undefined, optional - Specify whether the Secret or its key must be defined - """ - key: str + If not defined, the Go default cipher suites are used. + Available cipher suites are documented in the Go documentation: + https://golang.org/pkg/crypto/tls/#pkg-constants + clientAuthType : str, default is Undefined, optional + clientAuthType defines the server policy for client TLS authentication. - name?: str = "" - optional?: bool + For more detail on clientAuth options: + https://golang.org/pkg/crypto/tls/#ClientAuthType + clientCAFile : str, default is Undefined, optional + clientCAFile defines the path to the CA certificate file for client certificate authentication to + the server. -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTP: + It is mutually exclusive with `client_ca`. + client_ca : MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerClientCa, default is Undefined, optional + client ca + curvePreferences : [str], default is Undefined, optional + curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference + order. + + Available curves are documented in the Go documentation: + https://golang.org/pkg/crypto/tls/#CurveID + keyFile : str, default is Undefined, optional + keyFile defines the path to the TLS private key file in the container for the web server. + + If defined, either `cert` or `certFile` must be defined. + + It is mutually exclusive with `keySecret`. + keySecret : MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerKeySecret, default is Undefined, optional + key secret + maxVersion : str, default is Undefined, optional + maxVersion defines the Maximum TLS version that is acceptable. + minVersion : str, default is Undefined, optional + minVersion defines the minimum TLS version that is acceptable. + preferServerCipherSuites : bool, default is Undefined, optional + preferServerCipherSuites defines whether the server selects the client's most preferred cipher + suite, or the server's most preferred cipher suite. + + If true then the server's preference, as expressed in + the order of elements in cipherSuites, is used. + """ + cert?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerCert + certFile?: str + cipherSuites?: [str] + clientAuthType?: str + clientCAFile?: str + client_ca?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerClientCa + curvePreferences?: [str] + keyFile?: str + keySecret?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerKeySecret + maxVersion?: str + minVersion?: str + preferServerCipherSuites?: bool + +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerCert: r""" - Configures global SMTP parameters. + cert defines the Secret or ConfigMap containing the TLS certificate for the web server. + + Either `keySecret` or `keyFile` must be defined. + + It is mutually exclusive with `certFile`. Attributes ---------- - authIdentity : str, default is Undefined, optional - SMTP Auth using PLAIN - authPassword : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPAuthPassword, default is Undefined, optional - auth password - authSecret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPAuthSecret, default is Undefined, optional - auth secret - authUsername : str, default is Undefined, optional - SMTP Auth using CRAM-MD5, LOGIN and PLAIN. If empty, Alertmanager doesn't authenticate to the SMTP server. - from : str, default is Undefined, optional - The default SMTP From header field. - hello : str, default is Undefined, optional - The default hostname to identify to the SMTP server. - requireTLS : bool, default is Undefined, optional - The default SMTP TLS requirement. - Note that Go does not support unencrypted connections to remote SMTP endpoints. - smartHost : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPSmartHost, default is Undefined, optional - smart host + configMap : MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerCertConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerCertSecret, default is Undefined, optional + secret """ - authIdentity?: str - authPassword?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPAuthPassword - authSecret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPAuthSecret - authUsername?: str - from?: str - hello?: str - requireTLS?: bool - smartHost?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPSmartHost + configMap?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerCertConfigMap + secret?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerCertSecret -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPAuthPassword: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerCertConfigMap: r""" - SMTP Auth using LOGIN and PLAIN. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- key : str, default is Undefined, required - The key of the secret to select from. Must be a valid secret key. + The key to select. name : str, default is Undefined, optional Name of the referent. This field is effectively required, but due to backwards compatibility is @@ -2067,16 +2947,16 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPA almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names optional : bool, default is Undefined, optional - Specify whether the Secret or its key must be defined + Specify whether the ConfigMap or its key must be defined """ key: str name?: str = "" optional?: bool -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPAuthSecret: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerCertSecret: r""" - SMTP Auth using CRAM-MD5. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2096,33 +2976,31 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPA name?: str = "" optional?: bool -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSMTPSmartHost: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerClientCa: r""" - The default SMTP smarthost used for sending emails. + client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate + authentication to the server. + + It is mutually exclusive with `clientCAFile`. Attributes ---------- - host : str, default is Undefined, required - Defines the host's address, it can be a DNS name or a literal IP address. - port : str, default is Undefined, required - Defines the host's port, it can be a literal port number or a port name. + configMap : MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerClientCaConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerClientCaSecret, default is Undefined, optional + secret """ - host: str - - port: str - - check: - len(host) >= 1 - len(port) >= 1 + configMap?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerClientCaConfigMap + secret?: MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerClientCaSecret -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSlackAPIURL: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerClientCaConfigMap: r""" - The default Slack API URL. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- key : str, default is Undefined, required - The key of the secret to select from. Must be a valid secret key. + The key to select. name : str, default is Undefined, optional Name of the referent. This field is effectively required, but due to backwards compatibility is @@ -2130,35 +3008,21 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationGlobalSlack almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names optional : bool, default is Undefined, optional - Specify whether the Secret or its key must be defined + Specify whether the ConfigMap or its key must be defined """ key: str name?: str = "" optional?: bool -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0: - r""" - SecretOrConfigMap allows to specify data as a Secret or ConfigMap. Fields are mutually exclusive. - - Attributes - ---------- - configMap : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0ConfigMap, default is Undefined, optional - config map - secret : MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0Secret, default is Undefined, optional - secret - """ - configMap?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0ConfigMap - secret?: MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0Secret - -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0ConfigMap: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerClientCaSecret: r""" - ConfigMap containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- key : str, default is Undefined, required - The key to select. + The key of the secret to select from. Must be a valid secret key. name : str, default is Undefined, optional Name of the referent. This field is effectively required, but due to backwards compatibility is @@ -2166,16 +3030,20 @@ schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesIt almost certainly wrong. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names optional : bool, default is Undefined, optional - Specify whether the ConfigMap or its key must be defined + Specify whether the Secret or its key must be defined """ key: str name?: str = "" optional?: bool -schema MonitoringCoreosComV1AlertmanagerSpecAlertmanagerConfigurationTemplatesItems0Secret: +schema MonitoringCoreosComV1AlertmanagerSpecClusterTLSServerKeySecret: r""" - Secret containing data to use for the targets. + keySecret defines the secret containing the TLS private key for the web server. + + Either `cert` or `certFile` must be defined. + + It is mutually exclusive with `keyFile`. Attributes ---------- @@ -2224,8 +3092,8 @@ schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0: Cannot be updated. envFrom : [MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvFromItems0], default is Undefined, optional List of sources to populate environment variables in the container. - The keys defined within a source must be a C_IDENTIFIER. All invalid keys - will be reported as an event when the container is starting. When a key exists in multiple + The keys defined within a source may consist of any printable ASCII characters except '='. + When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. @@ -2264,10 +3132,10 @@ schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0: resources restartPolicy : str, default is Undefined, optional RestartPolicy defines the restart behavior of individual containers in a pod. - This field may only be set for init containers, and the only allowed value is "Always". - For non-init containers or when this field is not specified, + This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. - Setting the RestartPolicy as "Always" for the init container will have the following effect: + Additionally, setting the RestartPolicy as "Always" for the init container will + have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" @@ -2278,6 +3146,18 @@ schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0: container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. + restartPolicyRules : [MonitoringCoreosComV1AlertmanagerSpecContainersItems0RestartPolicyRulesItems0], default is Undefined, optional + Represents a list of rules to be checked to determine if the + container should be restarted on exit. The rules are evaluated in + order. Once a rule matches a container exit condition, the remaining + rules are ignored. If no rule matches the container exit condition, + the Container-level restart policy determines the whether the container + is restarted or not. Constraints on the rules: + - At most 20 rules are allowed. + - Rules can have the same action. + - Identical rules are not forbidden in validations. + When rules are specified, container MUST set RestartPolicy explicitly + even it if matches the Pod's RestartPolicy. securityContext : MonitoringCoreosComV1AlertmanagerSpecContainersItems0SecurityContext, default is Undefined, optional security context startupProbe : MonitoringCoreosComV1AlertmanagerSpecContainersItems0StartupProbe, default is Undefined, optional @@ -2339,6 +3219,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0: resizePolicy?: [MonitoringCoreosComV1AlertmanagerSpecContainersItems0ResizePolicyItems0] resources?: MonitoringCoreosComV1AlertmanagerSpecContainersItems0Resources restartPolicy?: str + restartPolicyRules?: [MonitoringCoreosComV1AlertmanagerSpecContainersItems0RestartPolicyRulesItems0] securityContext?: MonitoringCoreosComV1AlertmanagerSpecContainersItems0SecurityContext startupProbe?: MonitoringCoreosComV1AlertmanagerSpecContainersItems0StartupProbe stdin?: bool @@ -2352,14 +3233,15 @@ schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0: schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvFromItems0: r""" - EnvFromSource represents the source of a set of ConfigMaps + EnvFromSource represents the source of a set of ConfigMaps or Secrets Attributes ---------- configMapRef : MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvFromItems0ConfigMapRef, default is Undefined, optional config map ref prefix : str, default is Undefined, optional - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + Optional text to prepend to the name of each environment variable. + May consist of any printable ASCII characters except '='. secretRef : MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvFromItems0SecretRef, default is Undefined, optional secret ref """ @@ -2410,7 +3292,8 @@ schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0: Attributes ---------- name : str, default is Undefined, required - Name of the environment variable. Must be a C_IDENTIFIER. + Name of the environment variable. + May consist of any printable ASCII characters except '='. value : str, default is Undefined, optional Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and @@ -2439,6 +3322,8 @@ schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFrom: config map key ref fieldRef : MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFromFieldRef, default is Undefined, optional field ref + fileKeyRef : MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFromFileKeyRef, default is Undefined, optional + file key ref resourceFieldRef : MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFromResourceFieldRef, default is Undefined, optional resource field ref secretKeyRef : MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFromSecretKeyRef, default is Undefined, optional @@ -2446,6 +3331,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFrom: """ configMapKeyRef?: MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFromConfigMapKeyRef fieldRef?: MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFromFieldRef + fileKeyRef?: MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFromFileKeyRef resourceFieldRef?: MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFromResourceFieldRef secretKeyRef?: MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFromSecretKeyRef @@ -2486,6 +3372,38 @@ schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFromFi apiVersion?: str fieldPath: str +schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFromFileKeyRef: + r""" + FileKeyRef selects a key of the env file. + Requires the EnvFiles feature gate to be enabled. + + Attributes + ---------- + key : str, default is Undefined, required + The key within the env file. An invalid key will prevent the pod from starting. + The keys defined within a source may consist of any printable ASCII characters except '='. + During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + optional : bool, default is Undefined, optional + Specify whether the file or its key must be defined. If the file or key + does not exist, then the env var is not published. + If optional is set to true and the specified key does not exist, + the environment variable will not be set in the Pod's containers. + + If optional is set to false and the specified key does not exist, + an error will be returned during Pod creation. + path : str, default is Undefined, required + The path within the volume from which to select the file. + Must be relative and may not contain the '..' path or start with '..'. + volumeName : str, default is Undefined, required + The name of the volume mount containing the env file. + """ + key: str + + optional?: bool = False + path: str + + volumeName: str + schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0EnvItems0ValueFromResourceFieldRef: r""" Selects a resource of the container: only resources limits and requests @@ -2540,9 +3458,14 @@ schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0Lifecycle: post start preStop : MonitoringCoreosComV1AlertmanagerSpecContainersItems0LifecyclePreStop, default is Undefined, optional pre stop + stopSignal : str, default is Undefined, optional + StopSignal defines which signal will be sent to a container when it is being stopped. + If not specified, the default is defined by the container runtime in use. + StopSignal can only be set for Pods with a non-empty .spec.os.name """ postStart?: MonitoringCoreosComV1AlertmanagerSpecContainersItems0LifecyclePostStart preStop?: MonitoringCoreosComV1AlertmanagerSpecContainersItems0LifecyclePreStop + stopSignal?: str schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0LifecyclePostStart: r""" @@ -3129,7 +4052,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0Resources: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. - This is an alpha field and requires enabling the + This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. @@ -3169,6 +4092,44 @@ schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0ResourcesClaimsItems request?: str +schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0RestartPolicyRulesItems0: + r""" + ContainerRestartRule describes how a container exit is handled. + + Attributes + ---------- + action : str, default is Undefined, required + Specifies the action taken on a container exit if the requirements + are satisfied. The only possible value is "Restart" to restart the + container. + exitCodes : MonitoringCoreosComV1AlertmanagerSpecContainersItems0RestartPolicyRulesItems0ExitCodes, default is Undefined, optional + exit codes + """ + action: str + + exitCodes?: MonitoringCoreosComV1AlertmanagerSpecContainersItems0RestartPolicyRulesItems0ExitCodes + +schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0RestartPolicyRulesItems0ExitCodes: + r""" + Represents the exit codes to check on container exits. + + Attributes + ---------- + operator : str, default is Undefined, required + Represents the relationship between the container exit code(s) and the + specified values. Possible values are: + - In: the requirement is satisfied if the container exit code is in the + set of specified values. + - NotIn: the requirement is satisfied if the container exit code is + not in the set of specified values. + values : [int], default is Undefined, optional + Specifies the set of values to check for container exit codes. + At most 255 elements are allowed. + """ + operator: str + + values?: [int] + schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0SecurityContext: r""" SecurityContext defines the security options the container should be run with. @@ -3588,20 +4549,20 @@ schema MonitoringCoreosComV1AlertmanagerSpecContainersItems0VolumeMountsItems0: schema MonitoringCoreosComV1AlertmanagerSpecDNSConfig: r""" - Defines the DNS configuration for the pods. + dnsConfig defines the DNS configuration for the pods. Attributes ---------- nameservers : [str], default is Undefined, optional - A list of DNS name server IP addresses. + nameservers defines the list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. options : [MonitoringCoreosComV1AlertmanagerSpecDNSConfigOptionsItems0], default is Undefined, optional - A list of DNS resolver options. + options defines the list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Resolution options given in Options will override those that appear in the base DNSPolicy. searches : [str], default is Undefined, optional - A list of DNS search domains for host-name lookup. + searches defines the list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. """ nameservers?: [str] @@ -3619,9 +4580,9 @@ schema MonitoringCoreosComV1AlertmanagerSpecDNSConfigOptionsItems0: Attributes ---------- name : str, default is Undefined, required - Name is required and must be unique. + name is required and must be unique. value : str, default is Undefined, optional - Value is optional. + value is optional. """ name: str @@ -3638,9 +4599,9 @@ schema MonitoringCoreosComV1AlertmanagerSpecHostAliasesItems0: Attributes ---------- hostnames : [str], default is Undefined, required - Hostnames for the above IP address. + hostnames defines hostnames for the above IP address. ip : str, default is Undefined, required - IP address of the host file entry. + ip defines the IP address of the host file entry. """ hostnames: [str] @@ -3691,8 +4652,8 @@ schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0: Cannot be updated. envFrom : [MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvFromItems0], default is Undefined, optional List of sources to populate environment variables in the container. - The keys defined within a source must be a C_IDENTIFIER. All invalid keys - will be reported as an event when the container is starting. When a key exists in multiple + The keys defined within a source may consist of any printable ASCII characters except '='. + When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. @@ -3731,10 +4692,10 @@ schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0: resources restartPolicy : str, default is Undefined, optional RestartPolicy defines the restart behavior of individual containers in a pod. - This field may only be set for init containers, and the only allowed value is "Always". - For non-init containers or when this field is not specified, + This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. - Setting the RestartPolicy as "Always" for the init container will have the following effect: + Additionally, setting the RestartPolicy as "Always" for the init container will + have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" @@ -3745,6 +4706,18 @@ schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0: container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. + restartPolicyRules : [MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0RestartPolicyRulesItems0], default is Undefined, optional + Represents a list of rules to be checked to determine if the + container should be restarted on exit. The rules are evaluated in + order. Once a rule matches a container exit condition, the remaining + rules are ignored. If no rule matches the container exit condition, + the Container-level restart policy determines the whether the container + is restarted or not. Constraints on the rules: + - At most 20 rules are allowed. + - Rules can have the same action. + - Identical rules are not forbidden in validations. + When rules are specified, container MUST set RestartPolicy explicitly + even it if matches the Pod's RestartPolicy. securityContext : MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0SecurityContext, default is Undefined, optional security context startupProbe : MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0StartupProbe, default is Undefined, optional @@ -3806,6 +4779,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0: resizePolicy?: [MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0ResizePolicyItems0] resources?: MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0Resources restartPolicy?: str + restartPolicyRules?: [MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0RestartPolicyRulesItems0] securityContext?: MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0SecurityContext startupProbe?: MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0StartupProbe stdin?: bool @@ -3819,14 +4793,15 @@ schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0: schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvFromItems0: r""" - EnvFromSource represents the source of a set of ConfigMaps + EnvFromSource represents the source of a set of ConfigMaps or Secrets Attributes ---------- configMapRef : MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvFromItems0ConfigMapRef, default is Undefined, optional config map ref prefix : str, default is Undefined, optional - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + Optional text to prepend to the name of each environment variable. + May consist of any printable ASCII characters except '='. secretRef : MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvFromItems0SecretRef, default is Undefined, optional secret ref """ @@ -3877,7 +4852,8 @@ schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0: Attributes ---------- name : str, default is Undefined, required - Name of the environment variable. Must be a C_IDENTIFIER. + Name of the environment variable. + May consist of any printable ASCII characters except '='. value : str, default is Undefined, optional Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and @@ -3906,6 +4882,8 @@ schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFr config map key ref fieldRef : MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFromFieldRef, default is Undefined, optional field ref + fileKeyRef : MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFromFileKeyRef, default is Undefined, optional + file key ref resourceFieldRef : MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFromResourceFieldRef, default is Undefined, optional resource field ref secretKeyRef : MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFromSecretKeyRef, default is Undefined, optional @@ -3913,6 +4891,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFr """ configMapKeyRef?: MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFromConfigMapKeyRef fieldRef?: MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFromFieldRef + fileKeyRef?: MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFromFileKeyRef resourceFieldRef?: MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFromResourceFieldRef secretKeyRef?: MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFromSecretKeyRef @@ -3953,6 +4932,38 @@ schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFr apiVersion?: str fieldPath: str +schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFromFileKeyRef: + r""" + FileKeyRef selects a key of the env file. + Requires the EnvFiles feature gate to be enabled. + + Attributes + ---------- + key : str, default is Undefined, required + The key within the env file. An invalid key will prevent the pod from starting. + The keys defined within a source may consist of any printable ASCII characters except '='. + During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + optional : bool, default is Undefined, optional + Specify whether the file or its key must be defined. If the file or key + does not exist, then the env var is not published. + If optional is set to true and the specified key does not exist, + the environment variable will not be set in the Pod's containers. + + If optional is set to false and the specified key does not exist, + an error will be returned during Pod creation. + path : str, default is Undefined, required + The path within the volume from which to select the file. + Must be relative and may not contain the '..' path or start with '..'. + volumeName : str, default is Undefined, required + The name of the volume mount containing the env file. + """ + key: str + + optional?: bool = False + path: str + + volumeName: str + schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0EnvItems0ValueFromResourceFieldRef: r""" Selects a resource of the container: only resources limits and requests @@ -4007,9 +5018,14 @@ schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0Lifecycle: post start preStop : MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0LifecyclePreStop, default is Undefined, optional pre stop + stopSignal : str, default is Undefined, optional + StopSignal defines which signal will be sent to a container when it is being stopped. + If not specified, the default is defined by the container runtime in use. + StopSignal can only be set for Pods with a non-empty .spec.os.name """ postStart?: MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0LifecyclePostStart preStop?: MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0LifecyclePreStop + stopSignal?: str schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0LifecyclePostStart: r""" @@ -4596,7 +5612,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0Resources: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. - This is an alpha field and requires enabling the + This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. @@ -4636,6 +5652,44 @@ schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0ResourcesClaimsI request?: str +schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0RestartPolicyRulesItems0: + r""" + ContainerRestartRule describes how a container exit is handled. + + Attributes + ---------- + action : str, default is Undefined, required + Specifies the action taken on a container exit if the requirements + are satisfied. The only possible value is "Restart" to restart the + container. + exitCodes : MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0RestartPolicyRulesItems0ExitCodes, default is Undefined, optional + exit codes + """ + action: str + + exitCodes?: MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0RestartPolicyRulesItems0ExitCodes + +schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0RestartPolicyRulesItems0ExitCodes: + r""" + Represents the exit codes to check on container exits. + + Attributes + ---------- + operator : str, default is Undefined, required + Represents the relationship between the container exit code(s) and the + specified values. Possible values are: + - In: the requirement is satisfied if the container exit code is in the + set of specified values. + - NotIn: the requirement is satisfied if the container exit code is + not in the set of specified values. + values : [int], default is Undefined, optional + Specifies the set of values to check for container exit codes. + At most 255 elements are allowed. + """ + operator: str + + values?: [int] + schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0SecurityContext: r""" SecurityContext defines the security options the container should be run with. @@ -5053,9 +6107,31 @@ schema MonitoringCoreosComV1AlertmanagerSpecInitContainersItems0VolumeMountsItem subPath?: str subPathExpr?: str +schema MonitoringCoreosComV1AlertmanagerSpecLimits: + r""" + limits defines the limits command line flags when starting Alertmanager. + + Attributes + ---------- + maxPerSilenceBytes : str, default is Undefined, optional + maxPerSilenceBytes defines the maximum size of an individual silence as stored on disk. This corresponds to the Alertmanager's + `--silences.max-per-silence-bytes` flag. + It requires Alertmanager >= v0.28.0. + maxSilences : int, default is Undefined, optional + maxSilences defines the maximum number active and pending silences. This corresponds to the + Alertmanager's `--silences.max-silences` flag. + It requires Alertmanager >= v0.28.0. + """ + maxPerSilenceBytes?: str + maxSilences?: int + + check: + _regex_match(str(maxPerSilenceBytes), r"(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$") if maxPerSilenceBytes + maxSilences >= 0 if maxSilences not in [None, Undefined] + schema MonitoringCoreosComV1AlertmanagerSpecPersistentVolumeClaimRetentionPolicy: r""" - The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet. + persistentVolumeClaimRetentionPolicy controls if and how PVCs are deleted during the lifecycle of a StatefulSet. The default behavior is all PVCs are retained. This is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26. It requires enabling the StatefulSetAutoDeletePVC feature gate. @@ -5079,7 +6155,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecPersistentVolumeClaimRetentionPolicy schema MonitoringCoreosComV1AlertmanagerSpecPodMetadata: r""" - PodMetadata configures labels and annotations which are propagated to the Alertmanager pods. + podMetadata defines labels and annotations which are propagated to the Alertmanager pods. The following items are reserved and cannot be overridden: * "alertmanager" label, set to the name of the Alertmanager instance. @@ -5092,22 +6168,22 @@ schema MonitoringCoreosComV1AlertmanagerSpecPodMetadata: Attributes ---------- annotations : {str:str}, default is Undefined, optional - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. - More info: http://kubernetes.io/docs/user-guide/annotations + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ labels : {str:str}, default is Undefined, optional - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. - More info: http://kubernetes.io/docs/user-guide/labels + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ name : str, default is Undefined, optional - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. - More info: http://kubernetes.io/docs/user-guide/identifiers#names + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/ """ annotations?: {str:str} labels?: {str:str} @@ -5115,7 +6191,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecPodMetadata: schema MonitoringCoreosComV1AlertmanagerSpecResources: r""" - Define resources requests and limits for single Pods. + resources defines the resource requests and limits of the Pods. Attributes ---------- @@ -5123,7 +6199,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecResources: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. - This is an alpha field and requires enabling the + This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. @@ -5165,7 +6241,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecResourcesClaimsItems0: schema MonitoringCoreosComV1AlertmanagerSpecSecurityContext: r""" - SecurityContext holds pod-level security attributes and common container settings. + securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext. Attributes @@ -5395,13 +6471,13 @@ schema MonitoringCoreosComV1AlertmanagerSpecSecurityContextWindowsOptions: schema MonitoringCoreosComV1AlertmanagerSpecStorage: r""" - Storage is the definition of how storage will be used by the Alertmanager + storage defines the definition of how storage will be used by the Alertmanager instances. Attributes ---------- disableMountSubPath : bool, default is Undefined, optional - Deprecated: subPath usage will be removed in a future release. + disableMountSubPath deprecated: subPath usage will be removed in a future release. emptyDir : MonitoringCoreosComV1AlertmanagerSpecStorageEmptyDir, default is Undefined, optional empty dir ephemeral : MonitoringCoreosComV1AlertmanagerSpecStorageEphemeral, default is Undefined, optional @@ -5416,7 +6492,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecStorage: schema MonitoringCoreosComV1AlertmanagerSpecStorageEmptyDir: r""" - EmptyDirVolumeSource to be used by the StatefulSet. + emptyDir to be used by the StatefulSet. If specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir @@ -5443,7 +6519,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecStorageEmptyDir: schema MonitoringCoreosComV1AlertmanagerSpecStorageEphemeral: r""" - EphemeralVolumeSource to be used by the StatefulSet. + ephemeral to be used by the StatefulSet. This is a beta field in k8s 1.21 and GA in 1.15. For lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes @@ -5518,15 +6594,13 @@ schema MonitoringCoreosComV1AlertmanagerSpecStorageEphemeralVolumeClaimTemplateS volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, - it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass - will be applied to the claim but it's not allowed to reset this field to empty string once it is set. - If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass - will be set by the persistentvolume controller if it exists. + it can be changed after the claim is created. An empty string or nil value indicates that no + VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, + this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ - (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). volumeMode : str, default is Undefined, optional volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. @@ -5686,7 +6760,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecStorageEphemeralVolumeClaimTemplateS schema MonitoringCoreosComV1AlertmanagerSpecStorageVolumeClaimTemplate: r""" - Defines the PVC spec to be used by the Prometheus StatefulSets. + volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets. The easiest way to use a volume that cannot be automatically provisioned is to use a label selector alongside manually created PersistentVolumes. @@ -5718,27 +6792,27 @@ schema MonitoringCoreosComV1AlertmanagerSpecStorageVolumeClaimTemplate: schema MonitoringCoreosComV1AlertmanagerSpecStorageVolumeClaimTemplateMetadata: r""" - EmbeddedMetadata contains metadata relevant to an EmbeddedResource. + metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource. Attributes ---------- annotations : {str:str}, default is Undefined, optional - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. - More info: http://kubernetes.io/docs/user-guide/annotations + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ labels : {str:str}, default is Undefined, optional - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. - More info: http://kubernetes.io/docs/user-guide/labels + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ name : str, default is Undefined, optional - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. - More info: http://kubernetes.io/docs/user-guide/identifiers#names + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/ """ annotations?: {str:str} labels?: {str:str} @@ -5746,7 +6820,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecStorageVolumeClaimTemplateMetadata: schema MonitoringCoreosComV1AlertmanagerSpecStorageVolumeClaimTemplateSpec: r""" - Defines the desired characteristics of a volume requested by a pod author. + spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims Attributes @@ -5769,15 +6843,13 @@ schema MonitoringCoreosComV1AlertmanagerSpecStorageVolumeClaimTemplateSpec: volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, - it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass - will be applied to the claim but it's not allowed to reset this field to empty string once it is set. - If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass - will be set by the persistentvolume controller if it exists. + it can be changed after the claim is created. An empty string or nil value indicates that no + VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, + this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ - (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). volumeMode : str, default is Undefined, optional volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. @@ -5937,7 +7009,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecStorageVolumeClaimTemplateSpecSelect schema MonitoringCoreosComV1AlertmanagerSpecStorageVolumeClaimTemplateStatus: r""" - Deprecated: this field is never set. + status is deprecated: this field is never set. Attributes ---------- @@ -6011,7 +7083,6 @@ schema MonitoringCoreosComV1AlertmanagerSpecStorageVolumeClaimTemplateStatus: currentVolumeAttributesClassName : str, default is Undefined, optional currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim - This is a beta field and requires enabling VolumeAttributesClass feature (off by default). modifyVolumeStatus : MonitoringCoreosComV1AlertmanagerSpecStorageVolumeClaimTemplateStatusModifyVolumeStatus, default is Undefined, optional modify volume status phase : str, default is Undefined, optional @@ -6066,7 +7137,6 @@ schema MonitoringCoreosComV1AlertmanagerSpecStorageVolumeClaimTemplateStatusModi r""" ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. - This is a beta field and requires enabling VolumeAttributesClass feature (off by default). Attributes ---------- @@ -6185,7 +7255,6 @@ schema MonitoringCoreosComV1AlertmanagerSpecTopologySpreadConstraintsItems0: - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. If this value is nil, the behavior is equivalent to the Honor policy. - This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. nodeTaintsPolicy : str, default is Undefined, optional NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: @@ -6194,7 +7263,6 @@ schema MonitoringCoreosComV1AlertmanagerSpecTopologySpreadConstraintsItems0: - Ignore: node taints are ignored. All nodes are included. If this value is nil, the behavior is equivalent to the Ignore policy. - This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. topologyKey : str, default is Undefined, required TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. @@ -6935,15 +8003,13 @@ schema MonitoringCoreosComV1AlertmanagerSpecVolumesItems0EphemeralVolumeClaimTem volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, - it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass - will be applied to the claim but it's not allowed to reset this field to empty string once it is set. - If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass - will be set by the persistentvolume controller if it exists. + it can be changed after the claim is created. An empty string or nil value indicates that no + VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, + this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ - (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). volumeMode : str, default is Undefined, optional volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. @@ -7255,13 +8321,11 @@ schema MonitoringCoreosComV1AlertmanagerSpecVolumesItems0Glusterfs: r""" glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. - More info: https://examples.k8s.io/volumes/glusterfs/README.md Attributes ---------- endpoints : str, default is Undefined, required endpoints is the endpoint name that details Glusterfs topology. - More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod path : str, default is Undefined, required path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod @@ -7313,7 +8377,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecVolumesItems0Image: The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). - Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath). + Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type. Attributes @@ -7339,7 +8403,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecVolumesItems0Iscsi: r""" iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. - More info: https://examples.k8s.io/volumes/iscsi/README.md + More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi Attributes ---------- @@ -7519,6 +8583,8 @@ schema MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0: config map downwardAPI : MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0DownwardAPI, default is Undefined, optional downward API + podCertificate : MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0PodCertificate, default is Undefined, optional + pod certificate secret : MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0Secret, default is Undefined, optional secret serviceAccountToken : MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0ServiceAccountToken, default is Undefined, optional @@ -7527,6 +8593,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0: clusterTrustBundle?: MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0ClusterTrustBundle configMap?: MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0ConfigMap downwardAPI?: MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0DownwardAPI + podCertificate?: MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0PodCertificate secret?: MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0Secret serviceAccountToken?: MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0ServiceAccountToken @@ -7741,6 +8808,105 @@ schema MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0D check: _regex_match(str(divisor), r"^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$") if divisor +schema MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0PodCertificate: + r""" + Projects an auto-rotating credential bundle (private key and certificate + chain) that the pod can use either as a TLS client or server. + + Kubelet generates a private key and uses it to send a + PodCertificateRequest to the named signer. Once the signer approves the + request and issues a certificate chain, Kubelet writes the key and + certificate chain to the pod filesystem. The pod does not start until + certificates have been issued for each podCertificate projected volume + source in its spec. + + Kubelet will begin trying to rotate the certificate at the time indicated + by the signer using the PodCertificateRequest.Status.BeginRefreshAt + timestamp. + + Kubelet can write a single file, indicated by the credentialBundlePath + field, or separate files, indicated by the keyPath and + certificateChainPath fields. + + The credential bundle is a single file in PEM format. The first PEM + entry is the private key (in PKCS#8 format), and the remaining PEM + entries are the certificate chain issued by the signer (typically, + signers will return their certificate chain in leaf-to-root order). + + Prefer using the credential bundle format, since your application code + can read it atomically. If you use keyPath and certificateChainPath, + your application must make two separate file reads. If these coincide + with a certificate rotation, it is possible that the private key and leaf + certificate you read may not correspond to each other. Your application + will need to check for this condition, and re-read until they are + consistent. + + The named signer controls chooses the format of the certificate it + issues; consult the signer implementation's documentation to learn how to + use the certificates it issues. + + Attributes + ---------- + certificateChainPath : str, default is Undefined, optional + Write the certificate chain at this path in the projected volume. + + Most applications should use credentialBundlePath. When using keyPath + and certificateChainPath, your application needs to check that the key + and leaf certificate are consistent, because it is possible to read the + files mid-rotation. + credentialBundlePath : str, default is Undefined, optional + Write the credential bundle at this path in the projected volume. + + The credential bundle is a single file that contains multiple PEM blocks. + The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private + key. + + The remaining blocks are CERTIFICATE blocks, containing the issued + certificate chain from the signer (leaf and any intermediates). + + Using credentialBundlePath lets your Pod's application code make a single + atomic read that retrieves a consistent key and certificate chain. If you + project them to separate files, your application code will need to + additionally check that the leaf certificate was issued to the key. + keyPath : str, default is Undefined, optional + Write the key at this path in the projected volume. + + Most applications should use credentialBundlePath. When using keyPath + and certificateChainPath, your application needs to check that the key + and leaf certificate are consistent, because it is possible to read the + files mid-rotation. + keyType : str, default is Undefined, required + The type of keypair Kubelet will generate for the pod. + + Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", + "ECDSAP521", and "ED25519". + maxExpirationSeconds : int, default is Undefined, optional + maxExpirationSeconds is the maximum lifetime permitted for the + certificate. + + Kubelet copies this value verbatim into the PodCertificateRequests it + generates for this projection. + + If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver + will reject values shorter than 3600 (1 hour). The maximum allowable + value is 7862400 (91 days). + + The signer implementation is then free to issue a certificate with any + lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600 + seconds (1 hour). This constraint is enforced by kube-apiserver. + `kubernetes.io` signers will never issue certificates with a lifetime + longer than 24 hours. + signerName : str, default is Undefined, required + Kubelet's generated CSRs will be addressed to this signer. + """ + certificateChainPath?: str + credentialBundlePath?: str + keyPath?: str + keyType: str + + maxExpirationSeconds?: int + signerName: str + schema MonitoringCoreosComV1AlertmanagerSpecVolumesItems0ProjectedSourcesItems0Secret: r""" secret information about the secret data to project @@ -7858,7 +9024,6 @@ schema MonitoringCoreosComV1AlertmanagerSpecVolumesItems0Rbd: r""" rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. - More info: https://examples.k8s.io/volumes/rbd/README.md Attributes ---------- @@ -8120,17 +9285,17 @@ schema MonitoringCoreosComV1AlertmanagerSpecVolumesItems0VsphereVolume: schema MonitoringCoreosComV1AlertmanagerSpecWeb: r""" - Defines the web command line flags when starting Alertmanager. + web defines the web command line flags when starting Alertmanager. Attributes ---------- getConcurrency : int, default is Undefined, optional - Maximum number of GET requests processed concurrently. This corresponds to the + getConcurrency defines the maximum number of GET requests processed concurrently. This corresponds to the Alertmanager's `--web.get-concurrency` flag. httpConfig : MonitoringCoreosComV1AlertmanagerSpecWebHTTPConfig, default is Undefined, optional http config timeout : int, default is Undefined, optional - Timeout for HTTP requests. This corresponds to the Alertmanager's + timeout for HTTP requests. This corresponds to the Alertmanager's `--web.timeout` flag. tlsConfig : MonitoringCoreosComV1AlertmanagerSpecWebTLSConfig, default is Undefined, optional tls config @@ -8142,14 +9307,14 @@ schema MonitoringCoreosComV1AlertmanagerSpecWeb: schema MonitoringCoreosComV1AlertmanagerSpecWebHTTPConfig: r""" - Defines HTTP parameters for web server. + httpConfig defines HTTP parameters for web server. Attributes ---------- headers : MonitoringCoreosComV1AlertmanagerSpecWebHTTPConfigHeaders, default is Undefined, optional headers http2 : bool, default is Undefined, optional - Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. + http2 enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. When TLSConfig is not configured, HTTP/2 will be disabled. Whenever the value of the field changes, a rolling update will be triggered. """ @@ -8158,30 +9323,30 @@ schema MonitoringCoreosComV1AlertmanagerSpecWebHTTPConfig: schema MonitoringCoreosComV1AlertmanagerSpecWebHTTPConfigHeaders: r""" - List of headers that can be added to HTTP responses. + headers defines a list of headers that can be added to HTTP responses. Attributes ---------- contentSecurityPolicy : str, default is Undefined, optional - Set the Content-Security-Policy header to HTTP responses. + contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank. strictTransportSecurity : str, default is Undefined, optional - Set the Strict-Transport-Security header to HTTP responses. + strictTransportSecurity defines the Strict-Transport-Security header to HTTP responses. Unset if blank. Please make sure that you use this with care as this header might force browsers to load Prometheus and the other applications hosted on the same domain and subdomains over HTTPS. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security xContentTypeOptions : str, default is Undefined, optional - Set the X-Content-Type-Options header to HTTP responses. + xContentTypeOptions defines the X-Content-Type-Options header to HTTP responses. Unset if blank. Accepted value is nosniff. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options xFrameOptions : str, default is Undefined, optional - Set the X-Frame-Options header to HTTP responses. + xFrameOptions defines the X-Frame-Options header to HTTP responses. Unset if blank. Accepted values are deny and sameorigin. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options xXSSProtection : str, default is Undefined, optional - Set the X-XSS-Protection header to all responses. + xXSSProtection defines the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection """ @@ -8193,44 +9358,44 @@ schema MonitoringCoreosComV1AlertmanagerSpecWebHTTPConfigHeaders: schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfig: r""" - Defines the TLS parameters for HTTPS. + tlsConfig defines the TLS parameters for HTTPS. Attributes ---------- cert : MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the TLS certificate file in the container for the web server. + certFile defines the path to the TLS certificate file in the container for the web server. Either `keySecret` or `keyFile` must be defined. It is mutually exclusive with `cert`. cipherSuites : [str], default is Undefined, optional - List of supported cipher suites for TLS versions up to TLS 1.2. + cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2. If not defined, the Go default cipher suites are used. Available cipher suites are documented in the Go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants clientAuthType : str, default is Undefined, optional - The server policy for client TLS authentication. + clientAuthType defines the server policy for client TLS authentication. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType clientCAFile : str, default is Undefined, optional - Path to the CA certificate file for client certificate authentication to + clientCAFile defines the path to the CA certificate file for client certificate authentication to the server. It is mutually exclusive with `client_ca`. client_ca : MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigClientCa, default is Undefined, optional client ca curvePreferences : [str], default is Undefined, optional - Elliptic curves that will be used in an ECDHE handshake, in preference + curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the Go documentation: https://golang.org/pkg/crypto/tls/#CurveID keyFile : str, default is Undefined, optional - Path to the TLS private key file in the container for the web server. + keyFile defines the path to the TLS private key file in the container for the web server. If defined, either `cert` or `certFile` must be defined. @@ -8238,11 +9403,11 @@ schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfig: keySecret : MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum TLS version that is acceptable. + maxVersion defines the Maximum TLS version that is acceptable. minVersion : str, default is Undefined, optional - Minimum TLS version that is acceptable. + minVersion defines the minimum TLS version that is acceptable. preferServerCipherSuites : bool, default is Undefined, optional - Controls whether the server selects the client's most preferred cipher + preferServerCipherSuites defines whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in @@ -8263,7 +9428,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfig: schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigCert: r""" - Secret or ConfigMap containing the TLS certificate for the web server. + cert defines the Secret or ConfigMap containing the TLS certificate for the web server. Either `keySecret` or `keyFile` must be defined. @@ -8281,7 +9446,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigCert: schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8303,7 +9468,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigCertConfigMap: schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8325,7 +9490,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigCertSecret: schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigClientCa: r""" - Secret or ConfigMap containing the CA certificate for client certificate + client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server. It is mutually exclusive with `clientCAFile`. @@ -8342,7 +9507,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigClientCa: schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigClientCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8364,7 +9529,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigClientCaConfigMap: schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigClientCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8386,7 +9551,7 @@ schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigClientCaSecret: schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigKeySecret: r""" - Secret containing the TLS private key for the web server. + keySecret defines the secret containing the TLS private key for the web server. Either `cert` or `certFile` must be defined. @@ -8412,42 +9577,38 @@ schema MonitoringCoreosComV1AlertmanagerSpecWebTLSConfigKeySecret: schema MonitoringCoreosComV1AlertmanagerStatus: r""" - Most recent observed status of the Alertmanager cluster. Read-only. + status defines the most recent observed status of the Alertmanager cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Attributes ---------- - availableReplicas : int, default is Undefined, required - Total number of available pods (ready for at least minReadySeconds) + availableReplicas : int, default is Undefined, optional + availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this Alertmanager cluster. conditions : [MonitoringCoreosComV1AlertmanagerStatusConditionsItems0], default is Undefined, optional - The current state of the Alertmanager object. - paused : bool, default is Undefined, required - Represents whether any actions on the underlying managed objects are + conditions defines the current state of the Alertmanager object. + paused : bool, default is Undefined, optional + paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed. - replicas : int, default is Undefined, required - Total number of non-terminated pods targeted by this Alertmanager + replicas : int, default is Undefined, optional + replicas defines the total number of non-terminated pods targeted by this Alertmanager object (their labels match the selector). selector : str, default is Undefined, optional - The selector used to match the pods targeted by this Alertmanager object. - unavailableReplicas : int, default is Undefined, required - Total number of unavailable pods targeted by this Alertmanager object. - updatedReplicas : int, default is Undefined, required - Total number of non-terminated pods targeted by this Alertmanager + selector used to match the pods targeted by this Alertmanager object. + unavailableReplicas : int, default is Undefined, optional + unavailableReplicas defines the total number of unavailable pods targeted by this Alertmanager object. + updatedReplicas : int, default is Undefined, optional + updatedReplicas defines the total number of non-terminated pods targeted by this Alertmanager object that have the desired version spec. """ - availableReplicas: int - + availableReplicas?: int conditions?: [MonitoringCoreosComV1AlertmanagerStatusConditionsItems0] - paused: bool - - replicas: int - + paused?: bool + replicas?: int selector?: str - unavailableReplicas: int - - updatedReplicas: int + unavailableReplicas?: int + updatedReplicas?: int schema MonitoringCoreosComV1AlertmanagerStatusConditionsItems0: r""" @@ -8459,19 +9620,19 @@ schema MonitoringCoreosComV1AlertmanagerStatusConditionsItems0: lastTransitionTime : str, default is Undefined, required lastTransitionTime is the time of the last update to the current status property. message : str, default is Undefined, optional - Human-readable message indicating details for the condition's last transition. + message defines human-readable message indicating details for the condition's last transition. observedGeneration : int, default is Undefined, optional - ObservedGeneration represents the .metadata.generation that the + observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if `.metadata.generation` is currently 12, but the `.status.conditions[].observedGeneration` is 9, the condition is out of date with respect to the current state of the instance. reason : str, default is Undefined, optional - Reason for the condition's last transition. + reason for the condition's last transition. status : str, default is Undefined, required - Status of the condition. + status of the condition. $type : str, default is Undefined, required - Type of the condition being reported. + type of the condition being reported. """ lastTransitionTime: str diff --git a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_pod_monitor.k b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_pod_monitor.k index f1952c91..a0abe8ed 100644 --- a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_pod_monitor.k +++ b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_pod_monitor.k @@ -29,6 +29,8 @@ schema PodMonitor: metadata spec : MonitoringCoreosComV1PodMonitorSpec, default is Undefined, required spec + status : MonitoringCoreosComV1PodMonitorStatus, default is Undefined, optional + status """ apiVersion: "monitoring.coreos.com/v1" = "monitoring.coreos.com/v1" @@ -37,25 +39,30 @@ schema PodMonitor: metadata?: v1.ObjectMeta spec: MonitoringCoreosComV1PodMonitorSpec + status?: MonitoringCoreosComV1PodMonitorStatus + schema MonitoringCoreosComV1PodMonitorSpec: r""" - Specification of desired Pod selection for target discovery by Prometheus. + spec defines the specification of desired Pod selection for target discovery by Prometheus. Attributes ---------- attachMetadata : MonitoringCoreosComV1PodMonitorSpecAttachMetadata, default is Undefined, optional attach metadata bodySizeLimit : str, default is Undefined, optional - When defined, bodySizeLimit specifies a job level limit on the size + bodySizeLimit when defined specifies a job level limit on the size of uncompressed response body that will be accepted by Prometheus. It requires Prometheus >= v2.28.0. + convertClassicHistogramsToNHCB : bool, default is Undefined, optional + convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. + It requires Prometheus >= v3.0.0. fallbackScrapeProtocol : str, default is Undefined, optional - The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. + fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It requires Prometheus >= v3.0.0. jobLabel : str, default is Undefined, optional - The label to use to retrieve the job name from. + jobLabel defines the label to use to retrieve the job name from. `jobLabel` selects the label from the associated Kubernetes `Pod` object which will be used as the `job` label for all metrics. @@ -66,47 +73,49 @@ schema MonitoringCoreosComV1PodMonitorSpec: If the value of this field is empty, the `job` label of the metrics defaults to the namespace and name of the PodMonitor object (e.g. `/`). keepDroppedTargets : int, default is Undefined, optional - Per-scrape limit on the number of targets dropped by relabeling + keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0. labelLimit : int, default is Undefined, optional - Per-scrape limit on number of labels that will be accepted for a sample. + labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample. It requires Prometheus >= v2.27.0. labelNameLengthLimit : int, default is Undefined, optional - Per-scrape limit on length of labels name that will be accepted for a sample. + labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. It requires Prometheus >= v2.27.0. labelValueLengthLimit : int, default is Undefined, optional - Per-scrape limit on length of labels value that will be accepted for a sample. + labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. It requires Prometheus >= v2.27.0. namespaceSelector : MonitoringCoreosComV1PodMonitorSpecNamespaceSelector, default is Undefined, optional namespace selector nativeHistogramBucketLimit : int, default is Undefined, optional - If there are more than this many buckets in a native histogram, + nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0. nativeHistogramMinBucketFactor : int | str, default is Undefined, optional - If the growth factor of one bucket to the next is smaller than this, + nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this, buckets will be merged to increase the factor sufficiently. It requires Prometheus >= v2.50.0. podMetricsEndpoints : [MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0], default is Undefined, optional - Defines how to scrape metrics from the selected pods. + podMetricsEndpoints defines how to scrape metrics from the selected pods. podTargetLabels : [str], default is Undefined, optional - `podTargetLabels` defines the labels which are transferred from the + podTargetLabels defines the labels which are transferred from the associated Kubernetes `Pod` object onto the ingested metrics. sampleLimit : int, default is Undefined, optional - `sampleLimit` defines a per-scrape limit on the number of scraped samples + sampleLimit defines a per-scrape limit on the number of scraped samples that will be accepted. scrapeClass : str, default is Undefined, optional - The scrape class to apply. + scrapeClass defines the scrape class to apply. scrapeClassicHistograms : bool, default is Undefined, optional - Whether to scrape a classic histogram that is also exposed as a native histogram. + scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0. + + Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration. scrapeProtocols : [str], default is Undefined, optional - `scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the + scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. @@ -115,18 +124,19 @@ schema MonitoringCoreosComV1PodMonitorSpec: selector : MonitoringCoreosComV1PodMonitorSpecSelector, default is Undefined, required selector selectorMechanism : str, default is Undefined, optional - Mechanism used to select the endpoints to scrape. + selectorMechanism defines the mechanism used to select the endpoints to scrape. By default, the selection process relies on relabel configurations to filter the discovered targets. Alternatively, you can opt in for role selectors, which may offer better efficiency in large clusters. Which strategy is best for your use case needs to be carefully evaluated. It requires Prometheus >= v2.17.0. targetLimit : int, default is Undefined, optional - `targetLimit` defines a limit on the number of scraped targets that will + targetLimit defines a limit on the number of scraped targets that will be accepted. """ attachMetadata?: MonitoringCoreosComV1PodMonitorSpecAttachMetadata bodySizeLimit?: str + convertClassicHistogramsToNHCB?: bool fallbackScrapeProtocol?: "PrometheusProto" | "OpenMetricsText0.0.1" | "OpenMetricsText1.0.0" | "PrometheusText0.0.4" | "PrometheusText1.0.0" jobLabel?: str keepDroppedTargets?: int @@ -154,7 +164,7 @@ schema MonitoringCoreosComV1PodMonitorSpec: schema MonitoringCoreosComV1PodMonitorSpecAttachMetadata: r""" - `attachMetadata` defines additional metadata which is added to the + attachMetadata defines additional metadata which is added to the discovered targets. It requires Prometheus >= v2.35.0. @@ -162,7 +172,7 @@ schema MonitoringCoreosComV1PodMonitorSpecAttachMetadata: Attributes ---------- node : bool, default is Undefined, optional - When set to true, Prometheus attaches node metadata to the discovered + node when set to true, Prometheus attaches node metadata to the discovered targets. The Prometheus service account must have the `list` and `watch` @@ -172,16 +182,16 @@ schema MonitoringCoreosComV1PodMonitorSpecAttachMetadata: schema MonitoringCoreosComV1PodMonitorSpecNamespaceSelector: r""" - `namespaceSelector` defines in which namespace(s) Prometheus should discover the pods. + namespaceSelector defines in which namespace(s) Prometheus should discover the pods. By default, the pods are discovered in the same namespace as the `PodMonitor` object but it is possible to select pods across different/all namespaces. Attributes ---------- any : bool, default is Undefined, optional - Boolean describing whether all namespaces are selected in contrast to a + any defines the boolean describing whether all namespaces are selected in contrast to a list restricting them. matchNames : [str], default is Undefined, optional - List of namespace names to select from. + matchNames defines the list of namespace names to select from. """ any?: bool matchNames?: [str] @@ -200,49 +210,81 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0: bearerTokenSecret : MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0BearerTokenSecret, default is Undefined, optional bearer token secret enableHttp2 : bool, default is Undefined, optional - `enableHttp2` can be used to disable HTTP2 when scraping the target. + enableHttp2 can be used to disable HTTP2. filterRunning : bool, default is Undefined, optional - When true, the pods which are not running (e.g. either in Failed or + filterRunning when true, the pods which are not running (e.g. either in Failed or Succeeded state) are dropped during the target discovery. If unset, the filtering is enabled. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase followRedirects : bool, default is Undefined, optional - `followRedirects` defines whether the scrape requests should follow HTTP - 3xx redirects. + followRedirects defines whether the client should follow HTTP 3xx + redirects. honorLabels : bool, default is Undefined, optional - When true, `honorLabels` preserves the metric's labels when they collide + honorLabels when true preserves the metric's labels when they collide with the target's labels. honorTimestamps : bool, default is Undefined, optional - `honorTimestamps` controls whether Prometheus preserves the timestamps + honorTimestamps defines whether Prometheus preserves the timestamps when exposed by the target. interval : str, default is Undefined, optional - Interval at which Prometheus scrapes the metrics from the target. + interval at which Prometheus scrapes the metrics from the target. If empty, Prometheus uses the global scrape interval. metricRelabelings : [MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0MetricRelabelingsItems0], default is Undefined, optional - `metricRelabelings` configures the relabeling rules to apply to the + metricRelabelings defines the relabeling rules to apply to the samples before ingestion. + noProxy : str, default is Undefined, optional + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names + that should be excluded from proxying. IP and domain names can + contain port numbers. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2, default is Undefined, optional oauth2 params : {str:[str]}, default is Undefined, optional - `params` define optional HTTP URL parameters. + params define optional HTTP URL parameters. path : str, default is Undefined, optional - HTTP path from which to scrape for metrics. + path defines the HTTP path from which to scrape for metrics. If empty, Prometheus uses the default value (e.g. `/metrics`). port : str, default is Undefined, optional - The `Pod` port name which exposes the endpoint. + port defines the `Pod` port name which exposes the endpoint. + + If the pod doesn't expose a port with the same name, it will result + in no targets being discovered. + + If a `Pod` has multiple `Port`s with the same name (which is not + recommended), one target instance per unique port number will be + generated. It takes precedence over the `portNumber` and `targetPort` fields. portNumber : int, default is Undefined, optional - The `Pod` port number which exposes the endpoint. + portNumber defines the `Pod` port number which exposes the endpoint. + + The `Pod` must declare the specified `Port` in its spec or the + target will be dropped by Prometheus. + + This cannot be used to enable scraping of an undeclared port. + To scrape targets on a port which isn't exposed, you need to use + relabeling to override the `__address__` label (but beware of + duplicate targets if the `Pod` has other declared ports). + + In practice Prometheus will select targets for which the + matches the target's __meta_kubernetes_pod_container_port_number. + proxyConnectHeader : {str:[MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to + proxies during CONNECT requests. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyFromEnvironment : bool, default is Undefined, optional + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` configures the HTTP Proxy URL (e.g. - "http://proxyserver:2195") to go through when scraping the target. + proxyUrl defines the HTTP proxy server to use. relabelings : [MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0RelabelingsItems0], default is Undefined, optional - `relabelings` configures the relabeling rules to apply the target's + relabelings defines the relabeling rules to apply the target's metadata labels. The Operator automatically adds relabelings for a few standard Kubernetes fields. @@ -251,27 +293,22 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0: More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config scheme : str, default is Undefined, optional - HTTP scheme to use for scraping. - - `http` and `https` are the expected values unless you rewrite the - `__scheme__` label via relabeling. - - If empty, Prometheus uses the default value `http`. + scheme defines the HTTP scheme to use for scraping. scrapeTimeout : str, default is Undefined, optional - Timeout after which Prometheus considers the scrape to be failed. + scrapeTimeout defines the timeout after which Prometheus considers the scrape to be failed. If empty, Prometheus uses the global scrape timeout unless it is less than the target's scrape interval value in which the latter is used. The value cannot be greater than the scrape interval otherwise the operator will reject the resource. targetPort : int | str, default is Undefined, optional - Name or number of the target port of the `Pod` object behind the Service, the + targetPort defines the name or number of the target port of the `Pod` object behind the Service, the port must be specified with container port property. Deprecated: use 'port' or 'portNumber' instead. tlsConfig : MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfig, default is Undefined, optional tls config trackTimestampsStaleness : bool, default is Undefined, optional - `trackTimestampsStaleness` defines whether Prometheus tracks staleness of + trackTimestampsStaleness defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if `honorTimestamps` is false. @@ -287,14 +324,17 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0: honorTimestamps?: bool interval?: str metricRelabelings?: [MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0MetricRelabelingsItems0] + noProxy?: str oauth2?: MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2 params?: {str:[str]} path?: str port?: str portNumber?: int + proxyConnectHeader?: {str:[MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0ProxyConnectHeaderItems0]} + proxyFromEnvironment?: bool proxyUrl?: str relabelings?: [MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0RelabelingsItems0] - scheme?: "http" | "https" + scheme?: "http" | "https" | "HTTP" | "HTTPS" scrapeTimeout?: str targetPort?: int | str tlsConfig?: MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfig @@ -304,21 +344,22 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0: _regex_match(str(interval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if interval portNumber <= 65535 if portNumber not in [None, Undefined] portNumber >= 1 if portNumber not in [None, Undefined] + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(scrapeTimeout), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if scrapeTimeout schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Authorization: r""" - `authorization` configures the Authorization header credentials to use when - scraping the target. + authorization configures the Authorization header credentials used by + the client. - Cannot be set at the same time as `basicAuth`, or `oauth2`. + Cannot be set at the same time as `basicAuth`, `bearerTokenSecret` or `oauth2`. Attributes ---------- credentials : MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -329,7 +370,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Authorization schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -351,10 +392,10 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Authorization schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0BasicAuth: r""" - `basicAuth` configures the Basic Authentication credentials to use when - scraping the target. + basicAuth defines the Basic Authentication credentials used by the + client. - Cannot be set at the same time as `authorization`, or `oauth2`. + Cannot be set at the same time as `authorization`, `bearerTokenSecret` or `oauth2`. Attributes ---------- @@ -368,7 +409,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0BasicAuth: schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -391,7 +432,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0BasicAuthPass schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -414,9 +455,12 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0BasicAuthUser schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0BearerTokenSecret: r""" - `bearerTokenSecret` specifies a key of a Secret containing the bearer - token for scraping targets. The secret needs to be in the same namespace - as the PodMonitor object and readable by the Prometheus Operator. + bearerTokenSecret defines a key of a Secret containing the bearer token + used by the client for authentication. The secret needs to be in the + same namespace as the custom resource and readable by the Prometheus + Operator. + + Cannot be set at the same time as `authorization`, `basicAuth` or `oauth2`. Deprecated: use `authorization` instead. @@ -448,31 +492,31 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0MetricRelabel Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -487,16 +531,13 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0MetricRelabel sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2: r""" - `oauth2` configures the OAuth2 settings to use when scraping the target. + oauth2 defines the OAuth2 settings used by the client. It requires Prometheus >= 2.27.0. - Cannot be set at the same time as `authorization`, or `basicAuth`. + Cannot be set at the same time as `authorization`, `basicAuth` or `bearerTokenSecret`. Attributes ---------- @@ -505,31 +546,31 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2: clientSecret : MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2ClientID @@ -545,12 +586,12 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -565,7 +606,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2ClientI schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -587,7 +628,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2ClientI schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -609,7 +650,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2ClientI schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -654,7 +695,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2ProxyCo schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -664,19 +705,19 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConf cert : MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConfigCert @@ -688,7 +729,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConf schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -702,7 +743,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConf schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -724,7 +765,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConf schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -746,7 +787,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConf schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -760,7 +801,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConf schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -782,7 +823,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConf schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -804,7 +845,29 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConf schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0ProxyConnectHeaderItems0: + r""" + SecretKeySelector selects a key of a Secret. Attributes ---------- @@ -834,31 +897,31 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0RelabelingsIt Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -873,12 +936,9 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0RelabelingsIt sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfig: r""" - TLS configuration to use when scraping the target. + tlsConfig defines the TLS configuration used by the client. Attributes ---------- @@ -887,19 +947,19 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfig: cert : MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCa cert?: MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCert @@ -911,7 +971,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfig: schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -925,7 +985,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCa: schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -947,7 +1007,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCaCo schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -969,7 +1029,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCaSe schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -983,7 +1043,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCert schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1005,7 +1065,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCert schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1027,7 +1087,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigCert schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -1049,7 +1109,7 @@ schema MonitoringCoreosComV1PodMonitorSpecPodMetricsEndpointsItems0TLSConfigKeyS schema MonitoringCoreosComV1PodMonitorSpecSelector: r""" - Label selector to select the Kubernetes `Pod` objects to scrape metrics from. + selector defines the label selector to select the Kubernetes `Pod` objects to scrape metrics from. Attributes ---------- @@ -1087,3 +1147,85 @@ schema MonitoringCoreosComV1PodMonitorSpecSelectorMatchExpressionsItems0: values?: [str] +schema MonitoringCoreosComV1PodMonitorStatus: + r""" + status defines the status subresource. It is under active development and is updated only when the + "StatusForConfigurationResources" feature gate is enabled. + + Most recent observed status of the PodMonitor. Read-only. + More info: + https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + + Attributes + ---------- + bindings : [MonitoringCoreosComV1PodMonitorStatusBindingsItems0], default is Undefined, optional + bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource. + """ + bindings?: [MonitoringCoreosComV1PodMonitorStatusBindingsItems0] + +schema MonitoringCoreosComV1PodMonitorStatusBindingsItems0: + r""" + WorkloadBinding is a link between a configuration resource and a workload resource. + + Attributes + ---------- + conditions : [MonitoringCoreosComV1PodMonitorStatusBindingsItems0ConditionsItems0], default is Undefined, optional + conditions defines the current state of the configuration resource when bound to the referenced Workload object. + group : str, default is Undefined, required + group defines the group of the referenced resource. + name : str, default is Undefined, required + name defines the name of the referenced object. + namespace : str, default is Undefined, required + namespace defines the namespace of the referenced object. + resource : str, default is Undefined, required + resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager). + """ + conditions?: [MonitoringCoreosComV1PodMonitorStatusBindingsItems0ConditionsItems0] + group: "monitoring.coreos.com" + + name: str + + namespace: str + + resource: "prometheuses" | "prometheusagents" | "thanosrulers" | "alertmanagers" + + check: + len(name) >= 1 + len(namespace) >= 1 + +schema MonitoringCoreosComV1PodMonitorStatusBindingsItems0ConditionsItems0: + r""" + ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler. + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, required + lastTransitionTime defines the time of the last update to the current status property. + message : str, default is Undefined, optional + message defines the human-readable message indicating details for the condition's last transition. + observedGeneration : int, default is Undefined, optional + observedGeneration defines the .metadata.generation that the + condition was set based upon. For instance, if `.metadata.generation` is + currently 12, but the `.status.conditions[].observedGeneration` is 9, the + condition is out of date with respect to the current state of the object. + reason : str, default is Undefined, optional + reason for the condition's last transition. + status : str, default is Undefined, required + status of the condition. + $type : str, default is Undefined, required + type of the condition being reported. + Currently, only "Accepted" is supported. + """ + lastTransitionTime: str + + message?: str + observedGeneration?: int + reason?: str + status: str + + $type: "Accepted" + + check: + len(status) >= 1 + len($type) >= 1 + diff --git a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_probe.k b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_probe.k index edec5454..5d5cf5d9 100644 --- a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_probe.k +++ b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_probe.k @@ -28,6 +28,8 @@ schema Probe: metadata spec : MonitoringCoreosComV1ProbeSpec, default is Undefined, required spec + status : MonitoringCoreosComV1ProbeStatus, default is Undefined, optional + status """ apiVersion: "monitoring.coreos.com/v1" = "monitoring.coreos.com/v1" @@ -36,9 +38,11 @@ schema Probe: metadata?: v1.ObjectMeta spec: MonitoringCoreosComV1ProbeSpec + status?: MonitoringCoreosComV1ProbeStatus + schema MonitoringCoreosComV1ProbeSpec: r""" - Specification of desired Ingress selection for target discovery by Prometheus. + spec defines the specification of desired Ingress selection for target discovery by Prometheus. Attributes ---------- @@ -48,67 +52,76 @@ schema MonitoringCoreosComV1ProbeSpec: basic auth bearerTokenSecret : MonitoringCoreosComV1ProbeSpecBearerTokenSecret, default is Undefined, optional bearer token secret + convertClassicHistogramsToNHCB : bool, default is Undefined, optional + convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. + It requires Prometheus >= v3.0.0. fallbackScrapeProtocol : str, default is Undefined, optional - The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. + fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It requires Prometheus >= v3.0.0. interval : str, default is Undefined, optional - Interval at which targets are probed using the configured prober. + interval at which targets are probed using the configured prober. If not specified Prometheus' global scrape interval is used. jobName : str, default is Undefined, optional - The job name assigned to scraped metrics by default. + jobName assigned to scraped metrics by default. keepDroppedTargets : int, default is Undefined, optional - Per-scrape limit on the number of targets dropped by relabeling + keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0. labelLimit : int, default is Undefined, optional - Per-scrape limit on number of labels that will be accepted for a sample. + labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. labelNameLengthLimit : int, default is Undefined, optional - Per-scrape limit on length of labels name that will be accepted for a sample. + labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. labelValueLengthLimit : int, default is Undefined, optional - Per-scrape limit on length of labels value that will be accepted for a sample. + labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. metricRelabelings : [MonitoringCoreosComV1ProbeSpecMetricRelabelingsItems0], default is Undefined, optional - MetricRelabelConfigs to apply to samples before ingestion. + metricRelabelings defines the RelabelConfig to apply to samples before ingestion. module : str, default is Undefined, optional - The module to use for probing specifying how to probe the target. + module to use for probing specifying how to probe the target. Example module configuring in the blackbox exporter: https://github.com/prometheus/blackbox_exporter/blob/master/example.yml nativeHistogramBucketLimit : int, default is Undefined, optional - If there are more than this many buckets in a native histogram, + nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0. nativeHistogramMinBucketFactor : int | str, default is Undefined, optional - If the growth factor of one bucket to the next is smaller than this, + nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this, buckets will be merged to increase the factor sufficiently. It requires Prometheus >= v2.50.0. oauth2 : MonitoringCoreosComV1ProbeSpecOauth2, default is Undefined, optional oauth2 + params : [MonitoringCoreosComV1ProbeSpecParamsItems0], default is Undefined, optional + params defines the list of HTTP query parameters for the scrape. + Please note that the `.spec.module` field takes precedence over the `module` parameter from this list when both are defined. + The module name must be added using Module under ProbeSpec. prober : MonitoringCoreosComV1ProbeSpecProber, default is Undefined, optional prober sampleLimit : int, default is Undefined, optional - SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. + sampleLimit defines per-scrape limit on number of scraped samples that will be accepted. scrapeClass : str, default is Undefined, optional - The scrape class to apply. + scrapeClass defines the scrape class to apply. scrapeClassicHistograms : bool, default is Undefined, optional - Whether to scrape a classic histogram that is also exposed as a native histogram. + scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0. + + Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration. scrapeProtocols : [str], default is Undefined, optional - `scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the + scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. It requires Prometheus >= v2.49.0. scrapeTimeout : str, default is Undefined, optional - Timeout for scraping metrics from the Prometheus exporter. + scrapeTimeout defines the timeout for scraping metrics from the Prometheus exporter. If not specified, the Prometheus global scrape timeout is used. The value cannot be greater than the scrape interval otherwise the operator will reject the resource. targetLimit : int, default is Undefined, optional - TargetLimit defines a limit on the number of scraped targets that will be accepted. + targetLimit defines a limit on the number of scraped targets that will be accepted. targets : MonitoringCoreosComV1ProbeSpecTargets, default is Undefined, optional targets tlsConfig : MonitoringCoreosComV1ProbeSpecTLSConfig, default is Undefined, optional @@ -117,6 +130,7 @@ schema MonitoringCoreosComV1ProbeSpec: authorization?: MonitoringCoreosComV1ProbeSpecAuthorization basicAuth?: MonitoringCoreosComV1ProbeSpecBasicAuth bearerTokenSecret?: MonitoringCoreosComV1ProbeSpecBearerTokenSecret + convertClassicHistogramsToNHCB?: bool fallbackScrapeProtocol?: "PrometheusProto" | "OpenMetricsText0.0.1" | "OpenMetricsText1.0.0" | "PrometheusText0.0.4" | "PrometheusText1.0.0" interval?: str jobName?: str @@ -129,6 +143,7 @@ schema MonitoringCoreosComV1ProbeSpec: nativeHistogramBucketLimit?: int nativeHistogramMinBucketFactor?: int | str oauth2?: MonitoringCoreosComV1ProbeSpecOauth2 + params?: [MonitoringCoreosComV1ProbeSpecParamsItems0] prober?: MonitoringCoreosComV1ProbeSpecProber sampleLimit?: int scrapeClass?: str @@ -142,19 +157,20 @@ schema MonitoringCoreosComV1ProbeSpec: check: _regex_match(str(interval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if interval _regex_match(str(nativeHistogramMinBucketFactor), r"^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$") if nativeHistogramMinBucketFactor + len(params) >= 1 if params len(scrapeClass) >= 1 if scrapeClass _regex_match(str(scrapeTimeout), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if scrapeTimeout schema MonitoringCoreosComV1ProbeSpecAuthorization: r""" - Authorization section for this endpoint + authorization section for this endpoint Attributes ---------- credentials : MonitoringCoreosComV1ProbeSpecAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -165,7 +181,7 @@ schema MonitoringCoreosComV1ProbeSpecAuthorization: schema MonitoringCoreosComV1ProbeSpecAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -187,7 +203,7 @@ schema MonitoringCoreosComV1ProbeSpecAuthorizationCredentials: schema MonitoringCoreosComV1ProbeSpecBasicAuth: r""" - BasicAuth allow an endpoint to authenticate over basic authentication. + basicAuth allow an endpoint to authenticate over basic authentication. More info: https://prometheus.io/docs/operating/configuration/#endpoint Attributes @@ -202,7 +218,7 @@ schema MonitoringCoreosComV1ProbeSpecBasicAuth: schema MonitoringCoreosComV1ProbeSpecBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -225,7 +241,7 @@ schema MonitoringCoreosComV1ProbeSpecBasicAuthPassword: schema MonitoringCoreosComV1ProbeSpecBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -248,7 +264,7 @@ schema MonitoringCoreosComV1ProbeSpecBasicAuthUsername: schema MonitoringCoreosComV1ProbeSpecBearerTokenSecret: r""" - Secret to mount to read bearer token for scraping targets. The secret + bearerTokenSecret defines the secret to mount to read bearer token for scraping targets. The secret needs to be in the same namespace as the probe and accessible by the Prometheus Operator. @@ -280,31 +296,31 @@ schema MonitoringCoreosComV1ProbeSpecMetricRelabelingsItems0: Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -319,12 +335,9 @@ schema MonitoringCoreosComV1ProbeSpecMetricRelabelingsItems0: sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1ProbeSpecOauth2: r""" - OAuth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. + oauth2 for the URL. Only valid in Prometheus versions 2.27.0 and newer. Attributes ---------- @@ -333,31 +346,31 @@ schema MonitoringCoreosComV1ProbeSpecOauth2: clientSecret : MonitoringCoreosComV1ProbeSpecOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1ProbeSpecOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1ProbeSpecOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1ProbeSpecOauth2ClientID @@ -373,12 +386,12 @@ schema MonitoringCoreosComV1ProbeSpecOauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1ProbeSpecOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -393,7 +406,7 @@ schema MonitoringCoreosComV1ProbeSpecOauth2ClientID: schema MonitoringCoreosComV1ProbeSpecOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -415,7 +428,7 @@ schema MonitoringCoreosComV1ProbeSpecOauth2ClientIDConfigMap: schema MonitoringCoreosComV1ProbeSpecOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -437,7 +450,7 @@ schema MonitoringCoreosComV1ProbeSpecOauth2ClientIDSecret: schema MonitoringCoreosComV1ProbeSpecOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -482,7 +495,7 @@ schema MonitoringCoreosComV1ProbeSpecOauth2ProxyConnectHeaderItems0: schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -492,19 +505,19 @@ schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfig: cert : MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1ProbeSpecOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCa cert?: MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCert @@ -516,7 +529,7 @@ schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfig: schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -530,7 +543,7 @@ schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCa: schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -552,7 +565,7 @@ schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCaConfigMap: schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -574,7 +587,7 @@ schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCaSecret: schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -588,7 +601,7 @@ schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCert: schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -610,7 +623,7 @@ schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCertConfigMap: schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -632,7 +645,7 @@ schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigCertSecret: schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -652,33 +665,99 @@ schema MonitoringCoreosComV1ProbeSpecOauth2TLSConfigKeySecret: name?: str = "" optional?: bool +schema MonitoringCoreosComV1ProbeSpecParamsItems0: + r""" + ProbeParam defines specification of extra parameters for a Probe. + + Attributes + ---------- + name : str, default is Undefined, required + name defines the parameter name + values : [str], default is Undefined, optional + values defines the parameter values + """ + name: str + + values?: [str] + + check: + len(name) >= 1 + len(values) >= 1 if values + all values in values {len(values) >= 1 if values not in [None, Undefined]} if values + schema MonitoringCoreosComV1ProbeSpecProber: r""" - Specification for the prober to use for probing targets. + prober defines the specification for the prober to use for probing targets. The prober.URL parameter is required. Targets cannot be probed if left empty. Attributes ---------- + noProxy : str, default is Undefined, optional + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names + that should be excluded from proxying. IP and domain names can + contain port numbers. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. path : str, default is "/probe", optional - Path to collect metrics from. + path to collect metrics from. Defaults to `/probe`. + proxyConnectHeader : {str:[MonitoringCoreosComV1ProbeSpecProberProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to + proxies during CONNECT requests. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyFromEnvironment : bool, default is Undefined, optional + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - Optional ProxyURL. + proxyUrl defines the HTTP proxy server to use. scheme : str, default is Undefined, optional - HTTP scheme to use for scraping. - `http` and `https` are the expected values unless you rewrite the `__scheme__` label via relabeling. - If empty, Prometheus uses the default value `http`. + scheme defines the HTTP scheme to use when scraping the prober. url : str, default is Undefined, required - Mandatory URL of the prober. + url defines the address of the prober. + + Unlike what the name indicates, the value should be in the form of + `address:port` without any scheme which should be specified in the + `scheme` field. """ + noProxy?: str path?: str = "/probe" + proxyConnectHeader?: {str:[MonitoringCoreosComV1ProbeSpecProberProxyConnectHeaderItems0]} + proxyFromEnvironment?: bool proxyUrl?: str - scheme?: "http" | "https" + scheme?: "http" | "https" | "HTTP" | "HTTPS" url: str + check: + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl + len(url) >= 1 + +schema MonitoringCoreosComV1ProbeSpecProberProxyConnectHeaderItems0: + r""" + SecretKeySelector selects a key of a Secret. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + schema MonitoringCoreosComV1ProbeSpecTLSConfig: r""" - TLS configuration to use when scraping the endpoint. + tlsConfig defines the TLS configuration to use when scraping the endpoint. Attributes ---------- @@ -687,19 +766,19 @@ schema MonitoringCoreosComV1ProbeSpecTLSConfig: cert : MonitoringCoreosComV1ProbeSpecTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1ProbeSpecTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1ProbeSpecTLSConfigCa cert?: MonitoringCoreosComV1ProbeSpecTLSConfigCert @@ -711,7 +790,7 @@ schema MonitoringCoreosComV1ProbeSpecTLSConfig: schema MonitoringCoreosComV1ProbeSpecTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -725,7 +804,7 @@ schema MonitoringCoreosComV1ProbeSpecTLSConfigCa: schema MonitoringCoreosComV1ProbeSpecTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -747,7 +826,7 @@ schema MonitoringCoreosComV1ProbeSpecTLSConfigCaConfigMap: schema MonitoringCoreosComV1ProbeSpecTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -769,7 +848,7 @@ schema MonitoringCoreosComV1ProbeSpecTLSConfigCaSecret: schema MonitoringCoreosComV1ProbeSpecTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -783,7 +862,7 @@ schema MonitoringCoreosComV1ProbeSpecTLSConfigCert: schema MonitoringCoreosComV1ProbeSpecTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -805,7 +884,7 @@ schema MonitoringCoreosComV1ProbeSpecTLSConfigCertConfigMap: schema MonitoringCoreosComV1ProbeSpecTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -827,7 +906,7 @@ schema MonitoringCoreosComV1ProbeSpecTLSConfigCertSecret: schema MonitoringCoreosComV1ProbeSpecTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -849,7 +928,7 @@ schema MonitoringCoreosComV1ProbeSpecTLSConfigKeySecret: schema MonitoringCoreosComV1ProbeSpecTargets: r""" - Targets defines a set of static or dynamically discovered targets to probe. + targets defines a set of static or dynamically discovered targets to probe. Attributes ---------- @@ -872,7 +951,7 @@ schema MonitoringCoreosComV1ProbeSpecTargetsIngress: namespaceSelector : MonitoringCoreosComV1ProbeSpecTargetsIngressNamespaceSelector, default is Undefined, optional namespace selector relabelingConfigs : [MonitoringCoreosComV1ProbeSpecTargetsIngressRelabelingConfigsItems0], default is Undefined, optional - RelabelConfigs to apply to the label set of the target before it gets + relabelingConfigs to apply to the label set of the target before it gets scraped. The original ingress address is available via the `__tmp_prometheus_ingress_address` label. It can be used to customize the @@ -888,15 +967,15 @@ schema MonitoringCoreosComV1ProbeSpecTargetsIngress: schema MonitoringCoreosComV1ProbeSpecTargetsIngressNamespaceSelector: r""" - From which namespaces to select Ingress objects. + namespaceSelector defines from which namespaces to select Ingress objects. Attributes ---------- any : bool, default is Undefined, optional - Boolean describing whether all namespaces are selected in contrast to a + any defines the boolean describing whether all namespaces are selected in contrast to a list restricting them. matchNames : [str], default is Undefined, optional - List of namespace names to select from. + matchNames defines the list of namespace names to select from. """ any?: bool matchNames?: [str] @@ -911,31 +990,31 @@ schema MonitoringCoreosComV1ProbeSpecTargetsIngressRelabelingConfigsItems0: Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -950,12 +1029,9 @@ schema MonitoringCoreosComV1ProbeSpecTargetsIngressRelabelingConfigsItems0: sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1ProbeSpecTargetsIngressSelector: r""" - Selector to select the Ingress objects. + selector to select the Ingress objects. Attributes ---------- @@ -1003,13 +1079,13 @@ schema MonitoringCoreosComV1ProbeSpecTargetsStaticConfig: Attributes ---------- labels : {str:str}, default is Undefined, optional - Labels assigned to all metrics scraped from the targets. + labels defines all labels assigned to all metrics scraped from the targets. relabelingConfigs : [MonitoringCoreosComV1ProbeSpecTargetsStaticConfigRelabelingConfigsItems0], default is Undefined, optional - RelabelConfigs to apply to the label set of the targets before it gets + relabelingConfigs defines relabelings to be apply to the label set of the targets before it gets scraped. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config static : [str], default is Undefined, optional - The list of hosts to probe. + static defines the list of hosts to probe. """ labels?: {str:str} relabelingConfigs?: [MonitoringCoreosComV1ProbeSpecTargetsStaticConfigRelabelingConfigsItems0] @@ -1025,31 +1101,31 @@ schema MonitoringCoreosComV1ProbeSpecTargetsStaticConfigRelabelingConfigsItems0: Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -1064,6 +1140,85 @@ schema MonitoringCoreosComV1ProbeSpecTargetsStaticConfigRelabelingConfigsItems0: sourceLabels?: [str] targetLabel?: str +schema MonitoringCoreosComV1ProbeStatus: + r""" + status defines the status subresource. It is under active development and is updated only when the + "StatusForConfigurationResources" feature gate is enabled. + + Most recent observed status of the Probe. Read-only. + More info: + https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + + Attributes + ---------- + bindings : [MonitoringCoreosComV1ProbeStatusBindingsItems0], default is Undefined, optional + bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource. + """ + bindings?: [MonitoringCoreosComV1ProbeStatusBindingsItems0] + +schema MonitoringCoreosComV1ProbeStatusBindingsItems0: + r""" + WorkloadBinding is a link between a configuration resource and a workload resource. + + Attributes + ---------- + conditions : [MonitoringCoreosComV1ProbeStatusBindingsItems0ConditionsItems0], default is Undefined, optional + conditions defines the current state of the configuration resource when bound to the referenced Workload object. + group : str, default is Undefined, required + group defines the group of the referenced resource. + name : str, default is Undefined, required + name defines the name of the referenced object. + namespace : str, default is Undefined, required + namespace defines the namespace of the referenced object. + resource : str, default is Undefined, required + resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager). + """ + conditions?: [MonitoringCoreosComV1ProbeStatusBindingsItems0ConditionsItems0] + group: "monitoring.coreos.com" + + name: str + + namespace: str + + resource: "prometheuses" | "prometheusagents" | "thanosrulers" | "alertmanagers" + + check: + len(name) >= 1 + len(namespace) >= 1 + +schema MonitoringCoreosComV1ProbeStatusBindingsItems0ConditionsItems0: + r""" + ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler. + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, required + lastTransitionTime defines the time of the last update to the current status property. + message : str, default is Undefined, optional + message defines the human-readable message indicating details for the condition's last transition. + observedGeneration : int, default is Undefined, optional + observedGeneration defines the .metadata.generation that the + condition was set based upon. For instance, if `.metadata.generation` is + currently 12, but the `.status.conditions[].observedGeneration` is 9, the + condition is out of date with respect to the current state of the object. + reason : str, default is Undefined, optional + reason for the condition's last transition. + status : str, default is Undefined, required + status of the condition. + $type : str, default is Undefined, required + type of the condition being reported. + Currently, only "Accepted" is supported. + """ + lastTransitionTime: str + + message?: str + observedGeneration?: int + reason?: str + status: str + + $type: "Accepted" + check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels + len(status) >= 1 + len($type) >= 1 diff --git a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_prometheus.k b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_prometheus.k index fb74aa5b..484476a9 100644 --- a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_prometheus.k +++ b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_prometheus.k @@ -42,7 +42,7 @@ schema Prometheus: schema MonitoringCoreosComV1PrometheusSpec: r""" - Specification of the desired behavior of the Prometheus cluster. More info: + spec defines the specification of the desired behavior of the Prometheus cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Attributes @@ -52,7 +52,7 @@ schema MonitoringCoreosComV1PrometheusSpec: additionalAlertRelabelConfigs : MonitoringCoreosComV1PrometheusSpecAdditionalAlertRelabelConfigs, default is Undefined, optional additional alert relabel configs additionalArgs : [MonitoringCoreosComV1PrometheusSpecAdditionalArgsItems0], default is Undefined, optional - AdditionalArgs allows setting additional arguments for the 'prometheus' container. + additionalArgs allows setting additional arguments for the 'prometheus' container. It is intended for e.g. activating hidden flags which are not supported by the dedicated configuration options yet. The arguments are passed as-is to the @@ -69,7 +69,7 @@ schema MonitoringCoreosComV1PrometheusSpec: alerting : MonitoringCoreosComV1PrometheusSpecAlerting, default is Undefined, optional alerting allowOverlappingBlocks : bool, default is Undefined, optional - AllowOverlappingBlocks enables vertical compaction and vertical query + allowOverlappingBlocks enables vertical compaction and vertical query merge in Prometheus. Deprecated: this flag has no effect for Prometheus >= 2.39.0 where overlapping blocks are enabled by default. @@ -78,26 +78,26 @@ schema MonitoringCoreosComV1PrometheusSpec: arbitraryFSAccessThroughSMs : MonitoringCoreosComV1PrometheusSpecArbitraryFSAccessThroughSMs, default is Undefined, optional arbitrary f s access through s ms automountServiceAccountToken : bool, default is Undefined, optional - AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod. + automountServiceAccountToken defines whether a service account token should be automatically mounted in the pod. If the field isn't set, the operator mounts the service account token by default. **Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery. It is possible to use strategic merge patch to project the service account token into the 'prometheus' container. baseImage : str, default is Undefined, optional - Deprecated: use 'spec.image' instead. + baseImage is deprecated: use 'spec.image' instead. bodySizeLimit : str, default is Undefined, optional - BodySizeLimit defines per-scrape on response body size. + bodySizeLimit defines per-scrape on response body size. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit. configMaps : [str], default is Undefined, optional - ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus + configMaps defines a list of ConfigMaps in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each ConfigMap is added to the StatefulSet definition as a volume named `configmap-`. The ConfigMaps are mounted into /etc/prometheus/configmaps/ in the 'prometheus' container. containers : [MonitoringCoreosComV1PrometheusSpecContainersItems0], default is Undefined, optional - Containers allows injecting additional containers or modifying operator + containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to the Pods or to change the behavior of an operator generated container. Containers described here modify an operator generated @@ -112,16 +112,21 @@ schema MonitoringCoreosComV1PrometheusSpec: Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. + convertClassicHistogramsToNHCB : bool, default is Undefined, optional + convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native + histogram with custom buckets. + + It requires Prometheus >= v3.4.0. disableCompaction : bool, default is Undefined, optional - When true, the Prometheus compaction is disabled. + disableCompaction when true, the Prometheus compaction is disabled. When `spec.thanos.objectStorageConfig` or `spec.objectStorageConfigFile` are defined, the operator automatically disables block compaction to avoid race conditions during block uploads (as the Thanos documentation recommends). dnsConfig : MonitoringCoreosComV1PrometheusSpecDNSConfig, default is Undefined, optional dns config dnsPolicy : str, default is Undefined, optional - Defines the DNS policy for the pods. + dnsPolicy defines the DNS policy for the pods. enableAdminAPI : bool, default is Undefined, optional - Enables access to the Prometheus web admin API. + enableAdminAPI defines access to the Prometheus web admin API. WARNING: Enabling the admin APIs enables mutating endpoints, to delete data, shutdown Prometheus, and more. Enabling this should be done with care and the @@ -131,7 +136,7 @@ schema MonitoringCoreosComV1PrometheusSpec: For more information: https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis enableFeatures : [str], default is Undefined, optional - Enable access to Prometheus feature flags. By default, no features are enabled. + enableFeatures enables access to Prometheus feature flags. By default, no features are enabled. Enabling features which are disabled by default is entirely outside the scope of what the maintainers will support and by doing so, you accept @@ -139,13 +144,13 @@ schema MonitoringCoreosComV1PrometheusSpec: For more information see https://prometheus.io/docs/prometheus/latest/feature_flags/ enableOTLPReceiver : bool, default is Undefined, optional - Enable Prometheus to be used as a receiver for the OTLP Metrics protocol. + enableOTLPReceiver defines the Prometheus to be used as a receiver for the OTLP Metrics protocol. Note that the OTLP receiver endpoint is automatically enabled if `.spec.otlpConfig` is defined. It requires Prometheus >= v2.47.0. enableRemoteWriteReceiver : bool, default is Undefined, optional - Enable Prometheus to be used as a receiver for the Prometheus remote + enableRemoteWriteReceiver defines the Prometheus to be used as a receiver for the Prometheus remote write protocol. WARNING: This is not considered an efficient way of ingesting samples. @@ -155,8 +160,10 @@ schema MonitoringCoreosComV1PrometheusSpec: For more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver It requires Prometheus >= v2.33.0. + enableServiceLinks : bool, default is Undefined, optional + enableServiceLinks defines whether information about services should be injected into pod's environment variables enforcedBodySizeLimit : str, default is Undefined, optional - When defined, enforcedBodySizeLimit specifies a global limit on the size + enforcedBodySizeLimit when defined specifies a global limit on the size of uncompressed response body that will be accepted by Prometheus. Targets responding with a body larger than this many bytes will cause the scrape to fail. @@ -169,7 +176,7 @@ schema MonitoringCoreosComV1PrometheusSpec: * Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value. * Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit. enforcedKeepDroppedTargets : int, default is Undefined, optional - When defined, enforcedKeepDroppedTargets specifies a global limit on the number of targets + enforcedKeepDroppedTargets when defined specifies a global limit on the number of targets dropped by relabeling that will be kept in memory. The value overrides any `spec.keepDroppedTargets` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is @@ -183,7 +190,7 @@ schema MonitoringCoreosComV1PrometheusSpec: * Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value. * Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets. enforcedLabelLimit : int, default is Undefined, optional - When defined, enforcedLabelLimit specifies a global limit on the number + enforcedLabelLimit when defined specifies a global limit on the number of labels per sample. The value overrides any `spec.labelLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is greater than zero and less than `spec.enforcedLabelLimit`. @@ -196,7 +203,7 @@ schema MonitoringCoreosComV1PrometheusSpec: * Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value. * Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit. enforcedLabelNameLengthLimit : int, default is Undefined, optional - When defined, enforcedLabelNameLengthLimit specifies a global limit on the length + enforcedLabelNameLengthLimit when defined specifies a global limit on the length of labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is greater than zero and less than `spec.enforcedLabelNameLengthLimit`. @@ -209,7 +216,7 @@ schema MonitoringCoreosComV1PrometheusSpec: * Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value. * Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit. enforcedLabelValueLengthLimit : int, default is Undefined, optional - When not null, enforcedLabelValueLengthLimit defines a global limit on the length + enforcedLabelValueLengthLimit when not null defines a global limit on the length of labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is greater than zero and less than `spec.enforcedLabelValueLengthLimit`. @@ -222,7 +229,7 @@ schema MonitoringCoreosComV1PrometheusSpec: * Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value. * Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit. enforcedNamespaceLabel : str, default is Undefined, optional - When not empty, a label will be added to: + enforcedNamespaceLabel when not empty, a label will be added to: 1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects. 2. All metrics generated from recording rules defined in `PrometheusRule` objects. @@ -235,7 +242,7 @@ schema MonitoringCoreosComV1PrometheusSpec: The label's value is the namespace of the `ServiceMonitor`, `PodMonitor`, `Probe`, `PrometheusRule` or `ScrapeConfig` object. enforcedSampleLimit : int, default is Undefined, optional - When defined, enforcedSampleLimit specifies a global limit on the number + enforcedSampleLimit when defined specifies a global limit on the number of scraped samples that will be accepted. This overrides any `spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.sampleLimit` is greater than zero and less than @@ -250,7 +257,7 @@ schema MonitoringCoreosComV1PrometheusSpec: * Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value. * Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit. enforcedTargetLimit : int, default is Undefined, optional - When defined, enforcedTargetLimit specifies a global limit on the number + enforcedTargetLimit when defined specifies a global limit on the number of scraped targets. The value overrides any `spec.targetLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is greater than zero and less than `spec.enforcedTargetLimit`. @@ -264,43 +271,50 @@ schema MonitoringCoreosComV1PrometheusSpec: * Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value. * Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit. evaluationInterval : str, default is "30s", optional - Interval between rule evaluations. + evaluationInterval defines the interval between rule evaluations. Default: "30s" excludedFromEnforcement : [MonitoringCoreosComV1PrometheusSpecExcludedFromEnforcementItems0], default is Undefined, optional - List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects + excludedFromEnforcement defines the list of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects to be excluded from enforcing a namespace label of origin. It is only applicable if `spec.enforcedNamespaceLabel` set to true. exemplars : MonitoringCoreosComV1PrometheusSpecExemplars, default is Undefined, optional exemplars externalLabels : {str:str}, default is Undefined, optional - The labels to add to any time series or alerts when communicating with + externalLabels defines the labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager). Labels defined by `spec.replicaExternalLabelName` and `spec.prometheusExternalLabelName` take precedence over this list. externalUrl : str, default is Undefined, optional - The external URL under which the Prometheus service is externally + externalUrl defines the external URL under which the Prometheus service is externally available. This is necessary to generate correct URLs (for instance if Prometheus is accessible behind an Ingress resource). hostAliases : [MonitoringCoreosComV1PrometheusSpecHostAliasesItems0], default is Undefined, optional - Optional list of hosts and IPs that will be injected into the Pod's + hostAliases defines the optional list of hosts and IPs that will be injected into the Pod's hosts file if specified. hostNetwork : bool, default is Undefined, optional - Use the host's network namespace if true. + hostNetwork defines the host's network namespace if true. Make sure to understand the security implications if you want to enable - it (https://kubernetes.io/docs/concepts/configuration/overview/). + it (https://kubernetes.io/docs/concepts/configuration/overview/ ). When hostNetwork is enabled, this will set the DNS policy to `ClusterFirstWithHostNet` automatically (unless `.spec.DNSPolicy` is set to a different value). + hostUsers : bool, default is Undefined, optional + hostUsers supports the user space in Kubernetes. + + More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/ + + The feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled. + Starting Kubernetes 1.33, the feature is enabled by default. ignoreNamespaceSelectors : bool, default is Undefined, optional - When true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor + ignoreNamespaceSelectors when true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor and Probe objects will be ignored. They will only discover targets within the namespace of the PodMonitor, ServiceMonitor and Probe object. image : str, default is Undefined, optional - Container image name for Prometheus. If specified, it takes precedence + image defines the container image name for Prometheus. If specified, it takes precedence over the `spec.baseImage`, `spec.tag` and `spec.sha` fields. Specifying `spec.version` is still necessary to ensure the Prometheus @@ -310,14 +324,14 @@ schema MonitoringCoreosComV1PrometheusSpec: will use the latest upstream version of Prometheus available at the time when the operator was released. imagePullPolicy : str, default is Undefined, optional - Image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers. + imagePullPolicy defines the image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details. imagePullSecrets : [MonitoringCoreosComV1PrometheusSpecImagePullSecretsItems0], default is Undefined, optional - An optional list of references to Secrets in the same namespace + imagePullSecrets defines an optional list of references to Secrets in the same namespace to use for pulling images from registries. See http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod initContainers : [MonitoringCoreosComV1PrometheusSpecInitContainersItems0], default is Undefined, optional - InitContainers allows injecting initContainers to the Pod definition. Those + initContainers allows injecting initContainers to the Pod definition. Those can be used to e.g. fetch secrets for injection into the Prometheus configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: @@ -333,7 +347,7 @@ schema MonitoringCoreosComV1PrometheusSpec: maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. keepDroppedTargets : int, default is Undefined, optional - Per-scrape limit on the number of targets dropped by relabeling + keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0. @@ -341,58 +355,64 @@ schema MonitoringCoreosComV1PrometheusSpec: Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets. labelLimit : int, default is Undefined, optional - Per-scrape limit on number of labels that will be accepted for a sample. + labelLimit defines per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit. labelNameLengthLimit : int, default is Undefined, optional - Per-scrape limit on length of labels name that will be accepted for a sample. + labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit. labelValueLengthLimit : int, default is Undefined, optional - Per-scrape limit on length of labels value that will be accepted for a sample. + labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit. listenLocal : bool, default is Undefined, optional - When true, the Prometheus server listens on the loopback address + listenLocal when true, the Prometheus server listens on the loopback address instead of the Pod IP's address. logFormat : str, default is Undefined, optional - Log format for Log level for Prometheus and the config-reloader sidecar. + logFormat for Log level for Prometheus and the config-reloader sidecar. logLevel : str, default is Undefined, optional - Log level for Prometheus and the config-reloader sidecar. + logLevel for Prometheus and the config-reloader sidecar. maximumStartupDurationSeconds : int, default is Undefined, optional - Defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete. - If set, the value should be greater than 60 (seconds). Otherwise it will be equal to 600 seconds (15 minutes). + maximumStartupDurationSeconds defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete. + If set, the value should be greater than 60 (seconds). Otherwise it will be equal to 900 seconds (15 minutes). minReadySeconds : int, default is Undefined, optional - Minimum number of seconds for which a newly created Pod should be ready + minReadySeconds defines the minimum number of seconds for which a newly created Pod should be ready without any of its container crashing for it to be considered available. - Defaults to 0 (pod will be considered available as soon as it is ready) - This is an alpha field from kubernetes 1.22 until 1.24 which requires - enabling the StatefulSetMinReadySeconds feature gate. + If unset, pods will be considered available as soon as they are ready. + nameEscapingScheme : str, default is Undefined, optional + nameEscapingScheme defines the character escaping scheme that will be requested when scraping + for metric and label names that do not conform to the legacy Prometheus + character set. + + It requires Prometheus >= v3.4.0. nameValidationScheme : str, default is Undefined, optional - Specifies the validation scheme for metric and label names. + nameValidationScheme defines the validation scheme for metric and label names. + + It requires Prometheus >= v2.55.0. nodeSelector : {str:str}, default is Undefined, optional - Defines on which Nodes the Pods are scheduled. + nodeSelector defines on which Nodes the Pods are scheduled. otlp : MonitoringCoreosComV1PrometheusSpecOtlp, default is Undefined, optional otlp overrideHonorLabels : bool, default is Undefined, optional - When true, Prometheus resolves label conflicts by renaming the labels in the scraped data + overrideHonorLabels when true, Prometheus resolves label conflicts by renaming the labels in the scraped data to “exported_” for all targets created from ServiceMonitor, PodMonitor and ScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies. - In practice,`overrideHonorLaels:true` enforces `honorLabels:false` + In practice,`OverrideHonorLabels:true` enforces `honorLabels:false` for all ServiceMonitor, PodMonitor and ScrapeConfig objects. overrideHonorTimestamps : bool, default is Undefined, optional - When true, Prometheus ignores the timestamps for all the targets created + overrideHonorTimestamps when true, Prometheus ignores the timestamps for all the targets created from service and pod monitors. Otherwise the HonorTimestamps field of the service or pod monitor applies. paused : bool, default is Undefined, optional - When a Prometheus deployment is paused, no actions except for deletion + paused defines when a Prometheus deployment is paused, no actions except for deletion will be performed on the underlying objects. persistentVolumeClaimRetentionPolicy : MonitoringCoreosComV1PrometheusSpecPersistentVolumeClaimRetentionPolicy, default is Undefined, optional persistent volume claim retention policy @@ -403,25 +423,25 @@ schema MonitoringCoreosComV1PrometheusSpec: podMonitorSelector : MonitoringCoreosComV1PrometheusSpecPodMonitorSelector, default is Undefined, optional pod monitor selector podTargetLabels : [str], default is Undefined, optional - PodTargetLabels are appended to the `spec.podTargetLabels` field of all + podTargetLabels are appended to the `spec.podTargetLabels` field of all PodMonitor and ServiceMonitor objects. portName : str, default is "web", optional - Port name used for the pods and governing service. + portName used for the pods and governing service. Default: "web" priorityClassName : str, default is Undefined, optional - Priority class assigned to the Pods. + priorityClassName assigned to the Pods. probeNamespaceSelector : MonitoringCoreosComV1PrometheusSpecProbeNamespaceSelector, default is Undefined, optional probe namespace selector probeSelector : MonitoringCoreosComV1PrometheusSpecProbeSelector, default is Undefined, optional probe selector prometheusExternalLabelName : str, default is Undefined, optional - Name of Prometheus external label used to denote the Prometheus instance + prometheusExternalLabelName defines the name of Prometheus external label used to denote the Prometheus instance name. The external label will _not_ be added when the field is set to the empty string (`""`). Default: "prometheus" prometheusRulesExcludedFromEnforce : [MonitoringCoreosComV1PrometheusSpecPrometheusRulesExcludedFromEnforceItems0], default is Undefined, optional - Defines the list of PrometheusRule objects to which the namespace label + prometheusRulesExcludedFromEnforce defines the list of PrometheusRule objects to which the namespace label enforcement doesn't apply. This is only relevant when `spec.enforcedNamespaceLabel` is set to true. Deprecated: use `spec.excludedFromEnforcement` instead. @@ -440,25 +460,25 @@ schema MonitoringCoreosComV1PrometheusSpec: `/dev/stdout`, to log query information to the default Prometheus log stream. reloadStrategy : str, default is Undefined, optional - Defines the strategy used to reload the Prometheus configuration. + reloadStrategy defines the strategy used to reload the Prometheus configuration. If not specified, the configuration is reloaded using the /-/reload HTTP endpoint. remoteRead : [MonitoringCoreosComV1PrometheusSpecRemoteReadItems0], default is Undefined, optional - Defines the list of remote read configurations. + remoteRead defines the list of remote read configurations. remoteWrite : [MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0], default is Undefined, optional - Defines the list of remote write configurations. + remoteWrite defines the list of remote write configurations. remoteWriteReceiverMessageVersions : [str], default is Undefined, optional - List of the protobuf message versions to accept when receiving the + remoteWriteReceiverMessageVersions list of the protobuf message versions to accept when receiving the remote writes. It requires Prometheus >= v2.54.0. replicaExternalLabelName : str, default is Undefined, optional - Name of Prometheus external label used to denote the replica name. + replicaExternalLabelName defines the name of Prometheus external label used to denote the replica name. The external label will _not_ be added when the field is set to the empty string (`""`). Default: "prometheus_replica" replicas : int, default is Undefined, optional - Number of replicas of each shard to deploy for a Prometheus deployment. + replicas defines the number of replicas of each shard to deploy for a Prometheus deployment. `spec.replicas` multiplied by `spec.shards` is the total number of Pods created. @@ -466,13 +486,13 @@ schema MonitoringCoreosComV1PrometheusSpec: resources : MonitoringCoreosComV1PrometheusSpecResources, default is Undefined, optional resources retention : str, default is Undefined, optional - How long to retain the Prometheus data. + retention defines how long to retain the Prometheus data. Default: "24h" if `spec.retention` and `spec.retentionSize` are empty. retentionSize : str, default is Undefined, optional - Maximum number of bytes used by the Prometheus data. + retentionSize defines the maximum number of bytes used by the Prometheus data. routePrefix : str, default is Undefined, optional - The route prefix Prometheus registers HTTP handlers for. + routePrefix defines the route prefix Prometheus registers HTTP handlers for. This is useful when using `spec.externalURL`, and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but @@ -481,7 +501,7 @@ schema MonitoringCoreosComV1PrometheusSpec: ruleNamespaceSelector : MonitoringCoreosComV1PrometheusSpecRuleNamespaceSelector, default is Undefined, optional rule namespace selector ruleQueryOffset : str, default is Undefined, optional - Defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past. + ruleQueryOffset defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past. It requires Prometheus >= v2.53.0. ruleSelector : MonitoringCoreosComV1PrometheusSpecRuleSelector, default is Undefined, optional rule selector @@ -490,23 +510,29 @@ schema MonitoringCoreosComV1PrometheusSpec: runtime : MonitoringCoreosComV1PrometheusSpecRuntime, default is Undefined, optional runtime sampleLimit : int, default is Undefined, optional - SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. + sampleLimit defines per-scrape limit on number of scraped samples that will be accepted. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit. scrapeClasses : [MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0], default is Undefined, optional - List of scrape classes to expose to scraping objects such as + scrapeClasses defines the list of scrape classes to expose to scraping objects such as PodMonitors, ServiceMonitors, Probes and ScrapeConfigs. This is an *experimental feature*, it may change in any upcoming release in a breaking way. + scrapeClassicHistograms : bool, default is Undefined, optional + scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. + + Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration. + + It requires Prometheus >= v3.5.0. scrapeConfigNamespaceSelector : MonitoringCoreosComV1PrometheusSpecScrapeConfigNamespaceSelector, default is Undefined, optional scrape config namespace selector scrapeConfigSelector : MonitoringCoreosComV1PrometheusSpecScrapeConfigSelector, default is Undefined, optional scrape config selector scrapeFailureLogFile : str, default is Undefined, optional - File to which scrape failures are logged. + scrapeFailureLogFile defines the file to which scrape failures are logged. Reloading the configuration will reopen the file. If the filename has an empty path, e.g. 'file.log', The Prometheus Pods @@ -515,11 +541,11 @@ schema MonitoringCoreosComV1PrometheusSpec: must mount a volume in the specified directory and it must be writable. It requires Prometheus >= v2.55.0. scrapeInterval : str, default is "30s", optional - Interval between consecutive scrapes. + scrapeInterval defines interval between consecutive scrapes. Default: "30s" scrapeProtocols : [str], default is Undefined, optional - The protocols to negotiate during a scrape. It tells clients the + scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. @@ -528,20 +554,20 @@ schema MonitoringCoreosComV1PrometheusSpec: `PrometheusText1.0.0` requires Prometheus >= v3.0.0. scrapeTimeout : str, default is Undefined, optional - Number of seconds to wait until a scrape request times out. + scrapeTimeout defines the number of seconds to wait until a scrape request times out. The value cannot be greater than the scrape interval otherwise the operator will reject the resource. secrets : [str], default is Undefined, optional - Secrets is a list of Secrets in the same namespace as the Prometheus + secrets defines a list of Secrets in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each Secret is added to the StatefulSet definition as a volume named `secret-`. The Secrets are mounted into /etc/prometheus/secrets/ in the 'prometheus' container. securityContext : MonitoringCoreosComV1PrometheusSpecSecurityContext, default is Undefined, optional security context serviceAccountName : str, default is Undefined, optional - ServiceAccountName is the name of the ServiceAccount to use to run the + serviceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods. serviceDiscoveryRole : str, default is Undefined, optional - Defines the service discovery role used to discover targets from + serviceDiscoveryRole defines the service discovery role used to discover targets from `ServiceMonitor` objects and Alertmanager endpoints. If set, the value should be either "Endpoints" or "EndpointSlice". @@ -551,16 +577,18 @@ schema MonitoringCoreosComV1PrometheusSpec: serviceMonitorSelector : MonitoringCoreosComV1PrometheusSpecServiceMonitorSelector, default is Undefined, optional service monitor selector serviceName : str, default is Undefined, optional - The name of the service name used by the underlying StatefulSet(s) as the governing service. + serviceName defines the name of the service name used by the underlying StatefulSet(s) as the governing service. If defined, the Service must be created before the Prometheus/PrometheusAgent resource in the same namespace and it must define a selector that matches the pod labels. If empty, the operator will create and manage a headless service named `prometheus-operated` for Prometheus resources, or `prometheus-agent-operated` for PrometheusAgent resources. When deploying multiple Prometheus/PrometheusAgent resources in the same namespace, it is recommended to specify a different value for each. See https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details. sha : str, default is Undefined, optional - Deprecated: use 'spec.image' instead. The image's digest can be specified as part of the image name. + sha is deprecated: use 'spec.image' instead. The image's digest can be specified as part of the image name. + shardRetentionPolicy : MonitoringCoreosComV1PrometheusSpecShardRetentionPolicy, default is Undefined, optional + shard retention policy shards : int, default is Undefined, optional - Number of shards to distribute scraped targets onto. + shards defines the number of shards to distribute the scraped targets onto. `spec.replicas` multiplied by `spec.shards` is the total number of Pods being created. @@ -570,11 +598,11 @@ schema MonitoringCoreosComV1PrometheusSpec: Note that scaling down shards will not reshard data onto the remaining instances, it must be manually moved. Increasing shards will not reshard data either but it will continue to be available from the same - instances. To query globally, use Thanos sidecar and Thanos querier or - remote write data to a central location. - Alerting and recording rules + instances. To query globally, use either + * Thanos sidecar + querier for query federation and Thanos Ruler for rules. + * Remote-write to send metrics to a central location. - By default, the sharding is performed on: + By default, the sharding of targets is performed on: * The `__address__` target's metadata label for PodMonitor, ServiceMonitor and ScrapeConfig resources. * The `__param_target__` label for Probe resources. @@ -582,44 +610,54 @@ schema MonitoringCoreosComV1PrometheusSpec: Users can define their own sharding implementation by setting the `__tmp_hash` label during the target discovery with relabeling configuration (either in the monitoring resources or via scrape class). + + You can also disable sharding on a specific target by setting the + `__tmp_disable_sharding` label with relabeling configuration. When + the label value isn't empty, all Prometheus shards will scrape the target. storage : MonitoringCoreosComV1PrometheusSpecStorage, default is Undefined, optional storage tag : str, default is Undefined, optional - Deprecated: use 'spec.image' instead. The image's tag can be specified as part of the image name. + tag is deprecated: use 'spec.image' instead. The image's tag can be specified as part of the image name. targetLimit : int, default is Undefined, optional - TargetLimit defines a limit on the number of scraped targets that will be accepted. + targetLimit defines a limit on the number of scraped targets that will be accepted. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit. + terminationGracePeriodSeconds : int, default is Undefined, optional + terminationGracePeriodSeconds defines the optional duration in seconds the pod needs to terminate gracefully. + Value must be non-negative integer. The value zero indicates stop immediately via + the kill signal (no opportunity to shut down) which may lead to data corruption. + + Defaults to 600 seconds. thanos : MonitoringCoreosComV1PrometheusSpecThanos, default is Undefined, optional thanos tolerations : [MonitoringCoreosComV1PrometheusSpecTolerationsItems0], default is Undefined, optional - Defines the Pods' tolerations if specified. + tolerations defines the Pods' tolerations if specified. topologySpreadConstraints : [MonitoringCoreosComV1PrometheusSpecTopologySpreadConstraintsItems0], default is Undefined, optional - Defines the pod's topology spread constraints if specified. + topologySpreadConstraints defines the pod's topology spread constraints if specified. tracingConfig : MonitoringCoreosComV1PrometheusSpecTracingConfig, default is Undefined, optional tracing config tsdb : MonitoringCoreosComV1PrometheusSpecTsdb, default is Undefined, optional tsdb version : str, default is Undefined, optional - Version of Prometheus being deployed. The operator uses this information + version of Prometheus being deployed. The operator uses this information to generate the Prometheus StatefulSet + configuration files. If not specified, the operator assumes the latest upstream version of Prometheus available at the time when the version of the operator was released. volumeMounts : [MonitoringCoreosComV1PrometheusSpecVolumeMountsItems0], default is Undefined, optional - VolumeMounts allows the configuration of additional VolumeMounts. + volumeMounts allows the configuration of additional VolumeMounts. VolumeMounts will be appended to other VolumeMounts in the 'prometheus' container, that are generated as a result of StorageSpec objects. volumes : [MonitoringCoreosComV1PrometheusSpecVolumesItems0], default is Undefined, optional - Volumes allows the configuration of additional volumes on the output + volumes allows the configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects. walCompression : bool, default is Undefined, optional - Configures compression of the write-ahead log (WAL) using Snappy. + walCompression defines the compression of the write-ahead log (WAL) using Snappy. WAL compression is enabled by default for Prometheus >= 2.20.0 @@ -641,6 +679,7 @@ schema MonitoringCoreosComV1PrometheusSpec: bodySizeLimit?: str configMaps?: [str] containers?: [MonitoringCoreosComV1PrometheusSpecContainersItems0] + convertClassicHistogramsToNHCB?: bool disableCompaction?: bool dnsConfig?: MonitoringCoreosComV1PrometheusSpecDNSConfig dnsPolicy?: "ClusterFirstWithHostNet" | "ClusterFirst" | "Default" | "None" @@ -648,6 +687,7 @@ schema MonitoringCoreosComV1PrometheusSpec: enableFeatures?: [str] enableOTLPReceiver?: bool enableRemoteWriteReceiver?: bool + enableServiceLinks?: bool enforcedBodySizeLimit?: str enforcedKeepDroppedTargets?: int enforcedLabelLimit?: int @@ -663,6 +703,7 @@ schema MonitoringCoreosComV1PrometheusSpec: externalUrl?: str hostAliases?: [MonitoringCoreosComV1PrometheusSpecHostAliasesItems0] hostNetwork?: bool + hostUsers?: bool ignoreNamespaceSelectors?: bool image?: str imagePullPolicy?: "" | "Always" | "Never" | "IfNotPresent" @@ -677,6 +718,7 @@ schema MonitoringCoreosComV1PrometheusSpec: logLevel?: "" | "debug" | "info" | "warn" | "error" maximumStartupDurationSeconds?: int minReadySeconds?: int + nameEscapingScheme?: "AllowUTF8" | "Underscores" | "Dots" | "Values" nameValidationScheme?: "UTF8" | "Legacy" nodeSelector?: {str:str} otlp?: MonitoringCoreosComV1PrometheusSpecOtlp @@ -713,6 +755,7 @@ schema MonitoringCoreosComV1PrometheusSpec: runtime?: MonitoringCoreosComV1PrometheusSpecRuntime sampleLimit?: int scrapeClasses?: [MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0] + scrapeClassicHistograms?: bool scrapeConfigNamespaceSelector?: MonitoringCoreosComV1PrometheusSpecScrapeConfigNamespaceSelector scrapeConfigSelector?: MonitoringCoreosComV1PrometheusSpecScrapeConfigSelector scrapeFailureLogFile?: str @@ -727,10 +770,12 @@ schema MonitoringCoreosComV1PrometheusSpec: serviceMonitorSelector?: MonitoringCoreosComV1PrometheusSpecServiceMonitorSelector serviceName?: str sha?: str + shardRetentionPolicy?: MonitoringCoreosComV1PrometheusSpecShardRetentionPolicy shards?: int storage?: MonitoringCoreosComV1PrometheusSpecStorage tag?: str targetLimit?: int + terminationGracePeriodSeconds?: int thanos?: MonitoringCoreosComV1PrometheusSpecThanos tolerations?: [MonitoringCoreosComV1PrometheusSpecTolerationsItems0] topologySpreadConstraints?: [MonitoringCoreosComV1PrometheusSpecTopologySpreadConstraintsItems0] @@ -748,6 +793,7 @@ schema MonitoringCoreosComV1PrometheusSpec: _regex_match(str(enforcedBodySizeLimit), r"(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$") if enforcedBodySizeLimit _regex_match(str(evaluationInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if evaluationInterval maximumStartupDurationSeconds >= 60 if maximumStartupDurationSeconds not in [None, Undefined] + minReadySeconds >= 0 if minReadySeconds not in [None, Undefined] len(remoteWriteReceiverMessageVersions) >= 1 if remoteWriteReceiverMessageVersions _regex_match(str(retention), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if retention _regex_match(str(retentionSize), r"(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$") if retentionSize @@ -756,10 +802,11 @@ schema MonitoringCoreosComV1PrometheusSpec: _regex_match(str(scrapeInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if scrapeInterval _regex_match(str(scrapeTimeout), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if scrapeTimeout len(serviceName) >= 1 if serviceName + terminationGracePeriodSeconds >= 0 if terminationGracePeriodSeconds not in [None, Undefined] schema MonitoringCoreosComV1PrometheusSpecAdditionalAlertManagerConfigs: r""" - AdditionalAlertManagerConfigs specifies a key of a Secret containing + additionalAlertManagerConfigs defines a key of a Secret containing additional Prometheus Alertmanager configurations. The Alertmanager configurations are appended to the configuration generated by the Prometheus Operator. They must be formatted according to the official @@ -794,7 +841,7 @@ schema MonitoringCoreosComV1PrometheusSpecAdditionalAlertManagerConfigs: schema MonitoringCoreosComV1PrometheusSpecAdditionalAlertRelabelConfigs: r""" - AdditionalAlertRelabelConfigs specifies a key of a Secret containing + additionalAlertRelabelConfigs defines a key of a Secret containing additional Prometheus alert relabel configurations. The alert relabel configurations are appended to the configuration generated by the Prometheus Operator. They must be formatted according to the official @@ -834,9 +881,9 @@ schema MonitoringCoreosComV1PrometheusSpecAdditionalArgsItems0: Attributes ---------- name : str, default is Undefined, required - Name of the argument, e.g. "scrape.discovery-reload-interval". + name of the argument, e.g. "scrape.discovery-reload-interval". value : str, default is Undefined, optional - Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) + value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) """ name: str @@ -847,7 +894,7 @@ schema MonitoringCoreosComV1PrometheusSpecAdditionalArgsItems0: schema MonitoringCoreosComV1PrometheusSpecAdditionalScrapeConfigs: r""" - AdditionalScrapeConfigs allows specifying a key of a Secret containing + additionalScrapeConfigs allows specifying a key of a Secret containing additional Prometheus scrape configurations. Scrape configurations specified are appended to the configurations generated by the Prometheus Operator. Job configurations specified must have the form as specified @@ -879,7 +926,7 @@ schema MonitoringCoreosComV1PrometheusSpecAdditionalScrapeConfigs: schema MonitoringCoreosComV1PrometheusSpecAffinity: r""" - Defines the Pods' affinity scheduling rules if specified. + affinity defines the Pods' affinity scheduling rules if specified. Attributes ---------- @@ -1138,7 +1185,6 @@ schema MonitoringCoreosComV1PrometheusSpecAffinityPodAffinityPreferredDuringSche pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -1148,7 +1194,6 @@ schema MonitoringCoreosComV1PrometheusSpecAffinityPodAffinityPreferredDuringSche pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1PrometheusSpecAffinityPodAffinityPreferredDuringSchedulingIgnoredDuringExecutionItems0PodAffinityTermNamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -1277,7 +1322,6 @@ schema MonitoringCoreosComV1PrometheusSpecAffinityPodAffinityRequiredDuringSched pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -1287,7 +1331,6 @@ schema MonitoringCoreosComV1PrometheusSpecAffinityPodAffinityRequiredDuringSched pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1PrometheusSpecAffinityPodAffinityRequiredDuringSchedulingIgnoredDuringExecutionItems0NamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -1407,8 +1450,8 @@ schema MonitoringCoreosComV1PrometheusSpecAffinityPodAntiAffinity: most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), - compute a sum by iterating through the elements of this field and adding - "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the + compute a sum by iterating through the elements of this field and subtracting + "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. requiredDuringSchedulingIgnoredDuringExecution : [MonitoringCoreosComV1PrometheusSpecAffinityPodAntiAffinityRequiredDuringSchedulingIgnoredDuringExecutionItems0], default is Undefined, optional If the anti-affinity requirements specified by this field are not met at @@ -1455,7 +1498,6 @@ schema MonitoringCoreosComV1PrometheusSpecAffinityPodAntiAffinityPreferredDuring pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -1465,7 +1507,6 @@ schema MonitoringCoreosComV1PrometheusSpecAffinityPodAntiAffinityPreferredDuring pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1PrometheusSpecAffinityPodAntiAffinityPreferredDuringSchedulingIgnoredDuringExecutionItems0PodAffinityTermNamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -1594,7 +1635,6 @@ schema MonitoringCoreosComV1PrometheusSpecAffinityPodAntiAffinityRequiredDuringS pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -1604,7 +1644,6 @@ schema MonitoringCoreosComV1PrometheusSpecAffinityPodAntiAffinityRequiredDuringS pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1PrometheusSpecAffinityPodAntiAffinityRequiredDuringSchedulingIgnoredDuringExecutionItems0NamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -1713,12 +1752,12 @@ schema MonitoringCoreosComV1PrometheusSpecAffinityPodAntiAffinityRequiredDuringS schema MonitoringCoreosComV1PrometheusSpecAlerting: r""" - Defines the settings related to Alertmanager. + alerting defines the settings related to Alertmanager. Attributes ---------- alertmanagers : [MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0], default is Undefined, required - Alertmanager endpoints where Prometheus should send alerts to. + alertmanagers endpoints where Prometheus should send alerts to. """ alertmanagers: [MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0] @@ -1730,10 +1769,10 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0: Attributes ---------- alertRelabelings : [MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0AlertRelabelingsItems0], default is Undefined, optional - Relabeling configs applied before sending alerts to a specific Alertmanager. + alertRelabelings defines the relabeling configs applied before sending alerts to a specific Alertmanager. It requires Prometheus >= v2.51.0. apiVersion : str, default is Undefined, optional - Version of the Alertmanager API that Prometheus uses to send alerts. + apiVersion defines the version of the Alertmanager API that Prometheus uses to send alerts. It can be "V1" or "V2". The field has no effect for Prometheus >= v3.0.0 because only the v2 API is supported. authorization : MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Authorization, default is Undefined, optional @@ -1741,49 +1780,49 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0: basicAuth : MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0BasicAuth, default is Undefined, optional basic auth bearerTokenFile : str, default is Undefined, optional - File to read bearer token for Alertmanager. + bearerTokenFile defines the file to read bearer token for Alertmanager. Cannot be set at the same time as `basicAuth`, `authorization`, or `sigv4`. Deprecated: this will be removed in a future release. Prefer using `authorization`. enableHttp2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHttp2 defines whether to enable HTTP2. name : str, default is Undefined, required - Name of the Endpoints object in the namespace. + name of the Endpoints object in the namespace. namespace : str, default is Undefined, optional - Namespace of the Endpoints object. + namespace of the Endpoints object. If not set, the object will be discovered in the namespace of the Prometheus object. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. pathPrefix : str, default is Undefined, optional - Prefix for the HTTP path alerts are pushed to. + pathPrefix defines the prefix for the HTTP path alerts are pushed to. port : int | str, default is Undefined, required - Port on which the Alertmanager API is exposed. + port on which the Alertmanager API is exposed. proxyConnectHeader : {str:[MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. relabelings : [MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0RelabelingsItems0], default is Undefined, optional - Relabel configuration applied to the discovered Alertmanagers. + relabelings defines the relabel configuration applied to the discovered Alertmanagers. scheme : str, default is Undefined, optional - Scheme to use when firing alerts. + scheme defines the HTTP scheme to use when sending alerts. sigv4 : MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Sigv4, default is Undefined, optional sigv4 timeout : str, default is Undefined, optional - Timeout is a per-target Alertmanager timeout when pushing alerts. + timeout defines a per-target Alertmanager timeout when pushing alerts. tlsConfig : MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfig, default is Undefined, optional tls config """ @@ -1804,7 +1843,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0: proxyFromEnvironment?: bool proxyUrl?: str relabelings?: [MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0RelabelingsItems0] - scheme?: str + scheme?: "http" | "https" | "HTTP" | "HTTPS" sigv4?: MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Sigv4 timeout?: str tlsConfig?: MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfig @@ -1812,7 +1851,8 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0: check: len(name) >= 1 len(namespace) >= 1 if namespace - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + len(pathPrefix) >= 1 if pathPrefix + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(timeout), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if timeout schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0AlertRelabelingsItems0: @@ -1825,31 +1865,31 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0AlertRelabe Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -1864,12 +1904,9 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0AlertRelabe sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Authorization: r""" - Authorization section for Alertmanager. + authorization section for Alertmanager. Cannot be set at the same time as `basicAuth`, `bearerTokenFile` or `sigv4`. @@ -1878,7 +1915,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Authorizati credentials : MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -1889,7 +1926,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Authorizati schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -1911,7 +1948,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Authorizati schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0BasicAuth: r""" - BasicAuth configuration for Alertmanager. + basicAuth configuration for Alertmanager. Cannot be set at the same time as `bearerTokenFile`, `authorization` or `sigv4`. @@ -1927,7 +1964,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0BasicAuth: schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -1950,7 +1987,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0BasicAuthPa schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -2003,31 +2040,31 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Relabelings Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -2042,12 +2079,9 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Relabelings sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Sigv4: r""" - Sigv4 allows to configures AWS's Signature Verification 4 for the URL. + sigv4 defines AWS's Signature Verification 4 for the URL. It requires Prometheus >= v2.48.0. @@ -2058,23 +2092,27 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Sigv4: accessKey : MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Sigv4AccessKey, default is Undefined, optional access key profile : str, default is Undefined, optional - Profile is the named AWS profile used to authenticate. + profile defines the named AWS profile used to authenticate. region : str, default is Undefined, optional - Region is the AWS region. If blank, the region from the default credentials chain used. + region defines the AWS region. If blank, the region from the default credentials chain used. roleArn : str, default is Undefined, optional - RoleArn is the named AWS profile used to authenticate. + roleArn defines the named AWS profile used to authenticate. secretKey : MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Sigv4SecretKey, default is Undefined, optional secret key + useFIPSSTSEndpoint : bool, default is Undefined, optional + useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. + It requires Prometheus >= v2.54.0. """ accessKey?: MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Sigv4AccessKey profile?: str region?: str roleArn?: str secretKey?: MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Sigv4SecretKey + useFIPSSTSEndpoint?: bool schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Sigv4AccessKey: r""" - AccessKey is the AWS API key. If not specified, the environment variable + accessKey defines the AWS API key. If not specified, the environment variable `AWS_ACCESS_KEY_ID` is used. Attributes @@ -2097,7 +2135,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Sigv4Access schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Sigv4SecretKey: r""" - SecretKey is the AWS API secret. If not specified, the environment + secretKey defines the AWS API secret. If not specified, the environment variable `AWS_SECRET_ACCESS_KEY` is used. Attributes @@ -2120,34 +2158,34 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0Sigv4Secret schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfig: r""" - TLS Config to use for Alertmanager. + tlsConfig to use for Alertmanager. Attributes ---------- ca : MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCa, default is Undefined, optional ca caFile : str, default is Undefined, optional - Path to the CA cert in the Prometheus container to use for the targets. + caFile defines the path to the CA cert in the Prometheus container to use for the targets. cert : MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the client cert file in the Prometheus container for the targets. + certFile defines the path to the client cert file in the Prometheus container for the targets. insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keyFile : str, default is Undefined, optional - Path to the client key file in the Prometheus container for the targets. + keyFile defines the path to the client key file in the Prometheus container for the targets. keySecret : MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCa caFile?: str @@ -2162,7 +2200,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfig: schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -2176,7 +2214,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCa schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2198,7 +2236,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCa schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2220,7 +2258,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCa schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -2234,7 +2272,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCe schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2256,7 +2294,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCe schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2278,7 +2316,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigCe schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -2300,7 +2338,7 @@ schema MonitoringCoreosComV1PrometheusSpecAlertingAlertmanagersItems0TLSConfigKe schema MonitoringCoreosComV1PrometheusSpecApiserverConfig: r""" - APIServerConfig allows specifying a host and auth methods to access the + apiserverConfig allows specifying a host and auth methods to access the Kuberntees API server. If null, Prometheus is assumed to run inside of the cluster: it will discover the API servers automatically and use the Pod's CA certificate @@ -2313,19 +2351,35 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfig: basicAuth : MonitoringCoreosComV1PrometheusSpecApiserverConfigBasicAuth, default is Undefined, optional basic auth bearerToken : str, default is Undefined, optional - *Warning: this field shouldn't be used because the token value appears + bearerToken is deprecated: this will be removed in a future release. + *Warning: this field shouldn't be used because the token value appears in clear-text. Prefer using `authorization`.* - - Deprecated: this will be removed in a future release. bearerTokenFile : str, default is Undefined, optional - File to read bearer token for accessing apiserver. + bearerTokenFile defines the file to read bearer token for accessing apiserver. Cannot be set at the same time as `basicAuth`, `authorization`, or `bearerToken`. Deprecated: this will be removed in a future release. Prefer using `authorization`. host : str, default is Undefined, required - Kubernetes API address consisting of a hostname or IP address followed + host defines the Kubernetes API address consisting of a hostname or IP address followed by an optional port number. + noProxy : str, default is Undefined, optional + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names + that should be excluded from proxying. IP and domain names can + contain port numbers. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyConnectHeader : {str:[MonitoringCoreosComV1PrometheusSpecApiserverConfigProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to + proxies during CONNECT requests. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyFromEnvironment : bool, default is Undefined, optional + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyUrl : str, default is Undefined, optional + proxyUrl defines the HTTP proxy server to use. tlsConfig : MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfig, default is Undefined, optional tls config """ @@ -2335,11 +2389,18 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfig: bearerTokenFile?: str host: str + noProxy?: str + proxyConnectHeader?: {str:[MonitoringCoreosComV1PrometheusSpecApiserverConfigProxyConnectHeaderItems0]} + proxyFromEnvironment?: bool + proxyUrl?: str tlsConfig?: MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfig + check: + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl + schema MonitoringCoreosComV1PrometheusSpecApiserverConfigAuthorization: r""" - Authorization section for the API server. + authorization section for the API server. Cannot be set at the same time as `basicAuth`, `bearerToken`, or `bearerTokenFile`. @@ -2349,9 +2410,9 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigAuthorization: credentials : MonitoringCoreosComV1PrometheusSpecApiserverConfigAuthorizationCredentials, default is Undefined, optional credentials credentialsFile : str, default is Undefined, optional - File to read a secret from, mutually exclusive with `credentials`. + credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -2363,7 +2424,7 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigAuthorization: schema MonitoringCoreosComV1PrometheusSpecApiserverConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -2385,7 +2446,7 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigAuthorizationCredential schema MonitoringCoreosComV1PrometheusSpecApiserverConfigBasicAuth: r""" - BasicAuth configuration for the API server. + basicAuth configuration for the API server. Cannot be set at the same time as `authorization`, `bearerToken`, or `bearerTokenFile`. @@ -2402,7 +2463,7 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigBasicAuth: schema MonitoringCoreosComV1PrometheusSpecApiserverConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -2425,7 +2486,7 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigBasicAuthPassword: schema MonitoringCoreosComV1PrometheusSpecApiserverConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -2446,36 +2507,58 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigBasicAuthUsername: name?: str = "" optional?: bool +schema MonitoringCoreosComV1PrometheusSpecApiserverConfigProxyConnectHeaderItems0: + r""" + SecretKeySelector selects a key of a Secret. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfig: r""" - TLS Config to use for the API server. + tlsConfig to use for the API server. Attributes ---------- ca : MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCa, default is Undefined, optional ca caFile : str, default is Undefined, optional - Path to the CA cert in the Prometheus container to use for the targets. + caFile defines the path to the CA cert in the Prometheus container to use for the targets. cert : MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the client cert file in the Prometheus container for the targets. + certFile defines the path to the client cert file in the Prometheus container for the targets. insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keyFile : str, default is Undefined, optional - Path to the client key file in the Prometheus container for the targets. + keyFile defines the path to the client key file in the Prometheus container for the targets. keySecret : MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCa caFile?: str @@ -2490,7 +2573,7 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfig: schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -2504,7 +2587,7 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCa: schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2526,7 +2609,7 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCaConfigMap: schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2548,7 +2631,7 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCaSecret: schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -2562,7 +2645,7 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCert: schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2584,7 +2667,7 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCertConfigMap: schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2606,7 +2689,7 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigCertSecret: schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -2628,7 +2711,7 @@ schema MonitoringCoreosComV1PrometheusSpecApiserverConfigTLSConfigKeySecret: schema MonitoringCoreosComV1PrometheusSpecArbitraryFSAccessThroughSMs: r""" - When true, ServiceMonitor, PodMonitor and Probe object are forbidden to + arbitraryFSAccessThroughSMs when true, ServiceMonitor, PodMonitor and Probe object are forbidden to reference arbitrary files on the file system of the 'prometheus' container. When a ServiceMonitor's endpoint specifies a `bearerTokenFile` value @@ -2642,7 +2725,10 @@ schema MonitoringCoreosComV1PrometheusSpecArbitraryFSAccessThroughSMs: Attributes ---------- deny : bool, default is Undefined, optional - deny + deny prevents service monitors from accessing arbitrary files on the file system. + When true, service monitors cannot use file-based configurations like BearerTokenFile + that could potentially access sensitive files. When false (default), such access is allowed. + Setting this to true enhances security by preventing potential credential theft attacks. """ deny?: bool @@ -2675,8 +2761,8 @@ schema MonitoringCoreosComV1PrometheusSpecContainersItems0: Cannot be updated. envFrom : [MonitoringCoreosComV1PrometheusSpecContainersItems0EnvFromItems0], default is Undefined, optional List of sources to populate environment variables in the container. - The keys defined within a source must be a C_IDENTIFIER. All invalid keys - will be reported as an event when the container is starting. When a key exists in multiple + The keys defined within a source may consist of any printable ASCII characters except '='. + When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. @@ -2715,10 +2801,10 @@ schema MonitoringCoreosComV1PrometheusSpecContainersItems0: resources restartPolicy : str, default is Undefined, optional RestartPolicy defines the restart behavior of individual containers in a pod. - This field may only be set for init containers, and the only allowed value is "Always". - For non-init containers or when this field is not specified, + This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. - Setting the RestartPolicy as "Always" for the init container will have the following effect: + Additionally, setting the RestartPolicy as "Always" for the init container will + have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" @@ -2729,6 +2815,18 @@ schema MonitoringCoreosComV1PrometheusSpecContainersItems0: container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. + restartPolicyRules : [MonitoringCoreosComV1PrometheusSpecContainersItems0RestartPolicyRulesItems0], default is Undefined, optional + Represents a list of rules to be checked to determine if the + container should be restarted on exit. The rules are evaluated in + order. Once a rule matches a container exit condition, the remaining + rules are ignored. If no rule matches the container exit condition, + the Container-level restart policy determines the whether the container + is restarted or not. Constraints on the rules: + - At most 20 rules are allowed. + - Rules can have the same action. + - Identical rules are not forbidden in validations. + When rules are specified, container MUST set RestartPolicy explicitly + even it if matches the Pod's RestartPolicy. securityContext : MonitoringCoreosComV1PrometheusSpecContainersItems0SecurityContext, default is Undefined, optional security context startupProbe : MonitoringCoreosComV1PrometheusSpecContainersItems0StartupProbe, default is Undefined, optional @@ -2790,6 +2888,7 @@ schema MonitoringCoreosComV1PrometheusSpecContainersItems0: resizePolicy?: [MonitoringCoreosComV1PrometheusSpecContainersItems0ResizePolicyItems0] resources?: MonitoringCoreosComV1PrometheusSpecContainersItems0Resources restartPolicy?: str + restartPolicyRules?: [MonitoringCoreosComV1PrometheusSpecContainersItems0RestartPolicyRulesItems0] securityContext?: MonitoringCoreosComV1PrometheusSpecContainersItems0SecurityContext startupProbe?: MonitoringCoreosComV1PrometheusSpecContainersItems0StartupProbe stdin?: bool @@ -2803,14 +2902,15 @@ schema MonitoringCoreosComV1PrometheusSpecContainersItems0: schema MonitoringCoreosComV1PrometheusSpecContainersItems0EnvFromItems0: r""" - EnvFromSource represents the source of a set of ConfigMaps + EnvFromSource represents the source of a set of ConfigMaps or Secrets Attributes ---------- configMapRef : MonitoringCoreosComV1PrometheusSpecContainersItems0EnvFromItems0ConfigMapRef, default is Undefined, optional config map ref prefix : str, default is Undefined, optional - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + Optional text to prepend to the name of each environment variable. + May consist of any printable ASCII characters except '='. secretRef : MonitoringCoreosComV1PrometheusSpecContainersItems0EnvFromItems0SecretRef, default is Undefined, optional secret ref """ @@ -2861,7 +2961,8 @@ schema MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0: Attributes ---------- name : str, default is Undefined, required - Name of the environment variable. Must be a C_IDENTIFIER. + Name of the environment variable. + May consist of any printable ASCII characters except '='. value : str, default is Undefined, optional Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and @@ -2890,6 +2991,8 @@ schema MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFrom: config map key ref fieldRef : MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFromFieldRef, default is Undefined, optional field ref + fileKeyRef : MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFromFileKeyRef, default is Undefined, optional + file key ref resourceFieldRef : MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFromResourceFieldRef, default is Undefined, optional resource field ref secretKeyRef : MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFromSecretKeyRef, default is Undefined, optional @@ -2897,6 +3000,7 @@ schema MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFrom: """ configMapKeyRef?: MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFromConfigMapKeyRef fieldRef?: MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFromFieldRef + fileKeyRef?: MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFromFileKeyRef resourceFieldRef?: MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFromResourceFieldRef secretKeyRef?: MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFromSecretKeyRef @@ -2937,6 +3041,38 @@ schema MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFromFiel apiVersion?: str fieldPath: str +schema MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFromFileKeyRef: + r""" + FileKeyRef selects a key of the env file. + Requires the EnvFiles feature gate to be enabled. + + Attributes + ---------- + key : str, default is Undefined, required + The key within the env file. An invalid key will prevent the pod from starting. + The keys defined within a source may consist of any printable ASCII characters except '='. + During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + optional : bool, default is Undefined, optional + Specify whether the file or its key must be defined. If the file or key + does not exist, then the env var is not published. + If optional is set to true and the specified key does not exist, + the environment variable will not be set in the Pod's containers. + + If optional is set to false and the specified key does not exist, + an error will be returned during Pod creation. + path : str, default is Undefined, required + The path within the volume from which to select the file. + Must be relative and may not contain the '..' path or start with '..'. + volumeName : str, default is Undefined, required + The name of the volume mount containing the env file. + """ + key: str + + optional?: bool = False + path: str + + volumeName: str + schema MonitoringCoreosComV1PrometheusSpecContainersItems0EnvItems0ValueFromResourceFieldRef: r""" Selects a resource of the container: only resources limits and requests @@ -2991,9 +3127,14 @@ schema MonitoringCoreosComV1PrometheusSpecContainersItems0Lifecycle: post start preStop : MonitoringCoreosComV1PrometheusSpecContainersItems0LifecyclePreStop, default is Undefined, optional pre stop + stopSignal : str, default is Undefined, optional + StopSignal defines which signal will be sent to a container when it is being stopped. + If not specified, the default is defined by the container runtime in use. + StopSignal can only be set for Pods with a non-empty .spec.os.name """ postStart?: MonitoringCoreosComV1PrometheusSpecContainersItems0LifecyclePostStart preStop?: MonitoringCoreosComV1PrometheusSpecContainersItems0LifecyclePreStop + stopSignal?: str schema MonitoringCoreosComV1PrometheusSpecContainersItems0LifecyclePostStart: r""" @@ -3580,7 +3721,7 @@ schema MonitoringCoreosComV1PrometheusSpecContainersItems0Resources: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. - This is an alpha field and requires enabling the + This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. @@ -3620,6 +3761,44 @@ schema MonitoringCoreosComV1PrometheusSpecContainersItems0ResourcesClaimsItems0: request?: str +schema MonitoringCoreosComV1PrometheusSpecContainersItems0RestartPolicyRulesItems0: + r""" + ContainerRestartRule describes how a container exit is handled. + + Attributes + ---------- + action : str, default is Undefined, required + Specifies the action taken on a container exit if the requirements + are satisfied. The only possible value is "Restart" to restart the + container. + exitCodes : MonitoringCoreosComV1PrometheusSpecContainersItems0RestartPolicyRulesItems0ExitCodes, default is Undefined, optional + exit codes + """ + action: str + + exitCodes?: MonitoringCoreosComV1PrometheusSpecContainersItems0RestartPolicyRulesItems0ExitCodes + +schema MonitoringCoreosComV1PrometheusSpecContainersItems0RestartPolicyRulesItems0ExitCodes: + r""" + Represents the exit codes to check on container exits. + + Attributes + ---------- + operator : str, default is Undefined, required + Represents the relationship between the container exit code(s) and the + specified values. Possible values are: + - In: the requirement is satisfied if the container exit code is in the + set of specified values. + - NotIn: the requirement is satisfied if the container exit code is + not in the set of specified values. + values : [int], default is Undefined, optional + Specifies the set of values to check for container exit codes. + At most 255 elements are allowed. + """ + operator: str + + values?: [int] + schema MonitoringCoreosComV1PrometheusSpecContainersItems0SecurityContext: r""" SecurityContext defines the security options the container should be run with. @@ -4039,20 +4218,20 @@ schema MonitoringCoreosComV1PrometheusSpecContainersItems0VolumeMountsItems0: schema MonitoringCoreosComV1PrometheusSpecDNSConfig: r""" - Defines the DNS configuration for the pods. + dnsConfig defines the DNS configuration for the pods. Attributes ---------- nameservers : [str], default is Undefined, optional - A list of DNS name server IP addresses. + nameservers defines the list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. options : [MonitoringCoreosComV1PrometheusSpecDNSConfigOptionsItems0], default is Undefined, optional - A list of DNS resolver options. + options defines the list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Resolution options given in Options will override those that appear in the base DNSPolicy. searches : [str], default is Undefined, optional - A list of DNS search domains for host-name lookup. + searches defines the list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. """ nameservers?: [str] @@ -4070,9 +4249,9 @@ schema MonitoringCoreosComV1PrometheusSpecDNSConfigOptionsItems0: Attributes ---------- name : str, default is Undefined, required - Name is required and must be unique. + name is required and must be unique. value : str, default is Undefined, optional - Value is optional. + value is optional. """ name: str @@ -4088,14 +4267,14 @@ schema MonitoringCoreosComV1PrometheusSpecExcludedFromEnforcementItems0: Attributes ---------- group : str, default is "monitoring.coreos.com", optional - Group of the referent. When not specified, it defaults to `monitoring.coreos.com` + group of the referent. When not specified, it defaults to `monitoring.coreos.com` name : str, default is Undefined, optional - Name of the referent. When not set, all resources in the namespace are matched. + name of the referent. When not set, all resources in the namespace are matched. namespace : str, default is Undefined, required - Namespace of the referent. + namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ resource : str, default is Undefined, required - Resource of the referent. + resource of the referent. """ group?: "monitoring.coreos.com" = "monitoring.coreos.com" name?: str @@ -4108,13 +4287,13 @@ schema MonitoringCoreosComV1PrometheusSpecExcludedFromEnforcementItems0: schema MonitoringCoreosComV1PrometheusSpecExemplars: r""" - Exemplars related settings that are runtime reloadable. + exemplars related settings that are runtime reloadable. It requires to enable the `exemplar-storage` feature flag to be effective. Attributes ---------- maxSize : int, default is Undefined, optional - Maximum number of exemplars stored in memory for all series. + maxSize defines the maximum number of exemplars stored in memory for all series. exemplar-storage itself must be enabled using the `spec.enableFeature` option for exemplars to be scraped in the first place. @@ -4132,9 +4311,9 @@ schema MonitoringCoreosComV1PrometheusSpecHostAliasesItems0: Attributes ---------- hostnames : [str], default is Undefined, required - Hostnames for the above IP address. + hostnames defines hostnames for the above IP address. ip : str, default is Undefined, required - IP address of the host file entry. + ip defines the IP address of the host file entry. """ hostnames: [str] @@ -4185,8 +4364,8 @@ schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0: Cannot be updated. envFrom : [MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvFromItems0], default is Undefined, optional List of sources to populate environment variables in the container. - The keys defined within a source must be a C_IDENTIFIER. All invalid keys - will be reported as an event when the container is starting. When a key exists in multiple + The keys defined within a source may consist of any printable ASCII characters except '='. + When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. @@ -4225,10 +4404,10 @@ schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0: resources restartPolicy : str, default is Undefined, optional RestartPolicy defines the restart behavior of individual containers in a pod. - This field may only be set for init containers, and the only allowed value is "Always". - For non-init containers or when this field is not specified, + This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. - Setting the RestartPolicy as "Always" for the init container will have the following effect: + Additionally, setting the RestartPolicy as "Always" for the init container will + have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" @@ -4239,6 +4418,18 @@ schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0: container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. + restartPolicyRules : [MonitoringCoreosComV1PrometheusSpecInitContainersItems0RestartPolicyRulesItems0], default is Undefined, optional + Represents a list of rules to be checked to determine if the + container should be restarted on exit. The rules are evaluated in + order. Once a rule matches a container exit condition, the remaining + rules are ignored. If no rule matches the container exit condition, + the Container-level restart policy determines the whether the container + is restarted or not. Constraints on the rules: + - At most 20 rules are allowed. + - Rules can have the same action. + - Identical rules are not forbidden in validations. + When rules are specified, container MUST set RestartPolicy explicitly + even it if matches the Pod's RestartPolicy. securityContext : MonitoringCoreosComV1PrometheusSpecInitContainersItems0SecurityContext, default is Undefined, optional security context startupProbe : MonitoringCoreosComV1PrometheusSpecInitContainersItems0StartupProbe, default is Undefined, optional @@ -4300,6 +4491,7 @@ schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0: resizePolicy?: [MonitoringCoreosComV1PrometheusSpecInitContainersItems0ResizePolicyItems0] resources?: MonitoringCoreosComV1PrometheusSpecInitContainersItems0Resources restartPolicy?: str + restartPolicyRules?: [MonitoringCoreosComV1PrometheusSpecInitContainersItems0RestartPolicyRulesItems0] securityContext?: MonitoringCoreosComV1PrometheusSpecInitContainersItems0SecurityContext startupProbe?: MonitoringCoreosComV1PrometheusSpecInitContainersItems0StartupProbe stdin?: bool @@ -4313,14 +4505,15 @@ schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0: schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvFromItems0: r""" - EnvFromSource represents the source of a set of ConfigMaps + EnvFromSource represents the source of a set of ConfigMaps or Secrets Attributes ---------- configMapRef : MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvFromItems0ConfigMapRef, default is Undefined, optional config map ref prefix : str, default is Undefined, optional - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + Optional text to prepend to the name of each environment variable. + May consist of any printable ASCII characters except '='. secretRef : MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvFromItems0SecretRef, default is Undefined, optional secret ref """ @@ -4371,7 +4564,8 @@ schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0: Attributes ---------- name : str, default is Undefined, required - Name of the environment variable. Must be a C_IDENTIFIER. + Name of the environment variable. + May consist of any printable ASCII characters except '='. value : str, default is Undefined, optional Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and @@ -4400,6 +4594,8 @@ schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFrom config map key ref fieldRef : MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFromFieldRef, default is Undefined, optional field ref + fileKeyRef : MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFromFileKeyRef, default is Undefined, optional + file key ref resourceFieldRef : MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFromResourceFieldRef, default is Undefined, optional resource field ref secretKeyRef : MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFromSecretKeyRef, default is Undefined, optional @@ -4407,6 +4603,7 @@ schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFrom """ configMapKeyRef?: MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFromConfigMapKeyRef fieldRef?: MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFromFieldRef + fileKeyRef?: MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFromFileKeyRef resourceFieldRef?: MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFromResourceFieldRef secretKeyRef?: MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFromSecretKeyRef @@ -4447,6 +4644,38 @@ schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFrom apiVersion?: str fieldPath: str +schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFromFileKeyRef: + r""" + FileKeyRef selects a key of the env file. + Requires the EnvFiles feature gate to be enabled. + + Attributes + ---------- + key : str, default is Undefined, required + The key within the env file. An invalid key will prevent the pod from starting. + The keys defined within a source may consist of any printable ASCII characters except '='. + During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + optional : bool, default is Undefined, optional + Specify whether the file or its key must be defined. If the file or key + does not exist, then the env var is not published. + If optional is set to true and the specified key does not exist, + the environment variable will not be set in the Pod's containers. + + If optional is set to false and the specified key does not exist, + an error will be returned during Pod creation. + path : str, default is Undefined, required + The path within the volume from which to select the file. + Must be relative and may not contain the '..' path or start with '..'. + volumeName : str, default is Undefined, required + The name of the volume mount containing the env file. + """ + key: str + + optional?: bool = False + path: str + + volumeName: str + schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0EnvItems0ValueFromResourceFieldRef: r""" Selects a resource of the container: only resources limits and requests @@ -4501,9 +4730,14 @@ schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0Lifecycle: post start preStop : MonitoringCoreosComV1PrometheusSpecInitContainersItems0LifecyclePreStop, default is Undefined, optional pre stop + stopSignal : str, default is Undefined, optional + StopSignal defines which signal will be sent to a container when it is being stopped. + If not specified, the default is defined by the container runtime in use. + StopSignal can only be set for Pods with a non-empty .spec.os.name """ postStart?: MonitoringCoreosComV1PrometheusSpecInitContainersItems0LifecyclePostStart preStop?: MonitoringCoreosComV1PrometheusSpecInitContainersItems0LifecyclePreStop + stopSignal?: str schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0LifecyclePostStart: r""" @@ -5090,7 +5324,7 @@ schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0Resources: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. - This is an alpha field and requires enabling the + This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. @@ -5130,6 +5364,44 @@ schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0ResourcesClaimsIte request?: str +schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0RestartPolicyRulesItems0: + r""" + ContainerRestartRule describes how a container exit is handled. + + Attributes + ---------- + action : str, default is Undefined, required + Specifies the action taken on a container exit if the requirements + are satisfied. The only possible value is "Restart" to restart the + container. + exitCodes : MonitoringCoreosComV1PrometheusSpecInitContainersItems0RestartPolicyRulesItems0ExitCodes, default is Undefined, optional + exit codes + """ + action: str + + exitCodes?: MonitoringCoreosComV1PrometheusSpecInitContainersItems0RestartPolicyRulesItems0ExitCodes + +schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0RestartPolicyRulesItems0ExitCodes: + r""" + Represents the exit codes to check on container exits. + + Attributes + ---------- + operator : str, default is Undefined, required + Represents the relationship between the container exit code(s) and the + specified values. Possible values are: + - In: the requirement is satisfied if the container exit code is in the + set of specified values. + - NotIn: the requirement is satisfied if the container exit code is + not in the set of specified values. + values : [int], default is Undefined, optional + Specifies the set of values to check for container exit codes. + At most 255 elements are allowed. + """ + operator: str + + values?: [int] + schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0SecurityContext: r""" SecurityContext defines the security options the container should be run with. @@ -5549,34 +5821,58 @@ schema MonitoringCoreosComV1PrometheusSpecInitContainersItems0VolumeMountsItems0 schema MonitoringCoreosComV1PrometheusSpecOtlp: r""" - Settings related to the OTLP receiver feature. + otlp defines the settings related to the OTLP receiver feature. It requires Prometheus >= v2.55.0. Attributes ---------- + convertHistogramsToNHCB : bool, default is Undefined, optional + convertHistogramsToNHCB defines optional translation of OTLP explicit bucket histograms into native histograms with custom buckets. + It requires Prometheus >= v3.4.0. + ignoreResourceAttributes : [str], default is Undefined, optional + ignoreResourceAttributes defines the list of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true. + + It requires `promoteAllResourceAttributes` to be true. + It requires Prometheus >= v3.5.0. keepIdentifyingResourceAttributes : bool, default is Undefined, optional - Enables adding `service.name`, `service.namespace` and `service.instance.id` + keepIdentifyingResourceAttributes enables adding `service.name`, `service.namespace` and `service.instance.id` resource attributes to the `target_info` metric, on top of converting them into the `instance` and `job` labels. It requires Prometheus >= v3.1.0. + promoteAllResourceAttributes : bool, default is Undefined, optional + promoteAllResourceAttributes promotes all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`. + + Cannot be true when `promoteResourceAttributes` is defined. + It requires Prometheus >= v3.5.0. promoteResourceAttributes : [str], default is Undefined, optional - List of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none. + promoteResourceAttributes defines the list of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none. + Cannot be defined when `promoteAllResourceAttributes` is true. + promoteScopeMetadata : bool, default is Undefined, optional + promoteScopeMetadata controls whether to promote OpenTelemetry scope metadata (i.e. name, version, schema URL, and attributes) to metric labels. + As per the OpenTelemetry specification, the aforementioned scope metadata should be identifying, i.e. made into metric labels. + It requires Prometheus >= v3.6.0. translationStrategy : str, default is Undefined, optional - Configures how the OTLP receiver endpoint translates the incoming metrics. + translationStrategy defines how the OTLP receiver endpoint translates the incoming metrics. It requires Prometheus >= v3.0.0. """ + convertHistogramsToNHCB?: bool + ignoreResourceAttributes?: [str] keepIdentifyingResourceAttributes?: bool + promoteAllResourceAttributes?: bool promoteResourceAttributes?: [str] - translationStrategy?: "NoUTF8EscapingWithSuffixes" | "UnderscoreEscapingWithSuffixes" + promoteScopeMetadata?: bool + translationStrategy?: "NoUTF8EscapingWithSuffixes" | "UnderscoreEscapingWithSuffixes" | "NoTranslation" | "UnderscoreEscapingWithoutSuffixes" check: + len(ignoreResourceAttributes) >= 1 if ignoreResourceAttributes + all ignoreResourceAttributes in ignoreResourceAttributes {len(ignoreResourceAttributes) >= 1 if ignoreResourceAttributes not in [None, Undefined]} if ignoreResourceAttributes len(promoteResourceAttributes) >= 1 if promoteResourceAttributes all promoteResourceAttributes in promoteResourceAttributes {len(promoteResourceAttributes) >= 1 if promoteResourceAttributes not in [None, Undefined]} if promoteResourceAttributes schema MonitoringCoreosComV1PrometheusSpecPersistentVolumeClaimRetentionPolicy: r""" - The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet. + persistentVolumeClaimRetentionPolicy defines the field controls if and how PVCs are deleted during the lifecycle of a StatefulSet. The default behavior is all PVCs are retained. This is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26. It requires enabling the StatefulSetAutoDeletePVC feature gate. @@ -5600,7 +5896,7 @@ schema MonitoringCoreosComV1PrometheusSpecPersistentVolumeClaimRetentionPolicy: schema MonitoringCoreosComV1PrometheusSpecPodMetadata: r""" - PodMetadata configures labels and annotations which are propagated to the Prometheus pods. + podMetadata defines labels and annotations which are propagated to the Prometheus pods. The following items are reserved and cannot be overridden: * "prometheus" label, set to the name of the Prometheus object. @@ -5615,22 +5911,22 @@ schema MonitoringCoreosComV1PrometheusSpecPodMetadata: Attributes ---------- annotations : {str:str}, default is Undefined, optional - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. - More info: http://kubernetes.io/docs/user-guide/annotations + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ labels : {str:str}, default is Undefined, optional - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. - More info: http://kubernetes.io/docs/user-guide/labels + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ name : str, default is Undefined, optional - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. - More info: http://kubernetes.io/docs/user-guide/identifiers#names + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/ """ annotations?: {str:str} labels?: {str:str} @@ -5638,7 +5934,7 @@ schema MonitoringCoreosComV1PrometheusSpecPodMetadata: schema MonitoringCoreosComV1PrometheusSpecPodMonitorNamespaceSelector: r""" - Namespaces to match for PodMonitors discovery. An empty label selector + podMonitorNamespaceSelector defines the namespaces to match for PodMonitors discovery. An empty label selector matches all namespaces. A null label selector (default value) matches the current namespace only. @@ -5680,7 +5976,7 @@ schema MonitoringCoreosComV1PrometheusSpecPodMonitorNamespaceSelectorMatchExpres schema MonitoringCoreosComV1PrometheusSpecPodMonitorSelector: r""" - PodMonitors to be selected for target discovery. An empty label selector + podMonitorSelector defines the podMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -5730,7 +6026,7 @@ schema MonitoringCoreosComV1PrometheusSpecPodMonitorSelectorMatchExpressionsItem schema MonitoringCoreosComV1PrometheusSpecProbeNamespaceSelector: r""" - Namespaces to match for Probe discovery. An empty label + probeNamespaceSelector defines the namespaces to match for Probe discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only. @@ -5772,7 +6068,7 @@ schema MonitoringCoreosComV1PrometheusSpecProbeNamespaceSelectorMatchExpressions schema MonitoringCoreosComV1PrometheusSpecProbeSelector: r""" - Probes to be selected for target discovery. An empty label selector + probeSelector defines the probes to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -5829,9 +6125,9 @@ schema MonitoringCoreosComV1PrometheusSpecPrometheusRulesExcludedFromEnforceItem Attributes ---------- ruleName : str, default is Undefined, required - Name of the excluded PrometheusRule object. + ruleName defines the name of the excluded PrometheusRule object. ruleNamespace : str, default is Undefined, required - Namespace of the excluded PrometheusRule object. + ruleNamespace defines the namespace of the excluded PrometheusRule object. """ ruleName: str @@ -5839,20 +6135,20 @@ schema MonitoringCoreosComV1PrometheusSpecPrometheusRulesExcludedFromEnforceItem schema MonitoringCoreosComV1PrometheusSpecQuery: r""" - QuerySpec defines the configuration of the Promethus query service. + query defines the configuration of the Prometheus query service. Attributes ---------- lookbackDelta : str, default is Undefined, optional - The delta difference allowed for retrieving metrics during expression evaluations. + lookbackDelta defines the delta difference allowed for retrieving metrics during expression evaluations. maxConcurrency : int, default is Undefined, optional - Number of concurrent queries that can be run at once. + maxConcurrency defines the number of concurrent queries that can be run at once. maxSamples : int, default is Undefined, optional - Maximum number of samples a single query can load into memory. Note that + maxSamples defines the maximum number of samples a single query can load into memory. Note that queries will fail if they would load more samples than this into memory, so this also limits the number of samples a query can return. timeout : str, default is Undefined, optional - Maximum time a query may take before being aborted. + timeout defines the maximum time a query may take before being aborted. """ lookbackDelta?: str maxConcurrency?: int @@ -5875,63 +6171,62 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0: basicAuth : MonitoringCoreosComV1PrometheusSpecRemoteReadItems0BasicAuth, default is Undefined, optional basic auth bearerToken : str, default is Undefined, optional + bearerToken is deprecated: this will be removed in a future release. *Warning: this field shouldn't be used because the token value appears in clear-text. Prefer using `authorization`.* - - Deprecated: this will be removed in a future release. bearerTokenFile : str, default is Undefined, optional - File from which to read the bearer token for the URL. + bearerTokenFile defines the file from which to read the bearer token for the URL. Deprecated: this will be removed in a future release. Prefer using `authorization`. filterExternalLabels : bool, default is Undefined, optional - Whether to use the external labels as selectors for the remote read endpoint. + filterExternalLabels defines whether to use the external labels as selectors for the remote read endpoint. It requires Prometheus >= v2.34.0. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. It requires Prometheus >= v2.26.0. headers : {str:str}, default is Undefined, optional - Custom HTTP headers to be sent along with each remote read request. + headers defines the custom HTTP headers to be sent along with each remote read request. Be aware that headers that are set by Prometheus itself can't be overwritten. Only valid in Prometheus versions 2.26.0 and newer. name : str, default is Undefined, optional - The name of the remote read queue, it must be unique if specified. The + name of the remote read queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate read configurations. It requires Prometheus >= v2.15.0. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1PrometheusSpecRemoteReadItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. readRecent : bool, default is Undefined, optional - Whether reads should be made for queries for time ranges that + readRecent defines whether reads should be made for queries for time ranges that the local storage should have complete data for. remoteTimeout : str, default is Undefined, optional - Timeout for requests to the remote read endpoint. + remoteTimeout defines the timeout for requests to the remote read endpoint. requiredMatchers : {str:str}, default is Undefined, optional - An optional list of equality matchers which have to be present + requiredMatchers defines an optional list of equality matchers which have to be present in a selector to query the remote read endpoint. tlsConfig : MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfig, default is Undefined, optional tls config url : str, default is Undefined, required - The URL of the endpoint to query from. + url defines the URL of the endpoint to query from. """ authorization?: MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Authorization basicAuth?: MonitoringCoreosComV1PrometheusSpecRemoteReadItems0BasicAuth @@ -5953,12 +6248,12 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0: url: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(remoteTimeout), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if remoteTimeout schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Authorization: r""" - Authorization section for the URL. + authorization section for the URL. It requires Prometheus >= v2.26.0. @@ -5969,9 +6264,9 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Authorization: credentials : MonitoringCoreosComV1PrometheusSpecRemoteReadItems0AuthorizationCredentials, default is Undefined, optional credentials credentialsFile : str, default is Undefined, optional - File to read a secret from, mutually exclusive with `credentials`. + credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -5983,7 +6278,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Authorization: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -6005,7 +6300,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0AuthorizationCredentia schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0BasicAuth: r""" - BasicAuth configuration for the URL. + basicAuth configuration for the URL. Cannot be set at the same time as `authorization`, or `oauth2`. @@ -6021,7 +6316,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0BasicAuth: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -6044,7 +6339,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0BasicAuthPassword: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -6067,7 +6362,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0BasicAuthUsername: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2: r""" - OAuth2 configuration for the URL. + oauth2 configuration for the URL. It requires Prometheus >= v2.27.0. @@ -6080,31 +6375,31 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2: clientSecret : MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2ClientID @@ -6120,12 +6415,12 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -6140,7 +6435,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2ClientID: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6162,7 +6457,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2ClientIDConfigMa schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6184,7 +6479,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2ClientIDSecret: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -6229,7 +6524,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2ProxyConnectHead schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -6239,19 +6534,19 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfig: cert : MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCert @@ -6263,7 +6558,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfig: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -6277,7 +6572,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCa: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6299,7 +6594,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCaConfi schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6321,7 +6616,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCaSecre schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -6335,7 +6630,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCert: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6357,7 +6652,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCertCon schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6379,7 +6674,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigCertSec schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -6423,34 +6718,34 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0ProxyConnectHeaderItem schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfig: r""" - TLS Config to use for the URL. + tlsConfig to use for the URL. Attributes ---------- ca : MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCa, default is Undefined, optional ca caFile : str, default is Undefined, optional - Path to the CA cert in the Prometheus container to use for the targets. + caFile defines the path to the CA cert in the Prometheus container to use for the targets. cert : MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the client cert file in the Prometheus container for the targets. + certFile defines the path to the client cert file in the Prometheus container for the targets. insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keyFile : str, default is Undefined, optional - Path to the client key file in the Prometheus container for the targets. + keyFile defines the path to the client key file in the Prometheus container for the targets. keySecret : MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCa caFile?: str @@ -6465,7 +6760,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfig: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -6479,7 +6774,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCa: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6501,7 +6796,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCaConfigMap: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6523,7 +6818,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCaSecret: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -6537,7 +6832,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCert: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6559,7 +6854,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCertConfigMap schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6581,7 +6876,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigCertSecret: schema MonitoringCoreosComV1PrometheusSpecRemoteReadItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -6615,27 +6910,26 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0: basicAuth : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0BasicAuth, default is Undefined, optional basic auth bearerToken : str, default is Undefined, optional + bearerToken is deprecated: this will be removed in a future release. *Warning: this field shouldn't be used because the token value appears in clear-text. Prefer using `authorization`.* - - Deprecated: this will be removed in a future release. bearerTokenFile : str, default is Undefined, optional - File from which to read bearer token for the URL. + bearerTokenFile defines the file from which to read bearer token for the URL. Deprecated: this will be removed in a future release. Prefer using `authorization`. enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. - It requires Prometheus >= v2.26.0. + It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. headers : {str:str}, default is Undefined, optional - Custom HTTP headers to be sent along with each remote write request. + headers defines the custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can't be overwritten. - It requires Prometheus >= v2.25.0. + It requires Prometheus >= v2.25.0 or Thanos >= v0.24.0. messageVersion : str, default is Undefined, optional - The Remote Write message's version to use when writing to the endpoint. + messageVersion defines the Remote Write message's version to use when writing to the endpoint. `Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0. `Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0. @@ -6646,56 +6940,71 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0: Before setting this field, consult with your remote storage provider what message version it supports. - It requires Prometheus >= v2.54.0. + It requires Prometheus >= v2.54.0 or Thanos >= v0.37.0. metadataConfig : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0MetadataConfig, default is Undefined, optional metadata config name : str, default is Undefined, optional - The name of the remote write queue, it must be unique if specified. The + name of the remote write queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate queues. - It requires Prometheus >= v2.15.0. + It requires Prometheus >= v2.15.0 or Thanos >= 0.24.0. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. queueConfig : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0QueueConfig, default is Undefined, optional queue config remoteTimeout : str, default is Undefined, optional - Timeout for requests to the remote write endpoint. + remoteTimeout defines the timeout for requests to the remote write endpoint. + roundRobinDNS : bool, default is Undefined, optional + roundRobinDNS controls the DNS resolution behavior for remote-write connections. + When enabled: + - The remote-write mechanism will resolve the hostname via DNS. + - It will randomly select one of the resolved IP addresses and connect to it. + + When disabled (default behavior): + - The Go standard library will handle hostname resolution. + - It will attempt connections to each resolved IP address sequentially. + + Note: The connection timeout applies to the entire resolution and connection process. + + If disabled, the timeout is distributed across all connection attempts. + + It requires Prometheus >= v3.1.0 or Thanos >= v0.38.0. sendExemplars : bool, default is Undefined, optional - Enables sending of exemplars over remote write. Note that + sendExemplars enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the `spec.enableFeatures` option for exemplars to be scraped in the first place. - It requires Prometheus >= v2.27.0. + It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0. sendNativeHistograms : bool, default is Undefined, optional - Enables sending of native histograms, also known as sparse histograms + sendNativeHistograms enables sending of native histograms, also known as sparse histograms over remote write. - It requires Prometheus >= v2.40.0. + It requires Prometheus >= v2.40.0 or Thanos >= v0.30.0. sigv4 : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Sigv4, default is Undefined, optional sigv4 tlsConfig : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfig, default is Undefined, optional tls config url : str, default is Undefined, required - The URL of the endpoint to send samples to. + url defines the URL of the endpoint to send samples to. writeRelabelConfigs : [MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0WriteRelabelConfigsItems0], default is Undefined, optional - The list of remote write relabel configurations. + writeRelabelConfigs defines the list of remote write relabel configurations. """ authorization?: MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Authorization azureAd?: MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AzureAd @@ -6715,6 +7024,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0: proxyUrl?: str queueConfig?: MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0QueueConfig remoteTimeout?: str + roundRobinDNS?: bool sendExemplars?: bool sendNativeHistograms?: bool sigv4?: MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Sigv4 @@ -6724,15 +7034,15 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0: writeRelabelConfigs?: [MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0WriteRelabelConfigsItems0] check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(remoteTimeout), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if remoteTimeout len(url) >= 1 schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Authorization: r""" - Authorization section for the URL. + authorization section for the URL. - It requires Prometheus >= v2.26.0. + It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. Cannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`. @@ -6741,9 +7051,9 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Authorization: credentials : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AuthorizationCredentials, default is Undefined, optional credentials credentialsFile : str, default is Undefined, optional - File to read a secret from, mutually exclusive with `credentials`. + credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -6755,7 +7065,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Authorization: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -6777,16 +7087,16 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AuthorizationCredenti schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AzureAd: r""" - AzureAD for the URL. + azureAd for the URL. - It requires Prometheus >= v2.45.0. + It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0. Cannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`. Attributes ---------- cloud : str, default is Undefined, optional - The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'. + cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'. managedIdentity : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AzureAdManagedIdentity, default is Undefined, optional managed identity oauth : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AzureAdOauth, default is Undefined, optional @@ -6801,31 +7111,36 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AzureAd: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AzureAdManagedIdentity: r""" - ManagedIdentity defines the Azure User-assigned Managed identity. + managedIdentity defines the Azure User-assigned Managed identity. Cannot be set at the same time as `oauth` or `sdk`. Attributes ---------- - clientId : str, default is Undefined, required - The client id + clientId : str, default is Undefined, optional + clientId defines the Azure User-assigned Managed identity. + + For Prometheus >= 3.5.0 and Thanos >= 0.40.0, this field is allowed to be empty to support system-assigned managed identities. """ - clientId: str + clientId?: str + + check: + len(clientId) >= 1 if clientId schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AzureAdOauth: r""" - OAuth defines the oauth config that is being used to authenticate. + oauth defines the oauth config that is being used to authenticate. Cannot be set at the same time as `managedIdentity` or `sdk`. - It requires Prometheus >= v2.48.0. + It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0. Attributes ---------- clientId : str, default is Undefined, required - `clientID` is the clientId of the Azure Active Directory application that is being used to authenticate. + clientId defines the clientId of the Azure Active Directory application that is being used to authenticate. clientSecret : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AzureAdOauthClientSecret, default is Undefined, required client secret tenantId : str, default is Undefined, required - `tenantId` is the tenant ID of the Azure Active Directory application that is being used to authenticate. + tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate. """ clientId: str @@ -6840,7 +7155,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AzureAdOauth: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AzureAdOauthClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate. + clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate. Attributes ---------- @@ -6862,16 +7177,16 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AzureAdOauthClientSec schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AzureAdSdk: r""" - SDK defines the Azure SDK config that is being used to authenticate. + sdk defines the Azure SDK config that is being used to authenticate. See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication Cannot be set at the same time as `oauth` or `managedIdentity`. - It requires Prometheus >= 2.52.0. + It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0. Attributes ---------- tenantId : str, default is Undefined, optional - `tenantId` is the tenant ID of the azure active directory application that is being used to authenticate. + tenantId defines the tenant ID of the azure active directory application that is being used to authenticate. """ tenantId?: str @@ -6880,7 +7195,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0AzureAdSdk: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0BasicAuth: r""" - BasicAuth configuration for the URL. + basicAuth configuration for the URL. Cannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`. @@ -6896,7 +7211,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0BasicAuth: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -6919,7 +7234,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0BasicAuthPassword: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -6942,26 +7257,35 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0BasicAuthUsername: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0MetadataConfig: r""" - MetadataConfig configures the sending of series metadata to the remote storage. + metadataConfig defines how to send a series metadata to the remote storage. + + When the field is empty, **no metadata** is sent. But when the field is + null, metadata is sent. Attributes ---------- + maxSamplesPerSend : int, default is Undefined, optional + maxSamplesPerSend defines the maximum number of metadata samples per send. + + It requires Prometheus >= v2.29.0. send : bool, default is Undefined, optional - Defines whether metric metadata is sent to the remote storage or not. + send defines whether metric metadata is sent to the remote storage or not. sendInterval : str, default is Undefined, optional - Defines how frequently metric metadata is sent to the remote storage. + sendInterval defines how frequently metric metadata is sent to the remote storage. """ + maxSamplesPerSend?: int send?: bool sendInterval?: str check: + maxSamplesPerSend >= -1 if maxSamplesPerSend not in [None, Undefined] _regex_match(str(sendInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if sendInterval schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2: r""" - OAuth2 configuration for the URL. + oauth2 configuration for the URL. - It requires Prometheus >= v2.27.0. + It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0. Cannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`. @@ -6972,31 +7296,31 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2: clientSecret : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2ClientID @@ -7012,12 +7336,12 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -7032,7 +7356,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2ClientID: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7054,7 +7378,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2ClientIDConfigM schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7076,7 +7400,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2ClientIDSecret: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -7121,7 +7445,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2ProxyConnectHea schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -7131,19 +7455,19 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfig: cert : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCert @@ -7155,7 +7479,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfig: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -7169,7 +7493,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCa: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7191,7 +7515,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCaConf schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7213,7 +7537,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCaSecr schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -7227,7 +7551,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCert: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7249,7 +7573,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCertCo schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7271,7 +7595,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigCertSe schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -7315,35 +7639,35 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0ProxyConnectHeaderIte schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0QueueConfig: r""" - QueueConfig allows tuning of the remote write queue parameters. + queueConfig allows tuning of the remote write queue parameters. Attributes ---------- batchSendDeadline : str, default is Undefined, optional - BatchSendDeadline is the maximum time a sample will wait in buffer. + batchSendDeadline defines the maximum time a sample will wait in buffer. capacity : int, default is Undefined, optional - Capacity is the number of samples to buffer per shard before we start + capacity defines the number of samples to buffer per shard before we start dropping them. maxBackoff : str, default is Undefined, optional - MaxBackoff is the maximum retry delay. + maxBackoff defines the maximum retry delay. maxRetries : int, default is Undefined, optional - MaxRetries is the maximum number of times to retry a batch on recoverable errors. + maxRetries defines the maximum number of times to retry a batch on recoverable errors. maxSamplesPerSend : int, default is Undefined, optional - MaxSamplesPerSend is the maximum number of samples per send. + maxSamplesPerSend defines the maximum number of samples per send. maxShards : int, default is Undefined, optional - MaxShards is the maximum number of shards, i.e. amount of concurrency. + maxShards defines the maximum number of shards, i.e. amount of concurrency. minBackoff : str, default is Undefined, optional - MinBackoff is the initial retry delay. Gets doubled for every retry. + minBackoff defines the initial retry delay. Gets doubled for every retry. minShards : int, default is Undefined, optional - MinShards is the minimum number of shards, i.e. amount of concurrency. + minShards defines the minimum number of shards, i.e. amount of concurrency. retryOnRateLimit : bool, default is Undefined, optional - Retry upon receiving a 429 status code from the remote-write storage. + retryOnRateLimit defines the retry upon receiving a 429 status code from the remote-write storage. This is an *experimental feature*, it may change in any upcoming release in a breaking way. sampleAgeLimit : str, default is Undefined, optional - SampleAgeLimit drops samples older than the limit. - It requires Prometheus >= v2.50.0. + sampleAgeLimit drops samples older than the limit. + It requires Prometheus >= v2.50.0 or Thanos >= v0.32.0. """ batchSendDeadline?: str capacity?: int @@ -7364,9 +7688,9 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0QueueConfig: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Sigv4: r""" - Sigv4 allows to configures AWS's Signature Verification 4 for the URL. + sigv4 defines the AWS's Signature Verification 4 for the URL. - It requires Prometheus >= v2.26.0. + It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. Cannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`. @@ -7375,23 +7699,27 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Sigv4: accessKey : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Sigv4AccessKey, default is Undefined, optional access key profile : str, default is Undefined, optional - Profile is the named AWS profile used to authenticate. + profile defines the named AWS profile used to authenticate. region : str, default is Undefined, optional - Region is the AWS region. If blank, the region from the default credentials chain used. + region defines the AWS region. If blank, the region from the default credentials chain used. roleArn : str, default is Undefined, optional - RoleArn is the named AWS profile used to authenticate. + roleArn defines the named AWS profile used to authenticate. secretKey : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Sigv4SecretKey, default is Undefined, optional secret key + useFIPSSTSEndpoint : bool, default is Undefined, optional + useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. + It requires Prometheus >= v2.54.0. """ accessKey?: MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Sigv4AccessKey profile?: str region?: str roleArn?: str secretKey?: MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Sigv4SecretKey + useFIPSSTSEndpoint?: bool schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Sigv4AccessKey: r""" - AccessKey is the AWS API key. If not specified, the environment variable + accessKey defines the AWS API key. If not specified, the environment variable `AWS_ACCESS_KEY_ID` is used. Attributes @@ -7414,7 +7742,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Sigv4AccessKey: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Sigv4SecretKey: r""" - SecretKey is the AWS API secret. If not specified, the environment + secretKey defines the AWS API secret. If not specified, the environment variable `AWS_SECRET_ACCESS_KEY` is used. Attributes @@ -7437,34 +7765,34 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0Sigv4SecretKey: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfig: r""" - TLS Config to use for the URL. + tlsConfig to use for the URL. Attributes ---------- ca : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCa, default is Undefined, optional ca caFile : str, default is Undefined, optional - Path to the CA cert in the Prometheus container to use for the targets. + caFile defines the path to the CA cert in the Prometheus container to use for the targets. cert : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the client cert file in the Prometheus container for the targets. + certFile defines the path to the client cert file in the Prometheus container for the targets. insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keyFile : str, default is Undefined, optional - Path to the client key file in the Prometheus container for the targets. + keyFile defines the path to the client key file in the Prometheus container for the targets. keySecret : MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCa caFile?: str @@ -7479,7 +7807,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfig: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -7493,7 +7821,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCa: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7515,7 +7843,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCaConfigMap: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7537,7 +7865,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCaSecret: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -7551,7 +7879,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCert: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7573,7 +7901,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCertConfigMa schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7595,7 +7923,7 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigCertSecret: schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -7625,31 +7953,31 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0WriteRelabelConfigsIt Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -7664,12 +7992,9 @@ schema MonitoringCoreosComV1PrometheusSpecRemoteWriteItems0WriteRelabelConfigsIt sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1PrometheusSpecResources: r""" - Defines the resources requests and limits of the 'prometheus' container. + resources defines the resources requests and limits of the 'prometheus' container. Attributes ---------- @@ -7677,7 +8002,7 @@ schema MonitoringCoreosComV1PrometheusSpecResources: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. - This is an alpha field and requires enabling the + This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. @@ -7719,7 +8044,7 @@ schema MonitoringCoreosComV1PrometheusSpecResourcesClaimsItems0: schema MonitoringCoreosComV1PrometheusSpecRuleNamespaceSelector: r""" - Namespaces to match for PrometheusRule discovery. An empty label selector + ruleNamespaceSelector defines the namespaces to match for PrometheusRule discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only. @@ -7761,7 +8086,7 @@ schema MonitoringCoreosComV1PrometheusSpecRuleNamespaceSelectorMatchExpressionsI schema MonitoringCoreosComV1PrometheusSpecRuleSelector: r""" - PrometheusRule objects to be selected for rule evaluation. An empty + ruleSelector defines the prometheusRule objects to be selected for rule evaluation. An empty label selector matches all objects. A null label selector matches no objects. @@ -7803,7 +8128,7 @@ schema MonitoringCoreosComV1PrometheusSpecRuleSelectorMatchExpressionsItems0: schema MonitoringCoreosComV1PrometheusSpecRules: r""" - Defines the configuration of the Prometheus rules' engine. + rules defines the configuration of the Prometheus rules' engine. Attributes ---------- @@ -7814,22 +8139,22 @@ schema MonitoringCoreosComV1PrometheusSpecRules: schema MonitoringCoreosComV1PrometheusSpecRulesAlert: r""" - Defines the parameters of the Prometheus rules' engine. + alert defines the parameters of the Prometheus rules' engine. Any update to these parameters trigger a restart of the pods. Attributes ---------- forGracePeriod : str, default is Undefined, optional - Minimum duration between alert and restored 'for' state. + forGracePeriod defines the minimum duration between alert and restored 'for' state. This is maintained only for alerts with a configured 'for' time greater than the grace period. forOutageTolerance : str, default is Undefined, optional - Max time to tolerate prometheus outage for restoring 'for' state of + forOutageTolerance defines the max time to tolerate prometheus outage for restoring 'for' state of alert. resendDelay : str, default is Undefined, optional - Minimum amount of time to wait before resending an alert to + resendDelay defines the minimum amount of time to wait before resending an alert to Alertmanager. """ forGracePeriod?: str @@ -7838,12 +8163,12 @@ schema MonitoringCoreosComV1PrometheusSpecRulesAlert: schema MonitoringCoreosComV1PrometheusSpecRuntime: r""" - RuntimeConfig configures the values for the Prometheus process behavior + runtime defines the values for the Prometheus process behavior Attributes ---------- goGC : int, default is Undefined, optional - The Go garbage collection target percentage. Lowering this number may increase the CPU usage. + goGC defines the Go garbage collection target percentage. Lowering this number may increase the CPU usage. See: https://tip.golang.org/doc/gc-guide#GOGC """ goGC?: int @@ -7862,17 +8187,17 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0: authorization : MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0Authorization, default is Undefined, optional authorization default : bool, default is Undefined, optional - Default indicates that the scrape applies to all scrape objects that + default defines that the scrape applies to all scrape objects that don't configure an explicit scrape class name. Only one scrape class can be set as the default. fallbackScrapeProtocol : str, default is Undefined, optional - The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. + fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It will only apply if the scrape resource doesn't specify any FallbackScrapeProtocol It requires Prometheus >= v3.0.0. metricRelabelings : [MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0MetricRelabelingsItems0], default is Undefined, optional - MetricRelabelings configures the relabeling rules to apply to all samples before ingestion. + metricRelabelings defines the relabeling rules to apply to all samples before ingestion. The Operator adds the scrape class metric relabelings defined here. Then the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs. @@ -7880,9 +8205,9 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0: More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs name : str, default is Undefined, required - Name of the scrape class. + name of the scrape class. relabelings : [MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0RelabelingsItems0], default is Undefined, optional - Relabelings configures the relabeling rules to apply to all scrape targets. + relabelings defines the relabeling rules to apply to all scrape targets. The Operator automatically adds relabelings for a few standard Kubernetes fields like `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`. @@ -7908,14 +8233,14 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0: schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0AttachMetadata: r""" - AttachMetadata configures additional metadata to the discovered targets. + attachMetadata defines additional metadata to the discovered targets. When the scrape object defines its own configuration, it takes precedence over the scrape class configuration. Attributes ---------- node : bool, default is Undefined, optional - When set to true, Prometheus attaches node metadata to the discovered + node when set to true, Prometheus attaches node metadata to the discovered targets. The Prometheus service account must have the `list` and `watch` @@ -7925,7 +8250,7 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0AttachMetadata: schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0Authorization: r""" - Authorization section for the ScrapeClass. + authorization section for the ScrapeClass. It will only apply if the scrape resource doesn't specify any Authorization. Attributes @@ -7933,9 +8258,9 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0Authorization: credentials : MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0AuthorizationCredentials, default is Undefined, optional credentials credentialsFile : str, default is Undefined, optional - File to read a secret from, mutually exclusive with `credentials`. + credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -7947,7 +8272,7 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0Authorization: schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -7977,31 +8302,31 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0MetricRelabelingsIt Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -8016,9 +8341,6 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0MetricRelabelingsIt sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0RelabelingsItems0: r""" RelabelConfig allows dynamic rewriting of the label set for targets, alerts, @@ -8029,31 +8351,31 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0RelabelingsItems0: Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -8068,12 +8390,9 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0RelabelingsItems0: sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfig: r""" - TLSConfig defines the TLS settings to use for the scrape. When the + tlsConfig defines the TLS settings to use for the scrape. When the scrape objects define their own CA, certificate and/or key, they take precedence over the corresponding scrape class fields. @@ -8084,27 +8403,27 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfig: ca : MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCa, default is Undefined, optional ca caFile : str, default is Undefined, optional - Path to the CA cert in the Prometheus container to use for the targets. + caFile defines the path to the CA cert in the Prometheus container to use for the targets. cert : MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the client cert file in the Prometheus container for the targets. + certFile defines the path to the client cert file in the Prometheus container for the targets. insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keyFile : str, default is Undefined, optional - Path to the client key file in the Prometheus container for the targets. + keyFile defines the path to the client key file in the Prometheus container for the targets. keySecret : MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCa caFile?: str @@ -8119,7 +8438,7 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfig: schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -8133,7 +8452,7 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCa: schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8155,7 +8474,7 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCaConfigMa schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8177,7 +8496,7 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCaSecret: schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -8191,7 +8510,7 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCert: schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8213,7 +8532,7 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCertConfig schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8235,7 +8554,7 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigCertSecret schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -8257,7 +8576,7 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeClassesItems0TLSConfigKeySecret: schema MonitoringCoreosComV1PrometheusSpecScrapeConfigNamespaceSelector: r""" - Namespaces to match for ScrapeConfig discovery. An empty label selector + scrapeConfigNamespaceSelector defines the namespaces to match for ScrapeConfig discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only. @@ -8301,7 +8620,7 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeConfigNamespaceSelectorMatchExpr schema MonitoringCoreosComV1PrometheusSpecScrapeConfigSelector: r""" - ScrapeConfigs to be selected for target discovery. An empty label + scrapeConfigSelector defines the scrapeConfigs to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -8353,7 +8672,7 @@ schema MonitoringCoreosComV1PrometheusSpecScrapeConfigSelectorMatchExpressionsIt schema MonitoringCoreosComV1PrometheusSpecSecurityContext: r""" - SecurityContext holds pod-level security attributes and common container settings. + securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext. Attributes @@ -8583,7 +8902,7 @@ schema MonitoringCoreosComV1PrometheusSpecSecurityContextWindowsOptions: schema MonitoringCoreosComV1PrometheusSpecServiceMonitorNamespaceSelector: r""" - Namespaces to match for ServicedMonitors discovery. An empty label selector + serviceMonitorNamespaceSelector defines the namespaces to match for ServicedMonitors discovery. An empty label selector matches all namespaces. A null label selector (default value) matches the current namespace only. @@ -8625,7 +8944,7 @@ schema MonitoringCoreosComV1PrometheusSpecServiceMonitorNamespaceSelectorMatchEx schema MonitoringCoreosComV1PrometheusSpecServiceMonitorSelector: r""" - ServiceMonitors to be selected for target discovery. An empty label + serviceMonitorSelector defines the serviceMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -8673,14 +8992,52 @@ schema MonitoringCoreosComV1PrometheusSpecServiceMonitorSelectorMatchExpressions values?: [str] +schema MonitoringCoreosComV1PrometheusSpecShardRetentionPolicy: + r""" + shardRetentionPolicy defines the retention policy for the Prometheus shards. + (Alpha) Using this field requires the 'PrometheusShardRetentionPolicy' feature gate to be enabled. + + The final goals for this feature can be seen at https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/proposals/202310-shard-autoscaling.md#graceful-scale-down-of-prometheus-servers, + however, the feature is not yet fully implemented in this PR. The limitation being: + * Retention duration is not settable, for now, shards are retained forever. + + Attributes + ---------- + retain : MonitoringCoreosComV1PrometheusSpecShardRetentionPolicyRetain, default is Undefined, optional + retain + whenScaled : str, default is Undefined, optional + whenScaled defines the retention policy when the Prometheus shards are scaled down. + * `Delete`, the operator will delete the pods from the scaled-down shard(s). + * `Retain`, the operator will keep the pods from the scaled-down shard(s), so the data can still be queried. + + If not defined, the operator assumes the `Delete` value. + """ + retain?: MonitoringCoreosComV1PrometheusSpecShardRetentionPolicyRetain + whenScaled?: "Retain" | "Delete" + +schema MonitoringCoreosComV1PrometheusSpecShardRetentionPolicyRetain: + r""" + retain defines the config for retention when the retention policy is set to `Retain`. + This field is ineffective as of now. + + Attributes + ---------- + retentionPeriod : str, default is Undefined, required + retentionPeriod defines the retentionPeriod for shard retention policy. + """ + retentionPeriod: str + + check: + _regex_match(str(retentionPeriod), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") + schema MonitoringCoreosComV1PrometheusSpecStorage: r""" - Storage defines the storage used by Prometheus. + storage defines the storage used by Prometheus. Attributes ---------- disableMountSubPath : bool, default is Undefined, optional - Deprecated: subPath usage will be removed in a future release. + disableMountSubPath deprecated: subPath usage will be removed in a future release. emptyDir : MonitoringCoreosComV1PrometheusSpecStorageEmptyDir, default is Undefined, optional empty dir ephemeral : MonitoringCoreosComV1PrometheusSpecStorageEphemeral, default is Undefined, optional @@ -8695,7 +9052,7 @@ schema MonitoringCoreosComV1PrometheusSpecStorage: schema MonitoringCoreosComV1PrometheusSpecStorageEmptyDir: r""" - EmptyDirVolumeSource to be used by the StatefulSet. + emptyDir to be used by the StatefulSet. If specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir @@ -8722,7 +9079,7 @@ schema MonitoringCoreosComV1PrometheusSpecStorageEmptyDir: schema MonitoringCoreosComV1PrometheusSpecStorageEphemeral: r""" - EphemeralVolumeSource to be used by the StatefulSet. + ephemeral to be used by the StatefulSet. This is a beta field in k8s 1.21 and GA in 1.15. For lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes @@ -8797,15 +9154,13 @@ schema MonitoringCoreosComV1PrometheusSpecStorageEphemeralVolumeClaimTemplateSpe volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, - it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass - will be applied to the claim but it's not allowed to reset this field to empty string once it is set. - If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass - will be set by the persistentvolume controller if it exists. + it can be changed after the claim is created. An empty string or nil value indicates that no + VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, + this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ - (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). volumeMode : str, default is Undefined, optional volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. @@ -8965,7 +9320,7 @@ schema MonitoringCoreosComV1PrometheusSpecStorageEphemeralVolumeClaimTemplateSpe schema MonitoringCoreosComV1PrometheusSpecStorageVolumeClaimTemplate: r""" - Defines the PVC spec to be used by the Prometheus StatefulSets. + volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets. The easiest way to use a volume that cannot be automatically provisioned is to use a label selector alongside manually created PersistentVolumes. @@ -8997,27 +9352,27 @@ schema MonitoringCoreosComV1PrometheusSpecStorageVolumeClaimTemplate: schema MonitoringCoreosComV1PrometheusSpecStorageVolumeClaimTemplateMetadata: r""" - EmbeddedMetadata contains metadata relevant to an EmbeddedResource. + metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource. Attributes ---------- annotations : {str:str}, default is Undefined, optional - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. - More info: http://kubernetes.io/docs/user-guide/annotations + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ labels : {str:str}, default is Undefined, optional - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. - More info: http://kubernetes.io/docs/user-guide/labels + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ name : str, default is Undefined, optional - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. - More info: http://kubernetes.io/docs/user-guide/identifiers#names + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/ """ annotations?: {str:str} labels?: {str:str} @@ -9025,7 +9380,7 @@ schema MonitoringCoreosComV1PrometheusSpecStorageVolumeClaimTemplateMetadata: schema MonitoringCoreosComV1PrometheusSpecStorageVolumeClaimTemplateSpec: r""" - Defines the desired characteristics of a volume requested by a pod author. + spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims Attributes @@ -9048,15 +9403,13 @@ schema MonitoringCoreosComV1PrometheusSpecStorageVolumeClaimTemplateSpec: volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, - it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass - will be applied to the claim but it's not allowed to reset this field to empty string once it is set. - If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass - will be set by the persistentvolume controller if it exists. + it can be changed after the claim is created. An empty string or nil value indicates that no + VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, + this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ - (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). volumeMode : str, default is Undefined, optional volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. @@ -9216,7 +9569,7 @@ schema MonitoringCoreosComV1PrometheusSpecStorageVolumeClaimTemplateSpecSelector schema MonitoringCoreosComV1PrometheusSpecStorageVolumeClaimTemplateStatus: r""" - Deprecated: this field is never set. + status is deprecated: this field is never set. Attributes ---------- @@ -9290,7 +9643,6 @@ schema MonitoringCoreosComV1PrometheusSpecStorageVolumeClaimTemplateStatus: currentVolumeAttributesClassName : str, default is Undefined, optional currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim - This is a beta field and requires enabling VolumeAttributesClass feature (off by default). modifyVolumeStatus : MonitoringCoreosComV1PrometheusSpecStorageVolumeClaimTemplateStatusModifyVolumeStatus, default is Undefined, optional modify volume status phase : str, default is Undefined, optional @@ -9345,7 +9697,6 @@ schema MonitoringCoreosComV1PrometheusSpecStorageVolumeClaimTemplateStatusModify r""" ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. - This is a beta field and requires enabling VolumeAttributesClass feature (off by default). Attributes ---------- @@ -9369,21 +9720,21 @@ schema MonitoringCoreosComV1PrometheusSpecStorageVolumeClaimTemplateStatusModify schema MonitoringCoreosComV1PrometheusSpecThanos: r""" - Defines the configuration of the optional Thanos sidecar. + thanos defines the configuration of the optional Thanos sidecar. Attributes ---------- additionalArgs : [MonitoringCoreosComV1PrometheusSpecThanosAdditionalArgsItems0], default is Undefined, optional - AdditionalArgs allows setting additional arguments for the Thanos container. + additionalArgs allows setting additional arguments for the Thanos container. The arguments are passed as-is to the Thanos container which may cause issues if they are invalid or not supported the given Thanos version. In case of an argument conflict (e.g. an argument which is already set by the operator itself) or when providing an invalid argument, the reconciliation will fail and an error will be logged. baseImage : str, default is Undefined, optional - Deprecated: use 'image' instead. + baseImage is deprecated: use 'image' instead. blockSize : str, default is "2h", optional - BlockDuration controls the size of TSDB blocks produced by Prometheus. + blockSize controls the size of TSDB blocks produced by Prometheus. The default value is 2h to match the upstream Prometheus defaults. WARNING: Changing the block duration can impact the performance and @@ -9392,23 +9743,23 @@ schema MonitoringCoreosComV1PrometheusSpecThanos: set to a multiple of 120 times your longest scrape or rule interval. For example, 30s * 120 = 1h. getConfigInterval : str, default is Undefined, optional - How often to retrieve the Prometheus configuration. + getConfigInterval defines how often to retrieve the Prometheus configuration. getConfigTimeout : str, default is Undefined, optional - Maximum time to wait when retrieving the Prometheus configuration. + getConfigTimeout defines the maximum time to wait when retrieving the Prometheus configuration. grpcListenLocal : bool, default is Undefined, optional - When true, the Thanos sidecar listens on the loopback interface instead + grpcListenLocal defines when true, the Thanos sidecar listens on the loopback interface instead of the Pod IP's address for the gRPC endpoints. It has no effect if `listenLocal` is true. grpcServerTlsConfig : MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfig, default is Undefined, optional grpc server Tls config httpListenLocal : bool, default is Undefined, optional - When true, the Thanos sidecar listens on the loopback interface instead + httpListenLocal when true, the Thanos sidecar listens on the loopback interface instead of the Pod IP's address for the HTTP endpoints. It has no effect if `listenLocal` is true. image : str, default is Undefined, optional - Container image name for Thanos. If specified, it takes precedence over + image defines the container image name for Thanos. If specified, it takes precedence over the `spec.thanos.baseImage`, `spec.thanos.tag` and `spec.thanos.sha` fields. @@ -9419,37 +9770,37 @@ schema MonitoringCoreosComV1PrometheusSpecThanos: the operator will use the latest upstream version of Thanos available at the time when the operator was released. listenLocal : bool, default is Undefined, optional - Deprecated: use `grpcListenLocal` and `httpListenLocal` instead. + listenLocal is deprecated: use `grpcListenLocal` and `httpListenLocal` instead. logFormat : str, default is Undefined, optional - Log format for the Thanos sidecar. + logFormat for the Thanos sidecar. logLevel : str, default is Undefined, optional - Log level for the Thanos sidecar. + logLevel for the Thanos sidecar. minTime : str, default is Undefined, optional - Defines the start of time range limit served by the Thanos sidecar's StoreAPI. + minTime defines the start of time range limit served by the Thanos sidecar's StoreAPI. The field's value should be a constant time in RFC3339 format or a time duration relative to current time, such as -1d or 2h45m. Valid duration units are ms, s, m, h, d, w, y. objectStorageConfig : MonitoringCoreosComV1PrometheusSpecThanosObjectStorageConfig, default is Undefined, optional object storage config objectStorageConfigFile : str, default is Undefined, optional - Defines the Thanos sidecar's configuration file to upload TSDB blocks to object storage. + objectStorageConfigFile defines the Thanos sidecar's configuration file to upload TSDB blocks to object storage. More info: https://thanos.io/tip/thanos/storage.md/ This field takes precedence over objectStorageConfig. readyTimeout : str, default is Undefined, optional - ReadyTimeout is the maximum time that the Thanos sidecar will wait for + readyTimeout defines the maximum time that the Thanos sidecar will wait for Prometheus to start. resources : MonitoringCoreosComV1PrometheusSpecThanosResources, default is Undefined, optional resources sha : str, default is Undefined, optional - Deprecated: use 'image' instead. The image digest can be specified as part of the image name. + sha is deprecated: use 'image' instead. The image digest can be specified as part of the image name. tag : str, default is Undefined, optional - Deprecated: use 'image' instead. The image's tag can be specified as as part of the image name. + tag is deprecated: use 'image' instead. The image's tag can be specified as as part of the image name. tracingConfig : MonitoringCoreosComV1PrometheusSpecThanosTracingConfig, default is Undefined, optional tracing config tracingConfigFile : str, default is Undefined, optional - Defines the tracing configuration file for the Thanos sidecar. + tracingConfigFile defines the tracing configuration file for the Thanos sidecar. This field takes precedence over `tracingConfig`. @@ -9458,14 +9809,14 @@ schema MonitoringCoreosComV1PrometheusSpecThanos: This is an *experimental feature*, it may change in any upcoming release in a breaking way. version : str, default is Undefined, optional - Version of Thanos being deployed. The operator uses this information + version of Thanos being deployed. The operator uses this information to generate the Prometheus StatefulSet + configuration files. If not specified, the operator assumes the latest upstream release of Thanos available at the time when the version of the operator was released. volumeMounts : [MonitoringCoreosComV1PrometheusSpecThanosVolumeMountsItems0], default is Undefined, optional - VolumeMounts allows configuration of additional VolumeMounts for Thanos. + volumeMounts allows configuration of additional VolumeMounts for Thanos. VolumeMounts specified will be appended to other VolumeMounts in the 'thanos-sidecar' container. """ @@ -9506,9 +9857,9 @@ schema MonitoringCoreosComV1PrometheusSpecThanosAdditionalArgsItems0: Attributes ---------- name : str, default is Undefined, required - Name of the argument, e.g. "scrape.discovery-reload-interval". + name of the argument, e.g. "scrape.discovery-reload-interval". value : str, default is Undefined, optional - Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) + value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) """ name: str @@ -9519,7 +9870,7 @@ schema MonitoringCoreosComV1PrometheusSpecThanosAdditionalArgsItems0: schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfig: r""" - Configures the TLS parameters for the gRPC server providing the StoreAPI. + grpcServerTlsConfig defines the TLS parameters for the gRPC server providing the StoreAPI. Note: Currently only the `caFile`, `certFile`, and `keyFile` fields are supported. @@ -9528,27 +9879,27 @@ schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfig: ca : MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCa, default is Undefined, optional ca caFile : str, default is Undefined, optional - Path to the CA cert in the Prometheus container to use for the targets. + caFile defines the path to the CA cert in the Prometheus container to use for the targets. cert : MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the client cert file in the Prometheus container for the targets. + certFile defines the path to the client cert file in the Prometheus container for the targets. insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keyFile : str, default is Undefined, optional - Path to the client key file in the Prometheus container for the targets. + keyFile defines the path to the client key file in the Prometheus container for the targets. keySecret : MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCa caFile?: str @@ -9563,7 +9914,7 @@ schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfig: schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -9577,7 +9928,7 @@ schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCa: schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9599,7 +9950,7 @@ schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCaConfigMap: schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9621,7 +9972,7 @@ schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCaSecret: schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -9635,7 +9986,7 @@ schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCert: schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9657,7 +10008,7 @@ schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCertConfigMap schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9679,7 +10030,7 @@ schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigCertSecret: schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -9701,7 +10052,7 @@ schema MonitoringCoreosComV1PrometheusSpecThanosGrpcServerTLSConfigKeySecret: schema MonitoringCoreosComV1PrometheusSpecThanosObjectStorageConfig: r""" - Defines the Thanos sidecar's configuration to upload TSDB blocks to object storage. + objectStorageConfig defines the Thanos sidecar's configuration to upload TSDB blocks to object storage. More info: https://thanos.io/tip/thanos/storage.md/ @@ -9727,7 +10078,7 @@ schema MonitoringCoreosComV1PrometheusSpecThanosObjectStorageConfig: schema MonitoringCoreosComV1PrometheusSpecThanosResources: r""" - Defines the resources requests and limits of the Thanos sidecar. + resources defines the resources requests and limits of the Thanos sidecar. Attributes ---------- @@ -9735,7 +10086,7 @@ schema MonitoringCoreosComV1PrometheusSpecThanosResources: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. - This is an alpha field and requires enabling the + This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. @@ -9777,7 +10128,7 @@ schema MonitoringCoreosComV1PrometheusSpecThanosResourcesClaimsItems0: schema MonitoringCoreosComV1PrometheusSpecThanosTracingConfig: r""" - Defines the tracing configuration for the Thanos sidecar. + tracingConfig defines the tracing configuration for the Thanos sidecar. `tracingConfigFile` takes precedence over this field. @@ -9901,7 +10252,7 @@ schema MonitoringCoreosComV1PrometheusSpecTopologySpreadConstraintsItems0: Attributes ---------- additionalLabelSelectors : str, default is Undefined, optional - Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint. + additionalLabelSelectors Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint. labelSelector : MonitoringCoreosComV1PrometheusSpecTopologySpreadConstraintsItems0LabelSelector, default is Undefined, optional label selector matchLabelKeys : [str], default is Undefined, optional @@ -9960,7 +10311,6 @@ schema MonitoringCoreosComV1PrometheusSpecTopologySpreadConstraintsItems0: - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. If this value is nil, the behavior is equivalent to the Honor policy. - This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. nodeTaintsPolicy : str, default is Undefined, optional NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: @@ -9969,7 +10319,6 @@ schema MonitoringCoreosComV1PrometheusSpecTopologySpreadConstraintsItems0: - Ignore: node taints are ignored. All nodes are included. If this value is nil, the behavior is equivalent to the Ignore policy. - This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. topologyKey : str, default is Undefined, required TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. @@ -10057,7 +10406,7 @@ schema MonitoringCoreosComV1PrometheusSpecTopologySpreadConstraintsItems0LabelSe schema MonitoringCoreosComV1PrometheusSpecTracingConfig: r""" - TracingConfig configures tracing in Prometheus. + tracingConfig defines tracing in Prometheus. This is an *experimental feature*, it may change in any upcoming release in a breaking way. @@ -10065,19 +10414,19 @@ schema MonitoringCoreosComV1PrometheusSpecTracingConfig: Attributes ---------- clientType : str, default is Undefined, optional - Client used to export the traces. Supported values are `http` or `grpc`. + clientType defines the client used to export the traces. Supported values are `http` or `grpc`. compression : str, default is Undefined, optional - Compression key for supported compression types. The only supported value is `gzip`. + compression key for supported compression types. The only supported value is `gzip`. endpoint : str, default is Undefined, required - Endpoint to send the traces to. Should be provided in format :. + endpoint to send the traces to. Should be provided in format :. headers : {str:str}, default is Undefined, optional - Key-value pairs to be used as headers associated with gRPC or HTTP requests. + headers defines the key-value pairs to be used as headers associated with gRPC or HTTP requests. insecure : bool, default is Undefined, optional - If disabled, the client will use a secure connection. + insecure if disabled, the client will use a secure connection. samplingFraction : int | str, default is Undefined, optional - Sets the probability a given trace will be sampled. Must be a float from 0 through 1. + samplingFraction defines the probability a given trace will be sampled. Must be a float from 0 through 1. timeout : str, default is Undefined, optional - Maximum time the exporter will wait for each batch export. + timeout defines the maximum time the exporter will wait for each batch export. tlsConfig : MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfig, default is Undefined, optional tls config """ @@ -10098,34 +10447,34 @@ schema MonitoringCoreosComV1PrometheusSpecTracingConfig: schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfig: r""" - TLS Config to use when sending traces. + tlsConfig to use when sending traces. Attributes ---------- ca : MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCa, default is Undefined, optional ca caFile : str, default is Undefined, optional - Path to the CA cert in the Prometheus container to use for the targets. + caFile defines the path to the CA cert in the Prometheus container to use for the targets. cert : MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the client cert file in the Prometheus container for the targets. + certFile defines the path to the client cert file in the Prometheus container for the targets. insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keyFile : str, default is Undefined, optional - Path to the client key file in the Prometheus container for the targets. + keyFile defines the path to the client key file in the Prometheus container for the targets. keySecret : MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCa caFile?: str @@ -10140,7 +10489,7 @@ schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfig: schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -10154,7 +10503,7 @@ schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCa: schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10176,7 +10525,7 @@ schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCaConfigMap: schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10198,7 +10547,7 @@ schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCaSecret: schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -10212,7 +10561,7 @@ schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCert: schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10234,7 +10583,7 @@ schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCertConfigMap: schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10256,7 +10605,7 @@ schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigCertSecret: schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -10278,13 +10627,13 @@ schema MonitoringCoreosComV1PrometheusSpecTracingConfigTLSConfigKeySecret: schema MonitoringCoreosComV1PrometheusSpecTsdb: r""" - Defines the runtime reloadable configuration of the timeseries database(TSDB). + tsdb defines the runtime reloadable configuration of the timeseries database(TSDB). It requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0. Attributes ---------- outOfOrderTimeWindow : str, default is Undefined, optional - Configures how old an out-of-order/out-of-bounds sample can be with + outOfOrderTimeWindow defines how old an out-of-order/out-of-bounds sample can be with respect to the TSDB max time. An out-of-order/out-of-bounds sample is ingested into the TSDB as long as @@ -10956,15 +11305,13 @@ schema MonitoringCoreosComV1PrometheusSpecVolumesItems0EphemeralVolumeClaimTempl volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, - it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass - will be applied to the claim but it's not allowed to reset this field to empty string once it is set. - If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass - will be set by the persistentvolume controller if it exists. + it can be changed after the claim is created. An empty string or nil value indicates that no + VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, + this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ - (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). volumeMode : str, default is Undefined, optional volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. @@ -11276,13 +11623,11 @@ schema MonitoringCoreosComV1PrometheusSpecVolumesItems0Glusterfs: r""" glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. - More info: https://examples.k8s.io/volumes/glusterfs/README.md Attributes ---------- endpoints : str, default is Undefined, required endpoints is the endpoint name that details Glusterfs topology. - More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod path : str, default is Undefined, required path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod @@ -11334,7 +11679,7 @@ schema MonitoringCoreosComV1PrometheusSpecVolumesItems0Image: The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). - Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath). + Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type. Attributes @@ -11360,7 +11705,7 @@ schema MonitoringCoreosComV1PrometheusSpecVolumesItems0Iscsi: r""" iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. - More info: https://examples.k8s.io/volumes/iscsi/README.md + More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi Attributes ---------- @@ -11540,6 +11885,8 @@ schema MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0: config map downwardAPI : MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0DownwardAPI, default is Undefined, optional downward API + podCertificate : MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0PodCertificate, default is Undefined, optional + pod certificate secret : MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0Secret, default is Undefined, optional secret serviceAccountToken : MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0ServiceAccountToken, default is Undefined, optional @@ -11548,6 +11895,7 @@ schema MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0: clusterTrustBundle?: MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0ClusterTrustBundle configMap?: MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0ConfigMap downwardAPI?: MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0DownwardAPI + podCertificate?: MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0PodCertificate secret?: MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0Secret serviceAccountToken?: MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0ServiceAccountToken @@ -11762,6 +12110,105 @@ schema MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0Dow check: _regex_match(str(divisor), r"^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$") if divisor +schema MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0PodCertificate: + r""" + Projects an auto-rotating credential bundle (private key and certificate + chain) that the pod can use either as a TLS client or server. + + Kubelet generates a private key and uses it to send a + PodCertificateRequest to the named signer. Once the signer approves the + request and issues a certificate chain, Kubelet writes the key and + certificate chain to the pod filesystem. The pod does not start until + certificates have been issued for each podCertificate projected volume + source in its spec. + + Kubelet will begin trying to rotate the certificate at the time indicated + by the signer using the PodCertificateRequest.Status.BeginRefreshAt + timestamp. + + Kubelet can write a single file, indicated by the credentialBundlePath + field, or separate files, indicated by the keyPath and + certificateChainPath fields. + + The credential bundle is a single file in PEM format. The first PEM + entry is the private key (in PKCS#8 format), and the remaining PEM + entries are the certificate chain issued by the signer (typically, + signers will return their certificate chain in leaf-to-root order). + + Prefer using the credential bundle format, since your application code + can read it atomically. If you use keyPath and certificateChainPath, + your application must make two separate file reads. If these coincide + with a certificate rotation, it is possible that the private key and leaf + certificate you read may not correspond to each other. Your application + will need to check for this condition, and re-read until they are + consistent. + + The named signer controls chooses the format of the certificate it + issues; consult the signer implementation's documentation to learn how to + use the certificates it issues. + + Attributes + ---------- + certificateChainPath : str, default is Undefined, optional + Write the certificate chain at this path in the projected volume. + + Most applications should use credentialBundlePath. When using keyPath + and certificateChainPath, your application needs to check that the key + and leaf certificate are consistent, because it is possible to read the + files mid-rotation. + credentialBundlePath : str, default is Undefined, optional + Write the credential bundle at this path in the projected volume. + + The credential bundle is a single file that contains multiple PEM blocks. + The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private + key. + + The remaining blocks are CERTIFICATE blocks, containing the issued + certificate chain from the signer (leaf and any intermediates). + + Using credentialBundlePath lets your Pod's application code make a single + atomic read that retrieves a consistent key and certificate chain. If you + project them to separate files, your application code will need to + additionally check that the leaf certificate was issued to the key. + keyPath : str, default is Undefined, optional + Write the key at this path in the projected volume. + + Most applications should use credentialBundlePath. When using keyPath + and certificateChainPath, your application needs to check that the key + and leaf certificate are consistent, because it is possible to read the + files mid-rotation. + keyType : str, default is Undefined, required + The type of keypair Kubelet will generate for the pod. + + Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", + "ECDSAP521", and "ED25519". + maxExpirationSeconds : int, default is Undefined, optional + maxExpirationSeconds is the maximum lifetime permitted for the + certificate. + + Kubelet copies this value verbatim into the PodCertificateRequests it + generates for this projection. + + If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver + will reject values shorter than 3600 (1 hour). The maximum allowable + value is 7862400 (91 days). + + The signer implementation is then free to issue a certificate with any + lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600 + seconds (1 hour). This constraint is enforced by kube-apiserver. + `kubernetes.io` signers will never issue certificates with a lifetime + longer than 24 hours. + signerName : str, default is Undefined, required + Kubelet's generated CSRs will be addressed to this signer. + """ + certificateChainPath?: str + credentialBundlePath?: str + keyPath?: str + keyType: str + + maxExpirationSeconds?: int + signerName: str + schema MonitoringCoreosComV1PrometheusSpecVolumesItems0ProjectedSourcesItems0Secret: r""" secret information about the secret data to project @@ -11879,7 +12326,6 @@ schema MonitoringCoreosComV1PrometheusSpecVolumesItems0Rbd: r""" rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. - More info: https://examples.k8s.io/volumes/rbd/README.md Attributes ---------- @@ -12141,17 +12587,17 @@ schema MonitoringCoreosComV1PrometheusSpecVolumesItems0VsphereVolume: schema MonitoringCoreosComV1PrometheusSpecWeb: r""" - Defines the configuration of the Prometheus web server. + web defines the configuration of the Prometheus web server. Attributes ---------- httpConfig : MonitoringCoreosComV1PrometheusSpecWebHTTPConfig, default is Undefined, optional http config maxConnections : int, default is Undefined, optional - Defines the maximum number of simultaneous connections + maxConnections defines the maximum number of simultaneous connections A zero value means that Prometheus doesn't accept any incoming connection. pageTitle : str, default is Undefined, optional - The prometheus web page title. + pageTitle defines the prometheus web page title. tlsConfig : MonitoringCoreosComV1PrometheusSpecWebTLSConfig, default is Undefined, optional tls config """ @@ -12165,14 +12611,14 @@ schema MonitoringCoreosComV1PrometheusSpecWeb: schema MonitoringCoreosComV1PrometheusSpecWebHTTPConfig: r""" - Defines HTTP parameters for web server. + httpConfig defines HTTP parameters for web server. Attributes ---------- headers : MonitoringCoreosComV1PrometheusSpecWebHTTPConfigHeaders, default is Undefined, optional headers http2 : bool, default is Undefined, optional - Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. + http2 enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. When TLSConfig is not configured, HTTP/2 will be disabled. Whenever the value of the field changes, a rolling update will be triggered. """ @@ -12181,30 +12627,30 @@ schema MonitoringCoreosComV1PrometheusSpecWebHTTPConfig: schema MonitoringCoreosComV1PrometheusSpecWebHTTPConfigHeaders: r""" - List of headers that can be added to HTTP responses. + headers defines a list of headers that can be added to HTTP responses. Attributes ---------- contentSecurityPolicy : str, default is Undefined, optional - Set the Content-Security-Policy header to HTTP responses. + contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank. strictTransportSecurity : str, default is Undefined, optional - Set the Strict-Transport-Security header to HTTP responses. + strictTransportSecurity defines the Strict-Transport-Security header to HTTP responses. Unset if blank. Please make sure that you use this with care as this header might force browsers to load Prometheus and the other applications hosted on the same domain and subdomains over HTTPS. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security xContentTypeOptions : str, default is Undefined, optional - Set the X-Content-Type-Options header to HTTP responses. + xContentTypeOptions defines the X-Content-Type-Options header to HTTP responses. Unset if blank. Accepted value is nosniff. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options xFrameOptions : str, default is Undefined, optional - Set the X-Frame-Options header to HTTP responses. + xFrameOptions defines the X-Frame-Options header to HTTP responses. Unset if blank. Accepted values are deny and sameorigin. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options xXSSProtection : str, default is Undefined, optional - Set the X-XSS-Protection header to all responses. + xXSSProtection defines the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection """ @@ -12216,44 +12662,44 @@ schema MonitoringCoreosComV1PrometheusSpecWebHTTPConfigHeaders: schema MonitoringCoreosComV1PrometheusSpecWebTLSConfig: r""" - Defines the TLS parameters for HTTPS. + tlsConfig defines the TLS parameters for HTTPS. Attributes ---------- cert : MonitoringCoreosComV1PrometheusSpecWebTLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the TLS certificate file in the container for the web server. + certFile defines the path to the TLS certificate file in the container for the web server. Either `keySecret` or `keyFile` must be defined. It is mutually exclusive with `cert`. cipherSuites : [str], default is Undefined, optional - List of supported cipher suites for TLS versions up to TLS 1.2. + cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2. If not defined, the Go default cipher suites are used. Available cipher suites are documented in the Go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants clientAuthType : str, default is Undefined, optional - The server policy for client TLS authentication. + clientAuthType defines the server policy for client TLS authentication. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType clientCAFile : str, default is Undefined, optional - Path to the CA certificate file for client certificate authentication to + clientCAFile defines the path to the CA certificate file for client certificate authentication to the server. It is mutually exclusive with `client_ca`. client_ca : MonitoringCoreosComV1PrometheusSpecWebTLSConfigClientCa, default is Undefined, optional client ca curvePreferences : [str], default is Undefined, optional - Elliptic curves that will be used in an ECDHE handshake, in preference + curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the Go documentation: https://golang.org/pkg/crypto/tls/#CurveID keyFile : str, default is Undefined, optional - Path to the TLS private key file in the container for the web server. + keyFile defines the path to the TLS private key file in the container for the web server. If defined, either `cert` or `certFile` must be defined. @@ -12261,11 +12707,11 @@ schema MonitoringCoreosComV1PrometheusSpecWebTLSConfig: keySecret : MonitoringCoreosComV1PrometheusSpecWebTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum TLS version that is acceptable. + maxVersion defines the Maximum TLS version that is acceptable. minVersion : str, default is Undefined, optional - Minimum TLS version that is acceptable. + minVersion defines the minimum TLS version that is acceptable. preferServerCipherSuites : bool, default is Undefined, optional - Controls whether the server selects the client's most preferred cipher + preferServerCipherSuites defines whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in @@ -12286,7 +12732,7 @@ schema MonitoringCoreosComV1PrometheusSpecWebTLSConfig: schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigCert: r""" - Secret or ConfigMap containing the TLS certificate for the web server. + cert defines the Secret or ConfigMap containing the TLS certificate for the web server. Either `keySecret` or `keyFile` must be defined. @@ -12304,7 +12750,7 @@ schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigCert: schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -12326,7 +12772,7 @@ schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigCertConfigMap: schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -12348,7 +12794,7 @@ schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigCertSecret: schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigClientCa: r""" - Secret or ConfigMap containing the CA certificate for client certificate + client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server. It is mutually exclusive with `clientCAFile`. @@ -12365,7 +12811,7 @@ schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigClientCa: schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigClientCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -12387,7 +12833,7 @@ schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigClientCaConfigMap: schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigClientCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -12409,7 +12855,7 @@ schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigClientCaSecret: schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigKeySecret: r""" - Secret containing the TLS private key for the web server. + keySecret defines the secret containing the TLS private key for the web server. Either `cert` or `certFile` must be defined. @@ -12435,48 +12881,44 @@ schema MonitoringCoreosComV1PrometheusSpecWebTLSConfigKeySecret: schema MonitoringCoreosComV1PrometheusStatus: r""" - Most recent observed status of the Prometheus cluster. Read-only. + status defines the most recent observed status of the Prometheus cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Attributes ---------- - availableReplicas : int, default is Undefined, required - Total number of available pods (ready for at least minReadySeconds) + availableReplicas : int, default is Undefined, optional + availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this Prometheus deployment. conditions : [MonitoringCoreosComV1PrometheusStatusConditionsItems0], default is Undefined, optional - The current state of the Prometheus deployment. - paused : bool, default is Undefined, required - Represents whether any actions on the underlying managed objects are + conditions defines the current state of the Prometheus deployment. + paused : bool, default is Undefined, optional + paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed. - replicas : int, default is Undefined, required - Total number of non-terminated pods targeted by this Prometheus deployment + replicas : int, default is Undefined, optional + replicas defines the total number of non-terminated pods targeted by this Prometheus deployment (their labels match the selector). selector : str, default is Undefined, optional - The selector used to match the pods targeted by this Prometheus resource. + selector used to match the pods targeted by this Prometheus resource. shardStatuses : [MonitoringCoreosComV1PrometheusStatusShardStatusesItems0], default is Undefined, optional - The list has one entry per shard. Each entry provides a summary of the shard status. + shardStatuses defines the list has one entry per shard. Each entry provides a summary of the shard status. shards : int, default is Undefined, optional - Shards is the most recently observed number of shards. - unavailableReplicas : int, default is Undefined, required - Total number of unavailable pods targeted by this Prometheus deployment. - updatedReplicas : int, default is Undefined, required - Total number of non-terminated pods targeted by this Prometheus deployment + shards defines the most recently observed number of shards. + unavailableReplicas : int, default is Undefined, optional + unavailableReplicas defines the total number of unavailable pods targeted by this Prometheus deployment. + updatedReplicas : int, default is Undefined, optional + updatedReplicas defines the total number of non-terminated pods targeted by this Prometheus deployment that have the desired version spec. """ - availableReplicas: int - + availableReplicas?: int conditions?: [MonitoringCoreosComV1PrometheusStatusConditionsItems0] - paused: bool - - replicas: int - + paused?: bool + replicas?: int selector?: str shardStatuses?: [MonitoringCoreosComV1PrometheusStatusShardStatusesItems0] shards?: int - unavailableReplicas: int - - updatedReplicas: int + unavailableReplicas?: int + updatedReplicas?: int schema MonitoringCoreosComV1PrometheusStatusConditionsItems0: r""" @@ -12488,19 +12930,19 @@ schema MonitoringCoreosComV1PrometheusStatusConditionsItems0: lastTransitionTime : str, default is Undefined, required lastTransitionTime is the time of the last update to the current status property. message : str, default is Undefined, optional - Human-readable message indicating details for the condition's last transition. + message defines human-readable message indicating details for the condition's last transition. observedGeneration : int, default is Undefined, optional - ObservedGeneration represents the .metadata.generation that the + observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if `.metadata.generation` is currently 12, but the `.status.conditions[].observedGeneration` is 9, the condition is out of date with respect to the current state of the instance. reason : str, default is Undefined, optional - Reason for the condition's last transition. + reason for the condition's last transition. status : str, default is Undefined, required - Status of the condition. + status of the condition. $type : str, default is Undefined, required - Type of the condition being reported. + type of the condition being reported. """ lastTransitionTime: str @@ -12522,16 +12964,16 @@ schema MonitoringCoreosComV1PrometheusStatusShardStatusesItems0: Attributes ---------- availableReplicas : int, default is Undefined, required - Total number of available pods (ready for at least minReadySeconds) + availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this shard. replicas : int, default is Undefined, required - Total number of pods targeted by this shard. + replicas defines the total number of pods targeted by this shard. shardID : str, default is Undefined, required - Identifier of the shard. + shardID defines the identifier of the shard. unavailableReplicas : int, default is Undefined, required - Total number of unavailable pods targeted by this shard. + unavailableReplicas defines the Total number of unavailable pods targeted by this shard. updatedReplicas : int, default is Undefined, required - Total number of non-terminated pods targeted by this shard + updatedReplicas defines the total number of non-terminated pods targeted by this shard that have the desired spec. """ availableReplicas: int diff --git a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_prometheus_rule.k b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_prometheus_rule.k index 2f0f5c8a..74f6b87e 100644 --- a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_prometheus_rule.k +++ b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_prometheus_rule.k @@ -24,6 +24,8 @@ schema PrometheusRule: metadata spec : MonitoringCoreosComV1PrometheusRuleSpec, default is Undefined, required spec + status : MonitoringCoreosComV1PrometheusRuleStatus, default is Undefined, optional + status """ apiVersion: "monitoring.coreos.com/v1" = "monitoring.coreos.com/v1" @@ -32,14 +34,16 @@ schema PrometheusRule: metadata?: v1.ObjectMeta spec: MonitoringCoreosComV1PrometheusRuleSpec + status?: MonitoringCoreosComV1PrometheusRuleStatus + schema MonitoringCoreosComV1PrometheusRuleSpec: r""" - Specification of desired alerting rule definitions for Prometheus. + spec defines the specification of desired alerting rule definitions for Prometheus. Attributes ---------- groups : [MonitoringCoreosComV1PrometheusRuleSpecGroupsItems0], default is Undefined, optional - Content of Prometheus rule file + groups defines the content of Prometheus rule file """ groups?: [MonitoringCoreosComV1PrometheusRuleSpecGroupsItems0] @@ -50,30 +54,30 @@ schema MonitoringCoreosComV1PrometheusRuleSpecGroupsItems0: Attributes ---------- interval : str, default is Undefined, optional - Interval determines how often rules in the group are evaluated. + interval defines how often rules in the group are evaluated. labels : {str:str}, default is Undefined, optional - Labels to add or overwrite before storing the result for its rules. + labels define the labels to add or overwrite before storing the result for its rules. The labels defined at the rule level take precedence. It requires Prometheus >= 3.0.0. The field is ignored for Thanos Ruler. limit : int, default is Undefined, optional - Limit the number of alerts an alerting rule and series a recording + limit defines the number of alerts an alerting rule and series a recording rule can produce. Limit is supported starting with Prometheus >= 2.31 and Thanos Ruler >= 0.24. name : str, default is Undefined, required - Name of the rule group. + name defines the name of the rule group. partial_response_strategy : str, default is Undefined, optional - PartialResponseStrategy is only used by ThanosRuler and will + partial_response_strategy is only used by ThanosRuler and will be ignored by Prometheus instances. More info: https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md#partial-response query_offset : str, default is Undefined, optional - Defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past. + query_offset defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past. It requires Prometheus >= v2.53.0. It is not supported for ThanosRuler. rules : [MonitoringCoreosComV1PrometheusRuleSpecGroupsItems0RulesItems0], default is Undefined, optional - List of alerting and recording rules. + rules defines the list of alerting and recording rules. """ interval?: str labels?: {str:str} @@ -98,21 +102,21 @@ schema MonitoringCoreosComV1PrometheusRuleSpecGroupsItems0RulesItems0: Attributes ---------- alert : str, default is Undefined, optional - Name of the alert. Must be a valid label value. + alert defines the name of the alert. Must be a valid label value. Only one of `record` and `alert` must be set. annotations : {str:str}, default is Undefined, optional - Annotations to add to each alert. + annotations defines annotations to add to each alert. Only valid for alerting rules. expr : int | str, default is Undefined, required - PromQL expression to evaluate. + expr defines the PromQL expression to evaluate. $for : str, default is Undefined, optional - Alerts are considered firing once they have been returned for this long. + for defines how alerts are considered firing once they have been returned for this long. keep_firing_for : str, default is Undefined, optional - KeepFiringFor defines how long an alert will continue firing after the condition that triggered it has cleared. + keep_firing_for defines how long an alert will continue firing after the condition that triggered it has cleared. labels : {str:str}, default is Undefined, optional - Labels to add or overwrite. + labels defines labels to add or overwrite. record : str, default is Undefined, optional - Name of the time series to output to. Must be a valid metric name. + record defines the name of the time series to output to. Must be a valid metric name. Only one of `record` and `alert` must be set. """ alert?: str @@ -129,3 +133,85 @@ schema MonitoringCoreosComV1PrometheusRuleSpecGroupsItems0RulesItems0: len(keep_firing_for) >= 1 if keep_firing_for _regex_match(str(keep_firing_for), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if keep_firing_for +schema MonitoringCoreosComV1PrometheusRuleStatus: + r""" + status defines the status subresource. It is under active development and is updated only when the + "StatusForConfigurationResources" feature gate is enabled. + + Most recent observed status of the PrometheusRule. Read-only. + More info: + https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + + Attributes + ---------- + bindings : [MonitoringCoreosComV1PrometheusRuleStatusBindingsItems0], default is Undefined, optional + bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource. + """ + bindings?: [MonitoringCoreosComV1PrometheusRuleStatusBindingsItems0] + +schema MonitoringCoreosComV1PrometheusRuleStatusBindingsItems0: + r""" + WorkloadBinding is a link between a configuration resource and a workload resource. + + Attributes + ---------- + conditions : [MonitoringCoreosComV1PrometheusRuleStatusBindingsItems0ConditionsItems0], default is Undefined, optional + conditions defines the current state of the configuration resource when bound to the referenced Workload object. + group : str, default is Undefined, required + group defines the group of the referenced resource. + name : str, default is Undefined, required + name defines the name of the referenced object. + namespace : str, default is Undefined, required + namespace defines the namespace of the referenced object. + resource : str, default is Undefined, required + resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager). + """ + conditions?: [MonitoringCoreosComV1PrometheusRuleStatusBindingsItems0ConditionsItems0] + group: "monitoring.coreos.com" + + name: str + + namespace: str + + resource: "prometheuses" | "prometheusagents" | "thanosrulers" | "alertmanagers" + + check: + len(name) >= 1 + len(namespace) >= 1 + +schema MonitoringCoreosComV1PrometheusRuleStatusBindingsItems0ConditionsItems0: + r""" + ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler. + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, required + lastTransitionTime defines the time of the last update to the current status property. + message : str, default is Undefined, optional + message defines the human-readable message indicating details for the condition's last transition. + observedGeneration : int, default is Undefined, optional + observedGeneration defines the .metadata.generation that the + condition was set based upon. For instance, if `.metadata.generation` is + currently 12, but the `.status.conditions[].observedGeneration` is 9, the + condition is out of date with respect to the current state of the object. + reason : str, default is Undefined, optional + reason for the condition's last transition. + status : str, default is Undefined, required + status of the condition. + $type : str, default is Undefined, required + type of the condition being reported. + Currently, only "Accepted" is supported. + """ + lastTransitionTime: str + + message?: str + observedGeneration?: int + reason?: str + status: str + + $type: "Accepted" + + check: + len(status) >= 1 + len($type) >= 1 + diff --git a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_service_monitor.k b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_service_monitor.k index 0cee2575..8dfb5990 100644 --- a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_service_monitor.k +++ b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_service_monitor.k @@ -29,6 +29,8 @@ schema ServiceMonitor: metadata spec : MonitoringCoreosComV1ServiceMonitorSpec, default is Undefined, required spec + status : MonitoringCoreosComV1ServiceMonitorStatus, default is Undefined, optional + status """ apiVersion: "monitoring.coreos.com/v1" = "monitoring.coreos.com/v1" @@ -37,9 +39,11 @@ schema ServiceMonitor: metadata?: v1.ObjectMeta spec: MonitoringCoreosComV1ServiceMonitorSpec + status?: MonitoringCoreosComV1ServiceMonitorStatus + schema MonitoringCoreosComV1ServiceMonitorSpec: r""" - Specification of desired Service selection for target discovery by + spec defines the specification of desired Service selection for target discovery by Prometheus. Attributes @@ -47,20 +51,23 @@ schema MonitoringCoreosComV1ServiceMonitorSpec: attachMetadata : MonitoringCoreosComV1ServiceMonitorSpecAttachMetadata, default is Undefined, optional attach metadata bodySizeLimit : str, default is Undefined, optional - When defined, bodySizeLimit specifies a job level limit on the size + bodySizeLimit when defined, bodySizeLimit specifies a job level limit on the size of uncompressed response body that will be accepted by Prometheus. It requires Prometheus >= v2.28.0. + convertClassicHistogramsToNHCB : bool, default is Undefined, optional + convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. + It requires Prometheus >= v3.0.0. endpoints : [MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0], default is Undefined, required - List of endpoints part of this ServiceMonitor. + endpoints defines the list of endpoints part of this ServiceMonitor. Defines how to scrape metrics from Kubernetes [Endpoints](https://kubernetes.io/docs/concepts/services-networking/service/#endpoints) objects. In most cases, an Endpoints object is backed by a Kubernetes [Service](https://kubernetes.io/docs/concepts/services-networking/service/) object with the same name and labels. fallbackScrapeProtocol : str, default is Undefined, optional - The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. + fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It requires Prometheus >= v3.0.0. jobLabel : str, default is Undefined, optional - `jobLabel` selects the label from the associated Kubernetes `Service` + jobLabel selects the label from the associated Kubernetes `Service` object which will be used as the `job` label for all metrics. For example if `jobLabel` is set to `foo` and the Kubernetes `Service` @@ -71,45 +78,47 @@ schema MonitoringCoreosComV1ServiceMonitorSpec: the given Service, the `job` label of the metrics defaults to the name of the associated Kubernetes `Service`. keepDroppedTargets : int, default is Undefined, optional - Per-scrape limit on the number of targets dropped by relabeling + keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0. labelLimit : int, default is Undefined, optional - Per-scrape limit on number of labels that will be accepted for a sample. + labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample. It requires Prometheus >= v2.27.0. labelNameLengthLimit : int, default is Undefined, optional - Per-scrape limit on length of labels name that will be accepted for a sample. + labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. It requires Prometheus >= v2.27.0. labelValueLengthLimit : int, default is Undefined, optional - Per-scrape limit on length of labels value that will be accepted for a sample. + labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. It requires Prometheus >= v2.27.0. namespaceSelector : MonitoringCoreosComV1ServiceMonitorSpecNamespaceSelector, default is Undefined, optional namespace selector nativeHistogramBucketLimit : int, default is Undefined, optional - If there are more than this many buckets in a native histogram, + nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0. nativeHistogramMinBucketFactor : int | str, default is Undefined, optional - If the growth factor of one bucket to the next is smaller than this, + nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this, buckets will be merged to increase the factor sufficiently. It requires Prometheus >= v2.50.0. podTargetLabels : [str], default is Undefined, optional - `podTargetLabels` defines the labels which are transferred from the + podTargetLabels defines the labels which are transferred from the associated Kubernetes `Pod` object onto the ingested metrics. sampleLimit : int, default is Undefined, optional - `sampleLimit` defines a per-scrape limit on the number of scraped samples + sampleLimit defines a per-scrape limit on the number of scraped samples that will be accepted. scrapeClass : str, default is Undefined, optional - The scrape class to apply. + scrapeClass defines the scrape class to apply. scrapeClassicHistograms : bool, default is Undefined, optional - Whether to scrape a classic histogram that is also exposed as a native histogram. + scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0. + + Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration. scrapeProtocols : [str], default is Undefined, optional - `scrapeProtocols` defines the protocols to negotiate during a scrape. It tells clients the + scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. @@ -118,21 +127,28 @@ schema MonitoringCoreosComV1ServiceMonitorSpec: selector : MonitoringCoreosComV1ServiceMonitorSpecSelector, default is Undefined, required selector selectorMechanism : str, default is Undefined, optional - Mechanism used to select the endpoints to scrape. + selectorMechanism defines the mechanism used to select the endpoints to scrape. By default, the selection process relies on relabel configurations to filter the discovered targets. Alternatively, you can opt in for role selectors, which may offer better efficiency in large clusters. Which strategy is best for your use case needs to be carefully evaluated. It requires Prometheus >= v2.17.0. + serviceDiscoveryRole : str, default is Undefined, optional + serviceDiscoveryRole defines the service discovery role used to discover targets. + + If set, the value should be either "Endpoints" or "EndpointSlice". + Otherwise it defaults to the value defined in the + Prometheus/PrometheusAgent resource. targetLabels : [str], default is Undefined, optional - `targetLabels` defines the labels which are transferred from the + targetLabels defines the labels which are transferred from the associated Kubernetes `Service` object onto the ingested metrics. targetLimit : int, default is Undefined, optional - `targetLimit` defines a limit on the number of scraped targets that will + targetLimit defines a limit on the number of scraped targets that will be accepted. """ attachMetadata?: MonitoringCoreosComV1ServiceMonitorSpecAttachMetadata bodySizeLimit?: str + convertClassicHistogramsToNHCB?: bool endpoints: [MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0] fallbackScrapeProtocol?: "PrometheusProto" | "OpenMetricsText0.0.1" | "OpenMetricsText1.0.0" | "PrometheusText0.0.4" | "PrometheusText1.0.0" @@ -152,6 +168,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpec: selector: MonitoringCoreosComV1ServiceMonitorSpecSelector selectorMechanism?: "RelabelConfig" | "RoleSelector" + serviceDiscoveryRole?: "Endpoints" | "EndpointSlice" targetLabels?: [str] targetLimit?: int @@ -162,7 +179,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpec: schema MonitoringCoreosComV1ServiceMonitorSpecAttachMetadata: r""" - `attachMetadata` defines additional metadata which is added to the + attachMetadata defines additional metadata which is added to the discovered targets. It requires Prometheus >= v2.37.0. @@ -170,7 +187,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecAttachMetadata: Attributes ---------- node : bool, default is Undefined, optional - When set to true, Prometheus attaches node metadata to the discovered + node when set to true, Prometheus attaches node metadata to the discovered targets. The Prometheus service account must have the `list` and `watch` @@ -190,53 +207,67 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0: basicAuth : MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0BasicAuth, default is Undefined, optional basic auth bearerTokenFile : str, default is Undefined, optional - File to read bearer token for scraping the target. + bearerTokenFile defines the file to read bearer token for scraping the target. Deprecated: use `authorization` instead. bearerTokenSecret : MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0BearerTokenSecret, default is Undefined, optional bearer token secret enableHttp2 : bool, default is Undefined, optional - `enableHttp2` can be used to disable HTTP2 when scraping the target. + enableHttp2 can be used to disable HTTP2 when scraping the target. filterRunning : bool, default is Undefined, optional - When true, the pods which are not running (e.g. either in Failed or + filterRunning when true, the pods which are not running (e.g. either in Failed or Succeeded state) are dropped during the target discovery. If unset, the filtering is enabled. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle/#pod-phase followRedirects : bool, default is Undefined, optional - `followRedirects` defines whether the scrape requests should follow HTTP + followRedirects defines whether the scrape requests should follow HTTP 3xx redirects. honorLabels : bool, default is Undefined, optional - When true, `honorLabels` preserves the metric's labels when they collide + honorLabels defines when true the metric's labels when they collide with the target's labels. honorTimestamps : bool, default is Undefined, optional - `honorTimestamps` controls whether Prometheus preserves the timestamps + honorTimestamps defines whether Prometheus preserves the timestamps when exposed by the target. interval : str, default is Undefined, optional - Interval at which Prometheus scrapes the metrics from the target. + interval at which Prometheus scrapes the metrics from the target. If empty, Prometheus uses the global scrape interval. metricRelabelings : [MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0MetricRelabelingsItems0], default is Undefined, optional - `metricRelabelings` configures the relabeling rules to apply to the + metricRelabelings defines the relabeling rules to apply to the samples before ingestion. + noProxy : str, default is Undefined, optional + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names + that should be excluded from proxying. IP and domain names can + contain port numbers. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2, default is Undefined, optional oauth2 params : {str:[str]}, default is Undefined, optional params define optional HTTP URL parameters. path : str, default is Undefined, optional - HTTP path from which to scrape for metrics. + path defines the HTTP path from which to scrape for metrics. If empty, Prometheus uses the default value (e.g. `/metrics`). port : str, default is Undefined, optional - Name of the Service port which this endpoint refers to. + port defines the name of the Service port which this endpoint refers to. It takes precedence over `targetPort`. + proxyConnectHeader : {str:[MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to + proxies during CONNECT requests. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyFromEnvironment : bool, default is Undefined, optional + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` configures the HTTP Proxy URL (e.g. - "http://proxyserver:2195") to go through when scraping the target. + proxyUrl defines the HTTP proxy server to use. relabelings : [MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0RelabelingsItems0], default is Undefined, optional - `relabelings` configures the relabeling rules to apply the target's + relabelings defines the relabeling rules to apply the target's metadata labels. The Operator automatically adds relabelings for a few standard Kubernetes fields. @@ -245,25 +276,20 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0: More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config scheme : str, default is Undefined, optional - HTTP scheme to use for scraping. - - `http` and `https` are the expected values unless you rewrite the - `__scheme__` label via relabeling. - - If empty, Prometheus uses the default value `http`. + scheme defines the HTTP scheme to use when scraping the metrics. scrapeTimeout : str, default is Undefined, optional - Timeout after which Prometheus considers the scrape to be failed. + scrapeTimeout defines the timeout after which Prometheus considers the scrape to be failed. If empty, Prometheus uses the global scrape timeout unless it is less than the target's scrape interval value in which the latter is used. The value cannot be greater than the scrape interval otherwise the operator will reject the resource. targetPort : int | str, default is Undefined, optional - Name or number of the target port of the `Pod` object behind the + targetPort defines the name or number of the target port of the `Pod` object behind the Service. The port must be specified with the container's port property. tlsConfig : MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfig, default is Undefined, optional tls config trackTimestampsStaleness : bool, default is Undefined, optional - `trackTimestampsStaleness` defines whether Prometheus tracks staleness of + trackTimestampsStaleness defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if `honorTimestamps` is false. @@ -280,13 +306,16 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0: honorTimestamps?: bool interval?: str metricRelabelings?: [MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0MetricRelabelingsItems0] + noProxy?: str oauth2?: MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2 params?: {str:[str]} path?: str port?: str + proxyConnectHeader?: {str:[MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0ProxyConnectHeaderItems0]} + proxyFromEnvironment?: bool proxyUrl?: str relabelings?: [MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0RelabelingsItems0] - scheme?: "http" | "https" + scheme?: "http" | "https" | "HTTP" | "HTTPS" scrapeTimeout?: str targetPort?: int | str tlsConfig?: MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfig @@ -294,11 +323,12 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0: check: _regex_match(str(interval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if interval + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(scrapeTimeout), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if scrapeTimeout schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Authorization: r""" - `authorization` configures the Authorization header credentials to use when + authorization configures the Authorization header credentials to use when scraping the target. Cannot be set at the same time as `basicAuth`, or `oauth2`. @@ -308,7 +338,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Authorization: credentials : MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -319,7 +349,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Authorization: schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -341,7 +371,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0AuthorizationCreden schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0BasicAuth: r""" - `basicAuth` configures the Basic Authentication credentials to use when + basicAuth defines the Basic Authentication credentials to use when scraping the target. Cannot be set at the same time as `authorization`, or `oauth2`. @@ -358,7 +388,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0BasicAuth: schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -381,7 +411,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0BasicAuthPassword: schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -404,7 +434,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0BasicAuthUsername: schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0BearerTokenSecret: r""" - `bearerTokenSecret` specifies a key of a Secret containing the bearer + bearerTokenSecret defines a key of a Secret containing the bearer token for scraping targets. The secret needs to be in the same namespace as the ServiceMonitor object and readable by the Prometheus Operator. @@ -438,31 +468,31 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0MetricRelabelingsIt Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -477,12 +507,9 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0MetricRelabelingsIt sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2: r""" - `oauth2` configures the OAuth2 settings to use when scraping the target. + oauth2 defines the OAuth2 settings to use when scraping the target. It requires Prometheus >= 2.27.0. @@ -495,31 +522,31 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2: clientSecret : MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2ClientID @@ -535,12 +562,12 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -555,7 +582,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2ClientID: schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -577,7 +604,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2ClientIDConfi schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -599,7 +626,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2ClientIDSecre schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -644,7 +671,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2ProxyConnectH schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -654,19 +681,19 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfig: cert : MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCert @@ -678,7 +705,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfig: schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -692,7 +719,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCa: schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -714,7 +741,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCaCo schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -736,7 +763,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCaSe schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -750,7 +777,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCert schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -772,7 +799,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCert schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -794,7 +821,29 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigCert schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0ProxyConnectHeaderItems0: + r""" + SecretKeySelector selects a key of a Secret. Attributes ---------- @@ -824,31 +873,31 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0RelabelingsItems0: Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -863,39 +912,36 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0RelabelingsItems0: sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfig: r""" - TLS configuration to use when scraping the target. + tlsConfig defines the TLS configuration to use when scraping the target. Attributes ---------- ca : MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCa, default is Undefined, optional ca caFile : str, default is Undefined, optional - Path to the CA cert in the Prometheus container to use for the targets. + caFile defines the path to the CA cert in the Prometheus container to use for the targets. cert : MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the client cert file in the Prometheus container for the targets. + certFile defines the path to the client cert file in the Prometheus container for the targets. insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keyFile : str, default is Undefined, optional - Path to the client key file in the Prometheus container for the targets. + keyFile defines the path to the client key file in the Prometheus container for the targets. keySecret : MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCa caFile?: str @@ -910,7 +956,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfig: schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -924,7 +970,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCa: schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -946,7 +992,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCaConfigMa schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -968,7 +1014,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCaSecret: schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -982,7 +1028,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCert: schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1004,7 +1050,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCertConfig schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1026,7 +1072,7 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigCertSecret schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -1048,23 +1094,23 @@ schema MonitoringCoreosComV1ServiceMonitorSpecEndpointsItems0TLSConfigKeySecret: schema MonitoringCoreosComV1ServiceMonitorSpecNamespaceSelector: r""" - `namespaceSelector` defines in which namespace(s) Prometheus should discover the services. + namespaceSelector defines in which namespace(s) Prometheus should discover the services. By default, the services are discovered in the same namespace as the `ServiceMonitor` object but it is possible to select pods across different/all namespaces. Attributes ---------- any : bool, default is Undefined, optional - Boolean describing whether all namespaces are selected in contrast to a + any defines the boolean describing whether all namespaces are selected in contrast to a list restricting them. matchNames : [str], default is Undefined, optional - List of namespace names to select from. + matchNames defines the list of namespace names to select from. """ any?: bool matchNames?: [str] schema MonitoringCoreosComV1ServiceMonitorSpecSelector: r""" - Label selector to select the Kubernetes `Endpoints` objects to scrape metrics from. + selector defines the label selector to select the Kubernetes `Endpoints` objects to scrape metrics from. Attributes ---------- @@ -1102,3 +1148,85 @@ schema MonitoringCoreosComV1ServiceMonitorSpecSelectorMatchExpressionsItems0: values?: [str] +schema MonitoringCoreosComV1ServiceMonitorStatus: + r""" + status defines the status subresource. It is under active development and is updated only when the + "StatusForConfigurationResources" feature gate is enabled. + + Most recent observed status of the ServiceMonitor. Read-only. + More info: + https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + + Attributes + ---------- + bindings : [MonitoringCoreosComV1ServiceMonitorStatusBindingsItems0], default is Undefined, optional + bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource. + """ + bindings?: [MonitoringCoreosComV1ServiceMonitorStatusBindingsItems0] + +schema MonitoringCoreosComV1ServiceMonitorStatusBindingsItems0: + r""" + WorkloadBinding is a link between a configuration resource and a workload resource. + + Attributes + ---------- + conditions : [MonitoringCoreosComV1ServiceMonitorStatusBindingsItems0ConditionsItems0], default is Undefined, optional + conditions defines the current state of the configuration resource when bound to the referenced Workload object. + group : str, default is Undefined, required + group defines the group of the referenced resource. + name : str, default is Undefined, required + name defines the name of the referenced object. + namespace : str, default is Undefined, required + namespace defines the namespace of the referenced object. + resource : str, default is Undefined, required + resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager). + """ + conditions?: [MonitoringCoreosComV1ServiceMonitorStatusBindingsItems0ConditionsItems0] + group: "monitoring.coreos.com" + + name: str + + namespace: str + + resource: "prometheuses" | "prometheusagents" | "thanosrulers" | "alertmanagers" + + check: + len(name) >= 1 + len(namespace) >= 1 + +schema MonitoringCoreosComV1ServiceMonitorStatusBindingsItems0ConditionsItems0: + r""" + ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler. + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, required + lastTransitionTime defines the time of the last update to the current status property. + message : str, default is Undefined, optional + message defines the human-readable message indicating details for the condition's last transition. + observedGeneration : int, default is Undefined, optional + observedGeneration defines the .metadata.generation that the + condition was set based upon. For instance, if `.metadata.generation` is + currently 12, but the `.status.conditions[].observedGeneration` is 9, the + condition is out of date with respect to the current state of the object. + reason : str, default is Undefined, optional + reason for the condition's last transition. + status : str, default is Undefined, required + status of the condition. + $type : str, default is Undefined, required + type of the condition being reported. + Currently, only "Accepted" is supported. + """ + lastTransitionTime: str + + message?: str + observedGeneration?: int + reason?: str + status: str + + $type: "Accepted" + + check: + len(status) >= 1 + len($type) >= 1 + diff --git a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_thanos_ruler.k b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_thanos_ruler.k index 473a5aa7..89b3de1d 100644 --- a/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_thanos_ruler.k +++ b/docs/examples/src/charts/kube_prometheus_stack/api/v1/monitoring_coreos_com_v1_thanos_ruler.k @@ -40,13 +40,13 @@ schema ThanosRuler: schema MonitoringCoreosComV1ThanosRulerSpec: r""" - Specification of the desired behavior of the ThanosRuler cluster. More info: + spec defines the specification of the desired behavior of the ThanosRuler cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Attributes ---------- additionalArgs : [MonitoringCoreosComV1ThanosRulerSpecAdditionalArgsItems0], default is Undefined, optional - AdditionalArgs allows setting additional arguments for the ThanosRuler container. + additionalArgs defines how to add additional arguments for the ThanosRuler container. It is intended for e.g. activating hidden flags which are not supported by the dedicated configuration options yet. The arguments are passed as-is to the ThanosRuler container which may cause issues if they are invalid or not supported @@ -57,16 +57,16 @@ schema MonitoringCoreosComV1ThanosRulerSpec: affinity : MonitoringCoreosComV1ThanosRulerSpecAffinity, default is Undefined, optional affinity alertDropLabels : [str], default is Undefined, optional - Configures the label names which should be dropped in Thanos Ruler + alertDropLabels defines the label names which should be dropped in Thanos Ruler alerts. The replica label `thanos_ruler_replica` will always be dropped from the alerts. alertQueryUrl : str, default is Undefined, optional - The external Query URL the Thanos Ruler will set in the 'Source' field + alertQueryUrl defines how Thanos Ruler will set in the 'Source' field of all alerts. Maps to the '--alert.query-url' CLI arg. alertRelabelConfigFile : str, default is Undefined, optional - Configures the path to the alert relabeling configuration file. + alertRelabelConfigFile defines the path to the alert relabeling configuration file. Alert relabel configuration must have the form as specified in the official Prometheus documentation: @@ -80,13 +80,13 @@ schema MonitoringCoreosComV1ThanosRulerSpec: alertmanagersConfig : MonitoringCoreosComV1ThanosRulerSpecAlertmanagersConfig, default is Undefined, optional alertmanagers config alertmanagersUrl : [str], default is Undefined, optional - Configures the list of Alertmanager endpoints to send alerts to. + alertmanagersUrl defines the list of Alertmanager endpoints to send alerts to. For Thanos >= v0.10.0, it is recommended to use `alertmanagersConfig` instead. `alertmanagersConfig` takes precedence over this field. containers : [MonitoringCoreosComV1ThanosRulerSpecContainersItems0], default is Undefined, optional - Containers allows injecting additional containers or modifying operator generated + containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to a ThanosRuler pod or to change the behavior of an operator generated container. Containers described here modify an operator generated container if they share the same name and modifications are done via a @@ -96,36 +96,55 @@ schema MonitoringCoreosComV1ThanosRulerSpec: dnsConfig : MonitoringCoreosComV1ThanosRulerSpecDNSConfig, default is Undefined, optional dns config dnsPolicy : str, default is Undefined, optional - Defines the DNS policy for the pods. + dnsPolicy defines the DNS policy for the pods. + enableFeatures : [str], default is Undefined, optional + enableFeatures defines how to setup Thanos Ruler feature flags. By default, no features are enabled. + + Enabling features which are disabled by default is entirely outside the + scope of what the maintainers will support and by doing so, you accept + that this behaviour may break at any time without notice. + + For more information see https://thanos.io/tip/components/rule.md/ + + It requires Thanos >= 0.39.0. + enableServiceLinks : bool, default is Undefined, optional + enableServiceLinks defines whether information about services should be injected into pod's environment variables enforcedNamespaceLabel : str, default is Undefined, optional - EnforcedNamespaceLabel enforces adding a namespace label of origin for each alert + enforcedNamespaceLabel enforces adding a namespace label of origin for each alert and metric that is user created. The label value will always be the namespace of the object that is being created. evaluationInterval : str, default is "15s", optional - Interval between consecutive evaluations. + evaluationInterval defines the interval between consecutive evaluations. excludedFromEnforcement : [MonitoringCoreosComV1ThanosRulerSpecExcludedFromEnforcementItems0], default is Undefined, optional - List of references to PrometheusRule objects + excludedFromEnforcement defines the list of references to PrometheusRule objects to be excluded from enforcing a namespace label of origin. Applies only if enforcedNamespaceLabel set to true. externalPrefix : str, default is Undefined, optional - The external URL the Thanos Ruler instances will be available under. This is + externalPrefix defines the Thanos Ruler instances will be available under. This is necessary to generate correct URLs. This is necessary if Thanos Ruler is not served from root of a DNS name. grpcServerTlsConfig : MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfig, default is Undefined, optional grpc server Tls config hostAliases : [MonitoringCoreosComV1ThanosRulerSpecHostAliasesItems0], default is Undefined, optional - Pods' hostAliases configuration + hostAliases defines pods' hostAliases configuration + hostUsers : bool, default is Undefined, optional + hostUsers supports the user space in Kubernetes. + + More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/ + + The feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled. + Starting Kubernetes 1.33, the feature is enabled by default. image : str, default is Undefined, optional - Thanos container image URL. + image defines Thanos container image URL. imagePullPolicy : str, default is Undefined, optional - Image pull policy for the 'thanos', 'init-config-reloader' and 'config-reloader' containers. + imagePullPolicy defines for the 'thanos', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details. imagePullSecrets : [MonitoringCoreosComV1ThanosRulerSpecImagePullSecretsItems0], default is Undefined, optional - An optional list of references to secrets in the same namespace + imagePullSecrets defines an optional list of references to secrets in the same namespace to use for pulling thanos images from registries see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod initContainers : [MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0], default is Undefined, optional - InitContainers allows adding initContainers to the pod definition. Those can be used to e.g. + initContainers allows adding initContainers to the pod definition. Those can be used to e.g. fetch secrets for injection into the ThanosRuler configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/ @@ -133,28 +152,28 @@ schema MonitoringCoreosComV1ThanosRulerSpec: of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. labels : {str:str}, default is Undefined, optional - Configures the external label pairs of the ThanosRuler resource. + labels defines the external label pairs of the ThanosRuler resource. A default replica label `thanos_ruler_replica` will be always added as a label with the value of the pod's name. listenLocal : bool, default is Undefined, optional - ListenLocal makes the Thanos ruler listen on loopback, so that it + listenLocal defines the Thanos ruler listen on loopback, so that it does not bind against the Pod IP. logFormat : str, default is Undefined, optional - Log format for ThanosRuler to be configured with. + logFormat for ThanosRuler to be configured with. logLevel : str, default is Undefined, optional - Log level for ThanosRuler to be configured with. + logLevel for ThanosRuler to be configured with. minReadySeconds : int, default is Undefined, optional - Minimum number of seconds for which a newly created pod should be ready + minReadySeconds defines the minimum number of seconds for which a newly created pod should be ready without any of its container crashing for it to be considered available. - Defaults to 0 (pod will be considered available as soon as it is ready) - This is an alpha field from kubernetes 1.22 until 1.24 which requires enabling the StatefulSetMinReadySeconds feature gate. + + If unset, pods will be considered available as soon as they are ready. nodeSelector : {str:str}, default is Undefined, optional - Define which Nodes the Pods are scheduled on. + nodeSelector defines which Nodes the Pods are scheduled on. objectStorageConfig : MonitoringCoreosComV1ThanosRulerSpecObjectStorageConfig, default is Undefined, optional object storage config objectStorageConfigFile : str, default is Undefined, optional - Configures the path of the object storage configuration file. + objectStorageConfigFile defines the path of the object storage configuration file. The configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage @@ -162,56 +181,93 @@ schema MonitoringCoreosComV1ThanosRulerSpec: This field takes precedence over `objectStorageConfig`. paused : bool, default is Undefined, optional - When a ThanosRuler deployment is paused, no actions except for deletion + paused defines when a ThanosRuler deployment is paused, no actions except for deletion will be performed on the underlying objects. podMetadata : MonitoringCoreosComV1ThanosRulerSpecPodMetadata, default is Undefined, optional pod metadata portName : str, default is "web", optional - Port name used for the pods and governing service. + portName defines the port name used for the pods and governing service. Defaults to `web`. priorityClassName : str, default is Undefined, optional - Priority class assigned to the Pods + priorityClassName defines the priority class assigned to the Pods prometheusRulesExcludedFromEnforce : [MonitoringCoreosComV1ThanosRulerSpecPrometheusRulesExcludedFromEnforceItems0], default is Undefined, optional - PrometheusRulesExcludedFromEnforce - list of Prometheus rules to be excluded from enforcing + prometheusRulesExcludedFromEnforce defines a list of Prometheus rules to be excluded from enforcing of adding namespace labels. Works only if enforcedNamespaceLabel set to true. Make sure both ruleNamespace and ruleName are set for each pair Deprecated: use excludedFromEnforcement instead. queryConfig : MonitoringCoreosComV1ThanosRulerSpecQueryConfig, default is Undefined, optional query config queryEndpoints : [str], default is Undefined, optional - Configures the list of Thanos Query endpoints from which to query metrics. + queryEndpoints defines the list of Thanos Query endpoints from which to query metrics. For Thanos >= v0.11.0, it is recommended to use `queryConfig` instead. `queryConfig` takes precedence over this field. + remoteWrite : [MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0], default is Undefined, optional + remoteWrite defines the list of remote write configurations. + + When the list isn't empty, the ruler is configured with stateless mode. + + It requires Thanos >= 0.24.0. replicas : int, default is Undefined, optional - Number of thanos ruler instances to deploy. + replicas defines the number of thanos ruler instances to deploy. + resendDelay : str, default is Undefined, optional + resendDelay defines the minimum amount of time to wait before resending an alert to Alertmanager. resources : MonitoringCoreosComV1ThanosRulerSpecResources, default is Undefined, optional resources retention : str, default is "24h", optional - Time duration ThanosRuler shall retain data for. Default is '24h', - and must match the regular expression `[0-9]+(ms|s|m|h|d|w|y)` (milliseconds seconds minutes hours days weeks years). + retention defines the time duration ThanosRuler shall retain data for. Default is '24h', and + must match the regular expression `[0-9]+(ms|s|m|h|d|w|y)` (milliseconds + seconds minutes hours days weeks years). + + The field has no effect when remote-write is configured since the Ruler + operates in stateless mode. routePrefix : str, default is Undefined, optional - The route prefix ThanosRuler registers HTTP handlers for. This allows thanos UI to be served on a sub-path. + routePrefix defines the route prefix ThanosRuler registers HTTP handlers for. This allows thanos UI to be served on a sub-path. + ruleConcurrentEval : int, default is Undefined, optional + ruleConcurrentEval defines how many rules can be evaluated concurrently. + It requires Thanos >= v0.37.0. + ruleGracePeriod : str, default is Undefined, optional + ruleGracePeriod defines the minimum duration between alert and restored "for" state. + This is maintained only for alerts with configured "for" time greater than grace period. + It requires Thanos >= v0.30.0. ruleNamespaceSelector : MonitoringCoreosComV1ThanosRulerSpecRuleNamespaceSelector, default is Undefined, optional rule namespace selector + ruleOutageTolerance : str, default is Undefined, optional + ruleOutageTolerance defines the max time to tolerate prometheus outage for restoring "for" state of alert. + It requires Thanos >= v0.30.0. + ruleQueryOffset : str, default is Undefined, optional + ruleQueryOffset defines the default rule group's query offset duration to use. + It requires Thanos >= v0.38.0. ruleSelector : MonitoringCoreosComV1ThanosRulerSpecRuleSelector, default is Undefined, optional rule selector securityContext : MonitoringCoreosComV1ThanosRulerSpecSecurityContext, default is Undefined, optional security context serviceAccountName : str, default is Undefined, optional - ServiceAccountName is the name of the ServiceAccount to use to run the + serviceAccountName defines the name of the ServiceAccount to use to run the Thanos Ruler Pods. + serviceName : str, default is Undefined, optional + serviceName defines the name of the service name used by the underlying StatefulSet(s) as the governing service. + If defined, the Service must be created before the ThanosRuler resource in the same namespace and it must define a selector that matches the pod labels. + If empty, the operator will create and manage a headless service named `thanos-ruler-operated` for ThanosRuler resources. + When deploying multiple ThanosRuler resources in the same namespace, it is recommended to specify a different value for each. + See https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details. storage : MonitoringCoreosComV1ThanosRulerSpecStorage, default is Undefined, optional storage + terminationGracePeriodSeconds : int, default is Undefined, optional + terminationGracePeriodSeconds defines the optional duration in seconds the pod needs to terminate gracefully. + Value must be non-negative integer. The value zero indicates stop immediately via + the kill signal (no opportunity to shut down) which may lead to data corruption. + + Defaults to 120 seconds. tolerations : [MonitoringCoreosComV1ThanosRulerSpecTolerationsItems0], default is Undefined, optional - If specified, the pod's tolerations. + tolerations defines when specified, the pod's tolerations. topologySpreadConstraints : [MonitoringCoreosComV1ThanosRulerSpecTopologySpreadConstraintsItems0], default is Undefined, optional - If specified, the pod's topology spread constraints. + topologySpreadConstraints defines the pod's topology spread constraints. tracingConfig : MonitoringCoreosComV1ThanosRulerSpecTracingConfig, default is Undefined, optional tracing config tracingConfigFile : str, default is Undefined, optional - Configures the path of the tracing configuration file. + tracingConfigFile defines the path of the tracing configuration file. The configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration @@ -222,13 +278,13 @@ schema MonitoringCoreosComV1ThanosRulerSpec: This field takes precedence over `tracingConfig`. version : str, default is Undefined, optional - Version of Thanos to be deployed. + version of Thanos to be deployed. volumeMounts : [MonitoringCoreosComV1ThanosRulerSpecVolumeMountsItems0], default is Undefined, optional - VolumeMounts allows configuration of additional VolumeMounts on the output StatefulSet definition. + volumeMounts defines how the configuration of additional VolumeMounts on the output StatefulSet definition. VolumeMounts specified will be appended to other VolumeMounts in the ruler container, that are generated as a result of StorageSpec objects. volumes : [MonitoringCoreosComV1ThanosRulerSpecVolumesItems0], default is Undefined, optional - Volumes allows configuration of additional volumes on the output StatefulSet definition. Volumes specified will + volumes defines how configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects. web : MonitoringCoreosComV1ThanosRulerSpecWeb, default is Undefined, optional web @@ -244,12 +300,15 @@ schema MonitoringCoreosComV1ThanosRulerSpec: containers?: [MonitoringCoreosComV1ThanosRulerSpecContainersItems0] dnsConfig?: MonitoringCoreosComV1ThanosRulerSpecDNSConfig dnsPolicy?: "ClusterFirstWithHostNet" | "ClusterFirst" | "Default" | "None" + enableFeatures?: [str] + enableServiceLinks?: bool enforcedNamespaceLabel?: str evaluationInterval?: str = "15s" excludedFromEnforcement?: [MonitoringCoreosComV1ThanosRulerSpecExcludedFromEnforcementItems0] externalPrefix?: str grpcServerTlsConfig?: MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfig hostAliases?: [MonitoringCoreosComV1ThanosRulerSpecHostAliasesItems0] + hostUsers?: bool image?: str imagePullPolicy?: "" | "Always" | "Never" | "IfNotPresent" imagePullSecrets?: [MonitoringCoreosComV1ThanosRulerSpecImagePullSecretsItems0] @@ -269,15 +328,23 @@ schema MonitoringCoreosComV1ThanosRulerSpec: prometheusRulesExcludedFromEnforce?: [MonitoringCoreosComV1ThanosRulerSpecPrometheusRulesExcludedFromEnforceItems0] queryConfig?: MonitoringCoreosComV1ThanosRulerSpecQueryConfig queryEndpoints?: [str] + remoteWrite?: [MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0] replicas?: int + resendDelay?: str resources?: MonitoringCoreosComV1ThanosRulerSpecResources retention?: str = "24h" routePrefix?: str + ruleConcurrentEval?: int + ruleGracePeriod?: str ruleNamespaceSelector?: MonitoringCoreosComV1ThanosRulerSpecRuleNamespaceSelector + ruleOutageTolerance?: str + ruleQueryOffset?: str ruleSelector?: MonitoringCoreosComV1ThanosRulerSpecRuleSelector securityContext?: MonitoringCoreosComV1ThanosRulerSpecSecurityContext serviceAccountName?: str + serviceName?: str storage?: MonitoringCoreosComV1ThanosRulerSpecStorage + terminationGracePeriodSeconds?: int tolerations?: [MonitoringCoreosComV1ThanosRulerSpecTolerationsItems0] topologySpreadConstraints?: [MonitoringCoreosComV1ThanosRulerSpecTopologySpreadConstraintsItems0] tracingConfig?: MonitoringCoreosComV1ThanosRulerSpecTracingConfig @@ -288,8 +355,17 @@ schema MonitoringCoreosComV1ThanosRulerSpec: web?: MonitoringCoreosComV1ThanosRulerSpecWeb check: + all enableFeatures in enableFeatures {len(enableFeatures) >= 1 if enableFeatures not in [None, Undefined]} if enableFeatures _regex_match(str(evaluationInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if evaluationInterval + minReadySeconds >= 0 if minReadySeconds not in [None, Undefined] + _regex_match(str(resendDelay), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if resendDelay _regex_match(str(retention), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if retention + ruleConcurrentEval >= 1 if ruleConcurrentEval not in [None, Undefined] + _regex_match(str(ruleGracePeriod), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if ruleGracePeriod + _regex_match(str(ruleOutageTolerance), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if ruleOutageTolerance + _regex_match(str(ruleQueryOffset), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if ruleQueryOffset + len(serviceName) >= 1 if serviceName + terminationGracePeriodSeconds >= 0 if terminationGracePeriodSeconds not in [None, Undefined] schema MonitoringCoreosComV1ThanosRulerSpecAdditionalArgsItems0: r""" @@ -298,9 +374,9 @@ schema MonitoringCoreosComV1ThanosRulerSpecAdditionalArgsItems0: Attributes ---------- name : str, default is Undefined, required - Name of the argument, e.g. "scrape.discovery-reload-interval". + name of the argument, e.g. "scrape.discovery-reload-interval". value : str, default is Undefined, optional - Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) + value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) """ name: str @@ -311,7 +387,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecAdditionalArgsItems0: schema MonitoringCoreosComV1ThanosRulerSpecAffinity: r""" - If specified, the pod's scheduling constraints. + affinity defines when specified, the pod's scheduling constraints. Attributes ---------- @@ -570,7 +646,6 @@ schema MonitoringCoreosComV1ThanosRulerSpecAffinityPodAffinityPreferredDuringSch pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -580,7 +655,6 @@ schema MonitoringCoreosComV1ThanosRulerSpecAffinityPodAffinityPreferredDuringSch pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1ThanosRulerSpecAffinityPodAffinityPreferredDuringSchedulingIgnoredDuringExecutionItems0PodAffinityTermNamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -709,7 +783,6 @@ schema MonitoringCoreosComV1ThanosRulerSpecAffinityPodAffinityRequiredDuringSche pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -719,7 +792,6 @@ schema MonitoringCoreosComV1ThanosRulerSpecAffinityPodAffinityRequiredDuringSche pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1ThanosRulerSpecAffinityPodAffinityRequiredDuringSchedulingIgnoredDuringExecutionItems0NamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -839,8 +911,8 @@ schema MonitoringCoreosComV1ThanosRulerSpecAffinityPodAntiAffinity: most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), - compute a sum by iterating through the elements of this field and adding - "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the + compute a sum by iterating through the elements of this field and subtracting + "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. requiredDuringSchedulingIgnoredDuringExecution : [MonitoringCoreosComV1ThanosRulerSpecAffinityPodAntiAffinityRequiredDuringSchedulingIgnoredDuringExecutionItems0], default is Undefined, optional If the anti-affinity requirements specified by this field are not met at @@ -887,7 +959,6 @@ schema MonitoringCoreosComV1ThanosRulerSpecAffinityPodAntiAffinityPreferredDurin pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -897,7 +968,6 @@ schema MonitoringCoreosComV1ThanosRulerSpecAffinityPodAntiAffinityPreferredDurin pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1ThanosRulerSpecAffinityPodAntiAffinityPreferredDuringSchedulingIgnoredDuringExecutionItems0PodAffinityTermNamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -1026,7 +1096,6 @@ schema MonitoringCoreosComV1ThanosRulerSpecAffinityPodAntiAffinityRequiredDuring pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -1036,7 +1105,6 @@ schema MonitoringCoreosComV1ThanosRulerSpecAffinityPodAntiAffinityRequiredDuring pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1ThanosRulerSpecAffinityPodAntiAffinityRequiredDuringSchedulingIgnoredDuringExecutionItems0NamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -1145,7 +1213,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecAffinityPodAntiAffinityRequiredDuring schema MonitoringCoreosComV1ThanosRulerSpecAlertRelabelConfigs: r""" - Configures alert relabeling in Thanos Ruler. + alertRelabelConfigs defines the alert relabeling in Thanos Ruler. Alert relabel configuration must have the form as specified in the official Prometheus documentation: @@ -1175,7 +1243,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecAlertRelabelConfigs: schema MonitoringCoreosComV1ThanosRulerSpecAlertmanagersConfig: r""" - Configures the list of Alertmanager endpoints to send alerts to. + alertmanagersConfig defines the list of Alertmanager endpoints to send alerts to. The configuration format is defined at https://thanos.io/tip/components/rule.md/#alertmanager. @@ -1232,8 +1300,8 @@ schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0: Cannot be updated. envFrom : [MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvFromItems0], default is Undefined, optional List of sources to populate environment variables in the container. - The keys defined within a source must be a C_IDENTIFIER. All invalid keys - will be reported as an event when the container is starting. When a key exists in multiple + The keys defined within a source may consist of any printable ASCII characters except '='. + When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. @@ -1272,10 +1340,10 @@ schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0: resources restartPolicy : str, default is Undefined, optional RestartPolicy defines the restart behavior of individual containers in a pod. - This field may only be set for init containers, and the only allowed value is "Always". - For non-init containers or when this field is not specified, + This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. - Setting the RestartPolicy as "Always" for the init container will have the following effect: + Additionally, setting the RestartPolicy as "Always" for the init container will + have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" @@ -1286,6 +1354,18 @@ schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0: container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. + restartPolicyRules : [MonitoringCoreosComV1ThanosRulerSpecContainersItems0RestartPolicyRulesItems0], default is Undefined, optional + Represents a list of rules to be checked to determine if the + container should be restarted on exit. The rules are evaluated in + order. Once a rule matches a container exit condition, the remaining + rules are ignored. If no rule matches the container exit condition, + the Container-level restart policy determines the whether the container + is restarted or not. Constraints on the rules: + - At most 20 rules are allowed. + - Rules can have the same action. + - Identical rules are not forbidden in validations. + When rules are specified, container MUST set RestartPolicy explicitly + even it if matches the Pod's RestartPolicy. securityContext : MonitoringCoreosComV1ThanosRulerSpecContainersItems0SecurityContext, default is Undefined, optional security context startupProbe : MonitoringCoreosComV1ThanosRulerSpecContainersItems0StartupProbe, default is Undefined, optional @@ -1347,6 +1427,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0: resizePolicy?: [MonitoringCoreosComV1ThanosRulerSpecContainersItems0ResizePolicyItems0] resources?: MonitoringCoreosComV1ThanosRulerSpecContainersItems0Resources restartPolicy?: str + restartPolicyRules?: [MonitoringCoreosComV1ThanosRulerSpecContainersItems0RestartPolicyRulesItems0] securityContext?: MonitoringCoreosComV1ThanosRulerSpecContainersItems0SecurityContext startupProbe?: MonitoringCoreosComV1ThanosRulerSpecContainersItems0StartupProbe stdin?: bool @@ -1360,14 +1441,15 @@ schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0: schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvFromItems0: r""" - EnvFromSource represents the source of a set of ConfigMaps + EnvFromSource represents the source of a set of ConfigMaps or Secrets Attributes ---------- configMapRef : MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvFromItems0ConfigMapRef, default is Undefined, optional config map ref prefix : str, default is Undefined, optional - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + Optional text to prepend to the name of each environment variable. + May consist of any printable ASCII characters except '='. secretRef : MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvFromItems0SecretRef, default is Undefined, optional secret ref """ @@ -1418,7 +1500,8 @@ schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0: Attributes ---------- name : str, default is Undefined, required - Name of the environment variable. Must be a C_IDENTIFIER. + Name of the environment variable. + May consist of any printable ASCII characters except '='. value : str, default is Undefined, optional Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and @@ -1447,6 +1530,8 @@ schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFrom: config map key ref fieldRef : MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFromFieldRef, default is Undefined, optional field ref + fileKeyRef : MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFromFileKeyRef, default is Undefined, optional + file key ref resourceFieldRef : MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFromResourceFieldRef, default is Undefined, optional resource field ref secretKeyRef : MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFromSecretKeyRef, default is Undefined, optional @@ -1454,6 +1539,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFrom: """ configMapKeyRef?: MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFromConfigMapKeyRef fieldRef?: MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFromFieldRef + fileKeyRef?: MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFromFileKeyRef resourceFieldRef?: MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFromResourceFieldRef secretKeyRef?: MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFromSecretKeyRef @@ -1494,6 +1580,38 @@ schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFromFie apiVersion?: str fieldPath: str +schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFromFileKeyRef: + r""" + FileKeyRef selects a key of the env file. + Requires the EnvFiles feature gate to be enabled. + + Attributes + ---------- + key : str, default is Undefined, required + The key within the env file. An invalid key will prevent the pod from starting. + The keys defined within a source may consist of any printable ASCII characters except '='. + During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + optional : bool, default is Undefined, optional + Specify whether the file or its key must be defined. If the file or key + does not exist, then the env var is not published. + If optional is set to true and the specified key does not exist, + the environment variable will not be set in the Pod's containers. + + If optional is set to false and the specified key does not exist, + an error will be returned during Pod creation. + path : str, default is Undefined, required + The path within the volume from which to select the file. + Must be relative and may not contain the '..' path or start with '..'. + volumeName : str, default is Undefined, required + The name of the volume mount containing the env file. + """ + key: str + + optional?: bool = False + path: str + + volumeName: str + schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0EnvItems0ValueFromResourceFieldRef: r""" Selects a resource of the container: only resources limits and requests @@ -1548,9 +1666,14 @@ schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0Lifecycle: post start preStop : MonitoringCoreosComV1ThanosRulerSpecContainersItems0LifecyclePreStop, default is Undefined, optional pre stop + stopSignal : str, default is Undefined, optional + StopSignal defines which signal will be sent to a container when it is being stopped. + If not specified, the default is defined by the container runtime in use. + StopSignal can only be set for Pods with a non-empty .spec.os.name """ postStart?: MonitoringCoreosComV1ThanosRulerSpecContainersItems0LifecyclePostStart preStop?: MonitoringCoreosComV1ThanosRulerSpecContainersItems0LifecyclePreStop + stopSignal?: str schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0LifecyclePostStart: r""" @@ -2137,7 +2260,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0Resources: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. - This is an alpha field and requires enabling the + This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. @@ -2177,6 +2300,44 @@ schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0ResourcesClaimsItems0 request?: str +schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0RestartPolicyRulesItems0: + r""" + ContainerRestartRule describes how a container exit is handled. + + Attributes + ---------- + action : str, default is Undefined, required + Specifies the action taken on a container exit if the requirements + are satisfied. The only possible value is "Restart" to restart the + container. + exitCodes : MonitoringCoreosComV1ThanosRulerSpecContainersItems0RestartPolicyRulesItems0ExitCodes, default is Undefined, optional + exit codes + """ + action: str + + exitCodes?: MonitoringCoreosComV1ThanosRulerSpecContainersItems0RestartPolicyRulesItems0ExitCodes + +schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0RestartPolicyRulesItems0ExitCodes: + r""" + Represents the exit codes to check on container exits. + + Attributes + ---------- + operator : str, default is Undefined, required + Represents the relationship between the container exit code(s) and the + specified values. Possible values are: + - In: the requirement is satisfied if the container exit code is in the + set of specified values. + - NotIn: the requirement is satisfied if the container exit code is + not in the set of specified values. + values : [int], default is Undefined, optional + Specifies the set of values to check for container exit codes. + At most 255 elements are allowed. + """ + operator: str + + values?: [int] + schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0SecurityContext: r""" SecurityContext defines the security options the container should be run with. @@ -2596,20 +2757,20 @@ schema MonitoringCoreosComV1ThanosRulerSpecContainersItems0VolumeMountsItems0: schema MonitoringCoreosComV1ThanosRulerSpecDNSConfig: r""" - Defines the DNS configuration for the pods. + dnsConfig defines Defines the DNS configuration for the pods. Attributes ---------- nameservers : [str], default is Undefined, optional - A list of DNS name server IP addresses. + nameservers defines the list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. options : [MonitoringCoreosComV1ThanosRulerSpecDNSConfigOptionsItems0], default is Undefined, optional - A list of DNS resolver options. + options defines the list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Resolution options given in Options will override those that appear in the base DNSPolicy. searches : [str], default is Undefined, optional - A list of DNS search domains for host-name lookup. + searches defines the list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. """ nameservers?: [str] @@ -2627,9 +2788,9 @@ schema MonitoringCoreosComV1ThanosRulerSpecDNSConfigOptionsItems0: Attributes ---------- name : str, default is Undefined, required - Name is required and must be unique. + name is required and must be unique. value : str, default is Undefined, optional - Value is optional. + value is optional. """ name: str @@ -2645,14 +2806,14 @@ schema MonitoringCoreosComV1ThanosRulerSpecExcludedFromEnforcementItems0: Attributes ---------- group : str, default is "monitoring.coreos.com", optional - Group of the referent. When not specified, it defaults to `monitoring.coreos.com` + group of the referent. When not specified, it defaults to `monitoring.coreos.com` name : str, default is Undefined, optional - Name of the referent. When not set, all resources in the namespace are matched. + name of the referent. When not set, all resources in the namespace are matched. namespace : str, default is Undefined, required - Namespace of the referent. + namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ resource : str, default is Undefined, required - Resource of the referent. + resource of the referent. """ group?: "monitoring.coreos.com" = "monitoring.coreos.com" name?: str @@ -2665,7 +2826,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecExcludedFromEnforcementItems0: schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfig: r""" - GRPCServerTLSConfig configures the gRPC server from which Thanos Querier reads + grpcServerTlsConfig defines the gRPC server from which Thanos Querier reads recorded rule data. Note: Currently only the CAFile, CertFile, and KeyFile fields are supported. Maps to the '--grpc-server-tls-*' CLI args. @@ -2675,27 +2836,27 @@ schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfig: ca : MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCa, default is Undefined, optional ca caFile : str, default is Undefined, optional - Path to the CA cert in the Prometheus container to use for the targets. + caFile defines the path to the CA cert in the Prometheus container to use for the targets. cert : MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the client cert file in the Prometheus container for the targets. + certFile defines the path to the client cert file in the Prometheus container for the targets. insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keyFile : str, default is Undefined, optional - Path to the client key file in the Prometheus container for the targets. + keyFile defines the path to the client key file in the Prometheus container for the targets. keySecret : MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCa caFile?: str @@ -2710,7 +2871,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfig: schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -2724,7 +2885,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCa: schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2746,7 +2907,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCaConfigMap: schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2768,7 +2929,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCaSecret: schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -2782,7 +2943,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCert: schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2804,7 +2965,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCertConfigMap: schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2826,7 +2987,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigCertSecret: schema MonitoringCoreosComV1ThanosRulerSpecGrpcServerTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -2854,9 +3015,9 @@ schema MonitoringCoreosComV1ThanosRulerSpecHostAliasesItems0: Attributes ---------- hostnames : [str], default is Undefined, required - Hostnames for the above IP address. + hostnames defines hostnames for the above IP address. ip : str, default is Undefined, required - IP address of the host file entry. + ip defines the IP address of the host file entry. """ hostnames: [str] @@ -2907,8 +3068,8 @@ schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0: Cannot be updated. envFrom : [MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvFromItems0], default is Undefined, optional List of sources to populate environment variables in the container. - The keys defined within a source must be a C_IDENTIFIER. All invalid keys - will be reported as an event when the container is starting. When a key exists in multiple + The keys defined within a source may consist of any printable ASCII characters except '='. + When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. @@ -2947,10 +3108,10 @@ schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0: resources restartPolicy : str, default is Undefined, optional RestartPolicy defines the restart behavior of individual containers in a pod. - This field may only be set for init containers, and the only allowed value is "Always". - For non-init containers or when this field is not specified, + This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. - Setting the RestartPolicy as "Always" for the init container will have the following effect: + Additionally, setting the RestartPolicy as "Always" for the init container will + have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" @@ -2961,6 +3122,18 @@ schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0: container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. + restartPolicyRules : [MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0RestartPolicyRulesItems0], default is Undefined, optional + Represents a list of rules to be checked to determine if the + container should be restarted on exit. The rules are evaluated in + order. Once a rule matches a container exit condition, the remaining + rules are ignored. If no rule matches the container exit condition, + the Container-level restart policy determines the whether the container + is restarted or not. Constraints on the rules: + - At most 20 rules are allowed. + - Rules can have the same action. + - Identical rules are not forbidden in validations. + When rules are specified, container MUST set RestartPolicy explicitly + even it if matches the Pod's RestartPolicy. securityContext : MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0SecurityContext, default is Undefined, optional security context startupProbe : MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0StartupProbe, default is Undefined, optional @@ -3022,6 +3195,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0: resizePolicy?: [MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0ResizePolicyItems0] resources?: MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0Resources restartPolicy?: str + restartPolicyRules?: [MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0RestartPolicyRulesItems0] securityContext?: MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0SecurityContext startupProbe?: MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0StartupProbe stdin?: bool @@ -3035,14 +3209,15 @@ schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0: schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvFromItems0: r""" - EnvFromSource represents the source of a set of ConfigMaps + EnvFromSource represents the source of a set of ConfigMaps or Secrets Attributes ---------- configMapRef : MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvFromItems0ConfigMapRef, default is Undefined, optional config map ref prefix : str, default is Undefined, optional - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + Optional text to prepend to the name of each environment variable. + May consist of any printable ASCII characters except '='. secretRef : MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvFromItems0SecretRef, default is Undefined, optional secret ref """ @@ -3093,7 +3268,8 @@ schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0: Attributes ---------- name : str, default is Undefined, required - Name of the environment variable. Must be a C_IDENTIFIER. + Name of the environment variable. + May consist of any printable ASCII characters except '='. value : str, default is Undefined, optional Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and @@ -3122,6 +3298,8 @@ schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFro config map key ref fieldRef : MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFromFieldRef, default is Undefined, optional field ref + fileKeyRef : MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFromFileKeyRef, default is Undefined, optional + file key ref resourceFieldRef : MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFromResourceFieldRef, default is Undefined, optional resource field ref secretKeyRef : MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFromSecretKeyRef, default is Undefined, optional @@ -3129,6 +3307,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFro """ configMapKeyRef?: MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFromConfigMapKeyRef fieldRef?: MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFromFieldRef + fileKeyRef?: MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFromFileKeyRef resourceFieldRef?: MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFromResourceFieldRef secretKeyRef?: MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFromSecretKeyRef @@ -3169,6 +3348,38 @@ schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFro apiVersion?: str fieldPath: str +schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFromFileKeyRef: + r""" + FileKeyRef selects a key of the env file. + Requires the EnvFiles feature gate to be enabled. + + Attributes + ---------- + key : str, default is Undefined, required + The key within the env file. An invalid key will prevent the pod from starting. + The keys defined within a source may consist of any printable ASCII characters except '='. + During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + optional : bool, default is Undefined, optional + Specify whether the file or its key must be defined. If the file or key + does not exist, then the env var is not published. + If optional is set to true and the specified key does not exist, + the environment variable will not be set in the Pod's containers. + + If optional is set to false and the specified key does not exist, + an error will be returned during Pod creation. + path : str, default is Undefined, required + The path within the volume from which to select the file. + Must be relative and may not contain the '..' path or start with '..'. + volumeName : str, default is Undefined, required + The name of the volume mount containing the env file. + """ + key: str + + optional?: bool = False + path: str + + volumeName: str + schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0EnvItems0ValueFromResourceFieldRef: r""" Selects a resource of the container: only resources limits and requests @@ -3223,9 +3434,14 @@ schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0Lifecycle: post start preStop : MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0LifecyclePreStop, default is Undefined, optional pre stop + stopSignal : str, default is Undefined, optional + StopSignal defines which signal will be sent to a container when it is being stopped. + If not specified, the default is defined by the container runtime in use. + StopSignal can only be set for Pods with a non-empty .spec.os.name """ postStart?: MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0LifecyclePostStart preStop?: MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0LifecyclePreStop + stopSignal?: str schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0LifecyclePostStart: r""" @@ -3812,7 +4028,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0Resources: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. - This is an alpha field and requires enabling the + This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. @@ -3852,6 +4068,44 @@ schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0ResourcesClaimsIt request?: str +schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0RestartPolicyRulesItems0: + r""" + ContainerRestartRule describes how a container exit is handled. + + Attributes + ---------- + action : str, default is Undefined, required + Specifies the action taken on a container exit if the requirements + are satisfied. The only possible value is "Restart" to restart the + container. + exitCodes : MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0RestartPolicyRulesItems0ExitCodes, default is Undefined, optional + exit codes + """ + action: str + + exitCodes?: MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0RestartPolicyRulesItems0ExitCodes + +schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0RestartPolicyRulesItems0ExitCodes: + r""" + Represents the exit codes to check on container exits. + + Attributes + ---------- + operator : str, default is Undefined, required + Represents the relationship between the container exit code(s) and the + specified values. Possible values are: + - In: the requirement is satisfied if the container exit code is in the + set of specified values. + - NotIn: the requirement is satisfied if the container exit code is + not in the set of specified values. + values : [int], default is Undefined, optional + Specifies the set of values to check for container exit codes. + At most 255 elements are allowed. + """ + operator: str + + values?: [int] + schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0SecurityContext: r""" SecurityContext defines the security options the container should be run with. @@ -4271,9 +4525,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecInitContainersItems0VolumeMountsItems schema MonitoringCoreosComV1ThanosRulerSpecObjectStorageConfig: r""" - Configures object storage. - - The configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage + objectStorageConfig defines the configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage The operator performs no validation of the configuration. @@ -4299,7 +4551,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecObjectStorageConfig: schema MonitoringCoreosComV1ThanosRulerSpecPodMetadata: r""" - PodMetadata configures labels and annotations which are propagated to the ThanosRuler pods. + podMetadata defines labels and annotations which are propagated to the ThanosRuler pods. The following items are reserved and cannot be overridden: * "app.kubernetes.io/name" label, set to "thanos-ruler". @@ -4311,22 +4563,22 @@ schema MonitoringCoreosComV1ThanosRulerSpecPodMetadata: Attributes ---------- annotations : {str:str}, default is Undefined, optional - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. - More info: http://kubernetes.io/docs/user-guide/annotations + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ labels : {str:str}, default is Undefined, optional - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. - More info: http://kubernetes.io/docs/user-guide/labels + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ name : str, default is Undefined, optional - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. - More info: http://kubernetes.io/docs/user-guide/identifiers#names + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/ """ annotations?: {str:str} labels?: {str:str} @@ -4341,9 +4593,9 @@ schema MonitoringCoreosComV1ThanosRulerSpecPrometheusRulesExcludedFromEnforceIte Attributes ---------- ruleName : str, default is Undefined, required - Name of the excluded PrometheusRule object. + ruleName defines the name of the excluded PrometheusRule object. ruleNamespace : str, default is Undefined, required - Namespace of the excluded PrometheusRule object. + ruleNamespace defines the namespace of the excluded PrometheusRule object. """ ruleName: str @@ -4351,7 +4603,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecPrometheusRulesExcludedFromEnforceIte schema MonitoringCoreosComV1ThanosRulerSpecQueryConfig: r""" - Configures the list of Thanos Query endpoints from which to query metrics. + queryConfig defines the list of Thanos Query endpoints from which to query metrics. The configuration format is defined at https://thanos.io/tip/components/rule.md/#query-api @@ -4379,178 +4631,1274 @@ schema MonitoringCoreosComV1ThanosRulerSpecQueryConfig: name?: str = "" optional?: bool -schema MonitoringCoreosComV1ThanosRulerSpecResources: +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0: r""" - Resources defines the resource requirements for single Pods. - If not provided, no requests/limits will be set + RemoteWriteSpec defines the configuration to write samples from Prometheus + to a remote endpoint. Attributes ---------- - claims : [MonitoringCoreosComV1ThanosRulerSpecResourcesClaimsItems0], default is Undefined, optional - Claims lists the names of resources, defined in spec.resourceClaims, - that are used by this container. + authorization : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Authorization, default is Undefined, optional + authorization + azureAd : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAd, default is Undefined, optional + azure ad + basicAuth : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0BasicAuth, default is Undefined, optional + basic auth + bearerToken : str, default is Undefined, optional + bearerToken is deprecated: this will be removed in a future release. + *Warning: this field shouldn't be used because the token value appears + in clear-text. Prefer using `authorization`.* + bearerTokenFile : str, default is Undefined, optional + bearerTokenFile defines the file from which to read bearer token for the URL. - This is an alpha field and requires enabling the - DynamicResourceAllocation feature gate. + Deprecated: this will be removed in a future release. Prefer using `authorization`. + enableHTTP2 : bool, default is Undefined, optional + enableHTTP2 defines whether to enable HTTP2. + followRedirects : bool, default is Undefined, optional + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. - This field is immutable. It can only be set for containers. - limits : {str:int | str}, default is Undefined, optional - Limits describes the maximum amount of compute resources allowed. - More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ - requests : {str:int | str}, default is Undefined, optional - Requests describes the minimum amount of compute resources required. - If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, - otherwise to an implementation-defined value. Requests cannot exceed Limits. - More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ - """ - claims?: [MonitoringCoreosComV1ThanosRulerSpecResourcesClaimsItems0] - limits?: {str:int | str} - requests?: {str:int | str} + It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. + headers : {str:str}, default is Undefined, optional + headers defines the custom HTTP headers to be sent along with each remote write request. + Be aware that headers that are set by Prometheus itself can't be overwritten. + + It requires Prometheus >= v2.25.0 or Thanos >= v0.24.0. + messageVersion : str, default is Undefined, optional + messageVersion defines the Remote Write message's version to use when writing to the endpoint. + + `Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0. + `Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0. + + When `Version2.0` is selected, Prometheus will automatically be + configured to append the metadata of scraped metrics to the WAL. + + Before setting this field, consult with your remote storage provider + what message version it supports. + + It requires Prometheus >= v2.54.0 or Thanos >= v0.37.0. + metadataConfig : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0MetadataConfig, default is Undefined, optional + metadata config + name : str, default is Undefined, optional + name of the remote write queue, it must be unique if specified. The + name is used in metrics and logging in order to differentiate queues. + + It requires Prometheus >= v2.15.0 or Thanos >= 0.24.0. + noProxy : str, default is Undefined, optional + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names + that should be excluded from proxying. IP and domain names can + contain port numbers. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + oauth2 : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2, default is Undefined, optional + oauth2 + proxyConnectHeader : {str:[MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0ProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to + proxies during CONNECT requests. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyFromEnvironment : bool, default is Undefined, optional + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyUrl : str, default is Undefined, optional + proxyUrl defines the HTTP proxy server to use. + queueConfig : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0QueueConfig, default is Undefined, optional + queue config + remoteTimeout : str, default is Undefined, optional + remoteTimeout defines the timeout for requests to the remote write endpoint. + roundRobinDNS : bool, default is Undefined, optional + roundRobinDNS controls the DNS resolution behavior for remote-write connections. + When enabled: + - The remote-write mechanism will resolve the hostname via DNS. + - It will randomly select one of the resolved IP addresses and connect to it. + + When disabled (default behavior): + - The Go standard library will handle hostname resolution. + - It will attempt connections to each resolved IP address sequentially. + + Note: The connection timeout applies to the entire resolution and connection process. + + If disabled, the timeout is distributed across all connection attempts. + + It requires Prometheus >= v3.1.0 or Thanos >= v0.38.0. + sendExemplars : bool, default is Undefined, optional + sendExemplars enables sending of exemplars over remote write. Note that + exemplar-storage itself must be enabled using the `spec.enableFeatures` + option for exemplars to be scraped in the first place. + + It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0. + sendNativeHistograms : bool, default is Undefined, optional + sendNativeHistograms enables sending of native histograms, also known as sparse histograms + over remote write. + + It requires Prometheus >= v2.40.0 or Thanos >= v0.30.0. + sigv4 : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Sigv4, default is Undefined, optional + sigv4 + tlsConfig : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfig, default is Undefined, optional + tls config + url : str, default is Undefined, required + url defines the URL of the endpoint to send samples to. + writeRelabelConfigs : [MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0WriteRelabelConfigsItems0], default is Undefined, optional + writeRelabelConfigs defines the list of remote write relabel configurations. + """ + authorization?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Authorization + azureAd?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAd + basicAuth?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0BasicAuth + bearerToken?: str + bearerTokenFile?: str + enableHTTP2?: bool + followRedirects?: bool + headers?: {str:str} + messageVersion?: "V1.0" | "V2.0" + metadataConfig?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0MetadataConfig + name?: str + noProxy?: str + oauth2?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2 + proxyConnectHeader?: {str:[MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0ProxyConnectHeaderItems0]} + proxyFromEnvironment?: bool + proxyUrl?: str + queueConfig?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0QueueConfig + remoteTimeout?: str + roundRobinDNS?: bool + sendExemplars?: bool + sendNativeHistograms?: bool + sigv4?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Sigv4 + tlsConfig?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfig + url: str + + writeRelabelConfigs?: [MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0WriteRelabelConfigsItems0] check: - all _, limits in limits {_regex_match(str(limits), r"^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$") if limits} if limits - all _, requests in requests {_regex_match(str(requests), r"^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$") if requests} if requests + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl + _regex_match(str(remoteTimeout), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if remoteTimeout + len(url) >= 1 -schema MonitoringCoreosComV1ThanosRulerSpecResourcesClaimsItems0: +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Authorization: r""" - ResourceClaim references one entry in PodSpec.ResourceClaims. + authorization section for the URL. + + It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. + + Cannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`. Attributes ---------- - name : str, default is Undefined, required - Name must match the name of one entry in pod.spec.resourceClaims of - the Pod where this field is used. It makes that resource available - inside a container. - request : str, default is Undefined, optional - Request is the name chosen for a request in the referenced claim. - If empty, everything from the claim is made available, otherwise - only the result of this request. - """ - name: str + credentials : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AuthorizationCredentials, default is Undefined, optional + credentials + credentialsFile : str, default is Undefined, optional + credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. + $type : str, default is Undefined, optional + type defines the authentication type. The value is case-insensitive. - request?: str + "Basic" is not a supported value. -schema MonitoringCoreosComV1ThanosRulerSpecRuleNamespaceSelector: + Default: "Bearer" + """ + credentials?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AuthorizationCredentials + credentialsFile?: str + $type?: str + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AuthorizationCredentials: r""" - Namespaces to be selected for Rules discovery. If unspecified, only - the same namespace as the ThanosRuler object is in is used. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- - matchExpressions : [MonitoringCoreosComV1ThanosRulerSpecRuleNamespaceSelectorMatchExpressionsItems0], default is Undefined, optional - matchExpressions is a list of label selector requirements. The requirements are ANDed. - matchLabels : {str:str}, default is Undefined, optional - 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. + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined """ - matchExpressions?: [MonitoringCoreosComV1ThanosRulerSpecRuleNamespaceSelectorMatchExpressionsItems0] - matchLabels?: {str:str} + key: str -schema MonitoringCoreosComV1ThanosRulerSpecRuleNamespaceSelectorMatchExpressionsItems0: + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAd: r""" - A label selector requirement is a selector that contains values, a key, and an operator that - relates the key and values. + azureAd for the URL. + + It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0. + + Cannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`. Attributes ---------- - key : str, default is Undefined, required - key is the label key that the selector applies to. - operator : str, default is Undefined, required - operator represents a key's relationship to a set of values. - Valid operators are In, NotIn, Exists and DoesNotExist. - values : [str], default is Undefined, optional - 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. + cloud : str, default is Undefined, optional + cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'. + managedIdentity : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAdManagedIdentity, default is Undefined, optional + managed identity + oauth : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAdOauth, default is Undefined, optional + oauth + sdk : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAdSdk, default is Undefined, optional + sdk """ - key: str + cloud?: "AzureChina" | "AzureGovernment" | "AzurePublic" + managedIdentity?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAdManagedIdentity + oauth?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAdOauth + sdk?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAdSdk - operator: str +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAdManagedIdentity: + r""" + managedIdentity defines the Azure User-assigned Managed identity. + Cannot be set at the same time as `oauth` or `sdk`. - values?: [str] + Attributes + ---------- + clientId : str, default is Undefined, optional + clientId defines the Azure User-assigned Managed identity. -schema MonitoringCoreosComV1ThanosRulerSpecRuleSelector: + For Prometheus >= 3.5.0 and Thanos >= 0.40.0, this field is allowed to be empty to support system-assigned managed identities. + """ + clientId?: str + + check: + len(clientId) >= 1 if clientId + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAdOauth: r""" - PrometheusRule objects to be selected for rule evaluation. An empty - label selector matches all objects. A null label selector matches no - objects. + oauth defines the oauth config that is being used to authenticate. + Cannot be set at the same time as `managedIdentity` or `sdk`. + + It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0. Attributes ---------- - matchExpressions : [MonitoringCoreosComV1ThanosRulerSpecRuleSelectorMatchExpressionsItems0], default is Undefined, optional - matchExpressions is a list of label selector requirements. The requirements are ANDed. - matchLabels : {str:str}, default is Undefined, optional - 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. + clientId : str, default is Undefined, required + clientId defines the clientId of the Azure Active Directory application that is being used to authenticate. + clientSecret : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAdOauthClientSecret, default is Undefined, required + client secret + tenantId : str, default is Undefined, required + tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate. """ - matchExpressions?: [MonitoringCoreosComV1ThanosRulerSpecRuleSelectorMatchExpressionsItems0] - matchLabels?: {str:str} + clientId: str -schema MonitoringCoreosComV1ThanosRulerSpecRuleSelectorMatchExpressionsItems0: + clientSecret: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAdOauthClientSecret + + tenantId: str + + check: + len(clientId) >= 1 + len(tenantId) >= 1 + _regex_match(str(tenantId), r"^[0-9a-zA-Z-.]+$") + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAdOauthClientSecret: r""" - A label selector requirement is a selector that contains values, a key, and an operator that - relates the key and values. + clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate. Attributes ---------- key : str, default is Undefined, required - key is the label key that the selector applies to. - operator : str, default is Undefined, required - operator represents a key's relationship to a set of values. - Valid operators are In, NotIn, Exists and DoesNotExist. - values : [str], default is Undefined, optional - 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. + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined """ key: str - operator: str + name?: str = "" + optional?: bool - values?: [str] +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0AzureAdSdk: + r""" + sdk defines the Azure SDK config that is being used to authenticate. + See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication + Cannot be set at the same time as `oauth` or `managedIdentity`. -schema MonitoringCoreosComV1ThanosRulerSpecSecurityContext: + It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0. + + Attributes + ---------- + tenantId : str, default is Undefined, optional + tenantId defines the tenant ID of the azure active directory application that is being used to authenticate. + """ + tenantId?: str + + check: + _regex_match(str(tenantId), r"^[0-9a-zA-Z-.]+$") if tenantId + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0BasicAuth: r""" - SecurityContext holds pod-level security attributes and common container settings. - This defaults to the default PodSecurityContext. + basicAuth configuration for the URL. + + Cannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`. Attributes ---------- - appArmorProfile : MonitoringCoreosComV1ThanosRulerSpecSecurityContextAppArmorProfile, default is Undefined, optional - app armor profile - fsGroup : int, default is Undefined, optional - A special supplemental group that applies to all containers in a pod. - Some volume types allow the Kubelet to change the ownership of that volume - to be owned by the pod: + password : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0BasicAuthPassword, default is Undefined, optional + password + username : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0BasicAuthUsername, default is Undefined, optional + username + """ + password?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0BasicAuthPassword + username?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0BasicAuthUsername - 1. The owning GID will be the FSGroup - 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) - 3. The permission bits are OR'd with rw-rw---- +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0BasicAuthPassword: + r""" + password defines a key of a Secret containing the password for + authentication. - If unset, the Kubelet will not modify the ownership and permissions of any volume. - Note that this field cannot be set when spec.os.name is windows. - fsGroupChangePolicy : str, default is Undefined, optional - fsGroupChangePolicy defines behavior of changing ownership and permission of the volume - before being exposed inside Pod. This field will only apply to - volume types which support fsGroup based ownership(and permissions). - It will have no effect on ephemeral volume types such as: secret, configmaps - and emptydir. - Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. - Note that this field cannot be set when spec.os.name is windows. - runAsGroup : int, default is Undefined, optional - The GID to run the entrypoint of the container process. - Uses runtime default if unset. - May also be set in SecurityContext. If set in both SecurityContext and - PodSecurityContext, the value specified in SecurityContext takes precedence - for that container. - Note that this field cannot be set when spec.os.name is windows. - runAsNonRoot : bool, default is Undefined, optional - Indicates that the container must run as a non-root user. - If true, the Kubelet will validate the image at runtime to ensure that it + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0BasicAuthUsername: + r""" + username defines a key of a Secret containing the username for + authentication. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0MetadataConfig: + r""" + metadataConfig defines how to send a series metadata to the remote storage. + + When the field is empty, **no metadata** is sent. But when the field is + null, metadata is sent. + + Attributes + ---------- + maxSamplesPerSend : int, default is Undefined, optional + maxSamplesPerSend defines the maximum number of metadata samples per send. + + It requires Prometheus >= v2.29.0. + send : bool, default is Undefined, optional + send defines whether metric metadata is sent to the remote storage or not. + sendInterval : str, default is Undefined, optional + sendInterval defines how frequently metric metadata is sent to the remote storage. + """ + maxSamplesPerSend?: int + send?: bool + sendInterval?: str + + check: + maxSamplesPerSend >= -1 if maxSamplesPerSend not in [None, Undefined] + _regex_match(str(sendInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if sendInterval + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2: + r""" + oauth2 configuration for the URL. + + It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0. + + Cannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`. + + Attributes + ---------- + clientId : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ClientID, default is Undefined, required + client Id + clientSecret : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ClientSecret, default is Undefined, required + client secret + endpointParams : {str:str}, default is Undefined, optional + endpointParams configures the HTTP parameters to append to the token + URL. + noProxy : str, default is Undefined, optional + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names + that should be excluded from proxying. IP and domain names can + contain port numbers. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyConnectHeader : {str:[MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to + proxies during CONNECT requests. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyFromEnvironment : bool, default is Undefined, optional + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyUrl : str, default is Undefined, optional + proxyUrl defines the HTTP proxy server to use. + scopes : [str], default is Undefined, optional + scopes defines the OAuth2 scopes used for the token request. + tlsConfig : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfig, default is Undefined, optional + tls config + tokenUrl : str, default is Undefined, required + tokenUrl defines the URL to fetch the token from. + """ + clientId: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ClientID + + clientSecret: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ClientSecret + + endpointParams?: {str:str} + noProxy?: str + proxyConnectHeader?: {str:[MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ProxyConnectHeaderItems0]} + proxyFromEnvironment?: bool + proxyUrl?: str + scopes?: [str] + tlsConfig?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfig + tokenUrl: str + + check: + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl + len(tokenUrl) >= 1 + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ClientID: + r""" + clientId defines a key of a Secret or ConfigMap containing the + OAuth2 client's ID. + + Attributes + ---------- + configMap : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ClientIDConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ClientIDSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ClientIDConfigMap + secret?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ClientIDSecret + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ClientIDConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ClientIDSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ClientSecret: + r""" + clientSecret defines a key of a Secret containing the OAuth2 + client's secret. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2ProxyConnectHeaderItems0: + r""" + SecretKeySelector selects a key of a Secret. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfig: + r""" + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. + It requires Prometheus >= v2.43.0. + + Attributes + ---------- + ca : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCa, default is Undefined, optional + ca + cert : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCert, default is Undefined, optional + cert + insecureSkipVerify : bool, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigKeySecret, default is Undefined, optional + key secret + maxVersion : str, default is Undefined, optional + maxVersion defines the maximum acceptable TLS version. + + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. + minVersion : str, default is Undefined, optional + minVersion defines the minimum acceptable TLS version. + + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. + serverName : str, default is Undefined, optional + serverName is used to verify the hostname for the targets. + """ + ca?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCa + cert?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCert + insecureSkipVerify?: bool + keySecret?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigKeySecret + maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + serverName?: str + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCa: + r""" + ca defines the Certificate authority used when verifying server certificates. + + Attributes + ---------- + configMap : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCaConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCaSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCaConfigMap + secret?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCaSecret + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCaConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCaSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCert: + r""" + cert defines the Client certificate to present when doing client-authentication. + + Attributes + ---------- + configMap : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCertConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCertSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCertConfigMap + secret?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCertSecret + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCertConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigCertSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Oauth2TLSConfigKeySecret: + r""" + keySecret defines the Secret containing the client key file for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0ProxyConnectHeaderItems0: + r""" + SecretKeySelector selects a key of a Secret. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0QueueConfig: + r""" + queueConfig allows tuning of the remote write queue parameters. + + Attributes + ---------- + batchSendDeadline : str, default is Undefined, optional + batchSendDeadline defines the maximum time a sample will wait in buffer. + capacity : int, default is Undefined, optional + capacity defines the number of samples to buffer per shard before we start + dropping them. + maxBackoff : str, default is Undefined, optional + maxBackoff defines the maximum retry delay. + maxRetries : int, default is Undefined, optional + maxRetries defines the maximum number of times to retry a batch on recoverable errors. + maxSamplesPerSend : int, default is Undefined, optional + maxSamplesPerSend defines the maximum number of samples per send. + maxShards : int, default is Undefined, optional + maxShards defines the maximum number of shards, i.e. amount of concurrency. + minBackoff : str, default is Undefined, optional + minBackoff defines the initial retry delay. Gets doubled for every retry. + minShards : int, default is Undefined, optional + minShards defines the minimum number of shards, i.e. amount of concurrency. + retryOnRateLimit : bool, default is Undefined, optional + retryOnRateLimit defines the retry upon receiving a 429 status code from the remote-write storage. + + This is an *experimental feature*, it may change in any upcoming release + in a breaking way. + sampleAgeLimit : str, default is Undefined, optional + sampleAgeLimit drops samples older than the limit. + It requires Prometheus >= v2.50.0 or Thanos >= v0.32.0. + """ + batchSendDeadline?: str + capacity?: int + maxBackoff?: str + maxRetries?: int + maxSamplesPerSend?: int + maxShards?: int + minBackoff?: str + minShards?: int + retryOnRateLimit?: bool + sampleAgeLimit?: str + + check: + _regex_match(str(batchSendDeadline), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if batchSendDeadline + _regex_match(str(maxBackoff), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if maxBackoff + _regex_match(str(minBackoff), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if minBackoff + _regex_match(str(sampleAgeLimit), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if sampleAgeLimit + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Sigv4: + r""" + sigv4 defines the AWS's Signature Verification 4 for the URL. + + It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. + + Cannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`. + + Attributes + ---------- + accessKey : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Sigv4AccessKey, default is Undefined, optional + access key + profile : str, default is Undefined, optional + profile defines the named AWS profile used to authenticate. + region : str, default is Undefined, optional + region defines the AWS region. If blank, the region from the default credentials chain used. + roleArn : str, default is Undefined, optional + roleArn defines the named AWS profile used to authenticate. + secretKey : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Sigv4SecretKey, default is Undefined, optional + secret key + useFIPSSTSEndpoint : bool, default is Undefined, optional + useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. + It requires Prometheus >= v2.54.0. + """ + accessKey?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Sigv4AccessKey + profile?: str + region?: str + roleArn?: str + secretKey?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Sigv4SecretKey + useFIPSSTSEndpoint?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Sigv4AccessKey: + r""" + accessKey defines the AWS API key. If not specified, the environment variable + `AWS_ACCESS_KEY_ID` is used. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0Sigv4SecretKey: + r""" + secretKey defines the AWS API secret. If not specified, the environment + variable `AWS_SECRET_ACCESS_KEY` is used. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfig: + r""" + tlsConfig to use for the URL. + + Attributes + ---------- + ca : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCa, default is Undefined, optional + ca + caFile : str, default is Undefined, optional + caFile defines the path to the CA cert in the Prometheus container to use for the targets. + cert : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCert, default is Undefined, optional + cert + certFile : str, default is Undefined, optional + certFile defines the path to the client cert file in the Prometheus container for the targets. + insecureSkipVerify : bool, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keyFile : str, default is Undefined, optional + keyFile defines the path to the client key file in the Prometheus container for the targets. + keySecret : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigKeySecret, default is Undefined, optional + key secret + maxVersion : str, default is Undefined, optional + maxVersion defines the maximum acceptable TLS version. + + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. + minVersion : str, default is Undefined, optional + minVersion defines the minimum acceptable TLS version. + + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. + serverName : str, default is Undefined, optional + serverName is used to verify the hostname for the targets. + """ + ca?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCa + caFile?: str + cert?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCert + certFile?: str + insecureSkipVerify?: bool + keyFile?: str + keySecret?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigKeySecret + maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + serverName?: str + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCa: + r""" + ca defines the Certificate authority used when verifying server certificates. + + Attributes + ---------- + configMap : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCaConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCaSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCaConfigMap + secret?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCaSecret + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCaConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCaSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCert: + r""" + cert defines the Client certificate to present when doing client-authentication. + + Attributes + ---------- + configMap : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCertConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCertSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCertConfigMap + secret?: MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCertSecret + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCertConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigCertSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0TLSConfigKeySecret: + r""" + keySecret defines the Secret containing the client key file for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1ThanosRulerSpecRemoteWriteItems0WriteRelabelConfigsItems0: + r""" + RelabelConfig allows dynamic rewriting of the label set for targets, alerts, + scraped samples and remote write samples. + + More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config + + Attributes + ---------- + action : str, default is "replace", optional + action to perform based on the regex matching. + + `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. + `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. + + Default: "Replace" + modulus : int, default is Undefined, optional + modulus to take of the hash of the source label values. + + Only applicable when the action is `HashMod`. + regex : str, default is Undefined, optional + regex defines the regular expression against which the extracted value is matched. + replacement : str, default is Undefined, optional + replacement value against which a Replace action is performed if the + regular expression matches. + + Regex capture groups are available. + separator : str, default is Undefined, optional + separator defines the string between concatenated SourceLabels. + sourceLabels : [str], default is Undefined, optional + sourceLabels defines the source labels select values from existing labels. Their content is + concatenated using the configured Separator and matched against the + configured regular expression. + targetLabel : str, default is Undefined, optional + targetLabel defines the label to which the resulting string is written in a replacement. + + It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, + `KeepEqual` and `DropEqual` actions. + + Regex capture groups are available. + """ + action?: "replace" | "Replace" | "keep" | "Keep" | "drop" | "Drop" | "hashmod" | "HashMod" | "labelmap" | "LabelMap" | "labeldrop" | "LabelDrop" | "labelkeep" | "LabelKeep" | "lowercase" | "Lowercase" | "uppercase" | "Uppercase" | "keepequal" | "KeepEqual" | "dropequal" | "DropEqual" = "replace" + modulus?: int + regex?: str + replacement?: str + separator?: str + sourceLabels?: [str] + targetLabel?: str + +schema MonitoringCoreosComV1ThanosRulerSpecResources: + r""" + resources defines the resource requirements for single Pods. + If not provided, no requests/limits will be set + + Attributes + ---------- + claims : [MonitoringCoreosComV1ThanosRulerSpecResourcesClaimsItems0], default is Undefined, optional + Claims lists the names of resources, defined in spec.resourceClaims, + that are used by this container. + + This field depends on the + DynamicResourceAllocation feature gate. + + This field is immutable. It can only be set for containers. + limits : {str:int | str}, default is Undefined, optional + Limits describes the maximum amount of compute resources allowed. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + requests : {str:int | str}, default is Undefined, optional + Requests describes the minimum amount of compute resources required. + If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, + otherwise to an implementation-defined value. Requests cannot exceed Limits. + More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ + """ + claims?: [MonitoringCoreosComV1ThanosRulerSpecResourcesClaimsItems0] + limits?: {str:int | str} + requests?: {str:int | str} + + check: + all _, limits in limits {_regex_match(str(limits), r"^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$") if limits} if limits + all _, requests in requests {_regex_match(str(requests), r"^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$") if requests} if requests + +schema MonitoringCoreosComV1ThanosRulerSpecResourcesClaimsItems0: + r""" + ResourceClaim references one entry in PodSpec.ResourceClaims. + + Attributes + ---------- + name : str, default is Undefined, required + Name must match the name of one entry in pod.spec.resourceClaims of + the Pod where this field is used. It makes that resource available + inside a container. + request : str, default is Undefined, optional + Request is the name chosen for a request in the referenced claim. + If empty, everything from the claim is made available, otherwise + only the result of this request. + """ + name: str + + request?: str + +schema MonitoringCoreosComV1ThanosRulerSpecRuleNamespaceSelector: + r""" + ruleNamespaceSelector defines the namespaces to be selected for Rules discovery. If unspecified, only + the same namespace as the ThanosRuler object is in is used. + + Attributes + ---------- + matchExpressions : [MonitoringCoreosComV1ThanosRulerSpecRuleNamespaceSelectorMatchExpressionsItems0], default is Undefined, optional + matchExpressions is a list of label selector requirements. The requirements are ANDed. + matchLabels : {str:str}, default is Undefined, optional + 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. + """ + matchExpressions?: [MonitoringCoreosComV1ThanosRulerSpecRuleNamespaceSelectorMatchExpressionsItems0] + matchLabels?: {str:str} + +schema MonitoringCoreosComV1ThanosRulerSpecRuleNamespaceSelectorMatchExpressionsItems0: + r""" + A label selector requirement is a selector that contains values, a key, and an operator that + relates the key and values. + + Attributes + ---------- + key : str, default is Undefined, required + key is the label key that the selector applies to. + operator : str, default is Undefined, required + operator represents a key's relationship to a set of values. + Valid operators are In, NotIn, Exists and DoesNotExist. + values : [str], default is Undefined, optional + 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. + """ + key: str + + operator: str + + values?: [str] + +schema MonitoringCoreosComV1ThanosRulerSpecRuleSelector: + r""" + ruleSelector defines the PrometheusRule objects to be selected for rule evaluation. An empty + label selector matches all objects. A null label selector matches no + objects. + + Attributes + ---------- + matchExpressions : [MonitoringCoreosComV1ThanosRulerSpecRuleSelectorMatchExpressionsItems0], default is Undefined, optional + matchExpressions is a list of label selector requirements. The requirements are ANDed. + matchLabels : {str:str}, default is Undefined, optional + 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. + """ + matchExpressions?: [MonitoringCoreosComV1ThanosRulerSpecRuleSelectorMatchExpressionsItems0] + matchLabels?: {str:str} + +schema MonitoringCoreosComV1ThanosRulerSpecRuleSelectorMatchExpressionsItems0: + r""" + A label selector requirement is a selector that contains values, a key, and an operator that + relates the key and values. + + Attributes + ---------- + key : str, default is Undefined, required + key is the label key that the selector applies to. + operator : str, default is Undefined, required + operator represents a key's relationship to a set of values. + Valid operators are In, NotIn, Exists and DoesNotExist. + values : [str], default is Undefined, optional + 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. + """ + key: str + + operator: str + + values?: [str] + +schema MonitoringCoreosComV1ThanosRulerSpecSecurityContext: + r""" + securityContext defines the pod-level security attributes and common container settings. + This defaults to the default PodSecurityContext. + + Attributes + ---------- + appArmorProfile : MonitoringCoreosComV1ThanosRulerSpecSecurityContextAppArmorProfile, default is Undefined, optional + app armor profile + fsGroup : int, default is Undefined, optional + A special supplemental group that applies to all containers in a pod. + Some volume types allow the Kubelet to change the ownership of that volume + to be owned by the pod: + + 1. The owning GID will be the FSGroup + 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) + 3. The permission bits are OR'd with rw-rw---- + + If unset, the Kubelet will not modify the ownership and permissions of any volume. + Note that this field cannot be set when spec.os.name is windows. + fsGroupChangePolicy : str, default is Undefined, optional + fsGroupChangePolicy defines behavior of changing ownership and permission of the volume + before being exposed inside Pod. This field will only apply to + volume types which support fsGroup based ownership(and permissions). + It will have no effect on ephemeral volume types such as: secret, configmaps + and emptydir. + Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used. + Note that this field cannot be set when spec.os.name is windows. + runAsGroup : int, default is Undefined, optional + The GID to run the entrypoint of the container process. + Uses runtime default if unset. + May also be set in SecurityContext. If set in both SecurityContext and + PodSecurityContext, the value specified in SecurityContext takes precedence + for that container. + Note that this field cannot be set when spec.os.name is windows. + runAsNonRoot : bool, default is Undefined, optional + Indicates that the container must run as a non-root user. + If true, the Kubelet will validate the image at runtime to ensure that it does not run as UID 0 (root) and fail to start the container if it does. If unset or false, no such validation will be performed. May also be set in SecurityContext. If set in both SecurityContext and @@ -4745,12 +6093,12 @@ schema MonitoringCoreosComV1ThanosRulerSpecSecurityContextWindowsOptions: schema MonitoringCoreosComV1ThanosRulerSpecStorage: r""" - Storage spec to specify how storage shall be used. + storage defines the specification of how storage shall be used. Attributes ---------- disableMountSubPath : bool, default is Undefined, optional - Deprecated: subPath usage will be removed in a future release. + disableMountSubPath deprecated: subPath usage will be removed in a future release. emptyDir : MonitoringCoreosComV1ThanosRulerSpecStorageEmptyDir, default is Undefined, optional empty dir ephemeral : MonitoringCoreosComV1ThanosRulerSpecStorageEphemeral, default is Undefined, optional @@ -4765,7 +6113,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecStorage: schema MonitoringCoreosComV1ThanosRulerSpecStorageEmptyDir: r""" - EmptyDirVolumeSource to be used by the StatefulSet. + emptyDir to be used by the StatefulSet. If specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir @@ -4792,7 +6140,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecStorageEmptyDir: schema MonitoringCoreosComV1ThanosRulerSpecStorageEphemeral: r""" - EphemeralVolumeSource to be used by the StatefulSet. + ephemeral to be used by the StatefulSet. This is a beta field in k8s 1.21 and GA in 1.15. For lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes @@ -4867,15 +6215,13 @@ schema MonitoringCoreosComV1ThanosRulerSpecStorageEphemeralVolumeClaimTemplateSp volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, - it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass - will be applied to the claim but it's not allowed to reset this field to empty string once it is set. - If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass - will be set by the persistentvolume controller if it exists. + it can be changed after the claim is created. An empty string or nil value indicates that no + VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, + this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ - (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). volumeMode : str, default is Undefined, optional volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. @@ -5035,7 +6381,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecStorageEphemeralVolumeClaimTemplateSp schema MonitoringCoreosComV1ThanosRulerSpecStorageVolumeClaimTemplate: r""" - Defines the PVC spec to be used by the Prometheus StatefulSets. + volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets. The easiest way to use a volume that cannot be automatically provisioned is to use a label selector alongside manually created PersistentVolumes. @@ -5067,27 +6413,27 @@ schema MonitoringCoreosComV1ThanosRulerSpecStorageVolumeClaimTemplate: schema MonitoringCoreosComV1ThanosRulerSpecStorageVolumeClaimTemplateMetadata: r""" - EmbeddedMetadata contains metadata relevant to an EmbeddedResource. + metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource. Attributes ---------- annotations : {str:str}, default is Undefined, optional - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. - More info: http://kubernetes.io/docs/user-guide/annotations + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ labels : {str:str}, default is Undefined, optional - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. - More info: http://kubernetes.io/docs/user-guide/labels + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ name : str, default is Undefined, optional - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. - More info: http://kubernetes.io/docs/user-guide/identifiers#names + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/ """ annotations?: {str:str} labels?: {str:str} @@ -5095,7 +6441,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecStorageVolumeClaimTemplateMetadata: schema MonitoringCoreosComV1ThanosRulerSpecStorageVolumeClaimTemplateSpec: r""" - Defines the desired characteristics of a volume requested by a pod author. + spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims Attributes @@ -5118,15 +6464,13 @@ schema MonitoringCoreosComV1ThanosRulerSpecStorageVolumeClaimTemplateSpec: volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, - it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass - will be applied to the claim but it's not allowed to reset this field to empty string once it is set. - If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass - will be set by the persistentvolume controller if it exists. + it can be changed after the claim is created. An empty string or nil value indicates that no + VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, + this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ - (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). volumeMode : str, default is Undefined, optional volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. @@ -5286,7 +6630,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecStorageVolumeClaimTemplateSpecSelecto schema MonitoringCoreosComV1ThanosRulerSpecStorageVolumeClaimTemplateStatus: r""" - Deprecated: this field is never set. + status is deprecated: this field is never set. Attributes ---------- @@ -5360,7 +6704,6 @@ schema MonitoringCoreosComV1ThanosRulerSpecStorageVolumeClaimTemplateStatus: currentVolumeAttributesClassName : str, default is Undefined, optional currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim - This is a beta field and requires enabling VolumeAttributesClass feature (off by default). modifyVolumeStatus : MonitoringCoreosComV1ThanosRulerSpecStorageVolumeClaimTemplateStatusModifyVolumeStatus, default is Undefined, optional modify volume status phase : str, default is Undefined, optional @@ -5415,7 +6758,6 @@ schema MonitoringCoreosComV1ThanosRulerSpecStorageVolumeClaimTemplateStatusModif r""" ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. - This is a beta field and requires enabling VolumeAttributesClass feature (off by default). Attributes ---------- @@ -5534,7 +6876,6 @@ schema MonitoringCoreosComV1ThanosRulerSpecTopologySpreadConstraintsItems0: - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. If this value is nil, the behavior is equivalent to the Honor policy. - This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. nodeTaintsPolicy : str, default is Undefined, optional NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: @@ -5543,7 +6884,6 @@ schema MonitoringCoreosComV1ThanosRulerSpecTopologySpreadConstraintsItems0: - Ignore: node taints are ignored. All nodes are included. If this value is nil, the behavior is equivalent to the Ignore policy. - This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. topologyKey : str, default is Undefined, required TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. @@ -5630,7 +6970,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecTopologySpreadConstraintsItems0LabelS schema MonitoringCoreosComV1ThanosRulerSpecTracingConfig: r""" - Configures tracing. + tracingConfig defines the tracing configuration. The configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration @@ -6315,15 +7655,13 @@ schema MonitoringCoreosComV1ThanosRulerSpecVolumesItems0EphemeralVolumeClaimTemp volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, - it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass - will be applied to the claim but it's not allowed to reset this field to empty string once it is set. - If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass - will be set by the persistentvolume controller if it exists. + it can be changed after the claim is created. An empty string or nil value indicates that no + VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, + this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ - (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). volumeMode : str, default is Undefined, optional volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. @@ -6635,13 +7973,11 @@ schema MonitoringCoreosComV1ThanosRulerSpecVolumesItems0Glusterfs: r""" glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. - More info: https://examples.k8s.io/volumes/glusterfs/README.md Attributes ---------- endpoints : str, default is Undefined, required endpoints is the endpoint name that details Glusterfs topology. - More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod path : str, default is Undefined, required path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod @@ -6693,7 +8029,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecVolumesItems0Image: The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). - Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath). + Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type. Attributes @@ -6719,7 +8055,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecVolumesItems0Iscsi: r""" iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. - More info: https://examples.k8s.io/volumes/iscsi/README.md + More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi Attributes ---------- @@ -6899,6 +8235,8 @@ schema MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0: config map downwardAPI : MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0DownwardAPI, default is Undefined, optional downward API + podCertificate : MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0PodCertificate, default is Undefined, optional + pod certificate secret : MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0Secret, default is Undefined, optional secret serviceAccountToken : MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0ServiceAccountToken, default is Undefined, optional @@ -6907,6 +8245,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0: clusterTrustBundle?: MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0ClusterTrustBundle configMap?: MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0ConfigMap downwardAPI?: MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0DownwardAPI + podCertificate?: MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0PodCertificate secret?: MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0Secret serviceAccountToken?: MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0ServiceAccountToken @@ -7121,6 +8460,105 @@ schema MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0Do check: _regex_match(str(divisor), r"^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$") if divisor +schema MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0PodCertificate: + r""" + Projects an auto-rotating credential bundle (private key and certificate + chain) that the pod can use either as a TLS client or server. + + Kubelet generates a private key and uses it to send a + PodCertificateRequest to the named signer. Once the signer approves the + request and issues a certificate chain, Kubelet writes the key and + certificate chain to the pod filesystem. The pod does not start until + certificates have been issued for each podCertificate projected volume + source in its spec. + + Kubelet will begin trying to rotate the certificate at the time indicated + by the signer using the PodCertificateRequest.Status.BeginRefreshAt + timestamp. + + Kubelet can write a single file, indicated by the credentialBundlePath + field, or separate files, indicated by the keyPath and + certificateChainPath fields. + + The credential bundle is a single file in PEM format. The first PEM + entry is the private key (in PKCS#8 format), and the remaining PEM + entries are the certificate chain issued by the signer (typically, + signers will return their certificate chain in leaf-to-root order). + + Prefer using the credential bundle format, since your application code + can read it atomically. If you use keyPath and certificateChainPath, + your application must make two separate file reads. If these coincide + with a certificate rotation, it is possible that the private key and leaf + certificate you read may not correspond to each other. Your application + will need to check for this condition, and re-read until they are + consistent. + + The named signer controls chooses the format of the certificate it + issues; consult the signer implementation's documentation to learn how to + use the certificates it issues. + + Attributes + ---------- + certificateChainPath : str, default is Undefined, optional + Write the certificate chain at this path in the projected volume. + + Most applications should use credentialBundlePath. When using keyPath + and certificateChainPath, your application needs to check that the key + and leaf certificate are consistent, because it is possible to read the + files mid-rotation. + credentialBundlePath : str, default is Undefined, optional + Write the credential bundle at this path in the projected volume. + + The credential bundle is a single file that contains multiple PEM blocks. + The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private + key. + + The remaining blocks are CERTIFICATE blocks, containing the issued + certificate chain from the signer (leaf and any intermediates). + + Using credentialBundlePath lets your Pod's application code make a single + atomic read that retrieves a consistent key and certificate chain. If you + project them to separate files, your application code will need to + additionally check that the leaf certificate was issued to the key. + keyPath : str, default is Undefined, optional + Write the key at this path in the projected volume. + + Most applications should use credentialBundlePath. When using keyPath + and certificateChainPath, your application needs to check that the key + and leaf certificate are consistent, because it is possible to read the + files mid-rotation. + keyType : str, default is Undefined, required + The type of keypair Kubelet will generate for the pod. + + Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", + "ECDSAP521", and "ED25519". + maxExpirationSeconds : int, default is Undefined, optional + maxExpirationSeconds is the maximum lifetime permitted for the + certificate. + + Kubelet copies this value verbatim into the PodCertificateRequests it + generates for this projection. + + If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver + will reject values shorter than 3600 (1 hour). The maximum allowable + value is 7862400 (91 days). + + The signer implementation is then free to issue a certificate with any + lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600 + seconds (1 hour). This constraint is enforced by kube-apiserver. + `kubernetes.io` signers will never issue certificates with a lifetime + longer than 24 hours. + signerName : str, default is Undefined, required + Kubelet's generated CSRs will be addressed to this signer. + """ + certificateChainPath?: str + credentialBundlePath?: str + keyPath?: str + keyType: str + + maxExpirationSeconds?: int + signerName: str + schema MonitoringCoreosComV1ThanosRulerSpecVolumesItems0ProjectedSourcesItems0Secret: r""" secret information about the secret data to project @@ -7238,7 +8676,6 @@ schema MonitoringCoreosComV1ThanosRulerSpecVolumesItems0Rbd: r""" rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. - More info: https://examples.k8s.io/volumes/rbd/README.md Attributes ---------- @@ -7500,7 +8937,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecVolumesItems0VsphereVolume: schema MonitoringCoreosComV1ThanosRulerSpecWeb: r""" - Defines the configuration of the ThanosRuler web server. + web defines the configuration of the ThanosRuler web server. Attributes ---------- @@ -7514,14 +8951,14 @@ schema MonitoringCoreosComV1ThanosRulerSpecWeb: schema MonitoringCoreosComV1ThanosRulerSpecWebHTTPConfig: r""" - Defines HTTP parameters for web server. + httpConfig defines HTTP parameters for web server. Attributes ---------- headers : MonitoringCoreosComV1ThanosRulerSpecWebHTTPConfigHeaders, default is Undefined, optional headers http2 : bool, default is Undefined, optional - Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. + http2 enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. When TLSConfig is not configured, HTTP/2 will be disabled. Whenever the value of the field changes, a rolling update will be triggered. """ @@ -7530,30 +8967,30 @@ schema MonitoringCoreosComV1ThanosRulerSpecWebHTTPConfig: schema MonitoringCoreosComV1ThanosRulerSpecWebHTTPConfigHeaders: r""" - List of headers that can be added to HTTP responses. + headers defines a list of headers that can be added to HTTP responses. Attributes ---------- contentSecurityPolicy : str, default is Undefined, optional - Set the Content-Security-Policy header to HTTP responses. + contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank. strictTransportSecurity : str, default is Undefined, optional - Set the Strict-Transport-Security header to HTTP responses. + strictTransportSecurity defines the Strict-Transport-Security header to HTTP responses. Unset if blank. Please make sure that you use this with care as this header might force browsers to load Prometheus and the other applications hosted on the same domain and subdomains over HTTPS. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security xContentTypeOptions : str, default is Undefined, optional - Set the X-Content-Type-Options header to HTTP responses. + xContentTypeOptions defines the X-Content-Type-Options header to HTTP responses. Unset if blank. Accepted value is nosniff. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options xFrameOptions : str, default is Undefined, optional - Set the X-Frame-Options header to HTTP responses. + xFrameOptions defines the X-Frame-Options header to HTTP responses. Unset if blank. Accepted values are deny and sameorigin. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options xXSSProtection : str, default is Undefined, optional - Set the X-XSS-Protection header to all responses. + xXSSProtection defines the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection """ @@ -7565,44 +9002,44 @@ schema MonitoringCoreosComV1ThanosRulerSpecWebHTTPConfigHeaders: schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfig: r""" - Defines the TLS parameters for HTTPS. + tlsConfig defines the TLS parameters for HTTPS. Attributes ---------- cert : MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the TLS certificate file in the container for the web server. + certFile defines the path to the TLS certificate file in the container for the web server. Either `keySecret` or `keyFile` must be defined. It is mutually exclusive with `cert`. cipherSuites : [str], default is Undefined, optional - List of supported cipher suites for TLS versions up to TLS 1.2. + cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2. If not defined, the Go default cipher suites are used. Available cipher suites are documented in the Go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants clientAuthType : str, default is Undefined, optional - The server policy for client TLS authentication. + clientAuthType defines the server policy for client TLS authentication. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType clientCAFile : str, default is Undefined, optional - Path to the CA certificate file for client certificate authentication to + clientCAFile defines the path to the CA certificate file for client certificate authentication to the server. It is mutually exclusive with `client_ca`. client_ca : MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigClientCa, default is Undefined, optional client ca curvePreferences : [str], default is Undefined, optional - Elliptic curves that will be used in an ECDHE handshake, in preference + curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the Go documentation: https://golang.org/pkg/crypto/tls/#CurveID keyFile : str, default is Undefined, optional - Path to the TLS private key file in the container for the web server. + keyFile defines the path to the TLS private key file in the container for the web server. If defined, either `cert` or `certFile` must be defined. @@ -7610,11 +9047,11 @@ schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfig: keySecret : MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum TLS version that is acceptable. + maxVersion defines the Maximum TLS version that is acceptable. minVersion : str, default is Undefined, optional - Minimum TLS version that is acceptable. + minVersion defines the minimum TLS version that is acceptable. preferServerCipherSuites : bool, default is Undefined, optional - Controls whether the server selects the client's most preferred cipher + preferServerCipherSuites defines whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in @@ -7635,7 +9072,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfig: schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigCert: r""" - Secret or ConfigMap containing the TLS certificate for the web server. + cert defines the Secret or ConfigMap containing the TLS certificate for the web server. Either `keySecret` or `keyFile` must be defined. @@ -7653,7 +9090,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigCert: schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7675,7 +9112,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigCertConfigMap: schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7697,7 +9134,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigCertSecret: schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigClientCa: r""" - Secret or ConfigMap containing the CA certificate for client certificate + client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server. It is mutually exclusive with `clientCAFile`. @@ -7714,7 +9151,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigClientCa: schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigClientCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7736,7 +9173,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigClientCaConfigMap: schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigClientCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7758,7 +9195,7 @@ schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigClientCaSecret: schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigKeySecret: r""" - Secret containing the TLS private key for the web server. + keySecret defines the secret containing the TLS private key for the web server. Either `cert` or `certFile` must be defined. @@ -7784,39 +9221,35 @@ schema MonitoringCoreosComV1ThanosRulerSpecWebTLSConfigKeySecret: schema MonitoringCoreosComV1ThanosRulerStatus: r""" - Most recent observed status of the ThanosRuler cluster. Read-only. + status defines the most recent observed status of the ThanosRuler cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Attributes ---------- - availableReplicas : int, default is Undefined, required - Total number of available pods (ready for at least minReadySeconds) + availableReplicas : int, default is Undefined, optional + availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this ThanosRuler deployment. conditions : [MonitoringCoreosComV1ThanosRulerStatusConditionsItems0], default is Undefined, optional - The current state of the ThanosRuler object. - paused : bool, default is Undefined, required - Represents whether any actions on the underlying managed objects are + conditions defines the current state of the ThanosRuler object. + paused : bool, default is Undefined, optional + paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed. - replicas : int, default is Undefined, required - Total number of non-terminated pods targeted by this ThanosRuler deployment + replicas : int, default is Undefined, optional + replicas defines the total number of non-terminated pods targeted by this ThanosRuler deployment (their labels match the selector). - unavailableReplicas : int, default is Undefined, required - Total number of unavailable pods targeted by this ThanosRuler deployment. - updatedReplicas : int, default is Undefined, required - Total number of non-terminated pods targeted by this ThanosRuler deployment + unavailableReplicas : int, default is Undefined, optional + unavailableReplicas defines the total number of unavailable pods targeted by this ThanosRuler deployment. + updatedReplicas : int, default is Undefined, optional + updatedReplicas defines the total number of non-terminated pods targeted by this ThanosRuler deployment that have the desired version spec. """ - availableReplicas: int - + availableReplicas?: int conditions?: [MonitoringCoreosComV1ThanosRulerStatusConditionsItems0] - paused: bool - - replicas: int - - unavailableReplicas: int - - updatedReplicas: int + paused?: bool + replicas?: int + unavailableReplicas?: int + updatedReplicas?: int schema MonitoringCoreosComV1ThanosRulerStatusConditionsItems0: r""" @@ -7828,19 +9261,19 @@ schema MonitoringCoreosComV1ThanosRulerStatusConditionsItems0: lastTransitionTime : str, default is Undefined, required lastTransitionTime is the time of the last update to the current status property. message : str, default is Undefined, optional - Human-readable message indicating details for the condition's last transition. + message defines human-readable message indicating details for the condition's last transition. observedGeneration : int, default is Undefined, optional - ObservedGeneration represents the .metadata.generation that the + observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if `.metadata.generation` is currently 12, but the `.status.conditions[].observedGeneration` is 9, the condition is out of date with respect to the current state of the instance. reason : str, default is Undefined, optional - Reason for the condition's last transition. + reason for the condition's last transition. status : str, default is Undefined, required - Status of the condition. + status of the condition. $type : str, default is Undefined, required - Type of the condition being reported. + type of the condition being reported. """ lastTransitionTime: str diff --git a/docs/examples/src/charts/kube_prometheus_stack/api/v1alpha1/monitoring_coreos_com_v1alpha1_alertmanager_config.k b/docs/examples/src/charts/kube_prometheus_stack/api/v1alpha1/monitoring_coreos_com_v1alpha1_alertmanager_config.k index dc6f8e12..aa0844ae 100644 --- a/docs/examples/src/charts/kube_prometheus_stack/api/v1alpha1/monitoring_coreos_com_v1alpha1_alertmanager_config.k +++ b/docs/examples/src/charts/kube_prometheus_stack/api/v1alpha1/monitoring_coreos_com_v1alpha1_alertmanager_config.k @@ -33,22 +33,17 @@ schema AlertmanagerConfig: schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpec: r""" - AlertmanagerConfigSpec is a specification of the desired behavior of the - Alertmanager configuration. - By default, the Alertmanager configuration only applies to alerts for which - the `namespace` label is equal to the namespace of the AlertmanagerConfig - resource (see the `.spec.alertmanagerConfigMatcherStrategy` field of the - Alertmanager CRD). + spec defines the specification of AlertmanagerConfigSpec Attributes ---------- inhibitRules : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecInhibitRulesItems0], default is Undefined, optional - List of inhibition rules. The rules will only apply to alerts matching + inhibitRules defines the list of inhibition rules. The rules will only apply to alerts matching the resource's namespace. muteTimeIntervals : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecMuteTimeIntervalsItems0], default is Undefined, optional - List of MuteTimeInterval specifying when the routes should be muted. + muteTimeIntervals defines the list of MuteTimeInterval specifying when the routes should be muted. receivers : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0], default is Undefined, optional - List of receivers. + receivers defines the list of receivers. route : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecRoute, default is Undefined, optional route """ @@ -66,15 +61,16 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecInhibitRulesItems0: Attributes ---------- equal : [str], default is Undefined, optional - Labels that must have an equal value in the source and target alert for - the inhibition to take effect. + equal defines labels that must have an equal value in the source and target alert + for the inhibition to take effect. This ensures related alerts are properly grouped. sourceMatch : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecInhibitRulesItems0SourceMatchItems0], default is Undefined, optional - Matchers for which one or more alerts have to exist for the inhibition - to take effect. The operator enforces that the alert matches the - resource's namespace. + sourceMatch defines matchers for which one or more alerts have to exist for the inhibition + to take effect. The operator enforces that the alert matches the resource's namespace. + These are the "trigger" alerts that cause other alerts to be inhibited. targetMatch : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecInhibitRulesItems0TargetMatchItems0], default is Undefined, optional - Matchers that have to be fulfilled in the alerts to be muted. The - operator enforces that the alert matches the resource's namespace. + targetMatch defines matchers that have to be fulfilled in the alerts to be muted. + The operator enforces that the alert matches the resource's namespace. + When these conditions are met, matching alerts will be inhibited (silenced). """ equal?: [str] sourceMatch?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecInhibitRulesItems0SourceMatchItems0] @@ -87,15 +83,18 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecInhibitRulesItems0Source Attributes ---------- matchType : str, default is Undefined, optional - Match operation available with AlertManager >= v0.22.0 and - takes precedence over Regex (deprecated) if non-empty. + matchType defines the match operation available with AlertManager >= v0.22.0. + Takes precedence over Regex (deprecated) if non-empty. + Valid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match). name : str, default is Undefined, required - Label to match. + name defines the label to match. + This specifies which alert label should be evaluated. regex : bool, default is Undefined, optional - Whether to match on equality (false) or regular-expression (true). + regex defines whether to match on equality (false) or regular-expression (true). Deprecated: for AlertManager >= v0.22.0, `matchType` should be used instead. value : str, default is Undefined, optional - Label value to match. + value defines the label value to match. + This is the expected value for the specified label. """ matchType?: "!=" | "=" | "=~" | "!~" name: str @@ -113,15 +112,18 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecInhibitRulesItems0Target Attributes ---------- matchType : str, default is Undefined, optional - Match operation available with AlertManager >= v0.22.0 and - takes precedence over Regex (deprecated) if non-empty. + matchType defines the match operation available with AlertManager >= v0.22.0. + Takes precedence over Regex (deprecated) if non-empty. + Valid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match). name : str, default is Undefined, required - Label to match. + name defines the label to match. + This specifies which alert label should be evaluated. regex : bool, default is Undefined, optional - Whether to match on equality (false) or regular-expression (true). + regex defines whether to match on equality (false) or regular-expression (true). Deprecated: for AlertManager >= v0.22.0, `matchType` should be used instead. value : str, default is Undefined, optional - Label value to match. + value defines the label value to match. + This is the expected value for the specified label. """ matchType?: "!=" | "=" | "=~" | "!~" name: str @@ -139,9 +141,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecMuteTimeIntervalsItems0: Attributes ---------- name : str, default is Undefined, required - Name of the time interval + name of the time interval timeIntervals : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecMuteTimeIntervalsItems0TimeIntervalsItems0], default is Undefined, optional - TimeIntervals is a list of TimeInterval + timeIntervals defines a list of TimeInterval """ name: str @@ -154,15 +156,15 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecMuteTimeIntervalsItems0T Attributes ---------- daysOfMonth : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecMuteTimeIntervalsItems0TimeIntervalsItems0DaysOfMonthItems0], default is Undefined, optional - DaysOfMonth is a list of DayOfMonthRange + daysOfMonth defines a list of DayOfMonthRange months : [str], default is Undefined, optional - Months is a list of MonthRange + months defines a list of MonthRange times : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecMuteTimeIntervalsItems0TimeIntervalsItems0TimesItems0], default is Undefined, optional - Times is a list of TimeRange + times defines a list of TimeRange weekdays : [str], default is Undefined, optional - Weekdays is a list of WeekdayRange + weekdays defines a list of WeekdayRange years : [str], default is Undefined, optional - Years is a list of YearRange + years defines a list of YearRange """ daysOfMonth?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecMuteTimeIntervalsItems0TimeIntervalsItems0DaysOfMonthItems0] months?: [str] @@ -182,9 +184,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecMuteTimeIntervalsItems0T Attributes ---------- end : int, default is Undefined, optional - End of the inclusive range + end of the inclusive range start : int, default is Undefined, optional - Start of the inclusive range + start of the inclusive range """ end?: int start?: int @@ -202,9 +204,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecMuteTimeIntervalsItems0T Attributes ---------- endTime : str, default is Undefined, optional - EndTime is the end time in 24hr format. + endTime defines the end time in 24hr format. startTime : str, default is Undefined, optional - StartTime is the start time in 24hr format. + startTime defines the start time in 24hr format. """ endTime?: str startTime?: str @@ -220,43 +222,51 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0: Attributes ---------- discordConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0], default is Undefined, optional - List of Discord configurations. + discordConfigs defines the list of Slack configurations. emailConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0], default is Undefined, optional - List of Email configurations. + emailConfigs defines the list of Email configurations. msteamsConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0], default is Undefined, optional - List of MSTeams configurations. + msteamsConfigs defines the list of MSTeams configurations. It requires Alertmanager >= 0.26.0. + msteamsv2Configs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0], default is Undefined, optional + msteamsv2Configs defines the list of MSTeamsV2 configurations. + It requires Alertmanager >= 0.28.0. name : str, default is Undefined, required - Name of the receiver. Must be unique across all items from the list. + name defines the name of the receiver. Must be unique across all items from the list. opsgenieConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0], default is Undefined, optional - List of OpsGenie configurations. + opsgenieConfigs defines the list of OpsGenie configurations. pagerdutyConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0], default is Undefined, optional - List of PagerDuty configurations. + pagerdutyConfigs defines the List of PagerDuty configurations. pushoverConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0], default is Undefined, optional - List of Pushover configurations. + pushoverConfigs defines the list of Pushover configurations. + rocketchatConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0], default is Undefined, optional + rocketchatConfigs defines the list of RocketChat configurations. + It requires Alertmanager >= 0.28.0. slackConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0], default is Undefined, optional - List of Slack configurations. + slackConfigs defines the list of Slack configurations. snsConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0], default is Undefined, optional - List of SNS configurations + snsConfigs defines the list of SNS configurations telegramConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0], default is Undefined, optional - List of Telegram configurations. + telegramConfigs defines the list of Telegram configurations. victoropsConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0], default is Undefined, optional - List of VictorOps configurations. + victoropsConfigs defines the list of VictorOps configurations. webexConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0], default is Undefined, optional - List of Webex configurations. + webexConfigs defines the list of Webex configurations. webhookConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0], default is Undefined, optional - List of webhook configurations. + webhookConfigs defines the List of webhook configurations. wechatConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0], default is Undefined, optional - List of WeChat configurations. + wechatConfigs defines the list of WeChat configurations. """ discordConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0] emailConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0] msteamsConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0] + msteamsv2Configs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0] name: str opsgenieConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0] pagerdutyConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0] pushoverConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0] + rocketchatConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0] slackConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0] snsConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0] telegramConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0] @@ -277,25 +287,39 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo ---------- apiURL : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0APIURL, default is Undefined, required api URL + avatarURL : str, default is Undefined, optional + avatarURL defines the avatar url of the message sender. + content : str, default is Undefined, optional + content defines the template of the content's body. httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfig, default is Undefined, optional http config message : str, default is Undefined, optional - The template of the message's body. + message defines the template of the message's body. sendResolved : bool, default is Undefined, optional - Whether or not to notify about resolved alerts. + sendResolved defines whether or not to notify about resolved alerts. title : str, default is Undefined, optional - The template of the message's title. + title defines the template of the message's title. + username : str, default is Undefined, optional + username defines the username of the message sender. """ apiURL: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0APIURL + avatarURL?: str + content?: str httpConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfig message?: str sendResolved?: bool title?: str + username?: str + + check: + _regex_match(str(avatarURL), r"^https?://.+$") if avatarURL + len(content) >= 1 if content + len(username) >= 1 if username schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0APIURL: r""" - The secret's key that contains the Discord webhook URL. + apiURL defines the secret's key that contains the Discord webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -319,7 +343,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfig: r""" - HTTP client configuration. + httpConfig defines the HTTP client configuration. Attributes ---------- @@ -329,37 +353,40 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo basic auth bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. followRedirects : bool, default is Undefined, optional - FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyURL : str, default is Undefined, optional - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional tls config """ authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigAuthorization basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigBasicAuth bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool followRedirects?: bool noProxy?: str oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2 @@ -370,11 +397,11 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigAuthorization: r""" - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. Attributes @@ -382,7 +409,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -393,7 +420,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -415,7 +442,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigBasicAuth: r""" - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. Attributes @@ -430,7 +457,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -453,7 +480,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -476,7 +503,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigBearerTokenSecret: r""" - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -501,7 +528,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2: r""" - OAuth2 client credentials used to fetch a token for the targets. + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. Attributes ---------- @@ -510,31 +538,31 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2ClientID @@ -550,12 +578,12 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -570,7 +598,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -592,7 +620,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -614,7 +642,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -659,7 +687,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -669,19 +697,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2TLSConfigCert @@ -693,7 +721,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -707,7 +735,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -729,7 +757,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -751,7 +779,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -765,7 +793,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -787,7 +815,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -809,7 +837,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -853,7 +881,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfig: r""" - TLS configuration for the client. + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. Attributes ---------- @@ -862,19 +891,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfigCert @@ -886,7 +915,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -900,7 +929,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -922,7 +951,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -944,7 +973,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -958,7 +987,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -980,7 +1009,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1002,7 +1031,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0DiscordConfigsItems0HTTPConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -1029,35 +1058,43 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConf Attributes ---------- authIdentity : str, default is Undefined, optional - The identity to use for authentication. + authIdentity defines the identity to use for SMTP authentication. + This is typically used with PLAIN authentication mechanism. authPassword : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0AuthPassword, default is Undefined, optional auth password authSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0AuthSecret, default is Undefined, optional auth secret authUsername : str, default is Undefined, optional - The username to use for authentication. + authUsername defines the username to use for SMTP authentication. + This is used for SMTP AUTH when the server requires authentication. from : str, default is Undefined, optional - The sender address. + from defines the sender address for email notifications. + This appears as the "From" field in the email header. headers : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0HeadersItems0], default is Undefined, optional - Further headers email header key/value pairs. Overrides any headers - previously set by the notification implementation. + headers defines additional email header key/value pairs. + These override any headers previously set by the notification implementation. hello : str, default is Undefined, optional - The hostname to identify to the SMTP server. + hello defines the hostname to identify to the SMTP server. + This is used in the SMTP HELO/EHLO command during the connection handshake. html : str, default is Undefined, optional - The HTML body of the email notification. + html defines the HTML body of the email notification. + This allows for rich formatting in the email content. requireTLS : bool, default is Undefined, optional - The SMTP TLS requirement. + requireTLS defines the SMTP TLS requirement. Note that Go does not support unencrypted connections to remote SMTP endpoints. sendResolved : bool, default is Undefined, optional - Whether or not to notify about resolved alerts. + sendResolved defines whether or not to notify about resolved alerts. smarthost : str, default is Undefined, optional - The SMTP host and port through which emails are sent. E.g. example.com:25 + smarthost defines the SMTP host and port through which emails are sent. + Format should be "hostname:port", e.g. "smtp.example.com:587". text : str, default is Undefined, optional - The text body of the email notification. + text defines the plain text body of the email notification. + This provides a fallback for email clients that don't support HTML. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0TLSConfig, default is Undefined, optional tls config to : str, default is Undefined, optional - The email address to send notifications to. + to defines the email address to send notifications to. + This is the recipient address for alert notifications. """ authIdentity?: str authPassword?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0AuthPassword @@ -1076,7 +1113,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0AuthPassword: r""" - The secret's key that contains the password to use for authentication. + authPassword defines the secret's key that contains the password to use for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -1100,7 +1137,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0AuthSecret: r""" - The secret's key that contains the CRAM-MD5 secret. + authSecret defines the secret's key that contains the CRAM-MD5 secret. + This is used for CRAM-MD5 authentication mechanism. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -1129,9 +1167,11 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConf Attributes ---------- key : str, default is Undefined, required - Key of the tuple. + key defines the key of the tuple. + This is the identifier or name part of the key-value pair. value : str, default is Undefined, required - Value of the tuple. + value defines the value of the tuple. + This is the data or content associated with the key. """ key: str @@ -1142,7 +1182,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0TLSConfig: r""" - TLS configuration + tlsConfig defines the TLS configuration for SMTP connections. + This includes settings for certificates, CA validation, and TLS protocol options. Attributes ---------- @@ -1151,19 +1192,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConf cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0TLSConfigCert @@ -1175,7 +1216,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -1189,7 +1230,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1211,7 +1252,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1233,7 +1274,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -1247,7 +1288,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1269,7 +1310,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1291,7 +1332,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0EmailConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -1321,14 +1362,17 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfig, default is Undefined, optional http config sendResolved : bool, default is Undefined, optional - Whether to notify about resolved alerts. + sendResolved defines whether or not to notify about resolved alerts. summary : str, default is Undefined, optional - Message summary template. + summary defines the message summary template for Teams notifications. + This provides a brief overview that appears in Teams notification previews. It requires Alertmanager >= 0.27.0. text : str, default is Undefined, optional - Message body template. + text defines the message body template for Teams notifications. + This contains the detailed content of the Teams message. title : str, default is Undefined, optional - Message title template. + title defines the message title template for Teams notifications. + This appears as the main heading of the Teams message card. webhookUrl : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0WebhookURL, default is Undefined, required webhook Url """ @@ -1341,7 +1385,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfig: r""" - HTTP client configuration. + httpConfig defines the HTTP client configuration for Teams webhook requests. Attributes ---------- @@ -1351,37 +1395,40 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo basic auth bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. followRedirects : bool, default is Undefined, optional - FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyURL : str, default is Undefined, optional - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional tls config """ authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigAuthorization basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigBasicAuth bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool followRedirects?: bool noProxy?: str oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2 @@ -1392,11 +1439,11 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigAuthorization: r""" - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. Attributes @@ -1404,7 +1451,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -1415,7 +1462,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -1437,7 +1484,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigBasicAuth: r""" - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. Attributes @@ -1452,7 +1499,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -1475,7 +1522,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -1498,7 +1545,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigBearerTokenSecret: r""" - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -1523,7 +1570,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2: r""" - OAuth2 client credentials used to fetch a token for the targets. + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. Attributes ---------- @@ -1532,31 +1580,31 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2ClientID @@ -1572,12 +1620,12 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -1592,7 +1640,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1614,7 +1662,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1636,7 +1684,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -1681,7 +1729,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -1691,19 +1739,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2TLSConfigCert @@ -1715,7 +1763,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -1729,7 +1777,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1751,7 +1799,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1773,7 +1821,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -1787,7 +1835,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1809,7 +1857,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1831,7 +1879,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -1875,7 +1923,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfig: r""" - TLS configuration for the client. + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. Attributes ---------- @@ -1884,19 +1933,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfigCert @@ -1908,7 +1957,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -1922,7 +1971,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1944,7 +1993,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1966,7 +2015,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -1980,7 +2029,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2002,7 +2051,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2024,7 +2073,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0HTTPConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -2046,7 +2095,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsConfigsItems0WebhookURL: r""" - MSTeams webhook URL. + webhookUrl defines the MSTeams webhook URL for sending notifications. + This is the incoming webhook URL configured in your Teams channel. Attributes ---------- @@ -2066,180 +2116,117 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0MsteamsCo name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0: r""" - OpsGenieConfig configures notifications via OpsGenie. - See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config + MSTeamsV2Config configures notifications via Microsoft Teams using the new message format with adaptive cards as required by flows. + See https://prometheus.io/docs/alerting/latest/configuration/#msteamsv2_config + It requires Alertmanager >= 0.28.0. Attributes ---------- - actions : str, default is Undefined, optional - Comma separated list of actions that will be available for the alert. - apiKey : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0APIKey, default is Undefined, optional - api key - apiURL : str, default is Undefined, optional - The URL to send OpsGenie API requests to. - description : str, default is Undefined, optional - Description of the incident. - details : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0DetailsItems0], default is Undefined, optional - A set of arbitrary key/value pairs that provide further detail about the incident. - entity : str, default is Undefined, optional - Optional field that can be used to specify which domain alert is related to. - httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfig, default is Undefined, optional + httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfig, default is Undefined, optional http config - message : str, default is Undefined, optional - Alert text limited to 130 characters. - note : str, default is Undefined, optional - Additional alert note. - priority : str, default is Undefined, optional - Priority level of alert. Possible values are P1, P2, P3, P4, and P5. - responders : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0RespondersItems0], default is Undefined, optional - List of responders responsible for notifications. sendResolved : bool, default is Undefined, optional - Whether or not to notify about resolved alerts. - source : str, default is Undefined, optional - Backlink to the sender of the notification. - tags : str, default is Undefined, optional - Comma separated list of tags attached to the notifications. - updateAlerts : bool, default is Undefined, optional - Whether to update message and description of the alert in OpsGenie if it already exists - By default, the alert is never updated in OpsGenie, the new message only appears in activity log. + sendResolved defines whether or not to notify about resolved alerts. + text : str, default is Undefined, optional + text defines the message body template for adaptive card notifications. + This contains the detailed content displayed in the Teams adaptive card format. + title : str, default is Undefined, optional + title defines the message title template for adaptive card notifications. + This appears as the main heading in the Teams adaptive card. + webhookURL : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0WebhookURL, default is Undefined, optional + webhook URL """ - actions?: str - apiKey?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0APIKey - apiURL?: str - description?: str - details?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0DetailsItems0] - entity?: str - httpConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfig - message?: str - note?: str - priority?: str - responders?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0RespondersItems0] + httpConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfig sendResolved?: bool - source?: str - tags?: str - updateAlerts?: bool - -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0APIKey: - r""" - The secret's key that contains the OpsGenie API key. - The secret needs to be in the same namespace as the AlertmanagerConfig - object and accessible by the Prometheus Operator. - - Attributes - ---------- - key : str, default is Undefined, required - The key of the secret to select from. Must be a valid secret key. - name : str, default is Undefined, optional - 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 - optional : bool, default is Undefined, optional - Specify whether the Secret or its key must be defined - """ - key: str - - name?: str = "" - optional?: bool - -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0DetailsItems0: - r""" - KeyValue defines a (key, value) tuple. - - Attributes - ---------- - key : str, default is Undefined, required - Key of the tuple. - value : str, default is Undefined, required - Value of the tuple. - """ - key: str - - value: str + text?: str + title?: str + webhookURL?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0WebhookURL check: - len(key) >= 1 + len(text) >= 1 if text + len(title) >= 1 if title -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfig: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfig: r""" - HTTP client configuration. + httpConfig defines the HTTP client configuration for Teams webhook requests. Attributes ---------- - authorization : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigAuthorization, default is Undefined, optional + authorization : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigAuthorization, default is Undefined, optional authorization - basicAuth : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuth, default is Undefined, optional + basicAuth : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigBasicAuth, default is Undefined, optional basic auth - bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional + bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. followRedirects : bool, default is Undefined, optional - FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. - oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2, default is Undefined, optional + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2, default is Undefined, optional oauth2 - proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyURL : str, default is Undefined, optional - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. - tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional + proxyUrl defines the HTTP proxy server to use. + tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional tls config """ - authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigAuthorization - basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuth - bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBearerTokenSecret + authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigAuthorization + basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigBasicAuth + bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool followRedirects?: bool noProxy?: str - oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2 - proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigProxyConnectHeaderItems0]} + oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2 + proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigProxyConnectHeaderItems0]} proxyFromEnvironment?: bool proxyURL?: str proxyUrl?: str - tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfig + tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigAuthorization: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigAuthorization: r""" - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. Attributes ---------- - credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional + credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" """ - credentials?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigAuthorizationCredentials + credentials?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigAuthorizationCredentials $type?: str -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigAuthorizationCredentials: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -2259,24 +2246,24 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuth: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigBasicAuth: r""" - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. Attributes ---------- - password : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuthPassword, default is Undefined, optional + password : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigBasicAuthPassword, default is Undefined, optional password - username : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuthUsername, default is Undefined, optional + username : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigBasicAuthUsername, default is Undefined, optional username """ - password?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuthPassword - username?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuthUsername + password?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigBasicAuthPassword + username?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigBasicAuthUsername -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuthPassword: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -2297,9 +2284,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuthUsername: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -2320,9 +2307,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBearerTokenSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigBearerTokenSecret: r""" - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -2345,78 +2332,79 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2: r""" - OAuth2 client credentials used to fetch a token for the targets. + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. Attributes ---------- - clientId : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientID, default is Undefined, required + clientId : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ClientID, default is Undefined, required client Id - clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required + clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. - proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. - tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional + scopes defines the OAuth2 scopes used for the token request. + tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ - clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientID + clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ClientID - clientSecret: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientSecret + clientSecret: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ClientSecret endpointParams?: {str:str} noProxy?: str - proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]} + proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]} proxyFromEnvironment?: bool proxyUrl?: str scopes?: [str] - tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfig + tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfig tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientID: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientIDConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ClientIDConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientIDSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ClientIDSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientIDConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientIDSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ClientIDConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ClientIDSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientIDConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2436,9 +2424,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientIDSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2458,9 +2446,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -2481,7 +2469,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0: r""" SecretKeySelector selects a key of a Secret. @@ -2503,57 +2491,57 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfig: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes ---------- - ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCa, default is Undefined, optional + ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCa, default is Undefined, optional ca - cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional + cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. - keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ - ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCa - cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCert + ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCa + cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCert insecureSkipVerify?: bool - keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigKeySecret + keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigKeySecret maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" serverName?: str -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCa: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCaSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCaSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCaSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCaSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2573,9 +2561,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2595,23 +2583,23 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCert: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCertSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCertSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCertSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCertSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2631,9 +2619,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2653,9 +2641,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -2675,7 +2663,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigProxyConnectHeaderItems0: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigProxyConnectHeaderItems0: r""" SecretKeySelector selects a key of a Secret. @@ -2697,56 +2685,57 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfig: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfig: r""" - TLS configuration for the client. + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. Attributes ---------- - ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCa, default is Undefined, optional + ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCa, default is Undefined, optional ca - cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional + cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. - keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ - ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCa - cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCert + ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCa + cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCert insecureSkipVerify?: bool - keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigKeySecret + keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigKeySecret maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" serverName?: str -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCa: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCaConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCaConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCaSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCaSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCaConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCaSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCaConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCaSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCaConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2766,9 +2755,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCaSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2788,23 +2777,23 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCert: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCertConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCertConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCertSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCertSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCertConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCertSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCertConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCertSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCertConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2824,9 +2813,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCertSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2846,9 +2835,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigKeySecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0HTTPConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -2868,98 +2857,131 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0RespondersItems0: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Msteamsv2ConfigsItems0WebhookURL: r""" - OpsGenieConfigResponder defines a responder to an incident. - One of `id`, `name` or `username` has to be defined. + webhookURL defines the MSTeams incoming webhook URL for adaptive card notifications. + This webhook must support the newer adaptive cards format required by Teams flows. Attributes ---------- - id : str, default is Undefined, optional - ID of the responder. + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. name : str, default is Undefined, optional - Name of the responder. - $type : str, default is Undefined, required - Type of responder. - username : str, default is Undefined, optional - Username of the responder. + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined """ - id?: str - name?: str - $type: str - - username?: str + key: str - check: - len($type) >= 1 + name?: str = "" + optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0: r""" - PagerDutyConfig configures notifications via PagerDuty. - See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config + OpsGenieConfig configures notifications via OpsGenie. + See https://prometheus.io/docs/alerting/latest/configuration/#opsgenie_config Attributes ---------- - class : str, default is Undefined, optional - The class/type of the event. - client : str, default is Undefined, optional - Client identification. - clientURL : str, default is Undefined, optional - Backlink to the sender of notification. - component : str, default is Undefined, optional - The part or component of the affected system that is broken. + actions : str, default is Undefined, optional + actions defines a comma separated list of actions that will be available for the alert. + These appear as action buttons in the OpsGenie interface. + apiKey : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0APIKey, default is Undefined, optional + api key + apiURL : str, default is Undefined, optional + apiURL defines the URL to send OpsGenie API requests to. + When not specified, defaults to the standard OpsGenie API endpoint. description : str, default is Undefined, optional - Description of the incident. - details : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0DetailsItems0], default is Undefined, optional - Arbitrary key/value pairs that provide further detail about the incident. - group : str, default is Undefined, optional - A cluster or grouping of sources. - httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfig, default is Undefined, optional + description defines the detailed description of the incident. + This provides additional context beyond the message field. + details : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0DetailsItems0], default is Undefined, optional + details defines a set of arbitrary key/value pairs that provide further detail about the incident. + These appear as additional fields in the OpsGenie alert. + entity : str, default is Undefined, optional + entity defines an optional field that can be used to specify which domain alert is related to. + This helps group related alerts together in OpsGenie. + httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfig, default is Undefined, optional http config - pagerDutyImageConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0PagerDutyImageConfigsItems0], default is Undefined, optional - A list of image details to attach that provide further detail about an incident. - pagerDutyLinkConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0PagerDutyLinkConfigsItems0], default is Undefined, optional - A list of link details to attach that provide further detail about an incident. - routingKey : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0RoutingKey, default is Undefined, optional - routing key + message : str, default is Undefined, optional + message defines the alert text limited to 130 characters. + This appears as the main alert title in OpsGenie. + note : str, default is Undefined, optional + note defines an additional alert note. + This provides supplementary information about the alert. + priority : str, default is Undefined, optional + priority defines the priority level of alert. + Possible values are P1, P2, P3, P4, and P5, where P1 is highest priority. + responders : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0RespondersItems0], default is Undefined, optional + responders defines the list of responders responsible for notifications. + These determine who gets notified when the alert is created. sendResolved : bool, default is Undefined, optional - Whether or not to notify about resolved alerts. - serviceKey : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0ServiceKey, default is Undefined, optional - service key - severity : str, default is Undefined, optional - Severity of the incident. + sendResolved defines whether or not to notify about resolved alerts. source : str, default is Undefined, optional - Unique location of the affected system. - url : str, default is Undefined, optional - The URL to send requests to. + source defines the backlink to the sender of the notification. + This helps identify where the alert originated from. + tags : str, default is Undefined, optional + tags defines a comma separated list of tags attached to the notifications. + These help categorize and filter alerts within OpsGenie. + updateAlerts : bool, default is Undefined, optional + updateAlerts defines Whether to update message and description of the alert in OpsGenie if it already exists + By default, the alert is never updated in OpsGenie, the new message only appears in activity log. """ - class?: str - client?: str - clientURL?: str - component?: str + actions?: str + apiKey?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0APIKey + apiURL?: str description?: str - details?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0DetailsItems0] - group?: str - httpConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfig - pagerDutyImageConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0PagerDutyImageConfigsItems0] - pagerDutyLinkConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0PagerDutyLinkConfigsItems0] - routingKey?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0RoutingKey + details?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0DetailsItems0] + entity?: str + httpConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfig + message?: str + note?: str + priority?: str + responders?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0RespondersItems0] sendResolved?: bool - serviceKey?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0ServiceKey - severity?: str source?: str - url?: str + tags?: str + updateAlerts?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0DetailsItems0: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0APIKey: + r""" + apiKey defines the secret's key that contains the OpsGenie API key. + The secret needs to be in the same namespace as the AlertmanagerConfig + object and accessible by the Prometheus Operator. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0DetailsItems0: r""" KeyValue defines a (key, value) tuple. Attributes ---------- key : str, default is Undefined, required - Key of the tuple. + key defines the key of the tuple. + This is the identifier or name part of the key-value pair. value : str, default is Undefined, required - Value of the tuple. + value defines the value of the tuple. + This is the data or content associated with the key. """ key: str @@ -2968,83 +2990,86 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty check: len(key) >= 1 -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfig: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfig: r""" - HTTP client configuration. + httpConfig defines the HTTP client configuration for OpsGenie API requests. Attributes ---------- - authorization : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigAuthorization, default is Undefined, optional + authorization : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigAuthorization, default is Undefined, optional authorization - basicAuth : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuth, default is Undefined, optional + basicAuth : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuth, default is Undefined, optional basic auth - bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional + bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. followRedirects : bool, default is Undefined, optional - FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. - oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2, default is Undefined, optional + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2, default is Undefined, optional oauth2 - proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyURL : str, default is Undefined, optional - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. - tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional + proxyUrl defines the HTTP proxy server to use. + tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional tls config """ - authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigAuthorization - basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuth - bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBearerTokenSecret + authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigAuthorization + basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuth + bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool followRedirects?: bool noProxy?: str - oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2 - proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigProxyConnectHeaderItems0]} + oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2 + proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigProxyConnectHeaderItems0]} proxyFromEnvironment?: bool proxyURL?: str proxyUrl?: str - tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfig + tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigAuthorization: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigAuthorization: r""" - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. Attributes ---------- - credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional + credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" """ - credentials?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigAuthorizationCredentials + credentials?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigAuthorizationCredentials $type?: str -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigAuthorizationCredentials: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -3064,24 +3089,24 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuth: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuth: r""" - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. Attributes ---------- - password : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuthPassword, default is Undefined, optional + password : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuthPassword, default is Undefined, optional password - username : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuthUsername, default is Undefined, optional + username : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuthUsername, default is Undefined, optional username """ - password?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuthPassword - username?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuthUsername + password?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuthPassword + username?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuthUsername -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuthPassword: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -3102,9 +3127,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuthUsername: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -3125,9 +3150,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBearerTokenSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigBearerTokenSecret: r""" - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -3150,78 +3175,79 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2: r""" - OAuth2 client credentials used to fetch a token for the targets. + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. Attributes ---------- - clientId : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientID, default is Undefined, required + clientId : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientID, default is Undefined, required client Id - clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required + clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. - proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. - tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional + scopes defines the OAuth2 scopes used for the token request. + tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ - clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientID + clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientID - clientSecret: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientSecret + clientSecret: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientSecret endpointParams?: {str:str} noProxy?: str - proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]} + proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]} proxyFromEnvironment?: bool proxyUrl?: str scopes?: [str] - tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfig + tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfig tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientID: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientIDConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientIDConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientIDSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientIDSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientIDConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientIDSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientIDConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientIDSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientIDConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -3241,9 +3267,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientIDSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -3263,9 +3289,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -3286,7 +3312,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0: r""" SecretKeySelector selects a key of a Secret. @@ -3308,57 +3334,57 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfig: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes ---------- - ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCa, default is Undefined, optional + ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCa, default is Undefined, optional ca - cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional + cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. - keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ - ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCa - cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCert + ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCa + cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCert insecureSkipVerify?: bool - keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigKeySecret + keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigKeySecret maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" serverName?: str -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCa: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCaSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCaSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCaSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCaSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -3378,9 +3404,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -3400,23 +3426,23 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCert: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCertSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCertSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCertSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCertSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -3436,9 +3462,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -3458,9 +3484,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -3480,7 +3506,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigProxyConnectHeaderItems0: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigProxyConnectHeaderItems0: r""" SecretKeySelector selects a key of a Secret. @@ -3502,56 +3528,1751 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfig: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfig: r""" - TLS configuration for the client. + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. Attributes ---------- - ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCa, default is Undefined, optional + ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCa, default is Undefined, optional ca - cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional + cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. - keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ - ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCa - cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCert + ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCa + cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCert insecureSkipVerify?: bool - keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigKeySecret + keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigKeySecret maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" serverName?: str -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCa: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCaConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCaConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCaSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCaConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCaSecret + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCaConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCaSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCert: + r""" + cert defines the Client certificate to present when doing client-authentication. + + Attributes + ---------- + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCertConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCertSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCertConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCertSecret + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCertConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigCertSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0HTTPConfigTLSConfigKeySecret: + r""" + keySecret defines the Secret containing the client key file for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0OpsgenieConfigsItems0RespondersItems0: + r""" + OpsGenieConfigResponder defines a responder to an incident. + One of `id`, `name` or `username` has to be defined. + + Attributes + ---------- + id : str, default is Undefined, optional + id defines the unique identifier of the responder. + This corresponds to the responder's ID within OpsGenie. + name : str, default is Undefined, optional + name defines the display name of the responder. + This is used when the responder is identified by name rather than ID. + $type : str, default is Undefined, required + type defines the type of responder. + Valid values include "user", "team", "schedule", and "escalation". + This determines how OpsGenie interprets the other identifier fields. + username : str, default is Undefined, optional + username defines the username of the responder. + This is typically used for user-type responders when identifying by username. + """ + id?: str + name?: str + $type: "team" | "teams" | "user" | "escalation" | "schedule" + + username?: str + + check: + len($type) >= 1 + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0: + r""" + PagerDutyConfig configures notifications via PagerDuty. + See https://prometheus.io/docs/alerting/latest/configuration/#pagerduty_config + + Attributes + ---------- + class : str, default is Undefined, optional + class defines the class/type of the event. + client : str, default is Undefined, optional + client defines the client identification. + clientURL : str, default is Undefined, optional + clientURL defines the backlink to the sender of notification. + component : str, default is Undefined, optional + component defines the part or component of the affected system that is broken. + description : str, default is Undefined, optional + description of the incident. + details : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0DetailsItems0], default is Undefined, optional + details defines the arbitrary key/value pairs that provide further detail about the incident. + group : str, default is Undefined, optional + group defines a cluster or grouping of sources. + httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfig, default is Undefined, optional + http config + pagerDutyImageConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0PagerDutyImageConfigsItems0], default is Undefined, optional + pagerDutyImageConfigs defines a list of image details to attach that provide further detail about an incident. + pagerDutyLinkConfigs : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0PagerDutyLinkConfigsItems0], default is Undefined, optional + pagerDutyLinkConfigs defines a list of link details to attach that provide further detail about an incident. + routingKey : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0RoutingKey, default is Undefined, optional + routing key + sendResolved : bool, default is Undefined, optional + sendResolved defines whether or not to notify about resolved alerts. + serviceKey : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0ServiceKey, default is Undefined, optional + service key + severity : str, default is Undefined, optional + severity of the incident. + source : str, default is Undefined, optional + source defines the unique location of the affected system. + url : str, default is Undefined, optional + url defines the URL to send requests to. + """ + class?: str + client?: str + clientURL?: str + component?: str + description?: str + details?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0DetailsItems0] + group?: str + httpConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfig + pagerDutyImageConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0PagerDutyImageConfigsItems0] + pagerDutyLinkConfigs?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0PagerDutyLinkConfigsItems0] + routingKey?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0RoutingKey + sendResolved?: bool + serviceKey?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0ServiceKey + severity?: str + source?: str + url?: str + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0DetailsItems0: + r""" + KeyValue defines a (key, value) tuple. + + Attributes + ---------- + key : str, default is Undefined, required + key defines the key of the tuple. + This is the identifier or name part of the key-value pair. + value : str, default is Undefined, required + value defines the value of the tuple. + This is the data or content associated with the key. + """ + key: str + + value: str + + check: + len(key) >= 1 + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfig: + r""" + httpConfig defines the HTTP client configuration. + + Attributes + ---------- + authorization : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigAuthorization, default is Undefined, optional + authorization + basicAuth : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuth, default is Undefined, optional + basic auth + bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional + bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. + followRedirects : bool, default is Undefined, optional + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. + noProxy : str, default is Undefined, optional + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names + that should be excluded from proxying. IP and domain names can + contain port numbers. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2, default is Undefined, optional + oauth2 + proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to + proxies during CONNECT requests. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyFromEnvironment : bool, default is Undefined, optional + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyURL : str, default is Undefined, optional + proxyURL defines an optional proxy URL for HTTP requests. + If defined, this field takes precedence over `proxyUrl`. + proxyUrl : str, default is Undefined, optional + proxyUrl defines the HTTP proxy server to use. + tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional + tls config + """ + authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigAuthorization + basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuth + bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool + followRedirects?: bool + noProxy?: str + oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2 + proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigProxyConnectHeaderItems0]} + proxyFromEnvironment?: bool + proxyURL?: str + proxyUrl?: str + tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfig + + check: + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigAuthorization: + r""" + authorization defines the authorization header configuration for the client. + This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. + + Attributes + ---------- + credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional + credentials + $type : str, default is Undefined, optional + type defines the authentication type. The value is case-insensitive. + + "Basic" is not a supported value. + + Default: "Bearer" + """ + credentials?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigAuthorizationCredentials + $type?: str + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigAuthorizationCredentials: + r""" + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuth: + r""" + basicAuth defines the basic authentication credentials for the client. + This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. + + Attributes + ---------- + password : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuthPassword, default is Undefined, optional + password + username : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuthUsername, default is Undefined, optional + username + """ + password?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuthPassword + username?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuthUsername + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuthPassword: + r""" + password defines a key of a Secret containing the password for + authentication. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBasicAuthUsername: + r""" + username defines a key of a Secret containing the username for + authentication. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigBearerTokenSecret: + r""" + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client + for authentication. + The secret needs to be in the same namespace as the AlertmanagerConfig + object and accessible by the Prometheus Operator. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2: + r""" + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. + + Attributes + ---------- + clientId : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientID, default is Undefined, required + client Id + clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required + client secret + endpointParams : {str:str}, default is Undefined, optional + endpointParams configures the HTTP parameters to append to the token + URL. + noProxy : str, default is Undefined, optional + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names + that should be excluded from proxying. IP and domain names can + contain port numbers. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to + proxies during CONNECT requests. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyFromEnvironment : bool, default is Undefined, optional + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyUrl : str, default is Undefined, optional + proxyUrl defines the HTTP proxy server to use. + scopes : [str], default is Undefined, optional + scopes defines the OAuth2 scopes used for the token request. + tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional + tls config + tokenUrl : str, default is Undefined, required + tokenUrl defines the URL to fetch the token from. + """ + clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientID + + clientSecret: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientSecret + + endpointParams?: {str:str} + noProxy?: str + proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]} + proxyFromEnvironment?: bool + proxyUrl?: str + scopes?: [str] + tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfig + tokenUrl: str + + check: + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl + len(tokenUrl) >= 1 + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientID: + r""" + clientId defines a key of a Secret or ConfigMap containing the + OAuth2 client's ID. + + Attributes + ---------- + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientIDConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientIDSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientIDConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientIDSecret + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientIDConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientIDSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ClientSecret: + r""" + clientSecret defines a key of a Secret containing the OAuth2 + client's secret. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0: + r""" + SecretKeySelector selects a key of a Secret. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfig: + r""" + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. + It requires Prometheus >= v2.43.0. + + Attributes + ---------- + ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCa, default is Undefined, optional + ca + cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional + cert + insecureSkipVerify : bool, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional + key secret + maxVersion : str, default is Undefined, optional + maxVersion defines the maximum acceptable TLS version. + + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. + minVersion : str, default is Undefined, optional + minVersion defines the minimum acceptable TLS version. + + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. + serverName : str, default is Undefined, optional + serverName is used to verify the hostname for the targets. + """ + ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCa + cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCert + insecureSkipVerify?: bool + keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigKeySecret + maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + serverName?: str + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCa: + r""" + ca defines the Certificate authority used when verifying server certificates. + + Attributes + ---------- + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCaSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCaSecret + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCert: + r""" + cert defines the Client certificate to present when doing client-authentication. + + Attributes + ---------- + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCertSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCertSecret + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: + r""" + keySecret defines the Secret containing the client key file for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigProxyConnectHeaderItems0: + r""" + SecretKeySelector selects a key of a Secret. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfig: + r""" + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. + + Attributes + ---------- + ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCa, default is Undefined, optional + ca + cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional + cert + insecureSkipVerify : bool, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional + key secret + maxVersion : str, default is Undefined, optional + maxVersion defines the maximum acceptable TLS version. + + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. + minVersion : str, default is Undefined, optional + minVersion defines the minimum acceptable TLS version. + + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. + serverName : str, default is Undefined, optional + serverName is used to verify the hostname for the targets. + """ + ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCa + cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCert + insecureSkipVerify?: bool + keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigKeySecret + maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + serverName?: str + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCa: + r""" + ca defines the Certificate authority used when verifying server certificates. + + Attributes + ---------- + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCaConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCaSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCaConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCaSecret + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCaConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCaSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCert: + r""" + cert defines the Client certificate to present when doing client-authentication. + + Attributes + ---------- + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCertConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCertSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCertConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCertSecret + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCertConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCertSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigKeySecret: + r""" + keySecret defines the Secret containing the client key file for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0PagerDutyImageConfigsItems0: + r""" + PagerDutyImageConfig attaches images to an incident + + Attributes + ---------- + alt : str, default is Undefined, optional + alt is the optional alternative text for the image. + href : str, default is Undefined, optional + href defines the optional URL; makes the image a clickable link. + src : str, default is Undefined, optional + src of the image being attached to the incident + """ + alt?: str + href?: str + src?: str + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0PagerDutyLinkConfigsItems0: + r""" + PagerDutyLinkConfig attaches text links to an incident + + Attributes + ---------- + alt : str, default is Undefined, optional + alt defines the text that describes the purpose of the link, and can be used as the link's text. + href : str, default is Undefined, optional + href defines the URL of the link to be attached + """ + alt?: str + href?: str + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0RoutingKey: + r""" + routingKey defines the secret's key that contains the PagerDuty integration key (when using + Events API v2). Either this field or `serviceKey` needs to be defined. + The secret needs to be in the same namespace as the AlertmanagerConfig + object and accessible by the Prometheus Operator. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0ServiceKey: + r""" + serviceKey defines the secret's key that contains the PagerDuty service key (when using + integration type "Prometheus"). Either this field or `routingKey` needs to + be defined. + The secret needs to be in the same namespace as the AlertmanagerConfig + object and accessible by the Prometheus Operator. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0: + r""" + PushoverConfig configures notifications via Pushover. + See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config + + Attributes + ---------- + device : str, default is Undefined, optional + device defines the name of a specific device to send the notification to. + If not specified, the notification is sent to all user's devices. + expire : str, default is Undefined, optional + expire defines how long your notification will continue to be retried for, + unless the user acknowledges the notification. Only applies to priority 2 notifications. + html : bool, default is Undefined, optional + html defines whether notification message is HTML or plain text. + When true, the message can include HTML formatting tags. + httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfig, default is Undefined, optional + http config + message : str, default is Undefined, optional + message defines the notification message content. + This is the main body text of the Pushover notification. + monospace : bool, default is Undefined, optional + monospace optional HTML/monospace formatting for the message, see https://pushover.net/api#html + html and monospace formatting are mutually exclusive. + priority : str, default is Undefined, optional + priority defines the notification priority level. + See https://pushover.net/api#priority for valid values and behavior. + retry : str, default is Undefined, optional + retry defines how often the Pushover servers will send the same notification to the user. + Must be at least 30 seconds. Only applies to priority 2 notifications. + sendResolved : bool, default is Undefined, optional + sendResolved defines whether or not to notify about resolved alerts. + sound : str, default is Undefined, optional + sound defines the name of one of the sounds supported by device clients. + This overrides the user's default sound choice for this notification. + title : str, default is Undefined, optional + title defines the notification title displayed in the Pushover message. + This appears as the bold header text in the notification. + token : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0Token, default is Undefined, optional + token + tokenFile : str, default is Undefined, optional + tokenFile defines the token file that contains the registered application's API token. + See https://pushover.net/apps for application registration. + Either `token` or `tokenFile` is required. + It requires Alertmanager >= v0.26.0. + ttl : str, default is Undefined, optional + ttl defines the time to live for the alert notification. + This determines how long the notification remains active before expiring. + url : str, default is Undefined, optional + url defines a supplementary URL shown alongside the message. + This creates a clickable link within the Pushover notification. + urlTitle : str, default is Undefined, optional + urlTitle defines a title for the supplementary URL. + If not specified, the raw URL is shown instead. + userKey : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0UserKey, default is Undefined, optional + user key + userKeyFile : str, default is Undefined, optional + userKeyFile defines the user key file that contains the recipient user's user key. + Either `userKey` or `userKeyFile` is required. + It requires Alertmanager >= v0.26.0. + """ + device?: str + expire?: str + html?: bool + httpConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfig + message?: str + monospace?: bool + priority?: str + retry?: str + sendResolved?: bool + sound?: str + title?: str + token?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0Token + tokenFile?: str + ttl?: str + url?: str + urlTitle?: str + userKey?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0UserKey + userKeyFile?: str + + check: + _regex_match(str(expire), r"^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$") if expire + _regex_match(str(retry), r"^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$") if retry + _regex_match(str(ttl), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if ttl + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfig: + r""" + httpConfig defines the HTTP client configuration for Pushover API requests. + + Attributes + ---------- + authorization : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigAuthorization, default is Undefined, optional + authorization + basicAuth : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuth, default is Undefined, optional + basic auth + bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional + bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. + followRedirects : bool, default is Undefined, optional + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. + noProxy : str, default is Undefined, optional + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names + that should be excluded from proxying. IP and domain names can + contain port numbers. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2, default is Undefined, optional + oauth2 + proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to + proxies during CONNECT requests. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyFromEnvironment : bool, default is Undefined, optional + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyURL : str, default is Undefined, optional + proxyURL defines an optional proxy URL for HTTP requests. + If defined, this field takes precedence over `proxyUrl`. + proxyUrl : str, default is Undefined, optional + proxyUrl defines the HTTP proxy server to use. + tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional + tls config + """ + authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigAuthorization + basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuth + bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool + followRedirects?: bool + noProxy?: str + oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2 + proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigProxyConnectHeaderItems0]} + proxyFromEnvironment?: bool + proxyURL?: str + proxyUrl?: str + tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfig + + check: + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigAuthorization: + r""" + authorization defines the authorization header configuration for the client. + This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. + + Attributes + ---------- + credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional + credentials + $type : str, default is Undefined, optional + type defines the authentication type. The value is case-insensitive. + + "Basic" is not a supported value. + + Default: "Bearer" + """ + credentials?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigAuthorizationCredentials + $type?: str + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigAuthorizationCredentials: + r""" + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuth: + r""" + basicAuth defines the basic authentication credentials for the client. + This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. + + Attributes + ---------- + password : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuthPassword, default is Undefined, optional + password + username : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuthUsername, default is Undefined, optional + username + """ + password?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuthPassword + username?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuthUsername + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuthPassword: + r""" + password defines a key of a Secret containing the password for + authentication. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuthUsername: + r""" + username defines a key of a Secret containing the username for + authentication. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBearerTokenSecret: + r""" + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client + for authentication. + The secret needs to be in the same namespace as the AlertmanagerConfig + object and accessible by the Prometheus Operator. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2: + r""" + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. + + Attributes + ---------- + clientId : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientID, default is Undefined, required + client Id + clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required + client secret + endpointParams : {str:str}, default is Undefined, optional + endpointParams configures the HTTP parameters to append to the token + URL. + noProxy : str, default is Undefined, optional + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names + that should be excluded from proxying. IP and domain names can + contain port numbers. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to + proxies during CONNECT requests. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyFromEnvironment : bool, default is Undefined, optional + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyUrl : str, default is Undefined, optional + proxyUrl defines the HTTP proxy server to use. + scopes : [str], default is Undefined, optional + scopes defines the OAuth2 scopes used for the token request. + tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional + tls config + tokenUrl : str, default is Undefined, required + tokenUrl defines the URL to fetch the token from. + """ + clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientID + + clientSecret: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientSecret + + endpointParams?: {str:str} + noProxy?: str + proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]} + proxyFromEnvironment?: bool + proxyUrl?: str + scopes?: [str] + tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfig + tokenUrl: str + + check: + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl + len(tokenUrl) >= 1 + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientID: + r""" + clientId defines a key of a Secret or ConfigMap containing the + OAuth2 client's ID. + + Attributes + ---------- + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientIDConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientIDSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientIDConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientIDSecret + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientIDConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientIDSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientSecret: + r""" + clientSecret defines a key of a Secret containing the OAuth2 + client's secret. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0: + r""" + SecretKeySelector selects a key of a Secret. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfig: + r""" + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. + It requires Prometheus >= v2.43.0. + + Attributes + ---------- + ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCa, default is Undefined, optional + ca + cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional + cert + insecureSkipVerify : bool, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional + key secret + maxVersion : str, default is Undefined, optional + maxVersion defines the maximum acceptable TLS version. + + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. + minVersion : str, default is Undefined, optional + minVersion defines the minimum acceptable TLS version. + + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. + serverName : str, default is Undefined, optional + serverName is used to verify the hostname for the targets. + """ + ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCa + cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCert + insecureSkipVerify?: bool + keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigKeySecret + maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + serverName?: str + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCa: + r""" + ca defines the Certificate authority used when verifying server certificates. + + Attributes + ---------- + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCaSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCaSecret + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCert: + r""" + cert defines the Client certificate to present when doing client-authentication. + + Attributes + ---------- + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap, default is Undefined, optional + config map + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCertSecret, default is Undefined, optional + secret + """ + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCertSecret + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: + r""" + configMap defines the ConfigMap containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key to select. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the ConfigMap or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: + r""" + secret defines the Secret containing data to use for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: + r""" + keySecret defines the Secret containing the client key file for the targets. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigProxyConnectHeaderItems0: + r""" + SecretKeySelector selects a key of a Secret. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfig: + r""" + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. + + Attributes + ---------- + ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCa, default is Undefined, optional + ca + cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional + cert + insecureSkipVerify : bool, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional + key secret + maxVersion : str, default is Undefined, optional + maxVersion defines the maximum acceptable TLS version. + + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. + minVersion : str, default is Undefined, optional + minVersion defines the minimum acceptable TLS version. + + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. + serverName : str, default is Undefined, optional + serverName is used to verify the hostname for the targets. + """ + ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCa + cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCert + insecureSkipVerify?: bool + keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigKeySecret + maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" + serverName?: str + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCa: + r""" + ca defines the Certificate authority used when verifying server certificates. + + Attributes + ---------- + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCaConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCaSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCaSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCaConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCaSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCaConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCaSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCaConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -3571,9 +5292,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCaSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -3593,23 +5314,23 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCert: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCertConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCertConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCertSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCertSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCertConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCertSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCertConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCertSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCertConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -3629,9 +5350,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigCertSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -3651,9 +5372,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0HTTPConfigTLSConfigKeySecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -3673,43 +5394,13 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0PagerDutyImageConfigsItems0: - r""" - PagerDutyImageConfig attaches images to an incident - - Attributes - ---------- - alt : str, default is Undefined, optional - Alt is the optional alternative text for the image. - href : str, default is Undefined, optional - Optional URL; makes the image a clickable link. - src : str, default is Undefined, optional - Src of the image being attached to the incident - """ - alt?: str - href?: str - src?: str - -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0PagerDutyLinkConfigsItems0: - r""" - PagerDutyLinkConfig attaches text links to an incident - - Attributes - ---------- - alt : str, default is Undefined, optional - Text that describes the purpose of the link, and can be used as the link's text. - href : str, default is Undefined, optional - Href is the URL of the link to be attached - """ - alt?: str - href?: str - -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0RoutingKey: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0Token: r""" - The secret's key that contains the PagerDuty integration key (when using - Events API v2). Either this field or `serviceKey` needs to be defined. + token defines the secret's key that contains the registered application's API token. + See https://pushover.net/apps for application registration. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. + Either `token` or `tokenFile` is required. Attributes ---------- @@ -3729,13 +5420,12 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PagerdutyConfigsItems0ServiceKey: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0UserKey: r""" - The secret's key that contains the PagerDuty service key (when using - integration type "Prometheus"). Either this field or `routingKey` needs to - be defined. + userKey defines the secret's key that contains the recipient user's user key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. + Either `userKey` or `userKeyFile` is required. Attributes ---------- @@ -3755,154 +5445,227 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Pagerduty name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0: r""" - PushoverConfig configures notifications via Pushover. - See https://prometheus.io/docs/alerting/latest/configuration/#pushover_config + RocketChatConfig configures notifications via RocketChat. + It requires Alertmanager >= 0.28.0. Attributes ---------- - device : str, default is Undefined, optional - The name of a device to send the notification to - expire : str, default is Undefined, optional - How long your notification will continue to be retried for, unless the user - acknowledges the notification. - html : bool, default is Undefined, optional - Whether notification message is HTML or plain text. - httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfig, default is Undefined, optional + actions : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0ActionsItems0], default is Undefined, optional + actions defines interactive actions to include in the message. + These appear as buttons that users can click to trigger responses. + apiURL : str, default is Undefined, optional + apiURL defines the API URL for RocketChat. + Defaults to https://open.rocket.chat/ if not specified. + channel : str, default is Undefined, optional + channel defines the channel to send alerts to. + This can be a channel name (e.g., "#alerts") or a direct message recipient. + color : str, default is Undefined, optional + color defines the message color displayed in RocketChat. + This appears as a colored bar alongside the message. + emoji : str, default is Undefined, optional + emoji defines the emoji to be displayed as an avatar. + If provided, this emoji will be used instead of the default avatar or iconURL. + fields : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0FieldsItems0], default is Undefined, optional + fields defines additional fields for the message attachment. + These appear as structured key-value pairs within the message. + httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfig, default is Undefined, optional http config - message : str, default is Undefined, optional - Notification message. - priority : str, default is Undefined, optional - Priority, see https://pushover.net/api#priority - retry : str, default is Undefined, optional - How often the Pushover servers will send the same notification to the user. - Must be at least 30 seconds. + iconURL : str, default is Undefined, optional + iconURL defines the icon URL for the message avatar. + This displays a custom image as the message sender's avatar. + imageURL : str, default is Undefined, optional + imageURL defines the image URL to display within the message. + This embeds an image directly in the message attachment. + linkNames : bool, default is Undefined, optional + linkNames defines whether to enable automatic linking of usernames and channels. + When true, @username and #channel references become clickable links. sendResolved : bool, default is Undefined, optional - Whether or not to notify about resolved alerts. - sound : str, default is Undefined, optional - The name of one of the sounds supported by device clients to override the user's default sound choice + sendResolved defines whether or not to notify about resolved alerts. + shortFields : bool, default is Undefined, optional + shortFields defines whether to use short fields in the message layout. + When true, fields may be displayed side by side to save space. + text : str, default is Undefined, optional + text defines the message text to send. + This is optional because attachments can be used instead of or alongside text. + thumbURL : str, default is Undefined, optional + thumbURL defines the thumbnail URL for the message. + This displays a small thumbnail image alongside the message content. title : str, default is Undefined, optional - Notification title. - token : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0Token, default is Undefined, optional + title defines the message title displayed prominently in the message. + This appears as bold text at the top of the message attachment. + titleLink : str, default is Undefined, optional + titleLink defines the URL that the title will link to when clicked. + This makes the message title clickable in the RocketChat interface. + token : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0Token, default is Undefined, required token - tokenFile : str, default is Undefined, optional - The token file that contains the registered application's API token, see https://pushover.net/apps. - Either `token` or `tokenFile` is required. - It requires Alertmanager >= v0.26.0. - ttl : str, default is Undefined, optional - The time to live definition for the alert notification - url : str, default is Undefined, optional - A supplementary URL shown alongside the message. - urlTitle : str, default is Undefined, optional - A title for supplementary URL, otherwise just the URL is shown - userKey : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0UserKey, default is Undefined, optional - user key - userKeyFile : str, default is Undefined, optional - The user key file that contains the recipient user's user key. - Either `userKey` or `userKeyFile` is required. - It requires Alertmanager >= v0.26.0. + tokenID : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0TokenID, default is Undefined, required + token ID """ - device?: str - expire?: str - html?: bool - httpConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfig - message?: str - priority?: str - retry?: str + actions?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0ActionsItems0] + apiURL?: str + channel?: str + color?: str + emoji?: str + fields?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0FieldsItems0] + httpConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfig + iconURL?: str + imageURL?: str + linkNames?: bool sendResolved?: bool - sound?: str + shortFields?: bool + text?: str + thumbURL?: str title?: str - token?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0Token - tokenFile?: str - ttl?: str + titleLink?: str + token: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0Token + + tokenID: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0TokenID + + check: + len(actions) >= 1 if actions + _regex_match(str(apiURL), r"^https?://.+$") if apiURL + len(channel) >= 1 if channel + len(color) >= 1 if color + len(emoji) >= 1 if emoji + len(fields) >= 1 if fields + _regex_match(str(iconURL), r"^https?://.+$") if iconURL + _regex_match(str(imageURL), r"^https?://.+$") if imageURL + len(text) >= 1 if text + _regex_match(str(thumbURL), r"^https?://.+$") if thumbURL + len(title) >= 1 if title + len(titleLink) >= 1 if titleLink + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0ActionsItems0: + r""" + RocketChatActionConfig defines actions for RocketChat messages. + + Attributes + ---------- + msg : str, default is Undefined, optional + msg defines the message to send when the button is clicked. + This allows the button to post a predefined message to the channel. + text : str, default is Undefined, optional + text defines the button text displayed to users. + This is the label that appears on the interactive button. + url : str, default is Undefined, optional + url defines the URL the button links to when clicked. + This creates a clickable button that opens the specified URL. + """ + msg?: str + text?: str url?: str - urlTitle?: str - userKey?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0UserKey - userKeyFile?: str check: - _regex_match(str(expire), r"^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$") if expire - _regex_match(str(retry), r"^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$") if retry - _regex_match(str(ttl), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if ttl + len(msg) >= 1 if msg + len(text) >= 1 if text + _regex_match(str(url), r"^https?://.+$") if url -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfig: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0FieldsItems0: r""" - HTTP client configuration. + RocketChatFieldConfig defines additional fields for RocketChat messages. Attributes ---------- - authorization : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigAuthorization, default is Undefined, optional + short : bool, default is Undefined, optional + short defines whether this field should be a short field. + When true, the field may be displayed inline with other short fields to save space. + title : str, default is Undefined, optional + title defines the title of this field. + This appears as bold text labeling the field content. + value : str, default is Undefined, optional + value defines the value of this field, displayed underneath the title. + This contains the actual data or content for the field. + """ + short?: bool + title?: str + value?: str + + check: + len(title) >= 1 if title + len(value) >= 1 if value + +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfig: + r""" + httpConfig defines the HTTP client configuration for RocketChat API requests. + + Attributes + ---------- + authorization : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigAuthorization, default is Undefined, optional authorization - basicAuth : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuth, default is Undefined, optional + basicAuth : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigBasicAuth, default is Undefined, optional basic auth - bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional + bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. followRedirects : bool, default is Undefined, optional - FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. - oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2, default is Undefined, optional + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2, default is Undefined, optional oauth2 - proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyURL : str, default is Undefined, optional - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. - tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional + proxyUrl defines the HTTP proxy server to use. + tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional tls config """ - authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigAuthorization - basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuth - bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBearerTokenSecret + authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigAuthorization + basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigBasicAuth + bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool followRedirects?: bool noProxy?: str - oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2 - proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigProxyConnectHeaderItems0]} + oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2 + proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigProxyConnectHeaderItems0]} proxyFromEnvironment?: bool proxyURL?: str proxyUrl?: str - tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfig + tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigAuthorization: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigAuthorization: r""" - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. Attributes ---------- - credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional + credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. Default: "Bearer" """ - credentials?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigAuthorizationCredentials + credentials?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigAuthorizationCredentials $type?: str -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigAuthorizationCredentials: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -3922,24 +5685,24 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuth: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigBasicAuth: r""" - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. Attributes ---------- - password : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuthPassword, default is Undefined, optional + password : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigBasicAuthPassword, default is Undefined, optional password - username : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuthUsername, default is Undefined, optional + username : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigBasicAuthUsername, default is Undefined, optional username """ - password?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuthPassword - username?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuthUsername + password?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigBasicAuthPassword + username?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigBasicAuthUsername -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuthPassword: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -3960,9 +5723,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBasicAuthUsername: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -3983,9 +5746,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigBearerTokenSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigBearerTokenSecret: r""" - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -4008,78 +5771,79 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2: r""" - OAuth2 client credentials used to fetch a token for the targets. + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. Attributes ---------- - clientId : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientID, default is Undefined, required + clientId : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ClientID, default is Undefined, required client Id - clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required + clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. - proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. - tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional + scopes defines the OAuth2 scopes used for the token request. + tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ - clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientID + clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ClientID - clientSecret: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientSecret + clientSecret: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ClientSecret endpointParams?: {str:str} noProxy?: str - proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]} + proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]} proxyFromEnvironment?: bool proxyUrl?: str scopes?: [str] - tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfig + tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfig tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientID: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientIDConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ClientIDConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientIDSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ClientIDSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientIDConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientIDSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ClientIDConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ClientIDSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientIDConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -4099,9 +5863,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientIDSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -4121,9 +5885,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ClientSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -4144,7 +5908,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0: r""" SecretKeySelector selects a key of a Secret. @@ -4166,57 +5930,57 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfig: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes ---------- - ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCa, default is Undefined, optional + ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCa, default is Undefined, optional ca - cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional + cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. - keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ - ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCa - cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCert + ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCa + cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCert insecureSkipVerify?: bool - keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigKeySecret + keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigKeySecret maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" serverName?: str -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCa: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCaSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCaSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCaSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCaSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -4236,9 +6000,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -4258,23 +6022,23 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCert: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCertSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCertSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCertSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCertSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -4294,9 +6058,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -4316,9 +6080,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -4338,7 +6102,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigProxyConnectHeaderItems0: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigProxyConnectHeaderItems0: r""" SecretKeySelector selects a key of a Secret. @@ -4360,56 +6124,57 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfig: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfig: r""" - TLS configuration for the client. + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. Attributes ---------- - ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCa, default is Undefined, optional + ca : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCa, default is Undefined, optional ca - cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional + cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. - keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional + insecureSkipVerify defines how to disable target certificate validation. + keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ - ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCa - cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCert + ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCa + cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCert insecureSkipVerify?: bool - keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigKeySecret + keySecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigKeySecret maxVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" minVersion?: "TLS10" | "TLS11" | "TLS12" | "TLS13" serverName?: str -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCa: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCaConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCaConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCaSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCaSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCaConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCaSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCaConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCaSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCaConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -4429,9 +6194,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCaSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -4451,23 +6216,23 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCert: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- - configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCertConfigMap, default is Undefined, optional + configMap : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCertConfigMap, default is Undefined, optional config map - secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCertSecret, default is Undefined, optional + secret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCertSecret, default is Undefined, optional secret """ - configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCertConfigMap - secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCertSecret + configMap?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCertConfigMap + secret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCertSecret -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCertConfigMap: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -4487,9 +6252,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigCertSecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -4509,9 +6274,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0HTTPConfigTLSConfigKeySecret: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0HTTPConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -4531,12 +6296,10 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0Token: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0Token: r""" - The secret's key that contains the registered application's API token, see https://pushover.net/apps. - The secret needs to be in the same namespace as the AlertmanagerConfig - object and accessible by the Prometheus Operator. - Either `token` or `tokenFile` is required. + token defines the sender token for RocketChat authentication. + This is the personal access token or bot token used to authenticate API requests. Attributes ---------- @@ -4556,12 +6319,10 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverC name?: str = "" optional?: bool -schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0PushoverConfigsItems0UserKey: +schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0RocketchatConfigsItems0TokenID: r""" - The secret's key that contains the recipient user's user key. - The secret needs to be in the same namespace as the AlertmanagerConfig - object and accessible by the Prometheus Operator. - Either `userKey` or `userKeyFile` is required. + tokenID defines the sender token ID for RocketChat authentication. + This is the user ID associated with the token used for API requests. Attributes ---------- @@ -4589,49 +6350,54 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf Attributes ---------- actions : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0ActionsItems0], default is Undefined, optional - A list of Slack actions that are sent with each notification. + actions defines a list of Slack actions that are sent with each notification. apiURL : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0APIURL, default is Undefined, optional api URL callbackId : str, default is Undefined, optional - callback Id + callbackId defines an identifier for the message used in interactive components. channel : str, default is Undefined, optional - The channel or user to send notifications to. + channel defines the channel or user to send notifications to. color : str, default is Undefined, optional - color + color defines the color of the left border of the Slack message attachment. + Can be a hex color code (e.g., "#ff0000") or a predefined color name. fallback : str, default is Undefined, optional - fallback + fallback defines a plain-text summary of the attachment for clients that don't support attachments. fields : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0FieldsItems0], default is Undefined, optional - A list of Slack fields that are sent with each notification. + fields defines a list of Slack fields that are sent with each notification. footer : str, default is Undefined, optional - footer + footer defines small text displayed at the bottom of the message attachment. httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfig, default is Undefined, optional http config iconEmoji : str, default is Undefined, optional - icon emoji + iconEmoji defines the emoji to use as the bot's avatar (e.g., ":ghost:"). iconURL : str, default is Undefined, optional - icon URL + iconURL defines the URL to an image to use as the bot's avatar. imageURL : str, default is Undefined, optional - image URL + imageURL defines the URL to an image file that will be displayed inside the message attachment. linkNames : bool, default is Undefined, optional - link names + linkNames enables automatic linking of channel names and usernames in the message. + When true, @channel and @username will be converted to clickable links. mrkdwnIn : [str], default is Undefined, optional - mrkdwn in + mrkdwnIn defines which fields should be parsed as Slack markdown. + Valid values include "pretext", "text", and "fields". pretext : str, default is Undefined, optional - pretext + pretext defines optional text that appears above the message attachment block. sendResolved : bool, default is Undefined, optional - Whether or not to notify about resolved alerts. + sendResolved defines whether or not to notify about resolved alerts. shortFields : bool, default is Undefined, optional - short fields + shortFields determines whether fields are displayed in a compact format. + When true, fields are shown side by side when possible. text : str, default is Undefined, optional - text + text defines the main text content of the Slack message attachment. thumbURL : str, default is Undefined, optional - thumb URL + thumbURL defines the URL to an image file that will be displayed as a thumbnail + on the right side of the message attachment. title : str, default is Undefined, optional - title + title defines the title text displayed in the Slack message attachment. titleLink : str, default is Undefined, optional - title link + titleLink defines the URL that the title will link to when clicked. username : str, default is Undefined, optional - username + username defines the slack bot user name. """ actions?: [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0ActionsItems0] apiURL?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0APIURL @@ -4658,7 +6424,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0APIURL: r""" - The secret's key that contains the Slack webhook URL. + apiURL defines the secret's key that contains the Slack webhook URL. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -4692,17 +6458,23 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf confirm : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0ActionsItems0Confirm, default is Undefined, optional confirm name : str, default is Undefined, optional - name + name defines a unique identifier for the action within the message. + This value is sent back to your application when the action is triggered. style : str, default is Undefined, optional - style + style defines the visual appearance of the action element. + Valid values include "default", "primary" (green), and "danger" (red). text : str, default is Undefined, required - text + text defines the user-visible label displayed on the action element. + For buttons, this is the button text. For select menus, this is the placeholder text. $type : str, default is Undefined, required - type + type defines the type of interactive component. + Common values include "button" for clickable buttons and "select" for dropdown menus. url : str, default is Undefined, optional - url + url defines the URL to open when the action is triggered. + Only applicable for button-type actions. When set, clicking the button opens this URL. value : str, default is Undefined, optional - value + value defines the payload sent when the action is triggered. + This data is included in the callback sent to your application. """ confirm?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0ActionsItems0Confirm name?: str @@ -4720,22 +6492,23 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0ActionsItems0Confirm: r""" - SlackConfirmationField protect users from destructive actions or - particularly distinguished decisions by asking them to confirm their button - click one more time. - See https://api.slack.com/docs/interactive-message-field-guide#confirmation_fields - for more information. + confirm defines an optional confirmation dialog that appears before the action is executed. + When set, users must confirm their intent before the action proceeds. Attributes ---------- dismissText : str, default is Undefined, optional - dismiss text + dismissText defines the label for the cancel button in the dialog. + When not specified, defaults to "Cancel". This button cancels the action. okText : str, default is Undefined, optional - ok text + okText defines the label for the confirmation button in the dialog. + When not specified, defaults to "Okay". This button proceeds with the action. text : str, default is Undefined, required - text + text defines the main message displayed in the confirmation dialog. + This should be a clear question or statement asking the user to confirm their action. title : str, default is Undefined, optional - title + title defines the title text displayed at the top of the confirmation dialog. + When not specified, a default title will be used. """ dismissText?: str okText?: str @@ -4756,11 +6529,15 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf Attributes ---------- short : bool, default is Undefined, optional - short + short determines whether this field can be displayed alongside other short fields. + When true, Slack may display this field side by side with other short fields. + When false or not specified, the field takes the full width of the message. title : str, default is Undefined, required - title + title defines the label or header text displayed for this field. + This appears as bold text above the field value in the Slack message. value : str, default is Undefined, required - value + value defines the content or data displayed for this field. + This appears below the title and can contain plain text or Slack markdown. """ short?: bool title: str @@ -4773,7 +6550,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfig: r""" - HTTP client configuration. + httpConfig defines the HTTP client configuration. Attributes ---------- @@ -4783,37 +6560,40 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf basic auth bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. followRedirects : bool, default is Undefined, optional - FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyURL : str, default is Undefined, optional - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional tls config """ authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigAuthorization basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigBasicAuth bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool followRedirects?: bool noProxy?: str oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2 @@ -4824,11 +6604,11 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigAuthorization: r""" - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. Attributes @@ -4836,7 +6616,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -4847,7 +6627,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -4869,7 +6649,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigBasicAuth: r""" - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. Attributes @@ -4884,7 +6664,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -4907,7 +6687,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -4930,7 +6710,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigBearerTokenSecret: r""" - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -4955,7 +6735,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2: r""" - OAuth2 client credentials used to fetch a token for the targets. + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. Attributes ---------- @@ -4964,31 +6745,31 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2ClientID @@ -5004,12 +6785,12 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -5024,7 +6805,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5046,7 +6827,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5068,7 +6849,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -5113,7 +6894,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -5123,19 +6904,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2TLSConfigCert @@ -5147,7 +6928,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -5161,7 +6942,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5183,7 +6964,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5205,7 +6986,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -5219,7 +7000,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5241,7 +7022,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5263,7 +7044,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -5307,7 +7088,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfig: r""" - TLS configuration for the client. + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. Attributes ---------- @@ -5316,19 +7098,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfigCert @@ -5340,7 +7122,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -5354,7 +7136,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5376,7 +7158,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5398,7 +7180,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -5412,7 +7194,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5434,7 +7216,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5456,7 +7238,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SlackConfigsItems0HTTPConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -5484,28 +7266,31 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig Attributes ---------- apiURL : str, default is Undefined, optional - The SNS API URL i.e. https://sns.us-east-2.amazonaws.com. + apiURL defines the SNS API URL, e.g. https://sns.us-east-2.amazonaws.com. If not specified, the SNS API URL from the SNS SDK will be used. attributes : {str:str}, default is Undefined, optional - SNS message attributes. + attributes defines SNS message attributes as key-value pairs. + These provide additional metadata that can be used for message filtering and routing. httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfig, default is Undefined, optional http config message : str, default is Undefined, optional - The message content of the SNS notification. + message defines the message content of the SNS notification. + This is the actual notification text that will be sent to subscribers. phoneNumber : str, default is Undefined, optional - Phone number if message is delivered via SMS in E.164 format. + phoneNumber defines the phone number if message is delivered via SMS in E.164 format. If you don't specify this value, you must specify a value for the TopicARN or TargetARN. sendResolved : bool, default is Undefined, optional - Whether or not to notify about resolved alerts. + sendResolved defines whether or not to notify about resolved alerts. sigv4 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0Sigv4, default is Undefined, optional sigv4 subject : str, default is Undefined, optional - Subject line when the message is delivered to email endpoints. + subject defines the subject line when the message is delivered to email endpoints. + This field is only used when sending to email subscribers of an SNS topic. targetARN : str, default is Undefined, optional - The mobile platform endpoint ARN if message is delivered via mobile notifications. - If you don't specify this value, you must specify a value for the topic_arn or PhoneNumber. + targetARN defines the mobile platform endpoint ARN if message is delivered via mobile notifications. + If you don't specify this value, you must specify a value for the TopicARN or PhoneNumber. topicARN : str, default is Undefined, optional - SNS topic ARN, i.e. arn:aws:sns:us-east-2:698519295917:My-Topic + topicARN defines the SNS topic ARN, e.g. arn:aws:sns:us-east-2:698519295917:My-Topic. If you don't specify this value, you must specify a value for the PhoneNumber or TargetARN. """ apiURL?: str @@ -5521,7 +7306,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfig: r""" - HTTP client configuration. + httpConfig defines the HTTP client configuration for SNS API requests. Attributes ---------- @@ -5531,37 +7316,40 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig basic auth bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. followRedirects : bool, default is Undefined, optional - FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyURL : str, default is Undefined, optional - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional tls config """ authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigAuthorization basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigBasicAuth bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool followRedirects?: bool noProxy?: str oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2 @@ -5572,11 +7360,11 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigAuthorization: r""" - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. Attributes @@ -5584,7 +7372,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -5595,7 +7383,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -5617,7 +7405,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigBasicAuth: r""" - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. Attributes @@ -5632,7 +7420,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -5655,7 +7443,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -5678,7 +7466,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigBearerTokenSecret: r""" - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -5703,7 +7491,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2: r""" - OAuth2 client credentials used to fetch a token for the targets. + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. Attributes ---------- @@ -5712,31 +7501,31 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2ClientID @@ -5752,12 +7541,12 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -5772,7 +7561,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5794,7 +7583,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5816,7 +7605,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -5861,7 +7650,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -5871,19 +7660,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2TLSConfigCert @@ -5895,7 +7684,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -5909,7 +7698,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5931,7 +7720,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5953,7 +7742,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -5967,7 +7756,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5989,7 +7778,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6011,7 +7800,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -6055,7 +7844,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfig: r""" - TLS configuration for the client. + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. Attributes ---------- @@ -6064,19 +7854,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfigCert @@ -6088,7 +7878,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -6102,7 +7892,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6124,7 +7914,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6146,7 +7936,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -6160,7 +7950,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6182,7 +7972,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6204,7 +7994,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0HTTPConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -6226,30 +8016,35 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0Sigv4: r""" - Configures AWS's Signature Verification 4 signing process to sign requests. + sigv4 configures AWS's Signature Verification 4 signing process to sign requests. + This includes AWS credentials and region configuration for authentication. Attributes ---------- accessKey : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0Sigv4AccessKey, default is Undefined, optional access key profile : str, default is Undefined, optional - Profile is the named AWS profile used to authenticate. + profile defines the named AWS profile used to authenticate. region : str, default is Undefined, optional - Region is the AWS region. If blank, the region from the default credentials chain used. + region defines the AWS region. If blank, the region from the default credentials chain used. roleArn : str, default is Undefined, optional - RoleArn is the named AWS profile used to authenticate. + roleArn defines the named AWS profile used to authenticate. secretKey : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0Sigv4SecretKey, default is Undefined, optional secret key + useFIPSSTSEndpoint : bool, default is Undefined, optional + useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. + It requires Prometheus >= v2.54.0. """ accessKey?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0Sigv4AccessKey profile?: str region?: str roleArn?: str secretKey?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0Sigv4SecretKey + useFIPSSTSEndpoint?: bool schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0Sigv4AccessKey: r""" - AccessKey is the AWS API key. If not specified, the environment variable + accessKey defines the AWS API key. If not specified, the environment variable `AWS_ACCESS_KEY_ID` is used. Attributes @@ -6272,7 +8067,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfig schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0SnsConfigsItems0Sigv4SecretKey: r""" - SecretKey is the AWS API secret. If not specified, the environment + secretKey defines the AWS API secret. If not specified, the environment variable `AWS_SECRET_ACCESS_KEY` is used. Attributes @@ -6301,30 +8096,36 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC Attributes ---------- apiURL : str, default is Undefined, optional - The Telegram API URL i.e. https://api.telegram.org. - If not specified, default API URL will be used. + apiURL defines the Telegram API URL, e.g. https://api.telegram.org. + If not specified, the default Telegram API URL will be used. botToken : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0BotToken, default is Undefined, optional bot token botTokenFile : str, default is Undefined, optional - File to read the Telegram bot token from. It is mutually exclusive with `botToken`. + botTokenFile defines the file to read the Telegram bot token from. + It is mutually exclusive with `botToken`. Either `botToken` or `botTokenFile` is required. - It requires Alertmanager >= v0.26.0. chatID : int, default is Undefined, required - The Telegram chat ID. + chatID defines the Telegram chat ID where messages will be sent. + This can be a user ID, group ID, or channel ID (with @ prefix for public channels). disableNotifications : bool, default is Undefined, optional - Disable telegram notifications + disableNotifications controls whether Telegram notifications are sent silently. + When true, users will receive the message without notification sounds. httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfig, default is Undefined, optional http config message : str, default is Undefined, optional - Message template + message defines the message template for the Telegram notification. + This is the content that will be sent to the specified chat. messageThreadID : int, default is Undefined, optional - The Telegram Group Topic ID. + messageThreadID defines the Telegram Group Topic ID for threaded messages. + This allows sending messages to specific topics within Telegram groups. It requires Alertmanager >= 0.26.0. parseMode : str, default is Undefined, optional - Parse mode for telegram message + parseMode defines the parse mode for telegram message formatting. + Valid values are "MarkdownV2", "Markdown", and "HTML". + This determines how text formatting is interpreted in the message. sendResolved : bool, default is Undefined, optional - Whether to notify about resolved alerts. + sendResolved defines whether or not to notify about resolved alerts. """ apiURL?: str botToken?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0BotToken @@ -6340,10 +8141,9 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0BotToken: r""" - Telegram bot token. It is mutually exclusive with `botTokenFile`. + botToken defines the Telegram bot token. It is mutually exclusive with `botTokenFile`. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. - Either `botToken` or `botTokenFile` is required. Attributes @@ -6366,7 +8166,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfig: r""" - HTTP client configuration. + httpConfig defines the HTTP client configuration for Telegram API requests. Attributes ---------- @@ -6376,37 +8176,40 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC basic auth bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. followRedirects : bool, default is Undefined, optional - FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyURL : str, default is Undefined, optional - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional tls config """ authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigAuthorization basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigBasicAuth bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool followRedirects?: bool noProxy?: str oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2 @@ -6417,11 +8220,11 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigAuthorization: r""" - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. Attributes @@ -6429,7 +8232,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -6440,7 +8243,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -6462,7 +8265,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigBasicAuth: r""" - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. Attributes @@ -6477,7 +8280,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -6500,7 +8303,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -6523,7 +8326,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigBearerTokenSecret: r""" - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -6548,7 +8351,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2: r""" - OAuth2 client credentials used to fetch a token for the targets. + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. Attributes ---------- @@ -6557,31 +8361,31 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2ClientID @@ -6597,12 +8401,12 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -6617,7 +8421,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6639,7 +8443,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6661,7 +8465,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -6706,7 +8510,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -6716,19 +8520,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2TLSConfigCert @@ -6740,7 +8544,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -6754,7 +8558,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6776,7 +8580,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6798,7 +8602,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -6812,7 +8616,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6834,7 +8638,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6856,7 +8660,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -6900,7 +8704,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfig: r""" - TLS configuration for the client. + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. Attributes ---------- @@ -6909,19 +8714,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfigCert @@ -6933,7 +8738,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -6947,7 +8752,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6969,7 +8774,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6991,7 +8796,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -7005,7 +8810,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7027,7 +8832,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7049,7 +8854,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramC schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0TelegramConfigsItems0HTTPConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -7079,23 +8884,30 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops apiKey : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0APIKey, default is Undefined, optional api key apiUrl : str, default is Undefined, optional - The VictorOps API URL. + apiUrl defines the VictorOps API URL. + When not specified, defaults to the standard VictorOps API endpoint. customFields : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0CustomFieldsItems0], default is Undefined, optional - Additional custom fields for notification. + customFields defines additional custom fields for notification. + These provide extra metadata that will be included with the VictorOps incident. entityDisplayName : str, default is Undefined, optional - Contains summary of the alerted problem. + entityDisplayName contains a summary of the alerted problem. + This appears as the main title or identifier for the incident. httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfig, default is Undefined, optional http config messageType : str, default is Undefined, optional - Describes the behavior of the alert (CRITICAL, WARNING, INFO). + messageType describes the behavior of the alert. + Valid values are "CRITICAL", "WARNING", and "INFO". monitoringTool : str, default is Undefined, optional - The monitoring tool the state message is from. + monitoringTool defines the monitoring tool the state message is from. + This helps identify the source system that generated the alert. routingKey : str, default is Undefined, optional - A key used to map the alert to a team. + routingKey defines a key used to map the alert to a team. + This determines which VictorOps team will receive the alert notification. sendResolved : bool, default is Undefined, optional - Whether or not to notify about resolved alerts. + sendResolved defines whether or not to notify about resolved alerts. stateMessage : str, default is Undefined, optional - Contains long explanation of the alerted problem. + stateMessage contains a long explanation of the alerted problem. + This provides detailed context about the incident. """ apiKey?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0APIKey apiUrl?: str @@ -7110,7 +8922,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0APIKey: r""" - The secret's key that contains the API key to use when talking to the VictorOps API. + apiKey defines the secret's key that contains the API key to use when talking to the VictorOps API. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -7139,9 +8951,11 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops Attributes ---------- key : str, default is Undefined, required - Key of the tuple. + key defines the key of the tuple. + This is the identifier or name part of the key-value pair. value : str, default is Undefined, required - Value of the tuple. + value defines the value of the tuple. + This is the data or content associated with the key. """ key: str @@ -7152,7 +8966,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfig: r""" - The HTTP client's configuration. + httpConfig defines the HTTP client's configuration for VictorOps API requests. Attributes ---------- @@ -7162,37 +8976,40 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops basic auth bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. followRedirects : bool, default is Undefined, optional - FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyURL : str, default is Undefined, optional - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional tls config """ authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigAuthorization basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigBasicAuth bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool followRedirects?: bool noProxy?: str oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2 @@ -7203,11 +9020,11 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigAuthorization: r""" - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. Attributes @@ -7215,7 +9032,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -7226,7 +9043,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -7248,7 +9065,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigBasicAuth: r""" - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. Attributes @@ -7263,7 +9080,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -7286,7 +9103,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -7309,7 +9126,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigBearerTokenSecret: r""" - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -7334,7 +9151,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2: r""" - OAuth2 client credentials used to fetch a token for the targets. + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. Attributes ---------- @@ -7343,31 +9161,31 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2ClientID @@ -7383,12 +9201,12 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -7403,7 +9221,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7425,7 +9243,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7447,7 +9265,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -7492,7 +9310,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -7502,19 +9320,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2TLSConfigCert @@ -7526,7 +9344,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -7540,7 +9358,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7562,7 +9380,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7584,7 +9402,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -7598,7 +9416,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7620,7 +9438,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7642,7 +9460,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -7686,7 +9504,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfig: r""" - TLS configuration for the client. + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. Attributes ---------- @@ -7695,19 +9514,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfigCert @@ -7719,7 +9538,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -7733,7 +9552,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7755,7 +9574,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7777,7 +9596,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -7791,7 +9610,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7813,7 +9632,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7835,7 +9654,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0Victorops schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0VictoropsConfigsItems0HTTPConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -7863,16 +9682,15 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf Attributes ---------- apiURL : str, default is Undefined, optional - The Webex Teams API URL i.e. https://webexapis.com/v1/messages - Provide if different from the default API URL. + apiURL defines the Webex Teams API URL i.e. https://webexapis.com/v1/messages httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfig, default is Undefined, optional http config message : str, default is Undefined, optional - Message template + message defines the message template roomID : str, default is Undefined, required - ID of the Webex Teams room where to send the messages. + roomID defines the ID of the Webex Teams room where to send the messages. sendResolved : bool, default is Undefined, optional - Whether to notify about resolved alerts. + sendResolved defines whether or not to notify about resolved alerts. """ apiURL?: str httpConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfig @@ -7887,8 +9705,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfig: r""" - The HTTP client's configuration. - You must supply the bot token via the `httpConfig.authorization` field. + httpConfig defines the HTTP client's configuration. Attributes ---------- @@ -7898,37 +9715,40 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf basic auth bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. followRedirects : bool, default is Undefined, optional - FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyURL : str, default is Undefined, optional - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional tls config """ authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigAuthorization basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigBasicAuth bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool followRedirects?: bool noProxy?: str oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2 @@ -7939,11 +9759,11 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigAuthorization: r""" - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. Attributes @@ -7951,7 +9771,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -7962,7 +9782,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -7984,7 +9804,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigBasicAuth: r""" - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. Attributes @@ -7999,7 +9819,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -8022,7 +9842,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -8045,7 +9865,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigBearerTokenSecret: r""" - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -8070,7 +9890,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2: r""" - OAuth2 client credentials used to fetch a token for the targets. + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. Attributes ---------- @@ -8079,31 +9900,31 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2ClientID @@ -8119,12 +9940,12 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -8139,7 +9960,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8161,7 +9982,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8183,7 +10004,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -8228,7 +10049,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -8238,19 +10059,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2TLSConfigCert @@ -8262,7 +10083,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -8276,7 +10097,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8298,7 +10119,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8320,7 +10141,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -8334,7 +10155,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8356,7 +10177,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8378,7 +10199,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -8422,7 +10243,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfig: r""" - TLS configuration for the client. + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. Attributes ---------- @@ -8431,19 +10253,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfigCert @@ -8455,7 +10277,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -8469,7 +10291,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8491,7 +10313,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8513,7 +10335,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -8527,7 +10349,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8549,7 +10371,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8571,7 +10393,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConf schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebexConfigsItems0HTTPConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -8601,27 +10423,34 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfig, default is Undefined, optional http config maxAlerts : int, default is Undefined, optional - Maximum number of alerts to be sent per webhook message. When 0, all alerts are included. + maxAlerts defines the maximum number of alerts to be sent per webhook message. + When 0, all alerts are included in the webhook payload. sendResolved : bool, default is Undefined, optional - Whether or not to notify about resolved alerts. + sendResolved defines whether or not to notify about resolved alerts. + timeout : str, default is Undefined, optional + timeout defines the maximum time to wait for a webhook request to complete, + before failing the request and allowing it to be retried. + It requires Alertmanager >= v0.28.0. url : str, default is Undefined, optional - The URL to send HTTP POST requests to. `urlSecret` takes precedence over - `url`. One of `urlSecret` and `url` should be defined. + url defines the URL to send HTTP POST requests to. + urlSecret takes precedence over url. One of urlSecret and url should be defined. urlSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0URLSecret, default is Undefined, optional url secret """ httpConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfig maxAlerts?: int sendResolved?: bool + timeout?: str url?: str urlSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0URLSecret check: maxAlerts >= 0 if maxAlerts not in [None, Undefined] + _regex_match(str(timeout), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if timeout schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfig: r""" - HTTP client configuration. + httpConfig defines the HTTP client configuration for webhook requests. Attributes ---------- @@ -8631,37 +10460,40 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo basic auth bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. followRedirects : bool, default is Undefined, optional - FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyURL : str, default is Undefined, optional - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional tls config """ authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigAuthorization basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigBasicAuth bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool followRedirects?: bool noProxy?: str oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2 @@ -8672,11 +10504,11 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigAuthorization: r""" - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. Attributes @@ -8684,7 +10516,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -8695,7 +10527,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -8717,7 +10549,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigBasicAuth: r""" - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. Attributes @@ -8732,7 +10564,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -8755,7 +10587,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -8778,7 +10610,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigBearerTokenSecret: r""" - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -8803,7 +10635,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2: r""" - OAuth2 client credentials used to fetch a token for the targets. + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. Attributes ---------- @@ -8812,31 +10645,31 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2ClientID @@ -8852,12 +10685,12 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -8872,7 +10705,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8894,7 +10727,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8916,7 +10749,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -8961,7 +10794,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -8971,19 +10804,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2TLSConfigCert @@ -8995,7 +10828,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -9009,7 +10842,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9031,7 +10864,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9053,7 +10886,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -9067,7 +10900,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9089,7 +10922,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9111,7 +10944,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -9155,7 +10988,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfig: r""" - TLS configuration for the client. + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. Attributes ---------- @@ -9164,19 +10998,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfigCert @@ -9188,7 +11022,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -9202,7 +11036,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9224,7 +11058,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9246,7 +11080,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -9260,7 +11094,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9282,7 +11116,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9304,7 +11138,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0HTTPConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -9326,9 +11160,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookCo schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WebhookConfigsItems0URLSecret: r""" - The secret's key that contains the webhook URL to send HTTP requests to. - `urlSecret` takes precedence over `url`. One of `urlSecret` and `url` - should be defined. + urlSecret defines the secret's key that contains the webhook URL to send HTTP requests to. + urlSecret takes precedence over url. One of urlSecret and url should be defined. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -9358,27 +11191,35 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon Attributes ---------- agentID : str, default is Undefined, optional - agent ID + agentID defines the application agent ID within WeChat Work. + This identifies which WeChat Work application will send the notifications. apiSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0APISecret, default is Undefined, optional api secret apiURL : str, default is Undefined, optional - The WeChat API URL. + apiURL defines the WeChat API URL. + When not specified, defaults to the standard WeChat Work API endpoint. corpID : str, default is Undefined, optional - The corp id for authentication. + corpID defines the corp id for authentication. + This is the unique identifier for your WeChat Work organization. httpConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfig, default is Undefined, optional http config message : str, default is Undefined, optional - API request data as defined by the WeChat API. + message defines the API request data as defined by the WeChat API. + This contains the actual notification content to be sent. messageType : str, default is Undefined, optional - message type + messageType defines the type of message to send. + Valid values include "text", "markdown", and other WeChat Work supported message types. sendResolved : bool, default is Undefined, optional - Whether or not to notify about resolved alerts. + sendResolved defines whether or not to notify about resolved alerts. toParty : str, default is Undefined, optional - to party + toParty defines the target department(s) to receive the notification. + Can be a single department ID or multiple department IDs separated by '|'. toTag : str, default is Undefined, optional - to tag + toTag defines the target tag(s) to receive the notification. + Can be a single tag ID or multiple tag IDs separated by '|'. toUser : str, default is Undefined, optional - to user + toUser defines the target user(s) to receive the notification. + Can be a single user ID or multiple user IDs separated by '|'. """ agentID?: str apiSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0APISecret @@ -9394,7 +11235,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0APISecret: r""" - The secret's key that contains the WeChat API key. + apiSecret defines the secret's key that contains the WeChat API key. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -9418,7 +11259,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfig: r""" - HTTP client configuration. + httpConfig defines the HTTP client configuration for WeChat API requests. Attributes ---------- @@ -9428,37 +11269,40 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon basic auth bearerTokenSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigBearerTokenSecret, default is Undefined, optional bearer token secret + enableHttp2 : bool, default is Undefined, optional + enableHttp2 can be used to disable HTTP2. followRedirects : bool, default is Undefined, optional - FollowRedirects specifies whether the client should follow HTTP 3xx redirects. + followRedirects specifies whether the client should follow HTTP 3xx redirects. + When true, the client will automatically follow redirect responses. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyURL : str, default is Undefined, optional - Optional proxy URL. - + proxyURL defines an optional proxy URL for HTTP requests. If defined, this field takes precedence over `proxyUrl`. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfig, default is Undefined, optional tls config """ authorization?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigAuthorization basicAuth?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigBasicAuth bearerTokenSecret?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigBearerTokenSecret + enableHttp2?: bool followRedirects?: bool noProxy?: str oauth2?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2 @@ -9469,11 +11313,11 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon tlsConfig?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigAuthorization: r""" - Authorization header configuration for the client. + authorization defines the authorization header configuration for the client. This is mutually exclusive with BasicAuth and is only available starting from Alertmanager v0.22+. Attributes @@ -9481,7 +11325,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon credentials : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -9492,7 +11336,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -9514,7 +11358,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigBasicAuth: r""" - BasicAuth for the client. + basicAuth defines the basic authentication credentials for the client. This is mutually exclusive with Authorization. If both are defined, BasicAuth takes precedence. Attributes @@ -9529,7 +11373,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -9552,7 +11396,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -9575,7 +11419,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigBearerTokenSecret: r""" - The secret's key that contains the bearer token to be used by the client + bearerTokenSecret defines the secret's key that contains the bearer token to be used by the client for authentication. The secret needs to be in the same namespace as the AlertmanagerConfig object and accessible by the Prometheus Operator. @@ -9600,7 +11444,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2: r""" - OAuth2 client credentials used to fetch a token for the targets. + oauth2 defines the OAuth2 client credentials used to fetch a token for the targets. + This enables OAuth2 authentication flow for HTTP requests. Attributes ---------- @@ -9609,31 +11454,31 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon clientSecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2ClientID @@ -9649,12 +11494,12 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -9669,7 +11514,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9691,7 +11536,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9713,7 +11558,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -9758,7 +11603,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -9768,19 +11613,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2TLSConfigCert @@ -9792,7 +11637,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -9806,7 +11651,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9828,7 +11673,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9850,7 +11695,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -9864,7 +11709,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9886,7 +11731,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9908,7 +11753,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -9952,7 +11797,8 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfig: r""" - TLS configuration for the client. + tlsConfig defines the TLS configuration for the client. + This includes settings for certificates, CA validation, and TLS protocol options. Attributes ---------- @@ -9961,19 +11807,19 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon cert : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfigCa cert?: MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfigCert @@ -9985,7 +11831,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -9999,7 +11845,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10021,7 +11867,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10043,7 +11889,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -10057,7 +11903,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10079,7 +11925,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10101,7 +11947,7 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatConfigsItems0HTTPConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -10123,53 +11969,46 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecReceiversItems0WechatCon schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecRoute: r""" - The Alertmanager route definition for alerts matching the resource's + route defines the Alertmanager route definition for alerts matching the resource's namespace. If present, it will be added to the generated Alertmanager configuration as a first-level route. Attributes ---------- activeTimeIntervals : [str], default is Undefined, optional - ActiveTimeIntervals is a list of MuteTimeInterval names when this route should be active. + activeTimeIntervals is a list of MuteTimeInterval names when this route should be active. continue : bool, default is Undefined, optional - Boolean indicating whether an alert should continue matching subsequent + continue defines the boolean indicating whether an alert should continue matching subsequent sibling nodes. It will always be overridden to true for the first-level route by the Prometheus operator. groupBy : [str], default is Undefined, optional - List of labels to group by. + groupBy defines the list of labels to group by. Labels must not be repeated (unique list). Special label "..." (aggregate by all possible labels), if provided, must be the only element in the list. groupInterval : str, default is Undefined, optional - How long to wait before sending an updated notification. + groupInterval defines how long to wait before sending an updated notification. Must match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$` Example: "5m" groupWait : str, default is Undefined, optional - How long to wait before sending the initial notification. + groupWait defines how long to wait before sending the initial notification. Must match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$` Example: "30s" matchers : [MonitoringCoreosComV1alpha1AlertmanagerConfigSpecRouteMatchersItems0], default is Undefined, optional - List of matchers that the alert's labels should match. For the first + matchers defines the list of matchers that the alert's labels should match. For the first level route, the operator removes any existing equality and regexp matcher on the `namespace` label and adds a `namespace: ` matcher. muteTimeIntervals : [str], default is Undefined, optional - Note: this comment applies to the field definition above but appears - below otherwise it gets included in the generated manifest. - CRD schema doesn't support self-referential types for now (see - https://github.com/kubernetes/kubernetes/issues/62872). We have to use - an alternative type to circumvent the limitation. The downside is that - the Kube API can't validate the data beyond the fact that it is a valid - JSON representation. - MuteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched, + muteTimeIntervals is a list of MuteTimeInterval names that will mute this route when matched, receiver : str, default is Undefined, optional - Name of the receiver for this route. If not empty, it should be listed in + receiver defines the name of the receiver for this route. If not empty, it should be listed in the `receivers` field. repeatInterval : str, default is Undefined, optional - How long to wait before repeating the last notification. + repeatInterval defines how long to wait before repeating the last notification. Must match the regular expression`^(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?$` Example: "4h" routes : [any], default is Undefined, optional - Child routes. + routes defines the child routes. """ activeTimeIntervals?: [str] continue?: bool @@ -10189,15 +12028,18 @@ schema MonitoringCoreosComV1alpha1AlertmanagerConfigSpecRouteMatchersItems0: Attributes ---------- matchType : str, default is Undefined, optional - Match operation available with AlertManager >= v0.22.0 and - takes precedence over Regex (deprecated) if non-empty. + matchType defines the match operation available with AlertManager >= v0.22.0. + Takes precedence over Regex (deprecated) if non-empty. + Valid values: "=" (equality), "!=" (inequality), "=~" (regex match), "!~" (regex non-match). name : str, default is Undefined, required - Label to match. + name defines the label to match. + This specifies which alert label should be evaluated. regex : bool, default is Undefined, optional - Whether to match on equality (false) or regular-expression (true). + regex defines whether to match on equality (false) or regular-expression (true). Deprecated: for AlertManager >= v0.22.0, `matchType` should be used instead. value : str, default is Undefined, optional - Label value to match. + value defines the label value to match. + This is the expected value for the specified label. """ matchType?: "!=" | "=" | "=~" | "!~" name: str diff --git a/docs/examples/src/charts/kube_prometheus_stack/api/v1alpha1/monitoring_coreos_com_v1alpha1_prometheus_agent.k b/docs/examples/src/charts/kube_prometheus_stack/api/v1alpha1/monitoring_coreos_com_v1alpha1_prometheus_agent.k index 13184c22..3ca316bf 100644 --- a/docs/examples/src/charts/kube_prometheus_stack/api/v1alpha1/monitoring_coreos_com_v1alpha1_prometheus_agent.k +++ b/docs/examples/src/charts/kube_prometheus_stack/api/v1alpha1/monitoring_coreos_com_v1alpha1_prometheus_agent.k @@ -38,13 +38,13 @@ schema PrometheusAgent: schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: r""" - Specification of the desired behavior of the Prometheus agent. More info: + spec defines the specification of the desired behavior of the Prometheus agent. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Attributes ---------- additionalArgs : [MonitoringCoreosComV1alpha1PrometheusAgentSpecAdditionalArgsItems0], default is Undefined, optional - AdditionalArgs allows setting additional arguments for the 'prometheus' container. + additionalArgs allows setting additional arguments for the 'prometheus' container. It is intended for e.g. activating hidden flags which are not supported by the dedicated configuration options yet. The arguments are passed as-is to the @@ -63,24 +63,24 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: arbitraryFSAccessThroughSMs : MonitoringCoreosComV1alpha1PrometheusAgentSpecArbitraryFSAccessThroughSMs, default is Undefined, optional arbitrary f s access through s ms automountServiceAccountToken : bool, default is Undefined, optional - AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod. + automountServiceAccountToken defines whether a service account token should be automatically mounted in the pod. If the field isn't set, the operator mounts the service account token by default. **Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery. It is possible to use strategic merge patch to project the service account token into the 'prometheus' container. bodySizeLimit : str, default is Undefined, optional - BodySizeLimit defines per-scrape on response body size. + bodySizeLimit defines per-scrape on response body size. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit. configMaps : [str], default is Undefined, optional - ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus + configMaps defines a list of ConfigMaps in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each ConfigMap is added to the StatefulSet definition as a volume named `configmap-`. The ConfigMaps are mounted into /etc/prometheus/configmaps/ in the 'prometheus' container. containers : [MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0], default is Undefined, optional - Containers allows injecting additional containers or modifying operator + containers allows injecting additional containers or modifying operator generated containers. This can be used to allow adding an authentication proxy to the Pods or to change the behavior of an operator generated container. Containers described here modify an operator generated @@ -95,12 +95,17 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: Overriding containers is entirely outside the scope of what the maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. + convertClassicHistogramsToNHCB : bool, default is Undefined, optional + convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native + histogram with custom buckets. + + It requires Prometheus >= v3.4.0. dnsConfig : MonitoringCoreosComV1alpha1PrometheusAgentSpecDNSConfig, default is Undefined, optional dns config dnsPolicy : str, default is Undefined, optional - Defines the DNS policy for the pods. + dnsPolicy defines the DNS policy for the pods. enableFeatures : [str], default is Undefined, optional - Enable access to Prometheus feature flags. By default, no features are enabled. + enableFeatures enables access to Prometheus feature flags. By default, no features are enabled. Enabling features which are disabled by default is entirely outside the scope of what the maintainers will support and by doing so, you accept @@ -108,13 +113,13 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: For more information see https://prometheus.io/docs/prometheus/latest/feature_flags/ enableOTLPReceiver : bool, default is Undefined, optional - Enable Prometheus to be used as a receiver for the OTLP Metrics protocol. + enableOTLPReceiver defines the Prometheus to be used as a receiver for the OTLP Metrics protocol. Note that the OTLP receiver endpoint is automatically enabled if `.spec.otlpConfig` is defined. It requires Prometheus >= v2.47.0. enableRemoteWriteReceiver : bool, default is Undefined, optional - Enable Prometheus to be used as a receiver for the Prometheus remote + enableRemoteWriteReceiver defines the Prometheus to be used as a receiver for the Prometheus remote write protocol. WARNING: This is not considered an efficient way of ingesting samples. @@ -124,8 +129,10 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: For more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver It requires Prometheus >= v2.33.0. + enableServiceLinks : bool, default is Undefined, optional + enableServiceLinks defines whether information about services should be injected into pod's environment variables enforcedBodySizeLimit : str, default is Undefined, optional - When defined, enforcedBodySizeLimit specifies a global limit on the size + enforcedBodySizeLimit when defined specifies a global limit on the size of uncompressed response body that will be accepted by Prometheus. Targets responding with a body larger than this many bytes will cause the scrape to fail. @@ -138,7 +145,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: * Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value. * Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit. enforcedKeepDroppedTargets : int, default is Undefined, optional - When defined, enforcedKeepDroppedTargets specifies a global limit on the number of targets + enforcedKeepDroppedTargets when defined specifies a global limit on the number of targets dropped by relabeling that will be kept in memory. The value overrides any `spec.keepDroppedTargets` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is @@ -152,7 +159,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: * Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value. * Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets. enforcedLabelLimit : int, default is Undefined, optional - When defined, enforcedLabelLimit specifies a global limit on the number + enforcedLabelLimit when defined specifies a global limit on the number of labels per sample. The value overrides any `spec.labelLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is greater than zero and less than `spec.enforcedLabelLimit`. @@ -165,7 +172,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: * Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value. * Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit. enforcedLabelNameLengthLimit : int, default is Undefined, optional - When defined, enforcedLabelNameLengthLimit specifies a global limit on the length + enforcedLabelNameLengthLimit when defined specifies a global limit on the length of labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is greater than zero and less than `spec.enforcedLabelNameLengthLimit`. @@ -178,7 +185,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: * Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value. * Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit. enforcedLabelValueLengthLimit : int, default is Undefined, optional - When not null, enforcedLabelValueLengthLimit defines a global limit on the length + enforcedLabelValueLengthLimit when not null defines a global limit on the length of labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is greater than zero and less than `spec.enforcedLabelValueLengthLimit`. @@ -191,7 +198,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: * Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value. * Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit. enforcedNamespaceLabel : str, default is Undefined, optional - When not empty, a label will be added to: + enforcedNamespaceLabel when not empty, a label will be added to: 1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects. 2. All metrics generated from recording rules defined in `PrometheusRule` objects. @@ -204,7 +211,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: The label's value is the namespace of the `ServiceMonitor`, `PodMonitor`, `Probe`, `PrometheusRule` or `ScrapeConfig` object. enforcedSampleLimit : int, default is Undefined, optional - When defined, enforcedSampleLimit specifies a global limit on the number + enforcedSampleLimit when defined specifies a global limit on the number of scraped samples that will be accepted. This overrides any `spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.sampleLimit` is greater than zero and less than @@ -219,7 +226,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: * Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value. * Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit. enforcedTargetLimit : int, default is Undefined, optional - When defined, enforcedTargetLimit specifies a global limit on the number + enforcedTargetLimit when defined specifies a global limit on the number of scraped targets. The value overrides any `spec.targetLimit` set by ServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is greater than zero and less than `spec.enforcedTargetLimit`. @@ -233,38 +240,45 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: * Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value. * Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit. excludedFromEnforcement : [MonitoringCoreosComV1alpha1PrometheusAgentSpecExcludedFromEnforcementItems0], default is Undefined, optional - List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects + excludedFromEnforcement defines the list of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects to be excluded from enforcing a namespace label of origin. It is only applicable if `spec.enforcedNamespaceLabel` set to true. externalLabels : {str:str}, default is Undefined, optional - The labels to add to any time series or alerts when communicating with + externalLabels defines the labels to add to any time series or alerts when communicating with external systems (federation, remote storage, Alertmanager). Labels defined by `spec.replicaExternalLabelName` and `spec.prometheusExternalLabelName` take precedence over this list. externalUrl : str, default is Undefined, optional - The external URL under which the Prometheus service is externally + externalUrl defines the external URL under which the Prometheus service is externally available. This is necessary to generate correct URLs (for instance if Prometheus is accessible behind an Ingress resource). hostAliases : [MonitoringCoreosComV1alpha1PrometheusAgentSpecHostAliasesItems0], default is Undefined, optional - Optional list of hosts and IPs that will be injected into the Pod's + hostAliases defines the optional list of hosts and IPs that will be injected into the Pod's hosts file if specified. hostNetwork : bool, default is Undefined, optional - Use the host's network namespace if true. + hostNetwork defines the host's network namespace if true. Make sure to understand the security implications if you want to enable - it (https://kubernetes.io/docs/concepts/configuration/overview/). + it (https://kubernetes.io/docs/concepts/configuration/overview/ ). When hostNetwork is enabled, this will set the DNS policy to `ClusterFirstWithHostNet` automatically (unless `.spec.DNSPolicy` is set to a different value). + hostUsers : bool, default is Undefined, optional + hostUsers supports the user space in Kubernetes. + + More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/ + + The feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled. + Starting Kubernetes 1.33, the feature is enabled by default. ignoreNamespaceSelectors : bool, default is Undefined, optional - When true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor + ignoreNamespaceSelectors when true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor and Probe objects will be ignored. They will only discover targets within the namespace of the PodMonitor, ServiceMonitor and Probe object. image : str, default is Undefined, optional - Container image name for Prometheus. If specified, it takes precedence + image defines the container image name for Prometheus. If specified, it takes precedence over the `spec.baseImage`, `spec.tag` and `spec.sha` fields. Specifying `spec.version` is still necessary to ensure the Prometheus @@ -274,14 +288,14 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: will use the latest upstream version of Prometheus available at the time when the operator was released. imagePullPolicy : str, default is Undefined, optional - Image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers. + imagePullPolicy defines the image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details. imagePullSecrets : [MonitoringCoreosComV1alpha1PrometheusAgentSpecImagePullSecretsItems0], default is Undefined, optional - An optional list of references to Secrets in the same namespace + imagePullSecrets defines an optional list of references to Secrets in the same namespace to use for pulling images from registries. See http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod initContainers : [MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0], default is Undefined, optional - InitContainers allows injecting initContainers to the Pod definition. Those + initContainers allows injecting initContainers to the Pod definition. Those can be used to e.g. fetch secrets for injection into the Prometheus configuration from external sources. Any errors during the execution of an initContainer will lead to a restart of the Pod. More info: @@ -297,7 +311,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: maintainers will support and by doing so, you accept that this behaviour may break at any time without notice. keepDroppedTargets : int, default is Undefined, optional - Per-scrape limit on the number of targets dropped by relabeling + keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0. @@ -305,62 +319,68 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets. labelLimit : int, default is Undefined, optional - Per-scrape limit on number of labels that will be accepted for a sample. + labelLimit defines per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit. labelNameLengthLimit : int, default is Undefined, optional - Per-scrape limit on length of labels name that will be accepted for a sample. + labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit. labelValueLengthLimit : int, default is Undefined, optional - Per-scrape limit on length of labels value that will be accepted for a sample. + labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit. listenLocal : bool, default is Undefined, optional - When true, the Prometheus server listens on the loopback address + listenLocal when true, the Prometheus server listens on the loopback address instead of the Pod IP's address. logFormat : str, default is Undefined, optional - Log format for Log level for Prometheus and the config-reloader sidecar. + logFormat for Log level for Prometheus and the config-reloader sidecar. logLevel : str, default is Undefined, optional - Log level for Prometheus and the config-reloader sidecar. + logLevel for Prometheus and the config-reloader sidecar. maximumStartupDurationSeconds : int, default is Undefined, optional - Defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete. - If set, the value should be greater than 60 (seconds). Otherwise it will be equal to 600 seconds (15 minutes). + maximumStartupDurationSeconds defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete. + If set, the value should be greater than 60 (seconds). Otherwise it will be equal to 900 seconds (15 minutes). minReadySeconds : int, default is Undefined, optional - Minimum number of seconds for which a newly created Pod should be ready + minReadySeconds defines the minimum number of seconds for which a newly created Pod should be ready without any of its container crashing for it to be considered available. - Defaults to 0 (pod will be considered available as soon as it is ready) - This is an alpha field from kubernetes 1.22 until 1.24 which requires - enabling the StatefulSetMinReadySeconds feature gate. + If unset, pods will be considered available as soon as they are ready. mode : str, default is Undefined, optional - Mode defines how the Prometheus operator deploys the PrometheusAgent pod(s). + mode defines how the Prometheus operator deploys the PrometheusAgent pod(s). (Alpha) Using this field requires the `PrometheusAgentDaemonSet` feature gate to be enabled. + nameEscapingScheme : str, default is Undefined, optional + nameEscapingScheme defines the character escaping scheme that will be requested when scraping + for metric and label names that do not conform to the legacy Prometheus + character set. + + It requires Prometheus >= v3.4.0. nameValidationScheme : str, default is Undefined, optional - Specifies the validation scheme for metric and label names. + nameValidationScheme defines the validation scheme for metric and label names. + + It requires Prometheus >= v2.55.0. nodeSelector : {str:str}, default is Undefined, optional - Defines on which Nodes the Pods are scheduled. + nodeSelector defines on which Nodes the Pods are scheduled. otlp : MonitoringCoreosComV1alpha1PrometheusAgentSpecOtlp, default is Undefined, optional otlp overrideHonorLabels : bool, default is Undefined, optional - When true, Prometheus resolves label conflicts by renaming the labels in the scraped data + overrideHonorLabels when true, Prometheus resolves label conflicts by renaming the labels in the scraped data to “exported_” for all targets created from ServiceMonitor, PodMonitor and ScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies. - In practice,`overrideHonorLaels:true` enforces `honorLabels:false` + In practice,`OverrideHonorLabels:true` enforces `honorLabels:false` for all ServiceMonitor, PodMonitor and ScrapeConfig objects. overrideHonorTimestamps : bool, default is Undefined, optional - When true, Prometheus ignores the timestamps for all the targets created + overrideHonorTimestamps when true, Prometheus ignores the timestamps for all the targets created from service and pod monitors. Otherwise the HonorTimestamps field of the service or pod monitor applies. paused : bool, default is Undefined, optional - When a Prometheus deployment is paused, no actions except for deletion + paused defines when a Prometheus deployment is paused, no actions except for deletion will be performed on the underlying objects. persistentVolumeClaimRetentionPolicy : MonitoringCoreosComV1alpha1PrometheusAgentSpecPersistentVolumeClaimRetentionPolicy, default is Undefined, optional persistent volume claim retention policy @@ -371,41 +391,41 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: podMonitorSelector : MonitoringCoreosComV1alpha1PrometheusAgentSpecPodMonitorSelector, default is Undefined, optional pod monitor selector podTargetLabels : [str], default is Undefined, optional - PodTargetLabels are appended to the `spec.podTargetLabels` field of all + podTargetLabels are appended to the `spec.podTargetLabels` field of all PodMonitor and ServiceMonitor objects. portName : str, default is "web", optional - Port name used for the pods and governing service. + portName used for the pods and governing service. Default: "web" priorityClassName : str, default is Undefined, optional - Priority class assigned to the Pods. + priorityClassName assigned to the Pods. probeNamespaceSelector : MonitoringCoreosComV1alpha1PrometheusAgentSpecProbeNamespaceSelector, default is Undefined, optional probe namespace selector probeSelector : MonitoringCoreosComV1alpha1PrometheusAgentSpecProbeSelector, default is Undefined, optional probe selector prometheusExternalLabelName : str, default is Undefined, optional - Name of Prometheus external label used to denote the Prometheus instance + prometheusExternalLabelName defines the name of Prometheus external label used to denote the Prometheus instance name. The external label will _not_ be added when the field is set to the empty string (`""`). Default: "prometheus" reloadStrategy : str, default is Undefined, optional - Defines the strategy used to reload the Prometheus configuration. + reloadStrategy defines the strategy used to reload the Prometheus configuration. If not specified, the configuration is reloaded using the /-/reload HTTP endpoint. remoteWrite : [MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0], default is Undefined, optional - Defines the list of remote write configurations. + remoteWrite defines the list of remote write configurations. remoteWriteReceiverMessageVersions : [str], default is Undefined, optional - List of the protobuf message versions to accept when receiving the + remoteWriteReceiverMessageVersions list of the protobuf message versions to accept when receiving the remote writes. It requires Prometheus >= v2.54.0. replicaExternalLabelName : str, default is Undefined, optional - Name of Prometheus external label used to denote the replica name. + replicaExternalLabelName defines the name of Prometheus external label used to denote the replica name. The external label will _not_ be added when the field is set to the empty string (`""`). Default: "prometheus_replica" replicas : int, default is Undefined, optional - Number of replicas of each shard to deploy for a Prometheus deployment. + replicas defines the number of replicas of each shard to deploy for a Prometheus deployment. `spec.replicas` multiplied by `spec.shards` is the total number of Pods created. @@ -413,7 +433,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: resources : MonitoringCoreosComV1alpha1PrometheusAgentSpecResources, default is Undefined, optional resources routePrefix : str, default is Undefined, optional - The route prefix Prometheus registers HTTP handlers for. + routePrefix defines the route prefix Prometheus registers HTTP handlers for. This is useful when using `spec.externalURL`, and a proxy is rewriting HTTP routes of a request, and the actual ExternalURL is still true, but @@ -422,23 +442,29 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: runtime : MonitoringCoreosComV1alpha1PrometheusAgentSpecRuntime, default is Undefined, optional runtime sampleLimit : int, default is Undefined, optional - SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. + sampleLimit defines per-scrape limit on number of scraped samples that will be accepted. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit. scrapeClasses : [MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0], default is Undefined, optional - List of scrape classes to expose to scraping objects such as + scrapeClasses defines the list of scrape classes to expose to scraping objects such as PodMonitors, ServiceMonitors, Probes and ScrapeConfigs. This is an *experimental feature*, it may change in any upcoming release in a breaking way. + scrapeClassicHistograms : bool, default is Undefined, optional + scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. + + Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration. + + It requires Prometheus >= v3.5.0. scrapeConfigNamespaceSelector : MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeConfigNamespaceSelector, default is Undefined, optional scrape config namespace selector scrapeConfigSelector : MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeConfigSelector, default is Undefined, optional scrape config selector scrapeFailureLogFile : str, default is Undefined, optional - File to which scrape failures are logged. + scrapeFailureLogFile defines the file to which scrape failures are logged. Reloading the configuration will reopen the file. If the filename has an empty path, e.g. 'file.log', The Prometheus Pods @@ -447,11 +473,11 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: must mount a volume in the specified directory and it must be writable. It requires Prometheus >= v2.55.0. scrapeInterval : str, default is "30s", optional - Interval between consecutive scrapes. + scrapeInterval defines interval between consecutive scrapes. Default: "30s" scrapeProtocols : [str], default is Undefined, optional - The protocols to negotiate during a scrape. It tells clients the + scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. @@ -460,20 +486,20 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: `PrometheusText1.0.0` requires Prometheus >= v3.0.0. scrapeTimeout : str, default is Undefined, optional - Number of seconds to wait until a scrape request times out. + scrapeTimeout defines the number of seconds to wait until a scrape request times out. The value cannot be greater than the scrape interval otherwise the operator will reject the resource. secrets : [str], default is Undefined, optional - Secrets is a list of Secrets in the same namespace as the Prometheus + secrets defines a list of Secrets in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. Each Secret is added to the StatefulSet definition as a volume named `secret-`. The Secrets are mounted into /etc/prometheus/secrets/ in the 'prometheus' container. securityContext : MonitoringCoreosComV1alpha1PrometheusAgentSpecSecurityContext, default is Undefined, optional security context serviceAccountName : str, default is Undefined, optional - ServiceAccountName is the name of the ServiceAccount to use to run the + serviceAccountName is the name of the ServiceAccount to use to run the Prometheus Pods. serviceDiscoveryRole : str, default is Undefined, optional - Defines the service discovery role used to discover targets from + serviceDiscoveryRole defines the service discovery role used to discover targets from `ServiceMonitor` objects and Alertmanager endpoints. If set, the value should be either "Endpoints" or "EndpointSlice". @@ -483,14 +509,14 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: serviceMonitorSelector : MonitoringCoreosComV1alpha1PrometheusAgentSpecServiceMonitorSelector, default is Undefined, optional service monitor selector serviceName : str, default is Undefined, optional - The name of the service name used by the underlying StatefulSet(s) as the governing service. + serviceName defines the name of the service name used by the underlying StatefulSet(s) as the governing service. If defined, the Service must be created before the Prometheus/PrometheusAgent resource in the same namespace and it must define a selector that matches the pod labels. If empty, the operator will create and manage a headless service named `prometheus-operated` for Prometheus resources, or `prometheus-agent-operated` for PrometheusAgent resources. When deploying multiple Prometheus/PrometheusAgent resources in the same namespace, it is recommended to specify a different value for each. See https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details. shards : int, default is Undefined, optional - Number of shards to distribute scraped targets onto. + shards defines the number of shards to distribute the scraped targets onto. `spec.replicas` multiplied by `spec.shards` is the total number of Pods being created. @@ -500,11 +526,11 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: Note that scaling down shards will not reshard data onto the remaining instances, it must be manually moved. Increasing shards will not reshard data either but it will continue to be available from the same - instances. To query globally, use Thanos sidecar and Thanos querier or - remote write data to a central location. - Alerting and recording rules + instances. To query globally, use either + * Thanos sidecar + querier for query federation and Thanos Ruler for rules. + * Remote-write to send metrics to a central location. - By default, the sharding is performed on: + By default, the sharding of targets is performed on: * The `__address__` target's metadata label for PodMonitor, ServiceMonitor and ScrapeConfig resources. * The `__param_target__` label for Probe resources. @@ -512,40 +538,50 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: Users can define their own sharding implementation by setting the `__tmp_hash` label during the target discovery with relabeling configuration (either in the monitoring resources or via scrape class). + + You can also disable sharding on a specific target by setting the + `__tmp_disable_sharding` label with relabeling configuration. When + the label value isn't empty, all Prometheus shards will scrape the target. storage : MonitoringCoreosComV1alpha1PrometheusAgentSpecStorage, default is Undefined, optional storage targetLimit : int, default is Undefined, optional - TargetLimit defines a limit on the number of scraped targets that will be accepted. + targetLimit defines a limit on the number of scraped targets that will be accepted. Only valid in Prometheus versions 2.45.0 and newer. Note that the global limit only applies to scrape objects that don't specify an explicit limit value. If you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit. + terminationGracePeriodSeconds : int, default is Undefined, optional + terminationGracePeriodSeconds defines the optional duration in seconds the pod needs to terminate gracefully. + Value must be non-negative integer. The value zero indicates stop immediately via + the kill signal (no opportunity to shut down) which may lead to data corruption. + + Defaults to 600 seconds. tolerations : [MonitoringCoreosComV1alpha1PrometheusAgentSpecTolerationsItems0], default is Undefined, optional - Defines the Pods' tolerations if specified. + tolerations defines the Pods' tolerations if specified. topologySpreadConstraints : [MonitoringCoreosComV1alpha1PrometheusAgentSpecTopologySpreadConstraintsItems0], default is Undefined, optional - Defines the pod's topology spread constraints if specified. + topologySpreadConstraints defines the pod's topology spread constraints if specified. tracingConfig : MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfig, default is Undefined, optional tracing config tsdb : MonitoringCoreosComV1alpha1PrometheusAgentSpecTsdb, default is Undefined, optional tsdb version : str, default is Undefined, optional - Version of Prometheus being deployed. The operator uses this information + version of Prometheus being deployed. The operator uses this information to generate the Prometheus StatefulSet + configuration files. If not specified, the operator assumes the latest upstream version of Prometheus available at the time when the version of the operator was released. volumeMounts : [MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumeMountsItems0], default is Undefined, optional - VolumeMounts allows the configuration of additional VolumeMounts. + volumeMounts allows the configuration of additional VolumeMounts. VolumeMounts will be appended to other VolumeMounts in the 'prometheus' container, that are generated as a result of StorageSpec objects. volumes : [MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0], default is Undefined, optional - Volumes allows the configuration of additional volumes on the output + volumes allows the configuration of additional volumes on the output StatefulSet definition. Volumes specified will be appended to other volumes that are generated as a result of StorageSpec objects. walCompression : bool, default is Undefined, optional - Configures compression of the write-ahead log (WAL) using Snappy. + walCompression defines the compression of the write-ahead log (WAL) using Snappy. WAL compression is enabled by default for Prometheus >= 2.20.0 @@ -562,11 +598,13 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: bodySizeLimit?: str configMaps?: [str] containers?: [MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0] + convertClassicHistogramsToNHCB?: bool dnsConfig?: MonitoringCoreosComV1alpha1PrometheusAgentSpecDNSConfig dnsPolicy?: "ClusterFirstWithHostNet" | "ClusterFirst" | "Default" | "None" enableFeatures?: [str] enableOTLPReceiver?: bool enableRemoteWriteReceiver?: bool + enableServiceLinks?: bool enforcedBodySizeLimit?: str enforcedKeepDroppedTargets?: int enforcedLabelLimit?: int @@ -580,6 +618,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: externalUrl?: str hostAliases?: [MonitoringCoreosComV1alpha1PrometheusAgentSpecHostAliasesItems0] hostNetwork?: bool + hostUsers?: bool ignoreNamespaceSelectors?: bool image?: str imagePullPolicy?: "" | "Always" | "Never" | "IfNotPresent" @@ -595,6 +634,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: maximumStartupDurationSeconds?: int minReadySeconds?: int mode?: "StatefulSet" | "DaemonSet" + nameEscapingScheme?: "AllowUTF8" | "Underscores" | "Dots" | "Values" nameValidationScheme?: "UTF8" | "Legacy" nodeSelector?: {str:str} otlp?: MonitoringCoreosComV1alpha1PrometheusAgentSpecOtlp @@ -621,6 +661,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: runtime?: MonitoringCoreosComV1alpha1PrometheusAgentSpecRuntime sampleLimit?: int scrapeClasses?: [MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0] + scrapeClassicHistograms?: bool scrapeConfigNamespaceSelector?: MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeConfigNamespaceSelector scrapeConfigSelector?: MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeConfigSelector scrapeFailureLogFile?: str @@ -637,6 +678,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: shards?: int storage?: MonitoringCoreosComV1alpha1PrometheusAgentSpecStorage targetLimit?: int + terminationGracePeriodSeconds?: int tolerations?: [MonitoringCoreosComV1alpha1PrometheusAgentSpecTolerationsItems0] topologySpreadConstraints?: [MonitoringCoreosComV1alpha1PrometheusAgentSpecTopologySpreadConstraintsItems0] tracingConfig?: MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfig @@ -652,11 +694,13 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpec: all enableFeatures in enableFeatures {len(enableFeatures) >= 1 if enableFeatures not in [None, Undefined]} if enableFeatures _regex_match(str(enforcedBodySizeLimit), r"(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$") if enforcedBodySizeLimit maximumStartupDurationSeconds >= 60 if maximumStartupDurationSeconds not in [None, Undefined] + minReadySeconds >= 0 if minReadySeconds not in [None, Undefined] len(remoteWriteReceiverMessageVersions) >= 1 if remoteWriteReceiverMessageVersions len(scrapeFailureLogFile) >= 1 if scrapeFailureLogFile _regex_match(str(scrapeInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if scrapeInterval _regex_match(str(scrapeTimeout), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if scrapeTimeout len(serviceName) >= 1 if serviceName + terminationGracePeriodSeconds >= 0 if terminationGracePeriodSeconds not in [None, Undefined] schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAdditionalArgsItems0: r""" @@ -665,9 +709,9 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAdditionalArgsItems0: Attributes ---------- name : str, default is Undefined, required - Name of the argument, e.g. "scrape.discovery-reload-interval". + name of the argument, e.g. "scrape.discovery-reload-interval". value : str, default is Undefined, optional - Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) + value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile) """ name: str @@ -678,7 +722,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAdditionalArgsItems0: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAdditionalScrapeConfigs: r""" - AdditionalScrapeConfigs allows specifying a key of a Secret containing + additionalScrapeConfigs allows specifying a key of a Secret containing additional Prometheus scrape configurations. Scrape configurations specified are appended to the configurations generated by the Prometheus Operator. Job configurations specified must have the form as specified @@ -710,7 +754,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAdditionalScrapeConfigs: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinity: r""" - Defines the Pods' affinity scheduling rules if specified. + affinity defines the Pods' affinity scheduling rules if specified. Attributes ---------- @@ -969,7 +1013,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAffinityPreferre pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -979,7 +1022,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAffinityPreferre pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAffinityPreferredDuringSchedulingIgnoredDuringExecutionItems0PodAffinityTermNamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -1108,7 +1150,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAffinityRequired pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -1118,7 +1159,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAffinityRequired pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAffinityRequiredDuringSchedulingIgnoredDuringExecutionItems0NamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -1238,8 +1278,8 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAntiAffinity: most preferred is the one with the greatest sum of weights, i.e. for each node that meets all of the scheduling requirements (resource request, requiredDuringScheduling anti-affinity expressions, etc.), - compute a sum by iterating through the elements of this field and adding - "weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the + compute a sum by iterating through the elements of this field and subtracting + "weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the node(s) with the highest sum are the most preferred. requiredDuringSchedulingIgnoredDuringExecution : [MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAntiAffinityRequiredDuringSchedulingIgnoredDuringExecutionItems0], default is Undefined, optional If the anti-affinity requirements specified by this field are not met at @@ -1286,7 +1326,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAntiAffinityPref pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -1296,7 +1335,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAntiAffinityPref pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAntiAffinityPreferredDuringSchedulingIgnoredDuringExecutionItems0PodAffinityTermNamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -1425,7 +1463,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAntiAffinityRequ pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both matchLabelKeys and labelSelector. Also, matchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). mismatchLabelKeys : [str], default is Undefined, optional MismatchLabelKeys is a set of pod label keys to select which pods will be taken into consideration. The keys are used to lookup values from the @@ -1435,7 +1472,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAntiAffinityRequ pod labels will be ignored. The default value is empty. The same key is forbidden to exist in both mismatchLabelKeys and labelSelector. Also, mismatchLabelKeys cannot be set when labelSelector isn't set. - This is a beta field and requires enabling MatchLabelKeysInPodAffinity feature gate (enabled by default). namespaceSelector : MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAntiAffinityRequiredDuringSchedulingIgnoredDuringExecutionItems0NamespaceSelector, default is Undefined, optional namespace selector namespaces : [str], default is Undefined, optional @@ -1544,7 +1580,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecAffinityPodAntiAffinityRequ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfig: r""" - APIServerConfig allows specifying a host and auth methods to access the + apiserverConfig allows specifying a host and auth methods to access the Kuberntees API server. If null, Prometheus is assumed to run inside of the cluster: it will discover the API servers automatically and use the Pod's CA certificate @@ -1557,19 +1593,35 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfig: basicAuth : MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigBasicAuth, default is Undefined, optional basic auth bearerToken : str, default is Undefined, optional - *Warning: this field shouldn't be used because the token value appears + bearerToken is deprecated: this will be removed in a future release. + *Warning: this field shouldn't be used because the token value appears in clear-text. Prefer using `authorization`.* - - Deprecated: this will be removed in a future release. bearerTokenFile : str, default is Undefined, optional - File to read bearer token for accessing apiserver. + bearerTokenFile defines the file to read bearer token for accessing apiserver. Cannot be set at the same time as `basicAuth`, `authorization`, or `bearerToken`. Deprecated: this will be removed in a future release. Prefer using `authorization`. host : str, default is Undefined, required - Kubernetes API address consisting of a hostname or IP address followed + host defines the Kubernetes API address consisting of a hostname or IP address followed by an optional port number. + noProxy : str, default is Undefined, optional + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names + that should be excluded from proxying. IP and domain names can + contain port numbers. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigProxyConnectHeaderItems0]}, default is Undefined, optional + proxyConnectHeader optionally specifies headers to send to + proxies during CONNECT requests. + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyFromEnvironment : bool, default is Undefined, optional + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. + proxyUrl : str, default is Undefined, optional + proxyUrl defines the HTTP proxy server to use. tlsConfig : MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfig, default is Undefined, optional tls config """ @@ -1579,11 +1631,18 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfig: bearerTokenFile?: str host: str + noProxy?: str + proxyConnectHeader?: {str:[MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigProxyConnectHeaderItems0]} + proxyFromEnvironment?: bool + proxyUrl?: str tlsConfig?: MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfig + check: + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl + schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigAuthorization: r""" - Authorization section for the API server. + authorization section for the API server. Cannot be set at the same time as `basicAuth`, `bearerToken`, or `bearerTokenFile`. @@ -1593,9 +1652,9 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigAuthorizatio credentials : MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigAuthorizationCredentials, default is Undefined, optional credentials credentialsFile : str, default is Undefined, optional - File to read a secret from, mutually exclusive with `credentials`. + credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -1607,7 +1666,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigAuthorizatio schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -1629,7 +1688,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigAuthorizatio schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigBasicAuth: r""" - BasicAuth configuration for the API server. + basicAuth configuration for the API server. Cannot be set at the same time as `authorization`, `bearerToken`, or `bearerTokenFile`. @@ -1646,7 +1705,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigBasicAuth: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -1669,7 +1728,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigBasicAuthPas schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -1690,36 +1749,58 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigBasicAuthUse name?: str = "" optional?: bool +schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigProxyConnectHeaderItems0: + r""" + SecretKeySelector selects a key of a Secret. + + Attributes + ---------- + key : str, default is Undefined, required + The key of the secret to select from. Must be a valid secret key. + name : str, default is Undefined, optional + 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 + optional : bool, default is Undefined, optional + Specify whether the Secret or its key must be defined + """ + key: str + + name?: str = "" + optional?: bool + schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfig: r""" - TLS Config to use for the API server. + tlsConfig to use for the API server. Attributes ---------- ca : MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCa, default is Undefined, optional ca caFile : str, default is Undefined, optional - Path to the CA cert in the Prometheus container to use for the targets. + caFile defines the path to the CA cert in the Prometheus container to use for the targets. cert : MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the client cert file in the Prometheus container for the targets. + certFile defines the path to the client cert file in the Prometheus container for the targets. insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keyFile : str, default is Undefined, optional - Path to the client key file in the Prometheus container for the targets. + keyFile defines the path to the client key file in the Prometheus container for the targets. keySecret : MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCa caFile?: str @@ -1734,7 +1815,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfig: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -1748,7 +1829,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCa: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1770,7 +1851,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCaC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1792,7 +1873,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCaS schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -1806,7 +1887,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCer schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1828,7 +1909,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCer schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1850,7 +1931,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigCer schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -1872,7 +1953,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecApiserverConfigTLSConfigKey schema MonitoringCoreosComV1alpha1PrometheusAgentSpecArbitraryFSAccessThroughSMs: r""" - When true, ServiceMonitor, PodMonitor and Probe object are forbidden to + arbitraryFSAccessThroughSMs when true, ServiceMonitor, PodMonitor and Probe object are forbidden to reference arbitrary files on the file system of the 'prometheus' container. When a ServiceMonitor's endpoint specifies a `bearerTokenFile` value @@ -1886,7 +1967,10 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecArbitraryFSAccessThroughSMs Attributes ---------- deny : bool, default is Undefined, optional - deny + deny prevents service monitors from accessing arbitrary files on the file system. + When true, service monitors cannot use file-based configurations like BearerTokenFile + that could potentially access sensitive files. When false (default), such access is allowed. + Setting this to true enhances security by preventing potential credential theft attacks. """ deny?: bool @@ -1919,8 +2003,8 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0: Cannot be updated. envFrom : [MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvFromItems0], default is Undefined, optional List of sources to populate environment variables in the container. - The keys defined within a source must be a C_IDENTIFIER. All invalid keys - will be reported as an event when the container is starting. When a key exists in multiple + The keys defined within a source may consist of any printable ASCII characters except '='. + When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. @@ -1959,10 +2043,10 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0: resources restartPolicy : str, default is Undefined, optional RestartPolicy defines the restart behavior of individual containers in a pod. - This field may only be set for init containers, and the only allowed value is "Always". - For non-init containers or when this field is not specified, + This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. - Setting the RestartPolicy as "Always" for the init container will have the following effect: + Additionally, setting the RestartPolicy as "Always" for the init container will + have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" @@ -1973,6 +2057,18 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0: container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. + restartPolicyRules : [MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0RestartPolicyRulesItems0], default is Undefined, optional + Represents a list of rules to be checked to determine if the + container should be restarted on exit. The rules are evaluated in + order. Once a rule matches a container exit condition, the remaining + rules are ignored. If no rule matches the container exit condition, + the Container-level restart policy determines the whether the container + is restarted or not. Constraints on the rules: + - At most 20 rules are allowed. + - Rules can have the same action. + - Identical rules are not forbidden in validations. + When rules are specified, container MUST set RestartPolicy explicitly + even it if matches the Pod's RestartPolicy. securityContext : MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0SecurityContext, default is Undefined, optional security context startupProbe : MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0StartupProbe, default is Undefined, optional @@ -2034,6 +2130,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0: resizePolicy?: [MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0ResizePolicyItems0] resources?: MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0Resources restartPolicy?: str + restartPolicyRules?: [MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0RestartPolicyRulesItems0] securityContext?: MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0SecurityContext startupProbe?: MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0StartupProbe stdin?: bool @@ -2047,14 +2144,15 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvFromItems0: r""" - EnvFromSource represents the source of a set of ConfigMaps + EnvFromSource represents the source of a set of ConfigMaps or Secrets Attributes ---------- configMapRef : MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvFromItems0ConfigMapRef, default is Undefined, optional config map ref prefix : str, default is Undefined, optional - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + Optional text to prepend to the name of each environment variable. + May consist of any printable ASCII characters except '='. secretRef : MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvFromItems0SecretRef, default is Undefined, optional secret ref """ @@ -2105,7 +2203,8 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0: Attributes ---------- name : str, default is Undefined, required - Name of the environment variable. Must be a C_IDENTIFIER. + Name of the environment variable. + May consist of any printable ASCII characters except '='. value : str, default is Undefined, optional Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and @@ -2134,6 +2233,8 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0Va config map key ref fieldRef : MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0ValueFromFieldRef, default is Undefined, optional field ref + fileKeyRef : MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0ValueFromFileKeyRef, default is Undefined, optional + file key ref resourceFieldRef : MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0ValueFromResourceFieldRef, default is Undefined, optional resource field ref secretKeyRef : MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0ValueFromSecretKeyRef, default is Undefined, optional @@ -2141,6 +2242,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0Va """ configMapKeyRef?: MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0ValueFromConfigMapKeyRef fieldRef?: MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0ValueFromFieldRef + fileKeyRef?: MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0ValueFromFileKeyRef resourceFieldRef?: MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0ValueFromResourceFieldRef secretKeyRef?: MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0ValueFromSecretKeyRef @@ -2181,6 +2283,38 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0Va apiVersion?: str fieldPath: str +schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0ValueFromFileKeyRef: + r""" + FileKeyRef selects a key of the env file. + Requires the EnvFiles feature gate to be enabled. + + Attributes + ---------- + key : str, default is Undefined, required + The key within the env file. An invalid key will prevent the pod from starting. + The keys defined within a source may consist of any printable ASCII characters except '='. + During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + optional : bool, default is Undefined, optional + Specify whether the file or its key must be defined. If the file or key + does not exist, then the env var is not published. + If optional is set to true and the specified key does not exist, + the environment variable will not be set in the Pod's containers. + + If optional is set to false and the specified key does not exist, + an error will be returned during Pod creation. + path : str, default is Undefined, required + The path within the volume from which to select the file. + Must be relative and may not contain the '..' path or start with '..'. + volumeName : str, default is Undefined, required + The name of the volume mount containing the env file. + """ + key: str + + optional?: bool = False + path: str + + volumeName: str + schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0EnvItems0ValueFromResourceFieldRef: r""" Selects a resource of the container: only resources limits and requests @@ -2235,9 +2369,14 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0Lifecycle: post start preStop : MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0LifecyclePreStop, default is Undefined, optional pre stop + stopSignal : str, default is Undefined, optional + StopSignal defines which signal will be sent to a container when it is being stopped. + If not specified, the default is defined by the container runtime in use. + StopSignal can only be set for Pods with a non-empty .spec.os.name """ postStart?: MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0LifecyclePostStart preStop?: MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0LifecyclePreStop + stopSignal?: str schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0LifecyclePostStart: r""" @@ -2824,7 +2963,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0Resources: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. - This is an alpha field and requires enabling the + This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. @@ -2864,6 +3003,44 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0ResourcesCl request?: str +schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0RestartPolicyRulesItems0: + r""" + ContainerRestartRule describes how a container exit is handled. + + Attributes + ---------- + action : str, default is Undefined, required + Specifies the action taken on a container exit if the requirements + are satisfied. The only possible value is "Restart" to restart the + container. + exitCodes : MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0RestartPolicyRulesItems0ExitCodes, default is Undefined, optional + exit codes + """ + action: str + + exitCodes?: MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0RestartPolicyRulesItems0ExitCodes + +schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0RestartPolicyRulesItems0ExitCodes: + r""" + Represents the exit codes to check on container exits. + + Attributes + ---------- + operator : str, default is Undefined, required + Represents the relationship between the container exit code(s) and the + specified values. Possible values are: + - In: the requirement is satisfied if the container exit code is in the + set of specified values. + - NotIn: the requirement is satisfied if the container exit code is + not in the set of specified values. + values : [int], default is Undefined, optional + Specifies the set of values to check for container exit codes. + At most 255 elements are allowed. + """ + operator: str + + values?: [int] + schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0SecurityContext: r""" SecurityContext defines the security options the container should be run with. @@ -3283,20 +3460,20 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecContainersItems0VolumeMount schema MonitoringCoreosComV1alpha1PrometheusAgentSpecDNSConfig: r""" - Defines the DNS configuration for the pods. + dnsConfig defines the DNS configuration for the pods. Attributes ---------- nameservers : [str], default is Undefined, optional - A list of DNS name server IP addresses. + nameservers defines the list of DNS name server IP addresses. This will be appended to the base nameservers generated from DNSPolicy. options : [MonitoringCoreosComV1alpha1PrometheusAgentSpecDNSConfigOptionsItems0], default is Undefined, optional - A list of DNS resolver options. + options defines the list of DNS resolver options. This will be merged with the base options generated from DNSPolicy. Resolution options given in Options will override those that appear in the base DNSPolicy. searches : [str], default is Undefined, optional - A list of DNS search domains for host-name lookup. + searches defines the list of DNS search domains for host-name lookup. This will be appended to the base search paths generated from DNSPolicy. """ nameservers?: [str] @@ -3314,9 +3491,9 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecDNSConfigOptionsItems0: Attributes ---------- name : str, default is Undefined, required - Name is required and must be unique. + name is required and must be unique. value : str, default is Undefined, optional - Value is optional. + value is optional. """ name: str @@ -3332,14 +3509,14 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecExcludedFromEnforcementItem Attributes ---------- group : str, default is "monitoring.coreos.com", optional - Group of the referent. When not specified, it defaults to `monitoring.coreos.com` + group of the referent. When not specified, it defaults to `monitoring.coreos.com` name : str, default is Undefined, optional - Name of the referent. When not set, all resources in the namespace are matched. + name of the referent. When not set, all resources in the namespace are matched. namespace : str, default is Undefined, required - Namespace of the referent. + namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ resource : str, default is Undefined, required - Resource of the referent. + resource of the referent. """ group?: "monitoring.coreos.com" = "monitoring.coreos.com" name?: str @@ -3358,9 +3535,9 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecHostAliasesItems0: Attributes ---------- hostnames : [str], default is Undefined, required - Hostnames for the above IP address. + hostnames defines hostnames for the above IP address. ip : str, default is Undefined, required - IP address of the host file entry. + ip defines the IP address of the host file entry. """ hostnames: [str] @@ -3411,8 +3588,8 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0: Cannot be updated. envFrom : [MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvFromItems0], default is Undefined, optional List of sources to populate environment variables in the container. - The keys defined within a source must be a C_IDENTIFIER. All invalid keys - will be reported as an event when the container is starting. When a key exists in multiple + The keys defined within a source may consist of any printable ASCII characters except '='. + When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated. @@ -3451,10 +3628,10 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0: resources restartPolicy : str, default is Undefined, optional RestartPolicy defines the restart behavior of individual containers in a pod. - This field may only be set for init containers, and the only allowed value is "Always". - For non-init containers or when this field is not specified, + This overrides the pod-level restart policy. When this field is not specified, the restart behavior is defined by the Pod's restart policy and the container type. - Setting the RestartPolicy as "Always" for the init container will have the following effect: + Additionally, setting the RestartPolicy as "Always" for the init container will + have the following effect: this init container will be continually restarted on exit until all regular containers have terminated. Once all regular containers have completed, all init containers with restartPolicy "Always" @@ -3465,6 +3642,18 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0: container. Instead, the next init container starts immediately after this init container is started, or after any startupProbe has successfully completed. + restartPolicyRules : [MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0RestartPolicyRulesItems0], default is Undefined, optional + Represents a list of rules to be checked to determine if the + container should be restarted on exit. The rules are evaluated in + order. Once a rule matches a container exit condition, the remaining + rules are ignored. If no rule matches the container exit condition, + the Container-level restart policy determines the whether the container + is restarted or not. Constraints on the rules: + - At most 20 rules are allowed. + - Rules can have the same action. + - Identical rules are not forbidden in validations. + When rules are specified, container MUST set RestartPolicy explicitly + even it if matches the Pod's RestartPolicy. securityContext : MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0SecurityContext, default is Undefined, optional security context startupProbe : MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0StartupProbe, default is Undefined, optional @@ -3526,6 +3715,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0: resizePolicy?: [MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0ResizePolicyItems0] resources?: MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0Resources restartPolicy?: str + restartPolicyRules?: [MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0RestartPolicyRulesItems0] securityContext?: MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0SecurityContext startupProbe?: MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0StartupProbe stdin?: bool @@ -3539,14 +3729,15 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvFromItems0: r""" - EnvFromSource represents the source of a set of ConfigMaps + EnvFromSource represents the source of a set of ConfigMaps or Secrets Attributes ---------- configMapRef : MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvFromItems0ConfigMapRef, default is Undefined, optional config map ref prefix : str, default is Undefined, optional - An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER. + Optional text to prepend to the name of each environment variable. + May consist of any printable ASCII characters except '='. secretRef : MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvFromItems0SecretRef, default is Undefined, optional secret ref """ @@ -3597,7 +3788,8 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItem Attributes ---------- name : str, default is Undefined, required - Name of the environment variable. Must be a C_IDENTIFIER. + Name of the environment variable. + May consist of any printable ASCII characters except '='. value : str, default is Undefined, optional Variable references $(VAR_NAME) are expanded using the previously defined environment variables in the container and @@ -3626,6 +3818,8 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItem config map key ref fieldRef : MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItems0ValueFromFieldRef, default is Undefined, optional field ref + fileKeyRef : MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItems0ValueFromFileKeyRef, default is Undefined, optional + file key ref resourceFieldRef : MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItems0ValueFromResourceFieldRef, default is Undefined, optional resource field ref secretKeyRef : MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItems0ValueFromSecretKeyRef, default is Undefined, optional @@ -3633,6 +3827,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItem """ configMapKeyRef?: MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItems0ValueFromConfigMapKeyRef fieldRef?: MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItems0ValueFromFieldRef + fileKeyRef?: MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItems0ValueFromFileKeyRef resourceFieldRef?: MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItems0ValueFromResourceFieldRef secretKeyRef?: MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItems0ValueFromSecretKeyRef @@ -3673,6 +3868,38 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItem apiVersion?: str fieldPath: str +schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItems0ValueFromFileKeyRef: + r""" + FileKeyRef selects a key of the env file. + Requires the EnvFiles feature gate to be enabled. + + Attributes + ---------- + key : str, default is Undefined, required + The key within the env file. An invalid key will prevent the pod from starting. + The keys defined within a source may consist of any printable ASCII characters except '='. + During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters. + optional : bool, default is Undefined, optional + Specify whether the file or its key must be defined. If the file or key + does not exist, then the env var is not published. + If optional is set to true and the specified key does not exist, + the environment variable will not be set in the Pod's containers. + + If optional is set to false and the specified key does not exist, + an error will be returned during Pod creation. + path : str, default is Undefined, required + The path within the volume from which to select the file. + Must be relative and may not contain the '..' path or start with '..'. + volumeName : str, default is Undefined, required + The name of the volume mount containing the env file. + """ + key: str + + optional?: bool = False + path: str + + volumeName: str + schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0EnvItems0ValueFromResourceFieldRef: r""" Selects a resource of the container: only resources limits and requests @@ -3727,9 +3954,14 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0Lifecyc post start preStop : MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0LifecyclePreStop, default is Undefined, optional pre stop + stopSignal : str, default is Undefined, optional + StopSignal defines which signal will be sent to a container when it is being stopped. + If not specified, the default is defined by the container runtime in use. + StopSignal can only be set for Pods with a non-empty .spec.os.name """ postStart?: MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0LifecyclePostStart preStop?: MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0LifecyclePreStop + stopSignal?: str schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0LifecyclePostStart: r""" @@ -4316,7 +4548,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0Resourc Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. - This is an alpha field and requires enabling the + This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. @@ -4356,6 +4588,44 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0Resourc request?: str +schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0RestartPolicyRulesItems0: + r""" + ContainerRestartRule describes how a container exit is handled. + + Attributes + ---------- + action : str, default is Undefined, required + Specifies the action taken on a container exit if the requirements + are satisfied. The only possible value is "Restart" to restart the + container. + exitCodes : MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0RestartPolicyRulesItems0ExitCodes, default is Undefined, optional + exit codes + """ + action: str + + exitCodes?: MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0RestartPolicyRulesItems0ExitCodes + +schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0RestartPolicyRulesItems0ExitCodes: + r""" + Represents the exit codes to check on container exits. + + Attributes + ---------- + operator : str, default is Undefined, required + Represents the relationship between the container exit code(s) and the + specified values. Possible values are: + - In: the requirement is satisfied if the container exit code is in the + set of specified values. + - NotIn: the requirement is satisfied if the container exit code is + not in the set of specified values. + values : [int], default is Undefined, optional + Specifies the set of values to check for container exit codes. + At most 255 elements are allowed. + """ + operator: str + + values?: [int] + schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0SecurityContext: r""" SecurityContext defines the security options the container should be run with. @@ -4775,34 +5045,58 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecInitContainersItems0VolumeM schema MonitoringCoreosComV1alpha1PrometheusAgentSpecOtlp: r""" - Settings related to the OTLP receiver feature. + otlp defines the settings related to the OTLP receiver feature. It requires Prometheus >= v2.55.0. Attributes ---------- + convertHistogramsToNHCB : bool, default is Undefined, optional + convertHistogramsToNHCB defines optional translation of OTLP explicit bucket histograms into native histograms with custom buckets. + It requires Prometheus >= v3.4.0. + ignoreResourceAttributes : [str], default is Undefined, optional + ignoreResourceAttributes defines the list of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true. + + It requires `promoteAllResourceAttributes` to be true. + It requires Prometheus >= v3.5.0. keepIdentifyingResourceAttributes : bool, default is Undefined, optional - Enables adding `service.name`, `service.namespace` and `service.instance.id` + keepIdentifyingResourceAttributes enables adding `service.name`, `service.namespace` and `service.instance.id` resource attributes to the `target_info` metric, on top of converting them into the `instance` and `job` labels. It requires Prometheus >= v3.1.0. + promoteAllResourceAttributes : bool, default is Undefined, optional + promoteAllResourceAttributes promotes all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`. + + Cannot be true when `promoteResourceAttributes` is defined. + It requires Prometheus >= v3.5.0. promoteResourceAttributes : [str], default is Undefined, optional - List of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none. + promoteResourceAttributes defines the list of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none. + Cannot be defined when `promoteAllResourceAttributes` is true. + promoteScopeMetadata : bool, default is Undefined, optional + promoteScopeMetadata controls whether to promote OpenTelemetry scope metadata (i.e. name, version, schema URL, and attributes) to metric labels. + As per the OpenTelemetry specification, the aforementioned scope metadata should be identifying, i.e. made into metric labels. + It requires Prometheus >= v3.6.0. translationStrategy : str, default is Undefined, optional - Configures how the OTLP receiver endpoint translates the incoming metrics. + translationStrategy defines how the OTLP receiver endpoint translates the incoming metrics. It requires Prometheus >= v3.0.0. """ + convertHistogramsToNHCB?: bool + ignoreResourceAttributes?: [str] keepIdentifyingResourceAttributes?: bool + promoteAllResourceAttributes?: bool promoteResourceAttributes?: [str] - translationStrategy?: "NoUTF8EscapingWithSuffixes" | "UnderscoreEscapingWithSuffixes" + promoteScopeMetadata?: bool + translationStrategy?: "NoUTF8EscapingWithSuffixes" | "UnderscoreEscapingWithSuffixes" | "NoTranslation" | "UnderscoreEscapingWithoutSuffixes" check: + len(ignoreResourceAttributes) >= 1 if ignoreResourceAttributes + all ignoreResourceAttributes in ignoreResourceAttributes {len(ignoreResourceAttributes) >= 1 if ignoreResourceAttributes not in [None, Undefined]} if ignoreResourceAttributes len(promoteResourceAttributes) >= 1 if promoteResourceAttributes all promoteResourceAttributes in promoteResourceAttributes {len(promoteResourceAttributes) >= 1 if promoteResourceAttributes not in [None, Undefined]} if promoteResourceAttributes schema MonitoringCoreosComV1alpha1PrometheusAgentSpecPersistentVolumeClaimRetentionPolicy: r""" - The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet. + persistentVolumeClaimRetentionPolicy defines the field controls if and how PVCs are deleted during the lifecycle of a StatefulSet. The default behavior is all PVCs are retained. This is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26. It requires enabling the StatefulSetAutoDeletePVC feature gate. @@ -4826,7 +5120,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecPersistentVolumeClaimRetent schema MonitoringCoreosComV1alpha1PrometheusAgentSpecPodMetadata: r""" - PodMetadata configures labels and annotations which are propagated to the Prometheus pods. + podMetadata defines labels and annotations which are propagated to the Prometheus pods. The following items are reserved and cannot be overridden: * "prometheus" label, set to the name of the Prometheus object. @@ -4841,22 +5135,22 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecPodMetadata: Attributes ---------- annotations : {str:str}, default is Undefined, optional - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. - More info: http://kubernetes.io/docs/user-guide/annotations + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ labels : {str:str}, default is Undefined, optional - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. - More info: http://kubernetes.io/docs/user-guide/labels + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ name : str, default is Undefined, optional - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. - More info: http://kubernetes.io/docs/user-guide/identifiers#names + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/ """ annotations?: {str:str} labels?: {str:str} @@ -4864,7 +5158,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecPodMetadata: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecPodMonitorNamespaceSelector: r""" - Namespaces to match for PodMonitors discovery. An empty label selector + podMonitorNamespaceSelector defines the namespaces to match for PodMonitors discovery. An empty label selector matches all namespaces. A null label selector (default value) matches the current namespace only. @@ -4906,7 +5200,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecPodMonitorNamespaceSelector schema MonitoringCoreosComV1alpha1PrometheusAgentSpecPodMonitorSelector: r""" - PodMonitors to be selected for target discovery. An empty label selector + podMonitorSelector defines the podMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -4956,7 +5250,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecPodMonitorSelectorMatchExpr schema MonitoringCoreosComV1alpha1PrometheusAgentSpecProbeNamespaceSelector: r""" - Namespaces to match for Probe discovery. An empty label + probeNamespaceSelector defines the namespaces to match for Probe discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only. @@ -4998,7 +5292,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecProbeNamespaceSelectorMatch schema MonitoringCoreosComV1alpha1PrometheusAgentSpecProbeSelector: r""" - Probes to be selected for target discovery. An empty label selector + probeSelector defines the probes to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -5060,27 +5354,26 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0: basicAuth : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0BasicAuth, default is Undefined, optional basic auth bearerToken : str, default is Undefined, optional + bearerToken is deprecated: this will be removed in a future release. *Warning: this field shouldn't be used because the token value appears in clear-text. Prefer using `authorization`.* - - Deprecated: this will be removed in a future release. bearerTokenFile : str, default is Undefined, optional - File from which to read bearer token for the URL. + bearerTokenFile defines the file from which to read bearer token for the URL. Deprecated: this will be removed in a future release. Prefer using `authorization`. enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. - It requires Prometheus >= v2.26.0. + It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. headers : {str:str}, default is Undefined, optional - Custom HTTP headers to be sent along with each remote write request. + headers defines the custom HTTP headers to be sent along with each remote write request. Be aware that headers that are set by Prometheus itself can't be overwritten. - It requires Prometheus >= v2.25.0. + It requires Prometheus >= v2.25.0 or Thanos >= v0.24.0. messageVersion : str, default is Undefined, optional - The Remote Write message's version to use when writing to the endpoint. + messageVersion defines the Remote Write message's version to use when writing to the endpoint. `Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0. `Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0. @@ -5091,56 +5384,71 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0: Before setting this field, consult with your remote storage provider what message version it supports. - It requires Prometheus >= v2.54.0. + It requires Prometheus >= v2.54.0 or Thanos >= v0.37.0. metadataConfig : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0MetadataConfig, default is Undefined, optional metadata config name : str, default is Undefined, optional - The name of the remote write queue, it must be unique if specified. The + name of the remote write queue, it must be unique if specified. The name is used in metrics and logging in order to differentiate queues. - It requires Prometheus >= v2.15.0. + It requires Prometheus >= v2.15.0 or Thanos >= 0.24.0. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. queueConfig : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0QueueConfig, default is Undefined, optional queue config remoteTimeout : str, default is Undefined, optional - Timeout for requests to the remote write endpoint. + remoteTimeout defines the timeout for requests to the remote write endpoint. + roundRobinDNS : bool, default is Undefined, optional + roundRobinDNS controls the DNS resolution behavior for remote-write connections. + When enabled: + - The remote-write mechanism will resolve the hostname via DNS. + - It will randomly select one of the resolved IP addresses and connect to it. + + When disabled (default behavior): + - The Go standard library will handle hostname resolution. + - It will attempt connections to each resolved IP address sequentially. + + Note: The connection timeout applies to the entire resolution and connection process. + + If disabled, the timeout is distributed across all connection attempts. + + It requires Prometheus >= v3.1.0 or Thanos >= v0.38.0. sendExemplars : bool, default is Undefined, optional - Enables sending of exemplars over remote write. Note that + sendExemplars enables sending of exemplars over remote write. Note that exemplar-storage itself must be enabled using the `spec.enableFeatures` option for exemplars to be scraped in the first place. - It requires Prometheus >= v2.27.0. + It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0. sendNativeHistograms : bool, default is Undefined, optional - Enables sending of native histograms, also known as sparse histograms + sendNativeHistograms enables sending of native histograms, also known as sparse histograms over remote write. - It requires Prometheus >= v2.40.0. + It requires Prometheus >= v2.40.0 or Thanos >= v0.30.0. sigv4 : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Sigv4, default is Undefined, optional sigv4 tlsConfig : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfig, default is Undefined, optional tls config url : str, default is Undefined, required - The URL of the endpoint to send samples to. + url defines the URL of the endpoint to send samples to. writeRelabelConfigs : [MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0WriteRelabelConfigsItems0], default is Undefined, optional - The list of remote write relabel configurations. + writeRelabelConfigs defines the list of remote write relabel configurations. """ authorization?: MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Authorization azureAd?: MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AzureAd @@ -5160,6 +5468,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0: proxyUrl?: str queueConfig?: MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0QueueConfig remoteTimeout?: str + roundRobinDNS?: bool sendExemplars?: bool sendNativeHistograms?: bool sigv4?: MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Sigv4 @@ -5169,15 +5478,15 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0: writeRelabelConfigs?: [MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0WriteRelabelConfigsItems0] check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(remoteTimeout), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if remoteTimeout len(url) >= 1 schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Authorization: r""" - Authorization section for the URL. + authorization section for the URL. - It requires Prometheus >= v2.26.0. + It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. Cannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`. @@ -5186,9 +5495,9 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Authorizat credentials : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AuthorizationCredentials, default is Undefined, optional credentials credentialsFile : str, default is Undefined, optional - File to read a secret from, mutually exclusive with `credentials`. + credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -5200,7 +5509,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Authorizat schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -5222,16 +5531,16 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Authorizat schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AzureAd: r""" - AzureAD for the URL. + azureAd for the URL. - It requires Prometheus >= v2.45.0. + It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0. Cannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`. Attributes ---------- cloud : str, default is Undefined, optional - The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'. + cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'. managedIdentity : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AzureAdManagedIdentity, default is Undefined, optional managed identity oauth : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AzureAdOauth, default is Undefined, optional @@ -5246,31 +5555,36 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AzureAd: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AzureAdManagedIdentity: r""" - ManagedIdentity defines the Azure User-assigned Managed identity. + managedIdentity defines the Azure User-assigned Managed identity. Cannot be set at the same time as `oauth` or `sdk`. Attributes ---------- - clientId : str, default is Undefined, required - The client id + clientId : str, default is Undefined, optional + clientId defines the Azure User-assigned Managed identity. + + For Prometheus >= 3.5.0 and Thanos >= 0.40.0, this field is allowed to be empty to support system-assigned managed identities. """ - clientId: str + clientId?: str + + check: + len(clientId) >= 1 if clientId schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AzureAdOauth: r""" - OAuth defines the oauth config that is being used to authenticate. + oauth defines the oauth config that is being used to authenticate. Cannot be set at the same time as `managedIdentity` or `sdk`. - It requires Prometheus >= v2.48.0. + It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0. Attributes ---------- clientId : str, default is Undefined, required - `clientID` is the clientId of the Azure Active Directory application that is being used to authenticate. + clientId defines the clientId of the Azure Active Directory application that is being used to authenticate. clientSecret : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AzureAdOauthClientSecret, default is Undefined, required client secret tenantId : str, default is Undefined, required - `tenantId` is the tenant ID of the Azure Active Directory application that is being used to authenticate. + tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate. """ clientId: str @@ -5285,7 +5599,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AzureAdOau schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AzureAdOauthClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate. + clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate. Attributes ---------- @@ -5307,16 +5621,16 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AzureAdOau schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AzureAdSdk: r""" - SDK defines the Azure SDK config that is being used to authenticate. + sdk defines the Azure SDK config that is being used to authenticate. See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication Cannot be set at the same time as `oauth` or `managedIdentity`. - It requires Prometheus >= 2.52.0. + It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0. Attributes ---------- tenantId : str, default is Undefined, optional - `tenantId` is the tenant ID of the azure active directory application that is being used to authenticate. + tenantId defines the tenant ID of the azure active directory application that is being used to authenticate. """ tenantId?: str @@ -5325,7 +5639,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0AzureAdSdk schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0BasicAuth: r""" - BasicAuth configuration for the URL. + basicAuth configuration for the URL. Cannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`. @@ -5341,7 +5655,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0BasicAuth: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -5364,7 +5678,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0BasicAuthP schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -5387,26 +5701,35 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0BasicAuthU schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0MetadataConfig: r""" - MetadataConfig configures the sending of series metadata to the remote storage. + metadataConfig defines how to send a series metadata to the remote storage. + + When the field is empty, **no metadata** is sent. But when the field is + null, metadata is sent. Attributes ---------- + maxSamplesPerSend : int, default is Undefined, optional + maxSamplesPerSend defines the maximum number of metadata samples per send. + + It requires Prometheus >= v2.29.0. send : bool, default is Undefined, optional - Defines whether metric metadata is sent to the remote storage or not. + send defines whether metric metadata is sent to the remote storage or not. sendInterval : str, default is Undefined, optional - Defines how frequently metric metadata is sent to the remote storage. + sendInterval defines how frequently metric metadata is sent to the remote storage. """ + maxSamplesPerSend?: int send?: bool sendInterval?: str check: + maxSamplesPerSend >= -1 if maxSamplesPerSend not in [None, Undefined] _regex_match(str(sendInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if sendInterval schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2: r""" - OAuth2 configuration for the URL. + oauth2 configuration for the URL. - It requires Prometheus >= v2.27.0. + It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0. Cannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`. @@ -5417,31 +5740,31 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2: clientSecret : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2ClientID @@ -5457,12 +5780,12 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -5477,7 +5800,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2Clie schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5499,7 +5822,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2Clie schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5521,7 +5844,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2Clie schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -5566,7 +5889,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2Prox schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -5576,19 +5899,19 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSC cert : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSConfigCert @@ -5600,7 +5923,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -5614,7 +5937,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5636,7 +5959,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5658,7 +5981,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -5672,7 +5995,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5694,7 +6017,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5716,7 +6039,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -5760,35 +6083,35 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0ProxyConne schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0QueueConfig: r""" - QueueConfig allows tuning of the remote write queue parameters. + queueConfig allows tuning of the remote write queue parameters. Attributes ---------- batchSendDeadline : str, default is Undefined, optional - BatchSendDeadline is the maximum time a sample will wait in buffer. + batchSendDeadline defines the maximum time a sample will wait in buffer. capacity : int, default is Undefined, optional - Capacity is the number of samples to buffer per shard before we start + capacity defines the number of samples to buffer per shard before we start dropping them. maxBackoff : str, default is Undefined, optional - MaxBackoff is the maximum retry delay. + maxBackoff defines the maximum retry delay. maxRetries : int, default is Undefined, optional - MaxRetries is the maximum number of times to retry a batch on recoverable errors. + maxRetries defines the maximum number of times to retry a batch on recoverable errors. maxSamplesPerSend : int, default is Undefined, optional - MaxSamplesPerSend is the maximum number of samples per send. + maxSamplesPerSend defines the maximum number of samples per send. maxShards : int, default is Undefined, optional - MaxShards is the maximum number of shards, i.e. amount of concurrency. + maxShards defines the maximum number of shards, i.e. amount of concurrency. minBackoff : str, default is Undefined, optional - MinBackoff is the initial retry delay. Gets doubled for every retry. + minBackoff defines the initial retry delay. Gets doubled for every retry. minShards : int, default is Undefined, optional - MinShards is the minimum number of shards, i.e. amount of concurrency. + minShards defines the minimum number of shards, i.e. amount of concurrency. retryOnRateLimit : bool, default is Undefined, optional - Retry upon receiving a 429 status code from the remote-write storage. + retryOnRateLimit defines the retry upon receiving a 429 status code from the remote-write storage. This is an *experimental feature*, it may change in any upcoming release in a breaking way. sampleAgeLimit : str, default is Undefined, optional - SampleAgeLimit drops samples older than the limit. - It requires Prometheus >= v2.50.0. + sampleAgeLimit drops samples older than the limit. + It requires Prometheus >= v2.50.0 or Thanos >= v0.32.0. """ batchSendDeadline?: str capacity?: int @@ -5809,9 +6132,9 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0QueueConfi schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Sigv4: r""" - Sigv4 allows to configures AWS's Signature Verification 4 for the URL. + sigv4 defines the AWS's Signature Verification 4 for the URL. - It requires Prometheus >= v2.26.0. + It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0. Cannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`. @@ -5820,23 +6143,27 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Sigv4: accessKey : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Sigv4AccessKey, default is Undefined, optional access key profile : str, default is Undefined, optional - Profile is the named AWS profile used to authenticate. + profile defines the named AWS profile used to authenticate. region : str, default is Undefined, optional - Region is the AWS region. If blank, the region from the default credentials chain used. + region defines the AWS region. If blank, the region from the default credentials chain used. roleArn : str, default is Undefined, optional - RoleArn is the named AWS profile used to authenticate. + roleArn defines the named AWS profile used to authenticate. secretKey : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Sigv4SecretKey, default is Undefined, optional secret key + useFIPSSTSEndpoint : bool, default is Undefined, optional + useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint. + It requires Prometheus >= v2.54.0. """ accessKey?: MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Sigv4AccessKey profile?: str region?: str roleArn?: str secretKey?: MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Sigv4SecretKey + useFIPSSTSEndpoint?: bool schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Sigv4AccessKey: r""" - AccessKey is the AWS API key. If not specified, the environment variable + accessKey defines the AWS API key. If not specified, the environment variable `AWS_ACCESS_KEY_ID` is used. Attributes @@ -5859,7 +6186,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Sigv4Acces schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Sigv4SecretKey: r""" - SecretKey is the AWS API secret. If not specified, the environment + secretKey defines the AWS API secret. If not specified, the environment variable `AWS_SECRET_ACCESS_KEY` is used. Attributes @@ -5882,34 +6209,34 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0Sigv4Secre schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfig: r""" - TLS Config to use for the URL. + tlsConfig to use for the URL. Attributes ---------- ca : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigCa, default is Undefined, optional ca caFile : str, default is Undefined, optional - Path to the CA cert in the Prometheus container to use for the targets. + caFile defines the path to the CA cert in the Prometheus container to use for the targets. cert : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the client cert file in the Prometheus container for the targets. + certFile defines the path to the client cert file in the Prometheus container for the targets. insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keyFile : str, default is Undefined, optional - Path to the client key file in the Prometheus container for the targets. + keyFile defines the path to the client key file in the Prometheus container for the targets. keySecret : MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigCa caFile?: str @@ -5924,7 +6251,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfig: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -5938,7 +6265,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5960,7 +6287,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5982,7 +6309,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -5996,7 +6323,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6018,7 +6345,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6040,7 +6367,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -6070,31 +6397,31 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0WriteRelab Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -6109,12 +6436,9 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRemoteWriteItems0WriteRelab sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1alpha1PrometheusAgentSpecResources: r""" - Defines the resources requests and limits of the 'prometheus' container. + resources defines the resources requests and limits of the 'prometheus' container. Attributes ---------- @@ -6122,7 +6446,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecResources: Claims lists the names of resources, defined in spec.resourceClaims, that are used by this container. - This is an alpha field and requires enabling the + This field depends on the DynamicResourceAllocation feature gate. This field is immutable. It can only be set for containers. @@ -6164,12 +6488,12 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecResourcesClaimsItems0: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecRuntime: r""" - RuntimeConfig configures the values for the Prometheus process behavior + runtime defines the values for the Prometheus process behavior Attributes ---------- goGC : int, default is Undefined, optional - The Go garbage collection target percentage. Lowering this number may increase the CPU usage. + goGC defines the Go garbage collection target percentage. Lowering this number may increase the CPU usage. See: https://tip.golang.org/doc/gc-guide#GOGC """ goGC?: int @@ -6188,17 +6512,17 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0: authorization : MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0Authorization, default is Undefined, optional authorization default : bool, default is Undefined, optional - Default indicates that the scrape applies to all scrape objects that + default defines that the scrape applies to all scrape objects that don't configure an explicit scrape class name. Only one scrape class can be set as the default. fallbackScrapeProtocol : str, default is Undefined, optional - The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. + fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It will only apply if the scrape resource doesn't specify any FallbackScrapeProtocol It requires Prometheus >= v3.0.0. metricRelabelings : [MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0MetricRelabelingsItems0], default is Undefined, optional - MetricRelabelings configures the relabeling rules to apply to all samples before ingestion. + metricRelabelings defines the relabeling rules to apply to all samples before ingestion. The Operator adds the scrape class metric relabelings defined here. Then the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs. @@ -6206,9 +6530,9 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0: More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs name : str, default is Undefined, required - Name of the scrape class. + name of the scrape class. relabelings : [MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0RelabelingsItems0], default is Undefined, optional - Relabelings configures the relabeling rules to apply to all scrape targets. + relabelings defines the relabeling rules to apply to all scrape targets. The Operator automatically adds relabelings for a few standard Kubernetes fields like `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`. @@ -6234,14 +6558,14 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0AttachMetadata: r""" - AttachMetadata configures additional metadata to the discovered targets. + attachMetadata defines additional metadata to the discovered targets. When the scrape object defines its own configuration, it takes precedence over the scrape class configuration. Attributes ---------- node : bool, default is Undefined, optional - When set to true, Prometheus attaches node metadata to the discovered + node when set to true, Prometheus attaches node metadata to the discovered targets. The Prometheus service account must have the `list` and `watch` @@ -6251,7 +6575,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0AttachMe schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0Authorization: r""" - Authorization section for the ScrapeClass. + authorization section for the ScrapeClass. It will only apply if the scrape resource doesn't specify any Authorization. Attributes @@ -6259,9 +6583,9 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0Authoriz credentials : MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0AuthorizationCredentials, default is Undefined, optional credentials credentialsFile : str, default is Undefined, optional - File to read a secret from, mutually exclusive with `credentials`. + credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`. $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -6273,7 +6597,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0Authoriz schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -6303,31 +6627,31 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0MetricRe Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -6342,9 +6666,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0MetricRe sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0RelabelingsItems0: r""" RelabelConfig allows dynamic rewriting of the label set for targets, alerts, @@ -6355,31 +6676,31 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0Relabeli Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -6394,12 +6715,9 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0Relabeli sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfig: r""" - TLSConfig defines the TLS settings to use for the scrape. When the + tlsConfig defines the TLS settings to use for the scrape. When the scrape objects define their own CA, certificate and/or key, they take precedence over the corresponding scrape class fields. @@ -6410,27 +6728,27 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfi ca : MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfigCa, default is Undefined, optional ca caFile : str, default is Undefined, optional - Path to the CA cert in the Prometheus container to use for the targets. + caFile defines the path to the CA cert in the Prometheus container to use for the targets. cert : MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the client cert file in the Prometheus container for the targets. + certFile defines the path to the client cert file in the Prometheus container for the targets. insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keyFile : str, default is Undefined, optional - Path to the client key file in the Prometheus container for the targets. + keyFile defines the path to the client key file in the Prometheus container for the targets. keySecret : MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfigCa caFile?: str @@ -6445,7 +6763,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfi schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -6459,7 +6777,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfi schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6481,7 +6799,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfi schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6503,7 +6821,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfi schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -6517,7 +6835,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfi schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6539,7 +6857,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfi schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6561,7 +6879,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfi schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -6583,7 +6901,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeClassesItems0TLSConfi schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeConfigNamespaceSelector: r""" - Namespaces to match for ScrapeConfig discovery. An empty label selector + scrapeConfigNamespaceSelector defines the namespaces to match for ScrapeConfig discovery. An empty label selector matches all namespaces. A null label selector matches the current namespace only. @@ -6627,7 +6945,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeConfigNamespaceSelect schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeConfigSelector: r""" - ScrapeConfigs to be selected for target discovery. An empty label + scrapeConfigSelector defines the scrapeConfigs to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -6679,7 +6997,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecScrapeConfigSelectorMatchEx schema MonitoringCoreosComV1alpha1PrometheusAgentSpecSecurityContext: r""" - SecurityContext holds pod-level security attributes and common container settings. + securityContext holds pod-level security attributes and common container settings. This defaults to the default PodSecurityContext. Attributes @@ -6909,7 +7227,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecSecurityContextWindowsOptio schema MonitoringCoreosComV1alpha1PrometheusAgentSpecServiceMonitorNamespaceSelector: r""" - Namespaces to match for ServicedMonitors discovery. An empty label selector + serviceMonitorNamespaceSelector defines the namespaces to match for ServicedMonitors discovery. An empty label selector matches all namespaces. A null label selector (default value) matches the current namespace only. @@ -6951,7 +7269,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecServiceMonitorNamespaceSele schema MonitoringCoreosComV1alpha1PrometheusAgentSpecServiceMonitorSelector: r""" - ServiceMonitors to be selected for target discovery. An empty label + serviceMonitorSelector defines the serviceMonitors to be selected for target discovery. An empty label selector matches all objects. A null label selector matches no objects. If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector` @@ -7001,12 +7319,12 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecServiceMonitorSelectorMatch schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorage: r""" - Storage defines the storage used by Prometheus. + storage defines the storage used by Prometheus. Attributes ---------- disableMountSubPath : bool, default is Undefined, optional - Deprecated: subPath usage will be removed in a future release. + disableMountSubPath deprecated: subPath usage will be removed in a future release. emptyDir : MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageEmptyDir, default is Undefined, optional empty dir ephemeral : MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageEphemeral, default is Undefined, optional @@ -7021,7 +7339,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorage: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageEmptyDir: r""" - EmptyDirVolumeSource to be used by the StatefulSet. + emptyDir to be used by the StatefulSet. If specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`. More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir @@ -7048,7 +7366,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageEmptyDir: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageEphemeral: r""" - EphemeralVolumeSource to be used by the StatefulSet. + ephemeral to be used by the StatefulSet. This is a beta field in k8s 1.21 and GA in 1.15. For lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate. More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes @@ -7123,15 +7441,13 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageEphemeralVolumeClaim volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, - it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass - will be applied to the claim but it's not allowed to reset this field to empty string once it is set. - If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass - will be set by the persistentvolume controller if it exists. + it can be changed after the claim is created. An empty string or nil value indicates that no + VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, + this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ - (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). volumeMode : str, default is Undefined, optional volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. @@ -7291,7 +7607,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageEphemeralVolumeClaim schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageVolumeClaimTemplate: r""" - Defines the PVC spec to be used by the Prometheus StatefulSets. + volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets. The easiest way to use a volume that cannot be automatically provisioned is to use a label selector alongside manually created PersistentVolumes. @@ -7323,27 +7639,27 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageVolumeClaimTemplate: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageVolumeClaimTemplateMetadata: r""" - EmbeddedMetadata contains metadata relevant to an EmbeddedResource. + metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource. Attributes ---------- annotations : {str:str}, default is Undefined, optional - Annotations is an unstructured key value map stored with a resource that may be + annotations defines an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. - More info: http://kubernetes.io/docs/user-guide/annotations + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/ labels : {str:str}, default is Undefined, optional - Map of string keys and values that can be used to organize and categorize + labels define the map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. - More info: http://kubernetes.io/docs/user-guide/labels + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ name : str, default is Undefined, optional - Name must be unique within a namespace. Is required when creating resources, although + name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. - More info: http://kubernetes.io/docs/user-guide/identifiers#names + More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/ """ annotations?: {str:str} labels?: {str:str} @@ -7351,7 +7667,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageVolumeClaimTemplateM schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageVolumeClaimTemplateSpec: r""" - Defines the desired characteristics of a volume requested by a pod author. + spec defines the specification of the characteristics of a volume requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims Attributes @@ -7374,15 +7690,13 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageVolumeClaimTemplateS volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, - it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass - will be applied to the claim but it's not allowed to reset this field to empty string once it is set. - If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass - will be set by the persistentvolume controller if it exists. + it can be changed after the claim is created. An empty string or nil value indicates that no + VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, + this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ - (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). volumeMode : str, default is Undefined, optional volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. @@ -7542,7 +7856,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageVolumeClaimTemplateS schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageVolumeClaimTemplateStatus: r""" - Deprecated: this field is never set. + status is deprecated: this field is never set. Attributes ---------- @@ -7616,7 +7930,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageVolumeClaimTemplateS currentVolumeAttributesClassName : str, default is Undefined, optional currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using. When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim - This is a beta field and requires enabling VolumeAttributesClass feature (off by default). modifyVolumeStatus : MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageVolumeClaimTemplateStatusModifyVolumeStatus, default is Undefined, optional modify volume status phase : str, default is Undefined, optional @@ -7671,7 +7984,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecStorageVolumeClaimTemplateS r""" ModifyVolumeStatus represents the status object of ControllerModifyVolume operation. When this is unset, there is no ModifyVolume operation being attempted. - This is a beta field and requires enabling VolumeAttributesClass feature (off by default). Attributes ---------- @@ -7733,7 +8045,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTopologySpreadConstraintsIt Attributes ---------- additionalLabelSelectors : str, default is Undefined, optional - Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint. + additionalLabelSelectors Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint. labelSelector : MonitoringCoreosComV1alpha1PrometheusAgentSpecTopologySpreadConstraintsItems0LabelSelector, default is Undefined, optional label selector matchLabelKeys : [str], default is Undefined, optional @@ -7792,7 +8104,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTopologySpreadConstraintsIt - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. If this value is nil, the behavior is equivalent to the Honor policy. - This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. nodeTaintsPolicy : str, default is Undefined, optional NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: @@ -7801,7 +8112,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTopologySpreadConstraintsIt - Ignore: node taints are ignored. All nodes are included. If this value is nil, the behavior is equivalent to the Ignore policy. - This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag. topologyKey : str, default is Undefined, required TopologyKey is the key of node labels. Nodes that have a label with this key and identical values are considered to be in the same topology. @@ -7889,7 +8199,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTopologySpreadConstraintsIt schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfig: r""" - TracingConfig configures tracing in Prometheus. + tracingConfig defines tracing in Prometheus. This is an *experimental feature*, it may change in any upcoming release in a breaking way. @@ -7897,19 +8207,19 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfig: Attributes ---------- clientType : str, default is Undefined, optional - Client used to export the traces. Supported values are `http` or `grpc`. + clientType defines the client used to export the traces. Supported values are `http` or `grpc`. compression : str, default is Undefined, optional - Compression key for supported compression types. The only supported value is `gzip`. + compression key for supported compression types. The only supported value is `gzip`. endpoint : str, default is Undefined, required - Endpoint to send the traces to. Should be provided in format :. + endpoint to send the traces to. Should be provided in format :. headers : {str:str}, default is Undefined, optional - Key-value pairs to be used as headers associated with gRPC or HTTP requests. + headers defines the key-value pairs to be used as headers associated with gRPC or HTTP requests. insecure : bool, default is Undefined, optional - If disabled, the client will use a secure connection. + insecure if disabled, the client will use a secure connection. samplingFraction : int | str, default is Undefined, optional - Sets the probability a given trace will be sampled. Must be a float from 0 through 1. + samplingFraction defines the probability a given trace will be sampled. Must be a float from 0 through 1. timeout : str, default is Undefined, optional - Maximum time the exporter will wait for each batch export. + timeout defines the maximum time the exporter will wait for each batch export. tlsConfig : MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfig, default is Undefined, optional tls config """ @@ -7930,34 +8240,34 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfig: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfig: r""" - TLS Config to use when sending traces. + tlsConfig to use when sending traces. Attributes ---------- ca : MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCa, default is Undefined, optional ca caFile : str, default is Undefined, optional - Path to the CA cert in the Prometheus container to use for the targets. + caFile defines the path to the CA cert in the Prometheus container to use for the targets. cert : MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the client cert file in the Prometheus container for the targets. + certFile defines the path to the client cert file in the Prometheus container for the targets. insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keyFile : str, default is Undefined, optional - Path to the client key file in the Prometheus container for the targets. + keyFile defines the path to the client key file in the Prometheus container for the targets. keySecret : MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCa caFile?: str @@ -7972,7 +8282,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfig: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -7986,7 +8296,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCa: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8008,7 +8318,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCaCon schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8030,7 +8340,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCaSec schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -8044,7 +8354,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCert: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8066,7 +8376,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCertC schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8088,7 +8398,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigCertS schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -8110,13 +8420,13 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTracingConfigTLSConfigKeySe schema MonitoringCoreosComV1alpha1PrometheusAgentSpecTsdb: r""" - Defines the runtime reloadable configuration of the timeseries database(TSDB). + tsdb defines the runtime reloadable configuration of the timeseries database(TSDB). It requires Prometheus >= v2.39.0 or PrometheusAgent >= v2.54.0. Attributes ---------- outOfOrderTimeWindow : str, default is Undefined, optional - Configures how old an out-of-order/out-of-bounds sample can be with + outOfOrderTimeWindow defines how old an out-of-order/out-of-bounds sample can be with respect to the TSDB max time. An out-of-order/out-of-bounds sample is ingested into the TSDB as long as @@ -8788,15 +9098,13 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0EphemeralVolum volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim. If specified, the CSI driver will create or update the volume with the attributes defined in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName, - it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass - will be applied to the claim but it's not allowed to reset this field to empty string once it is set. - If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass - will be set by the persistentvolume controller if it exists. + it can be changed after the claim is created. An empty string or nil value indicates that no + VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state, + this field can be reset to its previous value (including nil) to cancel the modification. If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource exists. More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/ - (Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default). volumeMode : str, default is Undefined, optional volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec. @@ -9108,13 +9416,11 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0Glusterfs: r""" glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. - More info: https://examples.k8s.io/volumes/glusterfs/README.md Attributes ---------- endpoints : str, default is Undefined, required endpoints is the endpoint name that details Glusterfs topology. - More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod path : str, default is Undefined, required path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod @@ -9166,7 +9472,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0Image: The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). - Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath). + Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33. The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type. Attributes @@ -9192,7 +9498,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0Iscsi: r""" iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. - More info: https://examples.k8s.io/volumes/iscsi/README.md + More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi Attributes ---------- @@ -9372,6 +9678,8 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourc config map downwardAPI : MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourcesItems0DownwardAPI, default is Undefined, optional downward API + podCertificate : MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourcesItems0PodCertificate, default is Undefined, optional + pod certificate secret : MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourcesItems0Secret, default is Undefined, optional secret serviceAccountToken : MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourcesItems0ServiceAccountToken, default is Undefined, optional @@ -9380,6 +9688,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourc clusterTrustBundle?: MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourcesItems0ClusterTrustBundle configMap?: MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourcesItems0ConfigMap downwardAPI?: MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourcesItems0DownwardAPI + podCertificate?: MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourcesItems0PodCertificate secret?: MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourcesItems0Secret serviceAccountToken?: MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourcesItems0ServiceAccountToken @@ -9594,6 +9903,105 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourc check: _regex_match(str(divisor), r"^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$") if divisor +schema MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourcesItems0PodCertificate: + r""" + Projects an auto-rotating credential bundle (private key and certificate + chain) that the pod can use either as a TLS client or server. + + Kubelet generates a private key and uses it to send a + PodCertificateRequest to the named signer. Once the signer approves the + request and issues a certificate chain, Kubelet writes the key and + certificate chain to the pod filesystem. The pod does not start until + certificates have been issued for each podCertificate projected volume + source in its spec. + + Kubelet will begin trying to rotate the certificate at the time indicated + by the signer using the PodCertificateRequest.Status.BeginRefreshAt + timestamp. + + Kubelet can write a single file, indicated by the credentialBundlePath + field, or separate files, indicated by the keyPath and + certificateChainPath fields. + + The credential bundle is a single file in PEM format. The first PEM + entry is the private key (in PKCS#8 format), and the remaining PEM + entries are the certificate chain issued by the signer (typically, + signers will return their certificate chain in leaf-to-root order). + + Prefer using the credential bundle format, since your application code + can read it atomically. If you use keyPath and certificateChainPath, + your application must make two separate file reads. If these coincide + with a certificate rotation, it is possible that the private key and leaf + certificate you read may not correspond to each other. Your application + will need to check for this condition, and re-read until they are + consistent. + + The named signer controls chooses the format of the certificate it + issues; consult the signer implementation's documentation to learn how to + use the certificates it issues. + + Attributes + ---------- + certificateChainPath : str, default is Undefined, optional + Write the certificate chain at this path in the projected volume. + + Most applications should use credentialBundlePath. When using keyPath + and certificateChainPath, your application needs to check that the key + and leaf certificate are consistent, because it is possible to read the + files mid-rotation. + credentialBundlePath : str, default is Undefined, optional + Write the credential bundle at this path in the projected volume. + + The credential bundle is a single file that contains multiple PEM blocks. + The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private + key. + + The remaining blocks are CERTIFICATE blocks, containing the issued + certificate chain from the signer (leaf and any intermediates). + + Using credentialBundlePath lets your Pod's application code make a single + atomic read that retrieves a consistent key and certificate chain. If you + project them to separate files, your application code will need to + additionally check that the leaf certificate was issued to the key. + keyPath : str, default is Undefined, optional + Write the key at this path in the projected volume. + + Most applications should use credentialBundlePath. When using keyPath + and certificateChainPath, your application needs to check that the key + and leaf certificate are consistent, because it is possible to read the + files mid-rotation. + keyType : str, default is Undefined, required + The type of keypair Kubelet will generate for the pod. + + Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384", + "ECDSAP521", and "ED25519". + maxExpirationSeconds : int, default is Undefined, optional + maxExpirationSeconds is the maximum lifetime permitted for the + certificate. + + Kubelet copies this value verbatim into the PodCertificateRequests it + generates for this projection. + + If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver + will reject values shorter than 3600 (1 hour). The maximum allowable + value is 7862400 (91 days). + + The signer implementation is then free to issue a certificate with any + lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600 + seconds (1 hour). This constraint is enforced by kube-apiserver. + `kubernetes.io` signers will never issue certificates with a lifetime + longer than 24 hours. + signerName : str, default is Undefined, required + Kubelet's generated CSRs will be addressed to this signer. + """ + certificateChainPath?: str + credentialBundlePath?: str + keyPath?: str + keyType: str + + maxExpirationSeconds?: int + signerName: str + schema MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0ProjectedSourcesItems0Secret: r""" secret information about the secret data to project @@ -9711,7 +10119,6 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0Rbd: r""" rbd represents a Rados Block Device mount on the host that shares a pod's lifetime. Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. - More info: https://examples.k8s.io/volumes/rbd/README.md Attributes ---------- @@ -9973,17 +10380,17 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecVolumesItems0VsphereVolume: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWeb: r""" - Defines the configuration of the Prometheus web server. + web defines the configuration of the Prometheus web server. Attributes ---------- httpConfig : MonitoringCoreosComV1alpha1PrometheusAgentSpecWebHTTPConfig, default is Undefined, optional http config maxConnections : int, default is Undefined, optional - Defines the maximum number of simultaneous connections + maxConnections defines the maximum number of simultaneous connections A zero value means that Prometheus doesn't accept any incoming connection. pageTitle : str, default is Undefined, optional - The prometheus web page title. + pageTitle defines the prometheus web page title. tlsConfig : MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfig, default is Undefined, optional tls config """ @@ -9997,14 +10404,14 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWeb: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebHTTPConfig: r""" - Defines HTTP parameters for web server. + httpConfig defines HTTP parameters for web server. Attributes ---------- headers : MonitoringCoreosComV1alpha1PrometheusAgentSpecWebHTTPConfigHeaders, default is Undefined, optional headers http2 : bool, default is Undefined, optional - Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. + http2 enable HTTP/2 support. Note that HTTP/2 is only supported with TLS. When TLSConfig is not configured, HTTP/2 will be disabled. Whenever the value of the field changes, a rolling update will be triggered. """ @@ -10013,30 +10420,30 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebHTTPConfig: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebHTTPConfigHeaders: r""" - List of headers that can be added to HTTP responses. + headers defines a list of headers that can be added to HTTP responses. Attributes ---------- contentSecurityPolicy : str, default is Undefined, optional - Set the Content-Security-Policy header to HTTP responses. + contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses. Unset if blank. strictTransportSecurity : str, default is Undefined, optional - Set the Strict-Transport-Security header to HTTP responses. + strictTransportSecurity defines the Strict-Transport-Security header to HTTP responses. Unset if blank. Please make sure that you use this with care as this header might force browsers to load Prometheus and the other applications hosted on the same domain and subdomains over HTTPS. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security xContentTypeOptions : str, default is Undefined, optional - Set the X-Content-Type-Options header to HTTP responses. + xContentTypeOptions defines the X-Content-Type-Options header to HTTP responses. Unset if blank. Accepted value is nosniff. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options xFrameOptions : str, default is Undefined, optional - Set the X-Frame-Options header to HTTP responses. + xFrameOptions defines the X-Frame-Options header to HTTP responses. Unset if blank. Accepted values are deny and sameorigin. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options xXSSProtection : str, default is Undefined, optional - Set the X-XSS-Protection header to all responses. + xXSSProtection defines the X-XSS-Protection header to all responses. Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection """ @@ -10048,44 +10455,44 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebHTTPConfigHeaders: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfig: r""" - Defines the TLS parameters for HTTPS. + tlsConfig defines the TLS parameters for HTTPS. Attributes ---------- cert : MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigCert, default is Undefined, optional cert certFile : str, default is Undefined, optional - Path to the TLS certificate file in the container for the web server. + certFile defines the path to the TLS certificate file in the container for the web server. Either `keySecret` or `keyFile` must be defined. It is mutually exclusive with `cert`. cipherSuites : [str], default is Undefined, optional - List of supported cipher suites for TLS versions up to TLS 1.2. + cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2. If not defined, the Go default cipher suites are used. Available cipher suites are documented in the Go documentation: https://golang.org/pkg/crypto/tls/#pkg-constants clientAuthType : str, default is Undefined, optional - The server policy for client TLS authentication. + clientAuthType defines the server policy for client TLS authentication. For more detail on clientAuth options: https://golang.org/pkg/crypto/tls/#ClientAuthType clientCAFile : str, default is Undefined, optional - Path to the CA certificate file for client certificate authentication to + clientCAFile defines the path to the CA certificate file for client certificate authentication to the server. It is mutually exclusive with `client_ca`. client_ca : MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigClientCa, default is Undefined, optional client ca curvePreferences : [str], default is Undefined, optional - Elliptic curves that will be used in an ECDHE handshake, in preference + curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference order. Available curves are documented in the Go documentation: https://golang.org/pkg/crypto/tls/#CurveID keyFile : str, default is Undefined, optional - Path to the TLS private key file in the container for the web server. + keyFile defines the path to the TLS private key file in the container for the web server. If defined, either `cert` or `certFile` must be defined. @@ -10093,11 +10500,11 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfig: keySecret : MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum TLS version that is acceptable. + maxVersion defines the Maximum TLS version that is acceptable. minVersion : str, default is Undefined, optional - Minimum TLS version that is acceptable. + minVersion defines the minimum TLS version that is acceptable. preferServerCipherSuites : bool, default is Undefined, optional - Controls whether the server selects the client's most preferred cipher + preferServerCipherSuites defines whether the server selects the client's most preferred cipher suite, or the server's most preferred cipher suite. If true then the server's preference, as expressed in @@ -10118,7 +10525,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfig: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigCert: r""" - Secret or ConfigMap containing the TLS certificate for the web server. + cert defines the Secret or ConfigMap containing the TLS certificate for the web server. Either `keySecret` or `keyFile` must be defined. @@ -10136,7 +10543,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigCert: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10158,7 +10565,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigCertConfigMap: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10180,7 +10587,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigCertSecret: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigClientCa: r""" - Secret or ConfigMap containing the CA certificate for client certificate + client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate authentication to the server. It is mutually exclusive with `clientCAFile`. @@ -10197,7 +10604,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigClientCa: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigClientCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10219,7 +10626,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigClientCaConfigM schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigClientCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10241,7 +10648,7 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigClientCaSecret: schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigKeySecret: r""" - Secret containing the TLS private key for the web server. + keySecret defines the secret containing the TLS private key for the web server. Either `cert` or `certFile` must be defined. @@ -10267,48 +10674,44 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentSpecWebTLSConfigKeySecret: schema MonitoringCoreosComV1alpha1PrometheusAgentStatus: r""" - Most recent observed status of the Prometheus cluster. Read-only. + status defines the most recent observed status of the Prometheus cluster. Read-only. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status Attributes ---------- - availableReplicas : int, default is Undefined, required - Total number of available pods (ready for at least minReadySeconds) + availableReplicas : int, default is Undefined, optional + availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this Prometheus deployment. conditions : [MonitoringCoreosComV1alpha1PrometheusAgentStatusConditionsItems0], default is Undefined, optional - The current state of the Prometheus deployment. - paused : bool, default is Undefined, required - Represents whether any actions on the underlying managed objects are + conditions defines the current state of the Prometheus deployment. + paused : bool, default is Undefined, optional + paused defines whether any actions on the underlying managed objects are being performed. Only delete actions will be performed. - replicas : int, default is Undefined, required - Total number of non-terminated pods targeted by this Prometheus deployment + replicas : int, default is Undefined, optional + replicas defines the total number of non-terminated pods targeted by this Prometheus deployment (their labels match the selector). selector : str, default is Undefined, optional - The selector used to match the pods targeted by this Prometheus resource. + selector used to match the pods targeted by this Prometheus resource. shardStatuses : [MonitoringCoreosComV1alpha1PrometheusAgentStatusShardStatusesItems0], default is Undefined, optional - The list has one entry per shard. Each entry provides a summary of the shard status. + shardStatuses defines the list has one entry per shard. Each entry provides a summary of the shard status. shards : int, default is Undefined, optional - Shards is the most recently observed number of shards. - unavailableReplicas : int, default is Undefined, required - Total number of unavailable pods targeted by this Prometheus deployment. - updatedReplicas : int, default is Undefined, required - Total number of non-terminated pods targeted by this Prometheus deployment + shards defines the most recently observed number of shards. + unavailableReplicas : int, default is Undefined, optional + unavailableReplicas defines the total number of unavailable pods targeted by this Prometheus deployment. + updatedReplicas : int, default is Undefined, optional + updatedReplicas defines the total number of non-terminated pods targeted by this Prometheus deployment that have the desired version spec. """ - availableReplicas: int - + availableReplicas?: int conditions?: [MonitoringCoreosComV1alpha1PrometheusAgentStatusConditionsItems0] - paused: bool - - replicas: int - + paused?: bool + replicas?: int selector?: str shardStatuses?: [MonitoringCoreosComV1alpha1PrometheusAgentStatusShardStatusesItems0] shards?: int - unavailableReplicas: int - - updatedReplicas: int + unavailableReplicas?: int + updatedReplicas?: int schema MonitoringCoreosComV1alpha1PrometheusAgentStatusConditionsItems0: r""" @@ -10320,19 +10723,19 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentStatusConditionsItems0: lastTransitionTime : str, default is Undefined, required lastTransitionTime is the time of the last update to the current status property. message : str, default is Undefined, optional - Human-readable message indicating details for the condition's last transition. + message defines human-readable message indicating details for the condition's last transition. observedGeneration : int, default is Undefined, optional - ObservedGeneration represents the .metadata.generation that the + observedGeneration defines the .metadata.generation that the condition was set based upon. For instance, if `.metadata.generation` is currently 12, but the `.status.conditions[].observedGeneration` is 9, the condition is out of date with respect to the current state of the instance. reason : str, default is Undefined, optional - Reason for the condition's last transition. + reason for the condition's last transition. status : str, default is Undefined, required - Status of the condition. + status of the condition. $type : str, default is Undefined, required - Type of the condition being reported. + type of the condition being reported. """ lastTransitionTime: str @@ -10354,16 +10757,16 @@ schema MonitoringCoreosComV1alpha1PrometheusAgentStatusShardStatusesItems0: Attributes ---------- availableReplicas : int, default is Undefined, required - Total number of available pods (ready for at least minReadySeconds) + availableReplicas defines the total number of available pods (ready for at least minReadySeconds) targeted by this shard. replicas : int, default is Undefined, required - Total number of pods targeted by this shard. + replicas defines the total number of pods targeted by this shard. shardID : str, default is Undefined, required - Identifier of the shard. + shardID defines the identifier of the shard. unavailableReplicas : int, default is Undefined, required - Total number of unavailable pods targeted by this shard. + unavailableReplicas defines the Total number of unavailable pods targeted by this shard. updatedReplicas : int, default is Undefined, required - Total number of non-terminated pods targeted by this shard + updatedReplicas defines the total number of non-terminated pods targeted by this shard that have the desired spec. """ availableReplicas: int diff --git a/docs/examples/src/charts/kube_prometheus_stack/api/v1alpha1/monitoring_coreos_com_v1alpha1_scrape_config.k b/docs/examples/src/charts/kube_prometheus_stack/api/v1alpha1/monitoring_coreos_com_v1alpha1_scrape_config.k index c26ce28f..25b932d1 100644 --- a/docs/examples/src/charts/kube_prometheus_stack/api/v1alpha1/monitoring_coreos_com_v1alpha1_scrape_config.k +++ b/docs/examples/src/charts/kube_prometheus_stack/api/v1alpha1/monitoring_coreos_com_v1alpha1_scrape_config.k @@ -23,6 +23,8 @@ schema ScrapeConfig: metadata spec : MonitoringCoreosComV1alpha1ScrapeConfigSpec, default is Undefined, required spec + status : MonitoringCoreosComV1alpha1ScrapeConfigStatus, default is Undefined, optional + status """ apiVersion: "monitoring.coreos.com/v1alpha1" = "monitoring.coreos.com/v1alpha1" @@ -31,164 +33,180 @@ schema ScrapeConfig: metadata?: v1.ObjectMeta spec: MonitoringCoreosComV1alpha1ScrapeConfigSpec + status?: MonitoringCoreosComV1alpha1ScrapeConfigStatus + schema MonitoringCoreosComV1alpha1ScrapeConfigSpec: r""" - ScrapeConfigSpec is a specification of the desired configuration for a scrape configuration. + spec defines the specification of ScrapeConfigSpec. Attributes ---------- authorization : MonitoringCoreosComV1alpha1ScrapeConfigSpecAuthorization, default is Undefined, optional authorization azureSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0], default is Undefined, optional - AzureSDConfigs defines a list of Azure service discovery configurations. + azureSDConfigs defines a list of Azure service discovery configurations. basicAuth : MonitoringCoreosComV1alpha1ScrapeConfigSpecBasicAuth, default is Undefined, optional basic auth consulSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0], default is Undefined, optional - ConsulSDConfigs defines a list of Consul service discovery configurations. + consulSDConfigs defines a list of Consul service discovery configurations. + convertClassicHistogramsToNHCB : bool, default is Undefined, optional + convertClassicHistogramsToNHCB defines whether to convert all scraped classic histograms into a native histogram with custom buckets. + It requires Prometheus >= v3.0.0. digitalOceanSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0], default is Undefined, optional - DigitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations. + digitalOceanSDConfigs defines a list of DigitalOcean service discovery configurations. dnsSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecDNSSDConfigsItems0], default is Undefined, optional - DNSSDConfigs defines a list of DNS service discovery configurations. + dnsSDConfigs defines a list of DNS service discovery configurations. dockerSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0], default is Undefined, optional - DockerSDConfigs defines a list of Docker service discovery configurations. + dockerSDConfigs defines a list of Docker service discovery configurations. dockerSwarmSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0], default is Undefined, optional - DockerswarmSDConfigs defines a list of Dockerswarm service discovery configurations. + dockerSwarmSDConfigs defines a list of Dockerswarm service discovery configurations. ec2SDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0], default is Undefined, optional - EC2SDConfigs defines a list of EC2 service discovery configurations. + ec2SDConfigs defines a list of EC2 service discovery configurations. enableCompression : bool, default is Undefined, optional - When false, Prometheus will request uncompressed response from the scraped target. + enableCompression when false, Prometheus will request uncompressed response from the scraped target. It requires Prometheus >= v2.49.0. If unset, Prometheus uses true by default. enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. eurekaSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0], default is Undefined, optional - EurekaSDConfigs defines a list of Eureka service discovery configurations. + eurekaSDConfigs defines a list of Eureka service discovery configurations. fallbackScrapeProtocol : str, default is Undefined, optional - The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. + fallbackScrapeProtocol defines the protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type. It requires Prometheus >= v3.0.0. fileSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecFileSDConfigsItems0], default is Undefined, optional - FileSDConfigs defines a list of file service discovery configurations. + fileSDConfigs defines a list of file service discovery configurations. gceSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecGceSDConfigsItems0], default is Undefined, optional - GCESDConfigs defines a list of GCE service discovery configurations. + gceSDConfigs defines a list of GCE service discovery configurations. hetznerSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0], default is Undefined, optional - HetznerSDConfigs defines a list of Hetzner service discovery configurations. + hetznerSDConfigs defines a list of Hetzner service discovery configurations. honorLabels : bool, default is Undefined, optional - HonorLabels chooses the metric's labels on collisions with target labels. + honorLabels defines when true the metric's labels when they collide + with the target's labels. honorTimestamps : bool, default is Undefined, optional - HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data. + honorTimestamps defines whether Prometheus preserves the timestamps + when exposed by the target. httpSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0], default is Undefined, optional - HTTPSDConfigs defines a list of HTTP service discovery configurations. + httpSDConfigs defines a list of HTTP service discovery configurations. ionosSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0], default is Undefined, optional - IonosSDConfigs defines a list of IONOS service discovery configurations. + ionosSDConfigs defines a list of IONOS service discovery configurations. jobName : str, default is Undefined, optional - The value of the `job` label assigned to the scraped metrics by default. + jobName defines the value of the `job` label assigned to the scraped metrics by default. The `job_name` field in the rendered scrape configuration is always controlled by the operator to prevent duplicate job names, which Prometheus does not allow. Instead the `job` label is set by means of relabeling configs. keepDroppedTargets : int, default is Undefined, optional - Per-scrape limit on the number of targets dropped by relabeling + keepDroppedTargets defines the per-scrape limit on the number of targets dropped by relabeling that will be kept in memory. 0 means no limit. It requires Prometheus >= v2.47.0. kubernetesSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0], default is Undefined, optional - KubernetesSDConfigs defines a list of Kubernetes service discovery configurations. + kubernetesSDConfigs defines a list of Kubernetes service discovery configurations. kumaSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0], default is Undefined, optional - KumaSDConfigs defines a list of Kuma service discovery configurations. + kumaSDConfigs defines a list of Kuma service discovery configurations. labelLimit : int, default is Undefined, optional - Per-scrape limit on number of labels that will be accepted for a sample. + labelLimit defines the per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. labelNameLengthLimit : int, default is Undefined, optional - Per-scrape limit on length of labels name that will be accepted for a sample. + labelNameLengthLimit defines the per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. labelValueLengthLimit : int, default is Undefined, optional - Per-scrape limit on length of labels value that will be accepted for a sample. + labelValueLengthLimit defines the per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. lightSailSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0], default is Undefined, optional - LightsailSDConfigs defines a list of Lightsail service discovery configurations. + lightSailSDConfigs defines a list of Lightsail service discovery configurations. linodeSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0], default is Undefined, optional - LinodeSDConfigs defines a list of Linode service discovery configurations. + linodeSDConfigs defines a list of Linode service discovery configurations. metricRelabelings : [MonitoringCoreosComV1alpha1ScrapeConfigSpecMetricRelabelingsItems0], default is Undefined, optional - MetricRelabelConfigs to apply to samples before ingestion. + metricRelabelings defines the metricRelabelings to apply to samples before ingestion. metricsPath : str, default is Undefined, optional - MetricsPath HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics). + metricsPath defines the HTTP path to scrape for metrics. If empty, Prometheus uses the default value (e.g. /metrics). + nameEscapingScheme : str, default is Undefined, optional + nameEscapingScheme defines the metric name escaping mode to request through content negotiation. + + It requires Prometheus >= v3.4.0. + nameValidationScheme : str, default is Undefined, optional + nameValidationScheme defines the validation scheme for metric and label names. + + It requires Prometheus >= v3.0.0. nativeHistogramBucketLimit : int, default is Undefined, optional - If there are more than this many buckets in a native histogram, + nativeHistogramBucketLimit defines ff there are more than this many buckets in a native histogram, buckets will be merged to stay within the limit. It requires Prometheus >= v2.45.0. nativeHistogramMinBucketFactor : int | str, default is Undefined, optional - If the growth factor of one bucket to the next is smaller than this, + nativeHistogramMinBucketFactor defines if the growth factor of one bucket to the next is smaller than this, buckets will be merged to increase the factor sufficiently. It requires Prometheus >= v2.50.0. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. nomadSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0], default is Undefined, optional - NomadSDConfigs defines a list of Nomad service discovery configurations. + nomadSDConfigs defines a list of Nomad service discovery configurations. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2, default is Undefined, optional oauth2 openstackSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0], default is Undefined, optional - OpenStackSDConfigs defines a list of OpenStack service discovery configurations. + openstackSDConfigs defines a list of OpenStack service discovery configurations. ovhcloudSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecOvhcloudSDConfigsItems0], default is Undefined, optional - OVHCloudSDConfigs defines a list of OVHcloud service discovery configurations. + ovhcloudSDConfigs defines a list of OVHcloud service discovery configurations. params : {str:[str]}, default is Undefined, optional - Optional HTTP URL parameters + params defines optional HTTP URL parameters proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. puppetDBSDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0], default is Undefined, optional - PuppetDBSDConfigs defines a list of PuppetDB service discovery configurations. + puppetDBSDConfigs defines a list of PuppetDB service discovery configurations. relabelings : [MonitoringCoreosComV1alpha1ScrapeConfigSpecRelabelingsItems0], default is Undefined, optional - RelabelConfigs defines how to rewrite the target's labels before scraping. + relabelings defines how to rewrite the target's labels before scraping. Prometheus Operator automatically adds relabelings for a few standard Kubernetes fields. The original scrape job's name is available via the `__tmp_prometheus_job_name` label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config sampleLimit : int, default is Undefined, optional - SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. + sampleLimit defines per-scrape limit on number of scraped samples that will be accepted. scalewaySDConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0], default is Undefined, optional - ScalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations. + scalewaySDConfigs defines a list of Scaleway instances and baremetal service discovery configurations. scheme : str, default is Undefined, optional - Configures the protocol scheme used for requests. - If empty, Prometheus uses HTTP by default. + scheme defines the protocol scheme used for requests. scrapeClass : str, default is Undefined, optional - The scrape class to apply. + scrapeClass defines the scrape class to apply. scrapeClassicHistograms : bool, default is Undefined, optional - Whether to scrape a classic histogram that is also exposed as a native histogram. + scrapeClassicHistograms defines whether to scrape a classic histogram that is also exposed as a native histogram. It requires Prometheus >= v2.45.0. + + Notice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration. scrapeInterval : str, default is Undefined, optional - ScrapeInterval is the interval between consecutive scrapes. + scrapeInterval defines the interval between consecutive scrapes. scrapeProtocols : [str], default is Undefined, optional - The protocols to negotiate during a scrape. It tells clients the + scrapeProtocols defines the protocols to negotiate during a scrape. It tells clients the protocols supported by Prometheus in order of preference (from most to least preferred). If unset, Prometheus uses its default value. It requires Prometheus >= v2.49.0. scrapeTimeout : str, default is Undefined, optional - ScrapeTimeout is the number of seconds to wait until a scrape request times out. + scrapeTimeout defines the number of seconds to wait until a scrape request times out. The value cannot be greater than the scrape interval otherwise the operator will reject the resource. staticConfigs : [MonitoringCoreosComV1alpha1ScrapeConfigSpecStaticConfigsItems0], default is Undefined, optional - StaticConfigs defines a list of static targets with a common label set. + staticConfigs defines a list of static targets with a common label set. targetLimit : int, default is Undefined, optional - TargetLimit defines a limit on the number of scraped targets that will be accepted. + targetLimit defines a limit on the number of scraped targets that will be accepted. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfig, default is Undefined, optional tls config trackTimestampsStaleness : bool, default is Undefined, optional - TrackTimestampsStaleness whether Prometheus tracks staleness of + trackTimestampsStaleness defines whether Prometheus tracks staleness of the metrics that have an explicit timestamp present in scraped data. Has no effect if `honorTimestamps` is false. It requires Prometheus >= v2.48.0. @@ -197,6 +215,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpec: azureSDConfigs?: [MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0] basicAuth?: MonitoringCoreosComV1alpha1ScrapeConfigSpecBasicAuth consulSDConfigs?: [MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0] + convertClassicHistogramsToNHCB?: bool digitalOceanSDConfigs?: [MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0] dnsSDConfigs?: [MonitoringCoreosComV1alpha1ScrapeConfigSpecDNSSDConfigsItems0] dockerSDConfigs?: [MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0] @@ -224,6 +243,8 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpec: linodeSDConfigs?: [MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0] metricRelabelings?: [MonitoringCoreosComV1alpha1ScrapeConfigSpecMetricRelabelingsItems0] metricsPath?: str + nameEscapingScheme?: "AllowUTF8" | "Underscores" | "Dots" | "Values" + nameValidationScheme?: "UTF8" | "Legacy" nativeHistogramBucketLimit?: int nativeHistogramMinBucketFactor?: int | str noProxy?: str @@ -239,7 +260,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpec: relabelings?: [MonitoringCoreosComV1alpha1ScrapeConfigSpecRelabelingsItems0] sampleLimit?: int scalewaySDConfigs?: [MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0] - scheme?: "HTTP" | "HTTPS" + scheme?: "http" | "https" | "HTTP" | "HTTPS" scrapeClass?: str scrapeClassicHistograms?: bool scrapeInterval?: str @@ -255,7 +276,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpec: len(metricRelabelings) >= 1 if metricRelabelings len(metricsPath) >= 1 if metricsPath _regex_match(str(nativeHistogramMinBucketFactor), r"^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$") if nativeHistogramMinBucketFactor - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(relabelings) >= 1 if relabelings len(scrapeClass) >= 1 if scrapeClass _regex_match(str(scrapeInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if scrapeInterval @@ -264,14 +285,14 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpec: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAuthorization: r""" - Authorization header to use on every scrape request. + authorization defines the header to use on every scrape request. Attributes ---------- credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecAuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -282,7 +303,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAuthorization: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -310,7 +331,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0: Attributes ---------- authenticationMethod : str, default is Undefined, optional - # The authentication method, either `OAuth` or `ManagedIdentity` or `SDK`. + authenticationMethod defines the authentication method, either `OAuth` or `ManagedIdentity` or `SDK`. See https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/overview SDK authentication method uses environment variables by default. See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication @@ -319,46 +340,47 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0: basicAuth : MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0BasicAuth, default is Undefined, optional basic auth clientID : str, default is Undefined, optional - Optional client ID. Only required with the OAuth authentication method. + clientID defines client ID. Only required with the OAuth authentication method. clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0ClientSecret, default is Undefined, optional client secret enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. environment : str, default is Undefined, optional - The Azure environment. + environment defines the Azure environment. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2, default is Undefined, optional oauth2 port : int, default is Undefined, optional - The port to scrape metrics from. If using the public IP address, this must + port defines the port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. resourceGroup : str, default is Undefined, optional - Optional resource group name. Limits discovery to this resource group. + resourceGroup defines resource group name. Limits discovery to this resource group. Requires Prometheus v2.35.0 and above subscriptionID : str, default is Undefined, required - The subscription ID. Always required. + subscriptionID defines subscription ID. Always required. tenantID : str, default is Undefined, optional - Optional tenant ID. Only required with the OAuth authentication method. + tenantID defines tenant ID. Only required with the OAuth authentication method. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfig, default is Undefined, optional tls config """ @@ -388,7 +410,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0: len(environment) >= 1 if environment port <= 65535 if port not in [None, Undefined] port >= 0 if port not in [None, Undefined] - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval len(resourceGroup) >= 1 if resourceGroup len(subscriptionID) >= 1 @@ -396,7 +418,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Authorization: r""" - Authorization header configuration to authenticate against the target HTTP endpoint. + authorization defines the authorization header configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `oAuth2`, or `basicAuth`. Attributes @@ -404,7 +426,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Authorizat credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -415,7 +437,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Authorizat schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -437,7 +459,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Authorizat schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0BasicAuth: r""" - BasicAuth information to authenticate against the target HTTP endpoint. + basicAuth defines the information to authenticate against the target HTTP endpoint. More info: https://prometheus.io/docs/operating/configuration/#endpoints Cannot be set at the same time as `authorization`, or `oAuth2`. @@ -453,7 +475,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0BasicAuth: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -476,7 +498,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0BasicAuthP schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -499,7 +521,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0BasicAuthU schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0ClientSecret: r""" - Optional client secret. Only required with the OAuth authentication method. + clientSecret defines client secret. Only required with the OAuth authentication method. Attributes ---------- @@ -521,8 +543,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0ClientSecr schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2: r""" - Optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. - Cannot be set at the same time as `authorization`, or `basicAuth`. + oauth2 defines the configuration to use on every scrape request. Attributes ---------- @@ -531,31 +552,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2: clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2ClientID @@ -571,12 +592,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -591,7 +612,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2Clie schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -613,7 +634,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2Clie schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -635,7 +656,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2Clie schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -680,7 +701,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2Prox schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -690,19 +711,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSC cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSConfigCert @@ -714,7 +735,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -728,7 +749,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -750,7 +771,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -772,7 +793,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -786,7 +807,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -808,7 +829,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -830,7 +851,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -874,7 +895,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0ProxyConne schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfig: r""" - TLS configuration applying to the target HTTP endpoint. + tlsConfig defies the TLS configuration applying to the target HTTP endpoint. Attributes ---------- @@ -883,19 +904,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfig: cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigCert @@ -907,7 +928,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfig: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -921,7 +942,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -943,7 +964,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -965,7 +986,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -979,7 +1000,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1001,7 +1022,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1023,7 +1044,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -1045,7 +1066,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecAzureSDConfigsItems0TLSConfigK schema MonitoringCoreosComV1alpha1ScrapeConfigSpecBasicAuth: r""" - BasicAuth information to use on every scrape request. + basicAuth defines information to use on every scrape request. Attributes ---------- @@ -1059,7 +1080,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecBasicAuth: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecBasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -1082,7 +1103,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecBasicAuthPassword: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecBasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -1111,71 +1132,68 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0: Attributes ---------- allowStale : bool, default is Undefined, optional - Allow stale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul. + allowStale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul. If unset, Prometheus uses its default value. authorization : MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Authorization, default is Undefined, optional authorization basicAuth : MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0BasicAuth, default is Undefined, optional basic auth datacenter : str, default is Undefined, optional - Consul Datacenter name, if not provided it will use the local Consul Agent Datacenter. + datacenter defines the consul Datacenter name, if not provided it will use the local Consul Agent Datacenter. enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. - If unset, Prometheus uses its default value. + enableHTTP2 defines whether to enable HTTP2. $filter : str, default is Undefined, optional - Filter expression used to filter the catalog results. + filter defines the filter expression used to filter the catalog results. See https://www.consul.io/api-docs/catalog#list-services It requires Prometheus >= 3.0.0. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. - If unset, Prometheus uses its default value. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. namespace : str, default is Undefined, optional - Namespaces are only supported in Consul Enterprise. + namespace are only supported in Consul Enterprise. It requires Prometheus >= 2.28.0. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. nodeMeta : {str:str}, default is Undefined, optional - Node metadata key/value pairs to filter nodes for a given service. + nodeMeta defines the node metadata key/value pairs to filter nodes for a given service. Starting with Consul 1.14, it is recommended to use `filter` with the `NodeMeta` selector instead. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2, default is Undefined, optional oauth2 partition : str, default is Undefined, optional - Admin Partitions are only supported in Consul Enterprise. + partition defines the admin Partitions are only supported in Consul Enterprise. pathPrefix : str, default is Undefined, optional - Prefix for URIs for when consul is behind an API gateway (reverse proxy). + pathPrefix defines the prefix for URIs for when consul is behind an API gateway (reverse proxy). It requires Prometheus >= 2.45.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - The time after which the provided names are refreshed. - On large setup it might be a good idea to increase this value because the catalog will change all the time. - If unset, Prometheus uses its default value. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. scheme : str, default is Undefined, optional - HTTP Scheme default "http" + scheme defines the HTTP Scheme. server : str, default is Undefined, required - Consul server address. A valid string consisting of a hostname or IP followed by an optional port number. + server defines the consul server address. A valid string consisting of a hostname or IP followed by an optional port number. services : [str], default is Undefined, optional - A list of services for which targets are retrieved. If omitted, all services are scraped. + services defines a list of services for which targets are retrieved. If omitted, all services are scraped. tagSeparator : str, default is Undefined, optional - The string by which Consul tags are joined into the tag label. + tagSeparator defines the string by which Consul tags are joined into the tag label. If unset, Prometheus uses its default value. tags : [str], default is Undefined, optional - An optional list of tags used to filter nodes for a given service. Services must contain all tags in the list. + tags defines an optional list of tags used to filter nodes for a given service. Services must contain all tags in the list. Starting with Consul 1.14, it is recommended to use `filter` with the `ServiceTags` selector instead. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfig, default is Undefined, optional tls config @@ -1199,7 +1217,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0: proxyFromEnvironment?: bool proxyUrl?: str refreshInterval?: str - scheme?: "HTTP" | "HTTPS" + scheme?: "http" | "https" | "HTTP" | "HTTPS" server: str services?: [str] @@ -1214,14 +1232,14 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0: len(namespace) >= 1 if namespace len(partition) >= 1 if partition len(pathPrefix) >= 1 if pathPrefix - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval len(server) >= 1 len(tagSeparator) >= 1 if tagSeparator schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Authorization: r""" - Optional Authorization header configuration to authenticate against the Consul Server. + authorization defines the header configuration to authenticate against the Consul Server. Cannot be set at the same time as `basicAuth`, or `oauth2`. Attributes @@ -1229,7 +1247,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Authoriza credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -1240,7 +1258,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Authoriza schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -1262,7 +1280,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Authoriza schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0BasicAuth: r""" - Optional BasicAuth information to authenticate against the Consul Server. + basicAuth defines the information to authenticate against the Consul Server. More info: https://prometheus.io/docs/operating/configuration/#endpoints Cannot be set at the same time as `authorization`, or `oauth2`. @@ -1278,7 +1296,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0BasicAuth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -1301,7 +1319,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0BasicAuth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -1324,8 +1342,8 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0BasicAuth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2: r""" - Optional OAuth2.0 configuration. - Cannot be set at the same time as `basicAuth`, or `authorization`. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. + Cannot be set at the same time as `authorization`, or `basicAuth`. Attributes ---------- @@ -1334,31 +1352,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2: clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2ClientID @@ -1374,12 +1392,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -1394,7 +1412,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2Cli schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1416,7 +1434,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2Cli schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1438,7 +1456,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2Cli schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -1483,7 +1501,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2Pro schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -1493,19 +1511,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLS cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLSConfigCert @@ -1517,7 +1535,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -1531,7 +1549,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1553,7 +1571,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1575,7 +1593,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -1589,7 +1607,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1611,7 +1629,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1633,7 +1651,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -1677,7 +1695,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0ProxyConn schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfig: r""" - TLS configuration to connect to the Consul API. + tlsConfig defines the TLS configuration to connect to the Consul API. Attributes ---------- @@ -1686,19 +1704,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfig cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfigCert @@ -1710,7 +1728,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -1724,7 +1742,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1746,7 +1764,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1768,7 +1786,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -1782,7 +1800,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -1804,7 +1822,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -1826,7 +1844,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -1848,7 +1866,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecConsulSDConfigsItems0TokenRef: r""" - Consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent. + tokenRef defines the consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent. Attributes ---------- @@ -1877,15 +1895,15 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDNSSDConfigsItems0: Attributes ---------- names : [str], default is Undefined, required - A list of DNS domain names to be queried. + names defines a list of DNS domain names to be queried. port : int, default is Undefined, optional - The port number used if the query type is not SRV + port defines the port to scrape metrics from. If using the public IP address, this must Ignored for SRV records refreshInterval : str, default is Undefined, optional - RefreshInterval configures the time after which the provided names are refreshed. + refreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value. $type : str, default is Undefined, optional - The type of DNS query to perform. One of SRV, A, AAAA, MX or NS. + type defines the type of DNS query to perform. One of SRV, A, AAAA, MX or NS. If not set, Prometheus uses its default value. When set to NS, it requires Prometheus >= v2.49.0. @@ -1915,32 +1933,33 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0: authorization : MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Authorization, default is Undefined, optional authorization enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2, default is Undefined, optional oauth2 port : int, default is Undefined, optional - The port to scrape metrics from. + port defines the port to scrape metrics from. If using the public IP address, this must proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - Refresh interval to re-read the instance list. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLSConfig, default is Undefined, optional tls config """ @@ -1959,12 +1978,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0: check: port <= 65535 if port not in [None, Undefined] port >= 0 if port not in [None, Undefined] - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Authorization: r""" - Authorization header configuration to authenticate against the DigitalOcean API. + authorization defines the header configuration to authenticate against the DigitalOcean API. Cannot be set at the same time as `oauth2`. Attributes @@ -1972,7 +1991,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Aut credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -1983,7 +2002,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Aut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -2005,8 +2024,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Aut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2: r""" - Optional OAuth 2.0 configuration. - Cannot be set at the same time as `authorization`. + oauth2 defines the configuration to use on every scrape request. Attributes ---------- @@ -2015,31 +2033,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2ClientID @@ -2055,12 +2073,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -2075,7 +2093,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2097,7 +2115,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2119,7 +2137,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -2164,7 +2182,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -2174,19 +2192,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2TLSConfigCert @@ -2198,7 +2216,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -2212,7 +2230,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2234,7 +2252,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2256,7 +2274,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -2270,7 +2288,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2292,7 +2310,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2314,7 +2332,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oau schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -2358,7 +2376,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0Pro schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLSConfig: r""" - TLS configuration applying to the target HTTP endpoint. + tlsConfig defines the TLS configuration to connect to the Consul API. Attributes ---------- @@ -2367,19 +2385,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLS cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLSConfigCert @@ -2391,7 +2409,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -2405,7 +2423,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2427,7 +2445,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2449,7 +2467,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -2463,7 +2481,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2485,7 +2503,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2507,7 +2525,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDigitalOceanSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -2541,42 +2559,43 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0: basicAuth : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0BasicAuth, default is Undefined, optional basic auth enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. filters : [MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0FiltersItems0], default is Undefined, optional - Optional filters to limit the discovery process to a subset of the available resources. + filters defines filters to limit the discovery process to a subset of the available resources. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. host : str, default is Undefined, required - Address of the docker daemon + host defines the address of the docker daemon hostNetworkingHost : str, default is Undefined, optional - The host to use if the container is in host networking mode. + hostNetworkingHost defines the host to use if the container is in host networking mode. matchFirstNetwork : bool, default is Undefined, optional - Configure whether to match the first network if the container has multiple networks defined. + matchFirstNetwork defines whether to match the first network if the container has multiple networks defined. If unset, Prometheus uses true by default. It requires Prometheus >= v2.54.1. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2, default is Undefined, optional oauth2 port : int, default is Undefined, optional - The port to scrape metrics from. + port defines the port to scrape metrics from. If using the public IP address, this must proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - Time after which the container is refreshed. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfig, default is Undefined, optional tls config """ @@ -2600,12 +2619,15 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0: check: len(host) >= 1 - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + len(hostNetworkingHost) >= 1 if hostNetworkingHost + port <= 65535 if port not in [None, Undefined] + port >= 0 if port not in [None, Undefined] + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Authorization: r""" - Authorization header configuration to authenticate against the Docker API. + authorization defines the header configuration to authenticate against the DigitalOcean API. Cannot be set at the same time as `oauth2`. Attributes @@ -2613,7 +2635,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Authoriza credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -2624,7 +2646,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Authoriza schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -2646,7 +2668,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Authoriza schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0BasicAuth: r""" - BasicAuth information to use on every scrape request. + basicAuth defines information to use on every scrape request. Attributes ---------- @@ -2660,7 +2682,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0BasicAuth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -2683,7 +2705,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0BasicAuth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -2711,9 +2733,9 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0FiltersIt Attributes ---------- name : str, default is Undefined, required - Name of the Filter. + name of the Filter. values : [str], default is Undefined, required - Value to filter on. + values defines values to filter on. """ name: str @@ -2725,8 +2747,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0FiltersIt schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2: r""" - Optional OAuth 2.0 configuration. - Cannot be set at the same time as `authorization`. + oauth2 defines the configuration to use on every scrape request. Attributes ---------- @@ -2735,31 +2756,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2: clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2ClientID @@ -2775,12 +2796,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -2795,7 +2816,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2Cli schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2817,7 +2838,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2Cli schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2839,7 +2860,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2Cli schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -2884,7 +2905,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2Pro schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -2894,19 +2915,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLS cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLSConfigCert @@ -2918,7 +2939,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -2932,7 +2953,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -2954,7 +2975,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -2976,7 +2997,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -2990,7 +3011,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -3012,7 +3033,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -3034,7 +3055,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -3078,7 +3099,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0ProxyConn schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfig: r""" - TLS configuration applying to the target HTTP endpoint. + tlsConfig defines the TLS configuration to connect to the Consul API. Attributes ---------- @@ -3087,19 +3108,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfig cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfigCert @@ -3111,7 +3132,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -3125,7 +3146,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -3147,7 +3168,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -3169,7 +3190,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -3183,7 +3204,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -3205,7 +3226,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -3227,7 +3248,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -3259,44 +3280,45 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0: basicAuth : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0BasicAuth, default is Undefined, optional basic auth enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. filters : [MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0FiltersItems0], default is Undefined, optional - Optional filters to limit the discovery process to a subset of available + filters defines the filters to limit the discovery process to a subset of available resources. The available filters are listed in the upstream documentation: Services: https://docs.docker.com/engine/api/v1.40/#operation/ServiceList Tasks: https://docs.docker.com/engine/api/v1.40/#operation/TaskList Nodes: https://docs.docker.com/engine/api/v1.40/#operation/NodeList followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. host : str, default is Undefined, required - Address of the Docker daemon + host defines the address of the Docker daemon noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2, default is Undefined, optional oauth2 port : int, default is Undefined, optional - The port to scrape metrics from, when `role` is nodes, and for discovered + port defines the port to scrape metrics from. If using the public IP address, this must tasks and services that don't have published ports. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - The time after which the service discovery data is refreshed. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. role : str, default is Undefined, required - Role of the targets to retrieve. Must be `Services`, `Tasks`, or `Nodes`. + role of the targets to retrieve. Must be `Services`, `Tasks`, or `Nodes`. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSConfig, default is Undefined, optional tls config """ @@ -3322,19 +3344,20 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0: _regex_match(str(host), r"^[a-zA-Z][a-zA-Z0-9+.-]*://.+$") port <= 65535 if port not in [None, Undefined] port >= 0 if port not in [None, Undefined] - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Authorization: r""" - Authorization header configuration to authenticate against the target HTTP endpoint. + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. Attributes ---------- credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -3345,7 +3368,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Auth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -3367,7 +3390,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Auth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0BasicAuth: r""" - Optional HTTP basic authentication information. + basicAuth defines information to use on every scrape request. Attributes ---------- @@ -3381,7 +3404,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Basi schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -3404,7 +3427,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Basi schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -3432,9 +3455,9 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Filt Attributes ---------- name : str, default is Undefined, required - Name of the Filter. + name of the Filter. values : [str], default is Undefined, required - Value to filter on. + values defines values to filter on. """ name: str @@ -3446,7 +3469,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Filt schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2: r""" - Optional OAuth 2.0 configuration. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`. Attributes @@ -3456,31 +3479,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2ClientID @@ -3496,12 +3519,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -3516,7 +3539,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -3538,7 +3561,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -3560,7 +3583,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -3605,7 +3628,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -3615,19 +3638,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2TLSConfigCert @@ -3639,7 +3662,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -3653,7 +3676,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -3675,7 +3698,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -3697,7 +3720,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -3711,7 +3734,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -3733,7 +3756,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -3755,7 +3778,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oaut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -3799,7 +3822,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0Prox schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSConfig: r""" - TLS configuration to use on every scrape request + tlsConfig defines the TLS configuration to connect to the Consul API. Attributes ---------- @@ -3808,19 +3831,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSC cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSConfigCert @@ -3832,7 +3855,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -3846,7 +3869,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -3868,7 +3891,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -3890,7 +3913,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -3904,7 +3927,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -3926,7 +3949,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -3948,7 +3971,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecDockerSwarmSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -3983,43 +4006,44 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0: accessKey : MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0AccessKey, default is Undefined, optional access key enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. It requires Prometheus >= v2.41.0 filters : [MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0FiltersItems0], default is Undefined, optional - Filters can be used optionally to filter the instance list by other criteria. + filters can be used optionally to filter the instance list by other criteria. Available filter criteria can be found here: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeInstances.html Filter API documentation: https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_Filter.html It requires Prometheus >= v2.3.0 followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. It requires Prometheus >= v2.41.0 noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. port : int, default is Undefined, optional - The port to scrape metrics from. If using the public IP address, this must + port defines the port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. region : str, default is Undefined, optional - The AWS region. + region defines the AWS region. roleARN : str, default is Undefined, optional - AWS Role ARN, an alternative to using AWS API keys. + roleARN defines an alternative to using AWS API keys. secretKey : MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0SecretKey, default is Undefined, optional secret key tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfig, default is Undefined, optional @@ -4043,14 +4067,14 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0: check: port <= 65535 if port not in [None, Undefined] port >= 0 if port not in [None, Undefined] - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval len(region) >= 1 if region len(roleARN) >= 1 if roleARN schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0AccessKey: r""" - AccessKey is the AWS API key. + accessKey defines the AWS API key. Attributes ---------- @@ -4077,9 +4101,9 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0FiltersItems Attributes ---------- name : str, default is Undefined, required - Name of the Filter. + name of the Filter. values : [str], default is Undefined, required - Value to filter on. + values defines values to filter on. """ name: str @@ -4113,7 +4137,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0ProxyConnect schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0SecretKey: r""" - SecretKey is the AWS API secret. + secretKey defines the AWS API secret. Attributes ---------- @@ -4135,7 +4159,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0SecretKey: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfig: r""" - TLS configuration to connect to the AWS EC2 API. + tlsConfig defines the TLS configuration to connect to the Consul API. It requires Prometheus >= v2.41.0 Attributes @@ -4145,19 +4169,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfig: cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCert @@ -4169,7 +4193,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfig: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -4183,7 +4207,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCa: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -4205,7 +4229,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCaC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -4227,7 +4251,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCaS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -4241,7 +4265,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCer schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -4263,7 +4287,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCer schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -4285,7 +4309,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigCer schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEc2SDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -4318,32 +4342,33 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0: basicAuth : MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0BasicAuth, default is Undefined, optional basic auth enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - Refresh interval to re-read the instance list. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. server : str, default is Undefined, required - The URL to connect to the Eureka server. + server defines the URL to connect to the Eureka server. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfig, default is Undefined, optional tls config """ @@ -4362,20 +4387,22 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0: tlsConfig?: MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval len(server) >= 1 + _regex_match(str(server), r"^http(s)?://.+$") schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Authorization: r""" - Authorization header to use on every scrape request. + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. Attributes ---------- credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -4386,7 +4413,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Authoriza schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -4408,7 +4435,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Authoriza schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0BasicAuth: r""" - BasicAuth information to use on every scrape request. + basicAuth defines the BasicAuth information to use on every scrape request. Attributes ---------- @@ -4422,7 +4449,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0BasicAuth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -4445,7 +4472,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0BasicAuth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -4468,8 +4495,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0BasicAuth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2: r""" - Optional OAuth 2.0 configuration. - Cannot be set at the same time as `authorization` or `basic_auth`. + oauth2 defines the configuration to use on every scrape request. Attributes ---------- @@ -4478,31 +4504,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2: clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2ClientID @@ -4518,12 +4544,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -4538,7 +4564,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2Cli schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -4560,7 +4586,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2Cli schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -4582,7 +4608,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2Cli schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -4627,7 +4653,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2Pro schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -4637,19 +4663,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLS cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLSConfigCert @@ -4661,7 +4687,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -4675,7 +4701,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -4697,7 +4723,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -4719,7 +4745,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -4733,7 +4759,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -4755,7 +4781,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -4777,7 +4803,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -4821,7 +4847,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0ProxyConn schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfig: r""" - TLS configuration applying to the target HTTP endpoint. + tlsConfig defines the TLS configuration to connect to the Consul API. Attributes ---------- @@ -4830,19 +4856,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfig cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfigCert @@ -4854,7 +4880,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -4868,7 +4894,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -4890,7 +4916,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -4912,7 +4938,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -4926,7 +4952,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -4948,7 +4974,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -4970,7 +4996,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecEurekaSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -4998,12 +5024,13 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecFileSDConfigsItems0: Attributes ---------- files : [str], default is Undefined, required - List of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the + files defines the list of files to be used for file discovery. Recommendation: use absolute paths. While relative paths work, the prometheus-operator project makes no guarantees about the working directory where the configuration file is stored. Files must be mounted using Prometheus.ConfigMaps or Prometheus.Secrets. refreshInterval : str, default is Undefined, optional - RefreshInterval configures the refresh interval at which Prometheus will reload the content of the files. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. """ files: [str] @@ -5033,20 +5060,21 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecGceSDConfigsItems0: Attributes ---------- $filter : str, default is Undefined, optional - Filter can be used optionally to filter the instance list by other criteria + filter defines the filter that can be used optionally to filter the instance list by other criteria Syntax of this filter is described in the filter query parameter section: https://cloud.google.com/compute/docs/reference/latest/instances/list port : int, default is Undefined, optional - The port to scrape metrics from. If using the public IP address, this must + port defines the port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule. project : str, default is Undefined, required - The Google Cloud Project ID + project defines the Google Cloud Project ID refreshInterval : str, default is Undefined, optional - RefreshInterval configures the refresh interval at which Prometheus will re-read the instance list. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. tagSeparator : str, default is Undefined, optional - The tag separator is used to separate the tags on concatenation + tagSeparator defines the tag separator is used to separate the tags on concatenation zone : str, default is Undefined, required - The zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs. + zone defines the zone of the scrape targets. If you need multiple zones use multiple GCESDConfigs. """ $filter?: str port?: int @@ -5077,35 +5105,35 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0: basicAuth : MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0BasicAuth, default is Undefined, optional basic auth enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - RefreshInterval configures the refresh interval at which Prometheus will re-query the - endpoint to update the target list. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfig, default is Undefined, optional tls config url : str, default is Undefined, required - URL from which the targets are fetched. + url defines the URL from which the targets are fetched. """ authorization?: MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Authorization basicAuth?: MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0BasicAuth @@ -5121,14 +5149,14 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0: url: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval len(url) >= 1 _regex_match(str(url), r"^http(s)?://.+$") schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Authorization: r""" - Authorization header configuration to authenticate against the target HTTP endpoint. + authorization defines the authorization header configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `oAuth2`, or `basicAuth`. Attributes @@ -5136,7 +5164,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Authorizati credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -5147,7 +5175,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Authorizati schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -5169,7 +5197,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Authorizati schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0BasicAuth: r""" - BasicAuth information to authenticate against the target HTTP endpoint. + basicAuth defines information to use on every scrape request. More info: https://prometheus.io/docs/operating/configuration/#endpoints Cannot be set at the same time as `authorization`, or `oAuth2`. @@ -5185,7 +5213,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0BasicAuth: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -5208,7 +5236,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0BasicAuthPa schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -5231,7 +5259,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0BasicAuthUs schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2: r""" - Optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`. Attributes @@ -5241,31 +5269,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2: clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2ClientID @@ -5281,12 +5309,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -5301,7 +5329,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2Clien schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5323,7 +5351,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2Clien schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5345,7 +5373,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2Clien schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -5390,7 +5418,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2Proxy schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -5400,19 +5428,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSCo cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSConfigCert @@ -5424,7 +5452,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -5438,7 +5466,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5460,7 +5488,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5482,7 +5510,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -5496,7 +5524,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5518,7 +5546,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5540,7 +5568,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -5584,7 +5612,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0ProxyConnec schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfig: r""" - TLS configuration applying to the target HTTP endpoint. + tlsConfig defines the TLS configuration applying to the target HTTP endpoint. Attributes ---------- @@ -5593,19 +5621,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfig: cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCert @@ -5617,7 +5645,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfig: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -5631,7 +5659,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCa schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5653,7 +5681,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCa schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5675,7 +5703,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCa schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -5689,7 +5717,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCe schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -5711,7 +5739,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCe schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -5733,7 +5761,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigCe schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHTTPSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -5766,34 +5794,38 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0: basicAuth : MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0BasicAuth, default is Undefined, optional basic auth enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. + labelSelector : str, default is Undefined, optional + labelSelector defines the label selector used to filter the servers when fetching them from the API. + It requires Prometheus >= v3.5.0. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2, default is Undefined, optional oauth2 port : int, default is Undefined, optional - The port to scrape metrics from. + port defines the port to scrape metrics from. If using the public IP address, this must proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - The time after which the servers are refreshed. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. role : str, default is Undefined, required - The Hetzner role of entities that should be discovered. + role defines the Hetzner role of entities that should be discovered. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfig, default is Undefined, optional tls config """ @@ -5801,6 +5833,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0: basicAuth?: MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0BasicAuth enableHTTP2?: bool followRedirects?: bool + labelSelector?: str noProxy?: str oauth2?: MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2 port?: int @@ -5813,20 +5846,23 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0: tlsConfig?: MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + len(labelSelector) >= 1 if labelSelector + port <= 65535 if port not in [None, Undefined] + port >= 0 if port not in [None, Undefined] + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Authorization: r""" - Authorization header configuration, required when role is hcloud. - Role robot does not support bearer token authentication. + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. Attributes ---------- credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -5837,7 +5873,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Authoriz schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -5859,8 +5895,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Authoriz schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0BasicAuth: r""" - BasicAuth information to use on every scrape request, required when role is robot. - Role hcloud does not support basic auth. + basicAuth defines information to use on every scrape request. Attributes ---------- @@ -5874,7 +5909,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0BasicAut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -5897,7 +5932,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0BasicAut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -5920,8 +5955,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0BasicAut schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2: r""" - Optional OAuth 2.0 configuration. - Cannot be used at the same time as `basic_auth` or `authorization`. + oauth2 defines the configuration to use on every scrape request. Attributes ---------- @@ -5930,31 +5964,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2: clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2ClientID @@ -5970,12 +6004,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -5990,7 +6024,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2Cl schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6012,7 +6046,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2Cl schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6034,7 +6068,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2Cl schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -6079,7 +6113,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2Pr schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -6089,19 +6123,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TL cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TLSConfigCert @@ -6113,7 +6147,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TL schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -6127,7 +6161,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TL schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6149,7 +6183,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TL schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6171,7 +6205,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TL schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -6185,7 +6219,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TL schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6207,7 +6241,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TL schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6229,7 +6263,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TL schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -6273,7 +6307,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0ProxyCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfig: r""" - TLS configuration to use on every scrape request. + tlsConfig defines the TLS configuration to connect to the Consul API. Attributes ---------- @@ -6282,19 +6316,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfi cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfigCert @@ -6306,7 +6340,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfi schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -6320,7 +6354,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfi schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6342,7 +6376,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfi schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6364,7 +6398,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfi schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -6378,7 +6412,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfi schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6400,7 +6434,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfi schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6422,7 +6456,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfi schema MonitoringCoreosComV1alpha1ScrapeConfigSpecHetznerSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -6452,34 +6486,35 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0: authorization : MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Authorization, default is Undefined, required authorization datacenterID : str, default is Undefined, required - The unique ID of the IONOS data center. + datacenterID defines the unique ID of the IONOS data center. enableHTTP2 : bool, default is Undefined, optional - Configure whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. followRedirects : bool, default is Undefined, optional - Configure whether the HTTP requests should follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2, default is Undefined, optional oauth2 port : int, default is Undefined, optional - Port to scrape the metrics from. + port defines the port to scrape metrics from. If using the public IP address, this must proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - Refresh interval to re-read the list of resources. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfig, default is Undefined, optional tls config """ @@ -6502,19 +6537,20 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0: len(datacenterID) >= 1 port <= 65535 if port not in [None, Undefined] port >= 0 if port not in [None, Undefined] - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Authorization: r""" - Authorization` header configuration, required when using IONOS. + authorization defines the header configuration to authenticate against the IONOS. + Cannot be set at the same time as `oauth2`. Attributes ---------- credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -6525,7 +6561,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Authorizat schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -6547,7 +6583,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Authorizat schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2: r""" - Configure whether to enable OAuth2. + oauth2 defines the configuration to use on every scrape request. Attributes ---------- @@ -6556,31 +6592,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2: clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2ClientID @@ -6596,12 +6632,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -6616,7 +6652,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2Clie schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6638,7 +6674,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2Clie schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6660,7 +6696,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2Clie schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -6705,7 +6741,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2Prox schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -6715,19 +6751,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSC cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSConfigCert @@ -6739,7 +6775,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -6753,7 +6789,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6775,7 +6811,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6797,7 +6833,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -6811,7 +6847,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6833,7 +6869,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6855,7 +6891,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -6899,7 +6935,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0ProxyConne schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfig: r""" - TLS configuration to use when connecting to the IONOS API. + tlsConfig defines the TLS configuration to connect to the Consul API. Attributes ---------- @@ -6908,19 +6944,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfig: cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigCert @@ -6932,7 +6968,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfig: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -6946,7 +6982,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -6968,7 +7004,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -6990,7 +7026,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -7004,7 +7040,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7026,7 +7062,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7048,7 +7084,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecIonosSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -7076,7 +7112,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0: Attributes ---------- apiServer : str, default is Undefined, optional - The API server address consisting of a hostname or IP address followed + apiServer defines the API server address consisting of a hostname or IP address followed by an optional port number. If left empty, Prometheus is assumed to run inside of the cluster. It will discover API servers automatically and use the pod's @@ -7088,35 +7124,35 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0: basicAuth : MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0BasicAuth, default is Undefined, optional basic auth enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. namespaces : MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Namespaces, default is Undefined, optional namespaces noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. role : str, default is Undefined, required - Role of the Kubernetes entities that should be discovered. + role defines the Kubernetes role of the entities that should be discovered. Role `Endpointslice` requires Prometheus >= v2.21.0 selectors : [MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0SelectorsItems0], default is Undefined, optional - Selector to select objects. + selectors defines the selector to select objects. It requires Prometheus >= v2.17.0 tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSConfig, default is Undefined, optional tls config @@ -7140,18 +7176,18 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0: check: len(apiServer) >= 1 if apiServer - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0AttachMetadata: r""" - Optional metadata to attach to discovered targets. + attachMetadata defines the metadata to attach to discovered targets. It requires Prometheus >= v2.35.0 when using the `Pod` role and Prometheus >= v2.37.0 for `Endpoints` and `Endpointslice` roles. Attributes ---------- node : bool, default is Undefined, optional - Attaches node metadata to discovered targets. + node attaches node metadata to discovered targets. When set to true, Prometheus must have the `get` permission on the `Nodes` objects. Only valid for Pod, Endpoint and Endpointslice roles. @@ -7160,7 +7196,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Attac schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Authorization: r""" - Authorization header to use on every scrape request. + authorization defines the authorization header to use on every scrape request. Cannot be set at the same time as `basicAuth`, or `oauth2`. Attributes @@ -7168,7 +7204,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Autho credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -7179,7 +7215,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Autho schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -7201,7 +7237,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Autho schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0BasicAuth: r""" - BasicAuth information to use on every scrape request. + basicAuth defines information to use on every scrape request. Cannot be set at the same time as `authorization`, or `oauth2`. Attributes @@ -7216,7 +7252,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Basic schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -7239,7 +7275,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Basic schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -7262,22 +7298,22 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Basic schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Namespaces: r""" - Optional namespace discovery. If omitted, Prometheus discovers targets across all namespaces. + namespaces defines the namespace discovery. If omitted, Prometheus discovers targets across all namespaces. Attributes ---------- names : [str], default is Undefined, optional - List of namespaces where to watch for resources. + names defines a list of namespaces where to watch for resources. If empty and `ownNamespace` isn't true, Prometheus watches for resources in all namespaces. ownNamespace : bool, default is Undefined, optional - Includes the namespace in which the Prometheus pod runs to the list of watched namespaces. + ownNamespace includes the namespace in which the Prometheus pod runs to the list of watched namespaces. """ names?: [str] ownNamespace?: bool schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2: r""" - Optional OAuth 2.0 configuration. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`. Attributes @@ -7287,31 +7323,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2ClientID @@ -7327,12 +7363,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -7347,7 +7383,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7369,7 +7405,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7391,7 +7427,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -7436,7 +7472,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -7446,19 +7482,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2TLSConfigCert @@ -7470,7 +7506,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -7484,7 +7520,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7506,7 +7542,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7528,7 +7564,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -7542,7 +7578,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7564,7 +7600,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7586,7 +7622,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -7635,13 +7671,13 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Selec Attributes ---------- field : str, default is Undefined, optional - An optional field selector to limit the service discovery to resources which have fields with specific values. + field defines an optional field selector to limit the service discovery to resources which have fields with specific values. e.g: `metadata.name=foobar` label : str, default is Undefined, optional - An optional label selector to limit the service discovery to resources with specific labels and label values. + label defines an optional label selector to limit the service discovery to resources with specific labels and label values. e.g: `node.kubernetes.io/instance-type=master` role : str, default is Undefined, required - Role specifies the type of Kubernetes resource to limit the service discovery to. + role defines the type of Kubernetes resource to limit the service discovery to. Accepted values are: Node, Pod, Endpoints, EndpointSlice, Service, Ingress. """ field?: str @@ -7654,7 +7690,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0Selec schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSConfig: r""" - TLS configuration to connect to the Kubernetes API. + tlsConfig defines the TLS configuration to connect to the Kubernetes API. Attributes ---------- @@ -7663,19 +7699,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSCo cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSConfigCert @@ -7687,7 +7723,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -7701,7 +7737,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7723,7 +7759,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7745,7 +7781,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -7759,7 +7795,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -7781,7 +7817,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -7803,7 +7839,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKubernetesSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -7835,36 +7871,38 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0: basicAuth : MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0BasicAuth, default is Undefined, optional basic auth clientID : str, default is Undefined, optional - Client id is used by Kuma Control Plane to compute Monitoring Assignment for specific Prometheus backend. + clientID is used by Kuma Control Plane to compute Monitoring Assignment for specific Prometheus backend. + It requires Prometheus >= v2.50.0. enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. fetchTimeout : str, default is Undefined, optional - The time after which the monitoring assignments are refreshed. + fetchTimeout defines the time after which the monitoring assignments are refreshed. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - The time to wait between polling update requests. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. server : str, default is Undefined, required - Address of the Kuma Control Plane's MADS xDS server. + server defines the address of the Kuma Control Plane's MADS xDS server. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfig, default is Undefined, optional tls config """ @@ -7885,21 +7923,23 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0: tlsConfig?: MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfig check: + len(clientID) >= 1 if clientID _regex_match(str(fetchTimeout), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if fetchTimeout - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval - len(server) >= 1 + _regex_match(str(server), r"^https?://.+$") schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Authorization: r""" - Authorization header to use on every scrape request. + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. Attributes ---------- credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -7910,7 +7950,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Authorizati schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -7932,7 +7972,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Authorizati schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0BasicAuth: r""" - BasicAuth information to use on every scrape request. + basicAuth defines information to use on every scrape request. Attributes ---------- @@ -7946,7 +7986,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0BasicAuth: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -7969,7 +8009,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0BasicAuthPa schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -7992,8 +8032,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0BasicAuthUs schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2: r""" - Optional OAuth 2.0 configuration. - Cannot be set at the same time as `authorization`, or `basicAuth`. + oauth2 defines the configuration to use on every scrape request. Attributes ---------- @@ -8002,31 +8041,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2: clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2ClientID @@ -8042,12 +8081,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -8062,7 +8101,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2Clien schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8084,7 +8123,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2Clien schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8106,7 +8145,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2Clien schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -8151,7 +8190,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2Proxy schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -8161,19 +8200,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSCo cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSConfigCert @@ -8185,7 +8224,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -8199,7 +8238,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8221,7 +8260,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8243,7 +8282,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -8257,7 +8296,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8279,7 +8318,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8301,7 +8340,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -8345,7 +8384,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0ProxyConnec schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfig: r""" - TLS configuration to use on every scrape request + tlsConfig defines the TLS configuration to connect to the Consul API. Attributes ---------- @@ -8354,19 +8393,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfig: cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCert @@ -8378,7 +8417,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfig: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -8392,7 +8431,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCa schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8414,7 +8453,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCa schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8436,7 +8475,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCa schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -8450,7 +8489,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCe schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8472,7 +8511,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCe schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8494,7 +8533,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigCe schema MonitoringCoreosComV1alpha1ScrapeConfigSpecKumaSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -8528,39 +8567,39 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0: basicAuth : MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0BasicAuth, default is Undefined, optional basic auth enableHTTP2 : bool, default is Undefined, optional - Configure whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. endpoint : str, default is Undefined, optional - Custom endpoint to be used. + endpoint defines the custom endpoint to be used. followRedirects : bool, default is Undefined, optional - Configure whether the HTTP requests should follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2, default is Undefined, optional oauth2 port : int, default is Undefined, optional - Port to scrape the metrics from. - If using the public IP address, this must instead be specified in the relabeling rule. + port defines the port to scrape metrics from. If using the public IP address, this must proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - Refresh interval to re-read the list of instances. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. region : str, default is Undefined, optional - The AWS region. + region defines the AWS region. roleARN : str, default is Undefined, optional - AWS Role ARN, an alternative to using AWS API keys. + roleARN defines the AWS Role ARN, an alternative to using AWS API keys. secretKey : MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0SecretKey, default is Undefined, optional secret key tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSConfig, default is Undefined, optional @@ -8588,13 +8627,13 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0: len(endpoint) >= 1 if endpoint port <= 65535 if port not in [None, Undefined] port >= 0 if port not in [None, Undefined] - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval len(region) >= 1 if region schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0AccessKey: r""" - AccessKey is the AWS API key. + accessKey defines the AWS API key. Attributes ---------- @@ -8616,15 +8655,15 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Access schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Authorization: r""" - Optional `authorization` HTTP header configuration. - Cannot be set at the same time as `basicAuth`, or `oauth2`. + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. Attributes ---------- credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -8635,7 +8674,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Author schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -8657,7 +8696,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Author schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0BasicAuth: r""" - Optional HTTP basic authentication information. + basicAuth defines information to use on every scrape request. Cannot be set at the same time as `authorization`, or `oauth2`. Attributes @@ -8672,7 +8711,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0BasicA schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -8695,7 +8734,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0BasicA schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -8718,8 +8757,8 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0BasicA schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2: r""" - Optional OAuth2.0 configuration. - Cannot be set at the same time as `basicAuth`, or `authorization`. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. + Cannot be set at the same time as `authorization`, or `basicAuth`. Attributes ---------- @@ -8728,31 +8767,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2ClientID @@ -8768,12 +8807,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -8788,7 +8827,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8810,7 +8849,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8832,7 +8871,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -8877,7 +8916,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -8887,19 +8926,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2TLSConfigCert @@ -8911,7 +8950,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -8925,7 +8964,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -8947,7 +8986,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -8969,7 +9008,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -8983,7 +9022,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9005,7 +9044,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9027,7 +9066,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -9071,7 +9110,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0ProxyC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0SecretKey: r""" - SecretKey is the AWS API secret. + secretKey defines the AWS API secret. Attributes ---------- @@ -9093,7 +9132,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0Secret schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSConfig: r""" - TLS configuration to connect to the Puppet DB. + tlsConfig defines the TLS configuration to connect to the Consul API. Attributes ---------- @@ -9102,19 +9141,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSCon cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSConfigCert @@ -9126,7 +9165,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -9140,7 +9179,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9162,7 +9201,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9184,7 +9223,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -9198,7 +9237,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9220,7 +9259,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9242,7 +9281,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLightSailSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -9272,36 +9311,37 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0: authorization : MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Authorization, default is Undefined, optional authorization enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2, default is Undefined, optional oauth2 port : int, default is Undefined, optional - Default port to scrape metrics from. + port defines the port to scrape metrics from. If using the public IP address, this must proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - Time after which the linode instances are refreshed. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. region : str, default is Undefined, optional - Optional region to filter on. + region defines the region to filter on. tagSeparator : str, default is Undefined, optional - The string by which Linode Instance tags are joined into the tag label. + tagSeparator defines the string by which Linode Instance tags are joined into the tag label.el. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfig, default is Undefined, optional tls config """ @@ -9322,21 +9362,22 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0: check: port <= 65535 if port not in [None, Undefined] port >= 0 if port not in [None, Undefined] - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval len(region) >= 1 if region len(tagSeparator) >= 1 if tagSeparator schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Authorization: r""" - Authorization header configuration. + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. Attributes ---------- credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -9347,7 +9388,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Authoriza schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -9369,8 +9410,8 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Authoriza schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2: r""" - Optional OAuth 2.0 configuration. - Cannot be used at the same time as `authorization`. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. + Cannot be set at the same time as `authorization`, or `basicAuth`. Attributes ---------- @@ -9379,31 +9420,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2: clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2ClientID @@ -9419,12 +9460,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -9439,7 +9480,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2Cli schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9461,7 +9502,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2Cli schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9483,7 +9524,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2Cli schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -9528,7 +9569,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2Pro schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -9538,19 +9579,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLS cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLSConfigCert @@ -9562,7 +9603,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -9576,7 +9617,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9598,7 +9639,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9620,7 +9661,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -9634,7 +9675,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9656,7 +9697,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9678,7 +9719,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLS schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -9722,7 +9763,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0ProxyConn schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfig: r""" - TLS configuration applying to the target HTTP endpoint. + tlsConfig defines the TLS configuration to connect to the Consul API. Attributes ---------- @@ -9731,19 +9772,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfig cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfigCert @@ -9755,7 +9796,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -9769,7 +9810,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9791,7 +9832,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9813,7 +9854,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -9827,7 +9868,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -9849,7 +9890,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -9871,7 +9912,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfig schema MonitoringCoreosComV1alpha1ScrapeConfigSpecLinodeSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -9901,31 +9942,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecMetricRelabelingsItems0: Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -9940,9 +9981,6 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecMetricRelabelingsItems0: sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0: r""" NomadSDConfig configurations allow retrieving scrape targets from Nomad's Service API. @@ -9951,47 +9989,50 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0: Attributes ---------- allowStale : bool, default is Undefined, optional - The information to access the Nomad API. It is to be defined + allowStale defines the information to access the Nomad API. It is to be defined as the Nomad documentation requires. authorization : MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Authorization, default is Undefined, optional authorization basicAuth : MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0BasicAuth, default is Undefined, optional basic auth enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. namespace : str, default is Undefined, optional - namespace + namespace defines the Nomad namespace to query for service discovery. + When specified, only resources within this namespace will be discovered. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2, default is Undefined, optional oauth2 proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - Duration is a valid time duration that can be parsed by Prometheus model.ParseDuration() function. - Supported units: y, w, d, h, m, s, ms - Examples: `30s`, `1m`, `1h20m15s`, `15d` + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. region : str, default is Undefined, optional - region + region defines the Nomad region to query for service discovery. + When specified, only resources within this region will be discovered. server : str, default is Undefined, required - server + server defines the Nomad server address to connect to for service discovery. + This should be the full URL including protocol (e.g., "https://nomad.example.com:4646"). tagSeparator : str, default is Undefined, optional - tag separator + tagSeparator defines the separator used to join multiple tags. + This determines how Nomad service tags are concatenated into Prometheus labels. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfig, default is Undefined, optional tls config """ @@ -10014,20 +10055,21 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0: tlsConfig?: MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfig check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval len(server) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Authorization: r""" - Authorization header to use on every scrape request. + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. Attributes ---------- credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -10038,7 +10080,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Authorizat schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -10060,7 +10102,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Authorizat schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0BasicAuth: r""" - BasicAuth information to use on every scrape request. + basicAuth defines information to use on every scrape request. Attributes ---------- @@ -10074,7 +10116,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0BasicAuth: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -10097,7 +10139,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0BasicAuthP schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -10120,8 +10162,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0BasicAuthU schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2: r""" - Optional OAuth 2.0 configuration. - Cannot be set at the same time as `authorization` or `basic_auth`. + oauth2 defines the configuration to use on every scrape request. Attributes ---------- @@ -10130,31 +10171,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2: clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2ClientID @@ -10170,12 +10211,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -10190,7 +10231,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2Clie schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10212,7 +10253,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2Clie schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10234,7 +10275,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2Clie schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -10279,7 +10320,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2Prox schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -10289,19 +10330,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSC cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSConfigCert @@ -10313,7 +10354,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -10327,7 +10368,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10349,7 +10390,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10371,7 +10412,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -10385,7 +10426,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10407,7 +10448,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10429,7 +10470,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -10473,7 +10514,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0ProxyConne schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfig: r""" - TLS configuration applying to the target HTTP endpoint. + tlsConfig defines the TLS configuration to connect to the Consul API. Attributes ---------- @@ -10482,19 +10523,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfig: cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigCert @@ -10506,7 +10547,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfig: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -10520,7 +10561,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10542,7 +10583,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10564,7 +10605,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -10578,7 +10619,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10600,7 +10641,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10622,7 +10663,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigC schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -10644,7 +10685,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecNomadSDConfigsItems0TLSConfigK schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2: r""" - OAuth2 configuration to use on every scrape request. + oauth2 defines the configuration to use on every scrape request. Attributes ---------- @@ -10653,31 +10694,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2: clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2ClientID @@ -10693,12 +10734,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -10713,7 +10754,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2ClientID: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10735,7 +10776,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2ClientIDConfigMap: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10757,7 +10798,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2ClientIDSecret: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -10802,7 +10843,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2ProxyConnectHeaderItems0 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -10812,19 +10853,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfig: cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCert @@ -10836,7 +10877,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfig: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -10850,7 +10891,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCa: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10872,7 +10913,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCaConfigMap: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10894,7 +10935,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCaSecret: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -10908,7 +10949,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCert: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -10930,7 +10971,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCertConfigMap: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -10952,7 +10993,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigCertSecret: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -10980,51 +11021,54 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0: Attributes ---------- allTenants : bool, default is Undefined, optional - Whether the service discovery should list all instances for all projects. + allTenants defines whether the service discovery should list all instances for all projects. It is only relevant for the 'instance' role and usually requires admin permissions. applicationCredentialId : str, default is Undefined, optional - ApplicationCredentialID + applicationCredentialId defines the OpenStack applicationCredentialId. applicationCredentialName : str, default is Undefined, optional - The ApplicationCredentialID or ApplicationCredentialName fields are + applicationCredentialName defines the ApplicationCredentialID or ApplicationCredentialName fields are required if using an application credential to authenticate. Some providers allow you to create an application credential to authenticate rather than a password. applicationCredentialSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0ApplicationCredentialSecret, default is Undefined, optional application credential secret availability : str, default is Undefined, optional - Availability of the endpoint to connect to. + availability defines the availability of the endpoint to connect to. domainID : str, default is Undefined, optional - DomainID + domainID defines The OpenStack domainID. domainName : str, default is Undefined, optional - At most one of domainId and domainName must be provided if using username + domainName defines at most one of domainId and domainName that must be provided if using username with Identity V3. Otherwise, either are optional. identityEndpoint : str, default is Undefined, optional - IdentityEndpoint specifies the HTTP endpoint that is required to work with + identityEndpoint defines the HTTP endpoint that is required to work with the Identity API of the appropriate version. password : MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0Password, default is Undefined, optional password port : int, default is Undefined, optional - The port to scrape metrics from. If using the public IP address, this must + port defines the port to scrape metrics from. If using the public IP address, this must instead be specified in the relabeling rule. projectID : str, default is Undefined, optional - ProjectID + projectID defines the OpenStack projectID. projectName : str, default is Undefined, optional - The ProjectId and ProjectName fields are optional for the Identity V2 API. + projectName defines an optional field for the Identity V2 API. Some providers allow you to specify a ProjectName instead of the ProjectId. Some require both. Your provider's authentication policies will determine how these fields influence authentication. refreshInterval : str, default is Undefined, optional - Refresh interval to re-read the instance list. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. region : str, default is Undefined, required - The OpenStack Region. + region defines the OpenStack Region. role : str, default is Undefined, required - The OpenStack role of entities that should be discovered. + role defines the OpenStack role of entities that should be discovered. + + Note: The `LoadBalancer` role requires Prometheus >= v3.2.0. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfig, default is Undefined, optional tls config userid : str, default is Undefined, optional - UserID + userid defines the OpenStack userid. username : str, default is Undefined, optional - Username is required if using Identity V2 API. Consult with your provider's + username defines the username required if using Identity V2 API. Consult with your provider's control panel to discover your account's username. In Identity V3, either userid or a combination of username and domainId or domainName are needed @@ -11044,7 +11088,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0: refreshInterval?: str region: str - role: "Instance" | "instance" | "Hypervisor" | "hypervisor" + role: "Instance" | "Hypervisor" | "LoadBalancer" tlsConfig?: MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfig userid?: str @@ -11066,7 +11110,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0ApplicationCredentialSecret: r""" - The applicationCredentialSecret field is required if using an application + applicationCredentialSecret defines the required field if using an application credential to authenticate. Attributes @@ -11089,7 +11133,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0Applic schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0Password: r""" - Password for the Identity V2 and V3 APIs. Consult with your provider's + password defines the password for the Identity V2 and V3 APIs. Consult with your provider's control panel to discover your account's preferred method of authentication. Attributes @@ -11112,7 +11156,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0Passwo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfig: r""" - TLS configuration applying to the target HTTP endpoint. + tlsConfig defines the TLS configuration applying to the target HTTP endpoint. Attributes ---------- @@ -11121,19 +11165,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSCon cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfigCert @@ -11145,7 +11189,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -11159,7 +11203,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -11181,7 +11225,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -11203,7 +11247,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -11217,7 +11261,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -11239,7 +11283,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -11261,7 +11305,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSCon schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOpenstackSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -11289,17 +11333,21 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOvhcloudSDConfigsItems0: Attributes ---------- applicationKey : str, default is Undefined, required - Access key to use. https://api.ovh.com. + applicationKey defines the access key to use for OVHCloud API authentication. + This is obtained from the OVHCloud API credentials at https://api.ovh.com. applicationSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecOvhcloudSDConfigsItems0ApplicationSecret, default is Undefined, required application secret consumerKey : MonitoringCoreosComV1alpha1ScrapeConfigSpecOvhcloudSDConfigsItems0ConsumerKey, default is Undefined, required consumer key endpoint : str, default is Undefined, optional - Custom endpoint to be used. + endpoint defines a custom API endpoint to be used. + When not specified, defaults to the standard OVHCloud API endpoint for the region. refreshInterval : str, default is Undefined, optional - Refresh interval to re-read the resources list. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. service : str, default is Undefined, required - Service of the targets to retrieve. Must be `VPS` or `DedicatedServer`. + service defines the service type of the targets to retrieve. + Must be either `VPS` or `DedicatedServer` to specify which OVHCloud resources to discover. """ applicationKey: str @@ -11309,7 +11357,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOvhcloudSDConfigsItems0: endpoint?: str refreshInterval?: str - service: str + service: "VPS" | "DedicatedServer" check: len(applicationKey) >= 1 @@ -11318,7 +11366,8 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOvhcloudSDConfigsItems0: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOvhcloudSDConfigsItems0ApplicationSecret: r""" - SecretKeySelector selects a key of a Secret. + applicationSecret defines the secret key for OVHCloud API authentication. + This contains the application secret obtained during OVHCloud API credential creation. Attributes ---------- @@ -11340,7 +11389,8 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOvhcloudSDConfigsItems0Applica schema MonitoringCoreosComV1alpha1ScrapeConfigSpecOvhcloudSDConfigsItems0ConsumerKey: r""" - SecretKeySelector selects a key of a Secret. + consumerKey defines the consumer key for OVHCloud API authentication. + This is the third component of OVHCloud's three-key authentication system. Attributes ---------- @@ -11394,43 +11444,44 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0: basicAuth : MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0BasicAuth, default is Undefined, optional basic auth enableHTTP2 : bool, default is Undefined, optional - Configure whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. followRedirects : bool, default is Undefined, optional - Configure whether the HTTP requests should follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. includeParameters : bool, default is Undefined, optional - Whether to include the parameters as meta labels. + includeParameters defines whether to include the parameters as meta labels. Note: Enabling this exposes parameters in the Prometheus UI and API. Make sure that you don't have secrets exposed as parameters if you enable this. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. oauth2 : MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2, default is Undefined, optional oauth2 port : int, default is Undefined, optional - Port to scrape the metrics from. + port defines the port to scrape metrics from. If using the public IP address, this must proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. query : str, default is Undefined, required - Puppet Query Language (PQL) query. Only resources are supported. + query defines the Puppet Query Language (PQL) query. Only resources are supported. https://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html refreshInterval : str, default is Undefined, optional - Refresh interval to re-read the list of resources. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConfig, default is Undefined, optional tls config url : str, default is Undefined, required - The URL of the PuppetDB root query endpoint. + url defines the URL of the PuppetDB root query endpoint. """ authorization?: MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Authorization basicAuth?: MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0BasicAuth @@ -11452,7 +11503,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0: check: port <= 65535 if port not in [None, Undefined] port >= 0 if port not in [None, Undefined] - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(query) >= 1 _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval len(url) >= 1 @@ -11460,15 +11511,15 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Authorization: r""" - Optional `authorization` HTTP header configuration. - Cannot be set at the same time as `basicAuth`, or `oauth2`. + authorization defines the header configuration to authenticate against the DigitalOcean API. + Cannot be set at the same time as `oauth2`. Attributes ---------- credentials : MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0AuthorizationCredentials, default is Undefined, optional credentials $type : str, default is Undefined, optional - Defines the authentication type. The value is case-insensitive. + type defines the authentication type. The value is case-insensitive. "Basic" is not a supported value. @@ -11479,7 +11530,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Authori schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0AuthorizationCredentials: r""" - Selects a key of a Secret in the namespace that contains the credentials for authentication. + credentials defines a key of a Secret in the namespace that contains the credentials for authentication. Attributes ---------- @@ -11501,7 +11552,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Authori schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0BasicAuth: r""" - Optional HTTP basic authentication information. + basicAuth defines information to use on every scrape request. Cannot be set at the same time as `authorization`, or `oauth2`. Attributes @@ -11516,7 +11567,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0BasicAu schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0BasicAuthPassword: r""" - `password` specifies a key of a Secret containing the password for + password defines a key of a Secret containing the password for authentication. Attributes @@ -11539,7 +11590,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0BasicAu schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0BasicAuthUsername: r""" - `username` specifies a key of a Secret containing the username for + username defines a key of a Secret containing the username for authentication. Attributes @@ -11562,8 +11613,8 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0BasicAu schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2: r""" - Optional OAuth2.0 configuration. - Cannot be set at the same time as `basicAuth`, or `authorization`. + oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. + Cannot be set at the same time as `authorization`, or `basicAuth`. Attributes ---------- @@ -11572,31 +11623,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2: clientSecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2ClientSecret, default is Undefined, required client secret endpointParams : {str:str}, default is Undefined, optional - `endpointParams` configures the HTTP parameters to append to the token + endpointParams configures the HTTP parameters to append to the token URL. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. scopes : [str], default is Undefined, optional - `scopes` defines the OAuth2 scopes used for the token request. + scopes defines the OAuth2 scopes used for the token request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2TLSConfig, default is Undefined, optional tls config tokenUrl : str, default is Undefined, required - `tokenURL` configures the URL to fetch the token from. + tokenUrl defines the URL to fetch the token from. """ clientId: MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2ClientID @@ -11612,12 +11663,12 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2: tokenUrl: str check: - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl len(tokenUrl) >= 1 schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2ClientID: r""" - `clientId` specifies a key of a Secret or ConfigMap containing the + clientId defines a key of a Secret or ConfigMap containing the OAuth2 client's ID. Attributes @@ -11632,7 +11683,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2C schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2ClientIDConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -11654,7 +11705,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2C schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2ClientIDSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -11676,7 +11727,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2C schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2ClientSecret: r""" - `clientSecret` specifies a key of a Secret containing the OAuth2 + clientSecret defines a key of a Secret containing the OAuth2 client's secret. Attributes @@ -11721,7 +11772,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2P schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2TLSConfig: r""" - TLS configuration to use when connecting to the OAuth2 server. + tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server. It requires Prometheus >= v2.43.0. Attributes @@ -11731,19 +11782,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2T cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2TLSConfigCert @@ -11755,7 +11806,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2T schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -11769,7 +11820,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2T schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -11791,7 +11842,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2T schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -11813,7 +11864,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2T schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -11827,7 +11878,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2T schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -11849,7 +11900,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2T schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -11871,7 +11922,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2T schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0Oauth2TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -11915,7 +11966,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0ProxyCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConfig: r""" - TLS configuration to connect to the Puppet DB. + tlsConfig defines the TLS configuration to connect to the Consul API. Attributes ---------- @@ -11924,19 +11975,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConf cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConfigCert @@ -11948,7 +11999,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -11962,7 +12013,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -11984,7 +12035,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -12006,7 +12057,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -12020,7 +12071,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -12042,7 +12093,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -12064,7 +12115,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecPuppetDBSDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -12094,31 +12145,31 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecRelabelingsItems0: Attributes ---------- action : str, default is "replace", optional - Action to perform based on the regex matching. + action to perform based on the regex matching. `Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0. `DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0. Default: "Replace" modulus : int, default is Undefined, optional - Modulus to take of the hash of the source label values. + modulus to take of the hash of the source label values. Only applicable when the action is `HashMod`. regex : str, default is Undefined, optional - Regular expression against which the extracted value is matched. + regex defines the regular expression against which the extracted value is matched. replacement : str, default is Undefined, optional - Replacement value against which a Replace action is performed if the + replacement value against which a Replace action is performed if the regular expression matches. Regex capture groups are available. separator : str, default is Undefined, optional - Separator is the string between concatenated SourceLabels. + separator defines the string between concatenated SourceLabels. sourceLabels : [str], default is Undefined, optional - The source labels select values from existing labels. Their content is + sourceLabels defines the source labels select values from existing labels. Their content is concatenated using the configured Separator and matched against the configured regular expression. targetLabel : str, default is Undefined, optional - Label to which the resulting string is written in a replacement. + targetLabel defines the label to which the resulting string is written in a replacement. It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and `DropEqual` actions. @@ -12133,9 +12184,6 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecRelabelingsItems0: sourceLabels?: [str] targetLabel?: str - check: - all sourceLabels in sourceLabels {_regex_match(str(sourceLabels), r"^[a-zA-Z_][a-zA-Z0-9_]*$") if sourceLabels} if sourceLabels - schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0: r""" ScalewaySDConfig configurations allow retrieving scrape targets from Scaleway instances and baremetal services. @@ -12144,48 +12192,49 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0: Attributes ---------- accessKey : str, default is Undefined, required - Access key to use. https://console.scaleway.com/project/credentials + accessKey defines the access key to use. https://console.scaleway.com/project/credentials apiURL : str, default is Undefined, optional - API URL to use when doing the server listing requests. + apiURL defines the API URL to use when doing the server listing requests. enableHTTP2 : bool, default is Undefined, optional - Whether to enable HTTP2. + enableHTTP2 defines whether to enable HTTP2. followRedirects : bool, default is Undefined, optional - Configure whether HTTP requests follow HTTP 3xx redirects. + followRedirects defines whether HTTP requests follow HTTP 3xx redirects. nameFilter : str, default is Undefined, optional - NameFilter specify a name filter (works as a LIKE) to apply on the server listing request. + nameFilter defines a name filter (works as a LIKE) to apply on the server listing request. noProxy : str, default is Undefined, optional - `noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names + noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. port : int, default is Undefined, optional - The port to scrape metrics from. + port defines the port to scrape metrics from. If using the public IP address, this must projectID : str, default is Undefined, required - Project ID of the targets. + projectID defines the Project ID of the targets. proxyConnectHeader : {str:[MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0ProxyConnectHeaderItems0]}, default is Undefined, optional - ProxyConnectHeader optionally specifies headers to send to + proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests. - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyFromEnvironment : bool, default is Undefined, optional - Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). + proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY). - It requires Prometheus >= v2.43.0 or Alertmanager >= 0.25.0. + It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0. proxyUrl : str, default is Undefined, optional - `proxyURL` defines the HTTP proxy server to use. + proxyUrl defines the HTTP proxy server to use. refreshInterval : str, default is Undefined, optional - Refresh interval to re-read the list of instances. + refreshInterval defines the time after which the provided names are refreshed. + If not set, Prometheus uses its default value. role : str, default is Undefined, required - Service of the targets to retrieve. Must be `Instance` or `Baremetal`. + role defines the service of the targets to retrieve. Must be `Instance` or `Baremetal`. secretKey : MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0SecretKey, default is Undefined, required secret key tagsFilter : [str], default is Undefined, optional - TagsFilter specify a tag filter (a server needs to have all defined tags to be listed) to apply on the server listing request. + tagsFilter defines a tag filter (a server needs to have all defined tags to be listed) to apply on the server listing request. tlsConfig : MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConfig, default is Undefined, optional tls config zone : str, default is Undefined, optional - Zone is the availability zone of your targets (e.g. fr-par-1). + zone defines the availability zone of your targets (e.g. fr-par-1). """ accessKey: str @@ -12216,7 +12265,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0: port <= 65535 if port not in [None, Undefined] port >= 0 if port not in [None, Undefined] len(projectID) >= 1 - _regex_match(str(proxyUrl), r"^http(s)?://.+$") if proxyUrl + _regex_match(str(proxyUrl), r"^(http|https|socks5)://.+$") if proxyUrl _regex_match(str(refreshInterval), r"^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$") if refreshInterval len(tagsFilter) >= 1 if tagsFilter all tagsFilter in tagsFilter {len(tagsFilter) >= 1 if tagsFilter not in [None, Undefined]} if tagsFilter @@ -12246,7 +12295,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0ProxyCo schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0SecretKey: r""" - Secret key to use when listing targets. + secretKey defines the secret key to use when listing targets. Attributes ---------- @@ -12268,7 +12317,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0SecretK schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConfig: r""" - TLS configuration to use on every scrape request + tlsConfig defines the TLS configuration to connect to the Consul API. Attributes ---------- @@ -12277,19 +12326,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConf cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConfigCert @@ -12301,7 +12350,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -12315,7 +12364,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -12337,7 +12386,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -12359,7 +12408,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -12373,7 +12422,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -12395,7 +12444,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -12417,7 +12466,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConf schema MonitoringCoreosComV1alpha1ScrapeConfigSpecScalewaySDConfigsItems0TLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -12445,9 +12494,9 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecStaticConfigsItems0: Attributes ---------- labels : {str:str}, default is Undefined, optional - Labels assigned to all metrics scraped from the targets. + labels defines labels assigned to all metrics scraped from the targets. targets : [str], default is Undefined, required - List of targets for this static configuration. + targets defines the list of targets for this static configuration. """ labels?: {str:str} targets: [str] @@ -12457,7 +12506,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecStaticConfigsItems0: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfig: r""" - TLS configuration to use on every scrape request + tlsConfig defines the TLS configuration to use on every scrape request Attributes ---------- @@ -12466,19 +12515,19 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfig: cert : MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCert, default is Undefined, optional cert insecureSkipVerify : bool, default is Undefined, optional - Disable target certificate validation. + insecureSkipVerify defines how to disable target certificate validation. keySecret : MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigKeySecret, default is Undefined, optional key secret maxVersion : str, default is Undefined, optional - Maximum acceptable TLS version. + maxVersion defines the maximum acceptable TLS version. - It requires Prometheus >= v2.41.0. + It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0. minVersion : str, default is Undefined, optional - Minimum acceptable TLS version. + minVersion defines the minimum acceptable TLS version. - It requires Prometheus >= v2.35.0. + It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0. serverName : str, default is Undefined, optional - Used to verify the hostname for the targets. + serverName is used to verify the hostname for the targets. """ ca?: MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCa cert?: MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCert @@ -12490,7 +12539,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfig: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCa: r""" - Certificate authority used when verifying server certificates. + ca defines the Certificate authority used when verifying server certificates. Attributes ---------- @@ -12504,7 +12553,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCa: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCaConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -12526,7 +12575,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCaConfigMap: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCaSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -12548,7 +12597,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCaSecret: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCert: r""" - Client certificate to present when doing client-authentication. + cert defines the Client certificate to present when doing client-authentication. Attributes ---------- @@ -12562,7 +12611,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCert: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCertConfigMap: r""" - ConfigMap containing data to use for the targets. + configMap defines the ConfigMap containing data to use for the targets. Attributes ---------- @@ -12584,7 +12633,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCertConfigMap: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCertSecret: r""" - Secret containing data to use for the targets. + secret defines the Secret containing data to use for the targets. Attributes ---------- @@ -12606,7 +12655,7 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigCertSecret: schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigKeySecret: r""" - Secret containing the client key file for the targets. + keySecret defines the Secret containing the client key file for the targets. Attributes ---------- @@ -12626,3 +12675,85 @@ schema MonitoringCoreosComV1alpha1ScrapeConfigSpecTLSConfigKeySecret: name?: str = "" optional?: bool +schema MonitoringCoreosComV1alpha1ScrapeConfigStatus: + r""" + status defines the status subresource. It is under active development and is updated only when the + "StatusForConfigurationResources" feature gate is enabled. + + Most recent observed status of the ScrapeConfig. Read-only. + More info: + https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status + + Attributes + ---------- + bindings : [MonitoringCoreosComV1alpha1ScrapeConfigStatusBindingsItems0], default is Undefined, optional + bindings defines the list of workload resources (Prometheus, PrometheusAgent, ThanosRuler or Alertmanager) which select the configuration resource. + """ + bindings?: [MonitoringCoreosComV1alpha1ScrapeConfigStatusBindingsItems0] + +schema MonitoringCoreosComV1alpha1ScrapeConfigStatusBindingsItems0: + r""" + WorkloadBinding is a link between a configuration resource and a workload resource. + + Attributes + ---------- + conditions : [MonitoringCoreosComV1alpha1ScrapeConfigStatusBindingsItems0ConditionsItems0], default is Undefined, optional + conditions defines the current state of the configuration resource when bound to the referenced Workload object. + group : str, default is Undefined, required + group defines the group of the referenced resource. + name : str, default is Undefined, required + name defines the name of the referenced object. + namespace : str, default is Undefined, required + namespace defines the namespace of the referenced object. + resource : str, default is Undefined, required + resource defines the type of resource being referenced (e.g. Prometheus, PrometheusAgent, ThanosRuler or Alertmanager). + """ + conditions?: [MonitoringCoreosComV1alpha1ScrapeConfigStatusBindingsItems0ConditionsItems0] + group: "monitoring.coreos.com" + + name: str + + namespace: str + + resource: "prometheuses" | "prometheusagents" | "thanosrulers" | "alertmanagers" + + check: + len(name) >= 1 + len(namespace) >= 1 + +schema MonitoringCoreosComV1alpha1ScrapeConfigStatusBindingsItems0ConditionsItems0: + r""" + ConfigResourceCondition describes the status of configuration resources linked to Prometheus, PrometheusAgent, Alertmanager or ThanosRuler. + + Attributes + ---------- + lastTransitionTime : str, default is Undefined, required + lastTransitionTime defines the time of the last update to the current status property. + message : str, default is Undefined, optional + message defines the human-readable message indicating details for the condition's last transition. + observedGeneration : int, default is Undefined, optional + observedGeneration defines the .metadata.generation that the + condition was set based upon. For instance, if `.metadata.generation` is + currently 12, but the `.status.conditions[].observedGeneration` is 9, the + condition is out of date with respect to the current state of the object. + reason : str, default is Undefined, optional + reason for the condition's last transition. + status : str, default is Undefined, required + status of the condition. + $type : str, default is Undefined, required + type of the condition being reported. + Currently, only "Accepted" is supported. + """ + lastTransitionTime: str + + message?: str + observedGeneration?: int + reason?: str + status: str + + $type: "Accepted" + + check: + len(status) >= 1 + len($type) >= 1 + diff --git a/docs/examples/src/charts/kube_prometheus_stack/chart.k b/docs/examples/src/charts/kube_prometheus_stack/chart.k index 8946d21a..8190509b 100644 --- a/docs/examples/src/charts/kube_prometheus_stack/chart.k +++ b/docs/examples/src/charts/kube_prometheus_stack/chart.k @@ -14,10 +14,10 @@ schema Chart(helm.Chart): values : Values | any, optional chart : str, required, default is "kube-prometheus-stack" repoURL : str, required, default is "https://prometheus-community.github.io/helm-charts" - targetRevision : str, optional, default is "69.8.2" + targetRevision : str, optional, default is "80.4.1" """ values?: Values | any chart: str = "kube-prometheus-stack" repoURL: str = "https://prometheus-community.github.io/helm-charts" - targetRevision?: str = "69.8.2" + targetRevision?: str = "80.4.1" diff --git a/docs/examples/src/charts/kube_prometheus_stack/values.schema.json b/docs/examples/src/charts/kube_prometheus_stack/values.schema.json index 927fe7bf..ad316aac 100644 --- a/docs/examples/src/charts/kube_prometheus_stack/values.schema.json +++ b/docs/examples/src/charts/kube_prometheus_stack/values.schema.json @@ -171,10 +171,26 @@ "additionalProperties": true, "description": "# Configuration for alertmanager\n# ref: https://prometheus.io/docs/alerting/alertmanager/\n#", "properties": { + "additionalLabels": { + "additionalProperties": true, + "description": "# Additional labels for Alertmanager\n#", + "required": [], + "title": "additionalLabels", + "type": "object" + }, "alertmanagerSpec": { "additionalProperties": true, "description": "# Settings affecting alertmanagerSpec\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#alertmanagerspec\n#", "properties": { + "additionalArgs": { + "description": "# Additional command line arguments to pass to Alertmanager (in addition to those generated by the chart)", + "items": { + "required": [] + }, + "required": [], + "title": "additionalArgs", + "type": "array" + }, "additionalConfig": { "additionalProperties": true, "description": "# Additional configuration which is not covered by the properties above. (passed through tpl)", @@ -200,7 +216,7 @@ }, "affinity": { "additionalProperties": true, - "description": "# Assign custom affinity rules to the alertmanager instance\n# ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n#", + "description": "# Assign custom affinity rules to the alertmanager instance\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/\n#", "required": [], "title": "affinity", "type": "object" @@ -249,7 +265,7 @@ }, "clusterGossipInterval": { "default": "", - "description": "# clusterGossipInterval determines interval between gossip attempts.\n# Needs to be specified as GoDuration, a time duration that can be parsed by Go’s time.ParseDuration() (e.g. 45ms, 30s, 1m, 1h20m15s)", + "description": "# clusterGossipInterval determines interval between gossip attempts.\n# Needs to be specified as GoDuration, a time duration that can be parsed by Go's time.ParseDuration() (e.g. 45ms, 30s, 1m, 1h20m15s)", "required": [], "title": "clusterGossipInterval", "type": "string" @@ -263,14 +279,14 @@ }, "clusterPeerTimeout": { "default": "", - "description": "# clusterPeerTimeout determines timeout for cluster peering.\n# Needs to be specified as GoDuration, a time duration that can be parsed by Go’s time.ParseDuration() (e.g. 45ms, 30s, 1m, 1h20m15s)", + "description": "# clusterPeerTimeout determines timeout for cluster peering.\n# Needs to be specified as GoDuration, a time duration that can be parsed by Go's time.ParseDuration() (e.g. 45ms, 30s, 1m, 1h20m15s)", "required": [], "title": "clusterPeerTimeout", "type": "string" }, "clusterPushpullInterval": { "default": "", - "description": "# clusterPushpullInterval determines interval between pushpull attempts.\n# Needs to be specified as GoDuration, a time duration that can be parsed by Go’s time.ParseDuration() (e.g. 45ms, 30s, 1m, 1h20m15s)", + "description": "# clusterPushpullInterval determines interval between pushpull attempts.\n# Needs to be specified as GoDuration, a time duration that can be parsed by Go's time.ParseDuration() (e.g. 45ms, 30s, 1m, 1h20m15s)", "required": [], "title": "clusterPushpullInterval", "type": "string" @@ -293,6 +309,20 @@ "title": "containers", "type": "array" }, + "dnsConfig": { + "additionalProperties": true, + "description": "# DNS configuration for Alertmanager.\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.PodDNSConfig", + "required": [], + "title": "dnsConfig", + "type": "object" + }, + "dnsPolicy": { + "default": "", + "description": "# DNS policy for Alertmanager.\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#dnspolicystring-alias", + "required": [], + "title": "dnsPolicy", + "type": "string" + }, "externalUrl": { "default": "", "description": "# The external URL the Alertmanager instances will be available under. This is necessary to generate correct URLs. This is necessary if Alertmanager is not served from root of a DNS name. string false\n#", @@ -311,6 +341,12 @@ "additionalProperties": true, "description": "# Image of Alertmanager\n#", "properties": { + "pullPolicy": { + "default": "IfNotPresent", + "required": [], + "title": "pullPolicy", + "type": "string" + }, "registry": { "default": "quay.io", "required": [], @@ -330,7 +366,7 @@ "type": "string" }, "tag": { - "default": "v0.28.1", + "default": "v0.29.0", "required": [], "title": "tag", "type": "string" @@ -379,7 +415,7 @@ }, "nodeSelector": { "additionalProperties": true, - "description": "# Define which Nodes the Pods are scheduled on.\n# ref: https://kubernetes.io/docs/user-guide/node-selection/\n#", + "description": "# Define which Nodes the Pods are scheduled on.\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector\n#", "required": [], "title": "nodeSelector", "type": "object" @@ -442,7 +478,7 @@ }, "resources": { "additionalProperties": true, - "description": "# Define resources requests and limits for single Pods.\n# ref: https://kubernetes.io/docs/user-guide/compute-resources/\n#", + "description": "# Define resources requests and limits for single Pods.\n# ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n#", "required": [], "title": "resources", "type": "object" @@ -524,6 +560,13 @@ "title": "securityContext", "type": "object" }, + "serviceName": { + "default": "", + "description": "#", + "required": [], + "title": "serviceName", + "type": "null" + }, "storage": { "additionalProperties": true, "description": "# Storage is the definition of how storage will be used by the Alertmanager instances.\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/platform/storage.md\n#", @@ -533,13 +576,13 @@ }, "tlsConfig": { "additionalProperties": true, - "description": "# tlsConfig: TLS configuration to use when connect to the endpoint. For example if using istio mTLS.\n# Of type: https://github.com/coreos/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig", + "description": "# tlsConfig: TLS configuration to use when connect to the endpoint. For example if using istio mTLS.\n# Of type: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig", "required": [], "title": "tlsConfig", "type": "object" }, "tolerations": { - "description": "# If specified, the pod's tolerations.\n# ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/\n#", + "description": "# If specified, the pod's tolerations.\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/\n#", "items": { "required": [] }, @@ -548,7 +591,7 @@ "type": "array" }, "topologySpreadConstraints": { - "description": "# If specified, the pod's topology spread constraints.\n# ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/\n#", + "description": "# If specified, the pod's topology spread constraints.\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/\n#", "items": { "required": [] }, @@ -602,7 +645,7 @@ }, "apiVersion": { "default": "v2", - "description": "# Api that prometheus will use to communicate with alertmanager. Possible values are v1, v2\n#", + "description": "# API that Prometheus will use to communicate with alertmanager. Possible values are v1, v2\n#", "required": [], "title": "apiVersion", "type": "string" @@ -814,7 +857,6 @@ "properties": { "annotations": { "additionalProperties": true, - "description": "For Kubernetes \u003e= 1.18 you should specify the ingress-controller via the field ingressClassName\nSee https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress\ningressClassName: nginx", "required": [], "title": "annotations", "type": "object" @@ -834,6 +876,12 @@ "title": "hosts", "type": "array" }, + "ingressClassName": { + "default": "", + "required": [], + "title": "ingressClassName", + "type": "string" + }, "labels": { "additionalProperties": true, "required": [], @@ -869,7 +917,6 @@ "properties": { "annotations": { "additionalProperties": true, - "description": "For Kubernetes \u003e= 1.18 you should specify the ingress-controller via the field ingressClassName\nSee https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress\ningressClassName: nginx", "required": [], "title": "annotations", "type": "object" @@ -894,6 +941,12 @@ "title": "hostPrefix", "type": "string" }, + "ingressClassName": { + "default": "", + "required": [], + "title": "ingressClassName", + "type": "string" + }, "labels": { "additionalProperties": true, "required": [], @@ -943,6 +996,13 @@ "title": "ingressPerReplica", "type": "object" }, + "namespaceOverride": { + "default": "", + "description": "Optional: Override the namespace where Alertmanager will be deployed.", + "required": [], + "title": "namespaceOverride", + "type": "string" + }, "networkPolicy": { "additionalProperties": true, "description": "# Network Policy configuration\n#", @@ -1066,17 +1126,18 @@ "title": "enabled", "type": "boolean" }, - "maxUnavailable": { - "default": "", - "required": [], - "title": "maxUnavailable", - "type": "string" - }, "minAvailable": { "default": 1, "required": [], "title": "minAvailable", "type": "integer" + }, + "unhealthyPodEvictionPolicy": { + "default": "AlwaysAllow", + "description": "maxUnavailable: \"\"", + "required": [], + "title": "unhealthyPodEvictionPolicy", + "type": "string" } }, "required": [], @@ -1085,7 +1146,7 @@ }, "route": { "additionalProperties": true, - "description": "BETA: Configure the gateway routes for the chart here.\nMore routes can be added by adding a dictionary key like the 'main' route.\nBe aware that this is an early beta of this feature,\nkube-prometheus-stack does not guarantee this works and is subject to change.\nBeing BETA this can/will change in the future without notice, do not use unless you want to take that risk\n[[ref]](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io%2fv1alpha2)", + "description": "BETA: Configure the gateway routes for the chart here.\nMore routes can be added by adding a dictionary key like the 'main' route.\nBe aware that this is an early beta of this feature,\nkube-prometheus-stack does not guarantee this works and is subject to change.\nBeing BETA this can/will change in the future without notice, do not use unless you want to take that risk\n[[ref]](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io%2fv1alpha2)", "properties": { "main": { "additionalProperties": true, @@ -1247,6 +1308,12 @@ "title": "clusterIP", "type": "string" }, + "enabled": { + "default": true, + "required": [], + "title": "enabled", + "type": "boolean" + }, "externalIPs": { "items": { "required": [] @@ -1523,7 +1590,7 @@ }, "tlsConfig": { "additionalProperties": true, - "description": "# tlsConfig: TLS configuration to use when scraping the endpoint. For example if using istio mTLS.\n# Of type: https://github.com/coreos/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig", + "description": "# tlsConfig: TLS configuration to use when scraping the endpoint. For example if using istio mTLS.\n# Of type: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig", "required": [], "title": "tlsConfig", "type": "object" @@ -1600,7 +1667,7 @@ }, "stringConfig": { "default": "", - "description": "# Alertmanager configuration directives (as string type, preferred over the config hash map)\n# stringConfig will be used only, if tplConfig is true\n# ref: https://prometheus.io/docs/alerting/configuration/#configuration-file\n# https://prometheus.io/webtools/alerting/routing-tree-editor/\n#", + "description": "# Alertmanager configuration directives (as string type, preferred over the config hash map)\n# stringConfig will be used only if tplConfig is true\n# ref: https://prometheus.io/docs/alerting/configuration/#configuration-file\n# https://prometheus.io/webtools/alerting/routing-tree-editor/\n#", "required": [], "title": "stringConfig", "type": "string" @@ -2003,11 +2070,11 @@ }, "upgradeJob": { "additionalProperties": true, - "description": "# The CRD upgrade job mitigates the limitation of helm not being able to upgrade CRDs.\n# The job will apply the CRDs to the cluster before the operator is deployed, using helm hooks.\n# It deploy a corresponding clusterrole, clusterrolebinding and serviceaccount to apply the CRDs.\n# This feature is in preview, off by default and may change in the future.", + "description": "# The CRD upgrade job mitigates the limitation of helm not being able to upgrade CRDs.\n# The job will apply the CRDs to the cluster before the operator is deployed, using helm hooks.\n# It deploys a corresponding clusterrole, clusterrolebinding and serviceaccount to apply the CRDs.\n# This feature is in preview, off by default and may change in the future.", "properties": { "affinity": { "additionalProperties": true, - "description": "# Assign custom affinity rules to the upgrade-crd job\n# ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n#", + "description": "# Assign custom affinity rules to the upgrade-crd job\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/\n#", "required": [], "title": "affinity", "type": "object" @@ -2186,7 +2253,7 @@ }, "nodeSelector": { "additionalProperties": true, - "description": "# Define which Nodes the Pods are scheduled on.\n# ref: https://kubernetes.io/docs/user-guide/node-selection/\n#", + "description": "# Define which Nodes the Pods are scheduled on.\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector\n#", "required": [], "title": "nodeSelector", "type": "object" @@ -2254,7 +2321,7 @@ }, "resources": { "additionalProperties": true, - "description": "# Define resources requests and limits for single Pods.\n# ref: https://kubernetes.io/docs/user-guide/compute-resources/\n#", + "description": "# Define resources requests and limits for single Pods.\n# ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n#", "required": [], "title": "resources", "type": "object" @@ -2299,7 +2366,7 @@ "type": "object" }, "tolerations": { - "description": "# If specified, the pod's tolerations.\n# ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/\n#", + "description": "# If specified, the pod's tolerations.\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/\n#", "items": { "required": [] }, @@ -2308,7 +2375,7 @@ "type": "array" }, "topologySpreadConstraints": { - "description": "# If specified, the pod's topology spread constraints.\n# ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/\n#", + "description": "# If specified, the pod's topology spread constraints.\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/\n#", "items": { "required": [] }, @@ -2346,16 +2413,38 @@ "properties": { "config": { "additionalProperties": true, - "description": "Add (Cluster)Role permissions to list/watch the customResources defined in the config to rbac.extraRules", + "description": "Definition of the CustomResourceStateMetrics. Add (Cluster)Role permissions to list/watch the resources defined in the config to rbac.extraRules.", "required": [], "title": "config", "type": "object" }, + "create": { + "default": true, + "description": "Whether to create the ConfigMap that holds the config.", + "required": [], + "title": "create", + "type": "boolean" + }, "enabled": { "default": false, + "description": "Whether to enable support for CustomResourceStateMetrics.", "required": [], "title": "enabled", "type": "boolean" + }, + "key": { + "default": "config.yaml", + "description": "ConfigMap key that holds the config.", + "required": [], + "title": "key", + "type": "string" + }, + "name": { + "default": "", + "description": "Name of the ConfigMap that holds the config. If empty, name will be generated based on the release name.", + "required": [], + "title": "name", + "type": "string" } }, "required": [], @@ -2364,7 +2453,7 @@ }, "customRules": { "additionalProperties": true, - "description": "# custom Rules to override \"for\" and \"severity\" in defaultRules\n#", + "description": "# Custom rules to override \"for\" and \"severity\" in defaultRules\n#", "required": [], "title": "customRules", "type": "object" @@ -2518,6 +2607,13 @@ "title": "datasources", "type": "object" }, + "defaultCurlOptions": { + "default": "-skf", + "description": "# Configure how curl fetches remote dashboards. The beginning dash is required.\n# NOTE: This sets the default short flags for all dashboards, but these\n# defaults can be overridden individually for each dashboard by setting\n# curlOptions. See the example dashboards section below.\n#\n# -s - silent mode\n# -k - allow insecure (eg: non-TLS) connections\n# -f - fail fast\n# See the curl documentation for additional options\n#", + "required": [], + "title": "defaultCurlOptions", + "type": "string" + }, "defaultRules": { "additionalProperties": true, "description": "# Create default rules for monitoring the cluster\n#", @@ -2539,7 +2635,7 @@ }, "additionalRuleGroupAnnotations": { "additionalProperties": true, - "description": "# Additional annotations for specific PrometheusRule alerts groups", + "description": "# Additional annotations for specific PrometheusRule alert groups", "properties": { "alertmanager": { "additionalProperties": true, @@ -2953,6 +3049,13 @@ "title": "annotations", "type": "object" }, + "appNamespacesOperator": { + "default": "=~", + "description": "Defines the operator for namespace selection in rules\nUse \"=~\" to include namespaces matching the pattern (default)\nUse \"!~\" to exclude namespaces matching the pattern", + "required": [], + "title": "appNamespacesOperator", + "type": "string" + }, "appNamespacesTarget": { "default": ".*", "description": "# Reduce app namespace alert scope", @@ -3248,11 +3351,11 @@ "type": "object" }, "dnsPolicy": { - "default": "~", - "description": "dns configuration for pod", + "default": "ClusterFirst", + "description": "# dnsPolicy allows to change the default DNS configuration for the pod\n# Ref: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy", "required": [], "title": "dnsPolicy", - "type": "null" + "type": "string" }, "downloadDashboards": { "additionalProperties": true, @@ -3397,12 +3500,15 @@ "env": { "additionalProperties": true, "description": "Additional environment variables that will be passed to the daemonset", + "items": { + "required": [] + }, "required": [], "title": "env", "type": "object" }, "envFromConfigMaps": { - "description": "# The names of conifgmaps in the same kubernetes namespace which contain values to be added to the environment\n# Each entry should contain a name key, and can optionally specify whether the configmap must be defined with an optional key.\n# Name is templated.\n# ref: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#configmapenvsource-v1-core", + "description": "# The names of configmaps in the same kubernetes namespace which contain values to be added to the environment\n# Each entry should contain a name key, and can optionally specify whether the configmap must be defined with an optional key.\n# Name is templated.\n# ref: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#configmapenvsource-v1-core", "items": { "required": [] }, @@ -3546,16 +3652,17 @@ "type": "object" }, "extraManifests": { - "description": "# Extra manifests to deploy as an array", + "default": "null", + "description": "# Extra manifests to deploy. Can be of type dict or list.\n# If dict, keys are ignored and only values are used.\n# Items contained within extraObjects can be defined as dict or string and are passed through tpl.", "items": { "required": [] }, "required": [], "title": "extraManifests", - "type": "array" + "type": "null" }, "extraObjects": { - "description": "Create a dynamic manifests via values:", + "description": "extraObjects could be utilized to add dynamic manifests via values", "items": { "additionalProperties": true, "properties": { @@ -3678,7 +3785,7 @@ }, "imageRegistry": { "default": "", - "description": "# Global image registry to use if it needs to be overriden for some specific use cases (e.g local registries, custom images, ...)\n#", + "description": "# Global image registry to use if it needs to be overridden for some specific use cases (e.g. local registries, custom images, ...)\n#", "required": [], "title": "imageRegistry", "type": "string" @@ -3698,18 +3805,6 @@ "required": [], "title": "createAggregateClusterRoles", "type": "boolean" - }, - "pspAnnotations": { - "additionalProperties": true, - "required": [], - "title": "pspAnnotations", - "type": "object" - }, - "pspEnabled": { - "default": false, - "required": [], - "title": "pspEnabled", - "type": "boolean" } }, "required": [], @@ -3732,7 +3827,7 @@ "description": "# Using default values from https://github.com/grafana/helm-charts/blob/main/charts/grafana/values.yaml\n#", "properties": { "additionalDataSources": { - "description": "# Configure additional grafana datasources (passed through tpl)\n# ref: http://docs.grafana.org/administration/provisioning/#datasources", + "description": "# Configure additional grafana datasources (passed through tpl)\n# ref: https://grafana.com/docs/grafana/latest/administration/provisioning/#datasources", "items": { "required": [] }, @@ -3740,14 +3835,37 @@ "title": "additionalDataSources", "type": "array" }, - "adminPassword": { - "default": "prom-operator", + "admin": { + "additionalProperties": true, + "description": "Use an existing secret for the admin user.", + "properties": { + "existingSecret": { + "default": "", + "description": "# Name of the secret. Can be templated.", + "required": [], + "title": "existingSecret", + "type": "string" + }, + "passwordKey": { + "default": "admin-password", + "required": [], + "title": "passwordKey", + "type": "string" + }, + "userKey": { + "default": "admin-user", + "required": [], + "title": "userKey", + "type": "string" + } + }, "required": [], - "title": "adminPassword", - "type": "string" + "title": "admin", + "type": "object" }, "adminUser": { "default": "admin", + "description": "Administrator credentials when not using an existing secret (see below)", "required": [], "title": "adminUser", "type": "string" @@ -3876,9 +3994,53 @@ "title": "namespaceOverride", "type": "string" }, + "operator": { + "additionalProperties": true, + "description": "# Deploy GrafanaDashboard CRDs that reference dashboards from ConfigMaps when grafana-operator is used\n# These settings control how dashboards are integrated with the Grafana Operator\n# Note: End user still need to create is own kind: GrafanaDataSource for Prometheus\n# eg:\n# apiVersion: grafana.integreatly.org/v1beta1\n# kind: GrafanaDatasource\n# metadata:\n# name: prometheus\n# annotations: {}\n# spec:\n# allowCrossNamespaceImport: true\n# instanceSelector:\n# matchLabels:\n# app: grafana\n# datasource:\n# name: prometheus\n# type: prometheus\n# access: proxy\n# url: http://prometheus-operated.prometheus-stack.svc.cluster.local:9090\n# isDefault: true\n# jsonData:\n# \"tlsSkipVerify\": true\n# \"timeInterval\": \"5s\"\n#", + "properties": { + "annotations": { + "additionalProperties": true, + "description": "# Annotations for GrafanaDashboard Cr\n#", + "required": [], + "title": "annotations", + "type": "object" + }, + "dashboardsConfigMapRefEnabled": { + "default": false, + "description": "# Enable references to ConfigMaps containing dashboards in GrafanaDashboard CRs\n# Set to true to allow dashboards to be loaded from ConfigMap references", + "required": [], + "title": "dashboardsConfigMapRefEnabled", + "type": "boolean" + }, + "folder": { + "default": "General", + "description": "# Which folder all ddashboard in Grafana General means on Root level\n#", + "required": [], + "title": "folder", + "type": "string" + }, + "matchLabels": { + "additionalProperties": true, + "description": "# Labels that should be matched kind: Grafana instance\n# Example: { app: grafana, category: dashboard }\n#", + "required": [], + "title": "matchLabels", + "type": "object" + }, + "resyncPeriod": { + "default": "10m", + "description": "# How frequently the operator should resync resources (in duration format)\n# Controls how often dashboards are reconciled by the operator\n#", + "required": [], + "title": "resyncPeriod", + "type": "string" + } + }, + "required": [], + "title": "operator", + "type": "object" + }, "prune": { "default": false, - "description": "Flag to mark provisioned data sources for deletion if they are no longer configured.\nIt takes no effect if data sources are already listed in the deleteDatasources section.\nref: https://grafana.com/docs/grafana/latest/administration/provisioning/#example-data-source-config-file", + "description": "Flag to mark provisioned data sources for deletion if they are no longer configured.\nIt takes no effect if data sources are already listed in the deleteDatasources section.\nref: https://grafana.com/docs/grafana/latest/administration/provisioning/#example-data-source-configuration-file", "required": [], "title": "prune", "type": "boolean" @@ -3953,7 +4115,7 @@ "properties": { "enabled": { "default": true, - "description": "If true, a ServiceMonitor CRD is created for a prometheus operator\nhttps://github.com/coreos/prometheus-operator\n", + "description": "If true, a ServiceMonitor CRD is created for a prometheus operator\nhttps://github.com/prometheus-operator/prometheus-operator\n", "required": [], "title": "enabled", "type": "boolean" @@ -4162,7 +4324,7 @@ }, "createPrometheusReplicasDatasources": { "default": false, - "description": "# Create datasource for each Pod of Prometheus StatefulSet;\n# this uses headless service `prometheus-operated` which is\n# created by Prometheus Operator\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/0fee93e12dc7c2ea1218f19ae25ec6b893460590/pkg/prometheus/statefulset.go#L255-L286", + "description": "# Create datasource for each Pod of Prometheus StatefulSet;\n# this uses by default the headless service `prometheus-operated` which is\n# created by Prometheus Operator. In case you deployed your own Service for your\n# Prometheus instance, you can specify it with the field `prometheusServiceName`\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/0fee93e12dc7c2ea1218f19ae25ec6b893460590/pkg/prometheus/statefulset.go#L255-L286", "required": [], "title": "createPrometheusReplicasDatasources", "type": "boolean" @@ -4217,6 +4379,12 @@ "title": "name", "type": "string" }, + "prometheusServiceName": { + "default": "prometheus-operated", + "required": [], + "title": "prometheusServiceName", + "type": "string" + }, "uid": { "default": "prometheus", "required": [], @@ -4808,6 +4976,15 @@ "title": "pullPolicy", "type": "string" }, + "pullSecrets": { + "description": "image-renderer Image pull secrets (optional)", + "items": { + "required": [] + }, + "required": [], + "title": "pullSecrets", + "type": "array" + }, "registry": { "default": "docker.io", "description": "The Docker registry", @@ -5262,12 +5439,27 @@ "required": [], "title": "add", "type": "array" + }, + "drop": { + "items": { + "required": [], + "type": "string" + }, + "required": [], + "title": "drop", + "type": "array" } }, "required": [], "title": "capabilities", "type": "object" }, + "readOnlyRootFilesystem": { + "default": false, + "required": [], + "title": "readOnlyRootFilesystem", + "type": "boolean" + }, "runAsNonRoot": { "default": false, "required": [], @@ -5317,12 +5509,6 @@ "additionalProperties": true, "description": "# Configuration for kube-state-metrics subchart\n#", "properties": { - "namespaceOverride": { - "default": "", - "required": [], - "title": "namespaceOverride", - "type": "string" - }, "prometheus": { "additionalProperties": true, "properties": { @@ -5331,91 +5517,42 @@ "properties": { "enabled": { "default": true, - "description": "# Enable scraping via service monitor\n# Disable to prevent duplication if you enable prometheusScrape above\n#", + "description": "# Enable scraping via service monitor\n# Disable to prevent duplication if you enable prometheusScrape above", "required": [], "title": "enabled", "type": "boolean" }, - "honorLabels": { - "default": true, - "description": "Keep labels from scraped data, overriding server-side labels\n#", - "required": [], - "title": "honorLabels", - "type": "boolean" - }, - "interval": { - "default": "", - "description": "# Scrape interval. If not set, the Prometheus default scrape interval is used.\n#", - "required": [], - "title": "interval", - "type": "string" - }, - "labelLimit": { - "default": 0, - "description": "# Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.\n#", - "required": [], - "title": "labelLimit", - "type": "integer" - }, - "labelNameLengthLimit": { - "default": 0, - "description": "# Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.\n#", - "required": [], - "title": "labelNameLengthLimit", - "type": "integer" - }, - "labelValueLengthLimit": { - "default": 0, - "description": "# Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.\n#", - "required": [], - "title": "labelValueLengthLimit", - "type": "integer" - }, - "metricRelabelings": { - "description": "# MetricRelabelConfigs to apply to samples after scraping, but before ingestion.\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#relabelconfig\n#", - "items": { - "required": [] + "http": { + "additionalProperties": true, + "description": "# kube-state-metrics endpoint", + "properties": { + "honorLabels": { + "default": true, + "description": "# Keep labels from scraped data, overriding server-side labels", + "required": [], + "title": "honorLabels", + "type": "boolean" + } }, "required": [], - "title": "metricRelabelings", - "type": "array" - }, - "proxyUrl": { - "default": "", - "description": "# proxyUrl: URL of a proxy that should be used for scraping.\n#", - "required": [], - "title": "proxyUrl", - "type": "string" + "title": "http", + "type": "object" }, - "relabelings": { - "description": "# RelabelConfigs to apply to samples before scraping\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#relabelconfig\n#", - "items": { - "required": [] + "metrics": { + "additionalProperties": true, + "description": "# selfMonitor endpoint", + "properties": { + "honorLabels": { + "default": true, + "description": "# Keep labels from scraped data, overriding server-side labels", + "required": [], + "title": "honorLabels", + "type": "boolean" + } }, "required": [], - "title": "relabelings", - "type": "array" - }, - "sampleLimit": { - "default": 0, - "description": "# SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.\n#", - "required": [], - "title": "sampleLimit", - "type": "integer" - }, - "scrapeTimeout": { - "default": "", - "description": "# Scrape Timeout. If not set, the Prometheus default scrape timeout is used.\n#", - "required": [], - "title": "scrapeTimeout", - "type": "string" - }, - "targetLimit": { - "default": 0, - "description": "# TargetLimit defines a limit on the number of scraped targets that will be accepted.\n#", - "required": [], - "title": "targetLimit", - "type": "integer" + "title": "metrics", + "type": "object" } }, "required": [], @@ -5434,39 +5571,12 @@ "title": "prometheusScrape", "type": "boolean" }, - "rbac": { - "additionalProperties": true, - "properties": { - "create": { - "default": true, - "required": [], - "title": "create", - "type": "boolean" - } - }, - "required": [], - "title": "rbac", - "type": "object" - }, "releaseLabel": { "default": true, + "description": "# set to true to add the release label so scraping of the servicemonitor with kube-prometheus-stack works out of the box", "required": [], "title": "releaseLabel", "type": "boolean" - }, - "selfMonitor": { - "additionalProperties": true, - "properties": { - "enabled": { - "default": false, - "required": [], - "title": "enabled", - "type": "boolean" - } - }, - "required": [], - "title": "selfMonitor", - "type": "object" } }, "required": [], @@ -5545,7 +5655,7 @@ "type": "string" }, "regex": { - "default": "(etcd_request|apiserver_request_slo|apiserver_request_sli|apiserver_request)_duration_seconds_bucket;(0\\.15|0\\.2|0\\.3|0\\.35|0\\.4|0\\.45|0\\.6|0\\.7|0\\.8|0\\.9|1\\.25|1\\.5|1\\.75|2|3|3\\.5|4|4\\.5|6|7|8|9|15|20|30|40|45|50)(\\.0)?", + "default": "(etcd_request|apiserver_request_slo|apiserver_request_sli|apiserver_request)_duration_seconds_bucket;(0\\.15|0\\.2|0\\.3|0\\.35|0\\.4|0\\.45|0\\.6|0\\.7|0\\.8|0\\.9|1\\.25|1\\.5|1\\.75|2|3|3\\.5|4|4\\.5|6|7|8|9|15|20|40|45|50)(\\.0)?", "required": [], "title": "regex", "type": "string" @@ -5683,6 +5793,13 @@ "title": "endpoints", "type": "array" }, + "jobNameOverride": { + "default": "", + "description": "Overrides the job selector in Grafana dashboards and Prometheus rules\nFor k3s clusters, change to k3s-server", + "required": [], + "title": "jobNameOverride", + "type": "string" + }, "service": { "additionalProperties": true, "description": "# If using kubeControllerManager.endpoints only the port and targetPort are used\n#", @@ -6347,6 +6464,13 @@ "title": "endpoints", "type": "array" }, + "jobNameOverride": { + "default": "", + "description": "Overrides the job selector in Grafana dashboards and Prometheus rules\nFor k3s clusters, change to k3s-server", + "required": [], + "title": "jobNameOverride", + "type": "string" + }, "service": { "additionalProperties": true, "properties": { @@ -6617,6 +6741,13 @@ "title": "extraVolumeMounts", "type": "array" }, + "ignoreProbePaths": { + "default": true, + "description": "This set --ignore-paths=/livez,/readyz to kubeRBACProxy container args\nto allow the pod probes working properly with kubeRBACProxy enabled.", + "required": [], + "title": "ignoreProbePaths", + "type": "boolean" + }, "image": { "additionalProperties": true, "description": "VARIABLE: value", @@ -6646,7 +6777,7 @@ "type": "string" }, "tag": { - "default": "v0.18.2", + "default": "v0.20.1", "required": [], "title": "tag", "type": "string" @@ -6737,6 +6868,13 @@ "title": "endpoints", "type": "array" }, + "jobNameOverride": { + "default": "", + "description": "Overrides the job selector in Grafana dashboards and Prometheus rules\nFor k3s clusters, change to k3s-server", + "required": [], + "title": "jobNameOverride", + "type": "string" + }, "service": { "additionalProperties": true, "description": "# If using kubeScheduler.endpoints only the port and targetPort are used\n#", @@ -6997,6 +7135,13 @@ "title": "enabled", "type": "boolean" }, + "jobNameOverride": { + "default": "", + "description": "Overrides the job selector in Grafana dashboards and Prometheus rules\nFor k3s clusters, change to k3s-server", + "required": [], + "title": "jobNameOverride", + "type": "string" + }, "namespace": { "default": "kube-system", "required": [], @@ -7414,6 +7559,13 @@ "title": "kubernetesServiceMonitors", "type": "object" }, + "labels": { + "additionalProperties": true, + "description": "Labels to be added to the deployment/statefulset", + "required": [], + "title": "labels", + "type": "object" + }, "ldap": { "additionalProperties": true, "description": "# Grafana's LDAP configuration\n# Templated by the template in _helpers.tpl\n# NOTE: To enable the grafana.ini must be configured with auth.ldap.enabled\n# ref: http://docs.grafana.org/installation/configuration/#auth-ldap\n# ref: http://docs.grafana.org/installation/ldap/#configuration", @@ -7768,10 +7920,9 @@ }, "persistence": { "additionalProperties": true, - "description": "# Enable persistence using Persistent Volume Claims\n# ref: https://kubernetes.io/docs/user-guide/persistent-volumes/\n#", + "description": "# Enable persistence using Persistent Volume Claims\n# ref: https://kubernetes.io/docs/concepts/storage/persistent-volumes/\n#", "properties": { "accessModes": { - "description": "storageClassName: default", "items": { "required": [], "type": "string" @@ -7842,6 +7993,13 @@ "required": [], "title": "type", "type": "string" + }, + "volumeName": { + "default": "", + "description": "storageClassName: default\n# (Optional) Use this to bind the claim to an existing PersistentVolume (PV) by name.", + "required": [], + "title": "volumeName", + "type": "string" } }, "required": [], @@ -7901,41 +8059,19 @@ "title": "podPortName", "type": "string" }, - "podSecurityPolicy": { + "prometheus": { "additionalProperties": true, - "description": "# Specify if a Pod Security Policy for kube-state-metrics must be created\n# Ref: https://kubernetes.io/docs/concepts/policy/pod-security-policy/\n#", + "description": "# Deploy a Prometheus instance\n#", "properties": { - "additionalVolumes": { - "items": { - "required": [] - }, - "required": [], - "title": "additionalVolumes", - "type": "array" - }, - "annotations": { + "additionalLabels": { "additionalProperties": true, + "description": "# Additional labels for Prometheus\n#", "required": [], - "title": "annotations", + "title": "additionalLabels", "type": "object" }, - "enabled": { - "default": false, - "required": [], - "title": "enabled", - "type": "boolean" - } - }, - "required": [], - "title": "podSecurityPolicy", - "type": "object" - }, - "prometheus": { - "additionalProperties": true, - "description": "# Deploy a Prometheus instance\n#", - "properties": { "additionalPodMonitors": { - "description": "# Fallback scrape protocol used by Prometheus for scraping metrics\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.ScrapeProtocol\n#\nfallbackScrapeProtocol: \"\"", + "description": "# Attaches node metadata to the discovered targets\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.AttachMetadata\n#\nattachMetadata:\n node: true", "items": { "required": [] }, @@ -7961,7 +8097,7 @@ }, "agentMode": { "default": false, - "description": "# Toggle prometheus into agent mode\n# Note many of features described below (e.g. rules, query, alerting, remote read, thanos) will not work in agent mode.\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/designs/prometheus-agent.md\n#", + "description": "# Toggle prometheus into agent mode\n# Note many of features described below (e.g. rules, query, alerting, remote read, thanos) will not work in agent mode.\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/platform/prometheus-agent.md\n#", "required": [], "title": "agentMode", "type": "boolean" @@ -8006,7 +8142,6 @@ "properties": { "annotations": { "additionalProperties": true, - "description": "For Kubernetes \u003e= 1.18 you should specify the ingress-controller via the field ingressClassName\nSee https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress\ningressClassName: nginx", "required": [], "title": "annotations", "type": "object" @@ -8026,6 +8161,12 @@ "title": "hosts", "type": "array" }, + "ingressClassName": { + "default": "", + "required": [], + "title": "ingressClassName", + "type": "string" + }, "labels": { "additionalProperties": true, "required": [], @@ -8061,7 +8202,6 @@ "properties": { "annotations": { "additionalProperties": true, - "description": "For Kubernetes \u003e= 1.18 you should specify the ingress-controller via the field ingressClassName\nSee https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress\ningressClassName: nginx", "required": [], "title": "annotations", "type": "object" @@ -8086,6 +8226,12 @@ "title": "hostPrefix", "type": "string" }, + "ingressClassName": { + "default": "", + "required": [], + "title": "ingressClassName", + "type": "string" + }, "labels": { "additionalProperties": true, "required": [], @@ -8504,6 +8650,12 @@ "required": [], "title": "flavor", "type": "string" + }, + "namespace": { + "default": "", + "required": [], + "title": "namespace", + "type": "null" } }, "required": [], @@ -8520,17 +8672,18 @@ "title": "enabled", "type": "boolean" }, - "maxUnavailable": { - "default": "", - "required": [], - "title": "maxUnavailable", - "type": "string" - }, "minAvailable": { "default": 1, "required": [], "title": "minAvailable", "type": "integer" + }, + "unhealthyPodEvictionPolicy": { + "default": "AlwaysAllow", + "description": "maxUnavailable: \"\"", + "required": [], + "title": "unhealthyPodEvictionPolicy", + "type": "string" } }, "required": [], @@ -8620,7 +8773,7 @@ }, "honorLabels": { "default": true, - "description": "HonorLabels chooses the metric’s labels on collisions with target labels.", + "description": "HonorLabels chooses the metric's labels on collisions with target labels.", "required": [], "title": "honorLabels", "type": "boolean" @@ -8634,7 +8787,7 @@ }, "interval": { "default": "", - "description": "Interval at which endpoints should be scraped. If not specified Prometheus’ global scrape interval is used.", + "description": "Interval at which endpoints should be scraped. If not specified Prometheus' global scrape interval is used.", "required": [], "title": "interval", "type": "string" @@ -8721,7 +8874,7 @@ "type": "string" }, "relabelings": { - "description": "RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds\nrelabelings for a few standard Kubernetes fields. The original scrape job’s name\nis available via the __tmp_prometheus_job_name label.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", + "description": "RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds\nrelabelings for a few standard Kubernetes fields. The original scrape job's name\nis available via the __tmp_prometheus_job_name label.\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "items": { "required": [] }, @@ -8776,45 +8929,12 @@ "title": "podMonitor", "type": "object" }, - "podSecurityPolicy": { - "additionalProperties": true, - "description": "# Configure additional options for default pod security policy for Prometheus\n# ref: https://kubernetes.io/docs/concepts/policy/pod-security-policy/", - "properties": { - "allowedCapabilities": { - "items": { - "required": [] - }, - "required": [], - "title": "allowedCapabilities", - "type": "array" - }, - "allowedHostPaths": { - "items": { - "required": [] - }, - "required": [], - "title": "allowedHostPaths", - "type": "array" - }, - "volumes": { - "items": { - "required": [] - }, - "required": [], - "title": "volumes", - "type": "array" - } - }, - "required": [], - "title": "podSecurityPolicy", - "type": "object" - }, "prometheusSpec": { "additionalProperties": true, "description": "# Settings affecting prometheusSpec\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#prometheusspec\n#", "properties": { "additionalAlertManagerConfigs": { - "description": "# AdditionalAlertManagerConfigs allows for manual configuration of alertmanager jobs in the form as specified\n# in the official Prometheus documentation https://prometheus.io/docs/prometheus/latest/configuration/configuration/#\u003calertmanager_config\u003e.\n# AlertManager configurations specified are appended to the configurations generated by the Prometheus Operator.\n# As AlertManager configs are appended, the user is responsible to make sure it is valid. Note that using this\n# feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release\n# notes to ensure that no incompatible AlertManager configs are going to break Prometheus after the upgrade.\n#", + "description": "# AdditionalAlertManagerConfigs allows for manual configuration of alertmanager jobs in the form as specified\n# in the official Prometheus documentation https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config.\n# AlertManager configurations specified are appended to the configurations generated by the Prometheus Operator.\n# As AlertManager configs are appended, the user is responsible to make sure it is valid. Note that using this\n# feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release\n# notes to ensure that no incompatible AlertManager configs are going to break Prometheus after the upgrade.\n#", "items": { "required": [] }, @@ -8911,7 +9031,7 @@ }, "affinity": { "additionalProperties": true, - "description": "# Assign custom affinity rules to the prometheus instance\n# ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n#", + "description": "# Assign custom affinity rules to the prometheus instance\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/\n#", "required": [], "title": "affinity", "type": "object" @@ -8948,7 +9068,7 @@ }, "automountServiceAccountToken": { "default": true, - "description": "# AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod,\n# If the field isn’t set, the operator mounts the service account token by default.\n# Warning: be aware that by default, Prometheus requires the service account token for Kubernetes service discovery,\n# It is possible to use strategic merge patch to project the service account token into the ‘prometheus’ container.", + "description": "# AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod,\n# If the field isn't set, the operator mounts the service account token by default.\n# Warning: be aware that by default, Prometheus requires the service account token for Kubernetes service discovery,\n# It is possible to use strategic merge patch to project the service account token into the 'prometheus' container.", "required": [], "title": "automountServiceAccountToken", "type": "boolean" @@ -8978,6 +9098,20 @@ "title": "disableCompaction", "type": "boolean" }, + "dnsConfig": { + "additionalProperties": true, + "description": "# DNS configuration for Prometheus.\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.PodDNSConfig", + "required": [], + "title": "dnsConfig", + "type": "object" + }, + "dnsPolicy": { + "default": "", + "description": "# DNS policy for Prometheus.\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#dnspolicystring-alias", + "required": [], + "title": "dnsPolicy", + "type": "string" + }, "enableAdminAPI": { "default": false, "description": "# EnableAdminAPI enables Prometheus the administrative HTTP API which includes functionality such as deleting time series.\n# This is disabled by default.\n# ref: https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis\n#", @@ -8986,7 +9120,7 @@ "type": "boolean" }, "enableFeatures": { - "description": "EnableFeatures API enables access to Prometheus disabled features.\nref: https://prometheus.io/docs/prometheus/latest/disabled_features/", + "description": "EnableFeatures API enables access to Prometheus disabled features.\nref: https://prometheus.io/docs/prometheus/latest/feature_flags/", "items": { "required": [] }, @@ -8994,6 +9128,13 @@ "title": "enableFeatures", "type": "array" }, + "enableOTLPReceiver": { + "default": false, + "description": "# enableOTLPReceiver enables the OTLP receiver for Prometheus.", + "required": [], + "title": "enableOTLPReceiver", + "type": "boolean" + }, "enableRemoteWriteReceiver": { "default": false, "description": "# enable --web.enable-remote-write-receiver flag on prometheus-server\n#", @@ -9088,7 +9229,7 @@ "type": "string" }, "hostAliases": { - "description": "HostAlias holds the mapping between IP and hostnames that will be injected\nas an entry in the pod’s hosts file.", + "description": "HostAlias holds the mapping between IP and hostnames that will be injected\nas an entry in the pod's hosts file.", "items": { "required": [] }, @@ -9114,6 +9255,12 @@ "additionalProperties": true, "description": "# Image of Prometheus.\n#", "properties": { + "pullPolicy": { + "default": "IfNotPresent", + "required": [], + "title": "pullPolicy", + "type": "string" + }, "registry": { "default": "quay.io", "required": [], @@ -9133,7 +9280,7 @@ "type": "string" }, "tag": { - "default": "v3.2.1", + "default": "v3.8.0", "required": [], "title": "tag", "type": "string" @@ -9196,11 +9343,18 @@ }, "nodeSelector": { "additionalProperties": true, - "description": "# Define which Nodes the Pods are scheduled on.\n# ref: https://kubernetes.io/docs/user-guide/node-selection/\n#", + "description": "# Define which Nodes the Pods are scheduled on.\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector\n#", "required": [], "title": "nodeSelector", "type": "object" }, + "otlp": { + "additionalProperties": true, + "description": "# https://prometheus.io/docs/guides/opentelemetry\n#", + "required": [], + "title": "otlp", + "type": "object" + }, "overrideHonorLabels": { "default": false, "description": "# OverrideHonorLabels if set to true overrides all user configured honor_labels. If HonorLabels is set in ServiceMonitor\n# or PodMonitor to true, this overrides honor_labels to false.", @@ -9271,6 +9425,15 @@ "title": "podMonitorSelectorNilUsesHelmValues", "type": "boolean" }, + "podTargetLabels": { + "description": "# PodTargetLabels are appended to the `spec.podTargetLabels` field of all PodMonitor and ServiceMonitor objects.\n#", + "items": { + "required": [] + }, + "required": [], + "title": "podTargetLabels", + "type": "array" + }, "portName": { "default": "http-web", "description": "# PortName to use for Prometheus.\n#", @@ -9405,7 +9568,7 @@ }, "retentionSize": { "default": "", - "description": "# Maximum size of metrics\n#", + "description": "# Maximum size of metrics\n# Unit format should be in the form of \"50GiB\"", "required": [], "title": "retentionSize", "type": "string" @@ -9489,6 +9652,15 @@ "title": "scrapeInterval", "type": "string" }, + "scrapeProtocols": { + "description": "# Set default scrapeProtocols for Prometheus instances\n# https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#scrapeprotocolstring-alias", + "items": { + "required": [] + }, + "required": [], + "title": "scrapeProtocols", + "type": "array" + }, "scrapeTimeout": { "default": "", "description": "# Number of seconds to wait for target to respond before erroring\n#", @@ -9554,7 +9726,7 @@ }, "serviceDiscoveryRole": { "default": "", - "description": "# Defines the service discovery role used to discover targets from ServiceMonitor objects and Alertmanager endpoints.\n# If set, the value should be either “Endpoints” or “EndpointSlice”. If unset, the operator assumes the “Endpoints” role.", + "description": "# Defines the service discovery role used to discover targets from ServiceMonitor objects and Alertmanager endpoints.\n# If set, the value should be either \"Endpoints\" or \"EndpointSlice\". If unset, the operator assumes the \"Endpoints\" role.", "required": [], "title": "serviceDiscoveryRole", "type": "string" @@ -9580,6 +9752,13 @@ "title": "serviceMonitorSelectorNilUsesHelmValues", "type": "boolean" }, + "serviceName": { + "default": "", + "description": "#", + "required": [], + "title": "serviceName", + "type": "null" + }, "shards": { "default": 1, "description": "# EXPERIMENTAL: Number of shards to distribute targets onto.\n# Number of replicas multiplied by shards is the total number of Pods created.\n# Note that scaling down shards will not reshard data onto remaining instances, it must be manually moved.\n# Increasing shards will not reshard data either but it will continue to be available from the same instances.\n# To query globally use Thanos sidecar and Thanos querier or remote write data to a central location.\n# Sharding is done on the content of the `__address__` target meta-label.\n#", @@ -9602,7 +9781,7 @@ "type": "object" }, "tolerations": { - "description": "# Tolerations for use with node taints\n# ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/\n#", + "description": "# Tolerations for use with node taints\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/\n#", "items": { "required": [] }, @@ -9611,7 +9790,7 @@ "type": "array" }, "topologySpreadConstraints": { - "description": "# If specified, the pod's topology spread constraints.\n# ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/\n#", + "description": "# If specified, the pod's topology spread constraints.\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/\n#", "items": { "required": [] }, @@ -9687,7 +9866,7 @@ }, "route": { "additionalProperties": true, - "description": "BETA: Configure the gateway routes for the chart here.\nMore routes can be added by adding a dictionary key like the 'main' route.\nBe aware that this is an early beta of this feature,\nkube-prometheus-stack does not guarantee this works and is subject to change.\nBeing BETA this can/will change in the future without notice, do not use unless you want to take that risk\n[[ref]](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io%2fv1alpha2)", + "description": "BETA: Configure the gateway routes for the chart here.\nMore routes can be added by adding a dictionary key like the 'main' route.\nBe aware that this is an early beta of this feature,\nkube-prometheus-stack does not guarantee this works and is subject to change.\nBeing BETA this can/will change in the future without notice, do not use unless you want to take that risk\n[[ref]](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io%2fv1alpha2)", "properties": { "main": { "additionalProperties": true, @@ -9801,12 +9980,147 @@ } }, "required": [], - "title": "main", + "title": "main", + "type": "object" + } + }, + "required": [], + "title": "route", + "type": "object" + }, + "scrapeconfig": { + "additionalProperties": true, + "description": "# Create a scrapeConfig resource for scraping the kube-state-metrics service. Use this instead of serviceMonitor\n# to have more instances of kube-state-metrics safety.", + "properties": { + "additionalLabels": { + "additionalProperties": true, + "required": [], + "title": "additionalLabels", + "type": "object" + }, + "annotations": { + "additionalProperties": true, + "required": [], + "title": "annotations", + "type": "object" + }, + "enableHttp2": { + "default": false, + "description": "# Whether to enable HTTP2 for scrapeconfig", + "required": [], + "title": "enableHttp2", + "type": "boolean" + }, + "enabled": { + "default": false, + "description": "# To avoid duplicate metrics, first disable the serviceMonitor creation via prometheus.monitor.enabled=false", + "required": [], + "title": "enabled", + "type": "boolean" + }, + "honorLabels": { + "default": true, + "required": [], + "title": "honorLabels", + "type": "boolean" + }, + "jobName": { + "default": "kube-state-metrics", + "required": [], + "title": "jobName", + "type": "string" + }, + "labelLimit": { + "default": 0, + "description": "# Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.\n#", + "required": [], + "title": "labelLimit", + "type": "integer" + }, + "labelNameLengthLimit": { + "default": 0, + "description": "# Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.\n#", + "required": [], + "title": "labelNameLengthLimit", + "type": "integer" + }, + "labelValueLengthLimit": { + "default": 0, + "description": "# Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer.\n#", + "required": [], + "title": "labelValueLengthLimit", + "type": "integer" + }, + "metricRelabelings": { + "items": { + "required": [] + }, + "required": [], + "title": "metricRelabelings", + "type": "array" + }, + "proxyUrl": { + "default": "", + "required": [], + "title": "proxyUrl", + "type": "string" + }, + "relabelings": { + "items": { + "required": [] + }, + "required": [], + "title": "relabelings", + "type": "array" + }, + "sampleLimit": { + "default": 0, + "description": "# SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.\n#", + "required": [], + "title": "sampleLimit", + "type": "integer" + }, + "scheme": { + "default": "", + "required": [], + "title": "scheme", + "type": "string" + }, + "scrapeInterval": { + "default": "", + "required": [], + "title": "scrapeInterval", + "type": "string" + }, + "scrapeTimeout": { + "default": "", + "required": [], + "title": "scrapeTimeout", + "type": "string" + }, + "staticConfigLabels": { + "additionalProperties": true, + "description": "# StaticConfigLabels defines the labels to be used in the Prometheus static configuration for scraping.", + "required": [], + "title": "staticConfigLabels", + "type": "object" + }, + "targetLimit": { + "default": 0, + "description": "# TargetLimit defines a limit on the number of scraped targets that will be accepted.\n#", + "required": [], + "title": "targetLimit", + "type": "integer" + }, + "tlsConfig": { + "additionalProperties": true, + "required": [], + "title": "tlsConfig", "type": "object" } }, "required": [], - "title": "route", + "title": "scrapeconfig", "type": "object" }, "service": { @@ -9834,8 +10148,14 @@ "title": "clusterIP", "type": "string" }, + "enabled": { + "default": true, + "required": [], + "title": "enabled", + "type": "boolean" + }, "externalIPs": { - "description": "# List of IP addresses at which the Prometheus server service is available\n# Ref: https://kubernetes.io/docs/user-guide/services/#external-ips\n#", + "description": "# List of IP addresses at which the Prometheus server service is available\n# Ref: https://kubernetes.io/docs/concepts/services-networking/service/#external-ips\n#", "items": { "required": [] }, @@ -10222,7 +10542,6 @@ "properties": { "annotations": { "additionalProperties": true, - "description": "For Kubernetes \u003e= 1.18 you should specify the ingress-controller via the field ingressClassName\nSee https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress\ningressClassName: nginx", "required": [], "title": "annotations", "type": "object" @@ -10242,6 +10561,12 @@ "title": "hosts", "type": "array" }, + "ingressClassName": { + "default": "", + "required": [], + "title": "ingressClassName", + "type": "string" + }, "labels": { "additionalProperties": true, "required": [], @@ -10575,7 +10900,7 @@ }, "tlsConfig": { "additionalProperties": true, - "description": "# tlsConfig: TLS configuration to use when scraping the endpoint. For example if using istio mTLS.\n# Of type: https://github.com/coreos/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig", + "description": "# tlsConfig: TLS configuration to use when scraping the endpoint. For example if using istio mTLS.\n# Of type: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig", "required": [], "title": "tlsConfig", "type": "object" @@ -10614,7 +10939,7 @@ "properties": { "jobLabel": { "default": "node-exporter", - "description": "# Add the 'node-exporter' label to be used by serviceMonitor to match standard common usage in rules and grafana dashboards\n#", + "description": "# Add the 'node-exporter' label to be used by serviceMonitor and podMonitor to match standard common usage in rules and grafana dashboards\n#", "required": [], "title": "jobLabel", "type": "string" @@ -10720,6 +11045,26 @@ "required": [], "title": "monitor", "type": "object" + }, + "podMonitor": { + "additionalProperties": true, + "properties": { + "enabled": { + "default": false, + "required": [], + "title": "enabled", + "type": "boolean" + }, + "jobLabel": { + "default": "jobLabel", + "required": [], + "title": "jobLabel", + "type": "string" + } + }, + "required": [], + "title": "podMonitor", + "type": "object" } }, "required": [], @@ -11006,7 +11351,7 @@ "properties": { "affinity": { "additionalProperties": true, - "description": "# Assign custom affinity rules to the prometheus operator\n# ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n#", + "description": "# Assign custom affinity rules to the prometheus operator\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/\n#", "required": [], "title": "affinity", "type": "object" @@ -11177,7 +11522,7 @@ }, "nodeSelector": { "additionalProperties": true, - "description": "# Define which Nodes the Pods are scheduled on.\n# ref: https://kubernetes.io/docs/user-guide/node-selection/\n#", + "description": "# Define which Nodes the Pods are scheduled on.\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector\n#", "required": [], "title": "nodeSelector", "type": "object" @@ -11192,6 +11537,27 @@ "podDisruptionBudget": { "additionalProperties": true, "description": "Ref: https://kubernetes.io/docs/tasks/run-application/configure-pdb/", + "properties": { + "enabled": { + "default": false, + "required": [], + "title": "enabled", + "type": "boolean" + }, + "minAvailable": { + "default": 1, + "required": [], + "title": "minAvailable", + "type": "integer" + }, + "unhealthyPodEvictionPolicy": { + "default": "AlwaysAllow", + "description": "maxUnavailable: \"\"", + "required": [], + "title": "unhealthyPodEvictionPolicy", + "type": "string" + } + }, "required": [], "title": "podDisruptionBudget", "type": "object" @@ -11342,7 +11708,7 @@ "type": "string" }, "externalIPs": { - "description": "# List of IP addresses at which the Prometheus server service is available\n# Ref: https://kubernetes.io/docs/user-guide/services/#external-ips\n#", + "description": "# List of IP addresses at which the Prometheus server service is available\n# Ref: https://kubernetes.io/docs/concepts/services-networking/service/#external-ips\n#", "items": { "required": [] }, @@ -11491,7 +11857,7 @@ }, "tlsMinVersion": { "default": "VersionTLS13", - "description": "Value must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", + "description": "Value must match version names from https://pkg.go.dev/crypto/tls#pkg-constants", "required": [], "title": "tlsMinVersion", "type": "string" @@ -11502,7 +11868,7 @@ "type": "object" }, "tolerations": { - "description": "# Tolerations for use with node taints\n# ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/\n#", + "description": "# Tolerations for use with node taints\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/\n#", "items": { "required": [] }, @@ -11528,6 +11894,12 @@ "title": "failurePolicy", "type": "string" }, + "matchConditions": { + "additionalProperties": true, + "required": [], + "title": "matchConditions", + "type": "object" + }, "mutatingWebhookConfiguration": { "additionalProperties": true, "properties": { @@ -11585,13 +11957,13 @@ "type": "string" }, "registry": { - "default": "registry.k8s.io", + "default": "ghcr.io", "required": [], "title": "registry", "type": "string" }, "repository": { - "default": "ingress-nginx/kube-webhook-certgen", + "default": "jkroepke/kube-webhook-certgen", "required": [], "title": "repository", "type": "string" @@ -11603,7 +11975,7 @@ "type": "string" }, "tag": { - "default": "v1.5.1", + "default": "1.7.3", "required": [], "title": "tag", "type": "string" @@ -11799,7 +12171,7 @@ }, "affinity": { "additionalProperties": true, - "description": "# Assign custom affinity rules to the prometheus operator\n# ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n#", + "description": "# Assign custom affinity rules to the prometheus operator\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/\n#", "required": [], "title": "affinity", "type": "object" @@ -11918,7 +12290,7 @@ "type": "object" }, "extraArgs": { - "description": "# Extra arguments to pass to prometheusOperator\nhttps://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/operator.md", + "description": "# Extra arguments to pass to prometheusOperator\nhttps://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/platform/operator.md", "items": { "required": [] }, @@ -12138,7 +12510,7 @@ }, "nodeSelector": { "additionalProperties": true, - "description": "# Define which Nodes the Pods are scheduled on.\n# ref: https://kubernetes.io/docs/user-guide/node-selection/\n#", + "description": "# Define which Nodes the Pods are scheduled on.\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector\n#", "required": [], "title": "nodeSelector", "type": "object" @@ -12150,6 +12522,34 @@ "title": "podAnnotations", "type": "object" }, + "podDisruptionBudget": { + "additionalProperties": true, + "description": "# Assign a podDisruptionBudget to the operator\n#", + "properties": { + "enabled": { + "default": false, + "required": [], + "title": "enabled", + "type": "boolean" + }, + "minAvailable": { + "default": 1, + "required": [], + "title": "minAvailable", + "type": "integer" + }, + "unhealthyPodEvictionPolicy": { + "default": "AlwaysAllow", + "description": "maxUnavailable: \"\"", + "required": [], + "title": "unhealthyPodEvictionPolicy", + "type": "string" + } + }, + "required": [], + "title": "podDisruptionBudget", + "type": "object" + }, "podLabels": { "additionalProperties": true, "description": "# Labels to add to the operator pod\n#", @@ -12367,7 +12767,7 @@ "type": "string" }, "externalIPs": { - "description": "# List of IP addresses at which the Prometheus server service is available\n# Ref: https://kubernetes.io/docs/user-guide/services/#external-ips\n#", + "description": "# List of IP addresses at which the Prometheus server service is available\n# Ref: https://kubernetes.io/docs/concepts/services-networking/service/#external-ips\n#", "items": { "required": [] }, @@ -12616,7 +13016,7 @@ "type": "string" }, "tag": { - "default": "v0.37.2", + "default": "v0.40.1", "required": [], "title": "tag", "type": "string" @@ -12660,7 +13060,7 @@ }, "tlsMinVersion": { "default": "VersionTLS13", - "description": "Value must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants", + "description": "Value must match version names from https://pkg.go.dev/crypto/tls#pkg-constants", "required": [], "title": "tlsMinVersion", "type": "string" @@ -12671,7 +13071,7 @@ "type": "object" }, "tolerations": { - "description": "# Tolerations for use with node taints\n# ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/\n#", + "description": "# Tolerations for use with node taints\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/\n#", "items": { "required": [] }, @@ -12786,15 +13186,9 @@ "title": "namespaced", "type": "boolean" }, - "pspAnnotations": { - "additionalProperties": true, - "required": [], - "title": "pspAnnotations", - "type": "object" - }, "pspEnabled": { - "default": true, - "description": "# If true, create \u0026 use Pod Security Policy resources\n# https://kubernetes.io/docs/concepts/policy/pod-security-policy/", + "default": false, + "description": "# Use an existing ClusterRole/Role (depending on rbac.namespaced false/true)\nuseExistingRole: name-of-some-role\nuseExistingClusterRole: name-of-some-clusterRole", "required": [], "title": "pspEnabled", "type": "boolean" @@ -13320,11 +13714,17 @@ }, "externalTrafficPolicy": { "default": "", - "description": "# External traffic policy setting (Cluster, Local)", + "description": "# External/Internal traffic policy setting (Cluster, Local)\n# https://kubernetes.io/docs/reference/networking/virtual-ips/#traffic-policies", "required": [], "title": "externalTrafficPolicy", "type": "string" }, + "internalTrafficPolicy": { + "default": "", + "required": [], + "title": "internalTrafficPolicy", + "type": "string" + }, "ipDualStack": { "additionalProperties": true, "description": "# Dual stack settings for the service\n# https://kubernetes.io/docs/concepts/services-networking/dual-stack/#services", @@ -13626,8 +14026,95 @@ "title": "env", "type": "object" }, + "envValueFrom": { + "additionalProperties": true, + "description": "# \"valueFrom\" environment variable references that will be added to deployment pods. Name is templated.\n# ref: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#envvarsource-v1-core\n# Renders in container spec as:\n# env:\n# ...\n# - name: \u003ckey\u003e\n# valueFrom:\n# \u003cvalue rendered as YAML\u003e", + "properties": { + "VAR1": { + "additionalProperties": true, + "properties": { + "configMapKeyRef": { + "additionalProperties": true, + "properties": { + "key": { + "required": [], + "title": "key", + "type": "string" + }, + "name": { + "required": [], + "title": "name", + "type": "string" + } + }, + "required": [], + "title": "configMapKeyRef", + "type": "object" + } + }, + "required": [], + "title": "VAR1", + "type": "object" + }, + "VAR2": { + "additionalProperties": true, + "properties": { + "secretKeyRef": { + "additionalProperties": true, + "properties": { + "key": { + "required": [], + "title": "key", + "type": "string" + }, + "name": { + "required": [], + "title": "name", + "type": "string" + } + }, + "required": [], + "title": "secretKeyRef", + "type": "object" + } + }, + "required": [], + "title": "VAR2", + "type": "object" + }, + "VAR3": { + "additionalProperties": true, + "properties": { + "fieldRef": { + "additionalProperties": true, + "properties": { + "apiVersion": { + "required": [], + "title": "apiVersion", + "type": "string" + }, + "fieldPath": { + "required": [], + "title": "fieldPath", + "type": "string" + } + }, + "required": [], + "title": "fieldRef", + "type": "object" + } + }, + "required": [], + "title": "VAR3", + "type": "object" + } + }, + "required": [], + "title": "envValueFrom", + "type": "object" + }, "extraMounts": { - "description": "Additional alerts sidecar volume mounts", + "description": "Use native sidecar https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/\nrestartPolicy: Always\n# only applies to native sidecars\nstartupProbe:\n httpGet:\n path: /healthz\n port: 8080\n initialDelaySeconds: 5\n periodSeconds: 5\n failureThreshold: 60 # 5 minutes\nAdditional alerts sidecar volume mounts", "items": { "required": [] }, @@ -13644,21 +14131,21 @@ }, "label": { "default": "grafana_alert", - "description": "Do not reprocess already processed unchanged resources on k8s API reconnect.\nignoreAlreadyProcessed: true\nlabel that the configmaps with alert are marked with", + "description": " ENV_NAME:\n configMapKeyRef:\n name: configmap-name\n key: value_key\nDo not reprocess already processed unchanged resources on k8s API reconnect.\nignoreAlreadyProcessed: true\nlabel that the configmaps with alert are marked with (can be templated)", "required": [], "title": "label", "type": "string" }, "labelValue": { "default": "", - "description": "value of label that the configmaps with alert are set to", + "description": "value of label that the configmaps with alert are set to (can be templated)", "required": [], "title": "labelValue", "type": "string" }, "reloadURL": { "default": "http://localhost:3000/api/admin/provisioning/alerting/reload", - "description": "watchServerTimeout: request to the server, asking it to cleanly close the connection after that.\ndefaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S\nwatchServerTimeout: 3600\n\nwatchClientTimeout: is a client-side timeout, configuring your local socket.\nIf you have a network outage dropping all packets with no RST/FIN,\nthis is how long your client waits before realizing \u0026 dropping the connection.\ndefaults to 66sec (sic!)\nwatchClientTimeout: 60\n\nmaxTotalRetries: Total number of retries to allow for any http request.\nTakes precedence over other counts. Applies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry.\nmaxTotalRetries: 5\n\nmaxConnectRetries: How many connection-related errors to retry on for any http request.\nThese are errors raised before the request is sent to the remote server, which we assume has not triggered the server to process the request.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxConnectRetries: 10\n\nmaxReadRetries: How many times to retry on read errors for any http request\nThese errors are raised after the request was sent to the server, so the request may have side-effects.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxReadRetries: 5\n\nEndpoint to send request to reload alerts", + "description": "\nwatchServerTimeout: request to the server, asking it to cleanly close the connection after that.\ndefaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S\nwatchServerTimeout: 3600\n\nwatchClientTimeout: is a client-side timeout, configuring your local socket.\nIf you have a network outage dropping all packets with no RST/FIN,\nthis is how long your client waits before realizing \u0026 dropping the connection.\ndefaults to 66sec (sic!)\nwatchClientTimeout: 60\n\nmaxTotalRetries: Total number of retries to allow for any http request.\nTakes precedence over other counts. Applies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry.\nmaxTotalRetries: 5\n\nmaxConnectRetries: How many connection-related errors to retry on for any http request.\nThese are errors raised before the request is sent to the remote server, which we assume has not triggered the server to process the request.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxConnectRetries: 10\n\nmaxReadRetries: How many times to retry on read errors for any http request\nThese errors are raised after the request was sent to the server, so the request may have side-effects.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxReadRetries: 5\n\nEndpoint to send request to reload alerts", "required": [], "title": "reloadURL", "type": "string" @@ -13670,9 +14157,16 @@ "title": "resource", "type": "string" }, + "resourceName": { + "default": "", + "description": "\nresourceName: comma separated list of resource names to be fetched/checked by this sidecar.\nper default all resources of the type defined in {{ .Values.sidecar.alerts.resource }} will be checked.\nThis e.g. allows stricter RBAC rules which are limited to the resources meant for the sidecars.\nresourceName: \"secret/alerts-1,configmap/alerts-0\"", + "required": [], + "title": "resourceName", + "type": "string" + }, "script": { "default": "null", - "description": "Absolute path to shell script to execute after a alert got reloaded", + "description": "Absolute path to a script to execute after a configmap got reloaded.\nIt runs before calls to REQ_URI. If the file is not executable it will be passed to sh.\nOtherwise, it's executed as is. Shebangs known to work are #!/bin/sh and #!/usr/bin/env python", "required": [], "title": "script", "type": "null" @@ -13685,11 +14179,11 @@ "type": "null" }, "sizeLimit": { - "additionalProperties": true, + "default": "", "description": "Sets the size limit of the alert sidecar emptyDir volume", "required": [], "title": "sizeLimit", - "type": "object" + "type": "string" }, "skipReload": { "default": false, @@ -13823,23 +14317,30 @@ "title": "folderAnnotation", "type": "null" }, + "initDashboards": { + "default": false, + "description": "This is needed if skipReload is true, to load any dashboards defined at startup time.\nDeploy the dashboard sidecar as an initContainer.", + "required": [], + "title": "initDashboards", + "type": "boolean" + }, "label": { "default": "grafana_dashboard", - "description": "label that the configmaps with dashboards are marked with", + "description": "label that the configmaps with dashboards are marked with (can be templated)", "required": [], "title": "label", "type": "string" }, "labelValue": { "default": "", - "description": "value of label that the configmaps with dashboards are set to", + "description": "value of label that the configmaps with dashboards are set to (can be templated)", "required": [], "title": "labelValue", "type": "string" }, "provider": { "additionalProperties": true, - "description": "watchServerTimeout: request to the server, asking it to cleanly close the connection after that.\ndefaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S\nwatchServerTimeout: 3600\n\nwatchClientTimeout: is a client-side timeout, configuring your local socket.\nIf you have a network outage dropping all packets with no RST/FIN,\nthis is how long your client waits before realizing \u0026 dropping the connection.\ndefaults to 66sec (sic!)\nwatchClientTimeout: 60\n\nprovider configuration that lets grafana manage the dashboards", + "description": "Use native sidecar https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/\nrestartPolicy: Always\n# only applies to native sidecars\nstartupProbe:\n httpGet:\n path: /healthz\n port: 8083\n initialDelaySeconds: 5\n periodSeconds: 5\n failureThreshold: 60 # 5 minutes\nwatchServerTimeout: request to the server, asking it to cleanly close the connection after that.\ndefaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S\nwatchServerTimeout: 3600\n\nwatchClientTimeout: is a client-side timeout, configuring your local socket.\nIf you have a network outage dropping all packets with no RST/FIN,\nthis is how long your client waits before realizing \u0026 dropping the connection.\ndefaults to 66sec (sic!)\nwatchClientTimeout: 60\n\nprovider configuration that lets grafana manage the dashboards", "properties": { "allowUiUpdates": { "default": false, @@ -13916,9 +14417,16 @@ "title": "resource", "type": "string" }, + "resourceName": { + "default": "", + "description": "\nresourceName: comma separated list of resource names to be fetched/checked by this sidecar.\nper default all resources of the type defined in {{ .Values.sidecar.dashboards.resource }} will be checked.\nThis e.g. allows stricter RBAC rules which are limited to the resources meant for the sidecars.\nresourceName: \"secret/dashboards-0,configmap/dashboards-1\"", + "required": [], + "title": "resourceName", + "type": "string" + }, "script": { "default": "null", - "description": "Absolute path to shell script to execute after a configmap got reloaded", + "description": "Absolute path to a script to execute after a configmap got reloaded.\nIt runs before calls to REQ_URI. If the file is not executable it will be passed to sh.\nOtherwise, it's executed as is. Shebangs known to work are #!/bin/sh and #!/usr/bin/env python", "required": [], "title": "script", "type": "null" @@ -13931,11 +14439,11 @@ "type": "null" }, "sizeLimit": { - "additionalProperties": true, + "default": "", "description": "Sets the size limit of the dashboard sidecar emptyDir volume", "required": [], "title": "sizeLimit", - "type": "object" + "type": "string" }, "skipReload": { "default": false, @@ -14033,7 +14541,7 @@ "type": "object" }, "extraMounts": { - "description": "Additional datasources sidecar volume mounts", + "description": "Use native sidecar https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/\nrestartPolicy: Always\n# only applies to native sidecars\nstartupProbe:\n httpGet:\n path: /healthz\n port: 8081\n initialDelaySeconds: 5\n periodSeconds: 5\n failureThreshold: 60 # 5 minutes\nAdditional datasources sidecar volume mounts", "items": { "required": [] }, @@ -14050,21 +14558,21 @@ }, "label": { "default": "grafana_datasource", - "description": " ENV_NAME:\n configMapKeyRef:\n name: configmap-name\n key: value_key\nDo not reprocess already processed unchanged resources on k8s API reconnect.\nignoreAlreadyProcessed: true\nlabel that the configmaps with datasources are marked with", + "description": " ENV_NAME:\n configMapKeyRef:\n name: configmap-name\n key: value_key\nDo not reprocess already processed unchanged resources on k8s API reconnect.\nignoreAlreadyProcessed: true\nlabel that the configmaps with datasources are marked with (can be templated)", "required": [], "title": "label", "type": "string" }, "labelValue": { "default": "", - "description": "value of label that the configmaps with datasources are set to", + "description": "value of label that the configmaps with datasources are set to (can be templated)", "required": [], "title": "labelValue", "type": "string" }, "reloadURL": { "default": "http://localhost:3000/api/admin/provisioning/datasources/reload", - "description": "watchServerTimeout: request to the server, asking it to cleanly close the connection after that.\ndefaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S\nwatchServerTimeout: 3600\n\nwatchClientTimeout: is a client-side timeout, configuring your local socket.\nIf you have a network outage dropping all packets with no RST/FIN,\nthis is how long your client waits before realizing \u0026 dropping the connection.\ndefaults to 66sec (sic!)\nwatchClientTimeout: 60\n\nmaxTotalRetries: Total number of retries to allow for any http request.\nTakes precedence over other counts. Applies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry.\nmaxTotalRetries: 5\n\nmaxConnectRetries: How many connection-related errors to retry on for any http request.\nThese are errors raised before the request is sent to the remote server, which we assume has not triggered the server to process the request.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxConnectRetries: 10\n\nmaxReadRetries: How many times to retry on read errors for any http request\nThese errors are raised after the request was sent to the server, so the request may have side-effects.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxReadRetries: 5\n\nEndpoint to send request to reload datasources", + "description": "\nwatchServerTimeout: request to the server, asking it to cleanly close the connection after that.\ndefaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S\nwatchServerTimeout: 3600\n\nwatchClientTimeout: is a client-side timeout, configuring your local socket.\nIf you have a network outage dropping all packets with no RST/FIN,\nthis is how long your client waits before realizing \u0026 dropping the connection.\ndefaults to 66sec (sic!)\nwatchClientTimeout: 60\n\nmaxTotalRetries: Total number of retries to allow for any http request.\nTakes precedence over other counts. Applies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry.\nmaxTotalRetries: 5\n\nmaxConnectRetries: How many connection-related errors to retry on for any http request.\nThese are errors raised before the request is sent to the remote server, which we assume has not triggered the server to process the request.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxConnectRetries: 10\n\nmaxReadRetries: How many times to retry on read errors for any http request\nThese errors are raised after the request was sent to the server, so the request may have side-effects.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxReadRetries: 5\n\nEndpoint to send request to reload datasources", "required": [], "title": "reloadURL", "type": "string" @@ -14076,9 +14584,16 @@ "title": "resource", "type": "string" }, + "resourceName": { + "default": "", + "description": "\nresourceName: comma separated list of resource names to be fetched/checked by this sidecar.\nper default all resources of the type defined in {{ .Values.sidecar.datasources.resource }} will be checked.\nThis e.g. allows stricter RBAC rules which are limited to the resources meant for the sidecars.\nresourceName: \"secret/datasources-0,configmap/datasources-15\"", + "required": [], + "title": "resourceName", + "type": "string" + }, "script": { "default": "null", - "description": "Absolute path to shell script to execute after a datasource got reloaded", + "description": "Absolute path to a script to execute after a configmap got reloaded.\nIt runs before calls to REQ_URI. If the file is not executable it will be passed to sh.\nOtherwise, it's executed as is. Shebangs known to work are #!/bin/sh and #!/usr/bin/env python", "required": [], "title": "script", "type": "null" @@ -14091,11 +14606,11 @@ "type": "null" }, "sizeLimit": { - "additionalProperties": true, + "default": "", "description": "Sets the size limit of the datasource sidecar emptyDir volume", "required": [], "title": "sizeLimit", - "type": "object" + "type": "string" }, "skipReload": { "default": false, @@ -14145,7 +14660,7 @@ "type": "string" }, "tag": { - "default": "1.30.0", + "default": "2.1.2", "required": [], "title": "tag", "type": "string" @@ -14184,7 +14699,7 @@ "type": "object" }, "extraMounts": { - "description": "Additional notifiers sidecar volume mounts", + "description": "Use native sidecar https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/\nrestartPolicy: Always\n# only applies to native sidecars\nstartupProbe:\n httpGet:\n path: /healthz\n port: 8082\n initialDelaySeconds: 5\n periodSeconds: 5\n failureThreshold: 60 # 5 minutes\nAdditional notifiers sidecar volume mounts", "items": { "required": [] }, @@ -14201,21 +14716,21 @@ }, "label": { "default": "grafana_notifier", - "description": "Do not reprocess already processed unchanged resources on k8s API reconnect.\nignoreAlreadyProcessed: true\nlabel that the configmaps with notifiers are marked with", + "description": "Do not reprocess already processed unchanged resources on k8s API reconnect.\nignoreAlreadyProcessed: true\nlabel that the configmaps with notifiers are marked with (can be templated)", "required": [], "title": "label", "type": "string" }, "labelValue": { "default": "", - "description": "value of label that the configmaps with notifiers are set to", + "description": "value of label that the configmaps with notifiers are set to (can be templated)", "required": [], "title": "labelValue", "type": "string" }, "reloadURL": { "default": "http://localhost:3000/api/admin/provisioning/notifications/reload", - "description": "watchServerTimeout: request to the server, asking it to cleanly close the connection after that.\ndefaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S\nwatchServerTimeout: 3600\n\nwatchClientTimeout: is a client-side timeout, configuring your local socket.\nIf you have a network outage dropping all packets with no RST/FIN,\nthis is how long your client waits before realizing \u0026 dropping the connection.\ndefaults to 66sec (sic!)\nwatchClientTimeout: 60\n\nmaxTotalRetries: Total number of retries to allow for any http request.\nTakes precedence over other counts. Applies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry.\nmaxTotalRetries: 5\n\nmaxConnectRetries: How many connection-related errors to retry on for any http request.\nThese are errors raised before the request is sent to the remote server, which we assume has not triggered the server to process the request.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxConnectRetries: 10\n\nmaxReadRetries: How many times to retry on read errors for any http request\nThese errors are raised after the request was sent to the server, so the request may have side-effects.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxReadRetries: 5\n\nEndpoint to send request to reload notifiers", + "description": "\nwatchServerTimeout: request to the server, asking it to cleanly close the connection after that.\ndefaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S\nwatchServerTimeout: 3600\n\nwatchClientTimeout: is a client-side timeout, configuring your local socket.\nIf you have a network outage dropping all packets with no RST/FIN,\nthis is how long your client waits before realizing \u0026 dropping the connection.\ndefaults to 66sec (sic!)\nwatchClientTimeout: 60\n\nmaxTotalRetries: Total number of retries to allow for any http request.\nTakes precedence over other counts. Applies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry.\nmaxTotalRetries: 5\n\nmaxConnectRetries: How many connection-related errors to retry on for any http request.\nThese are errors raised before the request is sent to the remote server, which we assume has not triggered the server to process the request.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxConnectRetries: 10\n\nmaxReadRetries: How many times to retry on read errors for any http request\nThese errors are raised after the request was sent to the server, so the request may have side-effects.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxReadRetries: 5\n\nEndpoint to send request to reload notifiers", "required": [], "title": "reloadURL", "type": "string" @@ -14227,9 +14742,16 @@ "title": "resource", "type": "string" }, + "resourceName": { + "default": "", + "description": "\nresourceName: comma separated list of resource names to be fetched/checked by this sidecar.\nper default all resources of the type defined in {{ .Values.sidecar.notifiers.resource }} will be checked.\nThis e.g. allows stricter RBAC rules which are limited to the resources meant for the sidecars.\nresourceName: \"secret/notifiers-2,configmap/notifiers-1\"", + "required": [], + "title": "resourceName", + "type": "string" + }, "script": { "default": "null", - "description": "Absolute path to shell script to execute after a notifier got reloaded", + "description": "Absolute path to a script to execute after a configmap got reloaded.\nIt runs before calls to REQ_URI. If the file is not executable it will be passed to sh.\nOtherwise, it's executed as is. Shebangs known to work are #!/bin/sh and #!/usr/bin/env python", "required": [], "title": "script", "type": "null" @@ -14242,11 +14764,11 @@ "type": "null" }, "sizeLimit": { - "additionalProperties": true, + "default": "", "description": "Sets the size limit of the notifier sidecar emptyDir volume", "required": [], "title": "sizeLimit", - "type": "object" + "type": "string" }, "skipReload": { "default": false, @@ -14300,21 +14822,21 @@ }, "label": { "default": "grafana_plugin", - "description": "Do not reprocess already processed unchanged resources on k8s API reconnect.\nignoreAlreadyProcessed: true\nlabel that the configmaps with plugins are marked with", + "description": "Do not reprocess already processed unchanged resources on k8s API reconnect.\nignoreAlreadyProcessed: true\nlabel that the configmaps with plugins are marked with (can be templated)", "required": [], "title": "label", "type": "string" }, "labelValue": { "default": "", - "description": "value of label that the configmaps with plugins are set to", + "description": "value of label that the configmaps with plugins are set to (can be templated)", "required": [], "title": "labelValue", "type": "string" }, "reloadURL": { "default": "http://localhost:3000/api/admin/provisioning/plugins/reload", - "description": "watchServerTimeout: request to the server, asking it to cleanly close the connection after that.\ndefaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S\nwatchServerTimeout: 3600\n\nwatchClientTimeout: is a client-side timeout, configuring your local socket.\nIf you have a network outage dropping all packets with no RST/FIN,\nthis is how long your client waits before realizing \u0026 dropping the connection.\ndefaults to 66sec (sic!)\nwatchClientTimeout: 60\n\nmaxTotalRetries: Total number of retries to allow for any http request.\nTakes precedence over other counts. Applies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry.\nmaxTotalRetries: 5\n\nmaxConnectRetries: How many connection-related errors to retry on for any http request.\nThese are errors raised before the request is sent to the remote server, which we assume has not triggered the server to process the request.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxConnectRetries: 10\n\nmaxReadRetries: How many times to retry on read errors for any http request\nThese errors are raised after the request was sent to the server, so the request may have side-effects.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxReadRetries: 5\n\nEndpoint to send request to reload plugins", + "description": "\nwatchServerTimeout: request to the server, asking it to cleanly close the connection after that.\ndefaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S\nwatchServerTimeout: 3600\n\nwatchClientTimeout: is a client-side timeout, configuring your local socket.\nIf you have a network outage dropping all packets with no RST/FIN,\nthis is how long your client waits before realizing \u0026 dropping the connection.\ndefaults to 66sec (sic!)\nwatchClientTimeout: 60\n\nmaxTotalRetries: Total number of retries to allow for any http request.\nTakes precedence over other counts. Applies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry.\nmaxTotalRetries: 5\n\nmaxConnectRetries: How many connection-related errors to retry on for any http request.\nThese are errors raised before the request is sent to the remote server, which we assume has not triggered the server to process the request.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxConnectRetries: 10\n\nmaxReadRetries: How many times to retry on read errors for any http request\nThese errors are raised after the request was sent to the server, so the request may have side-effects.\nApplies to all requests to reloadURL and k8s api requests.\nSet to 0 to fail on the first retry of this type.\nmaxReadRetries: 5\n\nEndpoint to send request to reload plugins", "required": [], "title": "reloadURL", "type": "string" @@ -14326,9 +14848,16 @@ "title": "resource", "type": "string" }, + "resourceName": { + "default": "", + "description": "\nresourceName: comma separated list of resource names to be fetched/checked by this sidecar.\nper default all resources of the type defined in {{ .Values.sidecar.plugins.resource }} will be checked.\nThis e.g. allows stricter RBAC rules which are limited to the resources meant for the sidecars.\nresourceName: \"secret/plugins-0,configmap/plugins-1\"", + "required": [], + "title": "resourceName", + "type": "string" + }, "script": { "default": "null", - "description": "Absolute path to shell script to execute after a plugin got reloaded", + "description": "Absolute path to a script to execute after a configmap got reloaded.\nIt runs before calls to REQ_URI. If the file is not executable it will be passed to sh.\nOtherwise, it's executed as is. Shebangs known to work are #!/bin/sh and #!/usr/bin/env python", "required": [], "title": "script", "type": "null" @@ -14341,11 +14870,11 @@ "type": "null" }, "sizeLimit": { - "additionalProperties": true, + "default": "", "description": "Sets the size limit of the plugin sidecar emptyDir volume", "required": [], "title": "sizeLimit", - "type": "object" + "type": "string" }, "skipReload": { "default": false, @@ -14589,6 +15118,12 @@ "testFramework": { "additionalProperties": true, "properties": { + "containerSecurityContext": { + "additionalProperties": true, + "required": [], + "title": "containerSecurityContext", + "type": "object" + }, "enabled": { "default": true, "required": [], @@ -14691,7 +15226,6 @@ "properties": { "annotations": { "additionalProperties": true, - "description": "For Kubernetes \u003e= 1.18 you should specify the ingress-controller via the field ingressClassName\nSee https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress\ningressClassName: nginx", "required": [], "title": "annotations", "type": "object" @@ -14711,6 +15245,12 @@ "title": "hosts", "type": "array" }, + "ingressClassName": { + "default": "", + "required": [], + "title": "ingressClassName", + "type": "string" + }, "labels": { "additionalProperties": true, "required": [], @@ -14750,17 +15290,18 @@ "title": "enabled", "type": "boolean" }, - "maxUnavailable": { - "default": "", - "required": [], - "title": "maxUnavailable", - "type": "string" - }, "minAvailable": { "default": 1, "required": [], "title": "minAvailable", "type": "integer" + }, + "unhealthyPodEvictionPolicy": { + "default": "AlwaysAllow", + "description": "maxUnavailable: \"\"", + "required": [], + "title": "unhealthyPodEvictionPolicy", + "type": "string" } }, "required": [], @@ -14769,7 +15310,7 @@ }, "route": { "additionalProperties": true, - "description": "BETA: Configure the gateway routes for the chart here.\nMore routes can be added by adding a dictionary key like the 'main' route.\nBe aware that this is an early beta of this feature,\nkube-prometheus-stack does not guarantee this works and is subject to change.\nBeing BETA this can/will change in the future without notice, do not use unless you want to take that risk\n[[ref]](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io%2fv1alpha2)", + "description": "BETA: Configure the gateway routes for the chart here.\nMore routes can be added by adding a dictionary key like the 'main' route.\nBe aware that this is an early beta of this feature,\nkube-prometheus-stack does not guarantee this works and is subject to change.\nBeing BETA this can/will change in the future without notice, do not use unless you want to take that risk\n[[ref]](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io%2fv1alpha2)", "properties": { "main": { "additionalProperties": true, @@ -14916,6 +15457,12 @@ "title": "clusterIP", "type": "string" }, + "enabled": { + "default": true, + "required": [], + "title": "enabled", + "type": "boolean" + }, "externalIPs": { "items": { "required": [] @@ -15149,7 +15696,7 @@ }, "tlsConfig": { "additionalProperties": true, - "description": "# tlsConfig: TLS configuration to use when scraping the endpoint. For example if using istio mTLS.\n# Of type: https://github.com/coreos/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig", + "description": "# tlsConfig: TLS configuration to use when scraping the endpoint. For example if using istio mTLS.\n# Of type: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig", "required": [], "title": "tlsConfig", "type": "object" @@ -15188,7 +15735,7 @@ }, "affinity": { "additionalProperties": true, - "description": "# Assign custom affinity rules to the thanosRuler instance\n# ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/\n#", + "description": "# Assign custom affinity rules to the thanosRuler instance\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/\n#", "required": [], "title": "affinity", "type": "object" @@ -15278,7 +15825,7 @@ "type": "string" }, "tag": { - "default": "v0.37.2", + "default": "v0.40.1", "required": [], "title": "tag", "type": "string" @@ -15327,7 +15874,7 @@ }, "nodeSelector": { "additionalProperties": true, - "description": "# Define which Nodes the Pods are scheduled on.\n# ref: https://kubernetes.io/docs/user-guide/node-selection/\n#", + "description": "# Define which Nodes the Pods are scheduled on.\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector\n#", "required": [], "title": "nodeSelector", "type": "object" @@ -15438,7 +15985,7 @@ }, "resources": { "additionalProperties": true, - "description": "# Define resources requests and limits for single Pods.\n# ref: https://kubernetes.io/docs/user-guide/compute-resources/\n#", + "description": "# Define resources requests and limits for single Pods.\n# ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/\n#", "required": [], "title": "resources", "type": "object" @@ -15525,6 +16072,13 @@ "title": "securityContext", "type": "object" }, + "serviceName": { + "default": "", + "description": "#", + "required": [], + "title": "serviceName", + "type": "null" + }, "storage": { "additionalProperties": true, "description": "# Storage is the definition of how storage will be used by the ThanosRuler instances.\n# ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/platform/storage.md\n#", @@ -15533,7 +16087,7 @@ "type": "object" }, "tolerations": { - "description": "# If specified, the pod's tolerations.\n# ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/\n#", + "description": "# If specified, the pod's tolerations.\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/\n#", "items": { "required": [] }, @@ -15542,7 +16096,7 @@ "type": "array" }, "topologySpreadConstraints": { - "description": "# If specified, the pod's topology spread constraints.\n# ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/\n#", + "description": "# If specified, the pod's topology spread constraints.\n# ref: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/\n#", "items": { "required": [] }, diff --git a/docs/examples/src/charts/kube_prometheus_stack/values.schema.k b/docs/examples/src/charts/kube_prometheus_stack/values.schema.k index 1c551eb0..3d90f522 100644 --- a/docs/examples/src/charts/kube_prometheus_stack/values.schema.k +++ b/docs/examples/src/charts/kube_prometheus_stack/values.schema.k @@ -80,7 +80,7 @@ schema Values: customResourceState : ValuesCustomResourceState, optional Enabling support for customResourceState, will create a configMap including your config that will be read from kube-state-metrics customRules : ValuesCustomRules, optional - # custom Rules to override "for" and "severity" in defaultRules + # Custom rules to override "for" and "severity" in defaultRules # daemonsetAnnotations : ValuesDaemonsetAnnotations, optional Annotations to be added to windows exporter daemonset @@ -110,6 +110,17 @@ schema Values: # Configure grafana datasources # ref: http://docs.grafana.org/administration/provisioning/#datasources # + defaultCurlOptions : str, optional, default is "-skf" + # Configure how curl fetches remote dashboards. The beginning dash is required. + # NOTE: This sets the default short flags for all dashboards, but these + # defaults can be overridden individually for each dashboard by setting + # curlOptions. See the example dashboards section below. + # + # -s - silent mode + # -k - allow insecure (eg: non-TLS) connections + # -f - fail fast + # See the curl documentation for additional options + # defaultRules : ValuesDefaultRules, optional # Create default rules for monitoring the cluster # @@ -118,8 +129,9 @@ schema Values: # ref: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/#strategy dnsConfig : ValuesDnsConfig, optional Custom DNS configuration to be added to prometheus-windows-exporter pods - dnsPolicy : any, optional, default is "~" - dns configuration for pod + dnsPolicy : str, optional, default is "ClusterFirst" + # dnsPolicy allows to change the default DNS configuration for the pod + # Ref: https://kubernetes.io/docs/concepts/services-networking/dns-pod-service/#pod-s-dns-policy downloadDashboards : ValuesDownloadDashboards, optional downloadDashboardsImage : ValuesDownloadDashboardsImage, optional # Assign a PriorityClassName to pods if set @@ -132,10 +144,10 @@ schema Values: endpoints : [any], optional for deployments that have node_exporter deployed outside of the cluster, list their addresses here - env : ValuesEnv, optional + env : any | ValuesEnv, optional Additional environment variables that will be passed to the daemonset envFromConfigMaps : [any], optional - # The names of conifgmaps in the same kubernetes namespace which contain values to be added to the environment + # The names of configmaps in the same kubernetes namespace which contain values to be added to the environment # Each entry should contain a name key, and can optionally specify whether the configmap must be defined with an optional key. # Name is templated. # ref: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.23/#configmapenvsource-v1-core @@ -180,10 +192,12 @@ schema Values: # extraLabels : ValuesExtraLabels, optional Apply extra labels to common labels. - extraManifests : [any], optional - # Extra manifests to deploy as an array + extraManifests : any | any, optional, default is "null" + # Extra manifests to deploy. Can be of type dict or list. + # If dict, keys are ignored and only values are used. + # Items contained within extraObjects can be defined as dict or string and are passed through tpl. extraObjects : [ValuesExtraObjectsItems0], optional - Create a dynamic manifests via values: + extraObjects could be utilized to add dynamic manifests via values extraSecretMounts : [any], optional # Additional grafana server secret mounts Defines additional mounts with secrets. Secrets must be manually created in the namespace. @@ -273,6 +287,8 @@ schema Values: kubernetesServiceMonitors : ValuesKubernetesServiceMonitors, optional # Flag to disable all the kubernetes component scrapers # + labels : ValuesLabels, optional + Labels to be added to the deployment/statefulset ldap : ValuesLdap, optional # Grafana's LDAP configuration # Templated by the template in _helpers.tpl @@ -333,7 +349,7 @@ schema Values: # persistence : ValuesPersistence, optional # Enable persistence using Persistent Volume Claims - # ref: https://kubernetes.io/docs/user-guide/persistent-volumes/ + # ref: https://kubernetes.io/docs/concepts/storage/persistent-volumes/ # plugins : [any], optional # Pass the plugins you want installed as a list. @@ -347,10 +363,6 @@ schema Values: podPortName : str, optional, default is "grafana" # Pod Labels podLabels: {} - podSecurityPolicy : ValuesPodSecurityPolicy, optional - # Specify if a Pod Security Policy for kube-state-metrics must be created - # Ref: https://kubernetes.io/docs/concepts/policy/pod-security-policy/ - # prometheus : ValuesPrometheus, optional # Deploy a Prometheus instance # @@ -496,16 +508,17 @@ schema Values: dashboards?: ValuesDashboards dashboardsConfigMaps?: ValuesDashboardsConfigMaps datasources?: ValuesDatasources + defaultCurlOptions?: str defaultRules?: ValuesDefaultRules deploymentStrategy?: ValuesDeploymentStrategy dnsConfig?: ValuesDnsConfig - dnsPolicy?: any + dnsPolicy?: str downloadDashboards?: ValuesDownloadDashboards downloadDashboardsImage?: ValuesDownloadDashboardsImage enableKubeBackwardCompatibility?: bool enableServiceLinks?: bool endpoints?: [any] - env?: ValuesEnv + env?: any | ValuesEnv envFromConfigMaps?: [any] envFromSecret?: str envFromSecrets?: [any] @@ -520,7 +533,7 @@ schema Values: extraHostVolumeMounts?: [any] extraInitContainers?: [any] extraLabels?: ValuesExtraLabels - extraManifests?: [any] + extraManifests?: any | any extraObjects?: [ValuesExtraObjectsItems0] extraSecretMounts?: [any] extraVolumeMounts?: [any] @@ -558,6 +571,7 @@ schema Values: kubeconfig?: ValuesKubeconfig kubelet?: ValuesKubelet kubernetesServiceMonitors?: ValuesKubernetesServiceMonitors + labels?: ValuesLabels ldap?: ValuesLdap lifecycleHooks?: ValuesLifecycleHooks livenessProbe?: ValuesLivenessProbe @@ -579,7 +593,6 @@ schema Values: podDisruptionBudget?: ValuesPodDisruptionBudget podLabels?: ValuesPodLabels podPortName?: str - podSecurityPolicy?: ValuesPodSecurityPolicy prometheus?: ValuesPrometheus "prometheus-node-exporter"?: ValuesPrometheusNodeExporter "prometheus-windows-exporter"?: ValuesPrometheusWindowsExporter @@ -775,6 +788,9 @@ schema ValuesAlertmanager: Attributes ---------- + additionalLabels : ValuesAlertmanagerAdditionalLabels, optional + # Additional labels for Alertmanager + # alertmanagerSpec : ValuesAlertmanagerAlertmanagerSpec, optional # Settings affecting alertmanagerSpec # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#alertmanagerspec @@ -783,7 +799,7 @@ schema ValuesAlertmanager: # Annotations for Alertmanager # apiVersion : str, optional, default is "v2" - # Api that prometheus will use to communicate with alertmanager. Possible values are v1, v2 + # API that Prometheus will use to communicate with alertmanager. Possible values are v1, v2 # config : ValuesAlertmanagerConfig, optional # Alertmanager configuration directives @@ -807,6 +823,8 @@ schema ValuesAlertmanager: # Configuration for creating an Ingress that will map to each Alertmanager replica service # alertmanager.servicePerReplica must be enabled # + namespaceOverride : str, optional, default is "" + Optional: Override the namespace where Alertmanager will be deployed. networkPolicy : ValuesAlertmanagerNetworkPolicy, optional # Network Policy configuration # @@ -820,7 +838,7 @@ schema ValuesAlertmanager: Be aware that this is an early beta of this feature, kube-prometheus-stack does not guarantee this works and is subject to change. Being BETA this can/will change in the future without notice, do not use unless you want to take that risk - [[ref]](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io%2fv1alpha2) + [[ref]](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io%2fv1alpha2) secret : ValuesAlertmanagerSecret, optional # Configuration for Alertmanager secret # @@ -839,7 +857,7 @@ schema ValuesAlertmanager: # stringConfig : str, optional, default is "" # Alertmanager configuration directives (as string type, preferred over the config hash map) - # stringConfig will be used only, if tplConfig is true + # stringConfig will be used only if tplConfig is true # ref: https://prometheus.io/docs/alerting/configuration/#configuration-file # https://prometheus.io/webtools/alerting/routing-tree-editor/ # @@ -863,6 +881,7 @@ schema ValuesAlertmanager: # https://prometheus.io/docs/alerting/notification_examples/ """ [...str]: any + additionalLabels?: ValuesAlertmanagerAdditionalLabels alertmanagerSpec?: ValuesAlertmanagerAlertmanagerSpec annotations?: ValuesAlertmanagerAnnotations apiVersion?: str @@ -873,6 +892,7 @@ schema ValuesAlertmanager: forceDeployDashboards?: bool ingress?: ValuesAlertmanagerIngress ingressPerReplica?: ValuesAlertmanagerIngressPerReplica + namespaceOverride?: str networkPolicy?: ValuesAlertmanagerNetworkPolicy podDisruptionBudget?: ValuesAlertmanagerPodDisruptionBudget route?: ValuesAlertmanagerRoute @@ -885,6 +905,13 @@ schema ValuesAlertmanager: templateFiles?: ValuesAlertmanagerTemplateFiles tplConfig?: bool +schema ValuesAlertmanagerAdditionalLabels: + r""" + # Additional labels for Alertmanager + # + """ + [...str]: any + schema ValuesAlertmanagerAlertmanagerSpec: r""" # Settings affecting alertmanagerSpec @@ -893,6 +920,8 @@ schema ValuesAlertmanagerAlertmanagerSpec: Attributes ---------- + additionalArgs : [any], optional + # Additional command line arguments to pass to Alertmanager (in addition to those generated by the chart) additionalConfig : ValuesAlertmanagerAlertmanagerSpecAdditionalConfig, optional # Additional configuration which is not covered by the properties above. (passed through tpl) additionalConfigString : str, optional, default is "" @@ -904,7 +933,7 @@ schema ValuesAlertmanagerAlertmanagerSpec: # affinity : ValuesAlertmanagerAlertmanagerSpecAffinity, optional # Assign custom affinity rules to the alertmanager instance - # ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ # alertmanagerConfigMatcherStrategy : ValuesAlertmanagerAlertmanagerSpecAlertmanagerConfigMatcherStrategy, optional # Defines the strategy used by AlertmanagerConfig objects to match alerts. eg: @@ -926,15 +955,15 @@ schema ValuesAlertmanagerAlertmanagerSpec: # clusterGossipInterval : str, optional, default is "" # clusterGossipInterval determines interval between gossip attempts. - # Needs to be specified as GoDuration, a time duration that can be parsed by Go’s time.ParseDuration() (e.g. 45ms, 30s, 1m, 1h20m15s) + # Needs to be specified as GoDuration, a time duration that can be parsed by Go's time.ParseDuration() (e.g. 45ms, 30s, 1m, 1h20m15s) clusterLabel : str, optional, default is "" # clusterLabel defines the identifier that uniquely identifies the Alertmanager cluster. clusterPeerTimeout : str, optional, default is "" # clusterPeerTimeout determines timeout for cluster peering. - # Needs to be specified as GoDuration, a time duration that can be parsed by Go’s time.ParseDuration() (e.g. 45ms, 30s, 1m, 1h20m15s) + # Needs to be specified as GoDuration, a time duration that can be parsed by Go's time.ParseDuration() (e.g. 45ms, 30s, 1m, 1h20m15s) clusterPushpullInterval : str, optional, default is "" # clusterPushpullInterval determines interval between pushpull attempts. - # Needs to be specified as GoDuration, a time duration that can be parsed by Go’s time.ParseDuration() (e.g. 45ms, 30s, 1m, 1h20m15s) + # Needs to be specified as GoDuration, a time duration that can be parsed by Go's time.ParseDuration() (e.g. 45ms, 30s, 1m, 1h20m15s) configMaps : [any], optional # ConfigMaps is a list of ConfigMaps in the same namespace as the Alertmanager object, which shall be mounted into the Alertmanager Pods. # The ConfigMaps are mounted into /etc/alertmanager/configmaps/. @@ -942,6 +971,12 @@ schema ValuesAlertmanagerAlertmanagerSpec: containers : [any], optional # Containers allows injecting additional containers. This is meant to allow adding an authentication proxy to an Alertmanager pod. # + dnsConfig : ValuesAlertmanagerAlertmanagerSpecDnsConfig, optional + # DNS configuration for Alertmanager. + # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.PodDNSConfig + dnsPolicy : str, optional, default is "" + # DNS policy for Alertmanager. + # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#dnspolicystring-alias externalUrl : any, optional, default is "" # The external URL the Alertmanager instances will be available under. This is necessary to generate correct URLs. This is necessary if Alertmanager is not served from root of a DNS name. string false # @@ -969,7 +1004,7 @@ schema ValuesAlertmanagerAlertmanagerSpec: # be considered available. Defaults to 0 (pod will be considered available as soon as it is ready). nodeSelector : ValuesAlertmanagerAlertmanagerSpecNodeSelector, optional # Define which Nodes the Pods are scheduled on. - # ref: https://kubernetes.io/docs/user-guide/node-selection/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector # paused : bool, optional, default is False # If set to true all actions on the underlying managed objects are not going to be performed, except for delete actions. @@ -1006,7 +1041,7 @@ schema ValuesAlertmanagerAlertmanagerSpec: # running cluster equal to the expected size. resources : ValuesAlertmanagerAlertmanagerSpecResources, optional # Define resources requests and limits for single Pods. - # ref: https://kubernetes.io/docs/user-guide/compute-resources/ + # ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ # retention : str, optional, default is "120h" # Time duration Alertmanager shall retain data for. Default is '120h', and must match the regular expression @@ -1027,20 +1062,22 @@ schema ValuesAlertmanagerAlertmanagerSpec: # This defaults to non root user with uid 1000 and gid 2000. *v1.PodSecurityContext false # ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ # + serviceName : any, optional, default is "" + # storage : ValuesAlertmanagerAlertmanagerSpecStorage, optional # Storage is the definition of how storage will be used by the Alertmanager instances. # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/platform/storage.md # tlsConfig : ValuesAlertmanagerAlertmanagerSpecTlsConfig, optional # tlsConfig: TLS configuration to use when connect to the endpoint. For example if using istio mTLS. - # Of type: https://github.com/coreos/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig + # Of type: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig tolerations : [any], optional # If specified, the pod's tolerations. - # ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ # topologySpreadConstraints : [any], optional # If specified, the pod's topology spread constraints. - # ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/ # useExistingSecret : bool, optional, default is False # If true then the user will be responsible to provide a secret with alertmanager configuration @@ -1055,6 +1092,7 @@ schema ValuesAlertmanagerAlertmanagerSpec: # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#alertmanagerwebspec """ [...str]: any + additionalArgs?: [any] additionalConfig?: ValuesAlertmanagerAlertmanagerSpecAdditionalConfig additionalConfigString?: str additionalPeers?: [any] @@ -1071,6 +1109,8 @@ schema ValuesAlertmanagerAlertmanagerSpec: clusterPushpullInterval?: str configMaps?: [any] containers?: [any] + dnsConfig?: ValuesAlertmanagerAlertmanagerSpecDnsConfig + dnsPolicy?: str externalUrl?: any forceEnableClusterMode?: bool image?: ValuesAlertmanagerAlertmanagerSpecImage @@ -1094,6 +1134,7 @@ schema ValuesAlertmanagerAlertmanagerSpec: scheme?: str secrets?: [any] securityContext?: ValuesAlertmanagerAlertmanagerSpecSecurityContext + serviceName?: any storage?: ValuesAlertmanagerAlertmanagerSpecStorage tlsConfig?: ValuesAlertmanagerAlertmanagerSpecTlsConfig tolerations?: [any] @@ -1112,7 +1153,7 @@ schema ValuesAlertmanagerAlertmanagerSpecAdditionalConfig: schema ValuesAlertmanagerAlertmanagerSpecAffinity: r""" # Assign custom affinity rules to the alertmanager instance - # ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ # """ [...str]: any @@ -1145,6 +1186,13 @@ schema ValuesAlertmanagerAlertmanagerSpecAlertmanagerConfiguration: """ [...str]: any +schema ValuesAlertmanagerAlertmanagerSpecDnsConfig: + r""" + # DNS configuration for Alertmanager. + # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.PodDNSConfig + """ + [...str]: any + schema ValuesAlertmanagerAlertmanagerSpecImage: r""" # Image of Alertmanager @@ -1152,12 +1200,14 @@ schema ValuesAlertmanagerAlertmanagerSpecImage: Attributes ---------- + pullPolicy : str, optional, default is "IfNotPresent" registry : str, optional, default is "quay.io" repository : str, optional, default is "prometheus/alertmanager" sha : str, optional, default is "" - tag : str, optional, default is "v0.28.1" + tag : str, optional, default is "v0.29.0" """ [...str]: any + pullPolicy?: str registry?: str repository?: str sha?: str @@ -1166,7 +1216,7 @@ schema ValuesAlertmanagerAlertmanagerSpecImage: schema ValuesAlertmanagerAlertmanagerSpecNodeSelector: r""" # Define which Nodes the Pods are scheduled on. - # ref: https://kubernetes.io/docs/user-guide/node-selection/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector # """ [...str]: any @@ -1193,7 +1243,7 @@ schema ValuesAlertmanagerAlertmanagerSpecPodMetadata: schema ValuesAlertmanagerAlertmanagerSpecResources: r""" # Define resources requests and limits for single Pods. - # ref: https://kubernetes.io/docs/user-guide/compute-resources/ + # ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ # """ [...str]: any @@ -1242,7 +1292,7 @@ schema ValuesAlertmanagerAlertmanagerSpecStorage: schema ValuesAlertmanagerAlertmanagerSpecTlsConfig: r""" # tlsConfig: TLS configuration to use when connect to the endpoint. For example if using istio mTLS. - # Of type: https://github.com/coreos/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig + # Of type: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig """ [...str]: any @@ -1389,13 +1439,11 @@ schema ValuesAlertmanagerIngress: Attributes ---------- annotations : ValuesAlertmanagerIngressAnnotations, optional - For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - ingressClassName: nginx enabled : bool, optional, default is False hosts : [any], optional # Hosts must be provided if Ingress is enabled. # + ingressClassName : str, optional, default is "" labels : ValuesAlertmanagerIngressLabels, optional paths : [any], optional # Paths to use for ingress rules - one path should match the alertmanagerSpec.routePrefix @@ -1409,15 +1457,14 @@ schema ValuesAlertmanagerIngress: annotations?: ValuesAlertmanagerIngressAnnotations enabled?: bool hosts?: [any] + ingressClassName?: str labels?: ValuesAlertmanagerIngressLabels paths?: [any] tls?: [any] schema ValuesAlertmanagerIngressAnnotations: r""" - For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - ingressClassName: nginx + ValuesAlertmanagerIngressAnnotations """ [...str]: any @@ -1436,9 +1483,6 @@ schema ValuesAlertmanagerIngressPerReplica: Attributes ---------- annotations : ValuesAlertmanagerIngressPerReplicaAnnotations, optional - For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - ingressClassName: nginx enabled : bool, optional, default is False hostDomain : str, optional, default is "" # Domain that will be used for the per replica ingress @@ -1448,6 +1492,7 @@ schema ValuesAlertmanagerIngressPerReplica: # # Prefix for the per replica ingress that will have `-$replicaNumber` # appended to the end + ingressClassName : str, optional, default is "" labels : ValuesAlertmanagerIngressPerReplicaLabels, optional paths : [any], optional # Paths to use for ingress rules @@ -1464,6 +1509,7 @@ schema ValuesAlertmanagerIngressPerReplica: enabled?: bool hostDomain?: str hostPrefix?: str + ingressClassName?: str labels?: ValuesAlertmanagerIngressPerReplicaLabels paths?: [any] tlsSecretName?: str @@ -1471,9 +1517,7 @@ schema ValuesAlertmanagerIngressPerReplica: schema ValuesAlertmanagerIngressPerReplicaAnnotations: r""" - For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - ingressClassName: nginx + ValuesAlertmanagerIngressPerReplicaAnnotations """ [...str]: any @@ -1608,13 +1652,14 @@ schema ValuesAlertmanagerPodDisruptionBudget: Attributes ---------- enabled : bool, optional, default is False - maxUnavailable : str, optional, default is "" minAvailable : int, optional, default is 1 + unhealthyPodEvictionPolicy : str, optional, default is "AlwaysAllow" + maxUnavailable: "" """ [...str]: any enabled?: bool - maxUnavailable?: str minAvailable?: int + unhealthyPodEvictionPolicy?: str schema ValuesAlertmanagerRoute: r""" @@ -1623,7 +1668,7 @@ schema ValuesAlertmanagerRoute: Be aware that this is an early beta of this feature, kube-prometheus-stack does not guarantee this works and is subject to change. Being BETA this can/will change in the future without notice, do not use unless you want to take that risk - [[ref]](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io%2fv1alpha2) + [[ref]](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io%2fv1alpha2) Attributes ---------- @@ -1739,6 +1784,7 @@ schema ValuesAlertmanagerService: # annotations : ValuesAlertmanagerServiceAnnotations, optional clusterIP : str, optional, default is "" + enabled : bool, optional, default is True externalIPs : [any], optional externalTrafficPolicy : str, optional, default is "Cluster" # Denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints @@ -1776,6 +1822,7 @@ schema ValuesAlertmanagerService: additionalPorts?: [any] annotations?: ValuesAlertmanagerServiceAnnotations clusterIP?: str + enabled?: bool externalIPs?: [any] externalTrafficPolicy?: str ipDualStack?: ValuesAlertmanagerServiceIpDualStack @@ -1894,7 +1941,7 @@ schema ValuesAlertmanagerServiceMonitor: # tlsConfig : ValuesAlertmanagerServiceMonitorTlsConfig, optional # tlsConfig: TLS configuration to use when scraping the endpoint. For example if using istio mTLS. - # Of type: https://github.com/coreos/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig + # Of type: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig """ [...str]: any additionalEndpoints?: [any] @@ -1924,7 +1971,7 @@ schema ValuesAlertmanagerServiceMonitorAdditionalLabels: schema ValuesAlertmanagerServiceMonitorTlsConfig: r""" # tlsConfig: TLS configuration to use when scraping the endpoint. For example if using istio mTLS. - # Of type: https://github.com/coreos/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig + # Of type: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig """ [...str]: any @@ -2242,7 +2289,7 @@ schema ValuesCrds: upgradeJob : ValuesCrdsUpgradeJob, optional # The CRD upgrade job mitigates the limitation of helm not being able to upgrade CRDs. # The job will apply the CRDs to the cluster before the operator is deployed, using helm hooks. - # It deploy a corresponding clusterrole, clusterrolebinding and serviceaccount to apply the CRDs. + # It deploys a corresponding clusterrole, clusterrolebinding and serviceaccount to apply the CRDs. # This feature is in preview, off by default and may change in the future. """ [...str]: any @@ -2253,14 +2300,14 @@ schema ValuesCrdsUpgradeJob: r""" # The CRD upgrade job mitigates the limitation of helm not being able to upgrade CRDs. # The job will apply the CRDs to the cluster before the operator is deployed, using helm hooks. - # It deploy a corresponding clusterrole, clusterrolebinding and serviceaccount to apply the CRDs. + # It deploys a corresponding clusterrole, clusterrolebinding and serviceaccount to apply the CRDs. # This feature is in preview, off by default and may change in the future. Attributes ---------- affinity : ValuesCrdsUpgradeJobAffinity, optional # Assign custom affinity rules to the upgrade-crd job - # ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ # annotations : ValuesCrdsUpgradeJobAnnotations, optional # Annotations to add to the upgrade-crd job @@ -2284,7 +2331,7 @@ schema ValuesCrdsUpgradeJob: ## nodeSelector : ValuesCrdsUpgradeJobNodeSelector, optional # Define which Nodes the Pods are scheduled on. - # ref: https://kubernetes.io/docs/user-guide/node-selection/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector # podAnnotations : ValuesCrdsUpgradeJobPodAnnotations, optional # Annotations to add to the upgrade-crd pod @@ -2299,7 +2346,7 @@ schema ValuesCrdsUpgradeJob: # resources : ValuesCrdsUpgradeJobResources, optional # Define resources requests and limits for single Pods. - # ref: https://kubernetes.io/docs/user-guide/compute-resources/ + # ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ # serviceAccount : ValuesCrdsUpgradeJobServiceAccount, optional # Service account for upgrade crd job to use. @@ -2307,11 +2354,11 @@ schema ValuesCrdsUpgradeJob: # tolerations : [any], optional # If specified, the pod's tolerations. - # ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ # topologySpreadConstraints : [any], optional # If specified, the pod's topology spread constraints. - # ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/ # """ [...str]: any @@ -2337,7 +2384,7 @@ schema ValuesCrdsUpgradeJob: schema ValuesCrdsUpgradeJobAffinity: r""" # Assign custom affinity rules to the upgrade-crd job - # ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ # """ [...str]: any @@ -2444,7 +2491,7 @@ schema ValuesCrdsUpgradeJobLabels: schema ValuesCrdsUpgradeJobNodeSelector: r""" # Define which Nodes the Pods are scheduled on. - # ref: https://kubernetes.io/docs/user-guide/node-selection/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector # """ [...str]: any @@ -2499,7 +2546,7 @@ schema ValuesCrdsUpgradeJobPodSecurityContextSeccompProfile: schema ValuesCrdsUpgradeJobResources: r""" # Define resources requests and limits for single Pods. - # ref: https://kubernetes.io/docs/user-guide/compute-resources/ + # ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ # """ [...str]: any @@ -2550,22 +2597,32 @@ schema ValuesCustomResourceState: Attributes ---------- config : ValuesCustomResourceStateConfig, optional - Add (Cluster)Role permissions to list/watch the customResources defined in the config to rbac.extraRules + Definition of the CustomResourceStateMetrics. Add (Cluster)Role permissions to list/watch the resources defined in the config to rbac.extraRules. + create : bool, optional, default is True + Whether to create the ConfigMap that holds the config. enabled : bool, optional, default is False + Whether to enable support for CustomResourceStateMetrics. + key : str, optional, default is "config.yaml" + ConfigMap key that holds the config. + name : str, optional, default is "" + Name of the ConfigMap that holds the config. If empty, name will be generated based on the release name. """ [...str]: any config?: ValuesCustomResourceStateConfig + create?: bool enabled?: bool + key?: str + name?: str schema ValuesCustomResourceStateConfig: r""" - Add (Cluster)Role permissions to list/watch the customResources defined in the config to rbac.extraRules + Definition of the CustomResourceStateMetrics. Add (Cluster)Role permissions to list/watch the resources defined in the config to rbac.extraRules. """ [...str]: any schema ValuesCustomRules: r""" - # custom Rules to override "for" and "severity" in defaultRules + # Custom rules to override "for" and "severity" in defaultRules # """ [...str]: any @@ -2717,13 +2774,17 @@ schema ValuesDefaultRules: additionalRuleAnnotations : ValuesDefaultRulesAdditionalRuleAnnotations, optional # Additional annotations for PrometheusRule alerts additionalRuleGroupAnnotations : ValuesDefaultRulesAdditionalRuleGroupAnnotations, optional - # Additional annotations for specific PrometheusRule alerts groups + # Additional annotations for specific PrometheusRule alert groups additionalRuleGroupLabels : ValuesDefaultRulesAdditionalRuleGroupLabels, optional # Additional labels for specific PrometheusRule alert groups additionalRuleLabels : ValuesDefaultRulesAdditionalRuleLabels, optional # Additional labels for PrometheusRule alerts annotations : ValuesDefaultRulesAnnotations, optional # Annotations for default rules + appNamespacesOperator : str, optional, default is "=~" + Defines the operator for namespace selection in rules + Use "=~" to include namespaces matching the pattern (default) + Use "!~" to exclude namespaces matching the pattern appNamespacesTarget : str, optional, default is ".*" # Reduce app namespace alert scope create : bool, optional, default is True @@ -2745,6 +2806,7 @@ schema ValuesDefaultRules: additionalRuleGroupLabels?: ValuesDefaultRulesAdditionalRuleGroupLabels additionalRuleLabels?: ValuesDefaultRulesAdditionalRuleLabels annotations?: ValuesDefaultRulesAnnotations + appNamespacesOperator?: str appNamespacesTarget?: str create?: bool disabled?: ValuesDefaultRulesDisabled @@ -2762,7 +2824,7 @@ schema ValuesDefaultRulesAdditionalRuleAnnotations: schema ValuesDefaultRulesAdditionalRuleGroupAnnotations: r""" - # Additional annotations for specific PrometheusRule alerts groups + # Additional annotations for specific PrometheusRule alert groups Attributes ---------- @@ -3629,7 +3691,7 @@ schema ValuesGlobal: # ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/ # imageRegistry : str, optional, default is "" - # Global image registry to use if it needs to be overriden for some specific use cases (e.g local registries, custom images, ...) + # Global image registry to use if it needs to be overridden for some specific use cases (e.g. local registries, custom images, ...) # rbac : ValuesGlobalRbac, optional """ @@ -3649,20 +3711,10 @@ schema ValuesGlobalRbac: createAggregateClusterRoles : bool, optional, default is False # Create ClusterRoles that extend the existing view, edit and admin ClusterRoles to interact with prometheus-operator CRDs # Ref: https://kubernetes.io/docs/reference/access-authn-authz/rbac/#aggregated-clusterroles - pspAnnotations : ValuesGlobalRbacPspAnnotations, optional - pspEnabled : bool, optional, default is False """ [...str]: any create?: bool createAggregateClusterRoles?: bool - pspAnnotations?: ValuesGlobalRbacPspAnnotations - pspEnabled?: bool - -schema ValuesGlobalRbacPspAnnotations: - r""" - ValuesGlobalRbacPspAnnotations - """ - [...str]: any schema ValuesGrafana: r""" @@ -3673,9 +3725,11 @@ schema ValuesGrafana: ---------- additionalDataSources : [any], optional # Configure additional grafana datasources (passed through tpl) - # ref: http://docs.grafana.org/administration/provisioning/#datasources - adminPassword : str, optional, default is "prom-operator" + # ref: https://grafana.com/docs/grafana/latest/administration/provisioning/#datasources + admin : ValuesGrafanaAdmin, optional + Use an existing secret for the admin user. adminUser : str, optional, default is "admin" + Administrator credentials when not using an existing secret (see below) defaultDashboardsEditable : bool, optional, default is True # Editable flag for the default dashboards # @@ -3700,10 +3754,35 @@ schema ValuesGrafana: # ingress : ValuesGrafanaIngress, optional namespaceOverride : str, optional, default is "" + operator : ValuesGrafanaOperator, optional + # Deploy GrafanaDashboard CRDs that reference dashboards from ConfigMaps when grafana-operator is used + # These settings control how dashboards are integrated with the Grafana Operator + # Note: End user still need to create is own kind: GrafanaDataSource for Prometheus + # eg: + # apiVersion: grafana.integreatly.org/v1beta1 + # kind: GrafanaDatasource + # metadata: + # name: prometheus + # annotations: {} + # spec: + # allowCrossNamespaceImport: true + # instanceSelector: + # matchLabels: + # app: grafana + # datasource: + # name: prometheus + # type: prometheus + # access: proxy + # url: http://prometheus-operated.prometheus-stack.svc.cluster.local:9090 + # isDefault: true + # jsonData: + # "tlsSkipVerify": true + # "timeInterval": "5s" + # prune : bool, optional, default is False Flag to mark provisioned data sources for deletion if they are no longer configured. It takes no effect if data sources are already listed in the deleteDatasources section. - ref: https://grafana.com/docs/grafana/latest/administration/provisioning/#example-data-source-config-file + ref: https://grafana.com/docs/grafana/latest/administration/provisioning/#example-data-source-configuration-file rbac : ValuesGrafanaRbac, optional service : ValuesGrafanaService, optional # Passed to grafana subchart and used by servicemonitor below @@ -3725,7 +3804,7 @@ schema ValuesGrafana: """ [...str]: any additionalDataSources?: [any] - adminPassword?: str + admin?: ValuesGrafanaAdmin adminUser?: str defaultDashboardsEditable?: bool defaultDashboardsEnabled?: bool @@ -3738,6 +3817,7 @@ schema ValuesGrafana: forceDeployDatasources?: bool ingress?: ValuesGrafanaIngress namespaceOverride?: str + operator?: ValuesGrafanaOperator prune?: bool rbac?: ValuesGrafanaRbac service?: ValuesGrafanaService @@ -3745,6 +3825,22 @@ schema ValuesGrafana: serviceMonitor?: ValuesGrafanaServiceMonitor sidecar?: ValuesGrafanaSidecar +schema ValuesGrafanaAdmin: + r""" + Use an existing secret for the admin user. + + Attributes + ---------- + existingSecret : str, optional, default is "" + # Name of the secret. Can be templated. + passwordKey : str, optional, default is "admin-password" + userKey : str, optional, default is "admin-user" + """ + [...str]: any + existingSecret?: str + passwordKey?: str + userKey?: str + schema ValuesGrafanaIngress: r""" ValuesGrafanaIngress @@ -3878,6 +3974,75 @@ schema ValuesGrafanaIniServer: [...str]: any domain?: str +schema ValuesGrafanaOperator: + r""" + # Deploy GrafanaDashboard CRDs that reference dashboards from ConfigMaps when grafana-operator is used + # These settings control how dashboards are integrated with the Grafana Operator + # Note: End user still need to create is own kind: GrafanaDataSource for Prometheus + # eg: + # apiVersion: grafana.integreatly.org/v1beta1 + # kind: GrafanaDatasource + # metadata: + # name: prometheus + # annotations: {} + # spec: + # allowCrossNamespaceImport: true + # instanceSelector: + # matchLabels: + # app: grafana + # datasource: + # name: prometheus + # type: prometheus + # access: proxy + # url: http://prometheus-operated.prometheus-stack.svc.cluster.local:9090 + # isDefault: true + # jsonData: + # "tlsSkipVerify": true + # "timeInterval": "5s" + # + + Attributes + ---------- + annotations : ValuesGrafanaOperatorAnnotations, optional + # Annotations for GrafanaDashboard Cr + # + dashboardsConfigMapRefEnabled : bool, optional, default is False + # Enable references to ConfigMaps containing dashboards in GrafanaDashboard CRs + # Set to true to allow dashboards to be loaded from ConfigMap references + folder : str, optional, default is "General" + # Which folder all ddashboard in Grafana General means on Root level + # + matchLabels : ValuesGrafanaOperatorMatchLabels, optional + # Labels that should be matched kind: Grafana instance + # Example: { app: grafana, category: dashboard } + # + resyncPeriod : str, optional, default is "10m" + # How frequently the operator should resync resources (in duration format) + # Controls how often dashboards are reconciled by the operator + # + """ + [...str]: any + annotations?: ValuesGrafanaOperatorAnnotations + dashboardsConfigMapRefEnabled?: bool + folder?: str + matchLabels?: ValuesGrafanaOperatorMatchLabels + resyncPeriod?: str + +schema ValuesGrafanaOperatorAnnotations: + r""" + # Annotations for GrafanaDashboard Cr + # + """ + [...str]: any + +schema ValuesGrafanaOperatorMatchLabels: + r""" + # Labels that should be matched kind: Grafana instance + # Example: { app: grafana, category: dashboard } + # + """ + [...str]: any + schema ValuesGrafanaRbac: r""" ValuesGrafanaRbac @@ -3938,7 +4103,7 @@ schema ValuesGrafanaServiceMonitor: ---------- enabled : bool, optional, default is True If true, a ServiceMonitor CRD is created for a prometheus operator - https://github.com/coreos/prometheus-operator + https://github.com/prometheus-operator/prometheus-operator interval : str, optional, default is "" Scrape interval. If not set, the Prometheus default scrape interval is used. @@ -4088,8 +4253,9 @@ schema ValuesGrafanaSidecarDatasources: # createPrometheusReplicasDatasources : bool, optional, default is False # Create datasource for each Pod of Prometheus StatefulSet; - # this uses headless service `prometheus-operated` which is - # created by Prometheus Operator + # this uses by default the headless service `prometheus-operated` which is + # created by Prometheus Operator. In case you deployed your own Service for your + # Prometheus instance, you can specify it with the field `prometheusServiceName` # ref: https://github.com/prometheus-operator/prometheus-operator/blob/0fee93e12dc7c2ea1218f19ae25ec6b893460590/pkg/prometheus/statefulset.go#L255-L286 defaultDatasourceEnabled : bool, optional, default is True enabled : bool, optional, default is True @@ -4102,6 +4268,7 @@ schema ValuesGrafanaSidecarDatasources: label : str, optional, default is "grafana_datasource" labelValue : str, optional, default is "1" name : str, optional, default is "Prometheus" + prometheusServiceName : str, optional, default is "prometheus-operated" uid : str, optional, default is "prometheus" """ [...str]: any @@ -4116,6 +4283,7 @@ schema ValuesGrafanaSidecarDatasources: label?: str labelValue?: str name?: str + prometheusServiceName?: str uid?: str schema ValuesGrafanaSidecarDatasourcesAlertmanager: @@ -4529,6 +4697,8 @@ schema ValuesImageRendererImage: ---------- pullPolicy : str, optional, default is "Always" image-renderer ImagePullPolicy + pullSecrets : [any], optional + image-renderer Image pull secrets (optional) registry : str, optional, default is "docker.io" The Docker registry repository : str, optional, default is "grafana/grafana-image-renderer" @@ -4540,6 +4710,7 @@ schema ValuesImageRendererImage: """ [...str]: any pullPolicy?: str + pullSecrets?: [any] registry?: str repository?: str sha?: str @@ -4827,12 +4998,14 @@ schema ValuesInitChownDataSecurityContext: Attributes ---------- capabilities : ValuesInitChownDataSecurityContextCapabilities, optional + readOnlyRootFilesystem : bool, optional, default is False runAsNonRoot : bool, optional, default is False runAsUser : int, optional, default is 0 seccompProfile : ValuesInitChownDataSecurityContextSeccompProfile, optional """ [...str]: any capabilities?: ValuesInitChownDataSecurityContextCapabilities + readOnlyRootFilesystem?: bool runAsNonRoot?: bool runAsUser?: int seccompProfile?: ValuesInitChownDataSecurityContextSeccompProfile @@ -4844,9 +5017,11 @@ schema ValuesInitChownDataSecurityContextCapabilities: Attributes ---------- add : [str], optional + drop : [str], optional """ [...str]: any add?: [str] + drop?: [str] schema ValuesInitChownDataSecurityContextSeccompProfile: r""" @@ -4950,7 +5125,7 @@ schema ValuesKubeApiServerServiceMonitorMetricRelabelingsItems0: Attributes ---------- action : str, optional, default is "drop" - regex : str, optional, default is "(etcd_request|apiserver_request_slo|apiserver_request_sli|apiserver_request)_duration_seconds_bucket;(0\\.15|0\\.2|0\\.3|0\\.35|0\\.4|0\\.45|0\\.6|0\\.7|0\\.8|0\\.9|1\\.25|1\\.5|1\\.75|2|3|3\\.5|4|4\\.5|6|7|8|9|15|20|30|40|45|50)(\\.0)?" + regex : str, optional, default is "(etcd_request|apiserver_request_slo|apiserver_request_sli|apiserver_request)_duration_seconds_bucket;(0\\.15|0\\.2|0\\.3|0\\.35|0\\.4|0\\.45|0\\.6|0\\.7|0\\.8|0\\.9|1\\.25|1\\.5|1\\.75|2|3|3\\.5|4|4\\.5|6|7|8|9|15|20|40|45|50)(\\.0)?" sourceLabels : [str], optional """ [...str]: any @@ -5006,6 +5181,9 @@ schema ValuesKubeControllerManager: endpoints : [any], optional # If your kube controller manager is not deployed as a pod, specify IPs it can be found on # + jobNameOverride : str, optional, default is "" + Overrides the job selector in Grafana dashboards and Prometheus rules + For k3s clusters, change to k3s-server service : ValuesKubeControllerManagerService, optional # If using kubeControllerManager.endpoints only the port and targetPort are used # @@ -5014,6 +5192,7 @@ schema ValuesKubeControllerManager: [...str]: any enabled?: bool endpoints?: [any] + jobNameOverride?: str service?: ValuesKubeControllerManagerService serviceMonitor?: ValuesKubeControllerManagerServiceMonitor @@ -5474,12 +5653,16 @@ schema ValuesKubeProxy: endpoints : [any], optional # If your kube proxy is not deployed as a pod, specify IPs it can be found on # + jobNameOverride : str, optional, default is "" + Overrides the job selector in Grafana dashboards and Prometheus rules + For k3s clusters, change to k3s-server service : ValuesKubeProxyService, optional serviceMonitor : ValuesKubeProxyServiceMonitor, optional """ [...str]: any enabled?: bool endpoints?: [any] + jobNameOverride?: str service?: ValuesKubeProxyService serviceMonitor?: ValuesKubeProxyServiceMonitor @@ -5623,6 +5806,9 @@ schema ValuesKubeRbacproxy: extraVolumeMounts : [any], optional # Additional volume mounts in the kube-rbac-proxy container # See extraVolumes below + ignoreProbePaths : bool, optional, default is True + This set --ignore-paths=/livez,/readyz to kubeRBACProxy container args + to allow the pod probes working properly with kubeRBACProxy enabled. image : ValuesKubeRbacproxyImage, optional VARIABLE: value port : int, optional, default is 8100 @@ -5649,6 +5835,7 @@ schema ValuesKubeRbacproxy: env?: ValuesKubeRbacproxyEnv extraArgs?: [any] extraVolumeMounts?: [any] + ignoreProbePaths?: bool image?: ValuesKubeRbacproxyImage port?: int portName?: str @@ -5701,7 +5888,7 @@ schema ValuesKubeRbacproxyImage: registry : str, optional, default is "quay.io" repository : str, optional, default is "brancz/kube-rbac-proxy" sha : str, optional, default is "" - tag : str, optional, default is "v0.18.2" + tag : str, optional, default is "v0.20.1" """ [...str]: any pullPolicy?: str @@ -5742,6 +5929,9 @@ schema ValuesKubeScheduler: endpoints : [any], optional # If your kube scheduler is not deployed as a pod, specify IPs it can be found on # + jobNameOverride : str, optional, default is "" + Overrides the job selector in Grafana dashboards and Prometheus rules + For k3s clusters, change to k3s-server service : ValuesKubeSchedulerService, optional # If using kubeScheduler.endpoints only the port and targetPort are used # @@ -5750,6 +5940,7 @@ schema ValuesKubeScheduler: [...str]: any enabled?: bool endpoints?: [any] + jobNameOverride?: str service?: ValuesKubeSchedulerService serviceMonitor?: ValuesKubeSchedulerServiceMonitor @@ -5911,78 +6102,39 @@ schema ValuesKubeStateMetricsPrometheusMonitor: enabled : bool, optional, default is True # Enable scraping via service monitor # Disable to prevent duplication if you enable prometheusScrape above - # - honorLabels : bool, optional, default is True - Keep labels from scraped data, overriding server-side labels - # - interval : str, optional, default is "" - # Scrape interval. If not set, the Prometheus default scrape interval is used. - # - labelLimit : int, optional, default is 0 - # Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. - # - labelNameLengthLimit : int, optional, default is 0 - # Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. - # - labelValueLengthLimit : int, optional, default is 0 - # Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. - # - metricRelabelings : [any], optional - # MetricRelabelConfigs to apply to samples after scraping, but before ingestion. - # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#relabelconfig - # - proxyUrl : str, optional, default is "" - # proxyUrl: URL of a proxy that should be used for scraping. - # - relabelings : [any], optional - # RelabelConfigs to apply to samples before scraping - # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#relabelconfig - # - sampleLimit : int, optional, default is 0 - # SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. - # - scrapeTimeout : str, optional, default is "" - # Scrape Timeout. If not set, the Prometheus default scrape timeout is used. - # - targetLimit : int, optional, default is 0 - # TargetLimit defines a limit on the number of scraped targets that will be accepted. - # + http : ValuesKubeStateMetricsPrometheusMonitorHttp, optional + # kube-state-metrics endpoint + metrics : ValuesKubeStateMetricsPrometheusMonitorMetrics, optional + # selfMonitor endpoint """ [...str]: any enabled?: bool - honorLabels?: bool - interval?: str - labelLimit?: int - labelNameLengthLimit?: int - labelValueLengthLimit?: int - metricRelabelings?: [any] - proxyUrl?: str - relabelings?: [any] - sampleLimit?: int - scrapeTimeout?: str - targetLimit?: int + http?: ValuesKubeStateMetricsPrometheusMonitorHttp + metrics?: ValuesKubeStateMetricsPrometheusMonitorMetrics -schema ValuesKubeStateMetricsRbac: +schema ValuesKubeStateMetricsPrometheusMonitorHttp: r""" - ValuesKubeStateMetricsRbac + # kube-state-metrics endpoint Attributes ---------- - create : bool, optional, default is True + honorLabels : bool, optional, default is True + # Keep labels from scraped data, overriding server-side labels """ [...str]: any - create?: bool + honorLabels?: bool -schema ValuesKubeStateMetricsSelfMonitor: +schema ValuesKubeStateMetricsPrometheusMonitorMetrics: r""" - ValuesKubeStateMetricsSelfMonitor + # selfMonitor endpoint Attributes ---------- - enabled : bool, optional, default is False + honorLabels : bool, optional, default is True + # Keep labels from scraped data, overriding server-side labels """ [...str]: any - enabled?: bool + honorLabels?: bool schema ValuesKubeconfig: r""" @@ -6006,11 +6158,15 @@ schema ValuesKubelet: Attributes ---------- enabled : bool, optional, default is True + jobNameOverride : str, optional, default is "" + Overrides the job selector in Grafana dashboards and Prometheus rules + For k3s clusters, change to k3s-server namespace : str, optional, default is "kube-system" serviceMonitor : ValuesKubeletServiceMonitor, optional """ [...str]: any enabled?: bool + jobNameOverride?: str namespace?: str serviceMonitor?: ValuesKubeletServiceMonitor @@ -6276,6 +6432,12 @@ schema ValuesKubernetesServiceMonitors: [...str]: any enabled?: bool +schema ValuesLabels: + r""" + Labels to be added to the deployment/statefulset + """ + [...str]: any + schema ValuesLdap: r""" # Grafana's LDAP configuration @@ -6542,13 +6704,12 @@ schema ValuesNotifiers: schema ValuesPersistence: r""" # Enable persistence using Persistent Volume Claims - # ref: https://kubernetes.io/docs/user-guide/persistent-volumes/ + # ref: https://kubernetes.io/docs/concepts/storage/persistent-volumes/ # Attributes ---------- accessModes : [str], optional - storageClassName: default disableWarning : bool, optional, default is False enabled : bool, optional, default is False extraPvcLabels : ValuesPersistenceExtraPvcLabels, optional @@ -6569,6 +6730,9 @@ schema ValuesPersistence: # the current value of 'spec.volumeName' and incorporate it into the template. size : str, optional, default is "10Gi" $type : str, optional, default is "pvc" + volumeName : str, optional, default is "" + storageClassName: default + # (Optional) Use this to bind the claim to an existing PersistentVolume (PV) by name. """ [...str]: any accessModes?: [str] @@ -6580,6 +6744,7 @@ schema ValuesPersistence: lookupVolumeName?: bool size?: str $type?: str + volumeName?: str schema ValuesPersistenceExtraPvcLabels: r""" @@ -6634,29 +6799,6 @@ schema ValuesPodLabels: [...str]: any customLableA?: str -schema ValuesPodSecurityPolicy: - r""" - # Specify if a Pod Security Policy for kube-state-metrics must be created - # Ref: https://kubernetes.io/docs/concepts/policy/pod-security-policy/ - # - - Attributes - ---------- - additionalVolumes : [any], optional - annotations : ValuesPodSecurityPolicyAnnotations, optional - enabled : bool, optional, default is False - """ - [...str]: any - additionalVolumes?: [any] - annotations?: ValuesPodSecurityPolicyAnnotations - enabled?: bool - -schema ValuesPodSecurityPolicyAnnotations: - r""" - ValuesPodSecurityPolicyAnnotations - """ - [...str]: any - schema ValuesPrometheus: r""" # Deploy a Prometheus instance @@ -6664,17 +6806,21 @@ schema ValuesPrometheus: Attributes ---------- + additionalLabels : ValuesPrometheusAdditionalLabels, optional + # Additional labels for Prometheus + # additionalPodMonitors : [any], optional - # Fallback scrape protocol used by Prometheus for scraping metrics - # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.ScrapeProtocol + # Attaches node metadata to the discovered targets + # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.AttachMetadata # - fallbackScrapeProtocol: "" + attachMetadata: + node: true additionalRulesForClusterRole : [any], optional additionalServiceMonitors : [any], optional agentMode : bool, optional, default is False # Toggle prometheus into agent mode # Note many of features described below (e.g. rules, query, alerting, remote read, thanos) will not work in agent mode. - # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/designs/prometheus-agent.md + # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/platform/prometheus-agent.md # annotations : ValuesPrometheusAnnotations, optional # Annotations for Prometheus @@ -6704,9 +6850,6 @@ schema ValuesPrometheus: the time series resulting from the configuration through PodMonitor may have different labels. For instance, there will not be the service label any longer which might affect PromQL queries selecting that label. - podSecurityPolicy : ValuesPrometheusPodSecurityPolicy, optional - # Configure additional options for default pod security policy for Prometheus - # ref: https://kubernetes.io/docs/concepts/policy/pod-security-policy/ prometheusSpec : ValuesPrometheusPrometheusSpec, optional # Settings affecting prometheusSpec # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#prometheusspec @@ -6717,7 +6860,10 @@ schema ValuesPrometheus: Be aware that this is an early beta of this feature, kube-prometheus-stack does not guarantee this works and is subject to change. Being BETA this can/will change in the future without notice, do not use unless you want to take that risk - [[ref]](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io%2fv1alpha2) + [[ref]](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io%2fv1alpha2) + scrapeconfig : ValuesPrometheusScrapeconfig, optional + # Create a scrapeConfig resource for scraping the kube-state-metrics service. Use this instead of serviceMonitor + # to have more instances of kube-state-metrics safety. service : ValuesPrometheusService, optional # Configuration for Prometheus service # @@ -6745,6 +6891,7 @@ schema ValuesPrometheus: Needs thanosService to be enabled as well """ [...str]: any + additionalLabels?: ValuesPrometheusAdditionalLabels additionalPodMonitors?: [any] additionalRulesForClusterRole?: [any] additionalServiceMonitors?: [any] @@ -6758,9 +6905,9 @@ schema ValuesPrometheus: networkPolicy?: ValuesPrometheusNetworkPolicy podDisruptionBudget?: ValuesPrometheusPodDisruptionBudget podMonitor?: ValuesPrometheusPodMonitor - podSecurityPolicy?: ValuesPrometheusPodSecurityPolicy prometheusSpec?: ValuesPrometheusPrometheusSpec route?: ValuesPrometheusRoute + scrapeconfig?: ValuesPrometheusScrapeconfig service?: ValuesPrometheusService serviceAccount?: ValuesPrometheusServiceAccount serviceMonitor?: ValuesPrometheusServiceMonitor @@ -6770,6 +6917,13 @@ schema ValuesPrometheus: thanosServiceExternal?: ValuesPrometheusThanosServiceExternal thanosServiceMonitor?: ValuesPrometheusThanosServiceMonitor +schema ValuesPrometheusAdditionalLabels: + r""" + # Additional labels for Prometheus + # + """ + [...str]: any + schema ValuesPrometheusAnnotations: r""" # Annotations for Prometheus @@ -6813,9 +6967,6 @@ schema ValuesPrometheusIngress: Attributes ---------- annotations : ValuesPrometheusIngressAnnotations, optional - For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - ingressClassName: nginx enabled : bool, optional, default is False hosts : [any], optional # Hostnames. @@ -6823,6 +6974,7 @@ schema ValuesPrometheusIngress: # hosts: - prometheus.domain.com + ingressClassName : str, optional, default is "" labels : ValuesPrometheusIngressLabels, optional paths : [any], optional # Paths to use for ingress rules - one path should match the prometheusSpec.routePrefix @@ -6836,15 +6988,14 @@ schema ValuesPrometheusIngress: annotations?: ValuesPrometheusIngressAnnotations enabled?: bool hosts?: [any] + ingressClassName?: str labels?: ValuesPrometheusIngressLabels paths?: [any] tls?: [any] schema ValuesPrometheusIngressAnnotations: r""" - For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - ingressClassName: nginx + ValuesPrometheusIngressAnnotations """ [...str]: any @@ -6863,9 +7014,6 @@ schema ValuesPrometheusIngressPerReplica: Attributes ---------- annotations : ValuesPrometheusIngressPerReplicaAnnotations, optional - For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - ingressClassName: nginx enabled : bool, optional, default is False hostDomain : str, optional, default is "" # Domain that will be used for the per replica ingress @@ -6875,6 +7023,7 @@ schema ValuesPrometheusIngressPerReplica: # # Prefix for the per replica ingress that will have `-$replicaNumber` # appended to the end + ingressClassName : str, optional, default is "" labels : ValuesPrometheusIngressPerReplicaLabels, optional paths : [any], optional # Paths to use for ingress rules @@ -6891,6 +7040,7 @@ schema ValuesPrometheusIngressPerReplica: enabled?: bool hostDomain?: str hostPrefix?: str + ingressClassName?: str labels?: ValuesPrometheusIngressPerReplicaLabels paths?: [any] tlsSecretName?: str @@ -6898,9 +7048,7 @@ schema ValuesPrometheusIngressPerReplica: schema ValuesPrometheusIngressPerReplicaAnnotations: r""" - For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - ingressClassName: nginx + ValuesPrometheusIngressPerReplicaAnnotations """ [...str]: any @@ -7174,10 +7322,12 @@ schema ValuesPrometheusNetworkPolicy: Can be: * kubernetes for networking.k8s.io/v1/NetworkPolicy * cilium for cilium.io/v2/CiliumNetworkPolicy + namespace : any, optional, default is "" """ [...str]: any enabled?: bool flavor?: str + namespace?: any schema ValuesPrometheusNodeExporter: r""" @@ -7210,7 +7360,7 @@ schema ValuesPrometheusNodeExporterPodLabels: Attributes ---------- jobLabel : str, optional, default is "node-exporter" - # Add the 'node-exporter' label to be used by serviceMonitor to match standard common usage in rules and grafana dashboards + # Add the 'node-exporter' label to be used by serviceMonitor and podMonitor to match standard common usage in rules and grafana dashboards # """ [...str]: any @@ -7223,9 +7373,11 @@ schema ValuesPrometheusNodeExporterPrometheus: Attributes ---------- monitor : ValuesPrometheusNodeExporterPrometheusMonitor, optional + podMonitor : ValuesPrometheusNodeExporterPrometheusPodMonitor, optional """ [...str]: any monitor?: ValuesPrometheusNodeExporterPrometheusMonitor + podMonitor?: ValuesPrometheusNodeExporterPrometheusPodMonitor schema ValuesPrometheusNodeExporterPrometheusMonitor: r""" @@ -7282,6 +7434,19 @@ schema ValuesPrometheusNodeExporterPrometheusMonitor: scrapeTimeout?: str targetLimit?: int +schema ValuesPrometheusNodeExporterPrometheusPodMonitor: + r""" + ValuesPrometheusNodeExporterPrometheusPodMonitor + + Attributes + ---------- + enabled : bool, optional, default is False + jobLabel : str, optional, default is "jobLabel" + """ + [...str]: any + enabled?: bool + jobLabel?: str + schema ValuesPrometheusNodeExporterRbac: r""" ValuesPrometheusNodeExporterRbac @@ -7348,7 +7513,7 @@ schema ValuesPrometheusOperator: # rules from making their way into prometheus and potentially preventing the container from starting affinity : ValuesPrometheusOperatorAffinity, optional # Assign custom affinity rules to the prometheus operator - # ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ # alertmanagerConfigNamespaces : [any], optional alertmanagerInstanceNamespaces : [any], optional @@ -7387,7 +7552,7 @@ schema ValuesPrometheusOperator: # VARIABLE: value extraArgs : [any], optional # Extra arguments to pass to prometheusOperator - https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/operator.md + https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/platform/operator.md extraVolumeMounts : [any], optional # Additional volume mounts # @@ -7430,11 +7595,14 @@ schema ValuesPrometheusOperator: clusterDomain: "cluster.local" nodeSelector : ValuesPrometheusOperatorNodeSelector, optional # Define which Nodes the Pods are scheduled on. - # ref: https://kubernetes.io/docs/user-guide/node-selection/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector # podAnnotations : ValuesPrometheusOperatorPodAnnotations, optional # Annotations to add to the operator pod # + podDisruptionBudget : ValuesPrometheusOperatorPodDisruptionBudget, optional + # Assign a podDisruptionBudget to the operator + # podLabels : ValuesPrometheusOperatorPodLabels, optional # Labels to add to the operator pod # @@ -7493,7 +7661,7 @@ schema ValuesPrometheusOperator: # tolerations : [any], optional # Tolerations for use with node taints - # ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ # verticalPodAutoscaler : ValuesPrometheusOperatorVerticalPodAutoscaler, optional Enable vertical pod autoscaler support for prometheus-operator @@ -7527,6 +7695,7 @@ schema ValuesPrometheusOperator: networkPolicy?: ValuesPrometheusOperatorNetworkPolicy nodeSelector?: ValuesPrometheusOperatorNodeSelector podAnnotations?: ValuesPrometheusOperatorPodAnnotations + podDisruptionBudget?: ValuesPrometheusOperatorPodDisruptionBudget podLabels?: ValuesPrometheusOperatorPodLabels prometheusConfigReloader?: ValuesPrometheusOperatorPrometheusConfigReloader prometheusInstanceNamespaces?: [any] @@ -7572,6 +7741,7 @@ schema ValuesPrometheusOperatorAdmissionWebhooks: failurePolicy : str, optional, default is "" # Valid values: Fail, Ignore, IgnoreOnInstallOnly # IgnoreOnInstallOnly - If Release.IsInstall returns "true", set "Ignore" otherwise "Fail" + matchConditions : ValuesPrometheusOperatorAdmissionWebhooksMatchConditions, optional mutatingWebhookConfiguration : ValuesPrometheusOperatorAdmissionWebhooksMutatingWebhookConfiguration, optional namespaceSelector : ValuesPrometheusOperatorAdmissionWebhooksNamespaceSelector, optional objectSelector : ValuesPrometheusOperatorAdmissionWebhooksObjectSelector, optional @@ -7589,6 +7759,7 @@ schema ValuesPrometheusOperatorAdmissionWebhooks: deployment?: ValuesPrometheusOperatorAdmissionWebhooksDeployment enabled?: bool failurePolicy?: str + matchConditions?: ValuesPrometheusOperatorAdmissionWebhooksMatchConditions mutatingWebhookConfiguration?: ValuesPrometheusOperatorAdmissionWebhooksMutatingWebhookConfiguration namespaceSelector?: ValuesPrometheusOperatorAdmissionWebhooksNamespaceSelector objectSelector?: ValuesPrometheusOperatorAdmissionWebhooksObjectSelector @@ -7699,7 +7870,7 @@ schema ValuesPrometheusOperatorAdmissionWebhooksDeployment: ---------- affinity : ValuesPrometheusOperatorAdmissionWebhooksDeploymentAffinity, optional # Assign custom affinity rules to the prometheus operator - # ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ # annotations : ValuesPrometheusOperatorAdmissionWebhooksDeploymentAnnotations, optional # Annotations to add to the operator webhook deployment @@ -7737,7 +7908,7 @@ schema ValuesPrometheusOperatorAdmissionWebhooksDeployment: # nodeSelector : ValuesPrometheusOperatorAdmissionWebhooksDeploymentNodeSelector, optional # Define which Nodes the Pods are scheduled on. - # ref: https://kubernetes.io/docs/user-guide/node-selection/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector # podAnnotations : ValuesPrometheusOperatorAdmissionWebhooksDeploymentPodAnnotations, optional # Annotations to add to the operator webhook pod @@ -7784,7 +7955,7 @@ schema ValuesPrometheusOperatorAdmissionWebhooksDeployment: # tolerations : [any], optional # Tolerations for use with node taints - # ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ # """ [...str]: any @@ -7816,7 +7987,7 @@ schema ValuesPrometheusOperatorAdmissionWebhooksDeployment: schema ValuesPrometheusOperatorAdmissionWebhooksDeploymentAffinity: r""" # Assign custom affinity rules to the prometheus operator - # ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ # """ [...str]: any @@ -7923,7 +8094,7 @@ schema ValuesPrometheusOperatorAdmissionWebhooksDeploymentLivenessProbe: schema ValuesPrometheusOperatorAdmissionWebhooksDeploymentNodeSelector: r""" # Define which Nodes the Pods are scheduled on. - # ref: https://kubernetes.io/docs/user-guide/node-selection/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector # """ [...str]: any @@ -7938,8 +8109,18 @@ schema ValuesPrometheusOperatorAdmissionWebhooksDeploymentPodAnnotations: schema ValuesPrometheusOperatorAdmissionWebhooksDeploymentPodDisruptionBudget: r""" Ref: https://kubernetes.io/docs/tasks/run-application/configure-pdb/ + + Attributes + ---------- + enabled : bool, optional, default is False + minAvailable : int, optional, default is 1 + unhealthyPodEvictionPolicy : str, optional, default is "AlwaysAllow" + maxUnavailable: "" """ [...str]: any + enabled?: bool + minAvailable?: int + unhealthyPodEvictionPolicy?: str schema ValuesPrometheusOperatorAdmissionWebhooksDeploymentPodLabels: r""" @@ -8030,7 +8211,7 @@ schema ValuesPrometheusOperatorAdmissionWebhooksDeploymentService: clusterIP : str, optional, default is "" externalIPs : [any], optional # List of IP addresses at which the Prometheus server service is available - # Ref: https://kubernetes.io/docs/user-guide/services/#external-ips + # Ref: https://kubernetes.io/docs/concepts/services-networking/service/#external-ips # externalTrafficPolicy : str, optional, default is "Cluster" # Denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints @@ -8136,13 +8317,19 @@ schema ValuesPrometheusOperatorAdmissionWebhooksDeploymentTls: internalPort : int, optional, default is 10250 The default webhook port is 10250 in order to work out-of-the-box in GKE private clusters and avoid adding firewall rules. tlsMinVersion : str, optional, default is "VersionTLS13" - Value must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants + Value must match version names from https://pkg.go.dev/crypto/tls#pkg-constants """ [...str]: any enabled?: bool internalPort?: int tlsMinVersion?: str +schema ValuesPrometheusOperatorAdmissionWebhooksMatchConditions: + r""" + ValuesPrometheusOperatorAdmissionWebhooksMatchConditions + """ + [...str]: any + schema ValuesPrometheusOperatorAdmissionWebhooksMutatingWebhookConfiguration: r""" ValuesPrometheusOperatorAdmissionWebhooksMutatingWebhookConfiguration @@ -8235,10 +8422,10 @@ schema ValuesPrometheusOperatorAdmissionWebhooksPatchImage: Attributes ---------- pullPolicy : str, optional, default is "IfNotPresent" - registry : str, optional, default is "registry.k8s.io" - repository : str, optional, default is "ingress-nginx/kube-webhook-certgen" + registry : str, optional, default is "ghcr.io" + repository : str, optional, default is "jkroepke/kube-webhook-certgen" sha : str, optional, default is "" - tag : str, optional, default is "v1.5.1" + tag : str, optional, default is "1.7.3" """ [...str]: any pullPolicy?: str @@ -8377,7 +8564,7 @@ schema ValuesPrometheusOperatorAdmissionWebhooksValidatingWebhookConfigurationAn schema ValuesPrometheusOperatorAffinity: r""" # Assign custom affinity rules to the prometheus operator - # ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ # """ [...str]: any @@ -8556,7 +8743,7 @@ schema ValuesPrometheusOperatorNetworkPolicy: schema ValuesPrometheusOperatorNodeSelector: r""" # Define which Nodes the Pods are scheduled on. - # ref: https://kubernetes.io/docs/user-guide/node-selection/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector # """ [...str]: any @@ -8568,6 +8755,23 @@ schema ValuesPrometheusOperatorPodAnnotations: """ [...str]: any +schema ValuesPrometheusOperatorPodDisruptionBudget: + r""" + # Assign a podDisruptionBudget to the operator + # + + Attributes + ---------- + enabled : bool, optional, default is False + minAvailable : int, optional, default is 1 + unhealthyPodEvictionPolicy : str, optional, default is "AlwaysAllow" + maxUnavailable: "" + """ + [...str]: any + enabled?: bool + minAvailable?: int + unhealthyPodEvictionPolicy?: str + schema ValuesPrometheusOperatorPodLabels: r""" # Labels to add to the operator pod @@ -8699,7 +8903,7 @@ schema ValuesPrometheusOperatorService: clusterIP : str, optional, default is "" externalIPs : [any], optional # List of IP addresses at which the Prometheus server service is available - # Ref: https://kubernetes.io/docs/user-guide/services/#external-ips + # Ref: https://kubernetes.io/docs/concepts/services-networking/service/#external-ips # externalTrafficPolicy : str, optional, default is "Cluster" # Denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints @@ -8859,7 +9063,7 @@ schema ValuesPrometheusOperatorThanosImage: registry : str, optional, default is "quay.io" repository : str, optional, default is "thanos/thanos" sha : str, optional, default is "" - tag : str, optional, default is "v0.37.2" + tag : str, optional, default is "v0.40.1" """ [...str]: any registry?: str @@ -8878,7 +9082,7 @@ schema ValuesPrometheusOperatorTls: internalPort : int, optional, default is 10250 The default webhook port is 10250 in order to work out-of-the-box in GKE private clusters and avoid adding firewall rules. tlsMinVersion : str, optional, default is "VersionTLS13" - Value must match version names from https://golang.org/pkg/crypto/tls/#pkg-constants + Value must match version names from https://pkg.go.dev/crypto/tls#pkg-constants """ [...str]: any enabled?: bool @@ -8947,13 +9151,14 @@ schema ValuesPrometheusPodDisruptionBudget: Attributes ---------- enabled : bool, optional, default is False - maxUnavailable : str, optional, default is "" minAvailable : int, optional, default is 1 + unhealthyPodEvictionPolicy : str, optional, default is "AlwaysAllow" + maxUnavailable: "" """ [...str]: any enabled?: bool - maxUnavailable?: str minAvailable?: int + unhealthyPodEvictionPolicy?: str schema ValuesPrometheusPodMonitor: r""" @@ -8993,11 +9198,11 @@ schema ValuesPrometheusPodMonitor: followRedirects : str, optional, default is "" FollowRedirects configures whether scrape requests follow HTTP 3xx redirects. Default false. honorLabels : bool, optional, default is True - HonorLabels chooses the metric’s labels on collisions with target labels. + HonorLabels chooses the metric's labels on collisions with target labels. honorTimestamps : bool, optional, default is True HonorTimestamps controls whether Prometheus respects the timestamps present in scraped data. interval : str, optional, default is "" - Interval at which endpoints should be scraped. If not specified Prometheus’ global scrape interval is used. + Interval at which endpoints should be scraped. If not specified Prometheus' global scrape interval is used. jobLabel : str, optional, default is "" The label to use to retrieve the job name from. Defaults to label app.kubernetes.io/name. labelLimit : int, optional, default is 0 @@ -9027,7 +9232,7 @@ schema ValuesPrometheusPodMonitor: ProxyURL eg http://proxyserver:2195. Directs scrapes through proxy to this endpoint. relabelings : [any], optional RelabelConfigs to apply to samples before scraping. Prometheus Operator automatically adds - relabelings for a few standard Kubernetes fields. The original scrape job’s name + relabelings for a few standard Kubernetes fields. The original scrape job's name is available via the __tmp_prometheus_job_name label. More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config sampleLimit : int, optional, default is 0 @@ -9140,22 +9345,6 @@ schema ValuesPrometheusPodMonitorTlsConfig: """ [...str]: any -schema ValuesPrometheusPodSecurityPolicy: - r""" - # Configure additional options for default pod security policy for Prometheus - # ref: https://kubernetes.io/docs/concepts/policy/pod-security-policy/ - - Attributes - ---------- - allowedCapabilities : [any], optional - allowedHostPaths : [any], optional - volumes : [any], optional - """ - [...str]: any - allowedCapabilities?: [any] - allowedHostPaths?: [any] - volumes?: [any] - schema ValuesPrometheusPrometheusSpec: r""" # Settings affecting prometheusSpec @@ -9166,7 +9355,7 @@ schema ValuesPrometheusPrometheusSpec: ---------- additionalAlertManagerConfigs : [any], optional # AdditionalAlertManagerConfigs allows for manual configuration of alertmanager jobs in the form as specified - # in the official Prometheus documentation https://prometheus.io/docs/prometheus/latest/configuration/configuration/#. + # in the official Prometheus documentation https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config. # AlertManager configurations specified are appended to the configurations generated by the Prometheus Operator. # As AlertManager configs are appended, the user is responsible to make sure it is valid. Note that using this # feature may expose the possibility to break upgrades of Prometheus. It is advised to review Prometheus release @@ -9227,7 +9416,7 @@ schema ValuesPrometheusPrometheusSpec: # Cannot be used with additionalScrapeConfigs affinity : ValuesPrometheusPrometheusSpecAffinity, optional # Assign custom affinity rules to the prometheus instance - # ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ # alertingEndpoints : [any], optional # Alertmanagers to which alerts will be sent @@ -9247,9 +9436,9 @@ schema ValuesPrometheusPrometheusSpec: # on the file system of the Prometheus container e.g. bearer token files. automountServiceAccountToken : bool, optional, default is True # AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod, - # If the field isn’t set, the operator mounts the service account token by default. + # If the field isn't set, the operator mounts the service account token by default. # Warning: be aware that by default, Prometheus requires the service account token for Kubernetes service discovery, - # It is possible to use strategic merge patch to project the service account token into the ‘prometheus’ container. + # It is possible to use strategic merge patch to project the service account token into the 'prometheus' container. configMaps : [any], optional # ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus object, which shall be mounted into the Prometheus Pods. # The ConfigMaps are mounted into /etc/prometheus/configmaps/. @@ -9260,6 +9449,12 @@ schema ValuesPrometheusPrometheusSpec: disableCompaction : bool, optional, default is False # If true, pass --storage.tsdb.max-block-duration=2h to prometheus. This is already done if using Thanos # + dnsConfig : ValuesPrometheusPrometheusSpecDnsConfig, optional + # DNS configuration for Prometheus. + # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.PodDNSConfig + dnsPolicy : str, optional, default is "" + # DNS policy for Prometheus. + # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#dnspolicystring-alias enableAdminAPI : bool, optional, default is False # EnableAdminAPI enables Prometheus the administrative HTTP API which includes functionality such as deleting time series. # This is disabled by default. @@ -9267,7 +9462,9 @@ schema ValuesPrometheusPrometheusSpec: # enableFeatures : [any], optional EnableFeatures API enables access to Prometheus disabled features. - ref: https://prometheus.io/docs/prometheus/latest/disabled_features/ + ref: https://prometheus.io/docs/prometheus/latest/feature_flags/ + enableOTLPReceiver : bool, optional, default is False + # enableOTLPReceiver enables the OTLP receiver for Prometheus. enableRemoteWriteReceiver : bool, optional, default is False # enable --web.enable-remote-write-receiver flag on prometheus-server # @@ -9319,7 +9516,7 @@ schema ValuesPrometheusPrometheusSpec: # hostAliases : [any], optional HostAlias holds the mapping between IP and hostnames that will be injected - as an entry in the pod’s hosts file. + as an entry in the pod's hosts file. hostNetwork : bool, optional, default is False Required for use in managed kubernetes clusters (such as AWS EKS) with custom CNI (such as calico), because control-plane managed by AWS cannot communicate with pods' IP CIDR and admission webhooks are not working @@ -9359,7 +9556,10 @@ schema ValuesPrometheusPrometheusSpec: # Supported values are: Legacy, UTF8 nodeSelector : ValuesPrometheusPrometheusSpecNodeSelector, optional # Define which Nodes the Pods are scheduled on. - # ref: https://kubernetes.io/docs/user-guide/node-selection/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector + # + otlp : ValuesPrometheusPrometheusSpecOtlp, optional + # https://prometheus.io/docs/guides/opentelemetry # overrideHonorLabels : bool, optional, default is False # OverrideHonorLabels if set to true overrides all user configured honor_labels. If HonorLabels is set in ServiceMonitor @@ -9400,6 +9600,9 @@ schema ValuesPrometheusPrometheusSpec: # prometheus resource to be created with selectors based on values in the helm deployment, # which will also match the podmonitors created # + podTargetLabels : [any], optional + # PodTargetLabels are appended to the `spec.podTargetLabels` field of all PodMonitor and ServiceMonitor objects. + # portName : str, optional, default is "http-web" # PortName to use for Prometheus. # @@ -9462,7 +9665,7 @@ schema ValuesPrometheusPrometheusSpec: # retentionSize : str, optional, default is "" # Maximum size of metrics - # + # Unit format should be in the form of "50GiB" routePrefix : str, optional, default is "/" # Prefix used to register routes, overriding externalUrl route. # Useful for proxies that rewrite URLs. @@ -9511,6 +9714,9 @@ schema ValuesPrometheusPrometheusSpec: # Defaults to 30s. # ref: https://github.com/prometheus-operator/prometheus-operator/blob/release-0.44/pkg/prometheus/promcfg.go#L180-L183 # + scrapeProtocols : [any], optional + # Set default scrapeProtocols for Prometheus instances + # https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#scrapeprotocolstring-alias scrapeTimeout : str, optional, default is "" # Number of seconds to wait for target to respond before erroring # @@ -9527,7 +9733,7 @@ schema ValuesPrometheusPrometheusSpec: # serviceDiscoveryRole : str, optional, default is "" # Defines the service discovery role used to discover targets from ServiceMonitor objects and Alertmanager endpoints. - # If set, the value should be either “Endpoints” or “EndpointSlice”. If unset, the operator assumes the “Endpoints” role. + # If set, the value should be either "Endpoints" or "EndpointSlice". If unset, the operator assumes the "Endpoints" role. serviceMonitorNamespaceSelector : ValuesPrometheusPrometheusSpecServiceMonitorNamespaceSelector, optional # Namespaces to be selected for ServiceMonitor discovery. # @@ -9540,6 +9746,8 @@ schema ValuesPrometheusPrometheusSpec: # prometheus resource to be created with selectors based on values in the helm deployment, # which will also match the servicemonitors created # + serviceName : any, optional, default is "" + # shards : int, optional, default is 1 # EXPERIMENTAL: Number of shards to distribute targets onto. # Number of replicas multiplied by shards is the total number of Pods created. @@ -9560,11 +9768,11 @@ schema ValuesPrometheusPrometheusSpec: # tolerations : [any], optional # Tolerations for use with node taints - # ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ # topologySpreadConstraints : [any], optional # If specified, the pod's topology spread constraints. - # ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/ # tracingConfig : ValuesPrometheusPrometheusSpecTracingConfig, optional # TracingConfig configures tracing in Prometheus. @@ -9608,8 +9816,11 @@ schema ValuesPrometheusPrometheusSpec: configMaps?: [any] containers?: [any] disableCompaction?: bool + dnsConfig?: ValuesPrometheusPrometheusSpecDnsConfig + dnsPolicy?: str enableAdminAPI?: bool enableFeatures?: [any] + enableOTLPReceiver?: bool enableRemoteWriteReceiver?: bool enforcedKeepDroppedTargets?: int enforcedLabelLimit?: bool @@ -9635,6 +9846,7 @@ schema ValuesPrometheusPrometheusSpec: minReadySeconds?: int nameValidationScheme?: str nodeSelector?: ValuesPrometheusPrometheusSpecNodeSelector + otlp?: ValuesPrometheusPrometheusSpecOtlp overrideHonorLabels?: bool overrideHonorTimestamps?: bool paused?: bool @@ -9645,6 +9857,7 @@ schema ValuesPrometheusPrometheusSpec: podMonitorNamespaceSelector?: ValuesPrometheusPrometheusSpecPodMonitorNamespaceSelector podMonitorSelector?: ValuesPrometheusPrometheusSpecPodMonitorSelector podMonitorSelectorNilUsesHelmValues?: bool + podTargetLabels?: [any] portName?: str priorityClassName?: str probeNamespaceSelector?: ValuesPrometheusPrometheusSpecProbeNamespaceSelector @@ -9675,6 +9888,7 @@ schema ValuesPrometheusPrometheusSpec: scrapeConfigSelectorNilUsesHelmValues?: bool scrapeFailureLogFile?: str scrapeInterval?: str + scrapeProtocols?: [any] scrapeTimeout?: str secrets?: [any] securityContext?: ValuesPrometheusPrometheusSpecSecurityContext @@ -9682,6 +9896,7 @@ schema ValuesPrometheusPrometheusSpec: serviceMonitorNamespaceSelector?: ValuesPrometheusPrometheusSpecServiceMonitorNamespaceSelector serviceMonitorSelector?: ValuesPrometheusPrometheusSpecServiceMonitorSelector serviceMonitorSelectorNilUsesHelmValues?: bool + serviceName?: any shards?: int storageSpec?: ValuesPrometheusPrometheusSpecStorageSpec thanos?: ValuesPrometheusPrometheusSpecThanos @@ -9737,7 +9952,7 @@ schema ValuesPrometheusPrometheusSpecAdditionalScrapeConfigsSecret: schema ValuesPrometheusPrometheusSpecAffinity: r""" # Assign custom affinity rules to the prometheus instance - # ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ # """ [...str]: any @@ -9750,6 +9965,13 @@ schema ValuesPrometheusPrometheusSpecApiserverConfig: """ [...str]: any +schema ValuesPrometheusPrometheusSpecDnsConfig: + r""" + # DNS configuration for Prometheus. + # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#monitoring.coreos.com/v1.PodDNSConfig + """ + [...str]: any + schema ValuesPrometheusPrometheusSpecExemplars: r""" # Exemplars related settings that are runtime reloadable. @@ -9771,12 +9993,14 @@ schema ValuesPrometheusPrometheusSpecImage: Attributes ---------- + pullPolicy : str, optional, default is "IfNotPresent" registry : str, optional, default is "quay.io" repository : str, optional, default is "prometheus/prometheus" sha : str, optional, default is "" - tag : str, optional, default is "v3.2.1" + tag : str, optional, default is "v3.8.0" """ [...str]: any + pullPolicy?: str registry?: str repository?: str sha?: str @@ -9785,7 +10009,14 @@ schema ValuesPrometheusPrometheusSpecImage: schema ValuesPrometheusPrometheusSpecNodeSelector: r""" # Define which Nodes the Pods are scheduled on. - # ref: https://kubernetes.io/docs/user-guide/node-selection/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector + # + """ + [...str]: any + +schema ValuesPrometheusPrometheusSpecOtlp: + r""" + # https://prometheus.io/docs/guides/opentelemetry # """ [...str]: any @@ -9980,7 +10211,7 @@ schema ValuesPrometheusRoute: Be aware that this is an early beta of this feature, kube-prometheus-stack does not guarantee this works and is subject to change. Being BETA this can/will change in the future without notice, do not use unless you want to take that risk - [[ref]](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io%2fv1alpha2) + [[ref]](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io%2fv1alpha2) Attributes ---------- @@ -10066,6 +10297,91 @@ schema ValuesPrometheusRouteMainMatchesItems0Path: $type?: str value?: str +schema ValuesPrometheusScrapeconfig: + r""" + # Create a scrapeConfig resource for scraping the kube-state-metrics service. Use this instead of serviceMonitor + # to have more instances of kube-state-metrics safety. + + Attributes + ---------- + additionalLabels : ValuesPrometheusScrapeconfigAdditionalLabels, optional + annotations : ValuesPrometheusScrapeconfigAnnotations, optional + enableHttp2 : bool, optional, default is False + # Whether to enable HTTP2 for scrapeconfig + enabled : bool, optional, default is False + # To avoid duplicate metrics, first disable the serviceMonitor creation via prometheus.monitor.enabled=false + honorLabels : bool, optional, default is True + jobName : str, optional, default is "kube-state-metrics" + labelLimit : int, optional, default is 0 + # Per-scrape limit on number of labels that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. + # + labelNameLengthLimit : int, optional, default is 0 + # Per-scrape limit on length of labels name that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. + # + labelValueLengthLimit : int, optional, default is 0 + # Per-scrape limit on length of labels value that will be accepted for a sample. Only valid in Prometheus versions 2.27.0 and newer. + # + metricRelabelings : [any], optional + proxyUrl : str, optional, default is "" + relabelings : [any], optional + sampleLimit : int, optional, default is 0 + # SampleLimit defines per-scrape limit on number of scraped samples that will be accepted. + # + scheme : str, optional, default is "" + scrapeInterval : str, optional, default is "" + scrapeTimeout : str, optional, default is "" + staticConfigLabels : ValuesPrometheusScrapeconfigStaticConfigLabels, optional + # StaticConfigLabels defines the labels to be used in the Prometheus static configuration for scraping. + targetLimit : int, optional, default is 0 + # TargetLimit defines a limit on the number of scraped targets that will be accepted. + # + tlsConfig : ValuesPrometheusScrapeconfigTlsConfig, optional + """ + [...str]: any + additionalLabels?: ValuesPrometheusScrapeconfigAdditionalLabels + annotations?: ValuesPrometheusScrapeconfigAnnotations + enableHttp2?: bool + enabled?: bool + honorLabels?: bool + jobName?: str + labelLimit?: int + labelNameLengthLimit?: int + labelValueLengthLimit?: int + metricRelabelings?: [any] + proxyUrl?: str + relabelings?: [any] + sampleLimit?: int + scheme?: str + scrapeInterval?: str + scrapeTimeout?: str + staticConfigLabels?: ValuesPrometheusScrapeconfigStaticConfigLabels + targetLimit?: int + tlsConfig?: ValuesPrometheusScrapeconfigTlsConfig + +schema ValuesPrometheusScrapeconfigAdditionalLabels: + r""" + ValuesPrometheusScrapeconfigAdditionalLabels + """ + [...str]: any + +schema ValuesPrometheusScrapeconfigAnnotations: + r""" + ValuesPrometheusScrapeconfigAnnotations + """ + [...str]: any + +schema ValuesPrometheusScrapeconfigStaticConfigLabels: + r""" + # StaticConfigLabels defines the labels to be used in the Prometheus static configuration for scraping. + """ + [...str]: any + +schema ValuesPrometheusScrapeconfigTlsConfig: + r""" + ValuesPrometheusScrapeconfigTlsConfig + """ + [...str]: any + schema ValuesPrometheusService: r""" # Configuration for Prometheus service @@ -10078,9 +10394,10 @@ schema ValuesPrometheusService: # annotations : ValuesPrometheusServiceAnnotations, optional clusterIP : str, optional, default is "" + enabled : bool, optional, default is True externalIPs : [any], optional # List of IP addresses at which the Prometheus server service is available - # Ref: https://kubernetes.io/docs/user-guide/services/#external-ips + # Ref: https://kubernetes.io/docs/concepts/services-networking/service/#external-ips # externalTrafficPolicy : str, optional, default is "Cluster" # Denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints @@ -10122,6 +10439,7 @@ schema ValuesPrometheusService: additionalPorts?: [any] annotations?: ValuesPrometheusServiceAnnotations clusterIP?: str + enabled?: bool externalIPs?: [any] externalTrafficPolicy?: str ipDualStack?: ValuesPrometheusServiceIpDualStack @@ -10360,13 +10678,11 @@ schema ValuesPrometheusThanosIngress: Attributes ---------- annotations : ValuesPrometheusThanosIngressAnnotations, optional - For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - ingressClassName: nginx enabled : bool, optional, default is False hosts : [any], optional # Hosts must be provided if Ingress is enabled. # + ingressClassName : str, optional, default is "" labels : ValuesPrometheusThanosIngressLabels, optional nodePort : int, optional, default is 30901 # Port to expose on each node @@ -10385,6 +10701,7 @@ schema ValuesPrometheusThanosIngress: annotations?: ValuesPrometheusThanosIngressAnnotations enabled?: bool hosts?: [any] + ingressClassName?: str labels?: ValuesPrometheusThanosIngressLabels nodePort?: int paths?: [any] @@ -10393,9 +10710,7 @@ schema ValuesPrometheusThanosIngress: schema ValuesPrometheusThanosIngressAnnotations: r""" - For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - ingressClassName: nginx + ValuesPrometheusThanosIngressAnnotations """ [...str]: any @@ -10569,7 +10884,7 @@ schema ValuesPrometheusThanosServiceMonitor: # scheme: HTTP scheme to use for scraping. Can be used with `tlsConfig` for example if using istio mTLS. tlsConfig : ValuesPrometheusThanosServiceMonitorTlsConfig, optional # tlsConfig: TLS configuration to use when scraping the endpoint. For example if using istio mTLS. - # Of type: https://github.com/coreos/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig + # Of type: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig """ [...str]: any additionalLabels?: ValuesPrometheusThanosServiceMonitorAdditionalLabels @@ -10591,7 +10906,7 @@ schema ValuesPrometheusThanosServiceMonitorAdditionalLabels: schema ValuesPrometheusThanosServiceMonitorTlsConfig: r""" # tlsConfig: TLS configuration to use when scraping the endpoint. For example if using istio mTLS. - # Of type: https://github.com/coreos/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig + # Of type: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig """ [...str]: any @@ -10678,10 +10993,10 @@ schema ValuesRbac: resources: ["prometheuses"] verbs: ["list", "watch"] namespaced : bool, optional, default is False - pspAnnotations : ValuesRbacPspAnnotations, optional - pspEnabled : bool, optional, default is True - # If true, create & use Pod Security Policy resources - # https://kubernetes.io/docs/concepts/policy/pod-security-policy/ + pspEnabled : bool, optional, default is False + # Use an existing ClusterRole/Role (depending on rbac.namespaced false/true) + useExistingRole: name-of-some-role + useExistingClusterRole: name-of-some-clusterRole pspUseAppArmor : bool, optional, default is False useClusterRole : bool, optional, default is True If set to false - Run without Cluteradmin privs needed - ONLY works if namespace is also set (if useExistingRole is set this name is used as ClusterRole or Role to bind to) @@ -10692,17 +11007,10 @@ schema ValuesRbac: extraRoleRules?: [any] extraRules?: [any] namespaced?: bool - pspAnnotations?: ValuesRbacPspAnnotations pspEnabled?: bool pspUseAppArmor?: bool useClusterRole?: bool -schema ValuesRbacPspAnnotations: - r""" - ValuesRbacPspAnnotations - """ - [...str]: any - schema ValuesReadinessProbe: r""" # Readiness probe @@ -11033,7 +11341,9 @@ schema ValuesService: enabled : bool, optional, default is True # Creating a service is enabled by default externalTrafficPolicy : str, optional, default is "" - # External traffic policy setting (Cluster, Local) + # External/Internal traffic policy setting (Cluster, Local) + # https://kubernetes.io/docs/reference/networking/virtual-ips/#traffic-policies + internalTrafficPolicy : str, optional, default is "" ipDualStack : ValuesServiceIpDualStack, optional # Dual stack settings for the service # https://kubernetes.io/docs/concepts/services-networking/dual-stack/#services @@ -11070,6 +11380,7 @@ schema ValuesService: clusterIP?: str enabled?: bool externalTrafficPolicy?: str + internalTrafficPolicy?: str ipDualStack?: ValuesServiceIpDualStack ipFamilies?: [any] ipFamilyPolicy?: str @@ -11273,18 +11584,42 @@ schema ValuesSidecarAlerts: enabled : bool, optional, default is False env : ValuesSidecarAlertsEnv, optional Additional environment variables for the alerts sidecar + envValueFrom : ValuesSidecarAlertsEnvValueFrom, optional + # "valueFrom" environment variable references that will be added to deployment pods. Name is templated. + # ref: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#envvarsource-v1-core + # Renders in container spec as: + # env: + # ... + # - name: + # valueFrom: + # extraMounts : [any], optional + Use native sidecar https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/ + restartPolicy: Always + # only applies to native sidecars + startupProbe: + httpGet: + path: /healthz + port: 8080 + initialDelaySeconds: 5 + periodSeconds: 5 + failureThreshold: 60 # 5 minutes Additional alerts sidecar volume mounts initAlerts : bool, optional, default is False This is needed if skipReload is true, to load any alerts defined at startup time. Deploy the alert sidecar as an initContainer. label : str, optional, default is "grafana_alert" + ENV_NAME: + configMapKeyRef: + name: configmap-name + key: value_key Do not reprocess already processed unchanged resources on k8s API reconnect. ignoreAlreadyProcessed: true - label that the configmaps with alert are marked with + label that the configmaps with alert are marked with (can be templated) labelValue : str, optional, default is "" - value of label that the configmaps with alert are set to + value of label that the configmaps with alert are set to (can be templated) reloadURL : str, optional, default is "http://localhost:3000/api/admin/provisioning/alerting/reload" + watchServerTimeout: request to the server, asking it to cleanly close the connection after that. defaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S watchServerTimeout: 3600 @@ -11315,15 +11650,23 @@ schema ValuesSidecarAlerts: Endpoint to send request to reload alerts resource : str, optional, default is "both" search in configmap, secret or both + resourceName : str, optional, default is "" + + resourceName: comma separated list of resource names to be fetched/checked by this sidecar. + per default all resources of the type defined in {{ .Values.sidecar.alerts.resource }} will be checked. + This e.g. allows stricter RBAC rules which are limited to the resources meant for the sidecars. + resourceName: "secret/alerts-1,configmap/alerts-0" script : any, optional, default is "null" - Absolute path to shell script to execute after a alert got reloaded + Absolute path to a script to execute after a configmap got reloaded. + It runs before calls to REQ_URI. If the file is not executable it will be passed to sh. + Otherwise, it's executed as is. Shebangs known to work are #!/bin/sh and #!/usr/bin/env python searchNamespace : any, optional, default is "null" Log level. Can be one of: DEBUG, INFO, WARN, ERROR, CRITICAL. logLevel: INFO If specified, the sidecar will search for alert config-maps inside this namespace. Otherwise the namespace in which the sidecar is running will be used. It's also possible to specify ALL to search in all namespaces - sizeLimit : ValuesSidecarAlertsSizeLimit, optional + sizeLimit : str, optional, default is "" Sets the size limit of the alert sidecar emptyDir volume skipReload : bool, optional, default is False watchMethod : str, optional, default is "WATCH" @@ -11332,15 +11675,17 @@ schema ValuesSidecarAlerts: [...str]: any enabled?: bool env?: ValuesSidecarAlertsEnv + envValueFrom?: ValuesSidecarAlertsEnvValueFrom extraMounts?: [any] initAlerts?: bool label?: str labelValue?: str reloadURL?: str resource?: str + resourceName?: str script?: any searchNamespace?: any - sizeLimit?: ValuesSidecarAlertsSizeLimit + sizeLimit?: str skipReload?: bool watchMethod?: str @@ -11350,11 +11695,99 @@ schema ValuesSidecarAlertsEnv: """ [...str]: any -schema ValuesSidecarAlertsSizeLimit: +schema ValuesSidecarAlertsEnvValueFrom: + r""" + # "valueFrom" environment variable references that will be added to deployment pods. Name is templated. + # ref: https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#envvarsource-v1-core + # Renders in container spec as: + # env: + # ... + # - name: + # valueFrom: + # + + Attributes + ---------- + VAR1 : ValuesSidecarAlertsEnvValueFromVar1, optional + VAR2 : ValuesSidecarAlertsEnvValueFromVar2, optional + VAR3 : ValuesSidecarAlertsEnvValueFromVar3, optional + """ + [...str]: any + VAR1?: ValuesSidecarAlertsEnvValueFromVar1 + VAR2?: ValuesSidecarAlertsEnvValueFromVar2 + VAR3?: ValuesSidecarAlertsEnvValueFromVar3 + +schema ValuesSidecarAlertsEnvValueFromVar1: r""" - Sets the size limit of the alert sidecar emptyDir volume + ValuesSidecarAlertsEnvValueFromVar1 + + Attributes + ---------- + configMapKeyRef : ValuesSidecarAlertsEnvValueFromVar1ConfigMapKeyRef, optional """ [...str]: any + configMapKeyRef?: ValuesSidecarAlertsEnvValueFromVar1ConfigMapKeyRef + +schema ValuesSidecarAlertsEnvValueFromVar1ConfigMapKeyRef: + r""" + ValuesSidecarAlertsEnvValueFromVar1ConfigMapKeyRef + + Attributes + ---------- + key : str, optional + name : str, optional + """ + [...str]: any + key?: str + name?: str + +schema ValuesSidecarAlertsEnvValueFromVar2: + r""" + ValuesSidecarAlertsEnvValueFromVar2 + + Attributes + ---------- + secretKeyRef : ValuesSidecarAlertsEnvValueFromVar2SecretKeyRef, optional + """ + [...str]: any + secretKeyRef?: ValuesSidecarAlertsEnvValueFromVar2SecretKeyRef + +schema ValuesSidecarAlertsEnvValueFromVar2SecretKeyRef: + r""" + ValuesSidecarAlertsEnvValueFromVar2SecretKeyRef + + Attributes + ---------- + key : str, optional + name : str, optional + """ + [...str]: any + key?: str + name?: str + +schema ValuesSidecarAlertsEnvValueFromVar3: + r""" + ValuesSidecarAlertsEnvValueFromVar3 + + Attributes + ---------- + fieldRef : ValuesSidecarAlertsEnvValueFromVar3FieldRef, optional + """ + [...str]: any + fieldRef?: ValuesSidecarAlertsEnvValueFromVar3FieldRef + +schema ValuesSidecarAlertsEnvValueFromVar3FieldRef: + r""" + ValuesSidecarAlertsEnvValueFromVar3FieldRef + + Attributes + ---------- + apiVersion : str, optional + fieldPath : str, optional + """ + [...str]: any + apiVersion?: str + fieldPath?: str schema ValuesSidecarDashboards: r""" @@ -11392,11 +11825,24 @@ schema ValuesSidecarDashboards: folderAnnotation : any, optional, default is "null" If specified, the sidecar will look for annotation with this name to create folder and put graph here. You can use this parameter together with `provider.foldersFromFilesStructure`to annotate configmaps and create folder structure. + initDashboards : bool, optional, default is False + This is needed if skipReload is true, to load any dashboards defined at startup time. + Deploy the dashboard sidecar as an initContainer. label : str, optional, default is "grafana_dashboard" - label that the configmaps with dashboards are marked with + label that the configmaps with dashboards are marked with (can be templated) labelValue : str, optional, default is "" - value of label that the configmaps with dashboards are set to + value of label that the configmaps with dashboards are set to (can be templated) provider : ValuesSidecarDashboardsProvider, optional + Use native sidecar https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/ + restartPolicy: Always + # only applies to native sidecars + startupProbe: + httpGet: + path: /healthz + port: 8083 + initialDelaySeconds: 5 + periodSeconds: 5 + failureThreshold: 60 # 5 minutes watchServerTimeout: request to the server, asking it to cleanly close the connection after that. defaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S watchServerTimeout: 3600 @@ -11430,13 +11876,21 @@ schema ValuesSidecarDashboards: Endpoint to send request to reload alerts resource : str, optional, default is "both" search in configmap, secret or both + resourceName : str, optional, default is "" + + resourceName: comma separated list of resource names to be fetched/checked by this sidecar. + per default all resources of the type defined in {{ .Values.sidecar.dashboards.resource }} will be checked. + This e.g. allows stricter RBAC rules which are limited to the resources meant for the sidecars. + resourceName: "secret/dashboards-0,configmap/dashboards-1" script : any, optional, default is "null" - Absolute path to shell script to execute after a configmap got reloaded + Absolute path to a script to execute after a configmap got reloaded. + It runs before calls to REQ_URI. If the file is not executable it will be passed to sh. + Otherwise, it's executed as is. Shebangs known to work are #!/bin/sh and #!/usr/bin/env python searchNamespace : any, optional, default is "null" Namespaces list. If specified, the sidecar will search for config-maps/secrets inside these namespaces. Otherwise the namespace in which the sidecar is running will be used. It's also possible to specify ALL to search in all namespaces. - sizeLimit : ValuesSidecarDashboardsSizeLimit, optional + sizeLimit : str, optional, default is "" Sets the size limit of the dashboard sidecar emptyDir volume skipReload : bool, optional, default is False watchMethod : str, optional, default is "WATCH" @@ -11451,14 +11905,16 @@ schema ValuesSidecarDashboards: extraMounts?: [any] folder?: str folderAnnotation?: any + initDashboards?: bool label?: str labelValue?: str provider?: ValuesSidecarDashboardsProvider reloadURL?: str resource?: str + resourceName?: str script?: any searchNamespace?: any - sizeLimit?: ValuesSidecarDashboardsSizeLimit + sizeLimit?: str skipReload?: bool watchMethod?: str @@ -11538,6 +11994,16 @@ schema ValuesSidecarDashboardsEnvValueFromVar2SecretKeyRef: schema ValuesSidecarDashboardsProvider: r""" + Use native sidecar https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/ + restartPolicy: Always + # only applies to native sidecars + startupProbe: + httpGet: + path: /healthz + port: 8083 + initialDelaySeconds: 5 + periodSeconds: 5 + failureThreshold: 60 # 5 minutes watchServerTimeout: request to the server, asking it to cleanly close the connection after that. defaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S watchServerTimeout: 3600 @@ -11579,12 +12045,6 @@ schema ValuesSidecarDashboardsProvider: orgid?: int $type?: str -schema ValuesSidecarDashboardsSizeLimit: - r""" - Sets the size limit of the dashboard sidecar emptyDir volume - """ - [...str]: any - schema ValuesSidecarDatasources: r""" ValuesSidecarDatasources @@ -11604,6 +12064,16 @@ schema ValuesSidecarDatasources: # valueFrom: # extraMounts : [any], optional + Use native sidecar https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/ + restartPolicy: Always + # only applies to native sidecars + startupProbe: + httpGet: + path: /healthz + port: 8081 + initialDelaySeconds: 5 + periodSeconds: 5 + failureThreshold: 60 # 5 minutes Additional datasources sidecar volume mounts initDatasources : bool, optional, default is False This is needed if skipReload is true, to load any datasources defined at startup time. @@ -11615,10 +12085,11 @@ schema ValuesSidecarDatasources: key: value_key Do not reprocess already processed unchanged resources on k8s API reconnect. ignoreAlreadyProcessed: true - label that the configmaps with datasources are marked with + label that the configmaps with datasources are marked with (can be templated) labelValue : str, optional, default is "" - value of label that the configmaps with datasources are set to + value of label that the configmaps with datasources are set to (can be templated) reloadURL : str, optional, default is "http://localhost:3000/api/admin/provisioning/datasources/reload" + watchServerTimeout: request to the server, asking it to cleanly close the connection after that. defaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S watchServerTimeout: 3600 @@ -11649,15 +12120,23 @@ schema ValuesSidecarDatasources: Endpoint to send request to reload datasources resource : str, optional, default is "both" search in configmap, secret or both + resourceName : str, optional, default is "" + + resourceName: comma separated list of resource names to be fetched/checked by this sidecar. + per default all resources of the type defined in {{ .Values.sidecar.datasources.resource }} will be checked. + This e.g. allows stricter RBAC rules which are limited to the resources meant for the sidecars. + resourceName: "secret/datasources-0,configmap/datasources-15" script : any, optional, default is "null" - Absolute path to shell script to execute after a datasource got reloaded + Absolute path to a script to execute after a configmap got reloaded. + It runs before calls to REQ_URI. If the file is not executable it will be passed to sh. + Otherwise, it's executed as is. Shebangs known to work are #!/bin/sh and #!/usr/bin/env python searchNamespace : any, optional, default is "null" Log level. Can be one of: DEBUG, INFO, WARN, ERROR, CRITICAL. logLevel: INFO If specified, the sidecar will search for datasource config-maps inside this namespace. Otherwise the namespace in which the sidecar is running will be used. It's also possible to specify ALL to search in all namespaces - sizeLimit : ValuesSidecarDatasourcesSizeLimit, optional + sizeLimit : str, optional, default is "" Sets the size limit of the datasource sidecar emptyDir volume skipReload : bool, optional, default is False watchMethod : str, optional, default is "WATCH" @@ -11673,9 +12152,10 @@ schema ValuesSidecarDatasources: labelValue?: str reloadURL?: str resource?: str + resourceName?: str script?: any searchNamespace?: any - sizeLimit?: ValuesSidecarDatasourcesSizeLimit + sizeLimit?: str skipReload?: bool watchMethod?: str @@ -11753,12 +12233,6 @@ schema ValuesSidecarDatasourcesEnvValueFromVar2SecretKeyRef: key?: str name?: str -schema ValuesSidecarDatasourcesSizeLimit: - r""" - Sets the size limit of the datasource sidecar emptyDir volume - """ - [...str]: any - schema ValuesSidecarImage: r""" ValuesSidecarImage @@ -11769,7 +12243,7 @@ schema ValuesSidecarImage: The Docker registry repository : str, optional, default is "kiwigrid/k8s-sidecar" sha : str, optional, default is "" - tag : str, optional, default is "1.30.0" + tag : str, optional, default is "2.1.2" """ [...str]: any registry?: str @@ -11793,6 +12267,16 @@ schema ValuesSidecarNotifiers: env : ValuesSidecarNotifiersEnv, optional Additional environment variables for the notifierssidecar extraMounts : [any], optional + Use native sidecar https://kubernetes.io/docs/concepts/workloads/pods/sidecar-containers/ + restartPolicy: Always + # only applies to native sidecars + startupProbe: + httpGet: + path: /healthz + port: 8082 + initialDelaySeconds: 5 + periodSeconds: 5 + failureThreshold: 60 # 5 minutes Additional notifiers sidecar volume mounts initNotifiers : bool, optional, default is False Deploy the notifier sidecar as an initContainer in addition to a container. @@ -11800,10 +12284,11 @@ schema ValuesSidecarNotifiers: label : str, optional, default is "grafana_notifier" Do not reprocess already processed unchanged resources on k8s API reconnect. ignoreAlreadyProcessed: true - label that the configmaps with notifiers are marked with + label that the configmaps with notifiers are marked with (can be templated) labelValue : str, optional, default is "" - value of label that the configmaps with notifiers are set to + value of label that the configmaps with notifiers are set to (can be templated) reloadURL : str, optional, default is "http://localhost:3000/api/admin/provisioning/notifications/reload" + watchServerTimeout: request to the server, asking it to cleanly close the connection after that. defaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S watchServerTimeout: 3600 @@ -11834,15 +12319,23 @@ schema ValuesSidecarNotifiers: Endpoint to send request to reload notifiers resource : str, optional, default is "both" search in configmap, secret or both + resourceName : str, optional, default is "" + + resourceName: comma separated list of resource names to be fetched/checked by this sidecar. + per default all resources of the type defined in {{ .Values.sidecar.notifiers.resource }} will be checked. + This e.g. allows stricter RBAC rules which are limited to the resources meant for the sidecars. + resourceName: "secret/notifiers-2,configmap/notifiers-1" script : any, optional, default is "null" - Absolute path to shell script to execute after a notifier got reloaded + Absolute path to a script to execute after a configmap got reloaded. + It runs before calls to REQ_URI. If the file is not executable it will be passed to sh. + Otherwise, it's executed as is. Shebangs known to work are #!/bin/sh and #!/usr/bin/env python searchNamespace : any, optional, default is "null" Log level. Can be one of: DEBUG, INFO, WARN, ERROR, CRITICAL. logLevel: INFO If specified, the sidecar will search for notifier config-maps inside this namespace. Otherwise the namespace in which the sidecar is running will be used. It's also possible to specify ALL to search in all namespaces - sizeLimit : ValuesSidecarNotifiersSizeLimit, optional + sizeLimit : str, optional, default is "" Sets the size limit of the notifier sidecar emptyDir volume skipReload : bool, optional, default is False watchMethod : str, optional, default is "WATCH" @@ -11857,9 +12350,10 @@ schema ValuesSidecarNotifiers: labelValue?: str reloadURL?: str resource?: str + resourceName?: str script?: any searchNamespace?: any - sizeLimit?: ValuesSidecarNotifiersSizeLimit + sizeLimit?: str skipReload?: bool watchMethod?: str @@ -11869,12 +12363,6 @@ schema ValuesSidecarNotifiersEnv: """ [...str]: any -schema ValuesSidecarNotifiersSizeLimit: - r""" - Sets the size limit of the notifier sidecar emptyDir volume - """ - [...str]: any - schema ValuesSidecarPlugins: r""" ValuesSidecarPlugins @@ -11892,10 +12380,11 @@ schema ValuesSidecarPlugins: label : str, optional, default is "grafana_plugin" Do not reprocess already processed unchanged resources on k8s API reconnect. ignoreAlreadyProcessed: true - label that the configmaps with plugins are marked with + label that the configmaps with plugins are marked with (can be templated) labelValue : str, optional, default is "" - value of label that the configmaps with plugins are set to + value of label that the configmaps with plugins are set to (can be templated) reloadURL : str, optional, default is "http://localhost:3000/api/admin/provisioning/plugins/reload" + watchServerTimeout: request to the server, asking it to cleanly close the connection after that. defaults to 60sec; much higher values like 3600 seconds (1h) are feasible for non-Azure K8S watchServerTimeout: 3600 @@ -11926,15 +12415,23 @@ schema ValuesSidecarPlugins: Endpoint to send request to reload plugins resource : str, optional, default is "both" search in configmap, secret or both + resourceName : str, optional, default is "" + + resourceName: comma separated list of resource names to be fetched/checked by this sidecar. + per default all resources of the type defined in {{ .Values.sidecar.plugins.resource }} will be checked. + This e.g. allows stricter RBAC rules which are limited to the resources meant for the sidecars. + resourceName: "secret/plugins-0,configmap/plugins-1" script : any, optional, default is "null" - Absolute path to shell script to execute after a plugin got reloaded + Absolute path to a script to execute after a configmap got reloaded. + It runs before calls to REQ_URI. If the file is not executable it will be passed to sh. + Otherwise, it's executed as is. Shebangs known to work are #!/bin/sh and #!/usr/bin/env python searchNamespace : any, optional, default is "null" Log level. Can be one of: DEBUG, INFO, WARN, ERROR, CRITICAL. logLevel: INFO If specified, the sidecar will search for plugin config-maps inside this namespace. Otherwise the namespace in which the sidecar is running will be used. It's also possible to specify ALL to search in all namespaces - sizeLimit : ValuesSidecarPluginsSizeLimit, optional + sizeLimit : str, optional, default is "" Sets the size limit of the plugin sidecar emptyDir volume skipReload : bool, optional, default is False watchMethod : str, optional, default is "WATCH" @@ -11949,9 +12446,10 @@ schema ValuesSidecarPlugins: labelValue?: str reloadURL?: str resource?: str + resourceName?: str script?: any searchNamespace?: any - sizeLimit?: ValuesSidecarPluginsSizeLimit + sizeLimit?: str skipReload?: bool watchMethod?: str @@ -11961,12 +12459,6 @@ schema ValuesSidecarPluginsEnv: """ [...str]: any -schema ValuesSidecarPluginsSizeLimit: - r""" - Sets the size limit of the plugin sidecar emptyDir volume - """ - [...str]: any - schema ValuesSidecarReadinessProbe: r""" ValuesSidecarReadinessProbe @@ -12101,6 +12593,7 @@ schema ValuesTestFramework: Attributes ---------- + containerSecurityContext : ValuesTestFrameworkContainerSecurityContext, optional enabled : bool, optional, default is True image : ValuesTestFrameworkImage, optional # The type of Helm hook used to run this test. Defaults to test. @@ -12112,12 +12605,19 @@ schema ValuesTestFramework: securityContext : ValuesTestFrameworkSecurityContext, optional """ [...str]: any + containerSecurityContext?: ValuesTestFrameworkContainerSecurityContext enabled?: bool image?: ValuesTestFrameworkImage imagePullPolicy?: str resources?: ValuesTestFrameworkResources securityContext?: ValuesTestFrameworkSecurityContext +schema ValuesTestFrameworkContainerSecurityContext: + r""" + ValuesTestFrameworkContainerSecurityContext + """ + [...str]: any + schema ValuesTestFrameworkImage: r""" # The type of Helm hook used to run this test. Defaults to test. @@ -12177,7 +12677,7 @@ schema ValuesThanosRuler: Be aware that this is an early beta of this feature, kube-prometheus-stack does not guarantee this works and is subject to change. Being BETA this can/will change in the future without notice, do not use unless you want to take that risk - [[ref]](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io%2fv1alpha2) + [[ref]](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io%2fv1alpha2) service : ValuesThanosRulerService, optional # Configuration for ThanosRuler service # @@ -12248,13 +12748,11 @@ schema ValuesThanosRulerIngress: Attributes ---------- annotations : ValuesThanosRulerIngressAnnotations, optional - For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - ingressClassName: nginx enabled : bool, optional, default is False hosts : [any], optional # Hosts must be provided if Ingress is enabled. # + ingressClassName : str, optional, default is "" labels : ValuesThanosRulerIngressLabels, optional paths : [any], optional # Paths to use for ingress rules - one path should match the thanosruler.routePrefix @@ -12268,15 +12766,14 @@ schema ValuesThanosRulerIngress: annotations?: ValuesThanosRulerIngressAnnotations enabled?: bool hosts?: [any] + ingressClassName?: str labels?: ValuesThanosRulerIngressLabels paths?: [any] tls?: [any] schema ValuesThanosRulerIngressAnnotations: r""" - For Kubernetes >= 1.18 you should specify the ingress-controller via the field ingressClassName - See https://kubernetes.io/blog/2020/04/02/improvements-to-the-ingress-api-in-kubernetes-1.18/#specifying-the-class-of-an-ingress - ingressClassName: nginx + ValuesThanosRulerIngressAnnotations """ [...str]: any @@ -12295,13 +12792,14 @@ schema ValuesThanosRulerPodDisruptionBudget: Attributes ---------- enabled : bool, optional, default is False - maxUnavailable : str, optional, default is "" minAvailable : int, optional, default is 1 + unhealthyPodEvictionPolicy : str, optional, default is "AlwaysAllow" + maxUnavailable: "" """ [...str]: any enabled?: bool - maxUnavailable?: str minAvailable?: int + unhealthyPodEvictionPolicy?: str schema ValuesThanosRulerRoute: r""" @@ -12310,7 +12808,7 @@ schema ValuesThanosRulerRoute: Be aware that this is an early beta of this feature, kube-prometheus-stack does not guarantee this works and is subject to change. Being BETA this can/will change in the future without notice, do not use unless you want to take that risk - [[ref]](https://gateway-api.sigs.k8s.io/references/spec/#gateway.networking.k8s.io%2fv1alpha2) + [[ref]](https://gateway-api.sigs.k8s.io/reference/spec/#gateway.networking.k8s.io%2fv1alpha2) Attributes ---------- @@ -12407,6 +12905,7 @@ schema ValuesThanosRulerService: # Additional ports to open for ThanosRuler service annotations : ValuesThanosRulerServiceAnnotations, optional clusterIP : str, optional, default is "" + enabled : bool, optional, default is True externalIPs : [any], optional externalTrafficPolicy : str, optional, default is "Cluster" # Denotes if this Service desires to route external traffic to node-local or cluster-wide endpoints @@ -12433,6 +12932,7 @@ schema ValuesThanosRulerService: additionalPorts?: [any] annotations?: ValuesThanosRulerServiceAnnotations clusterIP?: str + enabled?: bool externalIPs?: [any] externalTrafficPolicy?: str ipDualStack?: ValuesThanosRulerServiceIpDualStack @@ -12544,7 +13044,7 @@ schema ValuesThanosRulerServiceMonitor: # tlsConfig : ValuesThanosRulerServiceMonitorTlsConfig, optional # tlsConfig: TLS configuration to use when scraping the endpoint. For example if using istio mTLS. - # Of type: https://github.com/coreos/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig + # Of type: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig """ [...str]: any additionalEndpoints?: [any] @@ -12573,7 +13073,7 @@ schema ValuesThanosRulerServiceMonitorAdditionalLabels: schema ValuesThanosRulerServiceMonitorTlsConfig: r""" # tlsConfig: TLS configuration to use when scraping the endpoint. For example if using istio mTLS. - # Of type: https://github.com/coreos/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig + # Of type: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/api-reference/api.md#tlsconfig """ [...str]: any @@ -12596,7 +13096,7 @@ schema ValuesThanosRulerThanosRulerSpec: # Useful, if you need advanced templating affinity : ValuesThanosRulerThanosRulerSpecAffinity, optional # Assign custom affinity rules to the thanosRuler instance - # ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ # alertDropLabels : [any], optional # Labels by name to drop before sending to alertmanager @@ -12638,7 +13138,7 @@ schema ValuesThanosRulerThanosRulerSpec: # nodeSelector : ValuesThanosRulerThanosRulerSpecNodeSelector, optional # Define which Nodes the Pods are scheduled on. - # ref: https://kubernetes.io/docs/user-guide/node-selection/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector # objectStorageConfig : ValuesThanosRulerThanosRulerSpecObjectStorageConfig, optional # ObjectStorageConfig configures object storage in Thanos @@ -12676,7 +13176,7 @@ schema ValuesThanosRulerThanosRulerSpec: # running cluster equal to the expected size. resources : ValuesThanosRulerThanosRulerSpecResources, optional # Define resources requests and limits for single Pods. - # ref: https://kubernetes.io/docs/user-guide/compute-resources/ + # ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ # retention : str, optional, default is "24h" # Time duration ThanosRuler shall retain data for. Default is '24h', and must match the regular expression @@ -12705,17 +13205,19 @@ schema ValuesThanosRulerThanosRulerSpec: # This defaults to non root user with uid 1000 and gid 2000. *v1.PodSecurityContext false # ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/ # + serviceName : any, optional, default is "" + # storage : ValuesThanosRulerThanosRulerSpecStorage, optional # Storage is the definition of how storage will be used by the ThanosRuler instances. # ref: https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/platform/storage.md # tolerations : [any], optional # If specified, the pod's tolerations. - # ref: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/ # topologySpreadConstraints : [any], optional # If specified, the pod's topology spread constraints. - # ref: https://kubernetes.io/docs/concepts/workloads/pods/pod-topology-spread-constraints/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/topology-spread-constraints/ # volumeMounts : [any], optional Additional VolumeMounts on the output StatefulSet definition. @@ -12760,6 +13262,7 @@ schema ValuesThanosRulerThanosRulerSpec: ruleSelector?: ValuesThanosRulerThanosRulerSpecRuleSelector ruleSelectorNilUsesHelmValues?: bool securityContext?: ValuesThanosRulerThanosRulerSpecSecurityContext + serviceName?: any storage?: ValuesThanosRulerThanosRulerSpecStorage tolerations?: [any] topologySpreadConstraints?: [any] @@ -12776,7 +13279,7 @@ schema ValuesThanosRulerThanosRulerSpecAdditionalConfig: schema ValuesThanosRulerThanosRulerSpecAffinity: r""" # Assign custom affinity rules to the thanosRuler instance - # ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/ # """ [...str]: any @@ -12825,7 +13328,7 @@ schema ValuesThanosRulerThanosRulerSpecImage: registry : str, optional, default is "quay.io" repository : str, optional, default is "thanos/thanos" sha : str, optional, default is "" - tag : str, optional, default is "v0.37.2" + tag : str, optional, default is "v0.40.1" """ [...str]: any registry?: str @@ -12844,7 +13347,7 @@ schema ValuesThanosRulerThanosRulerSpecLabels: schema ValuesThanosRulerThanosRulerSpecNodeSelector: r""" # Define which Nodes the Pods are scheduled on. - # ref: https://kubernetes.io/docs/user-guide/node-selection/ + # ref: https://kubernetes.io/docs/concepts/scheduling-eviction/assign-pod-node/#nodeselector # """ [...str]: any @@ -12927,7 +13430,7 @@ schema ValuesThanosRulerThanosRulerSpecQueryConfigSecret: schema ValuesThanosRulerThanosRulerSpecResources: r""" # Define resources requests and limits for single Pods. - # ref: https://kubernetes.io/docs/user-guide/compute-resources/ + # ref: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/ # """ [...str]: any