{ "description": "The `Prometheus` custom resource definition (CRD) defines a desired [Prometheus](https://prometheus.io/docs/prometheus) setup to run in a Kubernetes cluster. It allows to specify many options such as the number of replicas, persistent storage, and Alertmanagers where firing alerts should be sent and many more.\n\nFor each `Prometheus` resource, the Operator deploys one or several `StatefulSet` objects in the same namespace. The number of StatefulSets is equal to the number of shards which is 1 by default.\n\nThe resource defines via label and namespace selectors which `ServiceMonitor`, `PodMonitor`, `Probe` and `PrometheusRule` objects should be associated to the deployed Prometheus instances.\n\nThe Operator continuously reconciles the scrape and rules configuration and a sidecar container running in the Prometheus pods triggers a reload of the configuration when needed.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": [ "string", "null" ] }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": [ "string", "null" ] }, "metadata": { "type": [ "object", "null" ] }, "spec": { "additionalProperties": false, "description": "Specification of the desired behavior of the Prometheus cluster. More info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "additionalAlertManagerConfigs": { "additionalProperties": false, "description": "AdditionalAlertManagerConfigs specifies a key of a Secret containing\nadditional Prometheus Alertmanager configurations. The Alertmanager\nconfigurations are appended to the configuration generated by the\nPrometheus Operator. They must be formatted according to the official\nPrometheus documentation:\n\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config\n\nThe user is responsible for making sure that the configurations are valid\n\nNote that using this feature may expose the possibility to break\nupgrades of Prometheus. It is advised to review Prometheus release notes\nto ensure that no incompatible AlertManager configs are going to break\nPrometheus after the upgrade.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "additionalAlertRelabelConfigs": { "additionalProperties": false, "description": "AdditionalAlertRelabelConfigs specifies a key of a Secret containing\nadditional Prometheus alert relabel configurations. The alert relabel\nconfigurations are appended to the configuration generated by the\nPrometheus Operator. They must be formatted according to the official\nPrometheus documentation:\n\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs\n\nThe user is responsible for making sure that the configurations are valid\n\nNote that using this feature may expose the possibility to break\nupgrades of Prometheus. It is advised to review Prometheus release notes\nto ensure that no incompatible alert relabel configs are going to break\nPrometheus after the upgrade.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "additionalArgs": { "description": "AdditionalArgs allows setting additional arguments for the 'prometheus' container.\n\nIt is intended for e.g. activating hidden flags which are not supported by\nthe dedicated configuration options yet. The arguments are passed as-is to the\nPrometheus container which may cause issues if they are invalid or not supported\nby the given Prometheus version.\n\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged.", "items": { "additionalProperties": false, "description": "Argument as part of the AdditionalArgs list.", "properties": { "name": { "description": "Name of the argument, e.g. \"scrape.discovery-reload-interval\".", "minLength": 1, "type": "string" }, "value": { "description": "Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)", "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ] }, "additionalScrapeConfigs": { "additionalProperties": false, "description": "AdditionalScrapeConfigs allows specifying a key of a Secret containing\nadditional Prometheus scrape configurations. Scrape configurations\nspecified are appended to the configurations generated by the Prometheus\nOperator. Job configurations specified must have the form as specified\nin the official Prometheus documentation:\nhttps://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config.\nAs scrape configs are appended, the user is responsible to make sure it\nis valid. Note that using this feature may expose the possibility to\nbreak upgrades of Prometheus. It is advised to review Prometheus release\nnotes to ensure that no incompatible scrape configs are going to break\nPrometheus after the upgrade.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "affinity": { "additionalProperties": false, "description": "Defines the Pods' affinity scheduling rules if specified.", "properties": { "nodeAffinity": { "additionalProperties": false, "description": "Describes node affinity scheduling rules for the pod.", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node matches the corresponding matchExpressions; the\nnode(s) with the highest sum are the most preferred.", "items": { "additionalProperties": false, "description": "An empty preferred scheduling term matches all objects with implicit weight 0\n(i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).", "properties": { "preference": { "additionalProperties": false, "description": "A node selector term, associated with the corresponding weight.", "properties": { "matchExpressions": { "description": "A list of node selector requirements by node's labels.", "items": { "additionalProperties": false, "description": "A node selector requirement is a selector that contains values, a key, and an operator\nthat relates the key and values.", "properties": { "key": { "description": "The label key that the selector applies to.", "type": "string" }, "operator": { "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", "type": "string" }, "values": { "description": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchFields": { "description": "A list of node selector requirements by node's fields.", "items": { "additionalProperties": false, "description": "A node selector requirement is a selector that contains values, a key, and an operator\nthat relates the key and values.", "properties": { "key": { "description": "The label key that the selector applies to.", "type": "string" }, "operator": { "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", "type": "string" }, "values": { "description": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "weight": { "description": "Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.", "format": "int32", "type": "integer" } }, "required": [ "preference", "weight" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "requiredDuringSchedulingIgnoredDuringExecution": { "additionalProperties": false, "description": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to an update), the system\nmay or may not try to eventually evict the pod from its node.", "properties": { "nodeSelectorTerms": { "description": "Required. A list of node selector terms. The terms are ORed.", "items": { "additionalProperties": false, "description": "A null or empty node selector term matches no objects. The requirements of\nthem are ANDed.\nThe TopologySelectorTerm type implements a subset of the NodeSelectorTerm.", "properties": { "matchExpressions": { "description": "A list of node selector requirements by node's labels.", "items": { "additionalProperties": false, "description": "A node selector requirement is a selector that contains values, a key, and an operator\nthat relates the key and values.", "properties": { "key": { "description": "The label key that the selector applies to.", "type": "string" }, "operator": { "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", "type": "string" }, "values": { "description": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchFields": { "description": "A list of node selector requirements by node's fields.", "items": { "additionalProperties": false, "description": "A node selector requirement is a selector that contains values, a key, and an operator\nthat relates the key and values.", "properties": { "key": { "description": "The label key that the selector applies to.", "type": "string" }, "operator": { "description": "Represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.", "type": "string" }, "values": { "description": "An array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. If the operator is Gt or Lt, the values\narray must have a single element, which will be interpreted as an integer.\nThis array is replaced during a strategic merge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "type": "array", "x-kubernetes-list-type": "atomic" } }, "required": [ "nodeSelectorTerms" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "podAffinity": { "additionalProperties": false, "description": "Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.", "items": { "additionalProperties": false, "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)", "properties": { "podAffinityTerm": { "additionalProperties": false, "description": "Required. A pod affinity term, associated with the corresponding weight.", "properties": { "labelSelector": { "additionalProperties": false, "description": "A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "mismatchLabelKeys": { "description": "MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "namespaceSelector": { "additionalProperties": false, "description": "A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed.", "type": "string" } }, "required": [ "topologyKey" ], "type": "object" }, "weight": { "description": "weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100.", "format": "int32", "type": "integer" } }, "required": [ "podAffinityTerm", "weight" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.", "items": { "additionalProperties": false, "description": "Defines a set of pods (namely those matching the labelSelector\nrelative to the given namespace(s)) that this pod should be\nco-located (affinity) or not co-located (anti-affinity) with,\nwhere co-located is defined as running on a node whose value of\nthe label with key \u003ctopologyKey\u003e matches that of any node on which\na pod of the set of pods is running", "properties": { "labelSelector": { "additionalProperties": false, "description": "A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "mismatchLabelKeys": { "description": "MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "namespaceSelector": { "additionalProperties": false, "description": "A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed.", "type": "string" } }, "required": [ "topologyKey" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "podAntiAffinity": { "additionalProperties": false, "description": "Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).", "properties": { "preferredDuringSchedulingIgnoredDuringExecution": { "description": "The scheduler will prefer to schedule pods to nodes that satisfy\nthe anti-affinity expressions specified by this field, but it may choose\na node that violates one or more of the expressions. The node that is\nmost preferred is the one with the greatest sum of weights, i.e.\nfor each node that meets all of the scheduling requirements (resource\nrequest, requiredDuringScheduling anti-affinity expressions, etc.),\ncompute a sum by iterating through the elements of this field and adding\n\"weight\" to the sum if the node has pods which matches the corresponding podAffinityTerm; the\nnode(s) with the highest sum are the most preferred.", "items": { "additionalProperties": false, "description": "The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)", "properties": { "podAffinityTerm": { "additionalProperties": false, "description": "Required. A pod affinity term, associated with the corresponding weight.", "properties": { "labelSelector": { "additionalProperties": false, "description": "A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "mismatchLabelKeys": { "description": "MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "namespaceSelector": { "additionalProperties": false, "description": "A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed.", "type": "string" } }, "required": [ "topologyKey" ], "type": "object" }, "weight": { "description": "weight associated with matching the corresponding podAffinityTerm,\nin the range 1-100.", "format": "int32", "type": "integer" } }, "required": [ "podAffinityTerm", "weight" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "requiredDuringSchedulingIgnoredDuringExecution": { "description": "If the anti-affinity requirements specified by this field are not met at\nscheduling time, the pod will not be scheduled onto the node.\nIf the anti-affinity requirements specified by this field cease to be met\nat some point during pod execution (e.g. due to a pod label update), the\nsystem may or may not try to eventually evict the pod from its node.\nWhen there are multiple elements, the lists of nodes corresponding to each\npodAffinityTerm are intersected, i.e. all terms must be satisfied.", "items": { "additionalProperties": false, "description": "Defines a set of pods (namely those matching the labelSelector\nrelative to the given namespace(s)) that this pod should be\nco-located (affinity) or not co-located (anti-affinity) with,\nwhere co-located is defined as running on a node whose value of\nthe label with key \u003ctopologyKey\u003e matches that of any node on which\na pod of the set of pods is running", "properties": { "labelSelector": { "additionalProperties": false, "description": "A label query over a set of resources, in this case pods.\nIf it's null, this PodAffinityTerm matches with no Pods.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both matchLabelKeys and labelSelector.\nAlso, matchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "mismatchLabelKeys": { "description": "MismatchLabelKeys is a set of pod label keys to select which pods will\nbe taken into consideration. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`\nto select the group of existing pods which pods will be taken into consideration\nfor the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming\npod labels will be ignored. The default value is empty.\nThe same key is forbidden to exist in both mismatchLabelKeys and labelSelector.\nAlso, mismatchLabelKeys cannot be set when labelSelector isn't set.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "namespaceSelector": { "additionalProperties": false, "description": "A label query over the set of namespaces that the term applies to.\nThe term is applied to the union of the namespaces selected by this field\nand the ones listed in the namespaces field.\nnull selector and null or empty namespaces list means \"this pod's namespace\".\nAn empty selector ({}) matches all namespaces.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "namespaces": { "description": "namespaces specifies a static list of namespace names that the term applies to.\nThe term is applied to the union of the namespaces listed in this field\nand the ones selected by namespaceSelector.\nnull or empty namespaces list and null namespaceSelector means \"this pod's namespace\".", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "topologyKey": { "description": "This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching\nthe labelSelector in the specified namespaces, where co-located is defined as running on a node\nwhose value of the label with key topologyKey matches that of any node on which any of the\nselected pods is running.\nEmpty topologyKey is not allowed.", "type": "string" } }, "required": [ "topologyKey" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "alerting": { "additionalProperties": false, "description": "Defines the settings related to Alertmanager.", "properties": { "alertmanagers": { "description": "Alertmanager endpoints where Prometheus should send alerts to.", "items": { "additionalProperties": false, "description": "AlertmanagerEndpoints defines a selection of a single Endpoints object\ncontaining Alertmanager IPs to fire alerts against.", "properties": { "alertRelabelings": { "description": "Relabeling configs applied before sending alerts to a specific Alertmanager.\nIt requires Prometheus \u003e= v2.51.0.", "items": { "additionalProperties": false, "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus \u003e= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus \u003e= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", "keep", "Keep", "drop", "Drop", "hashmod", "HashMod", "labelmap", "LabelMap", "labeldrop", "LabelDrop", "labelkeep", "LabelKeep", "lowercase", "Lowercase", "uppercase", "Uppercase", "keepequal", "KeepEqual", "dropequal", "DropEqual" ], "type": [ "string", "null" ] }, "modulus": { "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": [ "integer", "null" ] }, "regex": { "description": "Regular expression against which the extracted value is matched.", "type": [ "string", "null" ] }, "replacement": { "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": [ "string", "null" ] }, "separator": { "description": "Separator is the string between concatenated SourceLabels.", "type": [ "string", "null" ] }, "sourceLabels": { "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "type": "string" }, "type": [ "array", "null" ] }, "targetLabel": { "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "apiVersion": { "description": "Version of the Alertmanager API that Prometheus uses to send alerts.\nIt can be \"V1\" or \"V2\".\nThe field has no effect for Prometheus \u003e= v3.0.0 because only the v2 API is supported.", "enum": [ "v1", "V1", "v2", "V2" ], "type": [ "string", "null" ] }, "authorization": { "additionalProperties": false, "description": "Authorization section for Alertmanager.\n\nCannot be set at the same time as `basicAuth`, `bearerTokenFile` or `sigv4`.", "properties": { "credentials": { "additionalProperties": false, "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "type": { "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "basicAuth": { "additionalProperties": false, "description": "BasicAuth configuration for Alertmanager.\n\nCannot be set at the same time as `bearerTokenFile`, `authorization` or `sigv4`.", "properties": { "password": { "additionalProperties": false, "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "username": { "additionalProperties": false, "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "bearerTokenFile": { "description": "File to read bearer token for Alertmanager.\n\nCannot be set at the same time as `basicAuth`, `authorization`, or `sigv4`.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", "type": [ "string", "null" ] }, "enableHttp2": { "description": "Whether to enable HTTP2.", "type": [ "boolean", "null" ] }, "name": { "description": "Name of the Endpoints object in the namespace.", "minLength": 1, "type": "string" }, "namespace": { "description": "Namespace of the Endpoints object.\n\nIf not set, the object will be discovered in the namespace of the\nPrometheus object.", "minLength": 1, "type": [ "string", "null" ] }, "noProxy": { "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "string", "null" ] }, "pathPrefix": { "description": "Prefix for the HTTP path alerts are pushed to.", "type": [ "string", "null" ] }, "port": { "description": "Port on which the Alertmanager API is exposed.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "proxyConnectHeader": { "additionalProperties": { "items": { "additionalProperties": false, "description": "SecretKeySelector selects a key of a Secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic" }, "type": "array" }, "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "boolean", "null" ] }, "proxyUrl": { "description": "`proxyURL` defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": [ "string", "null" ] }, "relabelings": { "description": "Relabel configuration applied to the discovered Alertmanagers.", "items": { "additionalProperties": false, "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus \u003e= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus \u003e= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", "keep", "Keep", "drop", "Drop", "hashmod", "HashMod", "labelmap", "LabelMap", "labeldrop", "LabelDrop", "labelkeep", "LabelKeep", "lowercase", "Lowercase", "uppercase", "Uppercase", "keepequal", "KeepEqual", "dropequal", "DropEqual" ], "type": [ "string", "null" ] }, "modulus": { "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": [ "integer", "null" ] }, "regex": { "description": "Regular expression against which the extracted value is matched.", "type": [ "string", "null" ] }, "replacement": { "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": [ "string", "null" ] }, "separator": { "description": "Separator is the string between concatenated SourceLabels.", "type": [ "string", "null" ] }, "sourceLabels": { "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "type": "string" }, "type": [ "array", "null" ] }, "targetLabel": { "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "scheme": { "description": "Scheme to use when firing alerts.", "type": [ "string", "null" ] }, "sigv4": { "additionalProperties": false, "description": "Sigv4 allows to configures AWS's Signature Verification 4 for the URL.\n\nIt requires Prometheus \u003e= v2.48.0.\n\nCannot be set at the same time as `basicAuth`, `bearerTokenFile` or `authorization`.", "properties": { "accessKey": { "additionalProperties": false, "description": "AccessKey is the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "profile": { "description": "Profile is the named AWS profile used to authenticate.", "type": [ "string", "null" ] }, "region": { "description": "Region is the AWS region. If blank, the region from the default credentials chain used.", "type": [ "string", "null" ] }, "roleArn": { "description": "RoleArn is the named AWS profile used to authenticate.", "type": [ "string", "null" ] }, "secretKey": { "additionalProperties": false, "description": "SecretKey is the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "timeout": { "description": "Timeout is a per-target Alertmanager timeout when pushing alerts.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "tlsConfig": { "additionalProperties": false, "description": "TLS Config to use for Alertmanager.", "properties": { "ca": { "additionalProperties": false, "description": "Certificate authority used when verifying server certificates.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "caFile": { "description": "Path to the CA cert in the Prometheus container to use for the targets.", "type": [ "string", "null" ] }, "cert": { "additionalProperties": false, "description": "Client certificate to present when doing client-authentication.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "certFile": { "description": "Path to the client cert file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "insecureSkipVerify": { "description": "Disable target certificate validation.", "type": [ "boolean", "null" ] }, "keyFile": { "description": "Path to the client key file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "keySecret": { "additionalProperties": false, "description": "Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "maxVersion": { "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.41.0 or Thanos \u003e= v0.31.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "minVersion": { "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.35.0 or Thanos \u003e= v0.28.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "serverName": { "description": "Used to verify the hostname for the targets.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "required": [ "name", "port" ], "type": "object" }, "type": "array" } }, "required": [ "alertmanagers" ], "type": [ "object", "null" ] }, "allowOverlappingBlocks": { "description": "AllowOverlappingBlocks enables vertical compaction and vertical query\nmerge in Prometheus.\n\nDeprecated: this flag has no effect for Prometheus \u003e= 2.39.0 where overlapping blocks are enabled by default.", "type": [ "boolean", "null" ] }, "apiserverConfig": { "additionalProperties": false, "description": "APIServerConfig allows specifying a host and auth methods to access the\nKuberntees API server.\nIf null, Prometheus is assumed to run inside of the cluster: it will\ndiscover the API servers automatically and use the Pod's CA certificate\nand bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/.", "properties": { "authorization": { "additionalProperties": false, "description": "Authorization section for the API server.\n\nCannot be set at the same time as `basicAuth`, `bearerToken`, or\n`bearerTokenFile`.", "properties": { "credentials": { "additionalProperties": false, "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "credentialsFile": { "description": "File to read a secret from, mutually exclusive with `credentials`.", "type": [ "string", "null" ] }, "type": { "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "basicAuth": { "additionalProperties": false, "description": "BasicAuth configuration for the API server.\n\nCannot be set at the same time as `authorization`, `bearerToken`, or\n`bearerTokenFile`.", "properties": { "password": { "additionalProperties": false, "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "username": { "additionalProperties": false, "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "bearerToken": { "description": "*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\nDeprecated: this will be removed in a future release.", "type": [ "string", "null" ] }, "bearerTokenFile": { "description": "File to read bearer token for accessing apiserver.\n\nCannot be set at the same time as `basicAuth`, `authorization`, or `bearerToken`.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", "type": [ "string", "null" ] }, "host": { "description": "Kubernetes API address consisting of a hostname or IP address followed\nby an optional port number.", "type": "string" }, "noProxy": { "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "string", "null" ] }, "proxyConnectHeader": { "additionalProperties": { "items": { "additionalProperties": false, "description": "SecretKeySelector selects a key of a Secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic" }, "type": "array" }, "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "boolean", "null" ] }, "proxyUrl": { "description": "`proxyURL` defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": [ "string", "null" ] }, "tlsConfig": { "additionalProperties": false, "description": "TLS Config to use for the API server.", "properties": { "ca": { "additionalProperties": false, "description": "Certificate authority used when verifying server certificates.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "caFile": { "description": "Path to the CA cert in the Prometheus container to use for the targets.", "type": [ "string", "null" ] }, "cert": { "additionalProperties": false, "description": "Client certificate to present when doing client-authentication.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "certFile": { "description": "Path to the client cert file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "insecureSkipVerify": { "description": "Disable target certificate validation.", "type": [ "boolean", "null" ] }, "keyFile": { "description": "Path to the client key file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "keySecret": { "additionalProperties": false, "description": "Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "maxVersion": { "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.41.0 or Thanos \u003e= v0.31.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "minVersion": { "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.35.0 or Thanos \u003e= v0.28.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "serverName": { "description": "Used to verify the hostname for the targets.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "required": [ "host" ], "type": [ "object", "null" ] }, "arbitraryFSAccessThroughSMs": { "additionalProperties": false, "description": "When true, ServiceMonitor, PodMonitor and Probe object are forbidden to\nreference arbitrary files on the file system of the 'prometheus'\ncontainer.\nWhen a ServiceMonitor's endpoint specifies a `bearerTokenFile` value\n(e.g. '/var/run/secrets/kubernetes.io/serviceaccount/token'), a\nmalicious target can get access to the Prometheus service account's\ntoken in the Prometheus' scrape request. Setting\n`spec.arbitraryFSAccessThroughSM` to 'true' would prevent the attack.\nUsers should instead provide the credentials using the\n`spec.bearerTokenSecret` field.", "properties": { "deny": { "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] }, "automountServiceAccountToken": { "description": "AutomountServiceAccountToken indicates whether a service account token should be automatically mounted in the pod.\nIf the field isn't set, the operator mounts the service account token by default.\n\n**Warning:** be aware that by default, Prometheus requires the service account token for Kubernetes service discovery.\nIt is possible to use strategic merge patch to project the service account token into the 'prometheus' container.", "type": [ "boolean", "null" ] }, "baseImage": { "description": "Deprecated: use 'spec.image' instead.", "type": [ "string", "null" ] }, "bodySizeLimit": { "description": "BodySizeLimit defines per-scrape on response body size.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedBodySizeLimit.", "pattern": "(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$", "type": [ "string", "null" ] }, "configMaps": { "description": "ConfigMaps is a list of ConfigMaps in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach ConfigMap is added to the StatefulSet definition as a volume named `configmap-\u003cconfigmap-name\u003e`.\nThe ConfigMaps are mounted into /etc/prometheus/configmaps/\u003cconfigmap-name\u003e in the 'prometheus' container.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "containers": { "description": "Containers allows injecting additional containers or modifying operator\ngenerated containers. This can be used to allow adding an authentication\nproxy to the Pods or to change the behavior of an operator generated\ncontainer. Containers described here modify an operator generated\ncontainer if they share the same name and modifications are done via a\nstrategic merge patch.\n\nThe names of containers managed by the operator are:\n* `prometheus`\n* `config-reloader`\n* `thanos-sidecar`\n\nOverriding containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice.", "items": { "additionalProperties": false, "description": "A single application container that you want to run within a pod.", "properties": { "args": { "description": "Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "command": { "description": "Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "env": { "description": "List of environment variables to set in the container.\nCannot be updated.", "items": { "additionalProperties": false, "description": "EnvVar represents an environment variable present in a Container.", "properties": { "name": { "description": "Name of the environment variable. Must be a C_IDENTIFIER.", "type": "string" }, "value": { "description": "Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\".", "type": [ "string", "null" ] }, "valueFrom": { "additionalProperties": false, "description": "Source for the environment variable's value. Cannot be used if value is not empty.", "properties": { "configMapKeyRef": { "additionalProperties": false, "description": "Selects a key of a ConfigMap.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "fieldRef": { "additionalProperties": false, "description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.", "properties": { "apiVersion": { "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".", "type": [ "string", "null" ] }, "fieldPath": { "description": "Path of the field to select in the specified API version.", "type": "string" } }, "required": [ "fieldPath" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "resourceFieldRef": { "additionalProperties": false, "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.", "properties": { "containerName": { "description": "Container name: required for volumes, optional for env vars", "type": [ "string", "null" ] }, "divisor": { "description": "Specifies the output format of the exposed resources, defaults to \"1\"", "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" }, { "type": "null" } ], "x-kubernetes-int-or-string": true }, "resource": { "description": "Required: resource to select", "type": "string" } }, "required": [ "resource" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secretKeyRef": { "additionalProperties": false, "description": "Selects a key of a secret in the pod's namespace", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "envFrom": { "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.", "items": { "additionalProperties": false, "description": "EnvFromSource represents the source of a set of ConfigMaps or Secrets", "properties": { "configMapRef": { "additionalProperties": false, "description": "The ConfigMap to select from", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap must be defined", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "prefix": { "description": "Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.", "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "The Secret to select from", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret must be defined", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "image": { "description": "Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.", "type": [ "string", "null" ] }, "imagePullPolicy": { "description": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images", "type": [ "string", "null" ] }, "lifecycle": { "additionalProperties": false, "description": "Actions that the management system should take in response to container lifecycle events.\nCannot be updated.", "properties": { "postStart": { "additionalProperties": false, "description": "PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks", "properties": { "exec": { "additionalProperties": false, "description": "Exec specifies a command to execute in the container.", "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "httpGet": { "additionalProperties": false, "description": "HTTPGet specifies an HTTP GET request to perform.", "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.", "type": [ "string", "null" ] }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.", "items": { "additionalProperties": false, "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header.", "type": "string" }, "value": { "description": "The header field value", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "path": { "description": "Path to access on the HTTP server.", "type": [ "string", "null" ] }, "port": { "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "scheme": { "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "sleep": { "additionalProperties": false, "description": "Sleep represents a duration that the container should sleep.", "properties": { "seconds": { "description": "Seconds is the number of seconds to sleep.", "format": "int64", "type": "integer" } }, "required": [ "seconds" ], "type": [ "object", "null" ] }, "tcpSocket": { "additionalProperties": false, "description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor backward compatibility. There is no validation of this field and\nlifecycle hooks will fail at runtime when it is specified.", "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.", "type": [ "string", "null" ] }, "port": { "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true } }, "required": [ "port" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "preStop": { "additionalProperties": false, "description": "PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks", "properties": { "exec": { "additionalProperties": false, "description": "Exec specifies a command to execute in the container.", "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "httpGet": { "additionalProperties": false, "description": "HTTPGet specifies an HTTP GET request to perform.", "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.", "type": [ "string", "null" ] }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.", "items": { "additionalProperties": false, "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header.", "type": "string" }, "value": { "description": "The header field value", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "path": { "description": "Path to access on the HTTP server.", "type": [ "string", "null" ] }, "port": { "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "scheme": { "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "sleep": { "additionalProperties": false, "description": "Sleep represents a duration that the container should sleep.", "properties": { "seconds": { "description": "Seconds is the number of seconds to sleep.", "format": "int64", "type": "integer" } }, "required": [ "seconds" ], "type": [ "object", "null" ] }, "tcpSocket": { "additionalProperties": false, "description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor backward compatibility. There is no validation of this field and\nlifecycle hooks will fail at runtime when it is specified.", "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.", "type": [ "string", "null" ] }, "port": { "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true } }, "required": [ "port" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "stopSignal": { "description": "StopSignal defines which signal will be sent to a container when it is being stopped.\nIf not specified, the default is defined by the container runtime in use.\nStopSignal can only be set for Pods with a non-empty .spec.os.name", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "livenessProbe": { "additionalProperties": false, "description": "Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "properties": { "exec": { "additionalProperties": false, "description": "Exec specifies a command to execute in the container.", "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "failureThreshold": { "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "grpc": { "additionalProperties": false, "description": "GRPC specifies a GRPC HealthCheckRequest.", "properties": { "port": { "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", "format": "int32", "type": "integer" }, "service": { "default": "", "description": "Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "httpGet": { "additionalProperties": false, "description": "HTTPGet specifies an HTTP GET request to perform.", "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.", "type": [ "string", "null" ] }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.", "items": { "additionalProperties": false, "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header.", "type": "string" }, "value": { "description": "The header field value", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "path": { "description": "Path to access on the HTTP server.", "type": [ "string", "null" ] }, "port": { "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "scheme": { "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "initialDelaySeconds": { "description": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": [ "integer", "null" ] }, "periodSeconds": { "description": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "successThreshold": { "description": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "tcpSocket": { "additionalProperties": false, "description": "TCPSocket specifies a connection to a TCP port.", "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.", "type": [ "string", "null" ] }, "port": { "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true } }, "required": [ "port" ], "type": [ "object", "null" ] }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.", "format": "int64", "type": [ "integer", "null" ] }, "timeoutSeconds": { "description": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "name": { "description": "Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated.", "type": "string" }, "ports": { "description": "List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated.", "items": { "additionalProperties": false, "description": "ContainerPort represents a network port in a single container.", "properties": { "containerPort": { "description": "Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 \u003c x \u003c 65536.", "format": "int32", "type": "integer" }, "hostIP": { "description": "What host IP to bind the external port to.", "type": [ "string", "null" ] }, "hostPort": { "description": "Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 \u003c x \u003c 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this.", "format": "int32", "type": [ "integer", "null" ] }, "name": { "description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services.", "type": [ "string", "null" ] }, "protocol": { "default": "TCP", "description": "Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\".", "type": [ "string", "null" ] } }, "required": [ "containerPort" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "containerPort", "protocol" ], "x-kubernetes-list-type": "map" }, "readinessProbe": { "additionalProperties": false, "description": "Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "properties": { "exec": { "additionalProperties": false, "description": "Exec specifies a command to execute in the container.", "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "failureThreshold": { "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "grpc": { "additionalProperties": false, "description": "GRPC specifies a GRPC HealthCheckRequest.", "properties": { "port": { "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", "format": "int32", "type": "integer" }, "service": { "default": "", "description": "Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "httpGet": { "additionalProperties": false, "description": "HTTPGet specifies an HTTP GET request to perform.", "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.", "type": [ "string", "null" ] }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.", "items": { "additionalProperties": false, "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header.", "type": "string" }, "value": { "description": "The header field value", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "path": { "description": "Path to access on the HTTP server.", "type": [ "string", "null" ] }, "port": { "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "scheme": { "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "initialDelaySeconds": { "description": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": [ "integer", "null" ] }, "periodSeconds": { "description": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "successThreshold": { "description": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "tcpSocket": { "additionalProperties": false, "description": "TCPSocket specifies a connection to a TCP port.", "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.", "type": [ "string", "null" ] }, "port": { "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true } }, "required": [ "port" ], "type": [ "object", "null" ] }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.", "format": "int64", "type": [ "integer", "null" ] }, "timeoutSeconds": { "description": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "resizePolicy": { "description": "Resources resize policy for the container.", "items": { "additionalProperties": false, "description": "ContainerResizePolicy represents resource resize policy for the container.", "properties": { "resourceName": { "description": "Name of the resource to which this resource resize policy applies.\nSupported values: cpu, memory.", "type": "string" }, "restartPolicy": { "description": "Restart policy to apply when specified resource is resized.\nIf not specified, it defaults to NotRequired.", "type": "string" } }, "required": [ "resourceName", "restartPolicy" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "resources": { "additionalProperties": false, "description": "Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.", "items": { "additionalProperties": false, "description": "ResourceClaim references one entry in PodSpec.ResourceClaims.", "properties": { "name": { "description": "Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container.", "type": "string" }, "request": { "description": "Request is the name chosen for a request in the referenced claim.\nIf empty, everything from the claim is made available, otherwise\nonly the result of this request.", "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "limits": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] }, "requests": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "restartPolicy": { "description": "RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted.", "type": [ "string", "null" ] }, "securityContext": { "additionalProperties": false, "description": "SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/", "properties": { "allowPrivilegeEscalation": { "description": "AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows.", "type": [ "boolean", "null" ] }, "appArmorProfile": { "additionalProperties": false, "description": "appArmorProfile is the AppArmor options to use by this container. If set, this profile\noverrides the pod's appArmorProfile.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\".", "type": [ "string", "null" ] }, "type": { "description": "type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.", "type": "string" } }, "required": [ "type" ], "type": [ "object", "null" ] }, "capabilities": { "additionalProperties": false, "description": "The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "add": { "description": "Added capabilities", "items": { "description": "Capability represent POSIX capabilities type", "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "drop": { "description": "Removed capabilities", "items": { "description": "Capability represent POSIX capabilities type", "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "privileged": { "description": "Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows.", "type": [ "boolean", "null" ] }, "procMount": { "description": "procMount denotes the type of proc mount to use for the containers.\nThe default value is Default which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows.", "type": [ "string", "null" ] }, "readOnlyRootFilesystem": { "description": "Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows.", "type": [ "boolean", "null" ] }, "runAsGroup": { "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.", "format": "int64", "type": [ "integer", "null" ] }, "runAsNonRoot": { "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.", "type": [ "boolean", "null" ] }, "runAsUser": { "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.", "format": "int64", "type": [ "integer", "null" ] }, "seLinuxOptions": { "additionalProperties": false, "description": "The SELinux context to be applied to the container.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "level": { "description": "Level is SELinux level label that applies to the container.", "type": [ "string", "null" ] }, "role": { "description": "Role is a SELinux role label that applies to the container.", "type": [ "string", "null" ] }, "type": { "description": "Type is a SELinux type label that applies to the container.", "type": [ "string", "null" ] }, "user": { "description": "User is a SELinux user label that applies to the container.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "seccompProfile": { "additionalProperties": false, "description": "The seccomp options to use by this container. If seccomp options are\nprovided at both the pod \u0026 container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type.", "type": [ "string", "null" ] }, "type": { "description": "type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied.", "type": "string" } }, "required": [ "type" ], "type": [ "object", "null" ] }, "windowsOptions": { "additionalProperties": false, "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.", "properties": { "gmsaCredentialSpec": { "description": "GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field.", "type": [ "string", "null" ] }, "gmsaCredentialSpecName": { "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.", "type": [ "string", "null" ] }, "hostProcess": { "description": "HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true.", "type": [ "boolean", "null" ] }, "runAsUserName": { "description": "The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "startupProbe": { "additionalProperties": false, "description": "StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "properties": { "exec": { "additionalProperties": false, "description": "Exec specifies a command to execute in the container.", "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "failureThreshold": { "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "grpc": { "additionalProperties": false, "description": "GRPC specifies a GRPC HealthCheckRequest.", "properties": { "port": { "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", "format": "int32", "type": "integer" }, "service": { "default": "", "description": "Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "httpGet": { "additionalProperties": false, "description": "HTTPGet specifies an HTTP GET request to perform.", "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.", "type": [ "string", "null" ] }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.", "items": { "additionalProperties": false, "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header.", "type": "string" }, "value": { "description": "The header field value", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "path": { "description": "Path to access on the HTTP server.", "type": [ "string", "null" ] }, "port": { "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "scheme": { "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "initialDelaySeconds": { "description": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": [ "integer", "null" ] }, "periodSeconds": { "description": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "successThreshold": { "description": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "tcpSocket": { "additionalProperties": false, "description": "TCPSocket specifies a connection to a TCP port.", "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.", "type": [ "string", "null" ] }, "port": { "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true } }, "required": [ "port" ], "type": [ "object", "null" ] }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.", "format": "int64", "type": [ "integer", "null" ] }, "timeoutSeconds": { "description": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "stdin": { "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.", "type": [ "boolean", "null" ] }, "stdinOnce": { "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false", "type": [ "boolean", "null" ] }, "terminationMessagePath": { "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.", "type": [ "string", "null" ] }, "terminationMessagePolicy": { "description": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.", "type": [ "string", "null" ] }, "tty": { "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.", "type": [ "boolean", "null" ] }, "volumeDevices": { "description": "volumeDevices is the list of block devices to be used by the container.", "items": { "additionalProperties": false, "description": "volumeDevice describes a mapping of a raw block device within a container.", "properties": { "devicePath": { "description": "devicePath is the path inside of the container that the device will be mapped to.", "type": "string" }, "name": { "description": "name must match the name of a persistentVolumeClaim in the pod", "type": "string" } }, "required": [ "devicePath", "name" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "devicePath" ], "x-kubernetes-list-type": "map" }, "volumeMounts": { "description": "Pod volumes to mount into the container's filesystem.\nCannot be updated.", "items": { "additionalProperties": false, "description": "VolumeMount describes a mounting of a Volume within a container.", "properties": { "mountPath": { "description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.", "type": "string" }, "mountPropagation": { "description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None).", "type": [ "string", "null" ] }, "name": { "description": "This must match the Name of a Volume.", "type": "string" }, "readOnly": { "description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.", "type": [ "boolean", "null" ] }, "recursiveReadOnly": { "description": "RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\nIf this field is not specified, it is treated as an equivalent of Disabled.", "type": [ "string", "null" ] }, "subPath": { "description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).", "type": [ "string", "null" ] }, "subPathExpr": { "description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.", "type": [ "string", "null" ] } }, "required": [ "mountPath", "name" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "mountPath" ], "x-kubernetes-list-type": "map" }, "workingDir": { "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.", "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ] }, "convertClassicHistogramsToNHCB": { "description": "Whether to convert all scraped classic histograms into a native\nhistogram with custom buckets.\n\nIt requires Prometheus \u003e= v3.4.0.", "type": [ "boolean", "null" ] }, "disableCompaction": { "description": "When true, the Prometheus compaction is disabled.\nWhen `spec.thanos.objectStorageConfig` or `spec.objectStorageConfigFile` are defined, the operator automatically\ndisables block compaction to avoid race conditions during block uploads (as the Thanos documentation recommends).", "type": [ "boolean", "null" ] }, "dnsConfig": { "additionalProperties": false, "description": "Defines the DNS configuration for the pods.", "properties": { "nameservers": { "description": "A list of DNS name server IP addresses.\nThis will be appended to the base nameservers generated from DNSPolicy.", "items": { "minLength": 1, "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "options": { "description": "A list of DNS resolver options.\nThis will be merged with the base options generated from DNSPolicy.\nResolution options given in Options\nwill override those that appear in the base DNSPolicy.", "items": { "additionalProperties": false, "description": "PodDNSConfigOption defines DNS resolver options of a pod.", "properties": { "name": { "description": "Name is required and must be unique.", "minLength": 1, "type": "string" }, "value": { "description": "Value is optional.", "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "searches": { "description": "A list of DNS search domains for host-name lookup.\nThis will be appended to the base search paths generated from DNSPolicy.", "items": { "minLength": 1, "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" } }, "type": [ "object", "null" ] }, "dnsPolicy": { "description": "Defines the DNS policy for the pods.", "enum": [ "ClusterFirstWithHostNet", "ClusterFirst", "Default", "None" ], "type": [ "string", "null" ] }, "enableAdminAPI": { "description": "Enables access to the Prometheus web admin API.\n\nWARNING: Enabling the admin APIs enables mutating endpoints, to delete data,\nshutdown Prometheus, and more. Enabling this should be done with care and the\nuser is advised to add additional authentication authorization via a proxy to\nensure only clients authorized to perform these actions can do so.\n\nFor more information:\nhttps://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis", "type": [ "boolean", "null" ] }, "enableFeatures": { "description": "Enable access to Prometheus feature flags. By default, no features are enabled.\n\nEnabling features which are disabled by default is entirely outside the\nscope of what the maintainers will support and by doing so, you accept\nthat this behaviour may break at any time without notice.\n\nFor more information see https://prometheus.io/docs/prometheus/latest/feature_flags/", "items": { "minLength": 1, "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "enableOTLPReceiver": { "description": "Enable Prometheus to be used as a receiver for the OTLP Metrics protocol.\n\nNote that the OTLP receiver endpoint is automatically enabled if `.spec.otlpConfig` is defined.\n\nIt requires Prometheus \u003e= v2.47.0.", "type": [ "boolean", "null" ] }, "enableRemoteWriteReceiver": { "description": "Enable Prometheus to be used as a receiver for the Prometheus remote\nwrite protocol.\n\nWARNING: This is not considered an efficient way of ingesting samples.\nUse it with caution for specific low-volume use cases.\nIt is not suitable for replacing the ingestion via scraping and turning\nPrometheus into a push-based metrics collection system.\nFor more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver\n\nIt requires Prometheus \u003e= v2.33.0.", "type": [ "boolean", "null" ] }, "enableServiceLinks": { "description": "Indicates whether information about services should be injected into pod's environment variables", "type": [ "boolean", "null" ] }, "enforcedBodySizeLimit": { "description": "When defined, enforcedBodySizeLimit specifies a global limit on the size\nof uncompressed response body that will be accepted by Prometheus.\nTargets responding with a body larger than this many bytes will cause\nthe scrape to fail.\n\nIt requires Prometheus \u003e= v2.28.0.\n\nWhen both `enforcedBodySizeLimit` and `bodySizeLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined bodySizeLimit value will inherit the global bodySizeLimit value (Prometheus \u003e= 2.45.0) or the enforcedBodySizeLimit value (Prometheus \u003c v2.45.0).\n If Prometheus version is \u003e= 2.45.0 and the `enforcedBodySizeLimit` is greater than the `bodySizeLimit`, the `bodySizeLimit` will be set to `enforcedBodySizeLimit`.\n* Scrape objects with a bodySizeLimit value less than or equal to enforcedBodySizeLimit keep their specific value.\n* Scrape objects with a bodySizeLimit value greater than enforcedBodySizeLimit are set to enforcedBodySizeLimit.", "pattern": "(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$", "type": [ "string", "null" ] }, "enforcedKeepDroppedTargets": { "description": "When defined, enforcedKeepDroppedTargets specifies a global limit on the number of targets\ndropped by relabeling that will be kept in memory. The value overrides\nany `spec.keepDroppedTargets` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets` is\ngreater than zero and less than `spec.enforcedKeepDroppedTargets`.\n\nIt requires Prometheus \u003e= v2.47.0.\n\nWhen both `enforcedKeepDroppedTargets` and `keepDroppedTargets` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined keepDroppedTargets value will inherit the global keepDroppedTargets value (Prometheus \u003e= 2.45.0) or the enforcedKeepDroppedTargets value (Prometheus \u003c v2.45.0).\n If Prometheus version is \u003e= 2.45.0 and the `enforcedKeepDroppedTargets` is greater than the `keepDroppedTargets`, the `keepDroppedTargets` will be set to `enforcedKeepDroppedTargets`.\n* Scrape objects with a keepDroppedTargets value less than or equal to enforcedKeepDroppedTargets keep their specific value.\n* Scrape objects with a keepDroppedTargets value greater than enforcedKeepDroppedTargets are set to enforcedKeepDroppedTargets.", "format": "int64", "type": [ "integer", "null" ] }, "enforcedLabelLimit": { "description": "When defined, enforcedLabelLimit specifies a global limit on the number\nof labels per sample. The value overrides any `spec.labelLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelLimit` is\ngreater than zero and less than `spec.enforcedLabelLimit`.\n\nIt requires Prometheus \u003e= v2.27.0.\n\nWhen both `enforcedLabelLimit` and `labelLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelLimit value will inherit the global labelLimit value (Prometheus \u003e= 2.45.0) or the enforcedLabelLimit value (Prometheus \u003c v2.45.0).\n If Prometheus version is \u003e= 2.45.0 and the `enforcedLabelLimit` is greater than the `labelLimit`, the `labelLimit` will be set to `enforcedLabelLimit`.\n* Scrape objects with a labelLimit value less than or equal to enforcedLabelLimit keep their specific value.\n* Scrape objects with a labelLimit value greater than enforcedLabelLimit are set to enforcedLabelLimit.", "format": "int64", "type": [ "integer", "null" ] }, "enforcedLabelNameLengthLimit": { "description": "When defined, enforcedLabelNameLengthLimit specifies a global limit on the length\nof labels name per sample. The value overrides any `spec.labelNameLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelNameLengthLimit`.\n\nIt requires Prometheus \u003e= v2.27.0.\n\nWhen both `enforcedLabelNameLengthLimit` and `labelNameLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelNameLengthLimit value will inherit the global labelNameLengthLimit value (Prometheus \u003e= 2.45.0) or the enforcedLabelNameLengthLimit value (Prometheus \u003c v2.45.0).\n If Prometheus version is \u003e= 2.45.0 and the `enforcedLabelNameLengthLimit` is greater than the `labelNameLengthLimit`, the `labelNameLengthLimit` will be set to `enforcedLabelNameLengthLimit`.\n* Scrape objects with a labelNameLengthLimit value less than or equal to enforcedLabelNameLengthLimit keep their specific value.\n* Scrape objects with a labelNameLengthLimit value greater than enforcedLabelNameLengthLimit are set to enforcedLabelNameLengthLimit.", "format": "int64", "type": [ "integer", "null" ] }, "enforcedLabelValueLengthLimit": { "description": "When not null, enforcedLabelValueLengthLimit defines a global limit on the length\nof labels value per sample. The value overrides any `spec.labelValueLengthLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is\ngreater than zero and less than `spec.enforcedLabelValueLengthLimit`.\n\nIt requires Prometheus \u003e= v2.27.0.\n\nWhen both `enforcedLabelValueLengthLimit` and `labelValueLengthLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined labelValueLengthLimit value will inherit the global labelValueLengthLimit value (Prometheus \u003e= 2.45.0) or the enforcedLabelValueLengthLimit value (Prometheus \u003c v2.45.0).\n If Prometheus version is \u003e= 2.45.0 and the `enforcedLabelValueLengthLimit` is greater than the `labelValueLengthLimit`, the `labelValueLengthLimit` will be set to `enforcedLabelValueLengthLimit`.\n* Scrape objects with a labelValueLengthLimit value less than or equal to enforcedLabelValueLengthLimit keep their specific value.\n* Scrape objects with a labelValueLengthLimit value greater than enforcedLabelValueLengthLimit are set to enforcedLabelValueLengthLimit.", "format": "int64", "type": [ "integer", "null" ] }, "enforcedNamespaceLabel": { "description": "When not empty, a label will be added to:\n\n1. All metrics scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig` objects.\n2. All metrics generated from recording rules defined in `PrometheusRule` objects.\n3. All alerts generated from alerting rules defined in `PrometheusRule` objects.\n4. All vector selectors of PromQL expressions defined in `PrometheusRule` objects.\n\nThe label will not added for objects referenced in `spec.excludedFromEnforcement`.\n\nThe label's name is this field's value.\nThe label's value is the namespace of the `ServiceMonitor`,\n`PodMonitor`, `Probe`, `PrometheusRule` or `ScrapeConfig` object.", "type": [ "string", "null" ] }, "enforcedSampleLimit": { "description": "When defined, enforcedSampleLimit specifies a global limit on the number\nof scraped samples that will be accepted. This overrides any\n`spec.sampleLimit` set by ServiceMonitor, PodMonitor, Probe objects\nunless `spec.sampleLimit` is greater than zero and less than\n`spec.enforcedSampleLimit`.\n\nIt is meant to be used by admins to keep the overall number of\nsamples/series under a desired limit.\n\nWhen both `enforcedSampleLimit` and `sampleLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined sampleLimit value will inherit the global sampleLimit value (Prometheus \u003e= 2.45.0) or the enforcedSampleLimit value (Prometheus \u003c v2.45.0).\n If Prometheus version is \u003e= 2.45.0 and the `enforcedSampleLimit` is greater than the `sampleLimit`, the `sampleLimit` will be set to `enforcedSampleLimit`.\n* Scrape objects with a sampleLimit value less than or equal to enforcedSampleLimit keep their specific value.\n* Scrape objects with a sampleLimit value greater than enforcedSampleLimit are set to enforcedSampleLimit.", "format": "int64", "type": [ "integer", "null" ] }, "enforcedTargetLimit": { "description": "When defined, enforcedTargetLimit specifies a global limit on the number\nof scraped targets. The value overrides any `spec.targetLimit` set by\nServiceMonitor, PodMonitor, Probe objects unless `spec.targetLimit` is\ngreater than zero and less than `spec.enforcedTargetLimit`.\n\nIt is meant to be used by admins to to keep the overall number of\ntargets under a desired limit.\n\nWhen both `enforcedTargetLimit` and `targetLimit` are defined and greater than zero, the following rules apply:\n* Scrape objects without a defined targetLimit value will inherit the global targetLimit value (Prometheus \u003e= 2.45.0) or the enforcedTargetLimit value (Prometheus \u003c v2.45.0).\n If Prometheus version is \u003e= 2.45.0 and the `enforcedTargetLimit` is greater than the `targetLimit`, the `targetLimit` will be set to `enforcedTargetLimit`.\n* Scrape objects with a targetLimit value less than or equal to enforcedTargetLimit keep their specific value.\n* Scrape objects with a targetLimit value greater than enforcedTargetLimit are set to enforcedTargetLimit.", "format": "int64", "type": [ "integer", "null" ] }, "evaluationInterval": { "default": "30s", "description": "Interval between rule evaluations.\nDefault: \"30s\"", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "excludedFromEnforcement": { "description": "List of references to PodMonitor, ServiceMonitor, Probe and PrometheusRule objects\nto be excluded from enforcing a namespace label of origin.\n\nIt is only applicable if `spec.enforcedNamespaceLabel` set to true.", "items": { "additionalProperties": false, "description": "ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.", "properties": { "group": { "default": "monitoring.coreos.com", "description": "Group of the referent. When not specified, it defaults to `monitoring.coreos.com`", "enum": [ "monitoring.coreos.com" ], "type": [ "string", "null" ] }, "name": { "description": "Name of the referent. When not set, all resources in the namespace are matched.", "type": [ "string", "null" ] }, "namespace": { "description": "Namespace of the referent.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/", "minLength": 1, "type": "string" }, "resource": { "description": "Resource of the referent.", "enum": [ "prometheusrules", "servicemonitors", "podmonitors", "probes", "scrapeconfigs" ], "type": "string" } }, "required": [ "namespace", "resource" ], "type": "object" }, "type": [ "array", "null" ] }, "exemplars": { "additionalProperties": false, "description": "Exemplars related settings that are runtime reloadable.\nIt requires to enable the `exemplar-storage` feature flag to be effective.", "properties": { "maxSize": { "description": "Maximum number of exemplars stored in memory for all series.\n\nexemplar-storage itself must be enabled using the `spec.enableFeature`\noption for exemplars to be scraped in the first place.\n\nIf not set, Prometheus uses its default value. A value of zero or less\nthan zero disables the storage.", "format": "int64", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "externalLabels": { "additionalProperties": { "type": "string" }, "description": "The labels to add to any time series or alerts when communicating with\nexternal systems (federation, remote storage, Alertmanager).\nLabels defined by `spec.replicaExternalLabelName` and\n`spec.prometheusExternalLabelName` take precedence over this list.", "type": [ "object", "null" ] }, "externalUrl": { "description": "The external URL under which the Prometheus service is externally\navailable. This is necessary to generate correct URLs (for instance if\nPrometheus is accessible behind an Ingress resource).", "type": [ "string", "null" ] }, "hostAliases": { "description": "Optional list of hosts and IPs that will be injected into the Pod's\nhosts file if specified.", "items": { "additionalProperties": false, "description": "HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the\npod's hosts file.", "properties": { "hostnames": { "description": "Hostnames for the above IP address.", "items": { "type": "string" }, "type": "array" }, "ip": { "description": "IP address of the host file entry.", "type": "string" } }, "required": [ "hostnames", "ip" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "ip" ], "x-kubernetes-list-type": "map" }, "hostNetwork": { "description": "Use the host's network namespace if true.\n\nMake sure to understand the security implications if you want to enable\nit (https://kubernetes.io/docs/concepts/configuration/overview/ ).\n\nWhen hostNetwork is enabled, this will set the DNS policy to\n`ClusterFirstWithHostNet` automatically (unless `.spec.DNSPolicy` is set\nto a different value).", "type": [ "boolean", "null" ] }, "hostUsers": { "description": "HostUsers supports the user space in Kubernetes.\n\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/\n\nThe feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled.\nStarting Kubernetes 1.33, the feature is enabled by default.", "type": [ "boolean", "null" ] }, "ignoreNamespaceSelectors": { "description": "When true, `spec.namespaceSelector` from all PodMonitor, ServiceMonitor\nand Probe objects will be ignored. They will only discover targets\nwithin the namespace of the PodMonitor, ServiceMonitor and Probe\nobject.", "type": [ "boolean", "null" ] }, "image": { "description": "Container image name for Prometheus. If specified, it takes precedence\nover the `spec.baseImage`, `spec.tag` and `spec.sha` fields.\n\nSpecifying `spec.version` is still necessary to ensure the Prometheus\nOperator knows which version of Prometheus is being configured.\n\nIf neither `spec.image` nor `spec.baseImage` are defined, the operator\nwill use the latest upstream version of Prometheus available at the time\nwhen the operator was released.", "type": [ "string", "null" ] }, "imagePullPolicy": { "description": "Image pull policy for the 'prometheus', 'init-config-reloader' and 'config-reloader' containers.\nSee https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.", "enum": [ "", "Always", "Never", "IfNotPresent" ], "type": [ "string", "null" ] }, "imagePullSecrets": { "description": "An optional list of references to Secrets in the same namespace\nto use for pulling images from registries.\nSee http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod", "items": { "additionalProperties": false, "description": "LocalObjectReference contains enough information to let you locate the\nreferenced object inside the same namespace.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "type": [ "array", "null" ] }, "initContainers": { "description": "InitContainers allows injecting initContainers to the Pod definition. Those\ncan be used to e.g. fetch secrets for injection into the Prometheus\nconfiguration from external sources. Any errors during the execution of\nan initContainer will lead to a restart of the Pod. More info:\nhttps://kubernetes.io/docs/concepts/workloads/pods/init-containers/\nInitContainers described here modify an operator generated init\ncontainers if they share the same name and modifications are done via a\nstrategic merge patch.\n\nThe names of init container name managed by the operator are:\n* `init-config-reloader`.\n\nOverriding init containers is entirely outside the scope of what the\nmaintainers will support and by doing so, you accept that this behaviour\nmay break at any time without notice.", "items": { "additionalProperties": false, "description": "A single application container that you want to run within a pod.", "properties": { "args": { "description": "Arguments to the entrypoint.\nThe container image's CMD is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "command": { "description": "Entrypoint array. Not executed within a shell.\nThe container image's ENTRYPOINT is used if this is not provided.\nVariable references $(VAR_NAME) are expanded using the container's environment. If a variable\ncannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. \"$$(VAR_NAME)\" will\nproduce the string literal \"$(VAR_NAME)\". Escaped references will never be expanded, regardless\nof whether the variable exists or not. Cannot be updated.\nMore info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "env": { "description": "List of environment variables to set in the container.\nCannot be updated.", "items": { "additionalProperties": false, "description": "EnvVar represents an environment variable present in a Container.", "properties": { "name": { "description": "Name of the environment variable. Must be a C_IDENTIFIER.", "type": "string" }, "value": { "description": "Variable references $(VAR_NAME) are expanded\nusing the previously defined environment variables in the container and\nany service environment variables. If a variable cannot be resolved,\nthe reference in the input string will be unchanged. Double $$ are reduced\nto a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.\n\"$$(VAR_NAME)\" will produce the string literal \"$(VAR_NAME)\".\nEscaped references will never be expanded, regardless of whether the variable\nexists or not.\nDefaults to \"\".", "type": [ "string", "null" ] }, "valueFrom": { "additionalProperties": false, "description": "Source for the environment variable's value. Cannot be used if value is not empty.", "properties": { "configMapKeyRef": { "additionalProperties": false, "description": "Selects a key of a ConfigMap.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "fieldRef": { "additionalProperties": false, "description": "Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['\u003cKEY\u003e']`, `metadata.annotations['\u003cKEY\u003e']`,\nspec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.", "properties": { "apiVersion": { "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".", "type": [ "string", "null" ] }, "fieldPath": { "description": "Path of the field to select in the specified API version.", "type": "string" } }, "required": [ "fieldPath" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "resourceFieldRef": { "additionalProperties": false, "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.", "properties": { "containerName": { "description": "Container name: required for volumes, optional for env vars", "type": [ "string", "null" ] }, "divisor": { "description": "Specifies the output format of the exposed resources, defaults to \"1\"", "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" }, { "type": "null" } ], "x-kubernetes-int-or-string": true }, "resource": { "description": "Required: resource to select", "type": "string" } }, "required": [ "resource" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secretKeyRef": { "additionalProperties": false, "description": "Selects a key of a secret in the pod's namespace", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "envFrom": { "description": "List of sources to populate environment variables in the container.\nThe keys defined within a source must be a C_IDENTIFIER. All invalid keys\nwill be reported as an event when the container is starting. When a key exists in multiple\nsources, the value associated with the last source will take precedence.\nValues defined by an Env with a duplicate key will take precedence.\nCannot be updated.", "items": { "additionalProperties": false, "description": "EnvFromSource represents the source of a set of ConfigMaps or Secrets", "properties": { "configMapRef": { "additionalProperties": false, "description": "The ConfigMap to select from", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap must be defined", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "prefix": { "description": "Optional text to prepend to the name of each environment variable. Must be a C_IDENTIFIER.", "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "The Secret to select from", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret must be defined", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "image": { "description": "Container image name.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.", "type": [ "string", "null" ] }, "imagePullPolicy": { "description": "Image pull policy.\nOne of Always, Never, IfNotPresent.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/containers/images#updating-images", "type": [ "string", "null" ] }, "lifecycle": { "additionalProperties": false, "description": "Actions that the management system should take in response to container lifecycle events.\nCannot be updated.", "properties": { "postStart": { "additionalProperties": false, "description": "PostStart is called immediately after a container is created. If the handler fails,\nthe container is terminated and restarted according to its restart policy.\nOther management of the container blocks until the hook completes.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks", "properties": { "exec": { "additionalProperties": false, "description": "Exec specifies a command to execute in the container.", "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "httpGet": { "additionalProperties": false, "description": "HTTPGet specifies an HTTP GET request to perform.", "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.", "type": [ "string", "null" ] }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.", "items": { "additionalProperties": false, "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header.", "type": "string" }, "value": { "description": "The header field value", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "path": { "description": "Path to access on the HTTP server.", "type": [ "string", "null" ] }, "port": { "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "scheme": { "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "sleep": { "additionalProperties": false, "description": "Sleep represents a duration that the container should sleep.", "properties": { "seconds": { "description": "Seconds is the number of seconds to sleep.", "format": "int64", "type": "integer" } }, "required": [ "seconds" ], "type": [ "object", "null" ] }, "tcpSocket": { "additionalProperties": false, "description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor backward compatibility. There is no validation of this field and\nlifecycle hooks will fail at runtime when it is specified.", "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.", "type": [ "string", "null" ] }, "port": { "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true } }, "required": [ "port" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "preStop": { "additionalProperties": false, "description": "PreStop is called immediately before a container is terminated due to an\nAPI request or management event such as liveness/startup probe failure,\npreemption, resource contention, etc. The handler is not called if the\ncontainer crashes or exits. The Pod's termination grace period countdown begins before the\nPreStop hook is executed. Regardless of the outcome of the handler, the\ncontainer will eventually terminate within the Pod's termination grace\nperiod (unless delayed by finalizers). Other management of the container blocks until the hook completes\nor until the termination grace period is reached.\nMore info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks", "properties": { "exec": { "additionalProperties": false, "description": "Exec specifies a command to execute in the container.", "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "httpGet": { "additionalProperties": false, "description": "HTTPGet specifies an HTTP GET request to perform.", "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.", "type": [ "string", "null" ] }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.", "items": { "additionalProperties": false, "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header.", "type": "string" }, "value": { "description": "The header field value", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "path": { "description": "Path to access on the HTTP server.", "type": [ "string", "null" ] }, "port": { "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "scheme": { "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "sleep": { "additionalProperties": false, "description": "Sleep represents a duration that the container should sleep.", "properties": { "seconds": { "description": "Seconds is the number of seconds to sleep.", "format": "int64", "type": "integer" } }, "required": [ "seconds" ], "type": [ "object", "null" ] }, "tcpSocket": { "additionalProperties": false, "description": "Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept\nfor backward compatibility. There is no validation of this field and\nlifecycle hooks will fail at runtime when it is specified.", "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.", "type": [ "string", "null" ] }, "port": { "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true } }, "required": [ "port" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "stopSignal": { "description": "StopSignal defines which signal will be sent to a container when it is being stopped.\nIf not specified, the default is defined by the container runtime in use.\nStopSignal can only be set for Pods with a non-empty .spec.os.name", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "livenessProbe": { "additionalProperties": false, "description": "Periodic probe of container liveness.\nContainer will be restarted if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "properties": { "exec": { "additionalProperties": false, "description": "Exec specifies a command to execute in the container.", "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "failureThreshold": { "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "grpc": { "additionalProperties": false, "description": "GRPC specifies a GRPC HealthCheckRequest.", "properties": { "port": { "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", "format": "int32", "type": "integer" }, "service": { "default": "", "description": "Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "httpGet": { "additionalProperties": false, "description": "HTTPGet specifies an HTTP GET request to perform.", "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.", "type": [ "string", "null" ] }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.", "items": { "additionalProperties": false, "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header.", "type": "string" }, "value": { "description": "The header field value", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "path": { "description": "Path to access on the HTTP server.", "type": [ "string", "null" ] }, "port": { "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "scheme": { "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "initialDelaySeconds": { "description": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": [ "integer", "null" ] }, "periodSeconds": { "description": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "successThreshold": { "description": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "tcpSocket": { "additionalProperties": false, "description": "TCPSocket specifies a connection to a TCP port.", "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.", "type": [ "string", "null" ] }, "port": { "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true } }, "required": [ "port" ], "type": [ "object", "null" ] }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.", "format": "int64", "type": [ "integer", "null" ] }, "timeoutSeconds": { "description": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "name": { "description": "Name of the container specified as a DNS_LABEL.\nEach container in a pod must have a unique name (DNS_LABEL).\nCannot be updated.", "type": "string" }, "ports": { "description": "List of ports to expose from the container. Not specifying a port here\nDOES NOT prevent that port from being exposed. Any port which is\nlistening on the default \"0.0.0.0\" address inside a container will be\naccessible from the network.\nModifying this array with strategic merge patch may corrupt the data.\nFor more information See https://github.com/kubernetes/kubernetes/issues/108255.\nCannot be updated.", "items": { "additionalProperties": false, "description": "ContainerPort represents a network port in a single container.", "properties": { "containerPort": { "description": "Number of port to expose on the pod's IP address.\nThis must be a valid port number, 0 \u003c x \u003c 65536.", "format": "int32", "type": "integer" }, "hostIP": { "description": "What host IP to bind the external port to.", "type": [ "string", "null" ] }, "hostPort": { "description": "Number of port to expose on the host.\nIf specified, this must be a valid port number, 0 \u003c x \u003c 65536.\nIf HostNetwork is specified, this must match ContainerPort.\nMost containers do not need this.", "format": "int32", "type": [ "integer", "null" ] }, "name": { "description": "If specified, this must be an IANA_SVC_NAME and unique within the pod. Each\nnamed port in a pod must have a unique name. Name for the port that can be\nreferred to by services.", "type": [ "string", "null" ] }, "protocol": { "default": "TCP", "description": "Protocol for port. Must be UDP, TCP, or SCTP.\nDefaults to \"TCP\".", "type": [ "string", "null" ] } }, "required": [ "containerPort" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "containerPort", "protocol" ], "x-kubernetes-list-type": "map" }, "readinessProbe": { "additionalProperties": false, "description": "Periodic probe of container service readiness.\nContainer will be removed from service endpoints if the probe fails.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "properties": { "exec": { "additionalProperties": false, "description": "Exec specifies a command to execute in the container.", "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "failureThreshold": { "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "grpc": { "additionalProperties": false, "description": "GRPC specifies a GRPC HealthCheckRequest.", "properties": { "port": { "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", "format": "int32", "type": "integer" }, "service": { "default": "", "description": "Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "httpGet": { "additionalProperties": false, "description": "HTTPGet specifies an HTTP GET request to perform.", "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.", "type": [ "string", "null" ] }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.", "items": { "additionalProperties": false, "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header.", "type": "string" }, "value": { "description": "The header field value", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "path": { "description": "Path to access on the HTTP server.", "type": [ "string", "null" ] }, "port": { "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "scheme": { "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "initialDelaySeconds": { "description": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": [ "integer", "null" ] }, "periodSeconds": { "description": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "successThreshold": { "description": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "tcpSocket": { "additionalProperties": false, "description": "TCPSocket specifies a connection to a TCP port.", "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.", "type": [ "string", "null" ] }, "port": { "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true } }, "required": [ "port" ], "type": [ "object", "null" ] }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.", "format": "int64", "type": [ "integer", "null" ] }, "timeoutSeconds": { "description": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "resizePolicy": { "description": "Resources resize policy for the container.", "items": { "additionalProperties": false, "description": "ContainerResizePolicy represents resource resize policy for the container.", "properties": { "resourceName": { "description": "Name of the resource to which this resource resize policy applies.\nSupported values: cpu, memory.", "type": "string" }, "restartPolicy": { "description": "Restart policy to apply when specified resource is resized.\nIf not specified, it defaults to NotRequired.", "type": "string" } }, "required": [ "resourceName", "restartPolicy" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "resources": { "additionalProperties": false, "description": "Compute Resources required by this container.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.", "items": { "additionalProperties": false, "description": "ResourceClaim references one entry in PodSpec.ResourceClaims.", "properties": { "name": { "description": "Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container.", "type": "string" }, "request": { "description": "Request is the name chosen for a request in the referenced claim.\nIf empty, everything from the claim is made available, otherwise\nonly the result of this request.", "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "limits": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] }, "requests": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "restartPolicy": { "description": "RestartPolicy defines the restart behavior of individual containers in a pod.\nThis field may only be set for init containers, and the only allowed value is \"Always\".\nFor non-init containers or when this field is not specified,\nthe restart behavior is defined by the Pod's restart policy and the container type.\nSetting the RestartPolicy as \"Always\" for the init container will have the following effect:\nthis init container will be continually restarted on\nexit until all regular containers have terminated. Once all regular\ncontainers have completed, all init containers with restartPolicy \"Always\"\nwill be shut down. This lifecycle differs from normal init containers and\nis often referred to as a \"sidecar\" container. Although this init\ncontainer still starts in the init container sequence, it does not wait\nfor the container to complete before proceeding to the next init\ncontainer. Instead, the next init container starts immediately after this\ninit container is started, or after any startupProbe has successfully\ncompleted.", "type": [ "string", "null" ] }, "securityContext": { "additionalProperties": false, "description": "SecurityContext defines the security options the container should be run with.\nIf set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.\nMore info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/", "properties": { "allowPrivilegeEscalation": { "description": "AllowPrivilegeEscalation controls whether a process can gain more\nprivileges than its parent process. This bool directly controls if\nthe no_new_privs flag will be set on the container process.\nAllowPrivilegeEscalation is true always when the container is:\n1) run as Privileged\n2) has CAP_SYS_ADMIN\nNote that this field cannot be set when spec.os.name is windows.", "type": [ "boolean", "null" ] }, "appArmorProfile": { "additionalProperties": false, "description": "appArmorProfile is the AppArmor options to use by this container. If set, this profile\noverrides the pod's appArmorProfile.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\".", "type": [ "string", "null" ] }, "type": { "description": "type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.", "type": "string" } }, "required": [ "type" ], "type": [ "object", "null" ] }, "capabilities": { "additionalProperties": false, "description": "The capabilities to add/drop when running containers.\nDefaults to the default set of capabilities granted by the container runtime.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "add": { "description": "Added capabilities", "items": { "description": "Capability represent POSIX capabilities type", "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "drop": { "description": "Removed capabilities", "items": { "description": "Capability represent POSIX capabilities type", "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "privileged": { "description": "Run container in privileged mode.\nProcesses in privileged containers are essentially equivalent to root on the host.\nDefaults to false.\nNote that this field cannot be set when spec.os.name is windows.", "type": [ "boolean", "null" ] }, "procMount": { "description": "procMount denotes the type of proc mount to use for the containers.\nThe default value is Default which uses the container runtime defaults for\nreadonly paths and masked paths.\nThis requires the ProcMountType feature flag to be enabled.\nNote that this field cannot be set when spec.os.name is windows.", "type": [ "string", "null" ] }, "readOnlyRootFilesystem": { "description": "Whether this container has a read-only root filesystem.\nDefault is false.\nNote that this field cannot be set when spec.os.name is windows.", "type": [ "boolean", "null" ] }, "runAsGroup": { "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.", "format": "int64", "type": [ "integer", "null" ] }, "runAsNonRoot": { "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.", "type": [ "boolean", "null" ] }, "runAsUser": { "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.", "format": "int64", "type": [ "integer", "null" ] }, "seLinuxOptions": { "additionalProperties": false, "description": "The SELinux context to be applied to the container.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "level": { "description": "Level is SELinux level label that applies to the container.", "type": [ "string", "null" ] }, "role": { "description": "Role is a SELinux role label that applies to the container.", "type": [ "string", "null" ] }, "type": { "description": "Type is a SELinux type label that applies to the container.", "type": [ "string", "null" ] }, "user": { "description": "User is a SELinux user label that applies to the container.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "seccompProfile": { "additionalProperties": false, "description": "The seccomp options to use by this container. If seccomp options are\nprovided at both the pod \u0026 container level, the container options\noverride the pod options.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type.", "type": [ "string", "null" ] }, "type": { "description": "type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied.", "type": "string" } }, "required": [ "type" ], "type": [ "object", "null" ] }, "windowsOptions": { "additionalProperties": false, "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options from the PodSecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.", "properties": { "gmsaCredentialSpec": { "description": "GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field.", "type": [ "string", "null" ] }, "gmsaCredentialSpecName": { "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.", "type": [ "string", "null" ] }, "hostProcess": { "description": "HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true.", "type": [ "boolean", "null" ] }, "runAsUserName": { "description": "The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "startupProbe": { "additionalProperties": false, "description": "StartupProbe indicates that the Pod has successfully initialized.\nIf specified, no other probes are executed until this completes successfully.\nIf this probe fails, the Pod will be restarted, just as if the livenessProbe failed.\nThis can be used to provide different probe parameters at the beginning of a Pod's lifecycle,\nwhen it might take a long time to load data or warm a cache, than during steady-state operation.\nThis cannot be updated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "properties": { "exec": { "additionalProperties": false, "description": "Exec specifies a command to execute in the container.", "properties": { "command": { "description": "Command is the command line to execute inside the container, the working directory for the\ncommand is root ('/') in the container's filesystem. The command is simply exec'd, it is\nnot run inside a shell, so traditional shell instructions ('|', etc) won't work. To use\na shell, you need to explicitly call out to that shell.\nExit status of 0 is treated as live/healthy and non-zero is unhealthy.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "failureThreshold": { "description": "Minimum consecutive failures for the probe to be considered failed after having succeeded.\nDefaults to 3. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "grpc": { "additionalProperties": false, "description": "GRPC specifies a GRPC HealthCheckRequest.", "properties": { "port": { "description": "Port number of the gRPC service. Number must be in the range 1 to 65535.", "format": "int32", "type": "integer" }, "service": { "default": "", "description": "Service is the name of the service to place in the gRPC HealthCheckRequest\n(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).\n\nIf this is not specified, the default behavior is defined by gRPC.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "httpGet": { "additionalProperties": false, "description": "HTTPGet specifies an HTTP GET request to perform.", "properties": { "host": { "description": "Host name to connect to, defaults to the pod IP. You probably want to set\n\"Host\" in httpHeaders instead.", "type": [ "string", "null" ] }, "httpHeaders": { "description": "Custom headers to set in the request. HTTP allows repeated headers.", "items": { "additionalProperties": false, "description": "HTTPHeader describes a custom header to be used in HTTP probes", "properties": { "name": { "description": "The header field name.\nThis will be canonicalized upon output, so case-variant names will be understood as the same header.", "type": "string" }, "value": { "description": "The header field value", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "path": { "description": "Path to access on the HTTP server.", "type": [ "string", "null" ] }, "port": { "description": "Name or number of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "scheme": { "description": "Scheme to use for connecting to the host.\nDefaults to HTTP.", "type": [ "string", "null" ] } }, "required": [ "port" ], "type": [ "object", "null" ] }, "initialDelaySeconds": { "description": "Number of seconds after the container has started before liveness probes are initiated.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": [ "integer", "null" ] }, "periodSeconds": { "description": "How often (in seconds) to perform the probe.\nDefault to 10 seconds. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "successThreshold": { "description": "Minimum consecutive successes for the probe to be considered successful after having failed.\nDefaults to 1. Must be 1 for liveness and startup. Minimum value is 1.", "format": "int32", "type": [ "integer", "null" ] }, "tcpSocket": { "additionalProperties": false, "description": "TCPSocket specifies a connection to a TCP port.", "properties": { "host": { "description": "Optional: Host name to connect to, defaults to the pod IP.", "type": [ "string", "null" ] }, "port": { "description": "Number or name of the port to access on the container.\nNumber must be in the range 1 to 65535.\nName must be an IANA_SVC_NAME.", "oneOf": [ { "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true } }, "required": [ "port" ], "type": [ "object", "null" ] }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully upon probe failure.\nThe grace period is the duration in seconds after the processes running in the pod are sent\na termination signal and the time when the processes are forcibly halted with a kill signal.\nSet this value longer than the expected cleanup time for your process.\nIf this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this\nvalue overrides the value provided by the pod spec.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down).\nThis is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.\nMinimum value is 1. spec.terminationGracePeriodSeconds is used if unset.", "format": "int64", "type": [ "integer", "null" ] }, "timeoutSeconds": { "description": "Number of seconds after which the probe times out.\nDefaults to 1 second. Minimum value is 1.\nMore info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes", "format": "int32", "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "stdin": { "description": "Whether this container should allocate a buffer for stdin in the container runtime. If this\nis not set, reads from stdin in the container will always result in EOF.\nDefault is false.", "type": [ "boolean", "null" ] }, "stdinOnce": { "description": "Whether the container runtime should close the stdin channel after it has been opened by\na single attach. When stdin is true the stdin stream will remain open across multiple attach\nsessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the\nfirst client attaches to stdin, and then remains open and accepts data until the client disconnects,\nat which time stdin is closed and remains closed until the container is restarted. If this\nflag is false, a container processes that reads from stdin will never receive an EOF.\nDefault is false", "type": [ "boolean", "null" ] }, "terminationMessagePath": { "description": "Optional: Path at which the file to which the container's termination message\nwill be written is mounted into the container's filesystem.\nMessage written is intended to be brief final status, such as an assertion failure message.\nWill be truncated by the node if greater than 4096 bytes. The total message length across\nall containers will be limited to 12kb.\nDefaults to /dev/termination-log.\nCannot be updated.", "type": [ "string", "null" ] }, "terminationMessagePolicy": { "description": "Indicate how the termination message should be populated. File will use the contents of\nterminationMessagePath to populate the container status message on both success and failure.\nFallbackToLogsOnError will use the last chunk of container log output if the termination\nmessage file is empty and the container exited with an error.\nThe log output is limited to 2048 bytes or 80 lines, whichever is smaller.\nDefaults to File.\nCannot be updated.", "type": [ "string", "null" ] }, "tty": { "description": "Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.\nDefault is false.", "type": [ "boolean", "null" ] }, "volumeDevices": { "description": "volumeDevices is the list of block devices to be used by the container.", "items": { "additionalProperties": false, "description": "volumeDevice describes a mapping of a raw block device within a container.", "properties": { "devicePath": { "description": "devicePath is the path inside of the container that the device will be mapped to.", "type": "string" }, "name": { "description": "name must match the name of a persistentVolumeClaim in the pod", "type": "string" } }, "required": [ "devicePath", "name" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "devicePath" ], "x-kubernetes-list-type": "map" }, "volumeMounts": { "description": "Pod volumes to mount into the container's filesystem.\nCannot be updated.", "items": { "additionalProperties": false, "description": "VolumeMount describes a mounting of a Volume within a container.", "properties": { "mountPath": { "description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.", "type": "string" }, "mountPropagation": { "description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None).", "type": [ "string", "null" ] }, "name": { "description": "This must match the Name of a Volume.", "type": "string" }, "readOnly": { "description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.", "type": [ "boolean", "null" ] }, "recursiveReadOnly": { "description": "RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\nIf this field is not specified, it is treated as an equivalent of Disabled.", "type": [ "string", "null" ] }, "subPath": { "description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).", "type": [ "string", "null" ] }, "subPathExpr": { "description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.", "type": [ "string", "null" ] } }, "required": [ "mountPath", "name" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "mountPath" ], "x-kubernetes-list-type": "map" }, "workingDir": { "description": "Container's working directory.\nIf not specified, the container runtime's default will be used, which\nmight be configured in the container image.\nCannot be updated.", "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ] }, "keepDroppedTargets": { "description": "Per-scrape limit on the number of targets dropped by relabeling\nthat will be kept in memory. 0 means no limit.\n\nIt requires Prometheus \u003e= v2.47.0.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedKeepDroppedTargets.", "format": "int64", "type": [ "integer", "null" ] }, "labelLimit": { "description": "Per-scrape limit on number of labels that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelLimit.", "format": "int64", "type": [ "integer", "null" ] }, "labelNameLengthLimit": { "description": "Per-scrape limit on length of labels name that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelNameLengthLimit.", "format": "int64", "type": [ "integer", "null" ] }, "labelValueLengthLimit": { "description": "Per-scrape limit on length of labels value that will be accepted for a sample.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedLabelValueLengthLimit.", "format": "int64", "type": [ "integer", "null" ] }, "listenLocal": { "description": "When true, the Prometheus server listens on the loopback address\ninstead of the Pod IP's address.", "type": [ "boolean", "null" ] }, "logFormat": { "description": "Log format for Log level for Prometheus and the config-reloader sidecar.", "enum": [ "", "logfmt", "json" ], "type": [ "string", "null" ] }, "logLevel": { "description": "Log level for Prometheus and the config-reloader sidecar.", "enum": [ "", "debug", "info", "warn", "error" ], "type": [ "string", "null" ] }, "maximumStartupDurationSeconds": { "description": "Defines the maximum time that the `prometheus` container's startup probe will wait before being considered failed. The startup probe will return success after the WAL replay is complete.\nIf set, the value should be greater than 60 (seconds). Otherwise it will be equal to 600 seconds (15 minutes).", "format": "int32", "minimum": 60, "type": [ "integer", "null" ] }, "minReadySeconds": { "description": "Minimum number of seconds for which a newly created Pod should be ready\nwithout any of its container crashing for it to be considered available.\n\nIf unset, pods will be considered available as soon as they are ready.", "format": "int32", "minimum": 0, "type": [ "integer", "null" ] }, "nameEscapingScheme": { "description": "Specifies the character escaping scheme that will be requested when scraping\nfor metric and label names that do not conform to the legacy Prometheus\ncharacter set.\n\nIt requires Prometheus \u003e= v3.4.0.", "enum": [ "AllowUTF8", "Underscores", "Dots", "Values" ], "type": [ "string", "null" ] }, "nameValidationScheme": { "description": "Specifies the validation scheme for metric and label names.\n\nIt requires Prometheus \u003e= v2.55.0.", "enum": [ "UTF8", "Legacy" ], "type": [ "string", "null" ] }, "nodeSelector": { "additionalProperties": { "type": "string" }, "description": "Defines on which Nodes the Pods are scheduled.", "type": [ "object", "null" ] }, "otlp": { "additionalProperties": false, "description": "Settings related to the OTLP receiver feature.\nIt requires Prometheus \u003e= v2.55.0.", "properties": { "convertHistogramsToNHCB": { "description": "Configures optional translation of OTLP explicit bucket histograms into native histograms with custom buckets.\nIt requires Prometheus \u003e= v3.4.0.", "type": [ "boolean", "null" ] }, "ignoreResourceAttributes": { "description": "List of OpenTelemetry resource attributes to ignore when `promoteAllResourceAttributes` is true.\n\nIt requires `promoteAllResourceAttributes` to be true.\nIt requires Prometheus \u003e= v3.5.0.", "items": { "minLength": 1, "type": "string" }, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "keepIdentifyingResourceAttributes": { "description": "Enables adding `service.name`, `service.namespace` and `service.instance.id`\nresource attributes to the `target_info` metric, on top of converting them into the `instance` and `job` labels.\n\nIt requires Prometheus \u003e= v3.1.0.", "type": [ "boolean", "null" ] }, "promoteAllResourceAttributes": { "description": "Promote all resource attributes to metric labels except the ones defined in `ignoreResourceAttributes`.\n\nCannot be true when `promoteResourceAttributes` is defined.\nIt requires Prometheus \u003e= v3.5.0.", "type": [ "boolean", "null" ] }, "promoteResourceAttributes": { "description": "List of OpenTelemetry Attributes that should be promoted to metric labels, defaults to none.\nCannot be defined when `promoteAllResourceAttributes` is true.", "items": { "minLength": 1, "type": "string" }, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "translationStrategy": { "description": "Configures how the OTLP receiver endpoint translates the incoming metrics.\n\nIt requires Prometheus \u003e= v3.0.0.", "enum": [ "NoUTF8EscapingWithSuffixes", "UnderscoreEscapingWithSuffixes", "NoTranslation" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "overrideHonorLabels": { "description": "When true, Prometheus resolves label conflicts by renaming the labels in the scraped data\n to “exported_” for all targets created from ServiceMonitor, PodMonitor and\nScrapeConfig objects. Otherwise the HonorLabels field of the service or pod monitor applies.\nIn practice,`overrideHonorLaels:true` enforces `honorLabels:false`\nfor all ServiceMonitor, PodMonitor and ScrapeConfig objects.", "type": [ "boolean", "null" ] }, "overrideHonorTimestamps": { "description": "When true, Prometheus ignores the timestamps for all the targets created\nfrom service and pod monitors.\nOtherwise the HonorTimestamps field of the service or pod monitor applies.", "type": [ "boolean", "null" ] }, "paused": { "description": "When a Prometheus deployment is paused, no actions except for deletion\nwill be performed on the underlying objects.", "type": [ "boolean", "null" ] }, "persistentVolumeClaimRetentionPolicy": { "additionalProperties": false, "description": "The field controls if and how PVCs are deleted during the lifecycle of a StatefulSet.\nThe default behavior is all PVCs are retained.\nThis is an alpha field from kubernetes 1.23 until 1.26 and a beta field from 1.26.\nIt requires enabling the StatefulSetAutoDeletePVC feature gate.", "properties": { "whenDeleted": { "description": "WhenDeleted specifies what happens to PVCs created from StatefulSet\nVolumeClaimTemplates when the StatefulSet is deleted. The default policy\nof `Retain` causes PVCs to not be affected by StatefulSet deletion. The\n`Delete` policy causes those PVCs to be deleted.", "type": [ "string", "null" ] }, "whenScaled": { "description": "WhenScaled specifies what happens to PVCs created from StatefulSet\nVolumeClaimTemplates when the StatefulSet is scaled down. The default\npolicy of `Retain` causes PVCs to not be affected by a scaledown. The\n`Delete` policy causes the associated PVCs for any excess pods above\nthe replica count to be deleted.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "podMetadata": { "additionalProperties": false, "description": "PodMetadata configures labels and annotations which are propagated to the Prometheus pods.\n\nThe following items are reserved and cannot be overridden:\n* \"prometheus\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/instance\" label, set to the name of the Prometheus object.\n* \"app.kubernetes.io/managed-by\" label, set to \"prometheus-operator\".\n* \"app.kubernetes.io/name\" label, set to \"prometheus\".\n* \"app.kubernetes.io/version\" label, set to the Prometheus version.\n* \"operator.prometheus.io/name\" label, set to the name of the Prometheus object.\n* \"operator.prometheus.io/shard\" label, set to the shard number of the Prometheus object.\n* \"kubectl.kubernetes.io/default-container\" annotation, set to \"prometheus\".", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", "type": [ "object", "null" ] }, "labels": { "additionalProperties": { "type": "string" }, "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "type": [ "object", "null" ] }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "podMonitorNamespaceSelector": { "additionalProperties": false, "description": "Namespaces to match for PodMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "podMonitorSelector": { "additionalProperties": false, "description": "PodMonitors to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "podTargetLabels": { "description": "PodTargetLabels are appended to the `spec.podTargetLabels` field of all\nPodMonitor and ServiceMonitor objects.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "portName": { "default": "web", "description": "Port name used for the pods and governing service.\nDefault: \"web\"", "type": [ "string", "null" ] }, "priorityClassName": { "description": "Priority class assigned to the Pods.", "type": [ "string", "null" ] }, "probeNamespaceSelector": { "additionalProperties": false, "description": "Namespaces to match for Probe discovery. An empty label\nselector matches all namespaces. A null label selector matches the\ncurrent namespace only.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "probeSelector": { "additionalProperties": false, "description": "Probes to be selected for target discovery. An empty label selector\nmatches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "prometheusExternalLabelName": { "description": "Name of Prometheus external label used to denote the Prometheus instance\nname. The external label will _not_ be added when the field is set to\nthe empty string (`\"\"`).\n\nDefault: \"prometheus\"", "type": [ "string", "null" ] }, "prometheusRulesExcludedFromEnforce": { "description": "Defines the list of PrometheusRule objects to which the namespace label\nenforcement doesn't apply.\nThis is only relevant when `spec.enforcedNamespaceLabel` is set to true.\nDeprecated: use `spec.excludedFromEnforcement` instead.", "items": { "additionalProperties": false, "description": "PrometheusRuleExcludeConfig enables users to configure excluded\nPrometheusRule names and their namespaces to be ignored while enforcing\nnamespace label for alerts and metrics.", "properties": { "ruleName": { "description": "Name of the excluded PrometheusRule object.", "type": "string" }, "ruleNamespace": { "description": "Namespace of the excluded PrometheusRule object.", "type": "string" } }, "required": [ "ruleName", "ruleNamespace" ], "type": "object" }, "type": [ "array", "null" ] }, "query": { "additionalProperties": false, "description": "QuerySpec defines the configuration of the Promethus query service.", "properties": { "lookbackDelta": { "description": "The delta difference allowed for retrieving metrics during expression evaluations.", "type": [ "string", "null" ] }, "maxConcurrency": { "description": "Number of concurrent queries that can be run at once.", "format": "int32", "minimum": 1, "type": [ "integer", "null" ] }, "maxSamples": { "description": "Maximum number of samples a single query can load into memory. Note that\nqueries will fail if they would load more samples than this into memory,\nso this also limits the number of samples a query can return.", "format": "int32", "type": [ "integer", "null" ] }, "timeout": { "description": "Maximum time a query may take before being aborted.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "queryLogFile": { "description": "queryLogFile specifies where the file to which PromQL queries are logged.\n\nIf the filename has an empty path, e.g. 'query.log', The Prometheus Pods\nwill mount the file into an emptyDir volume at `/var/log/prometheus`.\nIf a full path is provided, e.g. '/var/log/prometheus/query.log', you\nmust mount a volume in the specified directory and it must be writable.\nThis is because the prometheus container runs with a read-only root\nfilesystem for security reasons.\nAlternatively, the location can be set to a standard I/O stream, e.g.\n`/dev/stdout`, to log query information to the default Prometheus log\nstream.", "type": [ "string", "null" ] }, "reloadStrategy": { "description": "Defines the strategy used to reload the Prometheus configuration.\nIf not specified, the configuration is reloaded using the /-/reload HTTP endpoint.", "enum": [ "HTTP", "ProcessSignal" ], "type": [ "string", "null" ] }, "remoteRead": { "description": "Defines the list of remote read configurations.", "items": { "additionalProperties": false, "description": "RemoteReadSpec defines the configuration for Prometheus to read back samples\nfrom a remote endpoint.", "properties": { "authorization": { "additionalProperties": false, "description": "Authorization section for the URL.\n\nIt requires Prometheus \u003e= v2.26.0.\n\nCannot be set at the same time as `basicAuth`, or `oauth2`.", "properties": { "credentials": { "additionalProperties": false, "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "credentialsFile": { "description": "File to read a secret from, mutually exclusive with `credentials`.", "type": [ "string", "null" ] }, "type": { "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "basicAuth": { "additionalProperties": false, "description": "BasicAuth configuration for the URL.\n\nCannot be set at the same time as `authorization`, or `oauth2`.", "properties": { "password": { "additionalProperties": false, "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "username": { "additionalProperties": false, "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "bearerToken": { "description": "*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\nDeprecated: this will be removed in a future release.", "type": [ "string", "null" ] }, "bearerTokenFile": { "description": "File from which to read the bearer token for the URL.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", "type": [ "string", "null" ] }, "filterExternalLabels": { "description": "Whether to use the external labels as selectors for the remote read endpoint.\n\nIt requires Prometheus \u003e= v2.34.0.", "type": [ "boolean", "null" ] }, "followRedirects": { "description": "Configure whether HTTP requests follow HTTP 3xx redirects.\n\nIt requires Prometheus \u003e= v2.26.0.", "type": [ "boolean", "null" ] }, "headers": { "additionalProperties": { "type": "string" }, "description": "Custom HTTP headers to be sent along with each remote read request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\nOnly valid in Prometheus versions 2.26.0 and newer.", "type": [ "object", "null" ] }, "name": { "description": "The name of the remote read queue, it must be unique if specified. The\nname is used in metrics and logging in order to differentiate read\nconfigurations.\n\nIt requires Prometheus \u003e= v2.15.0.", "type": [ "string", "null" ] }, "noProxy": { "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "string", "null" ] }, "oauth2": { "additionalProperties": false, "description": "OAuth2 configuration for the URL.\n\nIt requires Prometheus \u003e= v2.27.0.\n\nCannot be set at the same time as `authorization`, or `basicAuth`.", "properties": { "clientId": { "additionalProperties": false, "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": "object" }, "clientSecret": { "additionalProperties": false, "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic" }, "endpointParams": { "additionalProperties": { "type": "string" }, "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", "type": [ "object", "null" ] }, "noProxy": { "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "string", "null" ] }, "proxyConnectHeader": { "additionalProperties": { "items": { "additionalProperties": false, "description": "SecretKeySelector selects a key of a Secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic" }, "type": "array" }, "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "boolean", "null" ] }, "proxyUrl": { "description": "`proxyURL` defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": [ "string", "null" ] }, "scopes": { "description": "`scopes` defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "tlsConfig": { "additionalProperties": false, "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus \u003e= v2.43.0.", "properties": { "ca": { "additionalProperties": false, "description": "Certificate authority used when verifying server certificates.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "cert": { "additionalProperties": false, "description": "Client certificate to present when doing client-authentication.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "insecureSkipVerify": { "description": "Disable target certificate validation.", "type": [ "boolean", "null" ] }, "keySecret": { "additionalProperties": false, "description": "Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "maxVersion": { "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.41.0 or Thanos \u003e= v0.31.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "minVersion": { "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.35.0 or Thanos \u003e= v0.28.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "serverName": { "description": "Used to verify the hostname for the targets.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tokenUrl": { "description": "`tokenURL` configures the URL to fetch the token from.", "minLength": 1, "type": "string" } }, "required": [ "clientId", "clientSecret", "tokenUrl" ], "type": [ "object", "null" ] }, "proxyConnectHeader": { "additionalProperties": { "items": { "additionalProperties": false, "description": "SecretKeySelector selects a key of a Secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic" }, "type": "array" }, "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "boolean", "null" ] }, "proxyUrl": { "description": "`proxyURL` defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": [ "string", "null" ] }, "readRecent": { "description": "Whether reads should be made for queries for time ranges that\nthe local storage should have complete data for.", "type": [ "boolean", "null" ] }, "remoteTimeout": { "description": "Timeout for requests to the remote read endpoint.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "requiredMatchers": { "additionalProperties": { "type": "string" }, "description": "An optional list of equality matchers which have to be present\nin a selector to query the remote read endpoint.", "type": [ "object", "null" ] }, "tlsConfig": { "additionalProperties": false, "description": "TLS Config to use for the URL.", "properties": { "ca": { "additionalProperties": false, "description": "Certificate authority used when verifying server certificates.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "caFile": { "description": "Path to the CA cert in the Prometheus container to use for the targets.", "type": [ "string", "null" ] }, "cert": { "additionalProperties": false, "description": "Client certificate to present when doing client-authentication.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "certFile": { "description": "Path to the client cert file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "insecureSkipVerify": { "description": "Disable target certificate validation.", "type": [ "boolean", "null" ] }, "keyFile": { "description": "Path to the client key file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "keySecret": { "additionalProperties": false, "description": "Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "maxVersion": { "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.41.0 or Thanos \u003e= v0.31.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "minVersion": { "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.35.0 or Thanos \u003e= v0.28.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "serverName": { "description": "Used to verify the hostname for the targets.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "url": { "description": "The URL of the endpoint to query from.", "type": "string" } }, "required": [ "url" ], "type": "object" }, "type": [ "array", "null" ] }, "remoteWrite": { "description": "Defines the list of remote write configurations.", "items": { "additionalProperties": false, "description": "RemoteWriteSpec defines the configuration to write samples from Prometheus\nto a remote endpoint.", "properties": { "authorization": { "additionalProperties": false, "description": "Authorization section for the URL.\n\nIt requires Prometheus \u003e= v2.26.0 or Thanos \u003e= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`.", "properties": { "credentials": { "additionalProperties": false, "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "credentialsFile": { "description": "File to read a secret from, mutually exclusive with `credentials`.", "type": [ "string", "null" ] }, "type": { "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "azureAd": { "additionalProperties": false, "description": "AzureAD for the URL.\n\nIt requires Prometheus \u003e= v2.45.0 or Thanos \u003e= v0.31.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`.", "properties": { "cloud": { "description": "The Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'.", "enum": [ "AzureChina", "AzureGovernment", "AzurePublic" ], "type": [ "string", "null" ] }, "managedIdentity": { "additionalProperties": false, "description": "ManagedIdentity defines the Azure User-assigned Managed identity.\nCannot be set at the same time as `oauth` or `sdk`.", "properties": { "clientId": { "description": "The client id", "type": "string" } }, "required": [ "clientId" ], "type": [ "object", "null" ] }, "oauth": { "additionalProperties": false, "description": "OAuth defines the oauth config that is being used to authenticate.\nCannot be set at the same time as `managedIdentity` or `sdk`.\n\nIt requires Prometheus \u003e= v2.48.0 or Thanos \u003e= v0.31.0.", "properties": { "clientId": { "description": "`clientID` is the clientId of the Azure Active Directory application that is being used to authenticate.", "minLength": 1, "type": "string" }, "clientSecret": { "additionalProperties": false, "description": "`clientSecret` specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic" }, "tenantId": { "description": "`tenantId` is the tenant ID of the Azure Active Directory application that is being used to authenticate.", "minLength": 1, "pattern": "^[0-9a-zA-Z-.]+$", "type": "string" } }, "required": [ "clientId", "clientSecret", "tenantId" ], "type": [ "object", "null" ] }, "sdk": { "additionalProperties": false, "description": "SDK defines the Azure SDK config that is being used to authenticate.\nSee https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication\nCannot be set at the same time as `oauth` or `managedIdentity`.\n\nIt requires Prometheus \u003e= v2.52.0 or Thanos \u003e= v0.36.0.", "properties": { "tenantId": { "description": "`tenantId` is the tenant ID of the azure active directory application that is being used to authenticate.", "pattern": "^[0-9a-zA-Z-.]+$", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "basicAuth": { "additionalProperties": false, "description": "BasicAuth configuration for the URL.\n\nCannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`.", "properties": { "password": { "additionalProperties": false, "description": "`password` specifies a key of a Secret containing the password for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "username": { "additionalProperties": false, "description": "`username` specifies a key of a Secret containing the username for\nauthentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "bearerToken": { "description": "*Warning: this field shouldn't be used because the token value appears\nin clear-text. Prefer using `authorization`.*\n\nDeprecated: this will be removed in a future release.", "type": [ "string", "null" ] }, "bearerTokenFile": { "description": "File from which to read bearer token for the URL.\n\nDeprecated: this will be removed in a future release. Prefer using `authorization`.", "type": [ "string", "null" ] }, "enableHTTP2": { "description": "Whether to enable HTTP2.", "type": [ "boolean", "null" ] }, "followRedirects": { "description": "Configure whether HTTP requests follow HTTP 3xx redirects.\n\nIt requires Prometheus \u003e= v2.26.0 or Thanos \u003e= v0.24.0.", "type": [ "boolean", "null" ] }, "headers": { "additionalProperties": { "type": "string" }, "description": "Custom HTTP headers to be sent along with each remote write request.\nBe aware that headers that are set by Prometheus itself can't be overwritten.\n\nIt requires Prometheus \u003e= v2.25.0 or Thanos \u003e= v0.24.0.", "type": [ "object", "null" ] }, "messageVersion": { "description": "The Remote Write message's version to use when writing to the endpoint.\n\n`Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0.\n`Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0.\n\nWhen `Version2.0` is selected, Prometheus will automatically be\nconfigured to append the metadata of scraped metrics to the WAL.\n\nBefore setting this field, consult with your remote storage provider\nwhat message version it supports.\n\nIt requires Prometheus \u003e= v2.54.0 or Thanos \u003e= v0.37.0.", "enum": [ "V1.0", "V2.0" ], "type": [ "string", "null" ] }, "metadataConfig": { "additionalProperties": false, "description": "MetadataConfig configures the sending of series metadata to the remote storage.", "properties": { "maxSamplesPerSend": { "description": "MaxSamplesPerSend is the maximum number of metadata samples per send.\n\nIt requires Prometheus \u003e= v2.29.0.", "format": "int32", "minimum": -1, "type": [ "integer", "null" ] }, "send": { "description": "Defines whether metric metadata is sent to the remote storage or not.", "type": [ "boolean", "null" ] }, "sendInterval": { "description": "Defines how frequently metric metadata is sent to the remote storage.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "name": { "description": "The name of the remote write queue, it must be unique if specified. The\nname is used in metrics and logging in order to differentiate queues.\n\nIt requires Prometheus \u003e= v2.15.0 or Thanos \u003e= 0.24.0.", "type": [ "string", "null" ] }, "noProxy": { "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "string", "null" ] }, "oauth2": { "additionalProperties": false, "description": "OAuth2 configuration for the URL.\n\nIt requires Prometheus \u003e= v2.27.0 or Thanos \u003e= v0.24.0.\n\nCannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`.", "properties": { "clientId": { "additionalProperties": false, "description": "`clientId` specifies a key of a Secret or ConfigMap containing the\nOAuth2 client's ID.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": "object" }, "clientSecret": { "additionalProperties": false, "description": "`clientSecret` specifies a key of a Secret containing the OAuth2\nclient's secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic" }, "endpointParams": { "additionalProperties": { "type": "string" }, "description": "`endpointParams` configures the HTTP parameters to append to the token\nURL.", "type": [ "object", "null" ] }, "noProxy": { "description": "`noProxy` is a comma-separated string that can contain IPs, CIDR notation, domain names\nthat should be excluded from proxying. IP and domain names can\ncontain port numbers.\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "string", "null" ] }, "proxyConnectHeader": { "additionalProperties": { "items": { "additionalProperties": false, "description": "SecretKeySelector selects a key of a Secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic" }, "type": "array" }, "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "boolean", "null" ] }, "proxyUrl": { "description": "`proxyURL` defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": [ "string", "null" ] }, "scopes": { "description": "`scopes` defines the OAuth2 scopes used for the token request.", "items": { "type": "string" }, "type": [ "array", "null" ] }, "tlsConfig": { "additionalProperties": false, "description": "TLS configuration to use when connecting to the OAuth2 server.\nIt requires Prometheus \u003e= v2.43.0.", "properties": { "ca": { "additionalProperties": false, "description": "Certificate authority used when verifying server certificates.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "cert": { "additionalProperties": false, "description": "Client certificate to present when doing client-authentication.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "insecureSkipVerify": { "description": "Disable target certificate validation.", "type": [ "boolean", "null" ] }, "keySecret": { "additionalProperties": false, "description": "Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "maxVersion": { "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.41.0 or Thanos \u003e= v0.31.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "minVersion": { "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.35.0 or Thanos \u003e= v0.28.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "serverName": { "description": "Used to verify the hostname for the targets.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "tokenUrl": { "description": "`tokenURL` configures the URL to fetch the token from.", "minLength": 1, "type": "string" } }, "required": [ "clientId", "clientSecret", "tokenUrl" ], "type": [ "object", "null" ] }, "proxyConnectHeader": { "additionalProperties": { "items": { "additionalProperties": false, "description": "SecretKeySelector selects a key of a Secret.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": "object", "x-kubernetes-map-type": "atomic" }, "type": "array" }, "description": "ProxyConnectHeader optionally specifies headers to send to\nproxies during CONNECT requests.\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "proxyFromEnvironment": { "description": "Whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).\n\nIt requires Prometheus \u003e= v2.43.0, Alertmanager \u003e= v0.25.0 or Thanos \u003e= v0.32.0.", "type": [ "boolean", "null" ] }, "proxyUrl": { "description": "`proxyURL` defines the HTTP proxy server to use.", "pattern": "^(http|https|socks5)://.+$", "type": [ "string", "null" ] }, "queueConfig": { "additionalProperties": false, "description": "QueueConfig allows tuning of the remote write queue parameters.", "properties": { "batchSendDeadline": { "description": "BatchSendDeadline is the maximum time a sample will wait in buffer.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "capacity": { "description": "Capacity is the number of samples to buffer per shard before we start\ndropping them.", "type": [ "integer", "null" ] }, "maxBackoff": { "description": "MaxBackoff is the maximum retry delay.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "maxRetries": { "description": "MaxRetries is the maximum number of times to retry a batch on recoverable errors.", "type": [ "integer", "null" ] }, "maxSamplesPerSend": { "description": "MaxSamplesPerSend is the maximum number of samples per send.", "type": [ "integer", "null" ] }, "maxShards": { "description": "MaxShards is the maximum number of shards, i.e. amount of concurrency.", "type": [ "integer", "null" ] }, "minBackoff": { "description": "MinBackoff is the initial retry delay. Gets doubled for every retry.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "minShards": { "description": "MinShards is the minimum number of shards, i.e. amount of concurrency.", "type": [ "integer", "null" ] }, "retryOnRateLimit": { "description": "Retry upon receiving a 429 status code from the remote-write storage.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "type": [ "boolean", "null" ] }, "sampleAgeLimit": { "description": "SampleAgeLimit drops samples older than the limit.\nIt requires Prometheus \u003e= v2.50.0 or Thanos \u003e= v0.32.0.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "remoteTimeout": { "description": "Timeout for requests to the remote write endpoint.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "roundRobinDNS": { "description": "When enabled:\n - The remote-write mechanism will resolve the hostname via DNS.\n - It will randomly select one of the resolved IP addresses and connect to it.\n\nWhen disabled (default behavior):\n - The Go standard library will handle hostname resolution.\n - It will attempt connections to each resolved IP address sequentially.\n\nNote: The connection timeout applies to the entire resolution and connection process.\n If disabled, the timeout is distributed across all connection attempts.\n\nIt requires Prometheus \u003e= v3.1.0 or Thanos \u003e= v0.38.0.", "type": [ "boolean", "null" ] }, "sendExemplars": { "description": "Enables sending of exemplars over remote write. Note that\nexemplar-storage itself must be enabled using the `spec.enableFeatures`\noption for exemplars to be scraped in the first place.\n\nIt requires Prometheus \u003e= v2.27.0 or Thanos \u003e= v0.24.0.", "type": [ "boolean", "null" ] }, "sendNativeHistograms": { "description": "Enables sending of native histograms, also known as sparse histograms\nover remote write.\n\nIt requires Prometheus \u003e= v2.40.0 or Thanos \u003e= v0.30.0.", "type": [ "boolean", "null" ] }, "sigv4": { "additionalProperties": false, "description": "Sigv4 allows to configures AWS's Signature Verification 4 for the URL.\n\nIt requires Prometheus \u003e= v2.26.0 or Thanos \u003e= v0.24.0.\n\nCannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`.", "properties": { "accessKey": { "additionalProperties": false, "description": "AccessKey is the AWS API key. If not specified, the environment variable\n`AWS_ACCESS_KEY_ID` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "profile": { "description": "Profile is the named AWS profile used to authenticate.", "type": [ "string", "null" ] }, "region": { "description": "Region is the AWS region. If blank, the region from the default credentials chain used.", "type": [ "string", "null" ] }, "roleArn": { "description": "RoleArn is the named AWS profile used to authenticate.", "type": [ "string", "null" ] }, "secretKey": { "additionalProperties": false, "description": "SecretKey is the AWS API secret. If not specified, the environment\nvariable `AWS_SECRET_ACCESS_KEY` is used.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "tlsConfig": { "additionalProperties": false, "description": "TLS Config to use for the URL.", "properties": { "ca": { "additionalProperties": false, "description": "Certificate authority used when verifying server certificates.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "caFile": { "description": "Path to the CA cert in the Prometheus container to use for the targets.", "type": [ "string", "null" ] }, "cert": { "additionalProperties": false, "description": "Client certificate to present when doing client-authentication.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "certFile": { "description": "Path to the client cert file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "insecureSkipVerify": { "description": "Disable target certificate validation.", "type": [ "boolean", "null" ] }, "keyFile": { "description": "Path to the client key file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "keySecret": { "additionalProperties": false, "description": "Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "maxVersion": { "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.41.0 or Thanos \u003e= v0.31.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "minVersion": { "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.35.0 or Thanos \u003e= v0.28.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "serverName": { "description": "Used to verify the hostname for the targets.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "url": { "description": "The URL of the endpoint to send samples to.", "minLength": 1, "type": "string" }, "writeRelabelConfigs": { "description": "The list of remote write relabel configurations.", "items": { "additionalProperties": false, "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus \u003e= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus \u003e= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", "keep", "Keep", "drop", "Drop", "hashmod", "HashMod", "labelmap", "LabelMap", "labeldrop", "LabelDrop", "labelkeep", "LabelKeep", "lowercase", "Lowercase", "uppercase", "Uppercase", "keepequal", "KeepEqual", "dropequal", "DropEqual" ], "type": [ "string", "null" ] }, "modulus": { "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": [ "integer", "null" ] }, "regex": { "description": "Regular expression against which the extracted value is matched.", "type": [ "string", "null" ] }, "replacement": { "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": [ "string", "null" ] }, "separator": { "description": "Separator is the string between concatenated SourceLabels.", "type": [ "string", "null" ] }, "sourceLabels": { "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "type": "string" }, "type": [ "array", "null" ] }, "targetLabel": { "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] } }, "required": [ "url" ], "type": "object" }, "type": [ "array", "null" ] }, "remoteWriteReceiverMessageVersions": { "description": "List of the protobuf message versions to accept when receiving the\nremote writes.\n\nIt requires Prometheus \u003e= v2.54.0.", "items": { "enum": [ "V1.0", "V2.0" ], "type": "string" }, "minItems": 1, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "replicaExternalLabelName": { "description": "Name of Prometheus external label used to denote the replica name.\nThe external label will _not_ be added when the field is set to the\nempty string (`\"\"`).\n\nDefault: \"prometheus_replica\"", "type": [ "string", "null" ] }, "replicas": { "description": "Number of replicas of each shard to deploy for a Prometheus deployment.\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\ncreated.\n\nDefault: 1", "format": "int32", "type": [ "integer", "null" ] }, "resources": { "additionalProperties": false, "description": "Defines the resources requests and limits of the 'prometheus' container.", "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.", "items": { "additionalProperties": false, "description": "ResourceClaim references one entry in PodSpec.ResourceClaims.", "properties": { "name": { "description": "Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container.", "type": "string" }, "request": { "description": "Request is the name chosen for a request in the referenced claim.\nIf empty, everything from the claim is made available, otherwise\nonly the result of this request.", "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "limits": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] }, "requests": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "retention": { "description": "How long to retain the Prometheus data.\n\nDefault: \"24h\" if `spec.retention` and `spec.retentionSize` are empty.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "retentionSize": { "description": "Maximum number of bytes used by the Prometheus data.", "pattern": "(^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$", "type": [ "string", "null" ] }, "routePrefix": { "description": "The route prefix Prometheus registers HTTP handlers for.\n\nThis is useful when using `spec.externalURL`, and a proxy is rewriting\nHTTP routes of a request, and the actual ExternalURL is still true, but\nthe server serves requests under a different route prefix. For example\nfor use with `kubectl proxy`.", "type": [ "string", "null" ] }, "ruleNamespaceSelector": { "additionalProperties": false, "description": "Namespaces to match for PrometheusRule discovery. An empty label selector\nmatches all namespaces. A null label selector matches the current\nnamespace only.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "ruleQueryOffset": { "description": "Defines the offset the rule evaluation timestamp of this particular group by the specified duration into the past.\nIt requires Prometheus \u003e= v2.53.0.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "ruleSelector": { "additionalProperties": false, "description": "PrometheusRule objects to be selected for rule evaluation. An empty\nlabel selector matches all objects. A null label selector matches no\nobjects.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "rules": { "additionalProperties": false, "description": "Defines the configuration of the Prometheus rules' engine.", "properties": { "alert": { "additionalProperties": false, "description": "Defines the parameters of the Prometheus rules' engine.\n\nAny update to these parameters trigger a restart of the pods.", "properties": { "forGracePeriod": { "description": "Minimum duration between alert and restored 'for' state.\n\nThis is maintained only for alerts with a configured 'for' time greater\nthan the grace period.", "type": [ "string", "null" ] }, "forOutageTolerance": { "description": "Max time to tolerate prometheus outage for restoring 'for' state of\nalert.", "type": [ "string", "null" ] }, "resendDelay": { "description": "Minimum amount of time to wait before resending an alert to\nAlertmanager.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "runtime": { "additionalProperties": false, "description": "RuntimeConfig configures the values for the Prometheus process behavior", "properties": { "goGC": { "description": "The Go garbage collection target percentage. Lowering this number may increase the CPU usage.\nSee: https://tip.golang.org/doc/gc-guide#GOGC", "format": "int32", "minimum": -1, "type": [ "integer", "null" ] } }, "type": [ "object", "null" ] }, "sampleLimit": { "description": "SampleLimit defines per-scrape limit on number of scraped samples that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedSampleLimit.", "format": "int64", "type": [ "integer", "null" ] }, "scrapeClasses": { "description": "List of scrape classes to expose to scraping objects such as\nPodMonitors, ServiceMonitors, Probes and ScrapeConfigs.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "items": { "additionalProperties": false, "properties": { "attachMetadata": { "additionalProperties": false, "description": "AttachMetadata configures additional metadata to the discovered targets.\nWhen the scrape object defines its own configuration, it takes\nprecedence over the scrape class configuration.", "properties": { "node": { "description": "When set to true, Prometheus attaches node metadata to the discovered\ntargets.\n\nThe Prometheus service account must have the `list` and `watch`\npermissions on the `Nodes` objects.", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] }, "authorization": { "additionalProperties": false, "description": "Authorization section for the ScrapeClass.\nIt will only apply if the scrape resource doesn't specify any Authorization.", "properties": { "credentials": { "additionalProperties": false, "description": "Selects a key of a Secret in the namespace that contains the credentials for authentication.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "credentialsFile": { "description": "File to read a secret from, mutually exclusive with `credentials`.", "type": [ "string", "null" ] }, "type": { "description": "Defines the authentication type. The value is case-insensitive.\n\n\"Basic\" is not a supported value.\n\nDefault: \"Bearer\"", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "default": { "description": "Default indicates that the scrape applies to all scrape objects that\ndon't configure an explicit scrape class name.\n\nOnly one scrape class can be set as the default.", "type": [ "boolean", "null" ] }, "fallbackScrapeProtocol": { "description": "The protocol to use if a scrape returns blank, unparseable, or otherwise invalid Content-Type.\nIt will only apply if the scrape resource doesn't specify any FallbackScrapeProtocol\n\nIt requires Prometheus \u003e= v3.0.0.", "enum": [ "PrometheusProto", "OpenMetricsText0.0.1", "OpenMetricsText1.0.0", "PrometheusText0.0.4", "PrometheusText1.0.0" ], "type": [ "string", "null" ] }, "metricRelabelings": { "description": "MetricRelabelings configures the relabeling rules to apply to all samples before ingestion.\n\nThe Operator adds the scrape class metric relabelings defined here.\nThen the Operator adds the target-specific metric relabelings defined in ServiceMonitors, PodMonitors, Probes and ScrapeConfigs.\nThen the Operator adds namespace enforcement relabeling rule, specified in '.spec.enforcedNamespaceLabel'.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#metric_relabel_configs", "items": { "additionalProperties": false, "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus \u003e= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus \u003e= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", "keep", "Keep", "drop", "Drop", "hashmod", "HashMod", "labelmap", "LabelMap", "labeldrop", "LabelDrop", "labelkeep", "LabelKeep", "lowercase", "Lowercase", "uppercase", "Uppercase", "keepequal", "KeepEqual", "dropequal", "DropEqual" ], "type": [ "string", "null" ] }, "modulus": { "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": [ "integer", "null" ] }, "regex": { "description": "Regular expression against which the extracted value is matched.", "type": [ "string", "null" ] }, "replacement": { "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": [ "string", "null" ] }, "separator": { "description": "Separator is the string between concatenated SourceLabels.", "type": [ "string", "null" ] }, "sourceLabels": { "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "type": "string" }, "type": [ "array", "null" ] }, "targetLabel": { "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "name": { "description": "Name of the scrape class.", "minLength": 1, "type": "string" }, "relabelings": { "description": "Relabelings configures the relabeling rules to apply to all scrape targets.\n\nThe Operator automatically adds relabelings for a few standard Kubernetes fields\nlike `__meta_kubernetes_namespace` and `__meta_kubernetes_service_name`.\nThen the Operator adds the scrape class relabelings defined here.\nThen the Operator adds the target-specific relabelings defined in the scrape object.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "items": { "additionalProperties": false, "description": "RelabelConfig allows dynamic rewriting of the label set for targets, alerts,\nscraped samples and remote write samples.\n\nMore info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config", "properties": { "action": { "default": "replace", "description": "Action to perform based on the regex matching.\n\n`Uppercase` and `Lowercase` actions require Prometheus \u003e= v2.36.0.\n`DropEqual` and `KeepEqual` actions require Prometheus \u003e= v2.41.0.\n\nDefault: \"Replace\"", "enum": [ "replace", "Replace", "keep", "Keep", "drop", "Drop", "hashmod", "HashMod", "labelmap", "LabelMap", "labeldrop", "LabelDrop", "labelkeep", "LabelKeep", "lowercase", "Lowercase", "uppercase", "Uppercase", "keepequal", "KeepEqual", "dropequal", "DropEqual" ], "type": [ "string", "null" ] }, "modulus": { "description": "Modulus to take of the hash of the source label values.\n\nOnly applicable when the action is `HashMod`.", "format": "int64", "type": [ "integer", "null" ] }, "regex": { "description": "Regular expression against which the extracted value is matched.", "type": [ "string", "null" ] }, "replacement": { "description": "Replacement value against which a Replace action is performed if the\nregular expression matches.\n\nRegex capture groups are available.", "type": [ "string", "null" ] }, "separator": { "description": "Separator is the string between concatenated SourceLabels.", "type": [ "string", "null" ] }, "sourceLabels": { "description": "The source labels select values from existing labels. Their content is\nconcatenated using the configured Separator and matched against the\nconfigured regular expression.", "items": { "description": "LabelName is a valid Prometheus label name which may only contain ASCII\nletters, numbers, as well as underscores.", "pattern": "^[a-zA-Z_][a-zA-Z0-9_]*$", "type": "string" }, "type": [ "array", "null" ] }, "targetLabel": { "description": "Label to which the resulting string is written in a replacement.\n\nIt is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,\n`KeepEqual` and `DropEqual` actions.\n\nRegex capture groups are available.", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "tlsConfig": { "additionalProperties": false, "description": "TLSConfig defines the TLS settings to use for the scrape. When the\nscrape objects define their own CA, certificate and/or key, they take\nprecedence over the corresponding scrape class fields.\n\nFor now only the `caFile`, `certFile` and `keyFile` fields are supported.", "properties": { "ca": { "additionalProperties": false, "description": "Certificate authority used when verifying server certificates.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "caFile": { "description": "Path to the CA cert in the Prometheus container to use for the targets.", "type": [ "string", "null" ] }, "cert": { "additionalProperties": false, "description": "Client certificate to present when doing client-authentication.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "certFile": { "description": "Path to the client cert file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "insecureSkipVerify": { "description": "Disable target certificate validation.", "type": [ "boolean", "null" ] }, "keyFile": { "description": "Path to the client key file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "keySecret": { "additionalProperties": false, "description": "Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "maxVersion": { "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.41.0 or Thanos \u003e= v0.31.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "minVersion": { "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.35.0 or Thanos \u003e= v0.28.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "serverName": { "description": "Used to verify the hostname for the targets.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "scrapeClassicHistograms": { "description": "Whether to scrape a classic histogram that is also exposed as a native histogram.\n\nNotice: `scrapeClassicHistograms` corresponds to the `always_scrape_classic_histograms` field in the Prometheus configuration.\n\nIt requires Prometheus \u003e= v3.5.0.", "type": [ "boolean", "null" ] }, "scrapeConfigNamespaceSelector": { "additionalProperties": false, "description": "Namespaces to match for ScrapeConfig discovery. An empty label selector\nmatches all namespaces. A null label selector matches the current\nnamespace only.\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "scrapeConfigSelector": { "additionalProperties": false, "description": "ScrapeConfigs to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.\n\nNote that the ScrapeConfig custom resource definition is currently at Alpha level.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "scrapeFailureLogFile": { "description": "File to which scrape failures are logged.\nReloading the configuration will reopen the file.\n\nIf the filename has an empty path, e.g. 'file.log', The Prometheus Pods\nwill mount the file into an emptyDir volume at `/var/log/prometheus`.\nIf a full path is provided, e.g. '/var/log/prometheus/file.log', you\nmust mount a volume in the specified directory and it must be writable.\nIt requires Prometheus \u003e= v2.55.0.", "minLength": 1, "type": [ "string", "null" ] }, "scrapeInterval": { "default": "30s", "description": "Interval between consecutive scrapes.\n\nDefault: \"30s\"", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "scrapeProtocols": { "description": "The protocols to negotiate during a scrape. It tells clients the\nprotocols supported by Prometheus in order of preference (from most to least preferred).\n\nIf unset, Prometheus uses its default value.\n\nIt requires Prometheus \u003e= v2.49.0.\n\n`PrometheusText1.0.0` requires Prometheus \u003e= v3.0.0.", "items": { "description": "ScrapeProtocol represents a protocol used by Prometheus for scraping metrics.\nSupported values are:\n* `OpenMetricsText0.0.1`\n* `OpenMetricsText1.0.0`\n* `PrometheusProto`\n* `PrometheusText0.0.4`\n* `PrometheusText1.0.0`", "enum": [ "PrometheusProto", "OpenMetricsText0.0.1", "OpenMetricsText1.0.0", "PrometheusText0.0.4", "PrometheusText1.0.0" ], "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "scrapeTimeout": { "description": "Number of seconds to wait until a scrape request times out.\nThe value cannot be greater than the scrape interval otherwise the operator will reject the resource.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "secrets": { "description": "Secrets is a list of Secrets in the same namespace as the Prometheus\nobject, which shall be mounted into the Prometheus Pods.\nEach Secret is added to the StatefulSet definition as a volume named `secret-\u003csecret-name\u003e`.\nThe Secrets are mounted into /etc/prometheus/secrets/\u003csecret-name\u003e in the 'prometheus' container.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "set" }, "securityContext": { "additionalProperties": false, "description": "SecurityContext holds pod-level security attributes and common container settings.\nThis defaults to the default PodSecurityContext.", "properties": { "appArmorProfile": { "additionalProperties": false, "description": "appArmorProfile is the AppArmor options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile loaded on the node that should be used.\nThe profile must be preconfigured on the node to work.\nMust match the loaded name of the profile.\nMust be set if and only if type is \"Localhost\".", "type": [ "string", "null" ] }, "type": { "description": "type indicates which kind of AppArmor profile will be applied.\nValid options are:\n Localhost - a profile pre-loaded on the node.\n RuntimeDefault - the container runtime's default profile.\n Unconfined - no AppArmor enforcement.", "type": "string" } }, "required": [ "type" ], "type": [ "object", "null" ] }, "fsGroup": { "description": "A special supplemental group that applies to all containers in a pod.\nSome volume types allow the Kubelet to change the ownership of that volume\nto be owned by the pod:\n\n1. The owning GID will be the FSGroup\n2. The setgid bit is set (new files created in the volume will be owned by FSGroup)\n3. The permission bits are OR'd with rw-rw----\n\nIf unset, the Kubelet will not modify the ownership and permissions of any volume.\nNote that this field cannot be set when spec.os.name is windows.", "format": "int64", "type": [ "integer", "null" ] }, "fsGroupChangePolicy": { "description": "fsGroupChangePolicy defines behavior of changing ownership and permission of the volume\nbefore being exposed inside Pod. This field will only apply to\nvolume types which support fsGroup based ownership(and permissions).\nIt will have no effect on ephemeral volume types such as: secret, configmaps\nand emptydir.\nValid values are \"OnRootMismatch\" and \"Always\". If not specified, \"Always\" is used.\nNote that this field cannot be set when spec.os.name is windows.", "type": [ "string", "null" ] }, "runAsGroup": { "description": "The GID to run the entrypoint of the container process.\nUses runtime default if unset.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows.", "format": "int64", "type": [ "integer", "null" ] }, "runAsNonRoot": { "description": "Indicates that the container must run as a non-root user.\nIf true, the Kubelet will validate the image at runtime to ensure that it\ndoes not run as UID 0 (root) and fail to start the container if it does.\nIf unset or false, no such validation will be performed.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.", "type": [ "boolean", "null" ] }, "runAsUser": { "description": "The UID to run the entrypoint of the container process.\nDefaults to user specified in image metadata if unspecified.\nMay also be set in SecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence\nfor that container.\nNote that this field cannot be set when spec.os.name is windows.", "format": "int64", "type": [ "integer", "null" ] }, "seLinuxChangePolicy": { "description": "seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod.\nIt has no effect on nodes that do not support SELinux or to volumes does not support SELinux.\nValid values are \"MountOption\" and \"Recursive\".\n\n\"Recursive\" means relabeling of all files on all Pod volumes by the container runtime.\nThis may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.\n\n\"MountOption\" mounts all eligible Pod volumes with `-o context` mount option.\nThis requires all Pods that share the same volume to use the same SELinux label.\nIt is not possible to share the same volume among privileged and unprivileged Pods.\nEligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes\nwhose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their\nCSIDriver instance. Other volumes are always re-labelled recursively.\n\"MountOption\" value is allowed only when SELinuxMount feature gate is enabled.\n\nIf not specified and SELinuxMount feature gate is enabled, \"MountOption\" is used.\nIf not specified and SELinuxMount feature gate is disabled, \"MountOption\" is used for ReadWriteOncePod volumes\nand \"Recursive\" for all other volumes.\n\nThis field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.\n\nAll Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state.\nNote that this field cannot be set when spec.os.name is windows.", "type": [ "string", "null" ] }, "seLinuxOptions": { "additionalProperties": false, "description": "The SELinux context to be applied to all containers.\nIf unspecified, the container runtime will allocate a random SELinux context for each\ncontainer. May also be set in SecurityContext. If set in\nboth SecurityContext and PodSecurityContext, the value specified in SecurityContext\ntakes precedence for that container.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "level": { "description": "Level is SELinux level label that applies to the container.", "type": [ "string", "null" ] }, "role": { "description": "Role is a SELinux role label that applies to the container.", "type": [ "string", "null" ] }, "type": { "description": "Type is a SELinux type label that applies to the container.", "type": [ "string", "null" ] }, "user": { "description": "User is a SELinux user label that applies to the container.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "seccompProfile": { "additionalProperties": false, "description": "The seccomp options to use by the containers in this pod.\nNote that this field cannot be set when spec.os.name is windows.", "properties": { "localhostProfile": { "description": "localhostProfile indicates a profile defined in a file on the node should be used.\nThe profile must be preconfigured on the node to work.\nMust be a descending path, relative to the kubelet's configured seccomp profile location.\nMust be set if type is \"Localhost\". Must NOT be set for any other type.", "type": [ "string", "null" ] }, "type": { "description": "type indicates which kind of seccomp profile will be applied.\nValid options are:\n\nLocalhost - a profile defined in a file on the node should be used.\nRuntimeDefault - the container runtime default profile should be used.\nUnconfined - no profile should be applied.", "type": "string" } }, "required": [ "type" ], "type": [ "object", "null" ] }, "supplementalGroups": { "description": "A list of groups applied to the first process run in each container, in\naddition to the container's primary GID and fsGroup (if specified). If\nthe SupplementalGroupsPolicy feature is enabled, the\nsupplementalGroupsPolicy field determines whether these are in addition\nto or instead of any group memberships defined in the container image.\nIf unspecified, no additional groups are added, though group memberships\ndefined in the container image may still be used, depending on the\nsupplementalGroupsPolicy field.\nNote that this field cannot be set when spec.os.name is windows.", "items": { "format": "int64", "type": "integer" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "supplementalGroupsPolicy": { "description": "Defines how supplemental groups of the first container processes are calculated.\nValid values are \"Merge\" and \"Strict\". If not specified, \"Merge\" is used.\n(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled\nand the container runtime must implement support for this feature.\nNote that this field cannot be set when spec.os.name is windows.", "type": [ "string", "null" ] }, "sysctls": { "description": "Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported\nsysctls (by the container runtime) might fail to launch.\nNote that this field cannot be set when spec.os.name is windows.", "items": { "additionalProperties": false, "description": "Sysctl defines a kernel parameter to be set", "properties": { "name": { "description": "Name of a property to set", "type": "string" }, "value": { "description": "Value of a property to set", "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "windowsOptions": { "additionalProperties": false, "description": "The Windows specific settings applied to all containers.\nIf unspecified, the options within a container's SecurityContext will be used.\nIf set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.\nNote that this field cannot be set when spec.os.name is linux.", "properties": { "gmsaCredentialSpec": { "description": "GMSACredentialSpec is where the GMSA admission webhook\n(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the\nGMSA credential spec named by the GMSACredentialSpecName field.", "type": [ "string", "null" ] }, "gmsaCredentialSpecName": { "description": "GMSACredentialSpecName is the name of the GMSA credential spec to use.", "type": [ "string", "null" ] }, "hostProcess": { "description": "HostProcess determines if a container should be run as a 'Host Process' container.\nAll of a Pod's containers must have the same effective HostProcess value\n(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).\nIn addition, if HostProcess is true then HostNetwork must also be set to true.", "type": [ "boolean", "null" ] }, "runAsUserName": { "description": "The UserName in Windows to run the entrypoint of the container process.\nDefaults to the user specified in image metadata if unspecified.\nMay also be set in PodSecurityContext. If set in both SecurityContext and\nPodSecurityContext, the value specified in SecurityContext takes precedence.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "serviceAccountName": { "description": "ServiceAccountName is the name of the ServiceAccount to use to run the\nPrometheus Pods.", "type": [ "string", "null" ] }, "serviceDiscoveryRole": { "description": "Defines the service discovery role used to discover targets from\n`ServiceMonitor` objects and Alertmanager endpoints.\n\nIf set, the value should be either \"Endpoints\" or \"EndpointSlice\".\nIf unset, the operator assumes the \"Endpoints\" role.", "enum": [ "Endpoints", "EndpointSlice" ], "type": [ "string", "null" ] }, "serviceMonitorNamespaceSelector": { "additionalProperties": false, "description": "Namespaces to match for ServicedMonitors discovery. An empty label selector\nmatches all namespaces. A null label selector (default value) matches the current\nnamespace only.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "serviceMonitorSelector": { "additionalProperties": false, "description": "ServiceMonitors to be selected for target discovery. An empty label\nselector matches all objects. A null label selector matches no objects.\n\nIf `spec.serviceMonitorSelector`, `spec.podMonitorSelector`, `spec.probeSelector`\nand `spec.scrapeConfigSelector` are null, the Prometheus configuration is unmanaged.\nThe Prometheus operator will ensure that the Prometheus configuration's\nSecret exists, but it is the responsibility of the user to provide the raw\ngzipped Prometheus configuration under the `prometheus.yaml.gz` key.\nThis behavior is *deprecated* and will be removed in the next major version\nof the custom resource definition. It is recommended to use\n`spec.additionalScrapeConfigs` instead.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "serviceName": { "description": "The name of the service name used by the underlying StatefulSet(s) as the governing service.\nIf defined, the Service must be created before the Prometheus/PrometheusAgent resource in the same namespace and it must define a selector that matches the pod labels.\nIf empty, the operator will create and manage a headless service named `prometheus-operated` for Prometheus resources,\nor `prometheus-agent-operated` for PrometheusAgent resources.\nWhen deploying multiple Prometheus/PrometheusAgent resources in the same namespace, it is recommended to specify a different value for each.\nSee https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details.", "minLength": 1, "type": [ "string", "null" ] }, "sha": { "description": "Deprecated: use 'spec.image' instead. The image's digest can be specified as part of the image name.", "type": [ "string", "null" ] }, "shardRetentionPolicy": { "additionalProperties": false, "description": "ShardRetentionPolicy defines the retention policy for the Prometheus shards.\n(Alpha) Using this field requires the 'PrometheusShardRetentionPolicy' feature gate to be enabled.\n\nThe final goals for this feature can be seen at https://github.com/prometheus-operator/prometheus-operator/blob/main/Documentation/proposals/202310-shard-autoscaling.md#graceful-scale-down-of-prometheus-servers,\nhowever, the feature is not yet fully implemented in this PR. The limitation being:\n* Retention duration is not settable, for now, shards are retained forever.", "properties": { "retain": { "additionalProperties": false, "description": "Defines the config for retention when the retention policy is set to `Retain`.\nThis field is ineffective as of now.", "properties": { "retentionPeriod": { "description": "Duration is a valid time duration that can be parsed by Prometheus model.ParseDuration() function.\nSupported units: y, w, d, h, m, s, ms\nExamples: `30s`, `1m`, `1h20m15s`, `15d`", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": "string" } }, "required": [ "retentionPeriod" ], "type": [ "object", "null" ] }, "whenScaled": { "description": "Defines the retention policy when the Prometheus shards are scaled down.\n* `Delete`, the operator will delete the pods from the scaled-down shard(s).\n* `Retain`, the operator will keep the pods from the scaled-down shard(s), so the data can still be queried.\n\nIf not defined, the operator assumes the `Delete` value.", "enum": [ "Retain", "Delete" ], "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "shards": { "description": "Number of shards to distribute the scraped targets onto.\n\n`spec.replicas` multiplied by `spec.shards` is the total number of Pods\nbeing created.\n\nWhen not defined, the operator assumes only one shard.\n\nNote that scaling down shards will not reshard data onto the remaining\ninstances, it must be manually moved. Increasing shards will not reshard\ndata either but it will continue to be available from the same\ninstances. To query globally, use either\n* Thanos sidecar + querier for query federation and Thanos Ruler for rules.\n* Remote-write to send metrics to a central location.\n\nBy default, the sharding of targets is performed on:\n* The `__address__` target's metadata label for PodMonitor,\nServiceMonitor and ScrapeConfig resources.\n* The `__param_target__` label for Probe resources.\n\nUsers can define their own sharding implementation by setting the\n`__tmp_hash` label during the target discovery with relabeling\nconfiguration (either in the monitoring resources or via scrape class).\n\nYou can also disable sharding on a specific target by setting the\n`__tmp_disable_sharding` label with relabeling configuration. When\nthe label value isn't empty, all Prometheus shards will scrape the target.", "format": "int32", "type": [ "integer", "null" ] }, "storage": { "additionalProperties": false, "description": "Storage defines the storage used by Prometheus.", "properties": { "disableMountSubPath": { "description": "Deprecated: subPath usage will be removed in a future release.", "type": [ "boolean", "null" ] }, "emptyDir": { "additionalProperties": false, "description": "EmptyDirVolumeSource to be used by the StatefulSet.\nIf specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir", "properties": { "medium": { "description": "medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", "type": [ "string", "null" ] }, "sizeLimit": { "description": "sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" }, { "type": "null" } ], "x-kubernetes-int-or-string": true } }, "type": [ "object", "null" ] }, "ephemeral": { "additionalProperties": false, "description": "EphemeralVolumeSource to be used by the StatefulSet.\nThis is a beta field in k8s 1.21 and GA in 1.15.\nFor lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.\nMore info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes", "properties": { "volumeClaimTemplate": { "additionalProperties": false, "description": "Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `\u003cpod name\u003e-\u003cvolume name\u003e` where\n`\u003cvolume name\u003e` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\nRequired, must not be nil.", "properties": { "metadata": { "description": "May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation.", "type": [ "object", "null" ] }, "spec": { "additionalProperties": false, "description": "The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here.", "properties": { "accessModes": { "description": "accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "dataSource": { "additionalProperties": false, "description": "dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource.", "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.", "type": [ "string", "null" ] }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" } }, "required": [ "kind", "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "dataSourceRef": { "additionalProperties": false, "description": "dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.", "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.", "type": [ "string", "null" ] }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" }, "namespace": { "description": "Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.", "type": [ "string", "null" ] } }, "required": [ "kind", "name" ], "type": [ "object", "null" ] }, "resources": { "additionalProperties": false, "description": "resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources", "properties": { "limits": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] }, "requests": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "selector": { "additionalProperties": false, "description": "selector is a label query over volumes to consider for binding.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "storageClassName": { "description": "storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1", "type": [ "string", "null" ] }, "volumeAttributesClassName": { "description": "volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).", "type": [ "string", "null" ] }, "volumeMode": { "description": "volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec.", "type": [ "string", "null" ] }, "volumeName": { "description": "volumeName is the binding reference to the PersistentVolume backing this claim.", "type": [ "string", "null" ] } }, "type": "object" } }, "required": [ "spec" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "volumeClaimTemplate": { "additionalProperties": false, "description": "Defines the PVC spec to be used by the Prometheus StatefulSets.\nThe easiest way to use a volume that cannot be automatically provisioned\nis to use a label selector alongside manually created PersistentVolumes.", "properties": { "apiVersion": { "description": "APIVersion defines the versioned schema of this representation of an object.\nServers should convert recognized schemas to the latest internal value, and\nmay reject unrecognized values.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources", "type": [ "string", "null" ] }, "kind": { "description": "Kind is a string value representing the REST resource this object represents.\nServers may infer this from the endpoint the client submits requests to.\nCannot be updated.\nIn CamelCase.\nMore info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds", "type": [ "string", "null" ] }, "metadata": { "additionalProperties": false, "description": "EmbeddedMetadata contains metadata relevant to an EmbeddedResource.", "properties": { "annotations": { "additionalProperties": { "type": "string" }, "description": "Annotations is an unstructured key value map stored with a resource that may be\nset by external tools to store and retrieve arbitrary metadata. They are not\nqueryable and should be preserved when modifying objects.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/", "type": [ "object", "null" ] }, "labels": { "additionalProperties": { "type": "string" }, "description": "Map of string keys and values that can be used to organize and categorize\n(scope and select) objects. May match selectors of replication controllers\nand services.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", "type": [ "object", "null" ] }, "name": { "description": "Name must be unique within a namespace. Is required when creating resources, although\nsome resources may allow a client to request the generation of an appropriate name\nautomatically. Name is primarily intended for creation idempotence and configuration\ndefinition.\nCannot be updated.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "spec": { "additionalProperties": false, "description": "Defines the desired characteristics of a volume requested by a pod author.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "properties": { "accessModes": { "description": "accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "dataSource": { "additionalProperties": false, "description": "dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource.", "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.", "type": [ "string", "null" ] }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" } }, "required": [ "kind", "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "dataSourceRef": { "additionalProperties": false, "description": "dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.", "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.", "type": [ "string", "null" ] }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" }, "namespace": { "description": "Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.", "type": [ "string", "null" ] } }, "required": [ "kind", "name" ], "type": [ "object", "null" ] }, "resources": { "additionalProperties": false, "description": "resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources", "properties": { "limits": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] }, "requests": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "selector": { "additionalProperties": false, "description": "selector is a label query over volumes to consider for binding.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "storageClassName": { "description": "storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1", "type": [ "string", "null" ] }, "volumeAttributesClassName": { "description": "volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).", "type": [ "string", "null" ] }, "volumeMode": { "description": "volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec.", "type": [ "string", "null" ] }, "volumeName": { "description": "volumeName is the binding reference to the PersistentVolume backing this claim.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "status": { "additionalProperties": false, "description": "Deprecated: this field is never set.", "properties": { "accessModes": { "description": "accessModes contains the actual access modes the volume backing the PVC has.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "allocatedResourceStatuses": { "additionalProperties": { "description": "When a controller receives persistentvolume claim update with ClaimResourceStatus for a resource\nthat it does not recognizes, then it should ignore that update and let other controllers\nhandle it.", "type": "string" }, "description": "allocatedResourceStatuses stores status of resource being resized for the given PVC.\nKey names follow standard Kubernetes label syntax. Valid values are either:\n\t* Un-prefixed keys:\n\t\t- storage - the capacity of the volume.\n\t* Custom resources must use implementation-defined prefixed names such as \"example.com/my-custom-resource\"\nApart from above values - keys that are unprefixed or have kubernetes.io prefix are considered\nreserved and hence may not be used.\n\nClaimResourceStatus can be in any of following states:\n\t- ControllerResizeInProgress:\n\t\tState set when resize controller starts resizing the volume in control-plane.\n\t- ControllerResizeFailed:\n\t\tState set when resize has failed in resize controller with a terminal error.\n\t- NodeResizePending:\n\t\tState set when resize controller has finished resizing the volume but further resizing of\n\t\tvolume is needed on the node.\n\t- NodeResizeInProgress:\n\t\tState set when kubelet starts resizing the volume.\n\t- NodeResizeFailed:\n\t\tState set when resizing has failed in kubelet with a terminal error. Transient errors don't set\n\t\tNodeResizeFailed.\nFor example: if expanding a PVC for more capacity - this field can be one of the following states:\n\t- pvc.status.allocatedResourceStatus['storage'] = \"ControllerResizeInProgress\"\n - pvc.status.allocatedResourceStatus['storage'] = \"ControllerResizeFailed\"\n - pvc.status.allocatedResourceStatus['storage'] = \"NodeResizePending\"\n - pvc.status.allocatedResourceStatus['storage'] = \"NodeResizeInProgress\"\n - pvc.status.allocatedResourceStatus['storage'] = \"NodeResizeFailed\"\nWhen this field is not set, it means that no resize operation is in progress for the given PVC.\n\nA controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus\nshould ignore the update for the purpose it was designed. For example - a controller that\nonly is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid\nresources associated with PVC.\n\nThis is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.", "type": [ "object", "null" ], "x-kubernetes-map-type": "granular" }, "allocatedResources": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "allocatedResources tracks the resources allocated to a PVC including its capacity.\nKey names follow standard Kubernetes label syntax. Valid values are either:\n\t* Un-prefixed keys:\n\t\t- storage - the capacity of the volume.\n\t* Custom resources must use implementation-defined prefixed names such as \"example.com/my-custom-resource\"\nApart from above values - keys that are unprefixed or have kubernetes.io prefix are considered\nreserved and hence may not be used.\n\nCapacity reported here may be larger than the actual capacity when a volume expansion operation\nis requested.\nFor storage quota, the larger value from allocatedResources and PVC.spec.resources is used.\nIf allocatedResources is not set, PVC.spec.resources alone is used for quota calculation.\nIf a volume expansion capacity request is lowered, allocatedResources is only\nlowered if there are no expansion operations in progress and if the actual volume capacity\nis equal or lower than the requested capacity.\n\nA controller that receives PVC update with previously unknown resourceName\nshould ignore the update for the purpose it was designed. For example - a controller that\nonly is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid\nresources associated with PVC.\n\nThis is an alpha field and requires enabling RecoverVolumeExpansionFailure feature.", "type": [ "object", "null" ] }, "capacity": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "capacity represents the actual resources of the underlying volume.", "type": [ "object", "null" ] }, "conditions": { "description": "conditions is the current Condition of persistent volume claim. If underlying persistent volume is being\nresized then the Condition will be set to 'Resizing'.", "items": { "additionalProperties": false, "description": "PersistentVolumeClaimCondition contains details about state of pvc", "properties": { "lastProbeTime": { "description": "lastProbeTime is the time we probed the condition.", "format": "date-time", "type": [ "string", "null" ] }, "lastTransitionTime": { "description": "lastTransitionTime is the time the condition transitioned from one status to another.", "format": "date-time", "type": [ "string", "null" ] }, "message": { "description": "message is the human-readable message indicating details about last transition.", "type": [ "string", "null" ] }, "reason": { "description": "reason is a unique, this should be a short, machine understandable string that gives the reason\nfor condition's last transition. If it reports \"Resizing\" that means the underlying\npersistent volume is being resized.", "type": [ "string", "null" ] }, "status": { "description": "Status is the status of the condition.\nCan be True, False, Unknown.\nMore info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=state%20of%20pvc-,conditions.status,-(string)%2C%20required", "type": "string" }, "type": { "description": "Type is the type of the condition.\nMore info: https://kubernetes.io/docs/reference/kubernetes-api/config-and-storage-resources/persistent-volume-claim-v1/#:~:text=set%20to%20%27ResizeStarted%27.-,PersistentVolumeClaimCondition,-contains%20details%20about", "type": "string" } }, "required": [ "status", "type" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" }, "currentVolumeAttributesClassName": { "description": "currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using.\nWhen unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim\nThis is a beta field and requires enabling VolumeAttributesClass feature (off by default).", "type": [ "string", "null" ] }, "modifyVolumeStatus": { "additionalProperties": false, "description": "ModifyVolumeStatus represents the status object of ControllerModifyVolume operation.\nWhen this is unset, there is no ModifyVolume operation being attempted.\nThis is a beta field and requires enabling VolumeAttributesClass feature (off by default).", "properties": { "status": { "description": "status is the status of the ControllerModifyVolume operation. It can be in any of following states:\n - Pending\n Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as\n the specified VolumeAttributesClass not existing.\n - InProgress\n InProgress indicates that the volume is being modified.\n - Infeasible\n Infeasible indicates that the request has been rejected as invalid by the CSI driver. To\n\t resolve the error, a valid VolumeAttributesClass needs to be specified.\nNote: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.", "type": "string" }, "targetVolumeAttributesClassName": { "description": "targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled", "type": [ "string", "null" ] } }, "required": [ "status" ], "type": [ "object", "null" ] }, "phase": { "description": "phase represents the current phase of PersistentVolumeClaim.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "tag": { "description": "Deprecated: use 'spec.image' instead. The image's tag can be specified as part of the image name.", "type": [ "string", "null" ] }, "targetLimit": { "description": "TargetLimit defines a limit on the number of scraped targets that will be accepted.\nOnly valid in Prometheus versions 2.45.0 and newer.\n\nNote that the global limit only applies to scrape objects that don't specify an explicit limit value.\nIf you want to enforce a maximum limit for all scrape objects, refer to enforcedTargetLimit.", "format": "int64", "type": [ "integer", "null" ] }, "terminationGracePeriodSeconds": { "description": "Optional duration in seconds the pod needs to terminate gracefully.\nValue must be non-negative integer. The value zero indicates stop immediately via\nthe kill signal (no opportunity to shut down) which may lead to data corruption.\n\nDefaults to 600 seconds.", "format": "int64", "minimum": 0, "type": [ "integer", "null" ] }, "thanos": { "additionalProperties": false, "description": "Defines the configuration of the optional Thanos sidecar.", "properties": { "additionalArgs": { "description": "AdditionalArgs allows setting additional arguments for the Thanos container.\nThe arguments are passed as-is to the Thanos container which may cause issues\nif they are invalid or not supported the given Thanos version.\nIn case of an argument conflict (e.g. an argument which is already set by the\noperator itself) or when providing an invalid argument, the reconciliation will\nfail and an error will be logged.", "items": { "additionalProperties": false, "description": "Argument as part of the AdditionalArgs list.", "properties": { "name": { "description": "Name of the argument, e.g. \"scrape.discovery-reload-interval\".", "minLength": 1, "type": "string" }, "value": { "description": "Argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)", "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ] }, "baseImage": { "description": "Deprecated: use 'image' instead.", "type": [ "string", "null" ] }, "blockSize": { "default": "2h", "description": "BlockDuration controls the size of TSDB blocks produced by Prometheus.\nThe default value is 2h to match the upstream Prometheus defaults.\n\nWARNING: Changing the block duration can impact the performance and\nefficiency of the entire Prometheus/Thanos stack due to how it interacts\nwith memory and Thanos compactors. It is recommended to keep this value\nset to a multiple of 120 times your longest scrape or rule interval. For\nexample, 30s * 120 = 1h.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "getConfigInterval": { "description": "How often to retrieve the Prometheus configuration.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "getConfigTimeout": { "description": "Maximum time to wait when retrieving the Prometheus configuration.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "grpcListenLocal": { "description": "When true, the Thanos sidecar listens on the loopback interface instead\nof the Pod IP's address for the gRPC endpoints.\n\nIt has no effect if `listenLocal` is true.", "type": [ "boolean", "null" ] }, "grpcServerTlsConfig": { "additionalProperties": false, "description": "Configures the TLS parameters for the gRPC server providing the StoreAPI.\n\nNote: Currently only the `caFile`, `certFile`, and `keyFile` fields are supported.", "properties": { "ca": { "additionalProperties": false, "description": "Certificate authority used when verifying server certificates.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "caFile": { "description": "Path to the CA cert in the Prometheus container to use for the targets.", "type": [ "string", "null" ] }, "cert": { "additionalProperties": false, "description": "Client certificate to present when doing client-authentication.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "certFile": { "description": "Path to the client cert file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "insecureSkipVerify": { "description": "Disable target certificate validation.", "type": [ "boolean", "null" ] }, "keyFile": { "description": "Path to the client key file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "keySecret": { "additionalProperties": false, "description": "Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "maxVersion": { "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.41.0 or Thanos \u003e= v0.31.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "minVersion": { "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.35.0 or Thanos \u003e= v0.28.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "serverName": { "description": "Used to verify the hostname for the targets.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "httpListenLocal": { "description": "When true, the Thanos sidecar listens on the loopback interface instead\nof the Pod IP's address for the HTTP endpoints.\n\nIt has no effect if `listenLocal` is true.", "type": [ "boolean", "null" ] }, "image": { "description": "Container image name for Thanos. If specified, it takes precedence over\nthe `spec.thanos.baseImage`, `spec.thanos.tag` and `spec.thanos.sha`\nfields.\n\nSpecifying `spec.thanos.version` is still necessary to ensure the\nPrometheus Operator knows which version of Thanos is being configured.\n\nIf neither `spec.thanos.image` nor `spec.thanos.baseImage` are defined,\nthe operator will use the latest upstream version of Thanos available at\nthe time when the operator was released.", "type": [ "string", "null" ] }, "listenLocal": { "description": "Deprecated: use `grpcListenLocal` and `httpListenLocal` instead.", "type": [ "boolean", "null" ] }, "logFormat": { "description": "Log format for the Thanos sidecar.", "enum": [ "", "logfmt", "json" ], "type": [ "string", "null" ] }, "logLevel": { "description": "Log level for the Thanos sidecar.", "enum": [ "", "debug", "info", "warn", "error" ], "type": [ "string", "null" ] }, "minTime": { "description": "Defines the start of time range limit served by the Thanos sidecar's StoreAPI.\nThe field's value should be a constant time in RFC3339 format or a time\nduration relative to current time, such as -1d or 2h45m. Valid duration\nunits are ms, s, m, h, d, w, y.", "type": [ "string", "null" ] }, "objectStorageConfig": { "additionalProperties": false, "description": "Defines the Thanos sidecar's configuration to upload TSDB blocks to object storage.\n\nMore info: https://thanos.io/tip/thanos/storage.md/\n\nobjectStorageConfigFile takes precedence over this field.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "objectStorageConfigFile": { "description": "Defines the Thanos sidecar's configuration file to upload TSDB blocks to object storage.\n\nMore info: https://thanos.io/tip/thanos/storage.md/\n\nThis field takes precedence over objectStorageConfig.", "type": [ "string", "null" ] }, "readyTimeout": { "description": "ReadyTimeout is the maximum time that the Thanos sidecar will wait for\nPrometheus to start.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "resources": { "additionalProperties": false, "description": "Defines the resources requests and limits of the Thanos sidecar.", "properties": { "claims": { "description": "Claims lists the names of resources, defined in spec.resourceClaims,\nthat are used by this container.\n\nThis is an alpha field and requires enabling the\nDynamicResourceAllocation feature gate.\n\nThis field is immutable. It can only be set for containers.", "items": { "additionalProperties": false, "description": "ResourceClaim references one entry in PodSpec.ResourceClaims.", "properties": { "name": { "description": "Name must match the name of one entry in pod.spec.resourceClaims of\nthe Pod where this field is used. It makes that resource available\ninside a container.", "type": "string" }, "request": { "description": "Request is the name chosen for a request in the referenced claim.\nIf empty, everything from the claim is made available, otherwise\nonly the result of this request.", "type": [ "string", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "name" ], "x-kubernetes-list-type": "map" }, "limits": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] }, "requests": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "sha": { "description": "Deprecated: use 'image' instead. The image digest can be specified as part of the image name.", "type": [ "string", "null" ] }, "tag": { "description": "Deprecated: use 'image' instead. The image's tag can be specified as as part of the image name.", "type": [ "string", "null" ] }, "tracingConfig": { "additionalProperties": false, "description": "Defines the tracing configuration for the Thanos sidecar.\n\n`tracingConfigFile` takes precedence over this field.\n\nMore info: https://thanos.io/tip/thanos/tracing.md/\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "tracingConfigFile": { "description": "Defines the tracing configuration file for the Thanos sidecar.\n\nThis field takes precedence over `tracingConfig`.\n\nMore info: https://thanos.io/tip/thanos/tracing.md/\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "type": [ "string", "null" ] }, "version": { "description": "Version of Thanos being deployed. The operator uses this information\nto generate the Prometheus StatefulSet + configuration files.\n\nIf not specified, the operator assumes the latest upstream release of\nThanos available at the time when the version of the operator was\nreleased.", "type": [ "string", "null" ] }, "volumeMounts": { "description": "VolumeMounts allows configuration of additional VolumeMounts for Thanos.\nVolumeMounts specified will be appended to other VolumeMounts in the\n'thanos-sidecar' container.", "items": { "additionalProperties": false, "description": "VolumeMount describes a mounting of a Volume within a container.", "properties": { "mountPath": { "description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.", "type": "string" }, "mountPropagation": { "description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None).", "type": [ "string", "null" ] }, "name": { "description": "This must match the Name of a Volume.", "type": "string" }, "readOnly": { "description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.", "type": [ "boolean", "null" ] }, "recursiveReadOnly": { "description": "RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\nIf this field is not specified, it is treated as an equivalent of Disabled.", "type": [ "string", "null" ] }, "subPath": { "description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).", "type": [ "string", "null" ] }, "subPathExpr": { "description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.", "type": [ "string", "null" ] } }, "required": [ "mountPath", "name" ], "type": "object" }, "type": [ "array", "null" ] } }, "type": [ "object", "null" ] }, "tolerations": { "description": "Defines the Pods' tolerations if specified.", "items": { "additionalProperties": false, "description": "The pod this Toleration is attached to tolerates any taint that matches\nthe triple \u003ckey,value,effect\u003e using the matching operator \u003coperator\u003e.", "properties": { "effect": { "description": "Effect indicates the taint effect to match. Empty means match all taint effects.\nWhen specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.", "type": [ "string", "null" ] }, "key": { "description": "Key is the taint key that the toleration applies to. Empty means match all taint keys.\nIf the key is empty, operator must be Exists; this combination means to match all values and all keys.", "type": [ "string", "null" ] }, "operator": { "description": "Operator represents a key's relationship to the value.\nValid operators are Exists and Equal. Defaults to Equal.\nExists is equivalent to wildcard for value, so that a pod can\ntolerate all taints of a particular category.", "type": [ "string", "null" ] }, "tolerationSeconds": { "description": "TolerationSeconds represents the period of time the toleration (which must be\nof effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,\nit is not set, which means tolerate the taint forever (do not evict). Zero and\nnegative values will be treated as 0 (evict immediately) by the system.", "format": "int64", "type": [ "integer", "null" ] }, "value": { "description": "Value is the taint value the toleration matches to.\nIf the operator is Exists, the value should be empty, otherwise just a regular string.", "type": [ "string", "null" ] } }, "type": "object" }, "type": [ "array", "null" ] }, "topologySpreadConstraints": { "description": "Defines the pod's topology spread constraints if specified.", "items": { "additionalProperties": false, "properties": { "additionalLabelSelectors": { "description": "Defines what Prometheus Operator managed labels should be added to labelSelector on the topologySpreadConstraint.", "enum": [ "OnResource", "OnShard" ], "type": [ "string", "null" ] }, "labelSelector": { "additionalProperties": false, "description": "LabelSelector is used to find matching pods.\nPods that match this label selector are counted to determine the number of pods\nin their corresponding topology domain.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "matchLabelKeys": { "description": "MatchLabelKeys is a set of pod label keys to select the pods over which\nspreading will be calculated. The keys are used to lookup values from the\nincoming pod labels, those key-value labels are ANDed with labelSelector\nto select the group of existing pods over which spreading will be calculated\nfor the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.\nMatchLabelKeys cannot be set when LabelSelector isn't set.\nKeys that don't exist in the incoming pod labels will\nbe ignored. A null or empty list means only match against labelSelector.\n\nThis is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "maxSkew": { "description": "MaxSkew describes the degree to which pods may be unevenly distributed.\nWhen `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference\nbetween the number of matching pods in the target topology and the global minimum.\nThe global minimum is the minimum number of matching pods in an eligible domain\nor zero if the number of eligible domains is less than MinDomains.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 2/2/1:\nIn this case, the global minimum is 1.\n| zone1 | zone2 | zone3 |\n| P P | P P | P |\n- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;\nscheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)\nviolate MaxSkew(1).\n- if MaxSkew is 2, incoming pod can be scheduled onto any zone.\nWhen `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence\nto topologies that satisfy it.\nIt's a required field. Default value is 1 and 0 is not allowed.", "format": "int32", "type": "integer" }, "minDomains": { "description": "MinDomains indicates a minimum number of eligible domains.\nWhen the number of eligible domains with matching topology keys is less than minDomains,\nPod Topology Spread treats \"global minimum\" as 0, and then the calculation of Skew is performed.\nAnd when the number of eligible domains with matching topology keys equals or greater than minDomains,\nthis value has no effect on scheduling.\nAs a result, when the number of eligible domains is less than minDomains,\nscheduler won't schedule more than maxSkew Pods to those domains.\nIf value is nil, the constraint behaves as if MinDomains is equal to 1.\nValid values are integers greater than 0.\nWhen value is not nil, WhenUnsatisfiable must be DoNotSchedule.\n\nFor example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same\nlabelSelector spread as 2/2/2:\n| zone1 | zone2 | zone3 |\n| P P | P P | P P |\nThe number of domains is less than 5(MinDomains), so \"global minimum\" is treated as 0.\nIn this situation, new pod with the same labelSelector cannot be scheduled,\nbecause computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,\nit will violate MaxSkew.", "format": "int32", "type": [ "integer", "null" ] }, "nodeAffinityPolicy": { "description": "NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector\nwhen calculating pod topology spread skew. Options are:\n- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.\n- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.\n\nIf this value is nil, the behavior is equivalent to the Honor policy.", "type": [ "string", "null" ] }, "nodeTaintsPolicy": { "description": "NodeTaintsPolicy indicates how we will treat node taints when calculating\npod topology spread skew. Options are:\n- Honor: nodes without taints, along with tainted nodes for which the incoming pod\nhas a toleration, are included.\n- Ignore: node taints are ignored. All nodes are included.\n\nIf this value is nil, the behavior is equivalent to the Ignore policy.", "type": [ "string", "null" ] }, "topologyKey": { "description": "TopologyKey is the key of node labels. Nodes that have a label with this key\nand identical values are considered to be in the same topology.\nWe consider each \u003ckey, value\u003e as a \"bucket\", and try to put balanced number\nof pods into each bucket.\nWe define a domain as a particular instance of a topology.\nAlso, we define an eligible domain as a domain whose nodes meet the requirements of\nnodeAffinityPolicy and nodeTaintsPolicy.\ne.g. If TopologyKey is \"kubernetes.io/hostname\", each Node is a domain of that topology.\nAnd, if TopologyKey is \"topology.kubernetes.io/zone\", each zone is a domain of that topology.\nIt's a required field.", "type": "string" }, "whenUnsatisfiable": { "description": "WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy\nthe spread constraint.\n- DoNotSchedule (default) tells the scheduler not to schedule it.\n- ScheduleAnyway tells the scheduler to schedule the pod in any location,\n but giving higher precedence to topologies that would help reduce the\n skew.\nA constraint is considered \"Unsatisfiable\" for an incoming pod\nif and only if every possible node assignment for that pod would violate\n\"MaxSkew\" on some topology.\nFor example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same\nlabelSelector spread as 3/1/1:\n| zone1 | zone2 | zone3 |\n| P P P | P | P |\nIf WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled\nto zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies\nMaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler\nwon't make it *more* imbalanced.\nIt's a required field.", "type": "string" } }, "required": [ "maxSkew", "topologyKey", "whenUnsatisfiable" ], "type": "object" }, "type": [ "array", "null" ] }, "tracingConfig": { "additionalProperties": false, "description": "TracingConfig configures tracing in Prometheus.\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.", "properties": { "clientType": { "description": "Client used to export the traces. Supported values are `http` or `grpc`.", "enum": [ "http", "grpc" ], "type": [ "string", "null" ] }, "compression": { "description": "Compression key for supported compression types. The only supported value is `gzip`.", "enum": [ "gzip" ], "type": [ "string", "null" ] }, "endpoint": { "description": "Endpoint to send the traces to. Should be provided in format \u003chost\u003e:\u003cport\u003e.", "minLength": 1, "type": "string" }, "headers": { "additionalProperties": { "type": "string" }, "description": "Key-value pairs to be used as headers associated with gRPC or HTTP requests.", "type": [ "object", "null" ] }, "insecure": { "description": "If disabled, the client will use a secure connection.", "type": [ "boolean", "null" ] }, "samplingFraction": { "description": "Sets the probability a given trace will be sampled. Must be a float from 0 through 1.", "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" }, { "type": "null" } ], "x-kubernetes-int-or-string": true }, "timeout": { "description": "Maximum time the exporter will wait for each batch export.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] }, "tlsConfig": { "additionalProperties": false, "description": "TLS Config to use when sending traces.", "properties": { "ca": { "additionalProperties": false, "description": "Certificate authority used when verifying server certificates.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "caFile": { "description": "Path to the CA cert in the Prometheus container to use for the targets.", "type": [ "string", "null" ] }, "cert": { "additionalProperties": false, "description": "Client certificate to present when doing client-authentication.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "certFile": { "description": "Path to the client cert file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "insecureSkipVerify": { "description": "Disable target certificate validation.", "type": [ "boolean", "null" ] }, "keyFile": { "description": "Path to the client key file in the Prometheus container for the targets.", "type": [ "string", "null" ] }, "keySecret": { "additionalProperties": false, "description": "Secret containing the client key file for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "maxVersion": { "description": "Maximum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.41.0 or Thanos \u003e= v0.31.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "minVersion": { "description": "Minimum acceptable TLS version.\n\nIt requires Prometheus \u003e= v2.35.0 or Thanos \u003e= v0.28.0.", "enum": [ "TLS10", "TLS11", "TLS12", "TLS13" ], "type": [ "string", "null" ] }, "serverName": { "description": "Used to verify the hostname for the targets.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] } }, "required": [ "endpoint" ], "type": [ "object", "null" ] }, "tsdb": { "additionalProperties": false, "description": "Defines the runtime reloadable configuration of the timeseries database(TSDB).\nIt requires Prometheus \u003e= v2.39.0 or PrometheusAgent \u003e= v2.54.0.", "properties": { "outOfOrderTimeWindow": { "description": "Configures how old an out-of-order/out-of-bounds sample can be with\nrespect to the TSDB max time.\n\nAn out-of-order/out-of-bounds sample is ingested into the TSDB as long as\nthe timestamp of the sample is \u003e= (TSDB.MaxTime - outOfOrderTimeWindow).\n\nThis is an *experimental feature*, it may change in any upcoming release\nin a breaking way.\n\nIt requires Prometheus \u003e= v2.39.0 or PrometheusAgent \u003e= v2.54.0.", "pattern": "^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "version": { "description": "Version of Prometheus being deployed. The operator uses this information\nto generate the Prometheus StatefulSet + configuration files.\n\nIf not specified, the operator assumes the latest upstream version of\nPrometheus available at the time when the version of the operator was\nreleased.", "type": [ "string", "null" ] }, "volumeMounts": { "description": "VolumeMounts allows the configuration of additional VolumeMounts.\n\nVolumeMounts will be appended to other VolumeMounts in the 'prometheus'\ncontainer, that are generated as a result of StorageSpec objects.", "items": { "additionalProperties": false, "description": "VolumeMount describes a mounting of a Volume within a container.", "properties": { "mountPath": { "description": "Path within the container at which the volume should be mounted. Must\nnot contain ':'.", "type": "string" }, "mountPropagation": { "description": "mountPropagation determines how mounts are propagated from the host\nto container and the other way around.\nWhen not set, MountPropagationNone is used.\nThis field is beta in 1.10.\nWhen RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified\n(which defaults to None).", "type": [ "string", "null" ] }, "name": { "description": "This must match the Name of a Volume.", "type": "string" }, "readOnly": { "description": "Mounted read-only if true, read-write otherwise (false or unspecified).\nDefaults to false.", "type": [ "boolean", "null" ] }, "recursiveReadOnly": { "description": "RecursiveReadOnly specifies whether read-only mounts should be handled\nrecursively.\n\nIf ReadOnly is false, this field has no meaning and must be unspecified.\n\nIf ReadOnly is true, and this field is set to Disabled, the mount is not made\nrecursively read-only. If this field is set to IfPossible, the mount is made\nrecursively read-only, if it is supported by the container runtime. If this\nfield is set to Enabled, the mount is made recursively read-only if it is\nsupported by the container runtime, otherwise the pod will not be started and\nan error will be generated to indicate the reason.\n\nIf this field is set to IfPossible or Enabled, MountPropagation must be set to\nNone (or be unspecified, which defaults to None).\n\nIf this field is not specified, it is treated as an equivalent of Disabled.", "type": [ "string", "null" ] }, "subPath": { "description": "Path within the volume from which the container's volume should be mounted.\nDefaults to \"\" (volume's root).", "type": [ "string", "null" ] }, "subPathExpr": { "description": "Expanded path within the volume from which the container's volume should be mounted.\nBehaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.\nDefaults to \"\" (volume's root).\nSubPathExpr and SubPath are mutually exclusive.", "type": [ "string", "null" ] } }, "required": [ "mountPath", "name" ], "type": "object" }, "type": [ "array", "null" ] }, "volumes": { "description": "Volumes allows the configuration of additional volumes on the output\nStatefulSet definition. Volumes specified will be appended to other\nvolumes that are generated as a result of StorageSpec objects.", "items": { "additionalProperties": false, "description": "Volume represents a named volume in a pod that may be accessed by any container in the pod.", "properties": { "awsElasticBlockStore": { "additionalProperties": false, "description": "awsElasticBlockStore represents an AWS Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nDeprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree\nawsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "properties": { "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "type": [ "string", "null" ] }, "partition": { "description": "partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).", "format": "int32", "type": [ "integer", "null" ] }, "readOnly": { "description": "readOnly value true will force the readOnly setting in VolumeMounts.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "type": [ "boolean", "null" ] }, "volumeID": { "description": "volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore", "type": "string" } }, "required": [ "volumeID" ], "type": [ "object", "null" ] }, "azureDisk": { "additionalProperties": false, "description": "azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.\nDeprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type\nare redirected to the disk.csi.azure.com CSI driver.", "properties": { "cachingMode": { "description": "cachingMode is the Host Caching mode: None, Read Only, Read Write.", "type": [ "string", "null" ] }, "diskName": { "description": "diskName is the Name of the data disk in the blob storage", "type": "string" }, "diskURI": { "description": "diskURI is the URI of data disk in the blob storage", "type": "string" }, "fsType": { "default": "ext4", "description": "fsType is Filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": [ "string", "null" ] }, "kind": { "description": "kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared", "type": [ "string", "null" ] }, "readOnly": { "default": false, "description": "readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.", "type": [ "boolean", "null" ] } }, "required": [ "diskName", "diskURI" ], "type": [ "object", "null" ] }, "azureFile": { "additionalProperties": false, "description": "azureFile represents an Azure File Service mount on the host and bind mount to the pod.\nDeprecated: AzureFile is deprecated. All operations for the in-tree azureFile type\nare redirected to the file.csi.azure.com CSI driver.", "properties": { "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.", "type": [ "boolean", "null" ] }, "secretName": { "description": "secretName is the name of secret that contains Azure Storage Account Name and Key", "type": "string" }, "shareName": { "description": "shareName is the azure share Name", "type": "string" } }, "required": [ "secretName", "shareName" ], "type": [ "object", "null" ] }, "cephfs": { "additionalProperties": false, "description": "cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.\nDeprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.", "properties": { "monitors": { "description": "monitors is Required: Monitors is a collection of Ceph monitors\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "path": { "description": "path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /", "type": [ "string", "null" ] }, "readOnly": { "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "type": [ "boolean", "null" ] }, "secretFile": { "description": "secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "type": [ "string", "null" ] }, "secretRef": { "additionalProperties": false, "description": "secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "user": { "description": "user is optional: User is the rados user name, default is admin\nMore info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it", "type": [ "string", "null" ] } }, "required": [ "monitors" ], "type": [ "object", "null" ] }, "cinder": { "additionalProperties": false, "description": "cinder represents a cinder volume attached and mounted on kubelets host machine.\nDeprecated: Cinder is deprecated. All operations for the in-tree cinder type\nare redirected to the cinder.csi.openstack.org CSI driver.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md", "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md", "type": [ "string", "null" ] }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md", "type": [ "boolean", "null" ] }, "secretRef": { "additionalProperties": false, "description": "secretRef is optional: points to a secret object containing parameters used to connect\nto OpenStack.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "volumeID": { "description": "volumeID used to identify the volume in cinder.\nMore info: https://examples.k8s.io/mysql-cinder-pd/README.md", "type": "string" } }, "required": [ "volumeID" ], "type": [ "object", "null" ] }, "configMap": { "additionalProperties": false, "description": "configMap represents a configMap that should populate this volume", "properties": { "defaultMode": { "description": "defaultMode is optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.", "format": "int32", "type": [ "integer", "null" ] }, "items": { "description": "items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.", "items": { "additionalProperties": false, "description": "Maps a string key to a path within a volume.", "properties": { "key": { "description": "key is the key to project.", "type": "string" }, "mode": { "description": "mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.", "format": "int32", "type": [ "integer", "null" ] }, "path": { "description": "path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'.", "type": "string" } }, "required": [ "key", "path" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "optional specify whether the ConfigMap or its keys must be defined", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "csi": { "additionalProperties": false, "description": "csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.", "properties": { "driver": { "description": "driver is the name of the CSI driver that handles this volume.\nConsult with your admin for the correct name as registered in the cluster.", "type": "string" }, "fsType": { "description": "fsType to mount. Ex. \"ext4\", \"xfs\", \"ntfs\".\nIf not provided, the empty value is passed to the associated CSI driver\nwhich will determine the default filesystem to apply.", "type": [ "string", "null" ] }, "nodePublishSecretRef": { "additionalProperties": false, "description": "nodePublishSecretRef is a reference to the secret object containing\nsensitive information to pass to the CSI driver to complete the CSI\nNodePublishVolume and NodeUnpublishVolume calls.\nThis field is optional, and may be empty if no secret is required. If the\nsecret object contains more than one secret, all secret references are passed.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "readOnly": { "description": "readOnly specifies a read-only configuration for the volume.\nDefaults to false (read/write).", "type": [ "boolean", "null" ] }, "volumeAttributes": { "additionalProperties": { "type": "string" }, "description": "volumeAttributes stores driver-specific properties that are passed to the CSI\ndriver. Consult your driver's documentation for supported values.", "type": [ "object", "null" ] } }, "required": [ "driver" ], "type": [ "object", "null" ] }, "downwardAPI": { "additionalProperties": false, "description": "downwardAPI represents downward API about the pod that should populate this volume", "properties": { "defaultMode": { "description": "Optional: mode bits to use on created files by default. Must be a\nOptional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDefaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.", "format": "int32", "type": [ "integer", "null" ] }, "items": { "description": "Items is a list of downward API volume file", "items": { "additionalProperties": false, "description": "DownwardAPIVolumeFile represents information to create the file containing the pod field", "properties": { "fieldRef": { "additionalProperties": false, "description": "Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.", "properties": { "apiVersion": { "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".", "type": [ "string", "null" ] }, "fieldPath": { "description": "Path of the field to select in the specified API version.", "type": "string" } }, "required": [ "fieldPath" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "mode": { "description": "Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.", "format": "int32", "type": [ "integer", "null" ] }, "path": { "description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'", "type": "string" }, "resourceFieldRef": { "additionalProperties": false, "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.", "properties": { "containerName": { "description": "Container name: required for volumes, optional for env vars", "type": [ "string", "null" ] }, "divisor": { "description": "Specifies the output format of the exposed resources, defaults to \"1\"", "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" }, { "type": "null" } ], "x-kubernetes-int-or-string": true }, "resource": { "description": "Required: resource to select", "type": "string" } }, "required": [ "resource" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "required": [ "path" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "emptyDir": { "additionalProperties": false, "description": "emptyDir represents a temporary directory that shares a pod's lifetime.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", "properties": { "medium": { "description": "medium represents what type of storage medium should back this directory.\nThe default is \"\" which means to use the node's default medium.\nMust be an empty string (default) or Memory.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", "type": [ "string", "null" ] }, "sizeLimit": { "description": "sizeLimit is the total amount of local storage required for this EmptyDir volume.\nThe size limit is also applicable for memory medium.\nThe maximum usage on memory medium EmptyDir would be the minimum value between\nthe SizeLimit specified here and the sum of memory limits of all containers in a pod.\nThe default is nil which means that the limit is undefined.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" }, { "type": "null" } ], "x-kubernetes-int-or-string": true } }, "type": [ "object", "null" ] }, "ephemeral": { "additionalProperties": false, "description": "ephemeral represents a volume that is handled by a cluster storage driver.\nThe volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,\nand deleted when the pod is removed.\n\nUse this if:\na) the volume is only needed while the pod runs,\nb) features of normal volumes like restoring from snapshot or capacity\n tracking are needed,\nc) the storage driver is specified through a storage class, and\nd) the storage driver supports dynamic volume provisioning through\n a PersistentVolumeClaim (see EphemeralVolumeSource for more\n information on the connection between this volume type\n and PersistentVolumeClaim).\n\nUse PersistentVolumeClaim or one of the vendor-specific\nAPIs for volumes that persist for longer than the lifecycle\nof an individual pod.\n\nUse CSI for light-weight local ephemeral volumes if the CSI driver is meant to\nbe used that way - see the documentation of the driver for\nmore information.\n\nA pod can use both types of ephemeral volumes and\npersistent volumes at the same time.", "properties": { "volumeClaimTemplate": { "additionalProperties": false, "description": "Will be used to create a stand-alone PVC to provision the volume.\nThe pod in which this EphemeralVolumeSource is embedded will be the\nowner of the PVC, i.e. the PVC will be deleted together with the\npod. The name of the PVC will be `\u003cpod name\u003e-\u003cvolume name\u003e` where\n`\u003cvolume name\u003e` is the name from the `PodSpec.Volumes` array\nentry. Pod validation will reject the pod if the concatenated name\nis not valid for a PVC (for example, too long).\n\nAn existing PVC with that name that is not owned by the pod\nwill *not* be used for the pod to avoid using an unrelated\nvolume by mistake. Starting the pod is then blocked until\nthe unrelated PVC is removed. If such a pre-created PVC is\nmeant to be used by the pod, the PVC has to updated with an\nowner reference to the pod once the pod exists. Normally\nthis should not be necessary, but it may be useful when\nmanually reconstructing a broken cluster.\n\nThis field is read-only and no changes will be made by Kubernetes\nto the PVC after it has been created.\n\nRequired, must not be nil.", "properties": { "metadata": { "description": "May contain labels and annotations that will be copied into the PVC\nwhen creating it. No other fields are allowed and will be rejected during\nvalidation.", "type": [ "object", "null" ] }, "spec": { "additionalProperties": false, "description": "The specification for the PersistentVolumeClaim. The entire content is\ncopied unchanged into the PVC that gets created from this\ntemplate. The same fields as in a PersistentVolumeClaim\nare also valid here.", "properties": { "accessModes": { "description": "accessModes contains the desired access modes the volume should have.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "dataSource": { "additionalProperties": false, "description": "dataSource field can be used to specify either:\n* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)\n* An existing PVC (PersistentVolumeClaim)\nIf the provisioner or an external controller can support the specified data source,\nit will create a new volume based on the contents of the specified data source.\nWhen the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,\nand dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.\nIf the namespace is specified, then dataSourceRef will not be copied to dataSource.", "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.", "type": [ "string", "null" ] }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" } }, "required": [ "kind", "name" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "dataSourceRef": { "additionalProperties": false, "description": "dataSourceRef specifies the object from which to populate the volume with data, if a non-empty\nvolume is desired. This may be any object from a non-empty API group (non\ncore object) or a PersistentVolumeClaim object.\nWhen this field is specified, volume binding will only succeed if the type of\nthe specified object matches some installed volume populator or dynamic\nprovisioner.\nThis field will replace the functionality of the dataSource field and as such\nif both fields are non-empty, they must have the same value. For backwards\ncompatibility, when namespace isn't specified in dataSourceRef,\nboth fields (dataSource and dataSourceRef) will be set to the same\nvalue automatically if one of them is empty and the other is non-empty.\nWhen namespace is specified in dataSourceRef,\ndataSource isn't set to the same value and must be empty.\nThere are three important differences between dataSource and dataSourceRef:\n* While dataSource only allows two specific types of objects, dataSourceRef\n allows any non-core object, as well as PersistentVolumeClaim objects.\n* While dataSource ignores disallowed values (dropping them), dataSourceRef\n preserves all values, and generates an error if a disallowed value is\n specified.\n* While dataSource only allows local objects, dataSourceRef allows objects\n in any namespaces.\n(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.\n(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.", "properties": { "apiGroup": { "description": "APIGroup is the group for the resource being referenced.\nIf APIGroup is not specified, the specified Kind must be in the core API group.\nFor any other third-party types, APIGroup is required.", "type": [ "string", "null" ] }, "kind": { "description": "Kind is the type of resource being referenced", "type": "string" }, "name": { "description": "Name is the name of resource being referenced", "type": "string" }, "namespace": { "description": "Namespace is the namespace of resource being referenced\nNote that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details.\n(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.", "type": [ "string", "null" ] } }, "required": [ "kind", "name" ], "type": [ "object", "null" ] }, "resources": { "additionalProperties": false, "description": "resources represents the minimum resources the volume should have.\nIf RecoverVolumeExpansionFailure feature is enabled users are allowed to specify resource requirements\nthat are lower than previous value but must still be higher than capacity recorded in the\nstatus field of the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources", "properties": { "limits": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Limits describes the maximum amount of compute resources allowed.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] }, "requests": { "additionalProperties": { "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" } ], "x-kubernetes-int-or-string": true }, "description": "Requests describes the minimum amount of compute resources required.\nIf Requests is omitted for a container, it defaults to Limits if that is explicitly specified,\notherwise to an implementation-defined value. Requests cannot exceed Limits.\nMore info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/", "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "selector": { "additionalProperties": false, "description": "selector is a label query over volumes to consider for binding.", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "storageClassName": { "description": "storageClassName is the name of the StorageClass required by the claim.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1", "type": [ "string", "null" ] }, "volumeAttributesClassName": { "description": "volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.\nIf specified, the CSI driver will create or update the volume with the attributes defined\nin the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,\nit can be changed after the claim is created. An empty string value means that no VolumeAttributesClass\nwill be applied to the claim but it's not allowed to reset this field to empty string once it is set.\nIf unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass\nwill be set by the persistentvolume controller if it exists.\nIf the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be\nset to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource\nexists.\nMore info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/\n(Beta) Using this field requires the VolumeAttributesClass feature gate to be enabled (off by default).", "type": [ "string", "null" ] }, "volumeMode": { "description": "volumeMode defines what type of volume is required by the claim.\nValue of Filesystem is implied when not included in claim spec.", "type": [ "string", "null" ] }, "volumeName": { "description": "volumeName is the binding reference to the PersistentVolume backing this claim.", "type": [ "string", "null" ] } }, "type": "object" } }, "required": [ "spec" ], "type": [ "object", "null" ] } }, "type": [ "object", "null" ] }, "fc": { "additionalProperties": false, "description": "fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.", "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": [ "string", "null" ] }, "lun": { "description": "lun is Optional: FC target lun number", "format": "int32", "type": [ "integer", "null" ] }, "readOnly": { "description": "readOnly is Optional: Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.", "type": [ "boolean", "null" ] }, "targetWWNs": { "description": "targetWWNs is Optional: FC target worldwide names (WWNs)", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "wwids": { "description": "wwids Optional: FC volume world wide identifiers (wwids)\nEither wwids or combination of targetWWNs and lun must be set, but not both simultaneously.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "flexVolume": { "additionalProperties": false, "description": "flexVolume represents a generic volume resource that is\nprovisioned/attached using an exec based plugin.\nDeprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.", "properties": { "driver": { "description": "driver is the name of the driver to use for this volume.", "type": "string" }, "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". The default filesystem depends on FlexVolume script.", "type": [ "string", "null" ] }, "options": { "additionalProperties": { "type": "string" }, "description": "options is Optional: this field holds extra command options if any.", "type": [ "object", "null" ] }, "readOnly": { "description": "readOnly is Optional: defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.", "type": [ "boolean", "null" ] }, "secretRef": { "additionalProperties": false, "description": "secretRef is Optional: secretRef is reference to the secret object containing\nsensitive information to pass to the plugin scripts. This may be\nempty if no secret object is specified. If the secret object\ncontains more than one secret, all secrets are passed to the plugin\nscripts.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "required": [ "driver" ], "type": [ "object", "null" ] }, "flocker": { "additionalProperties": false, "description": "flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running.\nDeprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.", "properties": { "datasetName": { "description": "datasetName is Name of the dataset stored as metadata -\u003e name on the dataset for Flocker\nshould be considered as deprecated", "type": [ "string", "null" ] }, "datasetUUID": { "description": "datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "gcePersistentDisk": { "additionalProperties": false, "description": "gcePersistentDisk represents a GCE Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nDeprecated: GCEPersistentDisk is deprecated. All operations for the in-tree\ngcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "properties": { "fsType": { "description": "fsType is filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "type": [ "string", "null" ] }, "partition": { "description": "partition is the partition in the volume that you want to mount.\nIf omitted, the default is to mount by volume name.\nExamples: For volume /dev/sda1, you specify the partition as \"1\".\nSimilarly, the volume partition for /dev/sda is \"0\" (or you can leave the property empty).\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "format": "int32", "type": [ "integer", "null" ] }, "pdName": { "description": "pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "type": "string" }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk", "type": [ "boolean", "null" ] } }, "required": [ "pdName" ], "type": [ "object", "null" ] }, "gitRepo": { "additionalProperties": false, "description": "gitRepo represents a git repository at a particular revision.\nDeprecated: GitRepo is deprecated. To provision a container with a git repo, mount an\nEmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir\ninto the Pod's container.", "properties": { "directory": { "description": "directory is the target directory name.\nMust not contain or start with '..'. If '.' is supplied, the volume directory will be the\ngit repository. Otherwise, if specified, the volume will contain the git repository in\nthe subdirectory with the given name.", "type": [ "string", "null" ] }, "repository": { "description": "repository is the URL", "type": "string" }, "revision": { "description": "revision is the commit hash for the specified revision.", "type": [ "string", "null" ] } }, "required": [ "repository" ], "type": [ "object", "null" ] }, "glusterfs": { "additionalProperties": false, "description": "glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.\nDeprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md", "properties": { "endpoints": { "description": "endpoints is the endpoint name that details Glusterfs topology.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "type": "string" }, "path": { "description": "path is the Glusterfs volume path.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "type": "string" }, "readOnly": { "description": "readOnly here will force the Glusterfs volume to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod", "type": [ "boolean", "null" ] } }, "required": [ "endpoints", "path" ], "type": [ "object", "null" ] }, "hostPath": { "additionalProperties": false, "description": "hostPath represents a pre-existing file or directory on the host\nmachine that is directly exposed to the container. This is generally\nused for system agents or other privileged things that are allowed\nto see the host machine. Most containers will NOT need this.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath", "properties": { "path": { "description": "path of the directory on the host.\nIf the path is a symlink, it will follow the link to the real path.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath", "type": "string" }, "type": { "description": "type for HostPath Volume\nDefaults to \"\"\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath", "type": [ "string", "null" ] } }, "required": [ "path" ], "type": [ "object", "null" ] }, "image": { "additionalProperties": false, "description": "image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine.\nThe volume is resolved at pod startup depending on which PullPolicy value is provided:\n\n- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.\n- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.\n- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.\n\nThe volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation.\nA failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message.\nThe 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.\nThe 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.\nThe volume will be mounted read-only (ro) and non-executable files (noexec).\nSub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33.\nThe field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.", "properties": { "pullPolicy": { "description": "Policy for pulling OCI objects. Possible values are:\nAlways: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.\nNever: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.\nIfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.\nDefaults to Always if :latest tag is specified, or IfNotPresent otherwise.", "type": [ "string", "null" ] }, "reference": { "description": "Required: Image or artifact reference to be used.\nBehaves in the same way as pod.spec.containers[*].image.\nPull secrets will be assembled in the same way as for the container image by looking up node credentials, SA image pull secrets, and pod spec image pull secrets.\nMore info: https://kubernetes.io/docs/concepts/containers/images\nThis field is optional to allow higher level config management to default or override\ncontainer images in workload controllers like Deployments and StatefulSets.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "iscsi": { "additionalProperties": false, "description": "iscsi represents an ISCSI Disk resource that is attached to a\nkubelet's host machine and then exposed to the pod.\nMore info: https://examples.k8s.io/volumes/iscsi/README.md", "properties": { "chapAuthDiscovery": { "description": "chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication", "type": [ "boolean", "null" ] }, "chapAuthSession": { "description": "chapAuthSession defines whether support iSCSI Session CHAP authentication", "type": [ "boolean", "null" ] }, "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi", "type": [ "string", "null" ] }, "initiatorName": { "description": "initiatorName is the custom iSCSI Initiator Name.\nIf initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface\n\u003ctarget portal\u003e:\u003cvolume name\u003e will be created for the connection.", "type": [ "string", "null" ] }, "iqn": { "description": "iqn is the target iSCSI Qualified Name.", "type": "string" }, "iscsiInterface": { "default": "default", "description": "iscsiInterface is the interface Name that uses an iSCSI transport.\nDefaults to 'default' (tcp).", "type": [ "string", "null" ] }, "lun": { "description": "lun represents iSCSI Target Lun number.", "format": "int32", "type": "integer" }, "portals": { "description": "portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.", "type": [ "boolean", "null" ] }, "secretRef": { "additionalProperties": false, "description": "secretRef is the CHAP Secret for iSCSI target and initiator authentication", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "targetPortal": { "description": "targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port\nis other than default (typically TCP ports 860 and 3260).", "type": "string" } }, "required": [ "iqn", "lun", "targetPortal" ], "type": [ "object", "null" ] }, "name": { "description": "name of the volume.\nMust be a DNS_LABEL and unique within the pod.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": "string" }, "nfs": { "additionalProperties": false, "description": "nfs represents an NFS mount on the host that shares a pod's lifetime\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "properties": { "path": { "description": "path that is exported by the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "type": "string" }, "readOnly": { "description": "readOnly here will force the NFS export to be mounted with read-only permissions.\nDefaults to false.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "type": [ "boolean", "null" ] }, "server": { "description": "server is the hostname or IP address of the NFS server.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#nfs", "type": "string" } }, "required": [ "path", "server" ], "type": [ "object", "null" ] }, "persistentVolumeClaim": { "additionalProperties": false, "description": "persistentVolumeClaimVolumeSource represents a reference to a\nPersistentVolumeClaim in the same namespace.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "properties": { "claimName": { "description": "claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims", "type": "string" }, "readOnly": { "description": "readOnly Will force the ReadOnly setting in VolumeMounts.\nDefault false.", "type": [ "boolean", "null" ] } }, "required": [ "claimName" ], "type": [ "object", "null" ] }, "photonPersistentDisk": { "additionalProperties": false, "description": "photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.\nDeprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.", "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": [ "string", "null" ] }, "pdID": { "description": "pdID is the ID that identifies Photon Controller persistent disk", "type": "string" } }, "required": [ "pdID" ], "type": [ "object", "null" ] }, "portworxVolume": { "additionalProperties": false, "description": "portworxVolume represents a portworx volume attached and mounted on kubelets host machine.\nDeprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type\nare redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate\nis on.", "properties": { "fsType": { "description": "fSType represents the filesystem type to mount\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": [ "string", "null" ] }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.", "type": [ "boolean", "null" ] }, "volumeID": { "description": "volumeID uniquely identifies a Portworx volume", "type": "string" } }, "required": [ "volumeID" ], "type": [ "object", "null" ] }, "projected": { "additionalProperties": false, "description": "projected items for all in one resources secrets, configmaps, and downward API", "properties": { "defaultMode": { "description": "defaultMode are the mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.", "format": "int32", "type": [ "integer", "null" ] }, "sources": { "description": "sources is the list of volume projections. Each entry in this list\nhandles one source.", "items": { "additionalProperties": false, "description": "Projection that may be projected along with other supported volume types.\nExactly one of these fields must be set.", "properties": { "clusterTrustBundle": { "additionalProperties": false, "description": "ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field\nof ClusterTrustBundle objects in an auto-updating file.\n\nAlpha, gated by the ClusterTrustBundleProjection feature gate.\n\nClusterTrustBundle objects can either be selected by name, or by the\ncombination of signer name and a label selector.\n\nKubelet performs aggressive normalization of the PEM contents written\ninto the pod filesystem. Esoteric PEM features such as inter-block\ncomments and block headers are stripped. Certificates are deduplicated.\nThe ordering of certificates within the file is arbitrary, and Kubelet\nmay change the order over time.", "properties": { "labelSelector": { "additionalProperties": false, "description": "Select all ClusterTrustBundles that match this label selector. Only has\neffect if signerName is set. Mutually-exclusive with name. If unset,\ninterpreted as \"match nothing\". If set but empty, interpreted as \"match\neverything\".", "properties": { "matchExpressions": { "description": "matchExpressions is a list of label selector requirements. The requirements are ANDed.", "items": { "additionalProperties": false, "description": "A label selector requirement is a selector that contains values, a key, and an operator that\nrelates the key and values.", "properties": { "key": { "description": "key is the label key that the selector applies to.", "type": "string" }, "operator": { "description": "operator represents a key's relationship to a set of values.\nValid operators are In, NotIn, Exists and DoesNotExist.", "type": "string" }, "values": { "description": "values is an array of string values. If the operator is In or NotIn,\nthe values array must be non-empty. If the operator is Exists or DoesNotExist,\nthe values array must be empty. This array is replaced during a strategic\nmerge patch.", "items": { "type": "string" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "required": [ "key", "operator" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "matchLabels": { "additionalProperties": { "type": "string" }, "description": "matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels\nmap is equivalent to an element of matchExpressions, whose key field is \"key\", the\noperator is \"In\", and the values array contains only \"value\". The requirements are ANDed.", "type": [ "object", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "name": { "description": "Select a single ClusterTrustBundle by object name. Mutually-exclusive\nwith signerName and labelSelector.", "type": [ "string", "null" ] }, "optional": { "description": "If true, don't block pod startup if the referenced ClusterTrustBundle(s)\naren't available. If using name, then the named ClusterTrustBundle is\nallowed not to exist. If using signerName, then the combination of\nsignerName and labelSelector is allowed to match zero\nClusterTrustBundles.", "type": [ "boolean", "null" ] }, "path": { "description": "Relative path from the volume root to write the bundle.", "type": "string" }, "signerName": { "description": "Select all ClusterTrustBundles that match this signer name.\nMutually-exclusive with name. The contents of all selected\nClusterTrustBundles will be unified and deduplicated.", "type": [ "string", "null" ] } }, "required": [ "path" ], "type": [ "object", "null" ] }, "configMap": { "additionalProperties": false, "description": "configMap information about the configMap data to project", "properties": { "items": { "description": "items if unspecified, each key-value pair in the Data field of the referenced\nConfigMap will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the ConfigMap,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.", "items": { "additionalProperties": false, "description": "Maps a string key to a path within a volume.", "properties": { "key": { "description": "key is the key to project.", "type": "string" }, "mode": { "description": "mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.", "format": "int32", "type": [ "integer", "null" ] }, "path": { "description": "path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'.", "type": "string" } }, "required": [ "key", "path" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "optional specify whether the ConfigMap or its keys must be defined", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "downwardAPI": { "additionalProperties": false, "description": "downwardAPI information about the downwardAPI data to project", "properties": { "items": { "description": "Items is a list of DownwardAPIVolume file", "items": { "additionalProperties": false, "description": "DownwardAPIVolumeFile represents information to create the file containing the pod field", "properties": { "fieldRef": { "additionalProperties": false, "description": "Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.", "properties": { "apiVersion": { "description": "Version of the schema the FieldPath is written in terms of, defaults to \"v1\".", "type": [ "string", "null" ] }, "fieldPath": { "description": "Path of the field to select in the specified API version.", "type": "string" } }, "required": [ "fieldPath" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "mode": { "description": "Optional: mode bits used to set permissions on this file, must be an octal value\nbetween 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.", "format": "int32", "type": [ "integer", "null" ] }, "path": { "description": "Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'", "type": "string" }, "resourceFieldRef": { "additionalProperties": false, "description": "Selects a resource of the container: only resources limits and requests\n(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.", "properties": { "containerName": { "description": "Container name: required for volumes, optional for env vars", "type": [ "string", "null" ] }, "divisor": { "description": "Specifies the output format of the exposed resources, defaults to \"1\"", "oneOf": [ { "pattern": "^(\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\\+|-)?(([0-9]+(\\.[0-9]*)?)|(\\.[0-9]+))))?$", "type": "string" }, { "type": "integer" }, { "type": "null" } ], "x-kubernetes-int-or-string": true }, "resource": { "description": "Required: resource to select", "type": "string" } }, "required": [ "resource" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "required": [ "path" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "secret": { "additionalProperties": false, "description": "secret information about the secret data to project", "properties": { "items": { "description": "items if unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.", "items": { "additionalProperties": false, "description": "Maps a string key to a path within a volume.", "properties": { "key": { "description": "key is the key to project.", "type": "string" }, "mode": { "description": "mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.", "format": "int32", "type": [ "integer", "null" ] }, "path": { "description": "path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'.", "type": "string" } }, "required": [ "key", "path" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "optional field specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "serviceAccountToken": { "additionalProperties": false, "description": "serviceAccountToken is information about the serviceAccountToken data to project", "properties": { "audience": { "description": "audience is the intended audience of the token. A recipient of a token\nmust identify itself with an identifier specified in the audience of the\ntoken, and otherwise should reject the token. The audience defaults to the\nidentifier of the apiserver.", "type": [ "string", "null" ] }, "expirationSeconds": { "description": "expirationSeconds is the requested duration of validity of the service\naccount token. As the token approaches expiration, the kubelet volume\nplugin will proactively rotate the service account token. The kubelet will\nstart trying to rotate the token if the token is older than 80 percent of\nits time to live or if the token is older than 24 hours.Defaults to 1 hour\nand must be at least 10 minutes.", "format": "int64", "type": [ "integer", "null" ] }, "path": { "description": "path is the path relative to the mount point of the file to project the\ntoken into.", "type": "string" } }, "required": [ "path" ], "type": [ "object", "null" ] } }, "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" } }, "type": [ "object", "null" ] }, "quobyte": { "additionalProperties": false, "description": "quobyte represents a Quobyte mount on the host that shares a pod's lifetime.\nDeprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.", "properties": { "group": { "description": "group to map volume access to\nDefault is no group", "type": [ "string", "null" ] }, "readOnly": { "description": "readOnly here will force the Quobyte volume to be mounted with read-only permissions.\nDefaults to false.", "type": [ "boolean", "null" ] }, "registry": { "description": "registry represents a single or multiple Quobyte Registry services\nspecified as a string as host:port pair (multiple entries are separated with commas)\nwhich acts as the central registry for volumes", "type": "string" }, "tenant": { "description": "tenant owning the given Quobyte volume in the Backend\nUsed with dynamically provisioned Quobyte volumes, value is set by the plugin", "type": [ "string", "null" ] }, "user": { "description": "user to map volume access to\nDefaults to serivceaccount user", "type": [ "string", "null" ] }, "volume": { "description": "volume is a string that references an already created Quobyte volume by name.", "type": "string" } }, "required": [ "registry", "volume" ], "type": [ "object", "null" ] }, "rbd": { "additionalProperties": false, "description": "rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.\nDeprecated: RBD is deprecated and the in-tree rbd type is no longer supported.\nMore info: https://examples.k8s.io/volumes/rbd/README.md", "properties": { "fsType": { "description": "fsType is the filesystem type of the volume that you want to mount.\nTip: Ensure that the filesystem type is supported by the host operating system.\nExamples: \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#rbd", "type": [ "string", "null" ] }, "image": { "description": "image is the rados image name.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": "string" }, "keyring": { "default": "/etc/ceph/keyring", "description": "keyring is the path to key ring for RBDUser.\nDefault is /etc/ceph/keyring.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": [ "string", "null" ] }, "monitors": { "description": "monitors is a collection of Ceph monitors.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "items": { "type": "string" }, "type": "array", "x-kubernetes-list-type": "atomic" }, "pool": { "default": "rbd", "description": "pool is the rados pool name.\nDefault is rbd.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": [ "string", "null" ] }, "readOnly": { "description": "readOnly here will force the ReadOnly setting in VolumeMounts.\nDefaults to false.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": [ "boolean", "null" ] }, "secretRef": { "additionalProperties": false, "description": "secretRef is name of the authentication secret for RBDUser. If provided\noverrides keyring.\nDefault is nil.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "user": { "default": "admin", "description": "user is the rados user name.\nDefault is admin.\nMore info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it", "type": [ "string", "null" ] } }, "required": [ "image", "monitors" ], "type": [ "object", "null" ] }, "scaleIO": { "additionalProperties": false, "description": "scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.\nDeprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.", "properties": { "fsType": { "default": "xfs", "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\".\nDefault is \"xfs\".", "type": [ "string", "null" ] }, "gateway": { "description": "gateway is the host address of the ScaleIO API Gateway.", "type": "string" }, "protectionDomain": { "description": "protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.", "type": [ "string", "null" ] }, "readOnly": { "description": "readOnly Defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.", "type": [ "boolean", "null" ] }, "secretRef": { "additionalProperties": false, "description": "secretRef references to the secret for ScaleIO user and other\nsensitive information. If this is not provided, Login operation will fail.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": "object", "x-kubernetes-map-type": "atomic" }, "sslEnabled": { "description": "sslEnabled Flag enable/disable SSL communication with Gateway, default false", "type": [ "boolean", "null" ] }, "storageMode": { "default": "ThinProvisioned", "description": "storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.\nDefault is ThinProvisioned.", "type": [ "string", "null" ] }, "storagePool": { "description": "storagePool is the ScaleIO Storage Pool associated with the protection domain.", "type": [ "string", "null" ] }, "system": { "description": "system is the name of the storage system as configured in ScaleIO.", "type": "string" }, "volumeName": { "description": "volumeName is the name of a volume already created in the ScaleIO system\nthat is associated with this volume source.", "type": [ "string", "null" ] } }, "required": [ "gateway", "secretRef", "system" ], "type": [ "object", "null" ] }, "secret": { "additionalProperties": false, "description": "secret represents a secret that should populate this volume.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret", "properties": { "defaultMode": { "description": "defaultMode is Optional: mode bits used to set permissions on created files by default.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values\nfor mode bits. Defaults to 0644.\nDirectories within the path are not affected by this setting.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.", "format": "int32", "type": [ "integer", "null" ] }, "items": { "description": "items If unspecified, each key-value pair in the Data field of the referenced\nSecret will be projected into the volume as a file whose name is the\nkey and content is the value. If specified, the listed keys will be\nprojected into the specified paths, and unlisted keys will not be\npresent. If a key is specified which is not present in the Secret,\nthe volume setup will error unless it is marked optional. Paths must be\nrelative and may not contain the '..' path or start with '..'.", "items": { "additionalProperties": false, "description": "Maps a string key to a path within a volume.", "properties": { "key": { "description": "key is the key to project.", "type": "string" }, "mode": { "description": "mode is Optional: mode bits used to set permissions on this file.\nMust be an octal value between 0000 and 0777 or a decimal value between 0 and 511.\nYAML accepts both octal and decimal values, JSON requires decimal values for mode bits.\nIf not specified, the volume defaultMode will be used.\nThis might be in conflict with other options that affect the file\nmode, like fsGroup, and the result can be other mode bits set.", "format": "int32", "type": [ "integer", "null" ] }, "path": { "description": "path is the relative path of the file to map the key to.\nMay not be an absolute path.\nMay not contain the path element '..'.\nMay not start with the string '..'.", "type": "string" } }, "required": [ "key", "path" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-type": "atomic" }, "optional": { "description": "optional field specify whether the Secret or its keys must be defined", "type": [ "boolean", "null" ] }, "secretName": { "description": "secretName is the name of the secret in the pod's namespace to use.\nMore info: https://kubernetes.io/docs/concepts/storage/volumes#secret", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "storageos": { "additionalProperties": false, "description": "storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.\nDeprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.", "properties": { "fsType": { "description": "fsType is the filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": [ "string", "null" ] }, "readOnly": { "description": "readOnly defaults to false (read/write). ReadOnly here will force\nthe ReadOnly setting in VolumeMounts.", "type": [ "boolean", "null" ] }, "secretRef": { "additionalProperties": false, "description": "secretRef specifies the secret to use for obtaining the StorageOS API\ncredentials. If not specified, default values will be attempted.", "properties": { "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] } }, "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "volumeName": { "description": "volumeName is the human-readable name of the StorageOS volume. Volume\nnames are only unique within a namespace.", "type": [ "string", "null" ] }, "volumeNamespace": { "description": "volumeNamespace specifies the scope of the volume within StorageOS. If no\nnamespace is specified then the Pod's namespace will be used. This allows the\nKubernetes name scoping to be mirrored within StorageOS for tighter integration.\nSet VolumeName to any name to override the default behaviour.\nSet to \"default\" if you are not using namespaces within StorageOS.\nNamespaces that do not pre-exist within StorageOS will be created.", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "vsphereVolume": { "additionalProperties": false, "description": "vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.\nDeprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type\nare redirected to the csi.vsphere.vmware.com CSI driver.", "properties": { "fsType": { "description": "fsType is filesystem type to mount.\nMust be a filesystem type supported by the host operating system.\nEx. \"ext4\", \"xfs\", \"ntfs\". Implicitly inferred to be \"ext4\" if unspecified.", "type": [ "string", "null" ] }, "storagePolicyID": { "description": "storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.", "type": [ "string", "null" ] }, "storagePolicyName": { "description": "storagePolicyName is the storage Policy Based Management (SPBM) profile name.", "type": [ "string", "null" ] }, "volumePath": { "description": "volumePath is the path that identifies vSphere volume vmdk", "type": "string" } }, "required": [ "volumePath" ], "type": [ "object", "null" ] } }, "required": [ "name" ], "type": "object" }, "type": [ "array", "null" ] }, "walCompression": { "description": "Configures compression of the write-ahead log (WAL) using Snappy.\n\nWAL compression is enabled by default for Prometheus \u003e= 2.20.0\n\nRequires Prometheus v2.11.0 and above.", "type": [ "boolean", "null" ] }, "web": { "additionalProperties": false, "description": "Defines the configuration of the Prometheus web server.", "properties": { "httpConfig": { "additionalProperties": false, "description": "Defines HTTP parameters for web server.", "properties": { "headers": { "additionalProperties": false, "description": "List of headers that can be added to HTTP responses.", "properties": { "contentSecurityPolicy": { "description": "Set the Content-Security-Policy header to HTTP responses.\nUnset if blank.", "type": [ "string", "null" ] }, "strictTransportSecurity": { "description": "Set the Strict-Transport-Security header to HTTP responses.\nUnset if blank.\nPlease make sure that you use this with care as this header might force\nbrowsers to load Prometheus and the other applications hosted on the same\ndomain and subdomains over HTTPS.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security", "type": [ "string", "null" ] }, "xContentTypeOptions": { "description": "Set the X-Content-Type-Options header to HTTP responses.\nUnset if blank. Accepted value is nosniff.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options", "enum": [ "", "NoSniff" ], "type": [ "string", "null" ] }, "xFrameOptions": { "description": "Set the X-Frame-Options header to HTTP responses.\nUnset if blank. Accepted values are deny and sameorigin.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options", "enum": [ "", "Deny", "SameOrigin" ], "type": [ "string", "null" ] }, "xXSSProtection": { "description": "Set the X-XSS-Protection header to all responses.\nUnset if blank.\nhttps://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection", "type": [ "string", "null" ] } }, "type": [ "object", "null" ] }, "http2": { "description": "Enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.\nWhen TLSConfig is not configured, HTTP/2 will be disabled.\nWhenever the value of the field changes, a rolling update will be triggered.", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] }, "maxConnections": { "description": "Defines the maximum number of simultaneous connections\nA zero value means that Prometheus doesn't accept any incoming connection.", "format": "int32", "minimum": 0, "type": [ "integer", "null" ] }, "pageTitle": { "description": "The prometheus web page title.", "type": [ "string", "null" ] }, "tlsConfig": { "additionalProperties": false, "description": "Defines the TLS parameters for HTTPS.", "properties": { "cert": { "additionalProperties": false, "description": "Secret or ConfigMap containing the TLS certificate for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `certFile`.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "certFile": { "description": "Path to the TLS certificate file in the container for the web server.\n\nEither `keySecret` or `keyFile` must be defined.\n\nIt is mutually exclusive with `cert`.", "type": [ "string", "null" ] }, "cipherSuites": { "description": "List of supported cipher suites for TLS versions up to TLS 1.2.\n\nIf not defined, the Go default cipher suites are used.\nAvailable cipher suites are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#pkg-constants", "items": { "type": "string" }, "type": [ "array", "null" ] }, "clientAuthType": { "description": "The server policy for client TLS authentication.\n\nFor more detail on clientAuth options:\nhttps://golang.org/pkg/crypto/tls/#ClientAuthType", "type": [ "string", "null" ] }, "clientCAFile": { "description": "Path to the CA certificate file for client certificate authentication to\nthe server.\n\nIt is mutually exclusive with `client_ca`.", "type": [ "string", "null" ] }, "client_ca": { "additionalProperties": false, "description": "Secret or ConfigMap containing the CA certificate for client certificate\nauthentication to the server.\n\nIt is mutually exclusive with `clientCAFile`.", "properties": { "configMap": { "additionalProperties": false, "description": "ConfigMap containing data to use for the targets.", "properties": { "key": { "description": "The key to select.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the ConfigMap or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "secret": { "additionalProperties": false, "description": "Secret containing data to use for the targets.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" } }, "type": [ "object", "null" ] }, "curvePreferences": { "description": "Elliptic curves that will be used in an ECDHE handshake, in preference\norder.\n\nAvailable curves are documented in the Go documentation:\nhttps://golang.org/pkg/crypto/tls/#CurveID", "items": { "type": "string" }, "type": [ "array", "null" ] }, "keyFile": { "description": "Path to the TLS private key file in the container for the web server.\n\nIf defined, either `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keySecret`.", "type": [ "string", "null" ] }, "keySecret": { "additionalProperties": false, "description": "Secret containing the TLS private key for the web server.\n\nEither `cert` or `certFile` must be defined.\n\nIt is mutually exclusive with `keyFile`.", "properties": { "key": { "description": "The key of the secret to select from. Must be a valid secret key.", "type": "string" }, "name": { "default": "", "description": "Name of the referent.\nThis field is effectively required, but due to backwards compatibility is\nallowed to be empty. Instances of this type with an empty value here are\nalmost certainly wrong.\nMore info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names", "type": [ "string", "null" ] }, "optional": { "description": "Specify whether the Secret or its key must be defined", "type": [ "boolean", "null" ] } }, "required": [ "key" ], "type": [ "object", "null" ], "x-kubernetes-map-type": "atomic" }, "maxVersion": { "description": "Maximum TLS version that is acceptable.", "type": [ "string", "null" ] }, "minVersion": { "description": "Minimum TLS version that is acceptable.", "type": [ "string", "null" ] }, "preferServerCipherSuites": { "description": "Controls whether the server selects the client's most preferred cipher\nsuite, or the server's most preferred cipher suite.\n\nIf true then the server's preference, as expressed in\nthe order of elements in cipherSuites, is used.", "type": [ "boolean", "null" ] } }, "type": [ "object", "null" ] } }, "type": [ "object", "null" ] } }, "type": "object" }, "status": { "additionalProperties": false, "description": "Most recent observed status of the Prometheus cluster. Read-only.\nMore info:\nhttps://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status", "properties": { "availableReplicas": { "description": "Total number of available pods (ready for at least minReadySeconds)\ntargeted by this Prometheus deployment.", "format": "int32", "type": "integer" }, "conditions": { "description": "The current state of the Prometheus deployment.", "items": { "additionalProperties": false, "description": "Condition represents the state of the resources associated with the\nPrometheus, Alertmanager or ThanosRuler resource.", "properties": { "lastTransitionTime": { "description": "lastTransitionTime is the time of the last update to the current status property.", "format": "date-time", "type": "string" }, "message": { "description": "Human-readable message indicating details for the condition's last transition.", "type": [ "string", "null" ] }, "observedGeneration": { "description": "ObservedGeneration represents the .metadata.generation that the\ncondition was set based upon. For instance, if `.metadata.generation` is\ncurrently 12, but the `.status.conditions[].observedGeneration` is 9, the\ncondition is out of date with respect to the current state of the\ninstance.", "format": "int64", "type": [ "integer", "null" ] }, "reason": { "description": "Reason for the condition's last transition.", "type": [ "string", "null" ] }, "status": { "description": "Status of the condition.", "minLength": 1, "type": "string" }, "type": { "description": "Type of the condition being reported.", "minLength": 1, "type": "string" } }, "required": [ "lastTransitionTime", "status", "type" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "type" ], "x-kubernetes-list-type": "map" }, "paused": { "description": "Represents whether any actions on the underlying managed objects are\nbeing performed. Only delete actions will be performed.", "type": "boolean" }, "replicas": { "description": "Total number of non-terminated pods targeted by this Prometheus deployment\n(their labels match the selector).", "format": "int32", "type": "integer" }, "selector": { "description": "The selector used to match the pods targeted by this Prometheus resource.", "type": [ "string", "null" ] }, "shardStatuses": { "description": "The list has one entry per shard. Each entry provides a summary of the shard status.", "items": { "additionalProperties": false, "properties": { "availableReplicas": { "description": "Total number of available pods (ready for at least minReadySeconds)\ntargeted by this shard.", "format": "int32", "type": "integer" }, "replicas": { "description": "Total number of pods targeted by this shard.", "format": "int32", "type": "integer" }, "shardID": { "description": "Identifier of the shard.", "type": "string" }, "unavailableReplicas": { "description": "Total number of unavailable pods targeted by this shard.", "format": "int32", "type": "integer" }, "updatedReplicas": { "description": "Total number of non-terminated pods targeted by this shard\nthat have the desired spec.", "format": "int32", "type": "integer" } }, "required": [ "availableReplicas", "replicas", "shardID", "unavailableReplicas", "updatedReplicas" ], "type": "object" }, "type": [ "array", "null" ], "x-kubernetes-list-map-keys": [ "shardID" ], "x-kubernetes-list-type": "map" }, "shards": { "description": "Shards is the most recently observed number of shards.", "format": "int32", "type": [ "integer", "null" ] }, "unavailableReplicas": { "description": "Total number of unavailable pods targeted by this Prometheus deployment.", "format": "int32", "type": "integer" }, "updatedReplicas": { "description": "Total number of non-terminated pods targeted by this Prometheus deployment\nthat have the desired version spec.", "format": "int32", "type": "integer" } }, "required": [ "availableReplicas", "paused", "replicas", "unavailableReplicas", "updatedReplicas" ], "type": [ "object", "null" ] } }, "required": [ "spec" ], "type": "object" }