// Automatically generated by 'openshift-apidocs-gen'. Do not edit.
:_mod-docs-content-type: ASSEMBLY
[id="thanosruler-monitoring-coreos-com-v1"]
= ThanosRuler [monitoring.coreos.com/v1]
:toc: macro
:toc-title:

toc::[]


Description::
+
--
The `ThanosRuler` custom resource definition (CRD) defines a desired [Thanos Ruler](https://github.com/thanos-io/thanos/blob/main/docs/components/rule.md) setup to run in a Kubernetes cluster.

A `ThanosRuler` instance requires at least one compatible Prometheus API endpoint (either Thanos Querier or Prometheus services).

The resource defines via label and namespace selectors which `PrometheusRule` objects should be associated to the deployed Thanos Ruler instances.
--

Type::
  `object`

Required::
  - `spec`


== Specification

[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiVersion`
| `string`
| APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

| `kind`
| `string`
| Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

| `metadata`
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-ObjectMeta[`ObjectMeta`]
| Standard object's metadata. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

| `spec`
| `object`
| spec defines the specification of the desired behavior of the ThanosRuler cluster. More info:
https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

| `status`
| `object`
| status defines the most recent observed status of the ThanosRuler cluster. Read-only.
More info:
https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

|===
=== .spec
Description::
+
--
spec defines the specification of the desired behavior of the ThanosRuler cluster. More info:
https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `additionalArgs`
| `array`
| additionalArgs defines how to add additional arguments for the ThanosRuler container.
It is intended for e.g. activating hidden flags which are not supported by
the dedicated configuration options yet. The arguments are passed as-is to the
ThanosRuler container which may cause issues if they are invalid or not supported
by the given ThanosRuler version.
In case of an argument conflict (e.g. an argument which is already set by the
operator itself) or when providing an invalid argument the reconciliation will
fail and an error will be logged.

| `additionalArgs[]`
| `object`
| Argument as part of the AdditionalArgs list.

| `affinity`
| `object`
| affinity defines when specified, the pod's scheduling constraints.

| `alertDropLabels`
| `array (string)`
| alertDropLabels defines the label names which should be dropped in Thanos Ruler
alerts.

The replica label `thanos_ruler_replica` will always be dropped from the alerts.

| `alertQueryUrl`
| `string`
| alertQueryUrl defines how Thanos Ruler will set in the 'Source' field
of all alerts.
Maps to the '--alert.query-url' CLI arg.

| `alertRelabelConfigFile`
| `string`
| alertRelabelConfigFile defines the path to the alert relabeling configuration file.

Alert relabel configuration must have the form as specified in the
official Prometheus documentation:
https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs

The operator performs no validation of the configuration file.

This field takes precedence over `alertRelabelConfig`.

| `alertRelabelConfigs`
| `object`
| alertRelabelConfigs defines the alert relabeling in Thanos Ruler.

Alert relabel configuration must have the form as specified in the
official Prometheus documentation:
https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs

The operator performs no validation of the configuration.

`alertRelabelConfigFile` takes precedence over this field.

| `alertmanagersConfig`
| `object`
| alertmanagersConfig defines the list of Alertmanager endpoints to send alerts to.

The configuration format is defined at https://thanos.io/tip/components/rule.md/#alertmanager.

It requires Thanos >= v0.10.0.

The operator performs no validation of the configuration.

This field takes precedence over `alertmanagersUrl`.

| `alertmanagersUrl`
| `array (string)`
| alertmanagersUrl defines the list of Alertmanager endpoints to send alerts to.

For Thanos >= v0.10.0, it is recommended to use `alertmanagersConfig` instead.

`alertmanagersConfig` takes precedence over this field.

| `containers`
| `array`
| containers allows injecting additional containers or modifying operator
generated containers. This can be used to allow adding an authentication
proxy to the Pods or to change the behavior of an operator generated
container. Containers described here modify an operator generated
container if they share the same name and modifications are done via a
strategic merge patch.

The names of containers managed by the operator are:
* `thanos-ruler`
* `config-reloader`

Overriding containers which are managed by the operator require careful
testing, especially when upgrading to a new version of the operator.

| `containers[]`
| `object`
| A single application container that you want to run within a pod.

| `dnsConfig`
| `object`
| dnsConfig defines Defines the DNS configuration for the pods.

| `dnsPolicy`
| `string`
| dnsPolicy defines the DNS policy for the pods.

| `enableFeatures`
| `array (string)`
| enableFeatures defines how to setup Thanos Ruler feature flags. By default, no features are enabled.

Enabling features which are disabled by default is entirely outside the
scope of what the maintainers will support and by doing so, you accept
that this behaviour may break at any time without notice.

For more information see https://thanos.io/tip/components/rule.md/

It requires Thanos >= 0.39.0.

| `enableServiceLinks`
| `boolean`
| enableServiceLinks defines whether information about services should be injected into pod's environment variables

| `enforcedNamespaceLabel`
| `string`
| enforcedNamespaceLabel enforces adding a namespace label of origin for each alert
and metric that is user created. The label value will always be the namespace of the object that is
being created.

| `evaluationInterval`
| `string`
| evaluationInterval defines the interval between consecutive evaluations.

| `excludedFromEnforcement`
| `array`
| excludedFromEnforcement defines the list of references to PrometheusRule objects
to be excluded from enforcing a namespace label of origin.
Applies only if enforcedNamespaceLabel set to true.

| `excludedFromEnforcement[]`
| `object`
| ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.

| `externalPrefix`
| `string`
| externalPrefix defines the Thanos Ruler instances will be available under. This is
necessary to generate correct URLs. This is necessary if Thanos Ruler is not
served from root of a DNS name.

| `grpcServerTlsConfig`
| `object`
| grpcServerTlsConfig defines the gRPC server from which Thanos Querier reads
recorded rule data.

Note: Currently only the `minVersion`, `caFile`, `certFile`, and `keyFile` fields are supported.

| `hostAliases`
| `array`
| hostAliases defines pods' hostAliases configuration

| `hostAliases[]`
| `object`
| HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the
pod's hosts file.

| `hostUsers`
| `boolean`
| hostUsers supports the user space in Kubernetes.

More info: https://kubernetes.io/docs/tasks/configure-pod-container/user-namespaces/

The feature requires at least Kubernetes 1.28 with the `UserNamespacesSupport` feature gate enabled.
Starting Kubernetes 1.33, the feature is enabled by default.

| `image`
| `string`
| image defines Thanos container image URL.

| `imagePullPolicy`
| `string`
| imagePullPolicy defines for the 'thanos', 'init-config-reloader' and 'config-reloader' containers.
See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy for more details.

| `imagePullSecrets`
| `array`
| imagePullSecrets defines an optional list of references to secrets in the same namespace
to use for pulling thanos images from registries
see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod

| `imagePullSecrets[]`
| `object`
| LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.

| `initContainers`
| `array`
| initContainers allows injecting initContainers to the Pod definition.
Those can be used to e.g. fetch secrets for injection into the
configuration from external sources. Any errors during the execution of
an initContainer will lead to a restart of the Pod. More info:
https://kubernetes.io/docs/concepts/workloads/pods/init-containers/

| `initContainers[]`
| `object`
| A single application container that you want to run within a pod.

| `labels`
| `object (string)`
| labels defines the external label pairs of the ThanosRuler resource.

A default replica label `thanos_ruler_replica` will be always added as a
label with the value of the pod's name.

| `listenLocal`
| `boolean`
| listenLocal defines the Thanos ruler listen on loopback, so that it
does not bind against the Pod IP.

| `logFormat`
| `string`
| logFormat for ThanosRuler to be configured with.

| `logLevel`
| `string`
| logLevel for ThanosRuler to be configured with.

| `minReadySeconds`
| `integer`
| minReadySeconds defines the minimum number of seconds for which a newly created pod should be ready
without any of its container crashing for it to be considered available.

If unset, pods will be considered available as soon as they are ready.

| `nodeSelector`
| `object (string)`
| nodeSelector defines which Nodes the Pods are scheduled on.

| `objectStorageConfig`
| `object`
| objectStorageConfig defines the configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage

The operator performs no validation of the configuration.

`objectStorageConfigFile` takes precedence over this field.

| `objectStorageConfigFile`
| `string`
| objectStorageConfigFile defines the path of the object storage configuration file.

The configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage

The operator performs no validation of the configuration file.

This field takes precedence over `objectStorageConfig`.

| `paused`
| `boolean`
| paused defines when a ThanosRuler deployment is paused, no actions except for deletion
will be performed on the underlying objects.

| `podManagementPolicy`
| `string`
| podManagementPolicy defines the policy for creating/deleting pods when
scaling up and down.

Unlike the default StatefulSet behavior, the default policy is
`Parallel` to avoid manual intervention in case a pod gets stuck during
a rollout.

Note that updating this value implies the recreation of the StatefulSet
which incurs a service outage.

| `podMetadata`
| `object`
| podMetadata defines labels and annotations which are propagated to the ThanosRuler pods.

The following items are reserved and cannot be overridden:
* "app.kubernetes.io/name" label, set to "thanos-ruler".
* "app.kubernetes.io/managed-by" label, set to "prometheus-operator".
* "app.kubernetes.io/instance" label, set to the name of the ThanosRuler instance.
* "thanos-ruler" label, set to the name of the ThanosRuler instance.
* "kubectl.kubernetes.io/default-container" annotation, set to "thanos-ruler".

| `portName`
| `string`
| portName defines the port name used for the pods and governing service.
Defaults to `web`.

| `priorityClassName`
| `string`
| priorityClassName defines the priority class assigned to the Pods

| `prometheusRulesExcludedFromEnforce`
| `array`
| prometheusRulesExcludedFromEnforce defines a list of Prometheus rules to be excluded from enforcing
of adding namespace labels. Works only if enforcedNamespaceLabel set to true.
Make sure both ruleNamespace and ruleName are set for each pair
Deprecated: use excludedFromEnforcement instead.

| `prometheusRulesExcludedFromEnforce[]`
| `object`
| PrometheusRuleExcludeConfig enables users to configure excluded
PrometheusRule names and their namespaces to be ignored while enforcing
namespace label for alerts and metrics.

| `queryConfig`
| `object`
| queryConfig defines the list of Thanos Query endpoints from which to query metrics.

The configuration format is defined at https://thanos.io/tip/components/rule.md/#query-api

It requires Thanos >= v0.11.0.

The operator performs no validation of the configuration.

This field takes precedence over `queryEndpoints`.

| `queryEndpoints`
| `array (string)`
| queryEndpoints defines the list of Thanos Query endpoints from which to query metrics.

For Thanos >= v0.11.0, it is recommended to use `queryConfig` instead.

`queryConfig` takes precedence over this field.

| `remoteWrite`
| `array`
| remoteWrite defines the list of remote write configurations.

When the list isn't empty, the ruler is configured with stateless mode.

It requires Thanos >= 0.24.0.

| `remoteWrite[]`
| `object`
| RemoteWriteSpec defines the configuration to write samples from Prometheus
to a remote endpoint.

| `replicas`
| `integer`
| replicas defines the number of thanos ruler instances to deploy.

| `resendDelay`
| `string`
| resendDelay defines the minimum amount of time to wait before resending an alert to Alertmanager.

| `resources`
| `object`
| resources defines the resource requirements for single Pods.
If not provided, no requests/limits will be set

| `retention`
| `string`
| retention defines the time duration ThanosRuler shall retain data for. Default is '24h', and
must match the regular expression `[0-9]+(ms\|s\|m\|h\|d\|w\|y)` (milliseconds
seconds minutes hours days weeks years).

The field has no effect when remote-write is configured since the Ruler
operates in stateless mode.

| `routePrefix`
| `string`
| routePrefix defines the route prefix ThanosRuler registers HTTP handlers for. This allows thanos UI to be served on a sub-path.

| `ruleConcurrentEval`
| `integer`
| ruleConcurrentEval defines how many rules can be evaluated concurrently.
It requires Thanos >= v0.37.0.

| `ruleGracePeriod`
| `string`
| ruleGracePeriod defines the minimum duration between alert and restored "for" state.
This is maintained only for alerts with configured "for" time greater than grace period.
It requires Thanos >= v0.30.0.

| `ruleNamespaceSelector`
| `object`
| ruleNamespaceSelector defines the namespaces to be selected for Rules discovery. If unspecified, only
the same namespace as the ThanosRuler object is in is used.

| `ruleOutageTolerance`
| `string`
| ruleOutageTolerance defines the max time to tolerate prometheus outage for restoring "for" state of alert.
It requires Thanos >= v0.30.0.

| `ruleQueryOffset`
| `string`
| ruleQueryOffset defines the default rule group's query offset duration to use.
It requires Thanos >= v0.38.0.

| `ruleSelector`
| `object`
| ruleSelector defines the PrometheusRule objects to be selected for rule evaluation. An empty
label selector matches all objects. A null label selector matches no
objects.

| `schedulerName`
| `string`
| schedulerName defines the scheduler to use for Pod scheduling. If not specified, the default scheduler is used.

| `securityContext`
| `object`
| securityContext defines the pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext.

| `serviceAccountName`
| `string`
| serviceAccountName defines the name of the ServiceAccount to use to run the
Thanos Ruler Pods.

| `serviceName`
| `string`
| serviceName defines the name of the service name used by the underlying StatefulSet(s) as the governing service.
If defined, the Service  must be created before the ThanosRuler resource in the same namespace and it must define a selector that matches the pod labels.
If empty, the operator will create and manage a headless service named `thanos-ruler-operated` for ThanosRuler resources.
When deploying multiple ThanosRuler resources in the same namespace, it is recommended to specify a different value for each.
See https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/#stable-network-id for more details.

| `storage`
| `object`
| storage defines the specification of how storage shall be used.

| `terminationGracePeriodSeconds`
| `integer`
| terminationGracePeriodSeconds defines the optional duration in seconds the pod needs to terminate gracefully.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down) which may lead to data corruption.

Defaults to 120 seconds.

| `tolerations`
| `array`
| tolerations defines when specified, the pod's tolerations.

| `tolerations[]`
| `object`
| The pod this Toleration is attached to tolerates any taint that matches
the triple <key,value,effect> using the matching operator <operator>.

| `topologySpreadConstraints`
| `array`
| topologySpreadConstraints defines the pod's topology spread constraints.

| `topologySpreadConstraints[]`
| `object`
| TopologySpreadConstraint specifies how to spread matching pods among the given topology.

| `tracingConfig`
| `object`
| tracingConfig defines the tracing configuration.

The configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration

This is an *experimental feature*, it may change in any upcoming release
in a breaking way.

The operator performs no validation of the configuration.

`tracingConfigFile` takes precedence over this field.

| `tracingConfigFile`
| `string`
| tracingConfigFile defines the path of the tracing configuration file.

The configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration

This is an *experimental feature*, it may change in any upcoming release
in a breaking way.

The operator performs no validation of the configuration file.

This field takes precedence over `tracingConfig`.

| `updateStrategy`
| `object`
| updateStrategy indicates the strategy that will be employed to update
Pods in the StatefulSet when a revision is made to statefulset's Pod
Template.

The default strategy is RollingUpdate.

| `version`
| `string`
| version of Thanos to be deployed.

| `volumeMounts`
| `array`
| volumeMounts defines how the configuration of additional VolumeMounts on the output StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the ruler container,
that are generated as a result of StorageSpec objects.

| `volumeMounts[]`
| `object`
| VolumeMount describes a mounting of a Volume within a container.

| `volumes`
| `array`
| volumes defines how configuration of additional volumes on the output StatefulSet definition. Volumes specified will
be appended to other volumes that are generated as a result of StorageSpec objects.

| `volumes[]`
| `object`
| Volume represents a named volume in a pod that may be accessed by any container in the pod.

| `web`
| `object`
| web defines the configuration of the ThanosRuler web server.

|===
=== .spec.additionalArgs
Description::
+
--
additionalArgs defines how to add additional arguments for the ThanosRuler container.
It is intended for e.g. activating hidden flags which are not supported by
the dedicated configuration options yet. The arguments are passed as-is to the
ThanosRuler container which may cause issues if they are invalid or not supported
by the given ThanosRuler version.
In case of an argument conflict (e.g. an argument which is already set by the
operator itself) or when providing an invalid argument the reconciliation will
fail and an error will be logged.
--

Type::
  `array`




=== .spec.additionalArgs[]
Description::
+
--
Argument as part of the AdditionalArgs list.
--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| name of the argument, e.g. "scrape.discovery-reload-interval".

| `value`
| `string`
| value defines the argument value, e.g. 30s. Can be empty for name-only arguments (e.g. --storage.tsdb.no-lockfile)

|===
=== .spec.affinity
Description::
+
--
affinity defines when specified, the pod's scheduling constraints.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `nodeAffinity`
| `object`
| Describes node affinity scheduling rules for the pod.

| `podAffinity`
| `object`
| Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).

| `podAntiAffinity`
| `object`
| Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).

|===
=== .spec.affinity.nodeAffinity
Description::
+
--
Describes node affinity scheduling rules for the pod.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `preferredDuringSchedulingIgnoredDuringExecution`
| `array`
| The scheduler will prefer to schedule pods to nodes that satisfy
the affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node matches the corresponding matchExpressions; the
node(s) with the highest sum are the most preferred.

| `preferredDuringSchedulingIgnoredDuringExecution[]`
| `object`
| An empty preferred scheduling term matches all objects with implicit weight 0
(i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).

| `requiredDuringSchedulingIgnoredDuringExecution`
| `object`
| If the affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to an update), the system
may or may not try to eventually evict the pod from its node.

|===
=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution
Description::
+
--
The scheduler will prefer to schedule pods to nodes that satisfy
the affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node matches the corresponding matchExpressions; the
node(s) with the highest sum are the most preferred.
--

Type::
  `array`




=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
Description::
+
--
An empty preferred scheduling term matches all objects with implicit weight 0
(i.e. it's a no-op). A null preferred scheduling term matches no objects (i.e. is also a no-op).
--

Type::
  `object`

Required::
  - `preference`
  - `weight`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `preference`
| `object`
| A node selector term, associated with the corresponding weight.

| `weight`
| `integer`
| Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

|===
=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference
Description::
+
--
A node selector term, associated with the corresponding weight.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| A list of node selector requirements by node's labels.

| `matchExpressions[]`
| `object`
| A node selector requirement is a selector that contains values, a key, and an operator
that relates the key and values.

| `matchFields`
| `array`
| A list of node selector requirements by node's fields.

| `matchFields[]`
| `object`
| A node selector requirement is a selector that contains values, a key, and an operator
that relates the key and values.

|===
=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions
Description::
+
--
A list of node selector requirements by node's labels.
--

Type::
  `array`




=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchExpressions[]
Description::
+
--
A node selector requirement is a selector that contains values, a key, and an operator
that relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The label key that the selector applies to.

| `operator`
| `string`
| Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

| `values`
| `array (string)`
| An array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. If the operator is Gt or Lt, the values
array must have a single element, which will be interpreted as an integer.
This array is replaced during a strategic merge patch.

|===
=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields
Description::
+
--
A list of node selector requirements by node's fields.
--

Type::
  `array`




=== .spec.affinity.nodeAffinity.preferredDuringSchedulingIgnoredDuringExecution[].preference.matchFields[]
Description::
+
--
A node selector requirement is a selector that contains values, a key, and an operator
that relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The label key that the selector applies to.

| `operator`
| `string`
| Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

| `values`
| `array (string)`
| An array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. If the operator is Gt or Lt, the values
array must have a single element, which will be interpreted as an integer.
This array is replaced during a strategic merge patch.

|===
=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution
Description::
+
--
If the affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to an update), the system
may or may not try to eventually evict the pod from its node.
--

Type::
  `object`

Required::
  - `nodeSelectorTerms`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `nodeSelectorTerms`
| `array`
| Required. A list of node selector terms. The terms are ORed.

| `nodeSelectorTerms[]`
| `object`
| A null or empty node selector term matches no objects. The requirements of
them are ANDed.
The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.

|===
=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms
Description::
+
--
Required. A list of node selector terms. The terms are ORed.
--

Type::
  `array`




=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[]
Description::
+
--
A null or empty node selector term matches no objects. The requirements of
them are ANDed.
The TopologySelectorTerm type implements a subset of the NodeSelectorTerm.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| A list of node selector requirements by node's labels.

| `matchExpressions[]`
| `object`
| A node selector requirement is a selector that contains values, a key, and an operator
that relates the key and values.

| `matchFields`
| `array`
| A list of node selector requirements by node's fields.

| `matchFields[]`
| `object`
| A node selector requirement is a selector that contains values, a key, and an operator
that relates the key and values.

|===
=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions
Description::
+
--
A list of node selector requirements by node's labels.
--

Type::
  `array`




=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchExpressions[]
Description::
+
--
A node selector requirement is a selector that contains values, a key, and an operator
that relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The label key that the selector applies to.

| `operator`
| `string`
| Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

| `values`
| `array (string)`
| An array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. If the operator is Gt or Lt, the values
array must have a single element, which will be interpreted as an integer.
This array is replaced during a strategic merge patch.

|===
=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields
Description::
+
--
A list of node selector requirements by node's fields.
--

Type::
  `array`




=== .spec.affinity.nodeAffinity.requiredDuringSchedulingIgnoredDuringExecution.nodeSelectorTerms[].matchFields[]
Description::
+
--
A node selector requirement is a selector that contains values, a key, and an operator
that relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The label key that the selector applies to.

| `operator`
| `string`
| Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.

| `values`
| `array (string)`
| An array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. If the operator is Gt or Lt, the values
array must have a single element, which will be interpreted as an integer.
This array is replaced during a strategic merge patch.

|===
=== .spec.affinity.podAffinity
Description::
+
--
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod(s)).
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `preferredDuringSchedulingIgnoredDuringExecution`
| `array`
| The scheduler will prefer to schedule pods to nodes that satisfy
the affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
node(s) with the highest sum are the most preferred.

| `preferredDuringSchedulingIgnoredDuringExecution[]`
| `object`
| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

| `requiredDuringSchedulingIgnoredDuringExecution`
| `array`
| If the affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to a pod label update), the
system may or may not try to eventually evict the pod from its node.
When there are multiple elements, the lists of nodes corresponding to each
podAffinityTerm are intersected, i.e. all terms must be satisfied.

| `requiredDuringSchedulingIgnoredDuringExecution[]`
| `object`
| Defines a set of pods (namely those matching the labelSelector
relative to the given namespace(s)) that this pod should be
co-located (affinity) or not co-located (anti-affinity) with,
where co-located is defined as running on a node whose value of
the label with key <topologyKey> matches that of any node on which
a pod of the set of pods is running

|===
=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution
Description::
+
--
The scheduler will prefer to schedule pods to nodes that satisfy
the affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling affinity expressions, etc.),
compute a sum by iterating through the elements of this field and adding
"weight" to the sum if the node has pods which matches the corresponding podAffinityTerm; the
node(s) with the highest sum are the most preferred.
--

Type::
  `array`




=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
Description::
+
--
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
--

Type::
  `object`

Required::
  - `podAffinityTerm`
  - `weight`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `podAffinityTerm`
| `object`
| Required. A pod affinity term, associated with the corresponding weight.

| `weight`
| `integer`
| weight associated with matching the corresponding podAffinityTerm,
in the range 1-100.

|===
=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm
Description::
+
--
Required. A pod affinity term, associated with the corresponding weight.
--

Type::
  `object`

Required::
  - `topologyKey`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `labelSelector`
| `object`
| A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.

| `matchLabelKeys`
| `array (string)`
| MatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.

| `mismatchLabelKeys`
| `array (string)`
| MismatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

| `namespaceSelector`
| `object`
| A label query over the set of namespaces that the term applies to.
The term is applied to the union of the namespaces selected by this field
and the ones listed in the namespaces field.
null selector and null or empty namespaces list means "this pod's namespace".
An empty selector ({}) matches all namespaces.

| `namespaces`
| `array (string)`
| namespaces specifies a static list of namespace names that the term applies to.
The term is applied to the union of the namespaces listed in this field
and the ones selected by namespaceSelector.
null or empty namespaces list and null namespaceSelector means "this pod's namespace".

| `topologyKey`
| `string`
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
the labelSelector in the specified namespaces, where co-located is defined as running on a node
whose value of the label with key topologyKey matches that of any node on which any of the
selected pods is running.
Empty topologyKey is not allowed.

|===
=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector
Description::
+
--
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector
Description::
+
--
A label query over the set of namespaces that the term applies to.
The term is applied to the union of the namespaces selected by this field
and the ones listed in the namespaces field.
null selector and null or empty namespaces list means "this pod's namespace".
An empty selector ({}) matches all namespaces.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.affinity.podAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution
Description::
+
--
If the affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to a pod label update), the
system may or may not try to eventually evict the pod from its node.
When there are multiple elements, the lists of nodes corresponding to each
podAffinityTerm are intersected, i.e. all terms must be satisfied.
--

Type::
  `array`




=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
Description::
+
--
Defines a set of pods (namely those matching the labelSelector
relative to the given namespace(s)) that this pod should be
co-located (affinity) or not co-located (anti-affinity) with,
where co-located is defined as running on a node whose value of
the label with key <topologyKey> matches that of any node on which
a pod of the set of pods is running
--

Type::
  `object`

Required::
  - `topologyKey`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `labelSelector`
| `object`
| A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.

| `matchLabelKeys`
| `array (string)`
| MatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.

| `mismatchLabelKeys`
| `array (string)`
| MismatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

| `namespaceSelector`
| `object`
| A label query over the set of namespaces that the term applies to.
The term is applied to the union of the namespaces selected by this field
and the ones listed in the namespaces field.
null selector and null or empty namespaces list means "this pod's namespace".
An empty selector ({}) matches all namespaces.

| `namespaces`
| `array (string)`
| namespaces specifies a static list of namespace names that the term applies to.
The term is applied to the union of the namespaces listed in this field
and the ones selected by namespaceSelector.
null or empty namespaces list and null namespaceSelector means "this pod's namespace".

| `topologyKey`
| `string`
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
the labelSelector in the specified namespaces, where co-located is defined as running on a node
whose value of the label with key topologyKey matches that of any node on which any of the
selected pods is running.
Empty topologyKey is not allowed.

|===
=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector
Description::
+
--
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector
Description::
+
--
A label query over the set of namespaces that the term applies to.
The term is applied to the union of the namespaces selected by this field
and the ones listed in the namespaces field.
null selector and null or empty namespaces list means "this pod's namespace".
An empty selector ({}) matches all namespaces.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.affinity.podAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.affinity.podAntiAffinity
Description::
+
--
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod(s)).
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `preferredDuringSchedulingIgnoredDuringExecution`
| `array`
| The scheduler will prefer to schedule pods to nodes that satisfy
the anti-affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling anti-affinity expressions, etc.),
compute a sum by iterating through the elements of this field and subtracting
"weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the
node(s) with the highest sum are the most preferred.

| `preferredDuringSchedulingIgnoredDuringExecution[]`
| `object`
| The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)

| `requiredDuringSchedulingIgnoredDuringExecution`
| `array`
| If the anti-affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the anti-affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to a pod label update), the
system may or may not try to eventually evict the pod from its node.
When there are multiple elements, the lists of nodes corresponding to each
podAffinityTerm are intersected, i.e. all terms must be satisfied.

| `requiredDuringSchedulingIgnoredDuringExecution[]`
| `object`
| Defines a set of pods (namely those matching the labelSelector
relative to the given namespace(s)) that this pod should be
co-located (affinity) or not co-located (anti-affinity) with,
where co-located is defined as running on a node whose value of
the label with key <topologyKey> matches that of any node on which
a pod of the set of pods is running

|===
=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution
Description::
+
--
The scheduler will prefer to schedule pods to nodes that satisfy
the anti-affinity expressions specified by this field, but it may choose
a node that violates one or more of the expressions. The node that is
most preferred is the one with the greatest sum of weights, i.e.
for each node that meets all of the scheduling requirements (resource
request, requiredDuringScheduling anti-affinity expressions, etc.),
compute a sum by iterating through the elements of this field and subtracting
"weight" from the sum if the node has pods which matches the corresponding podAffinityTerm; the
node(s) with the highest sum are the most preferred.
--

Type::
  `array`




=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[]
Description::
+
--
The weights of all of the matched WeightedPodAffinityTerm fields are added per-node to find the most preferred node(s)
--

Type::
  `object`

Required::
  - `podAffinityTerm`
  - `weight`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `podAffinityTerm`
| `object`
| Required. A pod affinity term, associated with the corresponding weight.

| `weight`
| `integer`
| weight associated with matching the corresponding podAffinityTerm,
in the range 1-100.

|===
=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm
Description::
+
--
Required. A pod affinity term, associated with the corresponding weight.
--

Type::
  `object`

Required::
  - `topologyKey`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `labelSelector`
| `object`
| A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.

| `matchLabelKeys`
| `array (string)`
| MatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.

| `mismatchLabelKeys`
| `array (string)`
| MismatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

| `namespaceSelector`
| `object`
| A label query over the set of namespaces that the term applies to.
The term is applied to the union of the namespaces selected by this field
and the ones listed in the namespaces field.
null selector and null or empty namespaces list means "this pod's namespace".
An empty selector ({}) matches all namespaces.

| `namespaces`
| `array (string)`
| namespaces specifies a static list of namespace names that the term applies to.
The term is applied to the union of the namespaces listed in this field
and the ones selected by namespaceSelector.
null or empty namespaces list and null namespaceSelector means "this pod's namespace".

| `topologyKey`
| `string`
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
the labelSelector in the specified namespaces, where co-located is defined as running on a node
whose value of the label with key topologyKey matches that of any node on which any of the
selected pods is running.
Empty topologyKey is not allowed.

|===
=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector
Description::
+
--
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.labelSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector
Description::
+
--
A label query over the set of namespaces that the term applies to.
The term is applied to the union of the namespaces selected by this field
and the ones listed in the namespaces field.
null selector and null or empty namespaces list means "this pod's namespace".
An empty selector ({}) matches all namespaces.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.affinity.podAntiAffinity.preferredDuringSchedulingIgnoredDuringExecution[].podAffinityTerm.namespaceSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution
Description::
+
--
If the anti-affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the anti-affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to a pod label update), the
system may or may not try to eventually evict the pod from its node.
When there are multiple elements, the lists of nodes corresponding to each
podAffinityTerm are intersected, i.e. all terms must be satisfied.
--

Type::
  `array`




=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[]
Description::
+
--
Defines a set of pods (namely those matching the labelSelector
relative to the given namespace(s)) that this pod should be
co-located (affinity) or not co-located (anti-affinity) with,
where co-located is defined as running on a node whose value of
the label with key <topologyKey> matches that of any node on which
a pod of the set of pods is running
--

Type::
  `object`

Required::
  - `topologyKey`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `labelSelector`
| `object`
| A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.

| `matchLabelKeys`
| `array (string)`
| MatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key in (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.

| `mismatchLabelKeys`
| `array (string)`
| MismatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with `labelSelector` as `key notin (value)`
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.

| `namespaceSelector`
| `object`
| A label query over the set of namespaces that the term applies to.
The term is applied to the union of the namespaces selected by this field
and the ones listed in the namespaces field.
null selector and null or empty namespaces list means "this pod's namespace".
An empty selector ({}) matches all namespaces.

| `namespaces`
| `array (string)`
| namespaces specifies a static list of namespace names that the term applies to.
The term is applied to the union of the namespaces listed in this field
and the ones selected by namespaceSelector.
null or empty namespaces list and null namespaceSelector means "this pod's namespace".

| `topologyKey`
| `string`
| This pod should be co-located (affinity) or not co-located (anti-affinity) with the pods matching
the labelSelector in the specified namespaces, where co-located is defined as running on a node
whose value of the label with key topologyKey matches that of any node on which any of the
selected pods is running.
Empty topologyKey is not allowed.

|===
=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector
Description::
+
--
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].labelSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector
Description::
+
--
A label query over the set of namespaces that the term applies to.
The term is applied to the union of the namespaces selected by this field
and the ones listed in the namespaces field.
null selector and null or empty namespaces list means "this pod's namespace".
An empty selector ({}) matches all namespaces.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution[].namespaceSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.alertRelabelConfigs
Description::
+
--
alertRelabelConfigs defines the alert relabeling in Thanos Ruler.

Alert relabel configuration must have the form as specified in the
official Prometheus documentation:
https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs

The operator performs no validation of the configuration.

`alertRelabelConfigFile` takes precedence over this field.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.alertmanagersConfig
Description::
+
--
alertmanagersConfig defines the list of Alertmanager endpoints to send alerts to.

The configuration format is defined at https://thanos.io/tip/components/rule.md/#alertmanager.

It requires Thanos >= v0.10.0.

The operator performs no validation of the configuration.

This field takes precedence over `alertmanagersUrl`.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.containers
Description::
+
--
containers allows injecting additional containers or modifying operator
generated containers. This can be used to allow adding an authentication
proxy to the Pods or to change the behavior of an operator generated
container. Containers described here modify an operator generated
container if they share the same name and modifications are done via a
strategic merge patch.

The names of containers managed by the operator are:
* `thanos-ruler`
* `config-reloader`

Overriding containers which are managed by the operator require careful
testing, especially when upgrading to a new version of the operator.
--

Type::
  `array`




=== .spec.containers[]
Description::
+
--
A single application container that you want to run within a pod.
--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `args`
| `array (string)`
| Arguments to the entrypoint.
The container image's CMD is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

| `command`
| `array (string)`
| Entrypoint array. Not executed within a shell.
The container image's ENTRYPOINT is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

| `env`
| `array`
| List of environment variables to set in the container.
Cannot be updated.

| `env[]`
| `object`
| EnvVar represents an environment variable present in a Container.

| `envFrom`
| `array`
| List of sources to populate environment variables in the container.
The keys defined within a source may consist of any printable ASCII characters except '='.
When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.

| `envFrom[]`
| `object`
| EnvFromSource represents the source of a set of ConfigMaps or Secrets

| `image`
| `string`
| Container image name.
More info: https://kubernetes.io/docs/concepts/containers/images
This field is optional to allow higher level config management to default or override
container images in workload controllers like Deployments and StatefulSets.

| `imagePullPolicy`
| `string`
| Image pull policy.
One of Always, Never, IfNotPresent.
Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

| `lifecycle`
| `object`
| Actions that the management system should take in response to container lifecycle events.
Cannot be updated.

| `livenessProbe`
| `object`
| Periodic probe of container liveness.
Container will be restarted if the probe fails.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

| `name`
| `string`
| Name of the container specified as a DNS_LABEL.
Each container in a pod must have a unique name (DNS_LABEL).
Cannot be updated.

| `ports`
| `array`
| List of ports to expose from the container. Not specifying a port here
DOES NOT prevent that port from being exposed. Any port which is
listening on the default "0.0.0.0" address inside a container will be
accessible from the network.
Modifying this array with strategic merge patch may corrupt the data.
For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.

| `ports[]`
| `object`
| ContainerPort represents a network port in a single container.

| `readinessProbe`
| `object`
| Periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

| `resizePolicy`
| `array`
| Resources resize policy for the container.
This field cannot be set on ephemeral containers.

| `resizePolicy[]`
| `object`
| ContainerResizePolicy represents resource resize policy for the container.

| `resources`
| `object`
| Compute Resources required by this container.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

| `restartPolicy`
| `string`
| RestartPolicy defines the restart behavior of individual containers in a pod.
This overrides the pod-level restart policy. When this field is not specified,
the restart behavior is defined by the Pod's restart policy and the container type.
Additionally, setting the RestartPolicy as "Always" for the init container will
have the following effect:
this init container will be continually restarted on
exit until all regular containers have terminated. Once all regular
containers have completed, all init containers with restartPolicy "Always"
will be shut down. This lifecycle differs from normal init containers and
is often referred to as a "sidecar" container. Although this init
container still starts in the init container sequence, it does not wait
for the container to complete before proceeding to the next init
container. Instead, the next init container starts immediately after this
init container is started, or after any startupProbe has successfully
completed.

| `restartPolicyRules`
| `array`
| Represents a list of rules to be checked to determine if the
container should be restarted on exit. The rules are evaluated in
order. Once a rule matches a container exit condition, the remaining
rules are ignored. If no rule matches the container exit condition,
the Container-level restart policy determines the whether the container
is restarted or not. Constraints on the rules:
- At most 20 rules are allowed.
- Rules can have the same action.
- Identical rules are not forbidden in validations.
When rules are specified, container MUST set RestartPolicy explicitly
even it if matches the Pod's RestartPolicy.

| `restartPolicyRules[]`
| `object`
| ContainerRestartRule describes how a container exit is handled.

| `securityContext`
| `object`
| SecurityContext defines the security options the container should be run with.
If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

| `startupProbe`
| `object`
| StartupProbe indicates that the Pod has successfully initialized.
If specified, no other probes are executed until this completes successfully.
If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
when it might take a long time to load data or warm a cache, than during steady-state operation.
This cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

| `stdin`
| `boolean`
| Whether this container should allocate a buffer for stdin in the container runtime. If this
is not set, reads from stdin in the container will always result in EOF.
Default is false.

| `stdinOnce`
| `boolean`
| Whether the container runtime should close the stdin channel after it has been opened by
a single attach. When stdin is true the stdin stream will remain open across multiple attach
sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
first client attaches to stdin, and then remains open and accepts data until the client disconnects,
at which time stdin is closed and remains closed until the container is restarted. If this
flag is false, a container processes that reads from stdin will never receive an EOF.
Default is false

| `terminationMessagePath`
| `string`
| Optional: Path at which the file to which the container's termination message
will be written is mounted into the container's filesystem.
Message written is intended to be brief final status, such as an assertion failure message.
Will be truncated by the node if greater than 4096 bytes. The total message length across
all containers will be limited to 12kb.
Defaults to /dev/termination-log.
Cannot be updated.

| `terminationMessagePolicy`
| `string`
| Indicate how the termination message should be populated. File will use the contents of
terminationMessagePath to populate the container status message on both success and failure.
FallbackToLogsOnError will use the last chunk of container log output if the termination
message file is empty and the container exited with an error.
The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
Defaults to File.
Cannot be updated.

| `tty`
| `boolean`
| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.

| `volumeDevices`
| `array`
| volumeDevices is the list of block devices to be used by the container.

| `volumeDevices[]`
| `object`
| volumeDevice describes a mapping of a raw block device within a container.

| `volumeMounts`
| `array`
| Pod volumes to mount into the container's filesystem.
Cannot be updated.

| `volumeMounts[]`
| `object`
| VolumeMount describes a mounting of a Volume within a container.

| `workingDir`
| `string`
| Container's working directory.
If not specified, the container runtime's default will be used, which
might be configured in the container image.
Cannot be updated.

|===
=== .spec.containers[].env
Description::
+
--
List of environment variables to set in the container.
Cannot be updated.
--

Type::
  `array`




=== .spec.containers[].env[]
Description::
+
--
EnvVar represents an environment variable present in a Container.
--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the environment variable.
May consist of any printable ASCII characters except '='.

| `value`
| `string`
| Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".

| `valueFrom`
| `object`
| Source for the environment variable's value. Cannot be used if value is not empty.

|===
=== .spec.containers[].env[].valueFrom
Description::
+
--
Source for the environment variable's value. Cannot be used if value is not empty.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `configMapKeyRef`
| `object`
| Selects a key of a ConfigMap.

| `fieldRef`
| `object`
| Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

| `fileKeyRef`
| `object`
| FileKeyRef selects a key of the env file.
Requires the EnvFiles feature gate to be enabled.

| `resourceFieldRef`
| `object`
| Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

| `secretKeyRef`
| `object`
| Selects a key of a secret in the pod's namespace

|===
=== .spec.containers[].env[].valueFrom.configMapKeyRef
Description::
+
--
Selects a key of a ConfigMap.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key to select.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the ConfigMap or its key must be defined

|===
=== .spec.containers[].env[].valueFrom.fieldRef
Description::
+
--
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
--

Type::
  `object`

Required::
  - `fieldPath`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiVersion`
| `string`
| Version of the schema the FieldPath is written in terms of, defaults to "v1".

| `fieldPath`
| `string`
| Path of the field to select in the specified API version.

|===
=== .spec.containers[].env[].valueFrom.fileKeyRef
Description::
+
--
FileKeyRef selects a key of the env file.
Requires the EnvFiles feature gate to be enabled.
--

Type::
  `object`

Required::
  - `key`
  - `path`
  - `volumeName`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key within the env file. An invalid key will prevent the pod from starting.
The keys defined within a source may consist of any printable ASCII characters except '='.
During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.

| `optional`
| `boolean`
| Specify whether the file or its key must be defined. If the file or key
does not exist, then the env var is not published.
If optional is set to true and the specified key does not exist,
the environment variable will not be set in the Pod's containers.

If optional is set to false and the specified key does not exist,
an error will be returned during Pod creation.

| `path`
| `string`
| The path within the volume from which to select the file.
Must be relative and may not contain the '..' path or start with '..'.

| `volumeName`
| `string`
| The name of the volume mount containing the env file.

|===
=== .spec.containers[].env[].valueFrom.resourceFieldRef
Description::
+
--
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
--

Type::
  `object`

Required::
  - `resource`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `containerName`
| `string`
| Container name: required for volumes, optional for env vars

| `divisor`
| `integer-or-string`
| Specifies the output format of the exposed resources, defaults to "1"

| `resource`
| `string`
| Required: resource to select

|===
=== .spec.containers[].env[].valueFrom.secretKeyRef
Description::
+
--
Selects a key of a secret in the pod's namespace
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.containers[].envFrom
Description::
+
--
List of sources to populate environment variables in the container.
The keys defined within a source may consist of any printable ASCII characters except '='.
When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
--

Type::
  `array`




=== .spec.containers[].envFrom[]
Description::
+
--
EnvFromSource represents the source of a set of ConfigMaps or Secrets
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `configMapRef`
| `object`
| The ConfigMap to select from

| `prefix`
| `string`
| Optional text to prepend to the name of each environment variable.
May consist of any printable ASCII characters except '='.

| `secretRef`
| `object`
| The Secret to select from

|===
=== .spec.containers[].envFrom[].configMapRef
Description::
+
--
The ConfigMap to select from
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the ConfigMap must be defined

|===
=== .spec.containers[].envFrom[].secretRef
Description::
+
--
The Secret to select from
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret must be defined

|===
=== .spec.containers[].lifecycle
Description::
+
--
Actions that the management system should take in response to container lifecycle events.
Cannot be updated.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `postStart`
| `object`
| PostStart is called immediately after a container is created. If the handler fails,
the container is terminated and restarted according to its restart policy.
Other management of the container blocks until the hook completes.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

| `preStop`
| `object`
| PreStop is called immediately before a container is terminated due to an
API request or management event such as liveness/startup probe failure,
preemption, resource contention, etc. The handler is not called if the
container crashes or exits. The Pod's termination grace period countdown begins before the
PreStop hook is executed. Regardless of the outcome of the handler, the
container will eventually terminate within the Pod's termination grace
period (unless delayed by finalizers). Other management of the container blocks until the hook completes
or until the termination grace period is reached.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

| `stopSignal`
| `string`
| StopSignal defines which signal will be sent to a container when it is being stopped.
If not specified, the default is defined by the container runtime in use.
StopSignal can only be set for Pods with a non-empty .spec.os.name

|===
=== .spec.containers[].lifecycle.postStart
Description::
+
--
PostStart is called immediately after a container is created. If the handler fails,
the container is terminated and restarted according to its restart policy.
Other management of the container blocks until the hook completes.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `exec`
| `object`
| Exec specifies a command to execute in the container.

| `httpGet`
| `object`
| HTTPGet specifies an HTTP GET request to perform.

| `sleep`
| `object`
| Sleep represents a duration that the container should sleep.

| `tcpSocket`
| `object`
| Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified.

|===
=== .spec.containers[].lifecycle.postStart.exec
Description::
+
--
Exec specifies a command to execute in the container.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `command`
| `array (string)`
| Command is the command line to execute inside the container, the working directory for the
command  is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

|===
=== .spec.containers[].lifecycle.postStart.httpGet
Description::
+
--
HTTPGet specifies an HTTP GET request to perform.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.

| `httpHeaders`
| `array`
| Custom headers to set in the request. HTTP allows repeated headers.

| `httpHeaders[]`
| `object`
| HTTPHeader describes a custom header to be used in HTTP probes

| `path`
| `string`
| Path to access on the HTTP server.

| `port`
| `integer-or-string`
| Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

| `scheme`
| `string`
| Scheme to use for connecting to the host.
Defaults to HTTP.

|===
=== .spec.containers[].lifecycle.postStart.httpGet.httpHeaders
Description::
+
--
Custom headers to set in the request. HTTP allows repeated headers.
--

Type::
  `array`




=== .spec.containers[].lifecycle.postStart.httpGet.httpHeaders[]
Description::
+
--
HTTPHeader describes a custom header to be used in HTTP probes
--

Type::
  `object`

Required::
  - `name`
  - `value`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header.

| `value`
| `string`
| The header field value

|===
=== .spec.containers[].lifecycle.postStart.sleep
Description::
+
--
Sleep represents a duration that the container should sleep.
--

Type::
  `object`

Required::
  - `seconds`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `seconds`
| `integer`
| Seconds is the number of seconds to sleep.

|===
=== .spec.containers[].lifecycle.postStart.tcpSocket
Description::
+
--
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Optional: Host name to connect to, defaults to the pod IP.

| `port`
| `integer-or-string`
| Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

|===
=== .spec.containers[].lifecycle.preStop
Description::
+
--
PreStop is called immediately before a container is terminated due to an
API request or management event such as liveness/startup probe failure,
preemption, resource contention, etc. The handler is not called if the
container crashes or exits. The Pod's termination grace period countdown begins before the
PreStop hook is executed. Regardless of the outcome of the handler, the
container will eventually terminate within the Pod's termination grace
period (unless delayed by finalizers). Other management of the container blocks until the hook completes
or until the termination grace period is reached.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `exec`
| `object`
| Exec specifies a command to execute in the container.

| `httpGet`
| `object`
| HTTPGet specifies an HTTP GET request to perform.

| `sleep`
| `object`
| Sleep represents a duration that the container should sleep.

| `tcpSocket`
| `object`
| Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified.

|===
=== .spec.containers[].lifecycle.preStop.exec
Description::
+
--
Exec specifies a command to execute in the container.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `command`
| `array (string)`
| Command is the command line to execute inside the container, the working directory for the
command  is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

|===
=== .spec.containers[].lifecycle.preStop.httpGet
Description::
+
--
HTTPGet specifies an HTTP GET request to perform.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.

| `httpHeaders`
| `array`
| Custom headers to set in the request. HTTP allows repeated headers.

| `httpHeaders[]`
| `object`
| HTTPHeader describes a custom header to be used in HTTP probes

| `path`
| `string`
| Path to access on the HTTP server.

| `port`
| `integer-or-string`
| Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

| `scheme`
| `string`
| Scheme to use for connecting to the host.
Defaults to HTTP.

|===
=== .spec.containers[].lifecycle.preStop.httpGet.httpHeaders
Description::
+
--
Custom headers to set in the request. HTTP allows repeated headers.
--

Type::
  `array`




=== .spec.containers[].lifecycle.preStop.httpGet.httpHeaders[]
Description::
+
--
HTTPHeader describes a custom header to be used in HTTP probes
--

Type::
  `object`

Required::
  - `name`
  - `value`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header.

| `value`
| `string`
| The header field value

|===
=== .spec.containers[].lifecycle.preStop.sleep
Description::
+
--
Sleep represents a duration that the container should sleep.
--

Type::
  `object`

Required::
  - `seconds`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `seconds`
| `integer`
| Seconds is the number of seconds to sleep.

|===
=== .spec.containers[].lifecycle.preStop.tcpSocket
Description::
+
--
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Optional: Host name to connect to, defaults to the pod IP.

| `port`
| `integer-or-string`
| Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

|===
=== .spec.containers[].livenessProbe
Description::
+
--
Periodic probe of container liveness.
Container will be restarted if the probe fails.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `exec`
| `object`
| Exec specifies a command to execute in the container.

| `failureThreshold`
| `integer`
| Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.

| `grpc`
| `object`
| GRPC specifies a GRPC HealthCheckRequest.

| `httpGet`
| `object`
| HTTPGet specifies an HTTP GET request to perform.

| `initialDelaySeconds`
| `integer`
| Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

| `periodSeconds`
| `integer`
| How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.

| `successThreshold`
| `integer`
| Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

| `tcpSocket`
| `object`
| TCPSocket specifies a connection to a TCP port.

| `terminationGracePeriodSeconds`
| `integer`
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

| `timeoutSeconds`
| `integer`
| Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

|===
=== .spec.containers[].livenessProbe.exec
Description::
+
--
Exec specifies a command to execute in the container.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `command`
| `array (string)`
| Command is the command line to execute inside the container, the working directory for the
command  is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

|===
=== .spec.containers[].livenessProbe.grpc
Description::
+
--
GRPC specifies a GRPC HealthCheckRequest.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `port`
| `integer`
| Port number of the gRPC service. Number must be in the range 1 to 65535.

| `service`
| `string`
| Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

If this is not specified, the default behavior is defined by gRPC.

|===
=== .spec.containers[].livenessProbe.httpGet
Description::
+
--
HTTPGet specifies an HTTP GET request to perform.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.

| `httpHeaders`
| `array`
| Custom headers to set in the request. HTTP allows repeated headers.

| `httpHeaders[]`
| `object`
| HTTPHeader describes a custom header to be used in HTTP probes

| `path`
| `string`
| Path to access on the HTTP server.

| `port`
| `integer-or-string`
| Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

| `scheme`
| `string`
| Scheme to use for connecting to the host.
Defaults to HTTP.

|===
=== .spec.containers[].livenessProbe.httpGet.httpHeaders
Description::
+
--
Custom headers to set in the request. HTTP allows repeated headers.
--

Type::
  `array`




=== .spec.containers[].livenessProbe.httpGet.httpHeaders[]
Description::
+
--
HTTPHeader describes a custom header to be used in HTTP probes
--

Type::
  `object`

Required::
  - `name`
  - `value`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header.

| `value`
| `string`
| The header field value

|===
=== .spec.containers[].livenessProbe.tcpSocket
Description::
+
--
TCPSocket specifies a connection to a TCP port.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Optional: Host name to connect to, defaults to the pod IP.

| `port`
| `integer-or-string`
| Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

|===
=== .spec.containers[].ports
Description::
+
--
List of ports to expose from the container. Not specifying a port here
DOES NOT prevent that port from being exposed. Any port which is
listening on the default "0.0.0.0" address inside a container will be
accessible from the network.
Modifying this array with strategic merge patch may corrupt the data.
For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
--

Type::
  `array`




=== .spec.containers[].ports[]
Description::
+
--
ContainerPort represents a network port in a single container.
--

Type::
  `object`

Required::
  - `containerPort`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `containerPort`
| `integer`
| Number of port to expose on the pod's IP address.
This must be a valid port number, 0 < x < 65536.

| `hostIP`
| `string`
| What host IP to bind the external port to.

| `hostPort`
| `integer`
| Number of port to expose on the host.
If specified, this must be a valid port number, 0 < x < 65536.
If HostNetwork is specified, this must match ContainerPort.
Most containers do not need this.

| `name`
| `string`
| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
named port in a pod must have a unique name. Name for the port that can be
referred to by services.

| `protocol`
| `string`
| Protocol for port. Must be UDP, TCP, or SCTP.
Defaults to "TCP".

|===
=== .spec.containers[].readinessProbe
Description::
+
--
Periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `exec`
| `object`
| Exec specifies a command to execute in the container.

| `failureThreshold`
| `integer`
| Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.

| `grpc`
| `object`
| GRPC specifies a GRPC HealthCheckRequest.

| `httpGet`
| `object`
| HTTPGet specifies an HTTP GET request to perform.

| `initialDelaySeconds`
| `integer`
| Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

| `periodSeconds`
| `integer`
| How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.

| `successThreshold`
| `integer`
| Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

| `tcpSocket`
| `object`
| TCPSocket specifies a connection to a TCP port.

| `terminationGracePeriodSeconds`
| `integer`
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

| `timeoutSeconds`
| `integer`
| Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

|===
=== .spec.containers[].readinessProbe.exec
Description::
+
--
Exec specifies a command to execute in the container.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `command`
| `array (string)`
| Command is the command line to execute inside the container, the working directory for the
command  is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

|===
=== .spec.containers[].readinessProbe.grpc
Description::
+
--
GRPC specifies a GRPC HealthCheckRequest.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `port`
| `integer`
| Port number of the gRPC service. Number must be in the range 1 to 65535.

| `service`
| `string`
| Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

If this is not specified, the default behavior is defined by gRPC.

|===
=== .spec.containers[].readinessProbe.httpGet
Description::
+
--
HTTPGet specifies an HTTP GET request to perform.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.

| `httpHeaders`
| `array`
| Custom headers to set in the request. HTTP allows repeated headers.

| `httpHeaders[]`
| `object`
| HTTPHeader describes a custom header to be used in HTTP probes

| `path`
| `string`
| Path to access on the HTTP server.

| `port`
| `integer-or-string`
| Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

| `scheme`
| `string`
| Scheme to use for connecting to the host.
Defaults to HTTP.

|===
=== .spec.containers[].readinessProbe.httpGet.httpHeaders
Description::
+
--
Custom headers to set in the request. HTTP allows repeated headers.
--

Type::
  `array`




=== .spec.containers[].readinessProbe.httpGet.httpHeaders[]
Description::
+
--
HTTPHeader describes a custom header to be used in HTTP probes
--

Type::
  `object`

Required::
  - `name`
  - `value`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header.

| `value`
| `string`
| The header field value

|===
=== .spec.containers[].readinessProbe.tcpSocket
Description::
+
--
TCPSocket specifies a connection to a TCP port.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Optional: Host name to connect to, defaults to the pod IP.

| `port`
| `integer-or-string`
| Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

|===
=== .spec.containers[].resizePolicy
Description::
+
--
Resources resize policy for the container.
This field cannot be set on ephemeral containers.
--

Type::
  `array`




=== .spec.containers[].resizePolicy[]
Description::
+
--
ContainerResizePolicy represents resource resize policy for the container.
--

Type::
  `object`

Required::
  - `resourceName`
  - `restartPolicy`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `resourceName`
| `string`
| Name of the resource to which this resource resize policy applies.
Supported values: cpu, memory.

| `restartPolicy`
| `string`
| Restart policy to apply when specified resource is resized.
If not specified, it defaults to NotRequired.

|===
=== .spec.containers[].resources
Description::
+
--
Compute Resources required by this container.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `claims`
| `array`
| Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.

This field depends on the
DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

| `claims[]`
| `object`
| ResourceClaim references one entry in PodSpec.ResourceClaims.

| `limits`
| `integer-or-string`
| Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

| `requests`
| `integer-or-string`
| Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

|===
=== .spec.containers[].resources.claims
Description::
+
--
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.

This field depends on the
DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.
--

Type::
  `array`




=== .spec.containers[].resources.claims[]
Description::
+
--
ResourceClaim references one entry in PodSpec.ResourceClaims.
--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container.

| `request`
| `string`
| Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request.

|===
=== .spec.containers[].restartPolicyRules
Description::
+
--
Represents a list of rules to be checked to determine if the
container should be restarted on exit. The rules are evaluated in
order. Once a rule matches a container exit condition, the remaining
rules are ignored. If no rule matches the container exit condition,
the Container-level restart policy determines the whether the container
is restarted or not. Constraints on the rules:
- At most 20 rules are allowed.
- Rules can have the same action.
- Identical rules are not forbidden in validations.
When rules are specified, container MUST set RestartPolicy explicitly
even it if matches the Pod's RestartPolicy.
--

Type::
  `array`




=== .spec.containers[].restartPolicyRules[]
Description::
+
--
ContainerRestartRule describes how a container exit is handled.
--

Type::
  `object`

Required::
  - `action`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `action`
| `string`
| Specifies the action taken on a container exit if the requirements
are satisfied. The only possible value is "Restart" to restart the
container.

| `exitCodes`
| `object`
| Represents the exit codes to check on container exits.

|===
=== .spec.containers[].restartPolicyRules[].exitCodes
Description::
+
--
Represents the exit codes to check on container exits.
--

Type::
  `object`

Required::
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `operator`
| `string`
| Represents the relationship between the container exit code(s) and the
specified values. Possible values are:
- In: the requirement is satisfied if the container exit code is in the
  set of specified values.
- NotIn: the requirement is satisfied if the container exit code is
  not in the set of specified values.

| `values`
| `array (integer)`
| Specifies the set of values to check for container exit codes.
At most 255 elements are allowed.

|===
=== .spec.containers[].securityContext
Description::
+
--
SecurityContext defines the security options the container should be run with.
If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `allowPrivilegeEscalation`
| `boolean`
| AllowPrivilegeEscalation controls whether a process can gain more
privileges than its parent process. This bool directly controls if
the no_new_privs flag will be set on the container process.
AllowPrivilegeEscalation is true always when the container is:
1) run as Privileged
2) has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows.

| `appArmorProfile`
| `object`
| appArmorProfile is the AppArmor options to use by this container. If set, this profile
overrides the pod's appArmorProfile.
Note that this field cannot be set when spec.os.name is windows.

| `capabilities`
| `object`
| The capabilities to add/drop when running containers.
Defaults to the default set of capabilities granted by the container runtime.
Note that this field cannot be set when spec.os.name is windows.

| `privileged`
| `boolean`
| Run container in privileged mode.
Processes in privileged containers are essentially equivalent to root on the host.
Defaults to false.
Note that this field cannot be set when spec.os.name is windows.

| `procMount`
| `string`
| procMount denotes the type of proc mount to use for the containers.
The default value is Default which uses the container runtime defaults for
readonly paths and masked paths.
This requires the ProcMountType feature flag to be enabled.
Note that this field cannot be set when spec.os.name is windows.

| `readOnlyRootFilesystem`
| `boolean`
| Whether this container has a read-only root filesystem.
Default is false.
Note that this field cannot be set when spec.os.name is windows.

| `runAsGroup`
| `integer`
| The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in PodSecurityContext.  If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.

| `runAsNonRoot`
| `boolean`
| Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in PodSecurityContext.  If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.

| `runAsUser`
| `integer`
| The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in PodSecurityContext.  If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.

| `seLinuxOptions`
| `object`
| The SELinux context to be applied to the container.
If unspecified, the container runtime will allocate a random SELinux context for each
container.  May also be set in PodSecurityContext.  If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.

| `seccompProfile`
| `object`
| The seccomp options to use by this container. If seccomp options are
provided at both the pod & container level, the container options
override the pod options.
Note that this field cannot be set when spec.os.name is windows.

| `windowsOptions`
| `object`
| The Windows specific settings applied to all containers.
If unspecified, the options from the PodSecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux.

|===
=== .spec.containers[].securityContext.appArmorProfile
Description::
+
--
appArmorProfile is the AppArmor options to use by this container. If set, this profile
overrides the pod's appArmorProfile.
Note that this field cannot be set when spec.os.name is windows.
--

Type::
  `object`

Required::
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `localhostProfile`
| `string`
| localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost".

| `type`
| `string`
| type indicates which kind of AppArmor profile will be applied.
Valid options are:
  Localhost - a profile pre-loaded on the node.
  RuntimeDefault - the container runtime's default profile.
  Unconfined - no AppArmor enforcement.

|===
=== .spec.containers[].securityContext.capabilities
Description::
+
--
The capabilities to add/drop when running containers.
Defaults to the default set of capabilities granted by the container runtime.
Note that this field cannot be set when spec.os.name is windows.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `add`
| `array (string)`
| Added capabilities

| `drop`
| `array (string)`
| Removed capabilities

|===
=== .spec.containers[].securityContext.seLinuxOptions
Description::
+
--
The SELinux context to be applied to the container.
If unspecified, the container runtime will allocate a random SELinux context for each
container.  May also be set in PodSecurityContext.  If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `level`
| `string`
| Level is SELinux level label that applies to the container.

| `role`
| `string`
| Role is a SELinux role label that applies to the container.

| `type`
| `string`
| Type is a SELinux type label that applies to the container.

| `user`
| `string`
| User is a SELinux user label that applies to the container.

|===
=== .spec.containers[].securityContext.seccompProfile
Description::
+
--
The seccomp options to use by this container. If seccomp options are
provided at both the pod & container level, the container options
override the pod options.
Note that this field cannot be set when spec.os.name is windows.
--

Type::
  `object`

Required::
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `localhostProfile`
| `string`
| localhostProfile indicates a profile defined in a file on the node should be used.
The profile must be preconfigured on the node to work.
Must be a descending path, relative to the kubelet's configured seccomp profile location.
Must be set if type is "Localhost". Must NOT be set for any other type.

| `type`
| `string`
| type indicates which kind of seccomp profile will be applied.
Valid options are:

Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied.

|===
=== .spec.containers[].securityContext.windowsOptions
Description::
+
--
The Windows specific settings applied to all containers.
If unspecified, the options from the PodSecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `gmsaCredentialSpec`
| `string`
| GMSACredentialSpec is where the GMSA admission webhook
(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
GMSA credential spec named by the GMSACredentialSpecName field.

| `gmsaCredentialSpecName`
| `string`
| GMSACredentialSpecName is the name of the GMSA credential spec to use.

| `hostProcess`
| `boolean`
| HostProcess determines if a container should be run as a 'Host Process' container.
All of a Pod's containers must have the same effective HostProcess value
(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
In addition, if HostProcess is true then HostNetwork must also be set to true.

| `runAsUserName`
| `string`
| The UserName in Windows to run the entrypoint of the container process.
Defaults to the user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.

|===
=== .spec.containers[].startupProbe
Description::
+
--
StartupProbe indicates that the Pod has successfully initialized.
If specified, no other probes are executed until this completes successfully.
If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
when it might take a long time to load data or warm a cache, than during steady-state operation.
This cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `exec`
| `object`
| Exec specifies a command to execute in the container.

| `failureThreshold`
| `integer`
| Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.

| `grpc`
| `object`
| GRPC specifies a GRPC HealthCheckRequest.

| `httpGet`
| `object`
| HTTPGet specifies an HTTP GET request to perform.

| `initialDelaySeconds`
| `integer`
| Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

| `periodSeconds`
| `integer`
| How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.

| `successThreshold`
| `integer`
| Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

| `tcpSocket`
| `object`
| TCPSocket specifies a connection to a TCP port.

| `terminationGracePeriodSeconds`
| `integer`
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

| `timeoutSeconds`
| `integer`
| Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

|===
=== .spec.containers[].startupProbe.exec
Description::
+
--
Exec specifies a command to execute in the container.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `command`
| `array (string)`
| Command is the command line to execute inside the container, the working directory for the
command  is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

|===
=== .spec.containers[].startupProbe.grpc
Description::
+
--
GRPC specifies a GRPC HealthCheckRequest.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `port`
| `integer`
| Port number of the gRPC service. Number must be in the range 1 to 65535.

| `service`
| `string`
| Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

If this is not specified, the default behavior is defined by gRPC.

|===
=== .spec.containers[].startupProbe.httpGet
Description::
+
--
HTTPGet specifies an HTTP GET request to perform.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.

| `httpHeaders`
| `array`
| Custom headers to set in the request. HTTP allows repeated headers.

| `httpHeaders[]`
| `object`
| HTTPHeader describes a custom header to be used in HTTP probes

| `path`
| `string`
| Path to access on the HTTP server.

| `port`
| `integer-or-string`
| Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

| `scheme`
| `string`
| Scheme to use for connecting to the host.
Defaults to HTTP.

|===
=== .spec.containers[].startupProbe.httpGet.httpHeaders
Description::
+
--
Custom headers to set in the request. HTTP allows repeated headers.
--

Type::
  `array`




=== .spec.containers[].startupProbe.httpGet.httpHeaders[]
Description::
+
--
HTTPHeader describes a custom header to be used in HTTP probes
--

Type::
  `object`

Required::
  - `name`
  - `value`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header.

| `value`
| `string`
| The header field value

|===
=== .spec.containers[].startupProbe.tcpSocket
Description::
+
--
TCPSocket specifies a connection to a TCP port.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Optional: Host name to connect to, defaults to the pod IP.

| `port`
| `integer-or-string`
| Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

|===
=== .spec.containers[].volumeDevices
Description::
+
--
volumeDevices is the list of block devices to be used by the container.
--

Type::
  `array`




=== .spec.containers[].volumeDevices[]
Description::
+
--
volumeDevice describes a mapping of a raw block device within a container.
--

Type::
  `object`

Required::
  - `devicePath`
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `devicePath`
| `string`
| devicePath is the path inside of the container that the device will be mapped to.

| `name`
| `string`
| name must match the name of a persistentVolumeClaim in the pod

|===
=== .spec.containers[].volumeMounts
Description::
+
--
Pod volumes to mount into the container's filesystem.
Cannot be updated.
--

Type::
  `array`




=== .spec.containers[].volumeMounts[]
Description::
+
--
VolumeMount describes a mounting of a Volume within a container.
--

Type::
  `object`

Required::
  - `mountPath`
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `mountPath`
| `string`
| Path within the container at which the volume should be mounted.  Must
not contain ':'.

| `mountPropagation`
| `string`
| mountPropagation determines how mounts are propagated from the host
to container and the other way around.
When not set, MountPropagationNone is used.
This field is beta in 1.10.
When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
(which defaults to None).

| `name`
| `string`
| This must match the Name of a Volume.

| `readOnly`
| `boolean`
| Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.

| `recursiveReadOnly`
| `string`
| RecursiveReadOnly specifies whether read-only mounts should be handled
recursively.

If ReadOnly is false, this field has no meaning and must be unspecified.

If ReadOnly is true, and this field is set to Disabled, the mount is not made
recursively read-only.  If this field is set to IfPossible, the mount is made
recursively read-only, if it is supported by the container runtime.  If this
field is set to Enabled, the mount is made recursively read-only if it is
supported by the container runtime, otherwise the pod will not be started and
an error will be generated to indicate the reason.

If this field is set to IfPossible or Enabled, MountPropagation must be set to
None (or be unspecified, which defaults to None).

If this field is not specified, it is treated as an equivalent of Disabled.

| `subPath`
| `string`
| Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).

| `subPathExpr`
| `string`
| Expanded path within the volume from which the container's volume should be mounted.
Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
Defaults to "" (volume's root).
SubPathExpr and SubPath are mutually exclusive.

|===
=== .spec.dnsConfig
Description::
+
--
dnsConfig defines Defines the DNS configuration for the pods.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `nameservers`
| `array (string)`
| nameservers defines the list of DNS name server IP addresses.
This will be appended to the base nameservers generated from DNSPolicy.

| `options`
| `array`
| options defines the list of DNS resolver options.
This will be merged with the base options generated from DNSPolicy.
Resolution options given in Options
will override those that appear in the base DNSPolicy.

| `options[]`
| `object`
| PodDNSConfigOption defines DNS resolver options of a pod.

| `searches`
| `array (string)`
| searches defines the list of DNS search domains for host-name lookup.
This will be appended to the base search paths generated from DNSPolicy.

|===
=== .spec.dnsConfig.options
Description::
+
--
options defines the list of DNS resolver options.
This will be merged with the base options generated from DNSPolicy.
Resolution options given in Options
will override those that appear in the base DNSPolicy.
--

Type::
  `array`




=== .spec.dnsConfig.options[]
Description::
+
--
PodDNSConfigOption defines DNS resolver options of a pod.
--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| name is required and must be unique.

| `value`
| `string`
| value is optional.

|===
=== .spec.excludedFromEnforcement
Description::
+
--
excludedFromEnforcement defines the list of references to PrometheusRule objects
to be excluded from enforcing a namespace label of origin.
Applies only if enforcedNamespaceLabel set to true.
--

Type::
  `array`




=== .spec.excludedFromEnforcement[]
Description::
+
--
ObjectReference references a PodMonitor, ServiceMonitor, Probe or PrometheusRule object.
--

Type::
  `object`

Required::
  - `namespace`
  - `resource`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `group`
| `string`
| group of the referent. When not specified, it defaults to `monitoring.coreos.com`

| `name`
| `string`
| name of the referent. When not set, all resources in the namespace are matched.

| `namespace`
| `string`
| namespace of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

| `resource`
| `string`
| resource of the referent.

|===
=== .spec.grpcServerTlsConfig
Description::
+
--
grpcServerTlsConfig defines the gRPC server from which Thanos Querier reads
recorded rule data.

Note: Currently only the `minVersion`, `caFile`, `certFile`, and `keyFile` fields are supported.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `ca`
| `object`
| ca defines the Certificate authority used when verifying server certificates.

| `caFile`
| `string`
| caFile defines the path to the CA cert in the Prometheus container to use for the targets.

| `cert`
| `object`
| cert defines the Client certificate to present when doing client-authentication.

| `certFile`
| `string`
| certFile defines the path to the client cert file in the Prometheus container for the targets.

| `insecureSkipVerify`
| `boolean`
| insecureSkipVerify defines how to disable target certificate validation.

| `keyFile`
| `string`
| keyFile defines the path to the client key file in the Prometheus container for the targets.

| `keySecret`
| `object`
| keySecret defines the Secret containing the client key file for the targets.

| `maxVersion`
| `string`
| maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

| `minVersion`
| `string`
| minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

| `serverName`
| `string`
| serverName is used to verify the hostname for the targets.

|===
=== .spec.grpcServerTlsConfig.ca
Description::
+
--
ca defines the Certificate authority used when verifying server certificates.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `configMap`
| `object`
| configMap defines the ConfigMap containing data to use for the targets.

| `secret`
| `object`
| secret defines the Secret containing data to use for the targets.

|===
=== .spec.grpcServerTlsConfig.ca.configMap
Description::
+
--
configMap defines the ConfigMap containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key to select.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the ConfigMap or its key must be defined

|===
=== .spec.grpcServerTlsConfig.ca.secret
Description::
+
--
secret defines the Secret containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.grpcServerTlsConfig.cert
Description::
+
--
cert defines the Client certificate to present when doing client-authentication.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `configMap`
| `object`
| configMap defines the ConfigMap containing data to use for the targets.

| `secret`
| `object`
| secret defines the Secret containing data to use for the targets.

|===
=== .spec.grpcServerTlsConfig.cert.configMap
Description::
+
--
configMap defines the ConfigMap containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key to select.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the ConfigMap or its key must be defined

|===
=== .spec.grpcServerTlsConfig.cert.secret
Description::
+
--
secret defines the Secret containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.grpcServerTlsConfig.keySecret
Description::
+
--
keySecret defines the Secret containing the client key file for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.hostAliases
Description::
+
--
hostAliases defines pods' hostAliases configuration
--

Type::
  `array`




=== .spec.hostAliases[]
Description::
+
--
HostAlias holds the mapping between IP and hostnames that will be injected as an entry in the
pod's hosts file.
--

Type::
  `object`

Required::
  - `hostnames`
  - `ip`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `hostnames`
| `array (string)`
| hostnames defines hostnames for the above IP address.

| `ip`
| `string`
| ip defines the IP address of the host file entry.

|===
=== .spec.imagePullSecrets
Description::
+
--
imagePullSecrets defines an optional list of references to secrets in the same namespace
to use for pulling thanos images from registries
see http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
--

Type::
  `array`




=== .spec.imagePullSecrets[]
Description::
+
--
LocalObjectReference contains enough information to let you locate the
referenced object inside the same namespace.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

|===
=== .spec.initContainers
Description::
+
--
initContainers allows injecting initContainers to the Pod definition.
Those can be used to e.g. fetch secrets for injection into the
configuration from external sources. Any errors during the execution of
an initContainer will lead to a restart of the Pod. More info:
https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
--

Type::
  `array`




=== .spec.initContainers[]
Description::
+
--
A single application container that you want to run within a pod.
--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `args`
| `array (string)`
| Arguments to the entrypoint.
The container image's CMD is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

| `command`
| `array (string)`
| Entrypoint array. Not executed within a shell.
The container image's ENTRYPOINT is used if this is not provided.
Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will
produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless
of whether the variable exists or not. Cannot be updated.
More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

| `env`
| `array`
| List of environment variables to set in the container.
Cannot be updated.

| `env[]`
| `object`
| EnvVar represents an environment variable present in a Container.

| `envFrom`
| `array`
| List of sources to populate environment variables in the container.
The keys defined within a source may consist of any printable ASCII characters except '='.
When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.

| `envFrom[]`
| `object`
| EnvFromSource represents the source of a set of ConfigMaps or Secrets

| `image`
| `string`
| Container image name.
More info: https://kubernetes.io/docs/concepts/containers/images
This field is optional to allow higher level config management to default or override
container images in workload controllers like Deployments and StatefulSets.

| `imagePullPolicy`
| `string`
| Image pull policy.
One of Always, Never, IfNotPresent.
Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

| `lifecycle`
| `object`
| Actions that the management system should take in response to container lifecycle events.
Cannot be updated.

| `livenessProbe`
| `object`
| Periodic probe of container liveness.
Container will be restarted if the probe fails.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

| `name`
| `string`
| Name of the container specified as a DNS_LABEL.
Each container in a pod must have a unique name (DNS_LABEL).
Cannot be updated.

| `ports`
| `array`
| List of ports to expose from the container. Not specifying a port here
DOES NOT prevent that port from being exposed. Any port which is
listening on the default "0.0.0.0" address inside a container will be
accessible from the network.
Modifying this array with strategic merge patch may corrupt the data.
For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.

| `ports[]`
| `object`
| ContainerPort represents a network port in a single container.

| `readinessProbe`
| `object`
| Periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

| `resizePolicy`
| `array`
| Resources resize policy for the container.
This field cannot be set on ephemeral containers.

| `resizePolicy[]`
| `object`
| ContainerResizePolicy represents resource resize policy for the container.

| `resources`
| `object`
| Compute Resources required by this container.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

| `restartPolicy`
| `string`
| RestartPolicy defines the restart behavior of individual containers in a pod.
This overrides the pod-level restart policy. When this field is not specified,
the restart behavior is defined by the Pod's restart policy and the container type.
Additionally, setting the RestartPolicy as "Always" for the init container will
have the following effect:
this init container will be continually restarted on
exit until all regular containers have terminated. Once all regular
containers have completed, all init containers with restartPolicy "Always"
will be shut down. This lifecycle differs from normal init containers and
is often referred to as a "sidecar" container. Although this init
container still starts in the init container sequence, it does not wait
for the container to complete before proceeding to the next init
container. Instead, the next init container starts immediately after this
init container is started, or after any startupProbe has successfully
completed.

| `restartPolicyRules`
| `array`
| Represents a list of rules to be checked to determine if the
container should be restarted on exit. The rules are evaluated in
order. Once a rule matches a container exit condition, the remaining
rules are ignored. If no rule matches the container exit condition,
the Container-level restart policy determines the whether the container
is restarted or not. Constraints on the rules:
- At most 20 rules are allowed.
- Rules can have the same action.
- Identical rules are not forbidden in validations.
When rules are specified, container MUST set RestartPolicy explicitly
even it if matches the Pod's RestartPolicy.

| `restartPolicyRules[]`
| `object`
| ContainerRestartRule describes how a container exit is handled.

| `securityContext`
| `object`
| SecurityContext defines the security options the container should be run with.
If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

| `startupProbe`
| `object`
| StartupProbe indicates that the Pod has successfully initialized.
If specified, no other probes are executed until this completes successfully.
If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
when it might take a long time to load data or warm a cache, than during steady-state operation.
This cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

| `stdin`
| `boolean`
| Whether this container should allocate a buffer for stdin in the container runtime. If this
is not set, reads from stdin in the container will always result in EOF.
Default is false.

| `stdinOnce`
| `boolean`
| Whether the container runtime should close the stdin channel after it has been opened by
a single attach. When stdin is true the stdin stream will remain open across multiple attach
sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the
first client attaches to stdin, and then remains open and accepts data until the client disconnects,
at which time stdin is closed and remains closed until the container is restarted. If this
flag is false, a container processes that reads from stdin will never receive an EOF.
Default is false

| `terminationMessagePath`
| `string`
| Optional: Path at which the file to which the container's termination message
will be written is mounted into the container's filesystem.
Message written is intended to be brief final status, such as an assertion failure message.
Will be truncated by the node if greater than 4096 bytes. The total message length across
all containers will be limited to 12kb.
Defaults to /dev/termination-log.
Cannot be updated.

| `terminationMessagePolicy`
| `string`
| Indicate how the termination message should be populated. File will use the contents of
terminationMessagePath to populate the container status message on both success and failure.
FallbackToLogsOnError will use the last chunk of container log output if the termination
message file is empty and the container exited with an error.
The log output is limited to 2048 bytes or 80 lines, whichever is smaller.
Defaults to File.
Cannot be updated.

| `tty`
| `boolean`
| Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.

| `volumeDevices`
| `array`
| volumeDevices is the list of block devices to be used by the container.

| `volumeDevices[]`
| `object`
| volumeDevice describes a mapping of a raw block device within a container.

| `volumeMounts`
| `array`
| Pod volumes to mount into the container's filesystem.
Cannot be updated.

| `volumeMounts[]`
| `object`
| VolumeMount describes a mounting of a Volume within a container.

| `workingDir`
| `string`
| Container's working directory.
If not specified, the container runtime's default will be used, which
might be configured in the container image.
Cannot be updated.

|===
=== .spec.initContainers[].env
Description::
+
--
List of environment variables to set in the container.
Cannot be updated.
--

Type::
  `array`




=== .spec.initContainers[].env[]
Description::
+
--
EnvVar represents an environment variable present in a Container.
--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the environment variable.
May consist of any printable ASCII characters except '='.

| `value`
| `string`
| Variable references $(VAR_NAME) are expanded
using the previously defined environment variables in the container and
any service environment variables. If a variable cannot be resolved,
the reference in the input string will be unchanged. Double $$ are reduced
to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.
"$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".
Escaped references will never be expanded, regardless of whether the variable
exists or not.
Defaults to "".

| `valueFrom`
| `object`
| Source for the environment variable's value. Cannot be used if value is not empty.

|===
=== .spec.initContainers[].env[].valueFrom
Description::
+
--
Source for the environment variable's value. Cannot be used if value is not empty.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `configMapKeyRef`
| `object`
| Selects a key of a ConfigMap.

| `fieldRef`
| `object`
| Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

| `fileKeyRef`
| `object`
| FileKeyRef selects a key of the env file.
Requires the EnvFiles feature gate to be enabled.

| `resourceFieldRef`
| `object`
| Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

| `secretKeyRef`
| `object`
| Selects a key of a secret in the pod's namespace

|===
=== .spec.initContainers[].env[].valueFrom.configMapKeyRef
Description::
+
--
Selects a key of a ConfigMap.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key to select.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the ConfigMap or its key must be defined

|===
=== .spec.initContainers[].env[].valueFrom.fieldRef
Description::
+
--
Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels['<KEY>']`, `metadata.annotations['<KEY>']`,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.
--

Type::
  `object`

Required::
  - `fieldPath`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiVersion`
| `string`
| Version of the schema the FieldPath is written in terms of, defaults to "v1".

| `fieldPath`
| `string`
| Path of the field to select in the specified API version.

|===
=== .spec.initContainers[].env[].valueFrom.fileKeyRef
Description::
+
--
FileKeyRef selects a key of the env file.
Requires the EnvFiles feature gate to be enabled.
--

Type::
  `object`

Required::
  - `key`
  - `path`
  - `volumeName`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key within the env file. An invalid key will prevent the pod from starting.
The keys defined within a source may consist of any printable ASCII characters except '='.
During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.

| `optional`
| `boolean`
| Specify whether the file or its key must be defined. If the file or key
does not exist, then the env var is not published.
If optional is set to true and the specified key does not exist,
the environment variable will not be set in the Pod's containers.

If optional is set to false and the specified key does not exist,
an error will be returned during Pod creation.

| `path`
| `string`
| The path within the volume from which to select the file.
Must be relative and may not contain the '..' path or start with '..'.

| `volumeName`
| `string`
| The name of the volume mount containing the env file.

|===
=== .spec.initContainers[].env[].valueFrom.resourceFieldRef
Description::
+
--
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.
--

Type::
  `object`

Required::
  - `resource`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `containerName`
| `string`
| Container name: required for volumes, optional for env vars

| `divisor`
| `integer-or-string`
| Specifies the output format of the exposed resources, defaults to "1"

| `resource`
| `string`
| Required: resource to select

|===
=== .spec.initContainers[].env[].valueFrom.secretKeyRef
Description::
+
--
Selects a key of a secret in the pod's namespace
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.initContainers[].envFrom
Description::
+
--
List of sources to populate environment variables in the container.
The keys defined within a source may consist of any printable ASCII characters except '='.
When a key exists in multiple
sources, the value associated with the last source will take precedence.
Values defined by an Env with a duplicate key will take precedence.
Cannot be updated.
--

Type::
  `array`




=== .spec.initContainers[].envFrom[]
Description::
+
--
EnvFromSource represents the source of a set of ConfigMaps or Secrets
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `configMapRef`
| `object`
| The ConfigMap to select from

| `prefix`
| `string`
| Optional text to prepend to the name of each environment variable.
May consist of any printable ASCII characters except '='.

| `secretRef`
| `object`
| The Secret to select from

|===
=== .spec.initContainers[].envFrom[].configMapRef
Description::
+
--
The ConfigMap to select from
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the ConfigMap must be defined

|===
=== .spec.initContainers[].envFrom[].secretRef
Description::
+
--
The Secret to select from
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret must be defined

|===
=== .spec.initContainers[].lifecycle
Description::
+
--
Actions that the management system should take in response to container lifecycle events.
Cannot be updated.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `postStart`
| `object`
| PostStart is called immediately after a container is created. If the handler fails,
the container is terminated and restarted according to its restart policy.
Other management of the container blocks until the hook completes.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

| `preStop`
| `object`
| PreStop is called immediately before a container is terminated due to an
API request or management event such as liveness/startup probe failure,
preemption, resource contention, etc. The handler is not called if the
container crashes or exits. The Pod's termination grace period countdown begins before the
PreStop hook is executed. Regardless of the outcome of the handler, the
container will eventually terminate within the Pod's termination grace
period (unless delayed by finalizers). Other management of the container blocks until the hook completes
or until the termination grace period is reached.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

| `stopSignal`
| `string`
| StopSignal defines which signal will be sent to a container when it is being stopped.
If not specified, the default is defined by the container runtime in use.
StopSignal can only be set for Pods with a non-empty .spec.os.name

|===
=== .spec.initContainers[].lifecycle.postStart
Description::
+
--
PostStart is called immediately after a container is created. If the handler fails,
the container is terminated and restarted according to its restart policy.
Other management of the container blocks until the hook completes.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `exec`
| `object`
| Exec specifies a command to execute in the container.

| `httpGet`
| `object`
| HTTPGet specifies an HTTP GET request to perform.

| `sleep`
| `object`
| Sleep represents a duration that the container should sleep.

| `tcpSocket`
| `object`
| Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified.

|===
=== .spec.initContainers[].lifecycle.postStart.exec
Description::
+
--
Exec specifies a command to execute in the container.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `command`
| `array (string)`
| Command is the command line to execute inside the container, the working directory for the
command  is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

|===
=== .spec.initContainers[].lifecycle.postStart.httpGet
Description::
+
--
HTTPGet specifies an HTTP GET request to perform.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.

| `httpHeaders`
| `array`
| Custom headers to set in the request. HTTP allows repeated headers.

| `httpHeaders[]`
| `object`
| HTTPHeader describes a custom header to be used in HTTP probes

| `path`
| `string`
| Path to access on the HTTP server.

| `port`
| `integer-or-string`
| Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

| `scheme`
| `string`
| Scheme to use for connecting to the host.
Defaults to HTTP.

|===
=== .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders
Description::
+
--
Custom headers to set in the request. HTTP allows repeated headers.
--

Type::
  `array`




=== .spec.initContainers[].lifecycle.postStart.httpGet.httpHeaders[]
Description::
+
--
HTTPHeader describes a custom header to be used in HTTP probes
--

Type::
  `object`

Required::
  - `name`
  - `value`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header.

| `value`
| `string`
| The header field value

|===
=== .spec.initContainers[].lifecycle.postStart.sleep
Description::
+
--
Sleep represents a duration that the container should sleep.
--

Type::
  `object`

Required::
  - `seconds`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `seconds`
| `integer`
| Seconds is the number of seconds to sleep.

|===
=== .spec.initContainers[].lifecycle.postStart.tcpSocket
Description::
+
--
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Optional: Host name to connect to, defaults to the pod IP.

| `port`
| `integer-or-string`
| Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

|===
=== .spec.initContainers[].lifecycle.preStop
Description::
+
--
PreStop is called immediately before a container is terminated due to an
API request or management event such as liveness/startup probe failure,
preemption, resource contention, etc. The handler is not called if the
container crashes or exits. The Pod's termination grace period countdown begins before the
PreStop hook is executed. Regardless of the outcome of the handler, the
container will eventually terminate within the Pod's termination grace
period (unless delayed by finalizers). Other management of the container blocks until the hook completes
or until the termination grace period is reached.
More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `exec`
| `object`
| Exec specifies a command to execute in the container.

| `httpGet`
| `object`
| HTTPGet specifies an HTTP GET request to perform.

| `sleep`
| `object`
| Sleep represents a duration that the container should sleep.

| `tcpSocket`
| `object`
| Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified.

|===
=== .spec.initContainers[].lifecycle.preStop.exec
Description::
+
--
Exec specifies a command to execute in the container.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `command`
| `array (string)`
| Command is the command line to execute inside the container, the working directory for the
command  is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

|===
=== .spec.initContainers[].lifecycle.preStop.httpGet
Description::
+
--
HTTPGet specifies an HTTP GET request to perform.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.

| `httpHeaders`
| `array`
| Custom headers to set in the request. HTTP allows repeated headers.

| `httpHeaders[]`
| `object`
| HTTPHeader describes a custom header to be used in HTTP probes

| `path`
| `string`
| Path to access on the HTTP server.

| `port`
| `integer-or-string`
| Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

| `scheme`
| `string`
| Scheme to use for connecting to the host.
Defaults to HTTP.

|===
=== .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders
Description::
+
--
Custom headers to set in the request. HTTP allows repeated headers.
--

Type::
  `array`




=== .spec.initContainers[].lifecycle.preStop.httpGet.httpHeaders[]
Description::
+
--
HTTPHeader describes a custom header to be used in HTTP probes
--

Type::
  `object`

Required::
  - `name`
  - `value`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header.

| `value`
| `string`
| The header field value

|===
=== .spec.initContainers[].lifecycle.preStop.sleep
Description::
+
--
Sleep represents a duration that the container should sleep.
--

Type::
  `object`

Required::
  - `seconds`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `seconds`
| `integer`
| Seconds is the number of seconds to sleep.

|===
=== .spec.initContainers[].lifecycle.preStop.tcpSocket
Description::
+
--
Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept
for backward compatibility. There is no validation of this field and
lifecycle hooks will fail at runtime when it is specified.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Optional: Host name to connect to, defaults to the pod IP.

| `port`
| `integer-or-string`
| Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

|===
=== .spec.initContainers[].livenessProbe
Description::
+
--
Periodic probe of container liveness.
Container will be restarted if the probe fails.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `exec`
| `object`
| Exec specifies a command to execute in the container.

| `failureThreshold`
| `integer`
| Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.

| `grpc`
| `object`
| GRPC specifies a GRPC HealthCheckRequest.

| `httpGet`
| `object`
| HTTPGet specifies an HTTP GET request to perform.

| `initialDelaySeconds`
| `integer`
| Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

| `periodSeconds`
| `integer`
| How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.

| `successThreshold`
| `integer`
| Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

| `tcpSocket`
| `object`
| TCPSocket specifies a connection to a TCP port.

| `terminationGracePeriodSeconds`
| `integer`
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

| `timeoutSeconds`
| `integer`
| Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

|===
=== .spec.initContainers[].livenessProbe.exec
Description::
+
--
Exec specifies a command to execute in the container.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `command`
| `array (string)`
| Command is the command line to execute inside the container, the working directory for the
command  is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

|===
=== .spec.initContainers[].livenessProbe.grpc
Description::
+
--
GRPC specifies a GRPC HealthCheckRequest.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `port`
| `integer`
| Port number of the gRPC service. Number must be in the range 1 to 65535.

| `service`
| `string`
| Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

If this is not specified, the default behavior is defined by gRPC.

|===
=== .spec.initContainers[].livenessProbe.httpGet
Description::
+
--
HTTPGet specifies an HTTP GET request to perform.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.

| `httpHeaders`
| `array`
| Custom headers to set in the request. HTTP allows repeated headers.

| `httpHeaders[]`
| `object`
| HTTPHeader describes a custom header to be used in HTTP probes

| `path`
| `string`
| Path to access on the HTTP server.

| `port`
| `integer-or-string`
| Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

| `scheme`
| `string`
| Scheme to use for connecting to the host.
Defaults to HTTP.

|===
=== .spec.initContainers[].livenessProbe.httpGet.httpHeaders
Description::
+
--
Custom headers to set in the request. HTTP allows repeated headers.
--

Type::
  `array`




=== .spec.initContainers[].livenessProbe.httpGet.httpHeaders[]
Description::
+
--
HTTPHeader describes a custom header to be used in HTTP probes
--

Type::
  `object`

Required::
  - `name`
  - `value`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header.

| `value`
| `string`
| The header field value

|===
=== .spec.initContainers[].livenessProbe.tcpSocket
Description::
+
--
TCPSocket specifies a connection to a TCP port.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Optional: Host name to connect to, defaults to the pod IP.

| `port`
| `integer-or-string`
| Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

|===
=== .spec.initContainers[].ports
Description::
+
--
List of ports to expose from the container. Not specifying a port here
DOES NOT prevent that port from being exposed. Any port which is
listening on the default "0.0.0.0" address inside a container will be
accessible from the network.
Modifying this array with strategic merge patch may corrupt the data.
For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
--

Type::
  `array`




=== .spec.initContainers[].ports[]
Description::
+
--
ContainerPort represents a network port in a single container.
--

Type::
  `object`

Required::
  - `containerPort`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `containerPort`
| `integer`
| Number of port to expose on the pod's IP address.
This must be a valid port number, 0 < x < 65536.

| `hostIP`
| `string`
| What host IP to bind the external port to.

| `hostPort`
| `integer`
| Number of port to expose on the host.
If specified, this must be a valid port number, 0 < x < 65536.
If HostNetwork is specified, this must match ContainerPort.
Most containers do not need this.

| `name`
| `string`
| If specified, this must be an IANA_SVC_NAME and unique within the pod. Each
named port in a pod must have a unique name. Name for the port that can be
referred to by services.

| `protocol`
| `string`
| Protocol for port. Must be UDP, TCP, or SCTP.
Defaults to "TCP".

|===
=== .spec.initContainers[].readinessProbe
Description::
+
--
Periodic probe of container service readiness.
Container will be removed from service endpoints if the probe fails.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `exec`
| `object`
| Exec specifies a command to execute in the container.

| `failureThreshold`
| `integer`
| Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.

| `grpc`
| `object`
| GRPC specifies a GRPC HealthCheckRequest.

| `httpGet`
| `object`
| HTTPGet specifies an HTTP GET request to perform.

| `initialDelaySeconds`
| `integer`
| Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

| `periodSeconds`
| `integer`
| How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.

| `successThreshold`
| `integer`
| Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

| `tcpSocket`
| `object`
| TCPSocket specifies a connection to a TCP port.

| `terminationGracePeriodSeconds`
| `integer`
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

| `timeoutSeconds`
| `integer`
| Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

|===
=== .spec.initContainers[].readinessProbe.exec
Description::
+
--
Exec specifies a command to execute in the container.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `command`
| `array (string)`
| Command is the command line to execute inside the container, the working directory for the
command  is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

|===
=== .spec.initContainers[].readinessProbe.grpc
Description::
+
--
GRPC specifies a GRPC HealthCheckRequest.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `port`
| `integer`
| Port number of the gRPC service. Number must be in the range 1 to 65535.

| `service`
| `string`
| Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

If this is not specified, the default behavior is defined by gRPC.

|===
=== .spec.initContainers[].readinessProbe.httpGet
Description::
+
--
HTTPGet specifies an HTTP GET request to perform.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.

| `httpHeaders`
| `array`
| Custom headers to set in the request. HTTP allows repeated headers.

| `httpHeaders[]`
| `object`
| HTTPHeader describes a custom header to be used in HTTP probes

| `path`
| `string`
| Path to access on the HTTP server.

| `port`
| `integer-or-string`
| Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

| `scheme`
| `string`
| Scheme to use for connecting to the host.
Defaults to HTTP.

|===
=== .spec.initContainers[].readinessProbe.httpGet.httpHeaders
Description::
+
--
Custom headers to set in the request. HTTP allows repeated headers.
--

Type::
  `array`




=== .spec.initContainers[].readinessProbe.httpGet.httpHeaders[]
Description::
+
--
HTTPHeader describes a custom header to be used in HTTP probes
--

Type::
  `object`

Required::
  - `name`
  - `value`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header.

| `value`
| `string`
| The header field value

|===
=== .spec.initContainers[].readinessProbe.tcpSocket
Description::
+
--
TCPSocket specifies a connection to a TCP port.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Optional: Host name to connect to, defaults to the pod IP.

| `port`
| `integer-or-string`
| Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

|===
=== .spec.initContainers[].resizePolicy
Description::
+
--
Resources resize policy for the container.
This field cannot be set on ephemeral containers.
--

Type::
  `array`




=== .spec.initContainers[].resizePolicy[]
Description::
+
--
ContainerResizePolicy represents resource resize policy for the container.
--

Type::
  `object`

Required::
  - `resourceName`
  - `restartPolicy`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `resourceName`
| `string`
| Name of the resource to which this resource resize policy applies.
Supported values: cpu, memory.

| `restartPolicy`
| `string`
| Restart policy to apply when specified resource is resized.
If not specified, it defaults to NotRequired.

|===
=== .spec.initContainers[].resources
Description::
+
--
Compute Resources required by this container.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `claims`
| `array`
| Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.

This field depends on the
DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

| `claims[]`
| `object`
| ResourceClaim references one entry in PodSpec.ResourceClaims.

| `limits`
| `integer-or-string`
| Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

| `requests`
| `integer-or-string`
| Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

|===
=== .spec.initContainers[].resources.claims
Description::
+
--
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.

This field depends on the
DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.
--

Type::
  `array`




=== .spec.initContainers[].resources.claims[]
Description::
+
--
ResourceClaim references one entry in PodSpec.ResourceClaims.
--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container.

| `request`
| `string`
| Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request.

|===
=== .spec.initContainers[].restartPolicyRules
Description::
+
--
Represents a list of rules to be checked to determine if the
container should be restarted on exit. The rules are evaluated in
order. Once a rule matches a container exit condition, the remaining
rules are ignored. If no rule matches the container exit condition,
the Container-level restart policy determines the whether the container
is restarted or not. Constraints on the rules:
- At most 20 rules are allowed.
- Rules can have the same action.
- Identical rules are not forbidden in validations.
When rules are specified, container MUST set RestartPolicy explicitly
even it if matches the Pod's RestartPolicy.
--

Type::
  `array`




=== .spec.initContainers[].restartPolicyRules[]
Description::
+
--
ContainerRestartRule describes how a container exit is handled.
--

Type::
  `object`

Required::
  - `action`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `action`
| `string`
| Specifies the action taken on a container exit if the requirements
are satisfied. The only possible value is "Restart" to restart the
container.

| `exitCodes`
| `object`
| Represents the exit codes to check on container exits.

|===
=== .spec.initContainers[].restartPolicyRules[].exitCodes
Description::
+
--
Represents the exit codes to check on container exits.
--

Type::
  `object`

Required::
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `operator`
| `string`
| Represents the relationship between the container exit code(s) and the
specified values. Possible values are:
- In: the requirement is satisfied if the container exit code is in the
  set of specified values.
- NotIn: the requirement is satisfied if the container exit code is
  not in the set of specified values.

| `values`
| `array (integer)`
| Specifies the set of values to check for container exit codes.
At most 255 elements are allowed.

|===
=== .spec.initContainers[].securityContext
Description::
+
--
SecurityContext defines the security options the container should be run with.
If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.
More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `allowPrivilegeEscalation`
| `boolean`
| AllowPrivilegeEscalation controls whether a process can gain more
privileges than its parent process. This bool directly controls if
the no_new_privs flag will be set on the container process.
AllowPrivilegeEscalation is true always when the container is:
1) run as Privileged
2) has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows.

| `appArmorProfile`
| `object`
| appArmorProfile is the AppArmor options to use by this container. If set, this profile
overrides the pod's appArmorProfile.
Note that this field cannot be set when spec.os.name is windows.

| `capabilities`
| `object`
| The capabilities to add/drop when running containers.
Defaults to the default set of capabilities granted by the container runtime.
Note that this field cannot be set when spec.os.name is windows.

| `privileged`
| `boolean`
| Run container in privileged mode.
Processes in privileged containers are essentially equivalent to root on the host.
Defaults to false.
Note that this field cannot be set when spec.os.name is windows.

| `procMount`
| `string`
| procMount denotes the type of proc mount to use for the containers.
The default value is Default which uses the container runtime defaults for
readonly paths and masked paths.
This requires the ProcMountType feature flag to be enabled.
Note that this field cannot be set when spec.os.name is windows.

| `readOnlyRootFilesystem`
| `boolean`
| Whether this container has a read-only root filesystem.
Default is false.
Note that this field cannot be set when spec.os.name is windows.

| `runAsGroup`
| `integer`
| The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in PodSecurityContext.  If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.

| `runAsNonRoot`
| `boolean`
| Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in PodSecurityContext.  If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.

| `runAsUser`
| `integer`
| The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in PodSecurityContext.  If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.

| `seLinuxOptions`
| `object`
| The SELinux context to be applied to the container.
If unspecified, the container runtime will allocate a random SELinux context for each
container.  May also be set in PodSecurityContext.  If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.

| `seccompProfile`
| `object`
| The seccomp options to use by this container. If seccomp options are
provided at both the pod & container level, the container options
override the pod options.
Note that this field cannot be set when spec.os.name is windows.

| `windowsOptions`
| `object`
| The Windows specific settings applied to all containers.
If unspecified, the options from the PodSecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux.

|===
=== .spec.initContainers[].securityContext.appArmorProfile
Description::
+
--
appArmorProfile is the AppArmor options to use by this container. If set, this profile
overrides the pod's appArmorProfile.
Note that this field cannot be set when spec.os.name is windows.
--

Type::
  `object`

Required::
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `localhostProfile`
| `string`
| localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost".

| `type`
| `string`
| type indicates which kind of AppArmor profile will be applied.
Valid options are:
  Localhost - a profile pre-loaded on the node.
  RuntimeDefault - the container runtime's default profile.
  Unconfined - no AppArmor enforcement.

|===
=== .spec.initContainers[].securityContext.capabilities
Description::
+
--
The capabilities to add/drop when running containers.
Defaults to the default set of capabilities granted by the container runtime.
Note that this field cannot be set when spec.os.name is windows.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `add`
| `array (string)`
| Added capabilities

| `drop`
| `array (string)`
| Removed capabilities

|===
=== .spec.initContainers[].securityContext.seLinuxOptions
Description::
+
--
The SELinux context to be applied to the container.
If unspecified, the container runtime will allocate a random SELinux context for each
container.  May also be set in PodSecurityContext.  If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is windows.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `level`
| `string`
| Level is SELinux level label that applies to the container.

| `role`
| `string`
| Role is a SELinux role label that applies to the container.

| `type`
| `string`
| Type is a SELinux type label that applies to the container.

| `user`
| `string`
| User is a SELinux user label that applies to the container.

|===
=== .spec.initContainers[].securityContext.seccompProfile
Description::
+
--
The seccomp options to use by this container. If seccomp options are
provided at both the pod & container level, the container options
override the pod options.
Note that this field cannot be set when spec.os.name is windows.
--

Type::
  `object`

Required::
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `localhostProfile`
| `string`
| localhostProfile indicates a profile defined in a file on the node should be used.
The profile must be preconfigured on the node to work.
Must be a descending path, relative to the kubelet's configured seccomp profile location.
Must be set if type is "Localhost". Must NOT be set for any other type.

| `type`
| `string`
| type indicates which kind of seccomp profile will be applied.
Valid options are:

Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied.

|===
=== .spec.initContainers[].securityContext.windowsOptions
Description::
+
--
The Windows specific settings applied to all containers.
If unspecified, the options from the PodSecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `gmsaCredentialSpec`
| `string`
| GMSACredentialSpec is where the GMSA admission webhook
(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
GMSA credential spec named by the GMSACredentialSpecName field.

| `gmsaCredentialSpecName`
| `string`
| GMSACredentialSpecName is the name of the GMSA credential spec to use.

| `hostProcess`
| `boolean`
| HostProcess determines if a container should be run as a 'Host Process' container.
All of a Pod's containers must have the same effective HostProcess value
(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
In addition, if HostProcess is true then HostNetwork must also be set to true.

| `runAsUserName`
| `string`
| The UserName in Windows to run the entrypoint of the container process.
Defaults to the user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.

|===
=== .spec.initContainers[].startupProbe
Description::
+
--
StartupProbe indicates that the Pod has successfully initialized.
If specified, no other probes are executed until this completes successfully.
If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.
This can be used to provide different probe parameters at the beginning of a Pod's lifecycle,
when it might take a long time to load data or warm a cache, than during steady-state operation.
This cannot be updated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `exec`
| `object`
| Exec specifies a command to execute in the container.

| `failureThreshold`
| `integer`
| Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.

| `grpc`
| `object`
| GRPC specifies a GRPC HealthCheckRequest.

| `httpGet`
| `object`
| HTTPGet specifies an HTTP GET request to perform.

| `initialDelaySeconds`
| `integer`
| Number of seconds after the container has started before liveness probes are initiated.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

| `periodSeconds`
| `integer`
| How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.

| `successThreshold`
| `integer`
| Minimum consecutive successes for the probe to be considered successful after having failed.
Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

| `tcpSocket`
| `object`
| TCPSocket specifies a connection to a TCP port.

| `terminationGracePeriodSeconds`
| `integer`
| Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
The grace period is the duration in seconds after the processes running in the pod are sent
a termination signal and the time when the processes are forcibly halted with a kill signal.
Set this value longer than the expected cleanup time for your process.
If this value is nil, the pod's terminationGracePeriodSeconds will be used. Otherwise, this
value overrides the value provided by the pod spec.
Value must be non-negative integer. The value zero indicates stop immediately via
the kill signal (no opportunity to shut down).
This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.
Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

| `timeoutSeconds`
| `integer`
| Number of seconds after which the probe times out.
Defaults to 1 second. Minimum value is 1.
More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

|===
=== .spec.initContainers[].startupProbe.exec
Description::
+
--
Exec specifies a command to execute in the container.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `command`
| `array (string)`
| Command is the command line to execute inside the container, the working directory for the
command  is root ('/') in the container's filesystem. The command is simply exec'd, it is
not run inside a shell, so traditional shell instructions ('\|', etc) won't work. To use
a shell, you need to explicitly call out to that shell.
Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

|===
=== .spec.initContainers[].startupProbe.grpc
Description::
+
--
GRPC specifies a GRPC HealthCheckRequest.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `port`
| `integer`
| Port number of the gRPC service. Number must be in the range 1 to 65535.

| `service`
| `string`
| Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).

If this is not specified, the default behavior is defined by gRPC.

|===
=== .spec.initContainers[].startupProbe.httpGet
Description::
+
--
HTTPGet specifies an HTTP GET request to perform.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.

| `httpHeaders`
| `array`
| Custom headers to set in the request. HTTP allows repeated headers.

| `httpHeaders[]`
| `object`
| HTTPHeader describes a custom header to be used in HTTP probes

| `path`
| `string`
| Path to access on the HTTP server.

| `port`
| `integer-or-string`
| Name or number of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

| `scheme`
| `string`
| Scheme to use for connecting to the host.
Defaults to HTTP.

|===
=== .spec.initContainers[].startupProbe.httpGet.httpHeaders
Description::
+
--
Custom headers to set in the request. HTTP allows repeated headers.
--

Type::
  `array`




=== .spec.initContainers[].startupProbe.httpGet.httpHeaders[]
Description::
+
--
HTTPHeader describes a custom header to be used in HTTP probes
--

Type::
  `object`

Required::
  - `name`
  - `value`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| The header field name.
This will be canonicalized upon output, so case-variant names will be understood as the same header.

| `value`
| `string`
| The header field value

|===
=== .spec.initContainers[].startupProbe.tcpSocket
Description::
+
--
TCPSocket specifies a connection to a TCP port.
--

Type::
  `object`

Required::
  - `port`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `host`
| `string`
| Optional: Host name to connect to, defaults to the pod IP.

| `port`
| `integer-or-string`
| Number or name of the port to access on the container.
Number must be in the range 1 to 65535.
Name must be an IANA_SVC_NAME.

|===
=== .spec.initContainers[].volumeDevices
Description::
+
--
volumeDevices is the list of block devices to be used by the container.
--

Type::
  `array`




=== .spec.initContainers[].volumeDevices[]
Description::
+
--
volumeDevice describes a mapping of a raw block device within a container.
--

Type::
  `object`

Required::
  - `devicePath`
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `devicePath`
| `string`
| devicePath is the path inside of the container that the device will be mapped to.

| `name`
| `string`
| name must match the name of a persistentVolumeClaim in the pod

|===
=== .spec.initContainers[].volumeMounts
Description::
+
--
Pod volumes to mount into the container's filesystem.
Cannot be updated.
--

Type::
  `array`




=== .spec.initContainers[].volumeMounts[]
Description::
+
--
VolumeMount describes a mounting of a Volume within a container.
--

Type::
  `object`

Required::
  - `mountPath`
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `mountPath`
| `string`
| Path within the container at which the volume should be mounted.  Must
not contain ':'.

| `mountPropagation`
| `string`
| mountPropagation determines how mounts are propagated from the host
to container and the other way around.
When not set, MountPropagationNone is used.
This field is beta in 1.10.
When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
(which defaults to None).

| `name`
| `string`
| This must match the Name of a Volume.

| `readOnly`
| `boolean`
| Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.

| `recursiveReadOnly`
| `string`
| RecursiveReadOnly specifies whether read-only mounts should be handled
recursively.

If ReadOnly is false, this field has no meaning and must be unspecified.

If ReadOnly is true, and this field is set to Disabled, the mount is not made
recursively read-only.  If this field is set to IfPossible, the mount is made
recursively read-only, if it is supported by the container runtime.  If this
field is set to Enabled, the mount is made recursively read-only if it is
supported by the container runtime, otherwise the pod will not be started and
an error will be generated to indicate the reason.

If this field is set to IfPossible or Enabled, MountPropagation must be set to
None (or be unspecified, which defaults to None).

If this field is not specified, it is treated as an equivalent of Disabled.

| `subPath`
| `string`
| Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).

| `subPathExpr`
| `string`
| Expanded path within the volume from which the container's volume should be mounted.
Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
Defaults to "" (volume's root).
SubPathExpr and SubPath are mutually exclusive.

|===
=== .spec.objectStorageConfig
Description::
+
--
objectStorageConfig defines the configuration format is defined at https://thanos.io/tip/thanos/storage.md/#configuring-access-to-object-storage

The operator performs no validation of the configuration.

`objectStorageConfigFile` takes precedence over this field.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.podMetadata
Description::
+
--
podMetadata defines labels and annotations which are propagated to the ThanosRuler pods.

The following items are reserved and cannot be overridden:
* "app.kubernetes.io/name" label, set to "thanos-ruler".
* "app.kubernetes.io/managed-by" label, set to "prometheus-operator".
* "app.kubernetes.io/instance" label, set to the name of the ThanosRuler instance.
* "thanos-ruler" label, set to the name of the ThanosRuler instance.
* "kubectl.kubernetes.io/default-container" annotation, set to "thanos-ruler".
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `annotations`
| `object (string)`
| annotations defines an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

| `labels`
| `object (string)`
| labels define the map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

| `name`
| `string`
| name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/

|===
=== .spec.prometheusRulesExcludedFromEnforce
Description::
+
--
prometheusRulesExcludedFromEnforce defines a list of Prometheus rules to be excluded from enforcing
of adding namespace labels. Works only if enforcedNamespaceLabel set to true.
Make sure both ruleNamespace and ruleName are set for each pair
Deprecated: use excludedFromEnforcement instead.
--

Type::
  `array`




=== .spec.prometheusRulesExcludedFromEnforce[]
Description::
+
--
PrometheusRuleExcludeConfig enables users to configure excluded
PrometheusRule names and their namespaces to be ignored while enforcing
namespace label for alerts and metrics.
--

Type::
  `object`

Required::
  - `ruleName`
  - `ruleNamespace`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `ruleName`
| `string`
| ruleName defines the name of the excluded PrometheusRule object.

| `ruleNamespace`
| `string`
| ruleNamespace defines the namespace of the excluded PrometheusRule object.

|===
=== .spec.queryConfig
Description::
+
--
queryConfig defines the list of Thanos Query endpoints from which to query metrics.

The configuration format is defined at https://thanos.io/tip/components/rule.md/#query-api

It requires Thanos >= v0.11.0.

The operator performs no validation of the configuration.

This field takes precedence over `queryEndpoints`.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite
Description::
+
--
remoteWrite defines the list of remote write configurations.

When the list isn't empty, the ruler is configured with stateless mode.

It requires Thanos >= 0.24.0.
--

Type::
  `array`




=== .spec.remoteWrite[]
Description::
+
--
RemoteWriteSpec defines the configuration to write samples from Prometheus
to a remote endpoint.
--

Type::
  `object`

Required::
  - `url`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `authorization`
| `object`
| authorization section for the URL.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

Cannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`.

| `azureAd`
| `object`
| azureAd for the URL.

It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.

Cannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`.

| `basicAuth`
| `object`
| basicAuth configuration for the URL.

Cannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`.

| `bearerToken`
| `string`
| bearerToken is deprecated: this will be removed in a future release.
*Warning: this field shouldn't be used because the token value appears
in clear-text. Prefer using `authorization`.*

| `bearerTokenFile`
| `string`
| bearerTokenFile defines the file from which to read bearer token for the URL.

Deprecated: this will be removed in a future release. Prefer using `authorization`.

| `enableHTTP2`
| `boolean`
| enableHTTP2 defines whether to enable HTTP2.

| `followRedirects`
| `boolean`
| followRedirects defines whether HTTP requests follow HTTP 3xx redirects.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

| `headers`
| `object (string)`
| headers defines the custom HTTP headers to be sent along with each remote write request.
Be aware that headers that are set by Prometheus itself can't be overwritten.

It requires Prometheus >= v2.25.0 or Thanos >= v0.24.0.

| `messageVersion`
| `string`
| messageVersion defines the Remote Write message's version to use when writing to the endpoint.

`Version1.0` corresponds to the `prometheus.WriteRequest` protobuf message introduced in Remote Write 1.0.
`Version2.0` corresponds to the `io.prometheus.write.v2.Request` protobuf message introduced in Remote Write 2.0.

When `Version2.0` is selected, Prometheus will automatically be
configured to append the metadata of scraped metrics to the WAL.

Before setting this field, consult with your remote storage provider
what message version it supports.

It requires Prometheus >= v2.54.0 or Thanos >= v0.37.0.

| `metadataConfig`
| `object`
| metadataConfig defines how to send a series metadata to the remote storage.

When the field is empty, **no metadata** is sent. But when the field is
null, metadata is sent.

| `name`
| `string`
| name of the remote write queue, it must be unique if specified. The
name is used in metrics and logging in order to differentiate queues.

It requires Prometheus >= v2.15.0 or Thanos >= 0.24.0.

| `noProxy`
| `string`
| noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names
that should be excluded from proxying. IP and domain names can
contain port numbers.

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `oauth2`
| `object`
| oauth2 configuration for the URL.

It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.

Cannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`.

| `proxyConnectHeader`
| `object`
| proxyConnectHeader optionally specifies headers to send to
proxies during CONNECT requests.

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `proxyConnectHeader{}`
| `array`
| 

| `proxyConnectHeader{}[]`
| `object`
| SecretKeySelector selects a key of a Secret.

| `proxyFromEnvironment`
| `boolean`
| proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `proxyUrl`
| `string`
| proxyUrl defines the HTTP proxy server to use.

| `queueConfig`
| `object`
| queueConfig allows tuning of the remote write queue parameters.

| `remoteTimeout`
| `string`
| remoteTimeout defines the timeout for requests to the remote write endpoint.

| `roundRobinDNS`
| `boolean`
| roundRobinDNS controls the DNS resolution behavior for remote-write connections.
When enabled:
  - The remote-write mechanism will resolve the hostname via DNS.
  - It will randomly select one of the resolved IP addresses and connect to it.

When disabled (default behavior):
  - The Go standard library will handle hostname resolution.
  - It will attempt connections to each resolved IP address sequentially.

Note: The connection timeout applies to the entire resolution and connection process.

	If disabled, the timeout is distributed across all connection attempts.

It requires Prometheus >= v3.1.0 or Thanos >= v0.38.0.

| `sendExemplars`
| `boolean`
| sendExemplars enables sending of exemplars over remote write. Note that
exemplar-storage itself must be enabled using the `spec.enableFeatures`
option for exemplars to be scraped in the first place.

It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.

| `sendNativeHistograms`
| `boolean`
| sendNativeHistograms enables sending of native histograms, also known as sparse histograms
over remote write.

It requires Prometheus >= v2.40.0 or Thanos >= v0.30.0.

| `sigv4`
| `object`
| sigv4 defines the AWS's Signature Verification 4 for the URL.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

Cannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`.

| `tlsConfig`
| `object`
| tlsConfig to use for the URL.

| `url`
| `string`
| url defines the URL of the endpoint to send samples to.

It must use the HTTP or HTTPS scheme.

| `writeRelabelConfigs`
| `array`
| writeRelabelConfigs defines the list of remote write relabel configurations.

| `writeRelabelConfigs[]`
| `object`
| RelabelConfig allows dynamic rewriting of the label set for targets, alerts,
scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config

|===
=== .spec.remoteWrite[].authorization
Description::
+
--
authorization section for the URL.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

Cannot be set at the same time as `sigv4`, `basicAuth`, `oauth2`, or `azureAd`.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `credentials`
| `object`
| credentials defines a key of a Secret in the namespace that contains the credentials for authentication.

| `credentialsFile`
| `string`
| credentialsFile defines the file to read a secret from, mutually exclusive with `credentials`.

| `type`
| `string`
| type defines the authentication type. The value is case-insensitive.

"Basic" is not a supported value.

Default: "Bearer"

|===
=== .spec.remoteWrite[].authorization.credentials
Description::
+
--
credentials defines a key of a Secret in the namespace that contains the credentials for authentication.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].azureAd
Description::
+
--
azureAd for the URL.

It requires Prometheus >= v2.45.0 or Thanos >= v0.31.0.

Cannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `sigv4`.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `cloud`
| `string`
| cloud defines the Azure Cloud. Options are 'AzurePublic', 'AzureChina', or 'AzureGovernment'.

| `managedIdentity`
| `object`
| managedIdentity defines the Azure User-assigned Managed identity.
Cannot be set at the same time as `oauth`, `sdk` or `workloadIdentity`.

| `oauth`
| `object`
| oauth defines the oauth config that is being used to authenticate.
Cannot be set at the same time as `managedIdentity`, `sdk` or `workloadIdentity`.

It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.

| `scope`
| `string`
| scope is the custom OAuth 2.0 scope to request when acquiring tokens.
It requires Prometheus >= 3.9.0. Currently not supported by Thanos.

| `sdk`
| `object`
| sdk defines the Azure SDK config that is being used to authenticate.
See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication
Cannot be set at the same time as `oauth`, `managedIdentity` or `workloadIdentity`.

It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.

| `workloadIdentity`
| `object`
| workloadIdentity defines the Azure Workload Identity authentication.
Cannot be set at the same time as `oauth`, `managedIdentity`, or `sdk`.

It requires Prometheus >= 3.7.0. Currently not supported by Thanos.

|===
=== .spec.remoteWrite[].azureAd.managedIdentity
Description::
+
--
managedIdentity defines the Azure User-assigned Managed identity.
Cannot be set at the same time as `oauth`, `sdk` or `workloadIdentity`.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `clientId`
| `string`
| clientId defines the Azure User-assigned Managed identity.

For Prometheus >= 3.5.0 and Thanos >= 0.40.0, this field is allowed to be empty to support system-assigned managed identities.

|===
=== .spec.remoteWrite[].azureAd.oauth
Description::
+
--
oauth defines the oauth config that is being used to authenticate.
Cannot be set at the same time as `managedIdentity`, `sdk` or `workloadIdentity`.

It requires Prometheus >= v2.48.0 or Thanos >= v0.31.0.
--

Type::
  `object`

Required::
  - `clientId`
  - `clientSecret`
  - `tenantId`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `clientId`
| `string`
| clientId defines the clientId of the Azure Active Directory application that is being used to authenticate.

| `clientSecret`
| `object`
| clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.

| `tenantId`
| `string`
| tenantId is the tenant ID of the Azure Active Directory application that is being used to authenticate.

|===
=== .spec.remoteWrite[].azureAd.oauth.clientSecret
Description::
+
--
clientSecret specifies a key of a Secret containing the client secret of the Azure Active Directory application that is being used to authenticate.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].azureAd.sdk
Description::
+
--
sdk defines the Azure SDK config that is being used to authenticate.
See https://learn.microsoft.com/en-us/azure/developer/go/azure-sdk-authentication
Cannot be set at the same time as `oauth`, `managedIdentity` or `workloadIdentity`.

It requires Prometheus >= v2.52.0 or Thanos >= v0.36.0.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `tenantId`
| `string`
| tenantId defines the tenant ID of the azure active directory application that is being used to authenticate.

|===
=== .spec.remoteWrite[].azureAd.workloadIdentity
Description::
+
--
workloadIdentity defines the Azure Workload Identity authentication.
Cannot be set at the same time as `oauth`, `managedIdentity`, or `sdk`.

It requires Prometheus >= 3.7.0. Currently not supported by Thanos.
--

Type::
  `object`

Required::
  - `clientId`
  - `tenantId`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `clientId`
| `string`
| clientId is the clientID of the Azure Active Directory application.

| `tenantId`
| `string`
| tenantId is the tenant ID of the Azure Active Directory application.

|===
=== .spec.remoteWrite[].basicAuth
Description::
+
--
basicAuth configuration for the URL.

Cannot be set at the same time as `sigv4`, `authorization`, `oauth2`, or `azureAd`.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `password`
| `object`
| password defines a key of a Secret containing the password for
authentication.

| `username`
| `object`
| username defines a key of a Secret containing the username for
authentication.

|===
=== .spec.remoteWrite[].basicAuth.password
Description::
+
--
password defines a key of a Secret containing the password for
authentication.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].basicAuth.username
Description::
+
--
username defines a key of a Secret containing the username for
authentication.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].metadataConfig
Description::
+
--
metadataConfig defines how to send a series metadata to the remote storage.

When the field is empty, **no metadata** is sent. But when the field is
null, metadata is sent.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `maxSamplesPerSend`
| `integer`
| maxSamplesPerSend defines the maximum number of metadata samples per send.

It requires Prometheus >= v2.29.0.

| `send`
| `boolean`
| send defines whether metric metadata is sent to the remote storage or not.

| `sendInterval`
| `string`
| sendInterval defines how frequently metric metadata is sent to the remote storage.

|===
=== .spec.remoteWrite[].oauth2
Description::
+
--
oauth2 configuration for the URL.

It requires Prometheus >= v2.27.0 or Thanos >= v0.24.0.

Cannot be set at the same time as `sigv4`, `authorization`, `basicAuth`, or `azureAd`.
--

Type::
  `object`

Required::
  - `clientId`
  - `clientSecret`
  - `tokenUrl`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `clientId`
| `object`
| clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.

| `clientSecret`
| `object`
| clientSecret defines a key of a Secret containing the OAuth2
client's secret.

| `endpointParams`
| `object (string)`
| endpointParams configures the HTTP parameters to append to the token
URL.

| `noProxy`
| `string`
| noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names
that should be excluded from proxying. IP and domain names can
contain port numbers.

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `proxyConnectHeader`
| `object`
| proxyConnectHeader optionally specifies headers to send to
proxies during CONNECT requests.

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `proxyConnectHeader{}`
| `array`
| 

| `proxyConnectHeader{}[]`
| `object`
| SecretKeySelector selects a key of a Secret.

| `proxyFromEnvironment`
| `boolean`
| proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

| `proxyUrl`
| `string`
| proxyUrl defines the HTTP proxy server to use.

| `scopes`
| `array (string)`
| scopes defines the OAuth2 scopes used for the token request.

| `tlsConfig`
| `object`
| tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.

| `tokenUrl`
| `string`
| tokenUrl defines the URL to fetch the token from.

|===
=== .spec.remoteWrite[].oauth2.clientId
Description::
+
--
clientId defines a key of a Secret or ConfigMap containing the
OAuth2 client's ID.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `configMap`
| `object`
| configMap defines the ConfigMap containing data to use for the targets.

| `secret`
| `object`
| secret defines the Secret containing data to use for the targets.

|===
=== .spec.remoteWrite[].oauth2.clientId.configMap
Description::
+
--
configMap defines the ConfigMap containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key to select.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the ConfigMap or its key must be defined

|===
=== .spec.remoteWrite[].oauth2.clientId.secret
Description::
+
--
secret defines the Secret containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].oauth2.clientSecret
Description::
+
--
clientSecret defines a key of a Secret containing the OAuth2
client's secret.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].oauth2.proxyConnectHeader
Description::
+
--
proxyConnectHeader optionally specifies headers to send to
proxies during CONNECT requests.

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
--

Type::
  `object`




=== .spec.remoteWrite[].oauth2.proxyConnectHeader{}
Description::
+
--

--

Type::
  `array`




=== .spec.remoteWrite[].oauth2.proxyConnectHeader{}[]
Description::
+
--
SecretKeySelector selects a key of a Secret.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].oauth2.tlsConfig
Description::
+
--
tlsConfig defines the TLS configuration to use when connecting to the OAuth2 server.
It requires Prometheus >= v2.43.0.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `ca`
| `object`
| ca defines the Certificate authority used when verifying server certificates.

| `cert`
| `object`
| cert defines the Client certificate to present when doing client-authentication.

| `insecureSkipVerify`
| `boolean`
| insecureSkipVerify defines how to disable target certificate validation.

| `keySecret`
| `object`
| keySecret defines the Secret containing the client key file for the targets.

| `maxVersion`
| `string`
| maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

| `minVersion`
| `string`
| minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

| `serverName`
| `string`
| serverName is used to verify the hostname for the targets.

|===
=== .spec.remoteWrite[].oauth2.tlsConfig.ca
Description::
+
--
ca defines the Certificate authority used when verifying server certificates.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `configMap`
| `object`
| configMap defines the ConfigMap containing data to use for the targets.

| `secret`
| `object`
| secret defines the Secret containing data to use for the targets.

|===
=== .spec.remoteWrite[].oauth2.tlsConfig.ca.configMap
Description::
+
--
configMap defines the ConfigMap containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key to select.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the ConfigMap or its key must be defined

|===
=== .spec.remoteWrite[].oauth2.tlsConfig.ca.secret
Description::
+
--
secret defines the Secret containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].oauth2.tlsConfig.cert
Description::
+
--
cert defines the Client certificate to present when doing client-authentication.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `configMap`
| `object`
| configMap defines the ConfigMap containing data to use for the targets.

| `secret`
| `object`
| secret defines the Secret containing data to use for the targets.

|===
=== .spec.remoteWrite[].oauth2.tlsConfig.cert.configMap
Description::
+
--
configMap defines the ConfigMap containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key to select.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the ConfigMap or its key must be defined

|===
=== .spec.remoteWrite[].oauth2.tlsConfig.cert.secret
Description::
+
--
secret defines the Secret containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].oauth2.tlsConfig.keySecret
Description::
+
--
keySecret defines the Secret containing the client key file for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].proxyConnectHeader
Description::
+
--
proxyConnectHeader optionally specifies headers to send to
proxies during CONNECT requests.

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.
--

Type::
  `object`




=== .spec.remoteWrite[].proxyConnectHeader{}
Description::
+
--

--

Type::
  `array`




=== .spec.remoteWrite[].proxyConnectHeader{}[]
Description::
+
--
SecretKeySelector selects a key of a Secret.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].queueConfig
Description::
+
--
queueConfig allows tuning of the remote write queue parameters.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `batchSendDeadline`
| `string`
| batchSendDeadline defines the maximum time a sample will wait in buffer.

| `capacity`
| `integer`
| capacity defines the number of samples to buffer per shard before we start
dropping them.

| `maxBackoff`
| `string`
| maxBackoff defines the maximum retry delay.

| `maxRetries`
| `integer`
| maxRetries defines the maximum number of times to retry a batch on recoverable errors.

| `maxSamplesPerSend`
| `integer`
| maxSamplesPerSend defines the maximum number of samples per send.

| `maxShards`
| `integer`
| maxShards defines the maximum number of shards, i.e. amount of concurrency.

| `minBackoff`
| `string`
| minBackoff defines the initial retry delay. Gets doubled for every retry.

| `minShards`
| `integer`
| minShards defines the minimum number of shards, i.e. amount of concurrency.

| `retryOnRateLimit`
| `boolean`
| retryOnRateLimit defines the retry upon receiving a 429 status code from the remote-write storage.

This is an *experimental feature*, it may change in any upcoming release
in a breaking way.

| `sampleAgeLimit`
| `string`
| sampleAgeLimit drops samples older than the limit.
It requires Prometheus >= v2.50.0 or Thanos >= v0.32.0.

|===
=== .spec.remoteWrite[].sigv4
Description::
+
--
sigv4 defines the AWS's Signature Verification 4 for the URL.

It requires Prometheus >= v2.26.0 or Thanos >= v0.24.0.

Cannot be set at the same time as `authorization`, `basicAuth`, `oauth2`, or `azureAd`.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `accessKey`
| `object`
| accessKey defines the AWS API key. If not specified, the environment variable
`AWS_ACCESS_KEY_ID` is used.

| `profile`
| `string`
| profile defines the named AWS profile used to authenticate.

| `region`
| `string`
| region defines the AWS region. If blank, the region from the default credentials chain used.

| `roleArn`
| `string`
| roleArn defines the named AWS profile used to authenticate.

| `secretKey`
| `object`
| secretKey defines the AWS API secret. If not specified, the environment
variable `AWS_SECRET_ACCESS_KEY` is used.

| `useFIPSSTSEndpoint`
| `boolean`
| useFIPSSTSEndpoint defines the FIPS mode for the AWS STS endpoint.
It requires Prometheus >= v2.54.0.

|===
=== .spec.remoteWrite[].sigv4.accessKey
Description::
+
--
accessKey defines the AWS API key. If not specified, the environment variable
`AWS_ACCESS_KEY_ID` is used.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].sigv4.secretKey
Description::
+
--
secretKey defines the AWS API secret. If not specified, the environment
variable `AWS_SECRET_ACCESS_KEY` is used.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].tlsConfig
Description::
+
--
tlsConfig to use for the URL.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `ca`
| `object`
| ca defines the Certificate authority used when verifying server certificates.

| `caFile`
| `string`
| caFile defines the path to the CA cert in the Prometheus container to use for the targets.

| `cert`
| `object`
| cert defines the Client certificate to present when doing client-authentication.

| `certFile`
| `string`
| certFile defines the path to the client cert file in the Prometheus container for the targets.

| `insecureSkipVerify`
| `boolean`
| insecureSkipVerify defines how to disable target certificate validation.

| `keyFile`
| `string`
| keyFile defines the path to the client key file in the Prometheus container for the targets.

| `keySecret`
| `object`
| keySecret defines the Secret containing the client key file for the targets.

| `maxVersion`
| `string`
| maxVersion defines the maximum acceptable TLS version.

It requires Prometheus >= v2.41.0 or Thanos >= v0.31.0.

| `minVersion`
| `string`
| minVersion defines the minimum acceptable TLS version.

It requires Prometheus >= v2.35.0 or Thanos >= v0.28.0.

| `serverName`
| `string`
| serverName is used to verify the hostname for the targets.

|===
=== .spec.remoteWrite[].tlsConfig.ca
Description::
+
--
ca defines the Certificate authority used when verifying server certificates.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `configMap`
| `object`
| configMap defines the ConfigMap containing data to use for the targets.

| `secret`
| `object`
| secret defines the Secret containing data to use for the targets.

|===
=== .spec.remoteWrite[].tlsConfig.ca.configMap
Description::
+
--
configMap defines the ConfigMap containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key to select.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the ConfigMap or its key must be defined

|===
=== .spec.remoteWrite[].tlsConfig.ca.secret
Description::
+
--
secret defines the Secret containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].tlsConfig.cert
Description::
+
--
cert defines the Client certificate to present when doing client-authentication.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `configMap`
| `object`
| configMap defines the ConfigMap containing data to use for the targets.

| `secret`
| `object`
| secret defines the Secret containing data to use for the targets.

|===
=== .spec.remoteWrite[].tlsConfig.cert.configMap
Description::
+
--
configMap defines the ConfigMap containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key to select.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the ConfigMap or its key must be defined

|===
=== .spec.remoteWrite[].tlsConfig.cert.secret
Description::
+
--
secret defines the Secret containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].tlsConfig.keySecret
Description::
+
--
keySecret defines the Secret containing the client key file for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.remoteWrite[].writeRelabelConfigs
Description::
+
--
writeRelabelConfigs defines the list of remote write relabel configurations.
--

Type::
  `array`




=== .spec.remoteWrite[].writeRelabelConfigs[]
Description::
+
--
RelabelConfig allows dynamic rewriting of the label set for targets, alerts,
scraped samples and remote write samples.

More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `action`
| `string`
| action to perform based on the regex matching.

`Uppercase` and `Lowercase` actions require Prometheus >= v2.36.0.
`DropEqual` and `KeepEqual` actions require Prometheus >= v2.41.0.

Default: "Replace"

| `modulus`
| `integer`
| modulus to take of the hash of the source label values.

Only applicable when the action is `HashMod`.

| `regex`
| `string`
| regex defines the regular expression against which the extracted value is matched.

| `replacement`
| `string`
| replacement value against which a Replace action is performed if the
regular expression matches.

Regex capture groups are available.

| `separator`
| `string`
| separator defines the string between concatenated SourceLabels.

| `sourceLabels`
| `array (string)`
| sourceLabels defines the source labels select values from existing labels. Their content is
concatenated using the configured Separator and matched against the
configured regular expression.

| `targetLabel`
| `string`
| targetLabel defines the label to which the resulting string is written in a replacement.

It is mandatory for `Replace`, `HashMod`, `Lowercase`, `Uppercase`,
`KeepEqual` and `DropEqual` actions.

Regex capture groups are available.

|===
=== .spec.resources
Description::
+
--
resources defines the resource requirements for single Pods.
If not provided, no requests/limits will be set
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `claims`
| `array`
| Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.

This field depends on the
DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.

| `claims[]`
| `object`
| ResourceClaim references one entry in PodSpec.ResourceClaims.

| `limits`
| `integer-or-string`
| Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

| `requests`
| `integer-or-string`
| Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

|===
=== .spec.resources.claims
Description::
+
--
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.

This field depends on the
DynamicResourceAllocation feature gate.

This field is immutable. It can only be set for containers.
--

Type::
  `array`




=== .spec.resources.claims[]
Description::
+
--
ResourceClaim references one entry in PodSpec.ResourceClaims.
--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name must match the name of one entry in pod.spec.resourceClaims of
the Pod where this field is used. It makes that resource available
inside a container.

| `request`
| `string`
| Request is the name chosen for a request in the referenced claim.
If empty, everything from the claim is made available, otherwise
only the result of this request.

|===
=== .spec.ruleNamespaceSelector
Description::
+
--
ruleNamespaceSelector defines the namespaces to be selected for Rules discovery. If unspecified, only
the same namespace as the ThanosRuler object is in is used.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.ruleNamespaceSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.ruleNamespaceSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.ruleSelector
Description::
+
--
ruleSelector defines the PrometheusRule objects to be selected for rule evaluation. An empty
label selector matches all objects. A null label selector matches no
objects.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.ruleSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.ruleSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.securityContext
Description::
+
--
securityContext defines the pod-level security attributes and common container settings.
This defaults to the default PodSecurityContext.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `appArmorProfile`
| `object`
| appArmorProfile is the AppArmor options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows.

| `fsGroup`
| `integer`
| A special supplemental group that applies to all containers in a pod.
Some volume types allow the Kubelet to change the ownership of that volume
to be owned by the pod:

1. The owning GID will be the FSGroup
2. The setgid bit is set (new files created in the volume will be owned by FSGroup)
3. The permission bits are OR'd with rw-rw----

If unset, the Kubelet will not modify the ownership and permissions of any volume.
Note that this field cannot be set when spec.os.name is windows.

| `fsGroupChangePolicy`
| `string`
| fsGroupChangePolicy defines behavior of changing ownership and permission of the volume
before being exposed inside Pod. This field will only apply to
volume types which support fsGroup based ownership(and permissions).
It will have no effect on ephemeral volume types such as: secret, configmaps
and emptydir.
Valid values are "OnRootMismatch" and "Always". If not specified, "Always" is used.
Note that this field cannot be set when spec.os.name is windows.

| `runAsGroup`
| `integer`
| The GID to run the entrypoint of the container process.
Uses runtime default if unset.
May also be set in SecurityContext.  If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence
for that container.
Note that this field cannot be set when spec.os.name is windows.

| `runAsNonRoot`
| `boolean`
| Indicates that the container must run as a non-root user.
If true, the Kubelet will validate the image at runtime to ensure that it
does not run as UID 0 (root) and fail to start the container if it does.
If unset or false, no such validation will be performed.
May also be set in SecurityContext.  If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.

| `runAsUser`
| `integer`
| The UID to run the entrypoint of the container process.
Defaults to user specified in image metadata if unspecified.
May also be set in SecurityContext.  If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence
for that container.
Note that this field cannot be set when spec.os.name is windows.

| `seLinuxChangePolicy`
| `string`
| seLinuxChangePolicy defines how the container's SELinux label is applied to all volumes used by the Pod.
It has no effect on nodes that do not support SELinux or to volumes does not support SELinux.
Valid values are "MountOption" and "Recursive".

"Recursive" means relabeling of all files on all Pod volumes by the container runtime.
This may be slow for large volumes, but allows mixing privileged and unprivileged Pods sharing the same volume on the same node.

"MountOption" mounts all eligible Pod volumes with `-o context` mount option.
This requires all Pods that share the same volume to use the same SELinux label.
It is not possible to share the same volume among privileged and unprivileged Pods.
Eligible volumes are in-tree FibreChannel and iSCSI volumes, and all CSI volumes
whose CSI driver announces SELinux support by setting spec.seLinuxMount: true in their
CSIDriver instance. Other volumes are always re-labelled recursively.
"MountOption" value is allowed only when SELinuxMount feature gate is enabled.

If not specified and SELinuxMount feature gate is enabled, "MountOption" is used.
If not specified and SELinuxMount feature gate is disabled, "MountOption" is used for ReadWriteOncePod volumes
and "Recursive" for all other volumes.

This field affects only Pods that have SELinux label set, either in PodSecurityContext or in SecurityContext of all containers.

All Pods that use the same volume should use the same seLinuxChangePolicy, otherwise some pods can get stuck in ContainerCreating state.
Note that this field cannot be set when spec.os.name is windows.

| `seLinuxOptions`
| `object`
| The SELinux context to be applied to all containers.
If unspecified, the container runtime will allocate a random SELinux context for each
container.  May also be set in SecurityContext.  If set in
both SecurityContext and PodSecurityContext, the value specified in SecurityContext
takes precedence for that container.
Note that this field cannot be set when spec.os.name is windows.

| `seccompProfile`
| `object`
| The seccomp options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows.

| `supplementalGroups`
| `array (integer)`
| A list of groups applied to the first process run in each container, in
addition to the container's primary GID and fsGroup (if specified).  If
the SupplementalGroupsPolicy feature is enabled, the
supplementalGroupsPolicy field determines whether these are in addition
to or instead of any group memberships defined in the container image.
If unspecified, no additional groups are added, though group memberships
defined in the container image may still be used, depending on the
supplementalGroupsPolicy field.
Note that this field cannot be set when spec.os.name is windows.

| `supplementalGroupsPolicy`
| `string`
| Defines how supplemental groups of the first container processes are calculated.
Valid values are "Merge" and "Strict". If not specified, "Merge" is used.
(Alpha) Using the field requires the SupplementalGroupsPolicy feature gate to be enabled
and the container runtime must implement support for this feature.
Note that this field cannot be set when spec.os.name is windows.

| `sysctls`
| `array`
| Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Note that this field cannot be set when spec.os.name is windows.

| `sysctls[]`
| `object`
| Sysctl defines a kernel parameter to be set

| `windowsOptions`
| `object`
| The Windows specific settings applied to all containers.
If unspecified, the options within a container's SecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux.

|===
=== .spec.securityContext.appArmorProfile
Description::
+
--
appArmorProfile is the AppArmor options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows.
--

Type::
  `object`

Required::
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `localhostProfile`
| `string`
| localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost".

| `type`
| `string`
| type indicates which kind of AppArmor profile will be applied.
Valid options are:
  Localhost - a profile pre-loaded on the node.
  RuntimeDefault - the container runtime's default profile.
  Unconfined - no AppArmor enforcement.

|===
=== .spec.securityContext.seLinuxOptions
Description::
+
--
The SELinux context to be applied to all containers.
If unspecified, the container runtime will allocate a random SELinux context for each
container.  May also be set in SecurityContext.  If set in
both SecurityContext and PodSecurityContext, the value specified in SecurityContext
takes precedence for that container.
Note that this field cannot be set when spec.os.name is windows.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `level`
| `string`
| Level is SELinux level label that applies to the container.

| `role`
| `string`
| Role is a SELinux role label that applies to the container.

| `type`
| `string`
| Type is a SELinux type label that applies to the container.

| `user`
| `string`
| User is a SELinux user label that applies to the container.

|===
=== .spec.securityContext.seccompProfile
Description::
+
--
The seccomp options to use by the containers in this pod.
Note that this field cannot be set when spec.os.name is windows.
--

Type::
  `object`

Required::
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `localhostProfile`
| `string`
| localhostProfile indicates a profile defined in a file on the node should be used.
The profile must be preconfigured on the node to work.
Must be a descending path, relative to the kubelet's configured seccomp profile location.
Must be set if type is "Localhost". Must NOT be set for any other type.

| `type`
| `string`
| type indicates which kind of seccomp profile will be applied.
Valid options are:

Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied.

|===
=== .spec.securityContext.sysctls
Description::
+
--
Sysctls hold a list of namespaced sysctls used for the pod. Pods with unsupported
sysctls (by the container runtime) might fail to launch.
Note that this field cannot be set when spec.os.name is windows.
--

Type::
  `array`




=== .spec.securityContext.sysctls[]
Description::
+
--
Sysctl defines a kernel parameter to be set
--

Type::
  `object`

Required::
  - `name`
  - `value`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of a property to set

| `value`
| `string`
| Value of a property to set

|===
=== .spec.securityContext.windowsOptions
Description::
+
--
The Windows specific settings applied to all containers.
If unspecified, the options within a container's SecurityContext will be used.
If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.
Note that this field cannot be set when spec.os.name is linux.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `gmsaCredentialSpec`
| `string`
| GMSACredentialSpec is where the GMSA admission webhook
(https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the
GMSA credential spec named by the GMSACredentialSpecName field.

| `gmsaCredentialSpecName`
| `string`
| GMSACredentialSpecName is the name of the GMSA credential spec to use.

| `hostProcess`
| `boolean`
| HostProcess determines if a container should be run as a 'Host Process' container.
All of a Pod's containers must have the same effective HostProcess value
(it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).
In addition, if HostProcess is true then HostNetwork must also be set to true.

| `runAsUserName`
| `string`
| The UserName in Windows to run the entrypoint of the container process.
Defaults to the user specified in image metadata if unspecified.
May also be set in PodSecurityContext. If set in both SecurityContext and
PodSecurityContext, the value specified in SecurityContext takes precedence.

|===
=== .spec.storage
Description::
+
--
storage defines the specification of how storage shall be used.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `disableMountSubPath`
| `boolean`
| disableMountSubPath deprecated: subPath usage will be removed in a future release.

| `emptyDir`
| `object`
| emptyDir to be used by the StatefulSet.
If specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.
More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir

| `ephemeral`
| `object`
| ephemeral to be used by the StatefulSet.
This is a beta field in k8s 1.21 and GA in 1.15.
For lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.
More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes

| `volumeClaimTemplate`
| `object`
| volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets.
The easiest way to use a volume that cannot be automatically provisioned
is to use a label selector alongside manually created PersistentVolumes.

|===
=== .spec.storage.emptyDir
Description::
+
--
emptyDir to be used by the StatefulSet.
If specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.
More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `medium`
| `string`
| medium represents what type of storage medium should back this directory.
The default is "" which means to use the node's default medium.
Must be an empty string (default) or Memory.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

| `sizeLimit`
| `integer-or-string`
| sizeLimit is the total amount of local storage required for this EmptyDir volume.
The size limit is also applicable for memory medium.
The maximum usage on memory medium EmptyDir would be the minimum value between
the SizeLimit specified here and the sum of memory limits of all containers in a pod.
The default is nil which means that the limit is undefined.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

|===
=== .spec.storage.ephemeral
Description::
+
--
ephemeral to be used by the StatefulSet.
This is a beta field in k8s 1.21 and GA in 1.15.
For lower versions, starting with k8s 1.19, it requires enabling the GenericEphemeralVolume feature gate.
More info: https://kubernetes.io/docs/concepts/storage/ephemeral-volumes/#generic-ephemeral-volumes
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `volumeClaimTemplate`
| `object`
| Will be used to create a stand-alone PVC to provision the volume.
The pod in which this EphemeralVolumeSource is embedded will be the
owner of the PVC, i.e. the PVC will be deleted together with the
pod.  The name of the PVC will be `<pod name>-<volume name>` where
`<volume name>` is the name from the `PodSpec.Volumes` array
entry. Pod validation will reject the pod if the concatenated name
is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod
will *not* be used for the pod to avoid using an unrelated
volume by mistake. Starting the pod is then blocked until
the unrelated PVC is removed. If such a pre-created PVC is
meant to be used by the pod, the PVC has to updated with an
owner reference to the pod once the pod exists. Normally
this should not be necessary, but it may be useful when
manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes
to the PVC after it has been created.

Required, must not be nil.

|===
=== .spec.storage.ephemeral.volumeClaimTemplate
Description::
+
--
Will be used to create a stand-alone PVC to provision the volume.
The pod in which this EphemeralVolumeSource is embedded will be the
owner of the PVC, i.e. the PVC will be deleted together with the
pod.  The name of the PVC will be `<pod name>-<volume name>` where
`<volume name>` is the name from the `PodSpec.Volumes` array
entry. Pod validation will reject the pod if the concatenated name
is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod
will *not* be used for the pod to avoid using an unrelated
volume by mistake. Starting the pod is then blocked until
the unrelated PVC is removed. If such a pre-created PVC is
meant to be used by the pod, the PVC has to updated with an
owner reference to the pod once the pod exists. Normally
this should not be necessary, but it may be useful when
manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes
to the PVC after it has been created.

Required, must not be nil.
--

Type::
  `object`

Required::
  - `spec`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `metadata`
| `object`
| May contain labels and annotations that will be copied into the PVC
when creating it. No other fields are allowed and will be rejected during
validation.

| `spec`
| `object`
| The specification for the PersistentVolumeClaim. The entire content is
copied unchanged into the PVC that gets created from this
template. The same fields as in a PersistentVolumeClaim
are also valid here.

|===
=== .spec.storage.ephemeral.volumeClaimTemplate.metadata
Description::
+
--
May contain labels and annotations that will be copied into the PVC
when creating it. No other fields are allowed and will be rejected during
validation.
--

Type::
  `object`




=== .spec.storage.ephemeral.volumeClaimTemplate.spec
Description::
+
--
The specification for the PersistentVolumeClaim. The entire content is
copied unchanged into the PVC that gets created from this
template. The same fields as in a PersistentVolumeClaim
are also valid here.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `accessModes`
| `array (string)`
| accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

| `dataSource`
| `object`
| dataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.

| `dataSourceRef`
| `object`
| dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef:
* While dataSource only allows two specific types of objects, dataSourceRef
  allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
  preserves all values, and generates an error if a disallowed value is
  specified.
* While dataSource only allows local objects, dataSourceRef allows objects
  in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

| `resources`
| `object`
| resources represents the minimum resources the volume should have.
Users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

| `selector`
| `object`
| selector is a label query over volumes to consider for binding.

| `storageClassName`
| `string`
| storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

| `volumeAttributesClassName`
| `string`
| volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
it can be changed after the claim is created. An empty string or nil value indicates that no
VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,
this field can be reset to its previous value (including nil) to cancel the modification.
If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
exists.
More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/

| `volumeMode`
| `string`
| volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.

| `volumeName`
| `string`
| volumeName is the binding reference to the PersistentVolume backing this claim.

|===
=== .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSource
Description::
+
--
dataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.
--

Type::
  `object`

Required::
  - `kind`
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiGroup`
| `string`
| APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.

| `kind`
| `string`
| Kind is the type of resource being referenced

| `name`
| `string`
| Name is the name of resource being referenced

|===
=== .spec.storage.ephemeral.volumeClaimTemplate.spec.dataSourceRef
Description::
+
--
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef:
* While dataSource only allows two specific types of objects, dataSourceRef
  allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
  preserves all values, and generates an error if a disallowed value is
  specified.
* While dataSource only allows local objects, dataSourceRef allows objects
  in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
--

Type::
  `object`

Required::
  - `kind`
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiGroup`
| `string`
| APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.

| `kind`
| `string`
| Kind is the type of resource being referenced

| `name`
| `string`
| Name is the name of resource being referenced

| `namespace`
| `string`
| Namespace is the namespace of resource being referenced
Note 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.
(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

|===
=== .spec.storage.ephemeral.volumeClaimTemplate.spec.resources
Description::
+
--
resources represents the minimum resources the volume should have.
Users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `limits`
| `integer-or-string`
| Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

| `requests`
| `integer-or-string`
| Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

|===
=== .spec.storage.ephemeral.volumeClaimTemplate.spec.selector
Description::
+
--
selector is a label query over volumes to consider for binding.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.storage.ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.storage.volumeClaimTemplate
Description::
+
--
volumeClaimTemplate defines the PVC spec to be used by the Prometheus StatefulSets.
The easiest way to use a volume that cannot be automatically provisioned
is to use a label selector alongside manually created PersistentVolumes.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiVersion`
| `string`
| APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

| `kind`
| `string`
| Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

| `metadata`
| `object`
| metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.

| `spec`
| `object`
| spec defines the specification of the  characteristics of a volume requested by a pod author.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

| `status`
| `object`
| status is deprecated: this field is never set.

|===
=== .spec.storage.volumeClaimTemplate.metadata
Description::
+
--
metadata defines EmbeddedMetadata contains metadata relevant to an EmbeddedResource.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `annotations`
| `object (string)`
| annotations defines an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/

| `labels`
| `object (string)`
| labels define the map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

| `name`
| `string`
| name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/

|===
=== .spec.storage.volumeClaimTemplate.spec
Description::
+
--
spec defines the specification of the  characteristics of a volume requested by a pod author.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `accessModes`
| `array (string)`
| accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

| `dataSource`
| `object`
| dataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.

| `dataSourceRef`
| `object`
| dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef:
* While dataSource only allows two specific types of objects, dataSourceRef
  allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
  preserves all values, and generates an error if a disallowed value is
  specified.
* While dataSource only allows local objects, dataSourceRef allows objects
  in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

| `resources`
| `object`
| resources represents the minimum resources the volume should have.
Users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

| `selector`
| `object`
| selector is a label query over volumes to consider for binding.

| `storageClassName`
| `string`
| storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

| `volumeAttributesClassName`
| `string`
| volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
it can be changed after the claim is created. An empty string or nil value indicates that no
VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,
this field can be reset to its previous value (including nil) to cancel the modification.
If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
exists.
More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/

| `volumeMode`
| `string`
| volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.

| `volumeName`
| `string`
| volumeName is the binding reference to the PersistentVolume backing this claim.

|===
=== .spec.storage.volumeClaimTemplate.spec.dataSource
Description::
+
--
dataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.
--

Type::
  `object`

Required::
  - `kind`
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiGroup`
| `string`
| APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.

| `kind`
| `string`
| Kind is the type of resource being referenced

| `name`
| `string`
| Name is the name of resource being referenced

|===
=== .spec.storage.volumeClaimTemplate.spec.dataSourceRef
Description::
+
--
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef:
* While dataSource only allows two specific types of objects, dataSourceRef
  allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
  preserves all values, and generates an error if a disallowed value is
  specified.
* While dataSource only allows local objects, dataSourceRef allows objects
  in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
--

Type::
  `object`

Required::
  - `kind`
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiGroup`
| `string`
| APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.

| `kind`
| `string`
| Kind is the type of resource being referenced

| `name`
| `string`
| Name is the name of resource being referenced

| `namespace`
| `string`
| Namespace is the namespace of resource being referenced
Note 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.
(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

|===
=== .spec.storage.volumeClaimTemplate.spec.resources
Description::
+
--
resources represents the minimum resources the volume should have.
Users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `limits`
| `integer-or-string`
| Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

| `requests`
| `integer-or-string`
| Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

|===
=== .spec.storage.volumeClaimTemplate.spec.selector
Description::
+
--
selector is a label query over volumes to consider for binding.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.storage.volumeClaimTemplate.spec.selector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.storage.volumeClaimTemplate.status
Description::
+
--
status is deprecated: this field is never set.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `accessModes`
| `array (string)`
| accessModes contains the actual access modes the volume backing the PVC has.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

| `allocatedResourceStatuses`
| `object (string)`
| allocatedResourceStatuses stores status of resource being resized for the given PVC.
Key names follow standard Kubernetes label syntax. Valid values are either:
	* Un-prefixed keys:
		- storage - the capacity of the volume.
	* Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered
reserved and hence may not be used.

ClaimResourceStatus can be in any of following states:
	- ControllerResizeInProgress:
		State set when resize controller starts resizing the volume in control-plane.
	- ControllerResizeFailed:
		State set when resize has failed in resize controller with a terminal error.
	- NodeResizePending:
		State set when resize controller has finished resizing the volume but further resizing of
		volume is needed on the node.
	- NodeResizeInProgress:
		State set when kubelet starts resizing the volume.
	- NodeResizeFailed:
		State set when resizing has failed in kubelet with a terminal error. Transient errors don't set
		NodeResizeFailed.
For example: if expanding a PVC for more capacity - this field can be one of the following states:
	- pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeInProgress"
     - pvc.status.allocatedResourceStatus['storage'] = "ControllerResizeFailed"
     - pvc.status.allocatedResourceStatus['storage'] = "NodeResizePending"
     - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeInProgress"
     - pvc.status.allocatedResourceStatus['storage'] = "NodeResizeFailed"
When this field is not set, it means that no resize operation is in progress for the given PVC.

A controller that receives PVC update with previously unknown resourceName or ClaimResourceStatus
should ignore the update for the purpose it was designed. For example - a controller that
only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid
resources associated with PVC.

| `allocatedResources`
| `integer-or-string`
| allocatedResources tracks the resources allocated to a PVC including its capacity.
Key names follow standard Kubernetes label syntax. Valid values are either:
	* Un-prefixed keys:
		- storage - the capacity of the volume.
	* Custom resources must use implementation-defined prefixed names such as "example.com/my-custom-resource"
Apart from above values - keys that are unprefixed or have kubernetes.io prefix are considered
reserved and hence may not be used.

Capacity reported here may be larger than the actual capacity when a volume expansion operation
is requested.
For storage quota, the larger value from allocatedResources and PVC.spec.resources is used.
If allocatedResources is not set, PVC.spec.resources alone is used for quota calculation.
If a volume expansion capacity request is lowered, allocatedResources is only
lowered if there are no expansion operations in progress and if the actual volume capacity
is equal or lower than the requested capacity.

A controller that receives PVC update with previously unknown resourceName
should ignore the update for the purpose it was designed. For example - a controller that
only is responsible for resizing capacity of the volume, should ignore PVC updates that change other valid
resources associated with PVC.

| `capacity`
| `integer-or-string`
| capacity represents the actual resources of the underlying volume.

| `conditions`
| `array`
| conditions is the current Condition of persistent volume claim. If underlying persistent volume is being
resized then the Condition will be set to 'Resizing'.

| `conditions[]`
| `object`
| PersistentVolumeClaimCondition contains details about state of pvc

| `currentVolumeAttributesClassName`
| `string`
| currentVolumeAttributesClassName is the current name of the VolumeAttributesClass the PVC is using.
When unset, there is no VolumeAttributeClass applied to this PersistentVolumeClaim

| `modifyVolumeStatus`
| `object`
| ModifyVolumeStatus represents the status object of ControllerModifyVolume operation.
When this is unset, there is no ModifyVolume operation being attempted.

| `phase`
| `string`
| phase represents the current phase of PersistentVolumeClaim.

|===
=== .spec.storage.volumeClaimTemplate.status.conditions
Description::
+
--
conditions is the current Condition of persistent volume claim. If underlying persistent volume is being
resized then the Condition will be set to 'Resizing'.
--

Type::
  `array`




=== .spec.storage.volumeClaimTemplate.status.conditions[]
Description::
+
--
PersistentVolumeClaimCondition contains details about state of pvc
--

Type::
  `object`

Required::
  - `status`
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `lastProbeTime`
| `string`
| lastProbeTime is the time we probed the condition.

| `lastTransitionTime`
| `string`
| lastTransitionTime is the time the condition transitioned from one status to another.

| `message`
| `string`
| message is the human-readable message indicating details about last transition.

| `reason`
| `string`
| reason is a unique, this should be a short, machine understandable string that gives the reason
for condition's last transition. If it reports "Resizing" that means the underlying
persistent volume is being resized.

| `status`
| `string`
| Status is the status of the condition.
Can be True, False, Unknown.
More 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 is the type of the condition.
More 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

|===
=== .spec.storage.volumeClaimTemplate.status.modifyVolumeStatus
Description::
+
--
ModifyVolumeStatus represents the status object of ControllerModifyVolume operation.
When this is unset, there is no ModifyVolume operation being attempted.
--

Type::
  `object`

Required::
  - `status`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `status`
| `string`
| status is the status of the ControllerModifyVolume operation. It can be in any of following states:
 - Pending
   Pending indicates that the PersistentVolumeClaim cannot be modified due to unmet requirements, such as
   the specified VolumeAttributesClass not existing.
 - InProgress
   InProgress indicates that the volume is being modified.
 - Infeasible
  Infeasible indicates that the request has been rejected as invalid by the CSI driver. To
	  resolve the error, a valid VolumeAttributesClass needs to be specified.
Note: New statuses can be added in the future. Consumers should check for unknown statuses and fail appropriately.

| `targetVolumeAttributesClassName`
| `string`
| targetVolumeAttributesClassName is the name of the VolumeAttributesClass the PVC currently being reconciled

|===
=== .spec.tolerations
Description::
+
--
tolerations defines when specified, the pod's tolerations.
--

Type::
  `array`




=== .spec.tolerations[]
Description::
+
--
The pod this Toleration is attached to tolerates any taint that matches
the triple <key,value,effect> using the matching operator <operator>.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `effect`
| `string`
| Effect indicates the taint effect to match. Empty means match all taint effects.
When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

| `key`
| `string`
| Key is the taint key that the toleration applies to. Empty means match all taint keys.
If the key is empty, operator must be Exists; this combination means to match all values and all keys.

| `operator`
| `string`
| Operator represents a key's relationship to the value.
Valid operators are Exists, Equal, Lt, and Gt. Defaults to Equal.
Exists is equivalent to wildcard for value, so that a pod can
tolerate all taints of a particular category.
Lt and Gt perform numeric comparisons (requires feature gate TaintTolerationComparisonOperators).

| `tolerationSeconds`
| `integer`
| TolerationSeconds represents the period of time the toleration (which must be
of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default,
it is not set, which means tolerate the taint forever (do not evict). Zero and
negative values will be treated as 0 (evict immediately) by the system.

| `value`
| `string`
| Value is the taint value the toleration matches to.
If the operator is Exists, the value should be empty, otherwise just a regular string.

|===
=== .spec.topologySpreadConstraints
Description::
+
--
topologySpreadConstraints defines the pod's topology spread constraints.
--

Type::
  `array`




=== .spec.topologySpreadConstraints[]
Description::
+
--
TopologySpreadConstraint specifies how to spread matching pods among the given topology.
--

Type::
  `object`

Required::
  - `maxSkew`
  - `topologyKey`
  - `whenUnsatisfiable`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `labelSelector`
| `object`
| LabelSelector is used to find matching pods.
Pods that match this label selector are counted to determine the number of pods
in their corresponding topology domain.

| `matchLabelKeys`
| `array (string)`
| MatchLabelKeys is a set of pod label keys to select the pods over which
spreading will be calculated. The keys are used to lookup values from the
incoming pod labels, those key-value labels are ANDed with labelSelector
to select the group of existing pods over which spreading will be calculated
for the incoming pod. The same key is forbidden to exist in both MatchLabelKeys and LabelSelector.
MatchLabelKeys cannot be set when LabelSelector isn't set.
Keys that don't exist in the incoming pod labels will
be ignored. A null or empty list means only match against labelSelector.

This is a beta field and requires the MatchLabelKeysInPodTopologySpread feature gate to be enabled (enabled by default).

| `maxSkew`
| `integer`
| MaxSkew describes the degree to which pods may be unevenly distributed.
When `whenUnsatisfiable=DoNotSchedule`, it is the maximum permitted difference
between the number of matching pods in the target topology and the global minimum.
The global minimum is the minimum number of matching pods in an eligible domain
or zero if the number of eligible domains is less than MinDomains.
For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
labelSelector spread as 2/2/1:
In this case, the global minimum is 1.
\| zone1 \| zone2 \| zone3 \|
\|  P P  \|  P P  \|   P   \|
- if MaxSkew is 1, incoming pod can only be scheduled to zone3 to become 2/2/2;
scheduling it onto zone1(zone2) would make the ActualSkew(3-1) on zone1(zone2)
violate MaxSkew(1).
- if MaxSkew is 2, incoming pod can be scheduled onto any zone.
When `whenUnsatisfiable=ScheduleAnyway`, it is used to give higher precedence
to topologies that satisfy it.
It's a required field. Default value is 1 and 0 is not allowed.

| `minDomains`
| `integer`
| MinDomains indicates a minimum number of eligible domains.
When the number of eligible domains with matching topology keys is less than minDomains,
Pod Topology Spread treats "global minimum" as 0, and then the calculation of Skew is performed.
And when the number of eligible domains with matching topology keys equals or greater than minDomains,
this value has no effect on scheduling.
As a result, when the number of eligible domains is less than minDomains,
scheduler won't schedule more than maxSkew Pods to those domains.
If value is nil, the constraint behaves as if MinDomains is equal to 1.
Valid values are integers greater than 0.
When value is not nil, WhenUnsatisfiable must be DoNotSchedule.

For example, in a 3-zone cluster, MaxSkew is set to 2, MinDomains is set to 5 and pods with the same
labelSelector spread as 2/2/2:
\| zone1 \| zone2 \| zone3 \|
\|  P P  \|  P P  \|  P P  \|
The number of domains is less than 5(MinDomains), so "global minimum" is treated as 0.
In this situation, new pod with the same labelSelector cannot be scheduled,
because computed skew will be 3(3 - 0) if new Pod is scheduled to any of the three zones,
it will violate MaxSkew.

| `nodeAffinityPolicy`
| `string`
| NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector
when calculating pod topology spread skew. Options are:
- Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations.
- Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations.

If this value is nil, the behavior is equivalent to the Honor policy.

| `nodeTaintsPolicy`
| `string`
| NodeTaintsPolicy indicates how we will treat node taints when calculating
pod topology spread skew. Options are:
- Honor: nodes without taints, along with tainted nodes for which the incoming pod
has a toleration, are included.
- Ignore: node taints are ignored. All nodes are included.

If this value is nil, the behavior is equivalent to the Ignore policy.

| `topologyKey`
| `string`
| TopologyKey is the key of node labels. Nodes that have a label with this key
and identical values are considered to be in the same topology.
We consider each <key, value> as a "bucket", and try to put balanced number
of pods into each bucket.
We define a domain as a particular instance of a topology.
Also, we define an eligible domain as a domain whose nodes meet the requirements of
nodeAffinityPolicy and nodeTaintsPolicy.
e.g. If TopologyKey is "kubernetes.io/hostname", each Node is a domain of that topology.
And, if TopologyKey is "topology.kubernetes.io/zone", each zone is a domain of that topology.
It's a required field.

| `whenUnsatisfiable`
| `string`
| WhenUnsatisfiable indicates how to deal with a pod if it doesn't satisfy
the spread constraint.
- DoNotSchedule (default) tells the scheduler not to schedule it.
- ScheduleAnyway tells the scheduler to schedule the pod in any location,
  but giving higher precedence to topologies that would help reduce the
  skew.
A constraint is considered "Unsatisfiable" for an incoming pod
if and only if every possible node assignment for that pod would violate
"MaxSkew" on some topology.
For example, in a 3-zone cluster, MaxSkew is set to 1, and pods with the same
labelSelector spread as 3/1/1:
\| zone1 \| zone2 \| zone3 \|
\| P P P \|   P   \|   P   \|
If WhenUnsatisfiable is set to DoNotSchedule, incoming pod can only be scheduled
to zone2(zone3) to become 3/2/1(3/1/2) as ActualSkew(2-1) on zone2(zone3) satisfies
MaxSkew(1). In other words, the cluster can still be imbalanced, but scheduler
won't make it *more* imbalanced.
It's a required field.

|===
=== .spec.topologySpreadConstraints[].labelSelector
Description::
+
--
LabelSelector is used to find matching pods.
Pods that match this label selector are counted to determine the number of pods
in their corresponding topology domain.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.topologySpreadConstraints[].labelSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.topologySpreadConstraints[].labelSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.tracingConfig
Description::
+
--
tracingConfig defines the tracing configuration.

The configuration format is defined at https://thanos.io/tip/thanos/tracing.md/#configuration

This is an *experimental feature*, it may change in any upcoming release
in a breaking way.

The operator performs no validation of the configuration.

`tracingConfigFile` takes precedence over this field.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.updateStrategy
Description::
+
--
updateStrategy indicates the strategy that will be employed to update
Pods in the StatefulSet when a revision is made to statefulset's Pod
Template.

The default strategy is RollingUpdate.
--

Type::
  `object`

Required::
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `rollingUpdate`
| `object`
| rollingUpdate is used to communicate parameters when type is RollingUpdate.

| `type`
| `string`
| type indicates the type of the StatefulSetUpdateStrategy.

Default is RollingUpdate.

|===
=== .spec.updateStrategy.rollingUpdate
Description::
+
--
rollingUpdate is used to communicate parameters when type is RollingUpdate.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `maxUnavailable`
| `integer-or-string`
| maxUnavailable is the maximum number of pods that can be unavailable
during the update. The value can be an absolute number (ex: 5) or a
percentage of desired pods (ex: 10%). Absolute number is calculated from
percentage by rounding up. This can not be 0.  Defaults to 1. This field
is alpha-level and is only honored by servers that enable the
MaxUnavailableStatefulSet feature. The field applies to all pods in the
range 0 to Replicas-1.  That means if there is any unavailable pod in
the range 0 to Replicas-1, it will be counted towards MaxUnavailable.

|===
=== .spec.volumeMounts
Description::
+
--
volumeMounts defines how the configuration of additional VolumeMounts on the output StatefulSet definition.
VolumeMounts specified will be appended to other VolumeMounts in the ruler container,
that are generated as a result of StorageSpec objects.
--

Type::
  `array`




=== .spec.volumeMounts[]
Description::
+
--
VolumeMount describes a mounting of a Volume within a container.
--

Type::
  `object`

Required::
  - `mountPath`
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `mountPath`
| `string`
| Path within the container at which the volume should be mounted.  Must
not contain ':'.

| `mountPropagation`
| `string`
| mountPropagation determines how mounts are propagated from the host
to container and the other way around.
When not set, MountPropagationNone is used.
This field is beta in 1.10.
When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
(which defaults to None).

| `name`
| `string`
| This must match the Name of a Volume.

| `readOnly`
| `boolean`
| Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.

| `recursiveReadOnly`
| `string`
| RecursiveReadOnly specifies whether read-only mounts should be handled
recursively.

If ReadOnly is false, this field has no meaning and must be unspecified.

If ReadOnly is true, and this field is set to Disabled, the mount is not made
recursively read-only.  If this field is set to IfPossible, the mount is made
recursively read-only, if it is supported by the container runtime.  If this
field is set to Enabled, the mount is made recursively read-only if it is
supported by the container runtime, otherwise the pod will not be started and
an error will be generated to indicate the reason.

If this field is set to IfPossible or Enabled, MountPropagation must be set to
None (or be unspecified, which defaults to None).

If this field is not specified, it is treated as an equivalent of Disabled.

| `subPath`
| `string`
| Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).

| `subPathExpr`
| `string`
| Expanded path within the volume from which the container's volume should be mounted.
Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container's environment.
Defaults to "" (volume's root).
SubPathExpr and SubPath are mutually exclusive.

|===
=== .spec.volumes
Description::
+
--
volumes defines how configuration of additional volumes on the output StatefulSet definition. Volumes specified will
be appended to other volumes that are generated as a result of StorageSpec objects.
--

Type::
  `array`




=== .spec.volumes[]
Description::
+
--
Volume represents a named volume in a pod that may be accessed by any container in the pod.
--

Type::
  `object`

Required::
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `awsElasticBlockStore`
| `object`
| awsElasticBlockStore represents an AWS Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree
awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

| `azureDisk`
| `object`
| azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type
are redirected to the disk.csi.azure.com CSI driver.

| `azureFile`
| `object`
| azureFile represents an Azure File Service mount on the host and bind mount to the pod.
Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type
are redirected to the file.csi.azure.com CSI driver.

| `cephfs`
| `object`
| cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.
Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.

| `cinder`
| `object`
| cinder represents a cinder volume attached and mounted on kubelets host machine.
Deprecated: Cinder is deprecated. All operations for the in-tree cinder type
are redirected to the cinder.csi.openstack.org CSI driver.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md

| `configMap`
| `object`
| configMap represents a configMap that should populate this volume

| `csi`
| `object`
| csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.

| `downwardAPI`
| `object`
| downwardAPI represents downward API about the pod that should populate this volume

| `emptyDir`
| `object`
| emptyDir represents a temporary directory that shares a pod's lifetime.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

| `ephemeral`
| `object`
| ephemeral represents a volume that is handled by a cluster storage driver.
The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
and deleted when the pod is removed.

Use this if:
a) the volume is only needed while the pod runs,
b) features of normal volumes like restoring from snapshot or capacity
   tracking are needed,
c) the storage driver is specified through a storage class, and
d) the storage driver supports dynamic volume provisioning through
   a PersistentVolumeClaim (see EphemeralVolumeSource for more
   information on the connection between this volume type
   and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific
APIs for volumes that persist for longer than the lifecycle
of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to
be used that way - see the documentation of the driver for
more information.

A pod can use both types of ephemeral volumes and
persistent volumes at the same time.

| `fc`
| `object`
| fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

| `flexVolume`
| `object`
| flexVolume represents a generic volume resource that is
provisioned/attached using an exec based plugin.
Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.

| `flocker`
| `object`
| flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running.
Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.

| `gcePersistentDisk`
| `object`
| gcePersistentDisk represents a GCE Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree
gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

| `gitRepo`
| `object`
| gitRepo represents a git repository at a particular revision.
Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an
EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
into the Pod's container.

| `glusterfs`
| `object`
| glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.

| `hostPath`
| `object`
| hostPath represents a pre-existing file or directory on the host
machine that is directly exposed to the container. This is generally
used for system agents or other privileged things that are allowed
to see the host machine. Most containers will NOT need this.
More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

| `image`
| `object`
| image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine.
The volume is resolved at pod startup depending on which PullPolicy value is provided:

- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
- 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.
- 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.

The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation.
A 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.
The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field.
The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images.
The volume will be mounted read-only (ro) and non-executable files (noexec).
Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33.
The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.

| `iscsi`
| `object`
| iscsi represents an ISCSI Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi

| `name`
| `string`
| name of the volume.
Must be a DNS_LABEL and unique within the pod.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `nfs`
| `object`
| nfs represents an NFS mount on the host that shares a pod's lifetime
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

| `persistentVolumeClaim`
| `object`
| persistentVolumeClaimVolumeSource represents a reference to a
PersistentVolumeClaim in the same namespace.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

| `photonPersistentDisk`
| `object`
| photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.
Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.

| `portworxVolume`
| `object`
| portworxVolume represents a portworx volume attached and mounted on kubelets host machine.
Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type
are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate
is on.

| `projected`
| `object`
| projected items for all in one resources secrets, configmaps, and downward API

| `quobyte`
| `object`
| quobyte represents a Quobyte mount on the host that shares a pod's lifetime.
Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.

| `rbd`
| `object`
| rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported.

| `scaleIO`
| `object`
| scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.

| `secret`
| `object`
| secret represents a secret that should populate this volume.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

| `storageos`
| `object`
| storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.

| `vsphereVolume`
| `object`
| vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.
Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type
are redirected to the csi.vsphere.vmware.com CSI driver.

|===
=== .spec.volumes[].awsElasticBlockStore
Description::
+
--
awsElasticBlockStore represents an AWS Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree
awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
--

Type::
  `object`

Required::
  - `volumeID`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `fsType`
| `string`
| fsType is the filesystem type of the volume that you want to mount.
Tip: Ensure that the filesystem type is supported by the host operating system.
Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

| `partition`
| `integer`
| partition is the partition in the volume that you want to mount.
If omitted, the default is to mount by volume name.
Examples: For volume /dev/sda1, you specify the partition as "1".
Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).

| `readOnly`
| `boolean`
| readOnly value true will force the readOnly setting in VolumeMounts.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

| `volumeID`
| `string`
| volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

|===
=== .spec.volumes[].azureDisk
Description::
+
--
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type
are redirected to the disk.csi.azure.com CSI driver.
--

Type::
  `object`

Required::
  - `diskName`
  - `diskURI`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `cachingMode`
| `string`
| cachingMode is the Host Caching mode: None, Read Only, Read Write.

| `diskName`
| `string`
| diskName is the Name of the data disk in the blob storage

| `diskURI`
| `string`
| diskURI is the URI of data disk in the blob storage

| `fsType`
| `string`
| fsType is Filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

| `kind`
| `string`
| 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

| `readOnly`
| `boolean`
| readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.

|===
=== .spec.volumes[].azureFile
Description::
+
--
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type
are redirected to the file.csi.azure.com CSI driver.
--

Type::
  `object`

Required::
  - `secretName`
  - `shareName`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `readOnly`
| `boolean`
| readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.

| `secretName`
| `string`
| secretName is the  name of secret that contains Azure Storage Account Name and Key

| `shareName`
| `string`
| shareName is the azure share Name

|===
=== .spec.volumes[].cephfs
Description::
+
--
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.
Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
--

Type::
  `object`

Required::
  - `monitors`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `monitors`
| `array (string)`
| monitors is Required: Monitors is a collection of Ceph monitors
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

| `path`
| `string`
| path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /

| `readOnly`
| `boolean`
| readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

| `secretFile`
| `string`
| secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

| `secretRef`
| `object`
| secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

| `user`
| `string`
| user is optional: User is the rados user name, default is admin
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

|===
=== .spec.volumes[].cephfs.secretRef
Description::
+
--
secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty.
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

|===
=== .spec.volumes[].cinder
Description::
+
--
cinder represents a cinder volume attached and mounted on kubelets host machine.
Deprecated: Cinder is deprecated. All operations for the in-tree cinder type
are redirected to the cinder.csi.openstack.org CSI driver.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md
--

Type::
  `object`

Required::
  - `volumeID`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `fsType`
| `string`
| fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md

| `readOnly`
| `boolean`
| readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md

| `secretRef`
| `object`
| secretRef is optional: points to a secret object containing parameters used to connect
to OpenStack.

| `volumeID`
| `string`
| volumeID used to identify the volume in cinder.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md

|===
=== .spec.volumes[].cinder.secretRef
Description::
+
--
secretRef is optional: points to a secret object containing parameters used to connect
to OpenStack.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

|===
=== .spec.volumes[].configMap
Description::
+
--
configMap represents a configMap that should populate this volume
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `defaultMode`
| `integer`
| defaultMode is optional: mode bits used to set permissions on created files by default.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
Defaults to 0644.
Directories within the path are not affected by this setting.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.

| `items`
| `array`
| items if unspecified, each key-value pair in the Data field of the referenced
ConfigMap will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the ConfigMap,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'.

| `items[]`
| `object`
| Maps a string key to a path within a volume.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| optional specify whether the ConfigMap or its keys must be defined

|===
=== .spec.volumes[].configMap.items
Description::
+
--
items if unspecified, each key-value pair in the Data field of the referenced
ConfigMap will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the ConfigMap,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'.
--

Type::
  `array`




=== .spec.volumes[].configMap.items[]
Description::
+
--
Maps a string key to a path within a volume.
--

Type::
  `object`

Required::
  - `key`
  - `path`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the key to project.

| `mode`
| `integer`
| mode is Optional: mode bits used to set permissions on this file.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.

| `path`
| `string`
| path is the relative path of the file to map the key to.
May not be an absolute path.
May not contain the path element '..'.
May not start with the string '..'.

|===
=== .spec.volumes[].csi
Description::
+
--
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers.
--

Type::
  `object`

Required::
  - `driver`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `driver`
| `string`
| driver is the name of the CSI driver that handles this volume.
Consult with your admin for the correct name as registered in the cluster.

| `fsType`
| `string`
| fsType to mount. Ex. "ext4", "xfs", "ntfs".
If not provided, the empty value is passed to the associated CSI driver
which will determine the default filesystem to apply.

| `nodePublishSecretRef`
| `object`
| nodePublishSecretRef is a reference to the secret object containing
sensitive information to pass to the CSI driver to complete the CSI
NodePublishVolume and NodeUnpublishVolume calls.
This field is optional, and  may be empty if no secret is required. If the
secret object contains more than one secret, all secret references are passed.

| `readOnly`
| `boolean`
| readOnly specifies a read-only configuration for the volume.
Defaults to false (read/write).

| `volumeAttributes`
| `object (string)`
| volumeAttributes stores driver-specific properties that are passed to the CSI
driver. Consult your driver's documentation for supported values.

|===
=== .spec.volumes[].csi.nodePublishSecretRef
Description::
+
--
nodePublishSecretRef is a reference to the secret object containing
sensitive information to pass to the CSI driver to complete the CSI
NodePublishVolume and NodeUnpublishVolume calls.
This field is optional, and  may be empty if no secret is required. If the
secret object contains more than one secret, all secret references are passed.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

|===
=== .spec.volumes[].downwardAPI
Description::
+
--
downwardAPI represents downward API about the pod that should populate this volume
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `defaultMode`
| `integer`
| Optional: mode bits to use on created files by default. Must be a
Optional: mode bits used to set permissions on created files by default.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
Defaults to 0644.
Directories within the path are not affected by this setting.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.

| `items`
| `array`
| Items is a list of downward API volume file

| `items[]`
| `object`
| DownwardAPIVolumeFile represents information to create the file containing the pod field

|===
=== .spec.volumes[].downwardAPI.items
Description::
+
--
Items is a list of downward API volume file
--

Type::
  `array`




=== .spec.volumes[].downwardAPI.items[]
Description::
+
--
DownwardAPIVolumeFile represents information to create the file containing the pod field
--

Type::
  `object`

Required::
  - `path`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `fieldRef`
| `object`
| Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

| `mode`
| `integer`
| Optional: mode bits used to set permissions on this file, must be an octal value
between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.

| `path`
| `string`
| 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 '..'

| `resourceFieldRef`
| `object`
| Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

|===
=== .spec.volumes[].downwardAPI.items[].fieldRef
Description::
+
--
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
--

Type::
  `object`

Required::
  - `fieldPath`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiVersion`
| `string`
| Version of the schema the FieldPath is written in terms of, defaults to "v1".

| `fieldPath`
| `string`
| Path of the field to select in the specified API version.

|===
=== .spec.volumes[].downwardAPI.items[].resourceFieldRef
Description::
+
--
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
--

Type::
  `object`

Required::
  - `resource`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `containerName`
| `string`
| Container name: required for volumes, optional for env vars

| `divisor`
| `integer-or-string`
| Specifies the output format of the exposed resources, defaults to "1"

| `resource`
| `string`
| Required: resource to select

|===
=== .spec.volumes[].emptyDir
Description::
+
--
emptyDir represents a temporary directory that shares a pod's lifetime.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `medium`
| `string`
| medium represents what type of storage medium should back this directory.
The default is "" which means to use the node's default medium.
Must be an empty string (default) or Memory.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

| `sizeLimit`
| `integer-or-string`
| sizeLimit is the total amount of local storage required for this EmptyDir volume.
The size limit is also applicable for memory medium.
The maximum usage on memory medium EmptyDir would be the minimum value between
the SizeLimit specified here and the sum of memory limits of all containers in a pod.
The default is nil which means that the limit is undefined.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

|===
=== .spec.volumes[].ephemeral
Description::
+
--
ephemeral represents a volume that is handled by a cluster storage driver.
The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
and deleted when the pod is removed.

Use this if:
a) the volume is only needed while the pod runs,
b) features of normal volumes like restoring from snapshot or capacity
   tracking are needed,
c) the storage driver is specified through a storage class, and
d) the storage driver supports dynamic volume provisioning through
   a PersistentVolumeClaim (see EphemeralVolumeSource for more
   information on the connection between this volume type
   and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific
APIs for volumes that persist for longer than the lifecycle
of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to
be used that way - see the documentation of the driver for
more information.

A pod can use both types of ephemeral volumes and
persistent volumes at the same time.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `volumeClaimTemplate`
| `object`
| Will be used to create a stand-alone PVC to provision the volume.
The pod in which this EphemeralVolumeSource is embedded will be the
owner of the PVC, i.e. the PVC will be deleted together with the
pod.  The name of the PVC will be `<pod name>-<volume name>` where
`<volume name>` is the name from the `PodSpec.Volumes` array
entry. Pod validation will reject the pod if the concatenated name
is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod
will *not* be used for the pod to avoid using an unrelated
volume by mistake. Starting the pod is then blocked until
the unrelated PVC is removed. If such a pre-created PVC is
meant to be used by the pod, the PVC has to updated with an
owner reference to the pod once the pod exists. Normally
this should not be necessary, but it may be useful when
manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes
to the PVC after it has been created.

Required, must not be nil.

|===
=== .spec.volumes[].ephemeral.volumeClaimTemplate
Description::
+
--
Will be used to create a stand-alone PVC to provision the volume.
The pod in which this EphemeralVolumeSource is embedded will be the
owner of the PVC, i.e. the PVC will be deleted together with the
pod.  The name of the PVC will be `<pod name>-<volume name>` where
`<volume name>` is the name from the `PodSpec.Volumes` array
entry. Pod validation will reject the pod if the concatenated name
is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod
will *not* be used for the pod to avoid using an unrelated
volume by mistake. Starting the pod is then blocked until
the unrelated PVC is removed. If such a pre-created PVC is
meant to be used by the pod, the PVC has to updated with an
owner reference to the pod once the pod exists. Normally
this should not be necessary, but it may be useful when
manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes
to the PVC after it has been created.

Required, must not be nil.
--

Type::
  `object`

Required::
  - `spec`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `metadata`
| `object`
| May contain labels and annotations that will be copied into the PVC
when creating it. No other fields are allowed and will be rejected during
validation.

| `spec`
| `object`
| The specification for the PersistentVolumeClaim. The entire content is
copied unchanged into the PVC that gets created from this
template. The same fields as in a PersistentVolumeClaim
are also valid here.

|===
=== .spec.volumes[].ephemeral.volumeClaimTemplate.metadata
Description::
+
--
May contain labels and annotations that will be copied into the PVC
when creating it. No other fields are allowed and will be rejected during
validation.
--

Type::
  `object`




=== .spec.volumes[].ephemeral.volumeClaimTemplate.spec
Description::
+
--
The specification for the PersistentVolumeClaim. The entire content is
copied unchanged into the PVC that gets created from this
template. The same fields as in a PersistentVolumeClaim
are also valid here.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `accessModes`
| `array (string)`
| accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

| `dataSource`
| `object`
| dataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.

| `dataSourceRef`
| `object`
| dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef:
* While dataSource only allows two specific types of objects, dataSourceRef
  allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
  preserves all values, and generates an error if a disallowed value is
  specified.
* While dataSource only allows local objects, dataSourceRef allows objects
  in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

| `resources`
| `object`
| resources represents the minimum resources the volume should have.
Users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources

| `selector`
| `object`
| selector is a label query over volumes to consider for binding.

| `storageClassName`
| `string`
| storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

| `volumeAttributesClassName`
| `string`
| volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
it can be changed after the claim is created. An empty string or nil value indicates that no
VolumeAttributesClass will be applied to the claim. If the claim enters an Infeasible error state,
this field can be reset to its previous value (including nil) to cancel the modification.
If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
exists.
More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/

| `volumeMode`
| `string`
| volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.

| `volumeName`
| `string`
| volumeName is the binding reference to the PersistentVolume backing this claim.

|===
=== .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSource
Description::
+
--
dataSource field can be used to specify either:
* An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
* An existing PVC (PersistentVolumeClaim)
If the provisioner or an external controller can support the specified data source,
it will create a new volume based on the contents of the specified data source.
When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef,
and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified.
If the namespace is specified, then dataSourceRef will not be copied to dataSource.
--

Type::
  `object`

Required::
  - `kind`
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiGroup`
| `string`
| APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.

| `kind`
| `string`
| Kind is the type of resource being referenced

| `name`
| `string`
| Name is the name of resource being referenced

|===
=== .spec.volumes[].ephemeral.volumeClaimTemplate.spec.dataSourceRef
Description::
+
--
dataSourceRef specifies the object from which to populate the volume with data, if a non-empty
volume is desired. This may be any object from a non-empty API group (non
core object) or a PersistentVolumeClaim object.
When this field is specified, volume binding will only succeed if the type of
the specified object matches some installed volume populator or dynamic
provisioner.
This field will replace the functionality of the dataSource field and as such
if both fields are non-empty, they must have the same value. For backwards
compatibility, when namespace isn't specified in dataSourceRef,
both fields (dataSource and dataSourceRef) will be set to the same
value automatically if one of them is empty and the other is non-empty.
When namespace is specified in dataSourceRef,
dataSource isn't set to the same value and must be empty.
There are three important differences between dataSource and dataSourceRef:
* While dataSource only allows two specific types of objects, dataSourceRef
  allows any non-core object, as well as PersistentVolumeClaim objects.
* While dataSource ignores disallowed values (dropping them), dataSourceRef
  preserves all values, and generates an error if a disallowed value is
  specified.
* While dataSource only allows local objects, dataSourceRef allows objects
  in any namespaces.
(Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled.
(Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.
--

Type::
  `object`

Required::
  - `kind`
  - `name`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiGroup`
| `string`
| APIGroup is the group for the resource being referenced.
If APIGroup is not specified, the specified Kind must be in the core API group.
For any other third-party types, APIGroup is required.

| `kind`
| `string`
| Kind is the type of resource being referenced

| `name`
| `string`
| Name is the name of resource being referenced

| `namespace`
| `string`
| Namespace is the namespace of resource being referenced
Note 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.
(Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

|===
=== .spec.volumes[].ephemeral.volumeClaimTemplate.spec.resources
Description::
+
--
resources represents the minimum resources the volume should have.
Users are allowed to specify resource requirements
that are lower than previous value but must still be higher than capacity recorded in the
status field of the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#resources
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `limits`
| `integer-or-string`
| Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

| `requests`
| `integer-or-string`
| Requests describes the minimum amount of compute resources required.
If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,
otherwise to an implementation-defined value. Requests cannot exceed Limits.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

|===
=== .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector
Description::
+
--
selector is a label query over volumes to consider for binding.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.volumes[].ephemeral.volumeClaimTemplate.spec.selector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.volumes[].fc
Description::
+
--
fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `fsType`
| `string`
| fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

| `lun`
| `integer`
| lun is Optional: FC target lun number

| `readOnly`
| `boolean`
| readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.

| `targetWWNs`
| `array (string)`
| targetWWNs is Optional: FC target worldwide names (WWNs)

| `wwids`
| `array (string)`
| wwids Optional: FC volume world wide identifiers (wwids)
Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

|===
=== .spec.volumes[].flexVolume
Description::
+
--
flexVolume represents a generic volume resource that is
provisioned/attached using an exec based plugin.
Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
--

Type::
  `object`

Required::
  - `driver`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `driver`
| `string`
| driver is the name of the driver to use for this volume.

| `fsType`
| `string`
| fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

| `options`
| `object (string)`
| options is Optional: this field holds extra command options if any.

| `readOnly`
| `boolean`
| readOnly is Optional: defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.

| `secretRef`
| `object`
| secretRef is Optional: secretRef is reference to the secret object containing
sensitive information to pass to the plugin scripts. This may be
empty if no secret object is specified. If the secret object
contains more than one secret, all secrets are passed to the plugin
scripts.

|===
=== .spec.volumes[].flexVolume.secretRef
Description::
+
--
secretRef is Optional: secretRef is reference to the secret object containing
sensitive information to pass to the plugin scripts. This may be
empty if no secret object is specified. If the secret object
contains more than one secret, all secrets are passed to the plugin
scripts.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

|===
=== .spec.volumes[].flocker
Description::
+
--
flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running.
Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `datasetName`
| `string`
| datasetName is Name of the dataset stored as metadata -> name on the dataset for Flocker
should be considered as deprecated

| `datasetUUID`
| `string`
| datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

|===
=== .spec.volumes[].gcePersistentDisk
Description::
+
--
gcePersistentDisk represents a GCE Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree
gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
--

Type::
  `object`

Required::
  - `pdName`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `fsType`
| `string`
| fsType is filesystem type of the volume that you want to mount.
Tip: Ensure that the filesystem type is supported by the host operating system.
Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

| `partition`
| `integer`
| partition is the partition in the volume that you want to mount.
If omitted, the default is to mount by volume name.
Examples: For volume /dev/sda1, you specify the partition as "1".
Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty).
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

| `pdName`
| `string`
| pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

| `readOnly`
| `boolean`
| readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

|===
=== .spec.volumes[].gitRepo
Description::
+
--
gitRepo represents a git repository at a particular revision.
Deprecated: GitRepo is deprecated. To provision a container with a git repo, mount an
EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir
into the Pod's container.
--

Type::
  `object`

Required::
  - `repository`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `directory`
| `string`
| directory is the target directory name.
Must not contain or start with '..'.  If '.' is supplied, the volume directory will be the
git repository.  Otherwise, if specified, the volume will contain the git repository in
the subdirectory with the given name.

| `repository`
| `string`
| repository is the URL

| `revision`
| `string`
| revision is the commit hash for the specified revision.

|===
=== .spec.volumes[].glusterfs
Description::
+
--
glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported.
--

Type::
  `object`

Required::
  - `endpoints`
  - `path`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `endpoints`
| `string`
| endpoints is the endpoint name that details Glusterfs topology.

| `path`
| `string`
| path is the Glusterfs volume path.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

| `readOnly`
| `boolean`
| readOnly here will force the Glusterfs volume to be mounted with read-only permissions.
Defaults to false.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

|===
=== .spec.volumes[].hostPath
Description::
+
--
hostPath represents a pre-existing file or directory on the host
machine that is directly exposed to the container. This is generally
used for system agents or other privileged things that are allowed
to see the host machine. Most containers will NOT need this.
More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
--

Type::
  `object`

Required::
  - `path`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `path`
| `string`
| path of the directory on the host.
If the path is a symlink, it will follow the link to the real path.
More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

| `type`
| `string`
| type for HostPath Volume
Defaults to ""
More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

|===
=== .spec.volumes[].image
Description::
+
--
image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine.
The volume is resolved at pod startup depending on which PullPolicy value is provided:

- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
- 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.
- 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.

The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation.
A 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.
The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field.
The OCI object gets mounted in a single directory (spec.containers[*].volumeMounts.mountPath) by merging the manifest layers in the same way as for container images.
The volume will be mounted read-only (ro) and non-executable files (noexec).
Sub path mounts for containers are not supported (spec.containers[*].volumeMounts.subpath) before 1.33.
The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `pullPolicy`
| `string`
| Policy for pulling OCI objects. Possible values are:
Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
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.
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.
Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.

| `reference`
| `string`
| Required: Image or artifact reference to be used.
Behaves in the same way as pod.spec.containers[*].image.
Pull 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.
More info: https://kubernetes.io/docs/concepts/containers/images
This field is optional to allow higher level config management to default or override
container images in workload controllers like Deployments and StatefulSets.

|===
=== .spec.volumes[].iscsi
Description::
+
--
iscsi represents an ISCSI Disk resource that is attached to a
kubelet's host machine and then exposed to the pod.
More info: https://kubernetes.io/docs/concepts/storage/volumes/#iscsi
--

Type::
  `object`

Required::
  - `iqn`
  - `lun`
  - `targetPortal`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `chapAuthDiscovery`
| `boolean`
| chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication

| `chapAuthSession`
| `boolean`
| chapAuthSession defines whether support iSCSI Session CHAP authentication

| `fsType`
| `string`
| fsType is the filesystem type of the volume that you want to mount.
Tip: Ensure that the filesystem type is supported by the host operating system.
Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi

| `initiatorName`
| `string`
| initiatorName is the custom iSCSI Initiator Name.
If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface
<target portal>:<volume name> will be created for the connection.

| `iqn`
| `string`
| iqn is the target iSCSI Qualified Name.

| `iscsiInterface`
| `string`
| iscsiInterface is the interface Name that uses an iSCSI transport.
Defaults to 'default' (tcp).

| `lun`
| `integer`
| lun represents iSCSI Target Lun number.

| `portals`
| `array (string)`
| portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port
is other than default (typically TCP ports 860 and 3260).

| `readOnly`
| `boolean`
| readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.

| `secretRef`
| `object`
| secretRef is the CHAP Secret for iSCSI target and initiator authentication

| `targetPortal`
| `string`
| targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port
is other than default (typically TCP ports 860 and 3260).

|===
=== .spec.volumes[].iscsi.secretRef
Description::
+
--
secretRef is the CHAP Secret for iSCSI target and initiator authentication
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

|===
=== .spec.volumes[].nfs
Description::
+
--
nfs represents an NFS mount on the host that shares a pod's lifetime
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
--

Type::
  `object`

Required::
  - `path`
  - `server`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `path`
| `string`
| path that is exported by the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

| `readOnly`
| `boolean`
| readOnly here will force the NFS export to be mounted with read-only permissions.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

| `server`
| `string`
| server is the hostname or IP address of the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

|===
=== .spec.volumes[].persistentVolumeClaim
Description::
+
--
persistentVolumeClaimVolumeSource represents a reference to a
PersistentVolumeClaim in the same namespace.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
--

Type::
  `object`

Required::
  - `claimName`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `claimName`
| `string`
| claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

| `readOnly`
| `boolean`
| readOnly Will force the ReadOnly setting in VolumeMounts.
Default false.

|===
=== .spec.volumes[].photonPersistentDisk
Description::
+
--
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.
Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
--

Type::
  `object`

Required::
  - `pdID`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `fsType`
| `string`
| fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

| `pdID`
| `string`
| pdID is the ID that identifies Photon Controller persistent disk

|===
=== .spec.volumes[].portworxVolume
Description::
+
--
portworxVolume represents a portworx volume attached and mounted on kubelets host machine.
Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type
are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate
is on.
--

Type::
  `object`

Required::
  - `volumeID`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `fsType`
| `string`
| fSType represents the filesystem type to mount
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.

| `readOnly`
| `boolean`
| readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.

| `volumeID`
| `string`
| volumeID uniquely identifies a Portworx volume

|===
=== .spec.volumes[].projected
Description::
+
--
projected items for all in one resources secrets, configmaps, and downward API
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `defaultMode`
| `integer`
| defaultMode are the mode bits used to set permissions on created files by default.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
Directories within the path are not affected by this setting.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.

| `sources`
| `array`
| sources is the list of volume projections. Each entry in this list
handles one source.

| `sources[]`
| `object`
| Projection that may be projected along with other supported volume types.
Exactly one of these fields must be set.

|===
=== .spec.volumes[].projected.sources
Description::
+
--
sources is the list of volume projections. Each entry in this list
handles one source.
--

Type::
  `array`




=== .spec.volumes[].projected.sources[]
Description::
+
--
Projection that may be projected along with other supported volume types.
Exactly one of these fields must be set.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `clusterTrustBundle`
| `object`
| ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field
of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the
combination of signer name and a label selector.

Kubelet performs aggressive normalization of the PEM contents written
into the pod filesystem.  Esoteric PEM features such as inter-block
comments and block headers are stripped.  Certificates are deduplicated.
The ordering of certificates within the file is arbitrary, and Kubelet
may change the order over time.

| `configMap`
| `object`
| configMap information about the configMap data to project

| `downwardAPI`
| `object`
| downwardAPI information about the downwardAPI data to project

| `podCertificate`
| `object`
| Projects an auto-rotating credential bundle (private key and certificate
chain) that the pod can use either as a TLS client or server.

Kubelet generates a private key and uses it to send a
PodCertificateRequest to the named signer.  Once the signer approves the
request and issues a certificate chain, Kubelet writes the key and
certificate chain to the pod filesystem.  The pod does not start until
certificates have been issued for each podCertificate projected volume
source in its spec.

Kubelet will begin trying to rotate the certificate at the time indicated
by the signer using the PodCertificateRequest.Status.BeginRefreshAt
timestamp.

Kubelet can write a single file, indicated by the credentialBundlePath
field, or separate files, indicated by the keyPath and
certificateChainPath fields.

The credential bundle is a single file in PEM format.  The first PEM
entry is the private key (in PKCS#8 format), and the remaining PEM
entries are the certificate chain issued by the signer (typically,
signers will return their certificate chain in leaf-to-root order).

Prefer using the credential bundle format, since your application code
can read it atomically.  If you use keyPath and certificateChainPath,
your application must make two separate file reads. If these coincide
with a certificate rotation, it is possible that the private key and leaf
certificate you read may not correspond to each other.  Your application
will need to check for this condition, and re-read until they are
consistent.

The named signer controls chooses the format of the certificate it
issues; consult the signer implementation's documentation to learn how to
use the certificates it issues.

| `secret`
| `object`
| secret information about the secret data to project

| `serviceAccountToken`
| `object`
| serviceAccountToken is information about the serviceAccountToken data to project

|===
=== .spec.volumes[].projected.sources[].clusterTrustBundle
Description::
+
--
ClusterTrustBundle allows a pod to access the `.spec.trustBundle` field
of ClusterTrustBundle objects in an auto-updating file.

Alpha, gated by the ClusterTrustBundleProjection feature gate.

ClusterTrustBundle objects can either be selected by name, or by the
combination of signer name and a label selector.

Kubelet performs aggressive normalization of the PEM contents written
into the pod filesystem.  Esoteric PEM features such as inter-block
comments and block headers are stripped.  Certificates are deduplicated.
The ordering of certificates within the file is arbitrary, and Kubelet
may change the order over time.
--

Type::
  `object`

Required::
  - `path`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `labelSelector`
| `object`
| Select all ClusterTrustBundles that match this label selector.  Only has
effect if signerName is set.  Mutually-exclusive with name.  If unset,
interpreted as "match nothing".  If set but empty, interpreted as "match
everything".

| `name`
| `string`
| Select a single ClusterTrustBundle by object name.  Mutually-exclusive
with signerName and labelSelector.

| `optional`
| `boolean`
| If true, don't block pod startup if the referenced ClusterTrustBundle(s)
aren't available.  If using name, then the named ClusterTrustBundle is
allowed not to exist.  If using signerName, then the combination of
signerName and labelSelector is allowed to match zero
ClusterTrustBundles.

| `path`
| `string`
| Relative path from the volume root to write the bundle.

| `signerName`
| `string`
| Select all ClusterTrustBundles that match this signer name.
Mutually-exclusive with name.  The contents of all selected
ClusterTrustBundles will be unified and deduplicated.

|===
=== .spec.volumes[].projected.sources[].clusterTrustBundle.labelSelector
Description::
+
--
Select all ClusterTrustBundles that match this label selector.  Only has
effect if signerName is set.  Mutually-exclusive with name.  If unset,
interpreted as "match nothing".  If set but empty, interpreted as "match
everything".
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `matchExpressions`
| `array`
| matchExpressions is a list of label selector requirements. The requirements are ANDed.

| `matchExpressions[]`
| `object`
| A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.

| `matchLabels`
| `object (string)`
| matchLabels is a map of {key,value} pairs. A single {key,value} in the matchLabels
map is equivalent to an element of matchExpressions, whose key field is "key", the
operator is "In", and the values array contains only "value". The requirements are ANDed.

|===
=== .spec.volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions
Description::
+
--
matchExpressions is a list of label selector requirements. The requirements are ANDed.
--

Type::
  `array`




=== .spec.volumes[].projected.sources[].clusterTrustBundle.labelSelector.matchExpressions[]
Description::
+
--
A label selector requirement is a selector that contains values, a key, and an operator that
relates the key and values.
--

Type::
  `object`

Required::
  - `key`
  - `operator`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the label key that the selector applies to.

| `operator`
| `string`
| operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.

| `values`
| `array (string)`
| values is an array of string values. If the operator is In or NotIn,
the values array must be non-empty. If the operator is Exists or DoesNotExist,
the values array must be empty. This array is replaced during a strategic
merge patch.

|===
=== .spec.volumes[].projected.sources[].configMap
Description::
+
--
configMap information about the configMap data to project
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `items`
| `array`
| items if unspecified, each key-value pair in the Data field of the referenced
ConfigMap will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the ConfigMap,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'.

| `items[]`
| `object`
| Maps a string key to a path within a volume.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| optional specify whether the ConfigMap or its keys must be defined

|===
=== .spec.volumes[].projected.sources[].configMap.items
Description::
+
--
items if unspecified, each key-value pair in the Data field of the referenced
ConfigMap will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the ConfigMap,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'.
--

Type::
  `array`




=== .spec.volumes[].projected.sources[].configMap.items[]
Description::
+
--
Maps a string key to a path within a volume.
--

Type::
  `object`

Required::
  - `key`
  - `path`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the key to project.

| `mode`
| `integer`
| mode is Optional: mode bits used to set permissions on this file.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.

| `path`
| `string`
| path is the relative path of the file to map the key to.
May not be an absolute path.
May not contain the path element '..'.
May not start with the string '..'.

|===
=== .spec.volumes[].projected.sources[].downwardAPI
Description::
+
--
downwardAPI information about the downwardAPI data to project
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `items`
| `array`
| Items is a list of DownwardAPIVolume file

| `items[]`
| `object`
| DownwardAPIVolumeFile represents information to create the file containing the pod field

|===
=== .spec.volumes[].projected.sources[].downwardAPI.items
Description::
+
--
Items is a list of DownwardAPIVolume file
--

Type::
  `array`




=== .spec.volumes[].projected.sources[].downwardAPI.items[]
Description::
+
--
DownwardAPIVolumeFile represents information to create the file containing the pod field
--

Type::
  `object`

Required::
  - `path`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `fieldRef`
| `object`
| Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.

| `mode`
| `integer`
| Optional: mode bits used to set permissions on this file, must be an octal value
between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.

| `path`
| `string`
| 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 '..'

| `resourceFieldRef`
| `object`
| Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

|===
=== .spec.volumes[].projected.sources[].downwardAPI.items[].fieldRef
Description::
+
--
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
--

Type::
  `object`

Required::
  - `fieldPath`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `apiVersion`
| `string`
| Version of the schema the FieldPath is written in terms of, defaults to "v1".

| `fieldPath`
| `string`
| Path of the field to select in the specified API version.

|===
=== .spec.volumes[].projected.sources[].downwardAPI.items[].resourceFieldRef
Description::
+
--
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
--

Type::
  `object`

Required::
  - `resource`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `containerName`
| `string`
| Container name: required for volumes, optional for env vars

| `divisor`
| `integer-or-string`
| Specifies the output format of the exposed resources, defaults to "1"

| `resource`
| `string`
| Required: resource to select

|===
=== .spec.volumes[].projected.sources[].podCertificate
Description::
+
--
Projects an auto-rotating credential bundle (private key and certificate
chain) that the pod can use either as a TLS client or server.

Kubelet generates a private key and uses it to send a
PodCertificateRequest to the named signer.  Once the signer approves the
request and issues a certificate chain, Kubelet writes the key and
certificate chain to the pod filesystem.  The pod does not start until
certificates have been issued for each podCertificate projected volume
source in its spec.

Kubelet will begin trying to rotate the certificate at the time indicated
by the signer using the PodCertificateRequest.Status.BeginRefreshAt
timestamp.

Kubelet can write a single file, indicated by the credentialBundlePath
field, or separate files, indicated by the keyPath and
certificateChainPath fields.

The credential bundle is a single file in PEM format.  The first PEM
entry is the private key (in PKCS#8 format), and the remaining PEM
entries are the certificate chain issued by the signer (typically,
signers will return their certificate chain in leaf-to-root order).

Prefer using the credential bundle format, since your application code
can read it atomically.  If you use keyPath and certificateChainPath,
your application must make two separate file reads. If these coincide
with a certificate rotation, it is possible that the private key and leaf
certificate you read may not correspond to each other.  Your application
will need to check for this condition, and re-read until they are
consistent.

The named signer controls chooses the format of the certificate it
issues; consult the signer implementation's documentation to learn how to
use the certificates it issues.
--

Type::
  `object`

Required::
  - `keyType`
  - `signerName`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `certificateChainPath`
| `string`
| Write the certificate chain at this path in the projected volume.

Most applications should use credentialBundlePath.  When using keyPath
and certificateChainPath, your application needs to check that the key
and leaf certificate are consistent, because it is possible to read the
files mid-rotation.

| `credentialBundlePath`
| `string`
| Write the credential bundle at this path in the projected volume.

The credential bundle is a single file that contains multiple PEM blocks.
The first PEM block is a PRIVATE KEY block, containing a PKCS#8 private
key.

The remaining blocks are CERTIFICATE blocks, containing the issued
certificate chain from the signer (leaf and any intermediates).

Using credentialBundlePath lets your Pod's application code make a single
atomic read that retrieves a consistent key and certificate chain.  If you
project them to separate files, your application code will need to
additionally check that the leaf certificate was issued to the key.

| `keyPath`
| `string`
| Write the key at this path in the projected volume.

Most applications should use credentialBundlePath.  When using keyPath
and certificateChainPath, your application needs to check that the key
and leaf certificate are consistent, because it is possible to read the
files mid-rotation.

| `keyType`
| `string`
| The type of keypair Kubelet will generate for the pod.

Valid values are "RSA3072", "RSA4096", "ECDSAP256", "ECDSAP384",
"ECDSAP521", and "ED25519".

| `maxExpirationSeconds`
| `integer`
| maxExpirationSeconds is the maximum lifetime permitted for the
certificate.

Kubelet copies this value verbatim into the PodCertificateRequests it
generates for this projection.

If omitted, kube-apiserver will set it to 86400(24 hours). kube-apiserver
will reject values shorter than 3600 (1 hour).  The maximum allowable
value is 7862400 (91 days).

The signer implementation is then free to issue a certificate with any
lifetime *shorter* than MaxExpirationSeconds, but no shorter than 3600
seconds (1 hour).  This constraint is enforced by kube-apiserver.
`kubernetes.io` signers will never issue certificates with a lifetime
longer than 24 hours.

| `signerName`
| `string`
| Kubelet's generated CSRs will be addressed to this signer.

| `userAnnotations`
| `object (string)`
| userAnnotations allow pod authors to pass additional information to
the signer implementation.  Kubernetes does not restrict or validate this
metadata in any way.

These values are copied verbatim into the `spec.unverifiedUserAnnotations` field of
the PodCertificateRequest objects that Kubelet creates.

Entries are subject to the same validation as object metadata annotations,
with the addition that all keys must be domain-prefixed. No restrictions
are placed on values, except an overall size limitation on the entire field.

Signers should document the keys and values they support. Signers should
deny requests that contain keys they do not recognize.

|===
=== .spec.volumes[].projected.sources[].secret
Description::
+
--
secret information about the secret data to project
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `items`
| `array`
| items if unspecified, each key-value pair in the Data field of the referenced
Secret will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the Secret,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'.

| `items[]`
| `object`
| Maps a string key to a path within a volume.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| optional field specify whether the Secret or its key must be defined

|===
=== .spec.volumes[].projected.sources[].secret.items
Description::
+
--
items if unspecified, each key-value pair in the Data field of the referenced
Secret will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the Secret,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'.
--

Type::
  `array`




=== .spec.volumes[].projected.sources[].secret.items[]
Description::
+
--
Maps a string key to a path within a volume.
--

Type::
  `object`

Required::
  - `key`
  - `path`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the key to project.

| `mode`
| `integer`
| mode is Optional: mode bits used to set permissions on this file.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.

| `path`
| `string`
| path is the relative path of the file to map the key to.
May not be an absolute path.
May not contain the path element '..'.
May not start with the string '..'.

|===
=== .spec.volumes[].projected.sources[].serviceAccountToken
Description::
+
--
serviceAccountToken is information about the serviceAccountToken data to project
--

Type::
  `object`

Required::
  - `path`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `audience`
| `string`
| audience is the intended audience of the token. A recipient of a token
must identify itself with an identifier specified in the audience of the
token, and otherwise should reject the token. The audience defaults to the
identifier of the apiserver.

| `expirationSeconds`
| `integer`
| expirationSeconds is the requested duration of validity of the service
account token. As the token approaches expiration, the kubelet volume
plugin will proactively rotate the service account token. The kubelet will
start trying to rotate the token if the token is older than 80 percent of
its time to live or if the token is older than 24 hours.Defaults to 1 hour
and must be at least 10 minutes.

| `path`
| `string`
| path is the path relative to the mount point of the file to project the
token into.

|===
=== .spec.volumes[].quobyte
Description::
+
--
quobyte represents a Quobyte mount on the host that shares a pod's lifetime.
Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
--

Type::
  `object`

Required::
  - `registry`
  - `volume`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `group`
| `string`
| group to map volume access to
Default is no group

| `readOnly`
| `boolean`
| readOnly here will force the Quobyte volume to be mounted with read-only permissions.
Defaults to false.

| `registry`
| `string`
| registry represents a single or multiple Quobyte Registry services
specified as a string as host:port pair (multiple entries are separated with commas)
which acts as the central registry for volumes

| `tenant`
| `string`
| tenant owning the given Quobyte volume in the Backend
Used with dynamically provisioned Quobyte volumes, value is set by the plugin

| `user`
| `string`
| user to map volume access to
Defaults to serivceaccount user

| `volume`
| `string`
| volume is a string that references an already created Quobyte volume by name.

|===
=== .spec.volumes[].rbd
Description::
+
--
rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported.
--

Type::
  `object`

Required::
  - `image`
  - `monitors`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `fsType`
| `string`
| fsType is the filesystem type of the volume that you want to mount.
Tip: Ensure that the filesystem type is supported by the host operating system.
Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.
More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd

| `image`
| `string`
| image is the rados image name.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

| `keyring`
| `string`
| keyring is the path to key ring for RBDUser.
Default is /etc/ceph/keyring.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

| `monitors`
| `array (string)`
| monitors is a collection of Ceph monitors.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

| `pool`
| `string`
| pool is the rados pool name.
Default is rbd.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

| `readOnly`
| `boolean`
| readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

| `secretRef`
| `object`
| secretRef is name of the authentication secret for RBDUser. If provided
overrides keyring.
Default is nil.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

| `user`
| `string`
| user is the rados user name.
Default is admin.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

|===
=== .spec.volumes[].rbd.secretRef
Description::
+
--
secretRef is name of the authentication secret for RBDUser. If provided
overrides keyring.
Default is nil.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

|===
=== .spec.volumes[].scaleIO
Description::
+
--
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
--

Type::
  `object`

Required::
  - `gateway`
  - `secretRef`
  - `system`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `fsType`
| `string`
| fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs".
Default is "xfs".

| `gateway`
| `string`
| gateway is the host address of the ScaleIO API Gateway.

| `protectionDomain`
| `string`
| protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.

| `readOnly`
| `boolean`
| readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.

| `secretRef`
| `object`
| secretRef references to the secret for ScaleIO user and other
sensitive information. If this is not provided, Login operation will fail.

| `sslEnabled`
| `boolean`
| sslEnabled Flag enable/disable SSL communication with Gateway, default false

| `storageMode`
| `string`
| storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
Default is ThinProvisioned.

| `storagePool`
| `string`
| storagePool is the ScaleIO Storage Pool associated with the protection domain.

| `system`
| `string`
| system is the name of the storage system as configured in ScaleIO.

| `volumeName`
| `string`
| volumeName is the name of a volume already created in the ScaleIO system
that is associated with this volume source.

|===
=== .spec.volumes[].scaleIO.secretRef
Description::
+
--
secretRef references to the secret for ScaleIO user and other
sensitive information. If this is not provided, Login operation will fail.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

|===
=== .spec.volumes[].secret
Description::
+
--
secret represents a secret that should populate this volume.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `defaultMode`
| `integer`
| defaultMode is Optional: mode bits used to set permissions on created files by default.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values
for mode bits. Defaults to 0644.
Directories within the path are not affected by this setting.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.

| `items`
| `array`
| items If unspecified, each key-value pair in the Data field of the referenced
Secret will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the Secret,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'.

| `items[]`
| `object`
| Maps a string key to a path within a volume.

| `optional`
| `boolean`
| optional field specify whether the Secret or its keys must be defined

| `secretName`
| `string`
| secretName is the name of the secret in the pod's namespace to use.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

|===
=== .spec.volumes[].secret.items
Description::
+
--
items If unspecified, each key-value pair in the Data field of the referenced
Secret will be projected into the volume as a file whose name is the
key and content is the value. If specified, the listed keys will be
projected into the specified paths, and unlisted keys will not be
present. If a key is specified which is not present in the Secret,
the volume setup will error unless it is marked optional. Paths must be
relative and may not contain the '..' path or start with '..'.
--

Type::
  `array`




=== .spec.volumes[].secret.items[]
Description::
+
--
Maps a string key to a path within a volume.
--

Type::
  `object`

Required::
  - `key`
  - `path`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| key is the key to project.

| `mode`
| `integer`
| mode is Optional: mode bits used to set permissions on this file.
Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511.
YAML accepts both octal and decimal values, JSON requires decimal values for mode bits.
If not specified, the volume defaultMode will be used.
This might be in conflict with other options that affect the file
mode, like fsGroup, and the result can be other mode bits set.

| `path`
| `string`
| path is the relative path of the file to map the key to.
May not be an absolute path.
May not contain the path element '..'.
May not start with the string '..'.

|===
=== .spec.volumes[].storageos
Description::
+
--
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `fsType`
| `string`
| fsType is the filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

| `readOnly`
| `boolean`
| readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.

| `secretRef`
| `object`
| secretRef specifies the secret to use for obtaining the StorageOS API
credentials.  If not specified, default values will be attempted.

| `volumeName`
| `string`
| volumeName is the human-readable name of the StorageOS volume.  Volume
names are only unique within a namespace.

| `volumeNamespace`
| `string`
| volumeNamespace specifies the scope of the volume within StorageOS.  If no
namespace is specified then the Pod's namespace will be used.  This allows the
Kubernetes name scoping to be mirrored within StorageOS for tighter integration.
Set VolumeName to any name to override the default behaviour.
Set to "default" if you are not using namespaces within StorageOS.
Namespaces that do not pre-exist within StorageOS will be created.

|===
=== .spec.volumes[].storageos.secretRef
Description::
+
--
secretRef specifies the secret to use for obtaining the StorageOS API
credentials.  If not specified, default values will be attempted.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

|===
=== .spec.volumes[].vsphereVolume
Description::
+
--
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.
Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type
are redirected to the csi.vsphere.vmware.com CSI driver.
--

Type::
  `object`

Required::
  - `volumePath`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `fsType`
| `string`
| fsType is filesystem type to mount.
Must be a filesystem type supported by the host operating system.
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

| `storagePolicyID`
| `string`
| storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

| `storagePolicyName`
| `string`
| storagePolicyName is the storage Policy Based Management (SPBM) profile name.

| `volumePath`
| `string`
| volumePath is the path that identifies vSphere volume vmdk

|===
=== .spec.web
Description::
+
--
web defines the configuration of the ThanosRuler web server.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `httpConfig`
| `object`
| httpConfig defines HTTP parameters for web server.

| `tlsConfig`
| `object`
| tlsConfig defines the TLS parameters for HTTPS.

|===
=== .spec.web.httpConfig
Description::
+
--
httpConfig defines HTTP parameters for web server.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `headers`
| `object`
| headers defines a list of headers that can be added to HTTP responses.

| `http2`
| `boolean`
| http2 enable HTTP/2 support. Note that HTTP/2 is only supported with TLS.
When TLSConfig is not configured, HTTP/2 will be disabled.
Whenever the value of the field changes, a rolling update will be triggered.

|===
=== .spec.web.httpConfig.headers
Description::
+
--
headers defines a list of headers that can be added to HTTP responses.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `contentSecurityPolicy`
| `string`
| contentSecurityPolicy defines the Content-Security-Policy header to HTTP responses.
Unset if blank.

| `strictTransportSecurity`
| `string`
| strictTransportSecurity defines the Strict-Transport-Security header to HTTP responses.
Unset if blank.
Please make sure that you use this with care as this header might force
browsers to load Prometheus and the other applications hosted on the same
domain and subdomains over HTTPS.
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security

| `xContentTypeOptions`
| `string`
| xContentTypeOptions defines the X-Content-Type-Options header to HTTP responses.
Unset if blank. Accepted value is nosniff.
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options

| `xFrameOptions`
| `string`
| xFrameOptions defines the X-Frame-Options header to HTTP responses.
Unset if blank. Accepted values are deny and sameorigin.
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options

| `xXSSProtection`
| `string`
| xXSSProtection defines the X-XSS-Protection header to all responses.
Unset if blank.
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection

|===
=== .spec.web.tlsConfig
Description::
+
--
tlsConfig defines the TLS parameters for HTTPS.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `cert`
| `object`
| cert defines the Secret or ConfigMap containing the TLS certificate for the web server.

Either `keySecret` or `keyFile` must be defined.

It is mutually exclusive with `certFile`.

| `certFile`
| `string`
| certFile defines the path to the TLS certificate file in the container for the web server.

Either `keySecret` or `keyFile` must be defined.

It is mutually exclusive with `cert`.

| `cipherSuites`
| `array (string)`
| cipherSuites defines the list of supported cipher suites for TLS versions up to TLS 1.2.

If not defined, the Go default cipher suites are used.
Available cipher suites are documented in the Go documentation:
https://golang.org/pkg/crypto/tls/#pkg-constants

| `clientAuthType`
| `string`
| clientAuthType defines the server policy for client TLS authentication.

For more detail on clientAuth options:
https://golang.org/pkg/crypto/tls/#ClientAuthType

| `clientCAFile`
| `string`
| clientCAFile defines the path to the CA certificate file for client certificate authentication to
the server.

It is mutually exclusive with `client_ca`.

| `client_ca`
| `object`
| client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate
authentication to the server.

It is mutually exclusive with `clientCAFile`.

| `curvePreferences`
| `array (string)`
| curvePreferences defines elliptic curves that will be used in an ECDHE handshake, in preference
order.

Available curves are documented in the Go documentation:
https://golang.org/pkg/crypto/tls/#CurveID

| `keyFile`
| `string`
| keyFile defines the path to the TLS private key file in the container for the web server.

If defined, either `cert` or `certFile` must be defined.

It is mutually exclusive with `keySecret`.

| `keySecret`
| `object`
| keySecret defines the secret containing the TLS private key for the web server.

Either `cert` or `certFile` must be defined.

It is mutually exclusive with `keyFile`.

| `maxVersion`
| `string`
| maxVersion defines the Maximum TLS version that is acceptable.

| `minVersion`
| `string`
| minVersion defines the minimum TLS version that is acceptable.

| `preferServerCipherSuites`
| `boolean`
| preferServerCipherSuites defines whether the server selects the client's most preferred cipher
suite, or the server's most preferred cipher suite.

If true then the server's preference, as expressed in
the order of elements in cipherSuites, is used.

|===
=== .spec.web.tlsConfig.cert
Description::
+
--
cert defines the Secret or ConfigMap containing the TLS certificate for the web server.

Either `keySecret` or `keyFile` must be defined.

It is mutually exclusive with `certFile`.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `configMap`
| `object`
| configMap defines the ConfigMap containing data to use for the targets.

| `secret`
| `object`
| secret defines the Secret containing data to use for the targets.

|===
=== .spec.web.tlsConfig.cert.configMap
Description::
+
--
configMap defines the ConfigMap containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key to select.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the ConfigMap or its key must be defined

|===
=== .spec.web.tlsConfig.cert.secret
Description::
+
--
secret defines the Secret containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.web.tlsConfig.client_ca
Description::
+
--
client_ca defines the Secret or ConfigMap containing the CA certificate for client certificate
authentication to the server.

It is mutually exclusive with `clientCAFile`.
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `configMap`
| `object`
| configMap defines the ConfigMap containing data to use for the targets.

| `secret`
| `object`
| secret defines the Secret containing data to use for the targets.

|===
=== .spec.web.tlsConfig.client_ca.configMap
Description::
+
--
configMap defines the ConfigMap containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key to select.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the ConfigMap or its key must be defined

|===
=== .spec.web.tlsConfig.client_ca.secret
Description::
+
--
secret defines the Secret containing data to use for the targets.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .spec.web.tlsConfig.keySecret
Description::
+
--
keySecret defines the secret containing the TLS private key for the web server.

Either `cert` or `certFile` must be defined.

It is mutually exclusive with `keyFile`.
--

Type::
  `object`

Required::
  - `key`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `key`
| `string`
| The key of the secret to select from.  Must be a valid secret key.

| `name`
| `string`
| Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

| `optional`
| `boolean`
| Specify whether the Secret or its key must be defined

|===
=== .status
Description::
+
--
status defines the most recent observed status of the ThanosRuler cluster. Read-only.
More info:
https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status
--

Type::
  `object`




[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `availableReplicas`
| `integer`
| availableReplicas defines the total number of available pods (ready for at least minReadySeconds)
targeted by this ThanosRuler deployment.

| `conditions`
| `array`
| conditions defines the current state of the ThanosRuler object.

| `conditions[]`
| `object`
| Condition represents the state of the resources associated with the
Prometheus, Alertmanager or ThanosRuler resource.

| `paused`
| `boolean`
| paused defines whether any actions on the underlying managed objects are
being performed. Only delete actions will be performed.

| `replicas`
| `integer`
| replicas defines the total number of non-terminated pods targeted by this ThanosRuler deployment
(their labels match the selector).

| `unavailableReplicas`
| `integer`
| unavailableReplicas defines the total number of unavailable pods targeted by this ThanosRuler deployment.

| `updatedReplicas`
| `integer`
| updatedReplicas defines the total number of non-terminated pods targeted by this ThanosRuler deployment
that have the desired version spec.

|===
=== .status.conditions
Description::
+
--
conditions defines the current state of the ThanosRuler object.
--

Type::
  `array`




=== .status.conditions[]
Description::
+
--
Condition represents the state of the resources associated with the
Prometheus, Alertmanager or ThanosRuler resource.
--

Type::
  `object`

Required::
  - `lastTransitionTime`
  - `status`
  - `type`



[cols="1,1,1",options="header"]
|===
| Property | Type | Description

| `lastTransitionTime`
| `string`
| lastTransitionTime is the time of the last update to the current status property.

| `message`
| `string`
| message defines human-readable message indicating details for the condition's last transition.

| `observedGeneration`
| `integer`
| observedGeneration defines the .metadata.generation that the
condition was set based upon. For instance, if `.metadata.generation` is
currently 12, but the `.status.conditions[].observedGeneration` is 9, the
condition is out of date with respect to the current state of the
instance.

| `reason`
| `string`
| reason for the condition's last transition.

| `status`
| `string`
| status of the condition.

| `type`
| `string`
| type of the condition being reported.

|===

== API endpoints

The following API endpoints are available:

* `/apis/monitoring.coreos.com/v1/thanosrulers`
- `GET`: list objects of kind ThanosRuler
* `/apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers`
- `DELETE`: delete collection of ThanosRuler
- `GET`: list objects of kind ThanosRuler
- `POST`: create a ThanosRuler
* `/apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers/{name}`
- `DELETE`: delete a ThanosRuler
- `GET`: read the specified ThanosRuler
- `PATCH`: partially update the specified ThanosRuler
- `PUT`: replace the specified ThanosRuler
* `/apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers/{name}/status`
- `GET`: read status of the specified ThanosRuler
- `PATCH`: partially update status of the specified ThanosRuler
- `PUT`: replace status of the specified ThanosRuler


=== /apis/monitoring.coreos.com/v1/thanosrulers



HTTP method::
  `GET`

Description::
  list objects of kind ThanosRuler


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#com-coreos-monitoring-v1-ThanosRulerList[`ThanosRulerList`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers



HTTP method::
  `DELETE`

Description::
  delete collection of ThanosRuler




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  list objects of kind ThanosRuler




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#com-coreos-monitoring-v1-ThanosRulerList[`ThanosRulerList`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `POST`

Description::
  create a ThanosRuler


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 201 - Created
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 202 - Accepted
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers/{name}

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ThanosRuler
|===


HTTP method::
  `DELETE`

Description::
  delete a ThanosRuler


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 202 - Accepted
| xref:../objects/index.adoc#io-k8s-apimachinery-pkg-apis-meta-v1-Status[`Status`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `GET`

Description::
  read the specified ThanosRuler




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update the specified ThanosRuler


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace the specified ThanosRuler


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 201 - Created
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 401 - Unauthorized
| Empty
|===


=== /apis/monitoring.coreos.com/v1/namespaces/{namespace}/thanosrulers/{name}/status

.Global path parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `name`
| `string`
| name of the ThanosRuler
|===


HTTP method::
  `GET`

Description::
  read status of the specified ThanosRuler




.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PATCH`

Description::
  partially update status of the specified ThanosRuler


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===


.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 401 - Unauthorized
| Empty
|===

HTTP method::
  `PUT`

Description::
  replace status of the specified ThanosRuler


.Query parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `dryRun`
| `string`
| When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
| `fieldValidation`
| `string`
| fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.
|===

.Body parameters
[cols="1,1,2",options="header"]
|===
| Parameter | Type | Description
| `body`
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 
|===

.HTTP responses
[cols="1,1",options="header"]
|===
| HTTP code | Reponse body
| 200 - OK
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 201 - Created
| xref:../monitoring_apis/thanosruler-monitoring-coreos-com-v1.adoc#thanosruler-monitoring-coreos-com-v1[`ThanosRuler`] schema
| 401 - Unauthorized
| Empty
|===


