11259 lines
650 KiB
YAML
11259 lines
650 KiB
YAML
|
---
|
||
|
apiVersion: apiextensions.k8s.io/v1
|
||
|
kind: CustomResourceDefinition
|
||
|
metadata:
|
||
|
annotations:
|
||
|
controller-gen.kubebuilder.io/version: v0.13.0
|
||
|
operator.prometheus.io/version: 0.69.1
|
||
|
name: prometheuses.monitoring.coreos.com
|
||
|
spec:
|
||
|
group: monitoring.coreos.com
|
||
|
names:
|
||
|
categories:
|
||
|
- prometheus-operator
|
||
|
kind: Prometheus
|
||
|
listKind: PrometheusList
|
||
|
plural: prometheuses
|
||
|
shortNames:
|
||
|
- prom
|
||
|
singular: prometheus
|
||
|
scope: Namespaced
|
||
|
versions:
|
||
|
- additionalPrinterColumns:
|
||
|
- description: The version of Prometheus
|
||
|
jsonPath: .spec.version
|
||
|
name: Version
|
||
|
type: string
|
||
|
- description: The number of desired replicas
|
||
|
jsonPath: .spec.replicas
|
||
|
name: Desired
|
||
|
type: integer
|
||
|
- description: The number of ready replicas
|
||
|
jsonPath: .status.availableReplicas
|
||
|
name: Ready
|
||
|
type: integer
|
||
|
- jsonPath: .status.conditions[?(@.type == 'Reconciled')].status
|
||
|
name: Reconciled
|
||
|
type: string
|
||
|
- jsonPath: .status.conditions[?(@.type == 'Available')].status
|
||
|
name: Available
|
||
|
type: string
|
||
|
- jsonPath: .metadata.creationTimestamp
|
||
|
name: Age
|
||
|
type: date
|
||
|
- description: Whether the resource reconciliation is paused or not
|
||
|
jsonPath: .status.paused
|
||
|
name: Paused
|
||
|
priority: 1
|
||
|
type: boolean
|
||
|
name: v1
|
||
|
schema:
|
||
|
openAPIV3Schema:
|
||
|
description: Prometheus defines a Prometheus deployment.
|
||
|
properties:
|
||
|
apiVersion:
|
||
|
description:
|
||
|
"APIVersion defines the versioned schema of this representation
|
||
|
of an object. Servers should convert recognized schemas to the latest
|
||
|
internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources"
|
||
|
type: string
|
||
|
kind:
|
||
|
description:
|
||
|
"Kind is a string value representing the REST resource this
|
||
|
object represents. Servers may infer this from the endpoint the client
|
||
|
submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
|
||
|
type: string
|
||
|
metadata:
|
||
|
type: object
|
||
|
spec:
|
||
|
description:
|
||
|
"Specification of the desired behavior of the Prometheus
|
||
|
cluster. More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
|
||
|
properties:
|
||
|
additionalAlertManagerConfigs:
|
||
|
description:
|
||
|
"AdditionalAlertManagerConfigs specifies a key of a Secret
|
||
|
containing additional Prometheus Alertmanager configurations. The
|
||
|
Alertmanager configurations are appended to the configuration generated
|
||
|
by the Prometheus Operator. They must be formatted according to
|
||
|
the official Prometheus documentation: \n https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config
|
||
|
\n The user is responsible for making sure that the configurations
|
||
|
are valid \n Note that using this feature may expose the possibility
|
||
|
to break upgrades of Prometheus. It is advised to review Prometheus
|
||
|
release notes to ensure that no incompatible AlertManager configs
|
||
|
are going to break Prometheus after the upgrade."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must be a
|
||
|
valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description: Specify whether the Secret or its key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
additionalAlertRelabelConfigs:
|
||
|
description:
|
||
|
"AdditionalAlertRelabelConfigs specifies a key of a Secret
|
||
|
containing additional Prometheus alert relabel configurations. The
|
||
|
alert relabel configurations are appended to the configuration generated
|
||
|
by the Prometheus Operator. They must be formatted according to
|
||
|
the official Prometheus documentation: \n https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alert_relabel_configs
|
||
|
\n The user is responsible for making sure that the configurations
|
||
|
are valid \n Note that using this feature may expose the possibility
|
||
|
to break upgrades of Prometheus. It is advised to review Prometheus
|
||
|
release notes to ensure that no incompatible alert relabel configs
|
||
|
are going to break Prometheus after the upgrade."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must be a
|
||
|
valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description: Specify whether the Secret or its key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
additionalArgs:
|
||
|
description:
|
||
|
"AdditionalArgs allows setting additional arguments for
|
||
|
the 'prometheus' container. \n 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 Prometheus container
|
||
|
which may cause issues if they are invalid or not supported by the
|
||
|
given Prometheus version. \n 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."
|
||
|
items:
|
||
|
description: Argument as part of the AdditionalArgs list.
|
||
|
properties:
|
||
|
name:
|
||
|
description: Name of the argument, e.g. "scrape.discovery-reload-interval".
|
||
|
minLength: 1
|
||
|
type: string
|
||
|
value:
|
||
|
description:
|
||
|
Argument value, e.g. 30s. Can be empty for name-only
|
||
|
arguments (e.g. --storage.tsdb.no-lockfile)
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
additionalScrapeConfigs:
|
||
|
description:
|
||
|
"AdditionalScrapeConfigs allows specifying a key of a
|
||
|
Secret containing additional Prometheus scrape configurations. Scrape
|
||
|
configurations specified are appended to the configurations generated
|
||
|
by the Prometheus Operator. Job configurations specified must have
|
||
|
the form as specified in the official Prometheus documentation:
|
||
|
https://prometheus.io/docs/prometheus/latest/configuration/configuration/#scrape_config.
|
||
|
As scrape configs are appended, the user is responsible to make
|
||
|
sure it is valid. Note that using this feature may expose the possibility
|
||
|
to break upgrades of Prometheus. It is advised to review Prometheus
|
||
|
release notes to ensure that no incompatible scrape configs are
|
||
|
going to break Prometheus after the upgrade."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must be a
|
||
|
valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description: Specify whether the Secret or its key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
affinity:
|
||
|
description: Defines the Pods' affinity scheduling rules if specified.
|
||
|
properties:
|
||
|
nodeAffinity:
|
||
|
description:
|
||
|
Describes node affinity scheduling rules for the
|
||
|
pod.
|
||
|
properties:
|
||
|
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.
|
||
|
items:
|
||
|
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).
|
||
|
properties:
|
||
|
preference:
|
||
|
description:
|
||
|
A node selector term, associated with the
|
||
|
corresponding weight.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
A list of node selector requirements
|
||
|
by node's labels.
|
||
|
items:
|
||
|
description:
|
||
|
A node selector requirement is a
|
||
|
selector that contains values, a key, and an
|
||
|
operator that relates the key and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The label key that the selector
|
||
|
applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
Represents a key's relationship
|
||
|
to a set of values. Valid operators are
|
||
|
In, NotIn, Exists, DoesNotExist. Gt, and
|
||
|
Lt.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
An array of string values. If
|
||
|
the operator is In or NotIn, 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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchFields:
|
||
|
description:
|
||
|
A list of node selector requirements
|
||
|
by node's fields.
|
||
|
items:
|
||
|
description:
|
||
|
A node selector requirement is a
|
||
|
selector that contains values, a key, and an
|
||
|
operator that relates the key and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The label key that the selector
|
||
|
applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
Represents a key's relationship
|
||
|
to a set of values. Valid operators are
|
||
|
In, NotIn, Exists, DoesNotExist. Gt, and
|
||
|
Lt.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
An array of string values. If
|
||
|
the operator is In or NotIn, 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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
weight:
|
||
|
description:
|
||
|
Weight associated with matching the corresponding
|
||
|
nodeSelectorTerm, in the range 1-100.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
required:
|
||
|
- preference
|
||
|
- weight
|
||
|
type: object
|
||
|
type: array
|
||
|
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.
|
||
|
properties:
|
||
|
nodeSelectorTerms:
|
||
|
description:
|
||
|
Required. A list of node selector terms.
|
||
|
The terms are ORed.
|
||
|
items:
|
||
|
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.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
A list of node selector requirements
|
||
|
by node's labels.
|
||
|
items:
|
||
|
description:
|
||
|
A node selector requirement is a
|
||
|
selector that contains values, a key, and an
|
||
|
operator that relates the key and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The label key that the selector
|
||
|
applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
Represents a key's relationship
|
||
|
to a set of values. Valid operators are
|
||
|
In, NotIn, Exists, DoesNotExist. Gt, and
|
||
|
Lt.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
An array of string values. If
|
||
|
the operator is In or NotIn, 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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchFields:
|
||
|
description:
|
||
|
A list of node selector requirements
|
||
|
by node's fields.
|
||
|
items:
|
||
|
description:
|
||
|
A node selector requirement is a
|
||
|
selector that contains values, a key, and an
|
||
|
operator that relates the key and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The label key that the selector
|
||
|
applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
Represents a key's relationship
|
||
|
to a set of values. Valid operators are
|
||
|
In, NotIn, Exists, DoesNotExist. Gt, and
|
||
|
Lt.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
An array of string values. If
|
||
|
the operator is In or NotIn, 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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: array
|
||
|
required:
|
||
|
- nodeSelectorTerms
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
podAffinity:
|
||
|
description:
|
||
|
Describes pod affinity scheduling rules (e.g. co-locate
|
||
|
this pod in the same node, zone, etc. as some other pod(s)).
|
||
|
properties:
|
||
|
preferredDuringSchedulingIgnoredDuringExecution:
|
||
|
description:
|
||
|
The scheduler will prefer to schedule pods to
|
||
|
nodes that satisfy 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.
|
||
|
items:
|
||
|
description:
|
||
|
The weights of all of the matched WeightedPodAffinityTerm
|
||
|
fields are added per-node to find the most preferred node(s)
|
||
|
properties:
|
||
|
podAffinityTerm:
|
||
|
description:
|
||
|
Required. A pod affinity term, associated
|
||
|
with the corresponding weight.
|
||
|
properties:
|
||
|
labelSelector:
|
||
|
description:
|
||
|
A label query over a set of resources,
|
||
|
in this case pods.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label
|
||
|
selector requirements. The requirements are
|
||
|
ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement
|
||
|
is a selector that contains values, a key,
|
||
|
and an operator that relates the key and
|
||
|
values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that
|
||
|
the selector applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's
|
||
|
relationship to a set of values. Valid
|
||
|
operators are In, NotIn, Exists and
|
||
|
DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string
|
||
|
values. If the operator is In or NotIn,
|
||
|
the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist,
|
||
|
the values array must be empty. This
|
||
|
array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value}
|
||
|
pairs. A single {key,value} in the matchLabels
|
||
|
map is equivalent to an element of matchExpressions,
|
||
|
whose key field is "key", the operator is
|
||
|
"In", and the values array contains only "value".
|
||
|
The requirements are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
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.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label
|
||
|
selector requirements. The requirements are
|
||
|
ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement
|
||
|
is a selector that contains values, a key,
|
||
|
and an operator that relates the key and
|
||
|
values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that
|
||
|
the selector applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's
|
||
|
relationship to a set of values. Valid
|
||
|
operators are In, NotIn, Exists and
|
||
|
DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string
|
||
|
values. If the operator is In or NotIn,
|
||
|
the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist,
|
||
|
the values array must be empty. This
|
||
|
array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value}
|
||
|
pairs. A single {key,value} in the matchLabels
|
||
|
map is equivalent to an element of matchExpressions,
|
||
|
whose key field is "key", the operator is
|
||
|
"In", and the values array contains only "value".
|
||
|
The requirements are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
namespaces:
|
||
|
description:
|
||
|
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".
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
topologyKey:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- topologyKey
|
||
|
type: object
|
||
|
weight:
|
||
|
description:
|
||
|
weight associated with matching the corresponding
|
||
|
podAffinityTerm, in the range 1-100.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
required:
|
||
|
- podAffinityTerm
|
||
|
- weight
|
||
|
type: object
|
||
|
type: array
|
||
|
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.
|
||
|
items:
|
||
|
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
|
||
|
properties:
|
||
|
labelSelector:
|
||
|
description:
|
||
|
A label query over a set of resources,
|
||
|
in this case pods.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label
|
||
|
selector requirements. The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a
|
||
|
selector that contains values, a key, and an
|
||
|
operator that relates the key and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the
|
||
|
selector applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship
|
||
|
to a set of values. Valid operators are
|
||
|
In, NotIn, Exists and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string
|
||
|
values. If the operator is In or NotIn,
|
||
|
the values array must be non-empty. If the
|
||
|
operator is Exists or DoesNotExist, the
|
||
|
values array must be empty. This array is
|
||
|
replaced during a strategic merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value}
|
||
|
pairs. A single {key,value} in the matchLabels
|
||
|
map is equivalent to an element of matchExpressions,
|
||
|
whose key field is "key", the operator is "In",
|
||
|
and the values array contains only "value". The
|
||
|
requirements are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
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.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label
|
||
|
selector requirements. The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a
|
||
|
selector that contains values, a key, and an
|
||
|
operator that relates the key and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the
|
||
|
selector applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship
|
||
|
to a set of values. Valid operators are
|
||
|
In, NotIn, Exists and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string
|
||
|
values. If the operator is In or NotIn,
|
||
|
the values array must be non-empty. If the
|
||
|
operator is Exists or DoesNotExist, the
|
||
|
values array must be empty. This array is
|
||
|
replaced during a strategic merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value}
|
||
|
pairs. A single {key,value} in the matchLabels
|
||
|
map is equivalent to an element of matchExpressions,
|
||
|
whose key field is "key", the operator is "In",
|
||
|
and the values array contains only "value". The
|
||
|
requirements are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
namespaces:
|
||
|
description:
|
||
|
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".
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
topologyKey:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- topologyKey
|
||
|
type: object
|
||
|
type: array
|
||
|
type: object
|
||
|
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)).
|
||
|
properties:
|
||
|
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 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.
|
||
|
items:
|
||
|
description:
|
||
|
The weights of all of the matched WeightedPodAffinityTerm
|
||
|
fields are added per-node to find the most preferred node(s)
|
||
|
properties:
|
||
|
podAffinityTerm:
|
||
|
description:
|
||
|
Required. A pod affinity term, associated
|
||
|
with the corresponding weight.
|
||
|
properties:
|
||
|
labelSelector:
|
||
|
description:
|
||
|
A label query over a set of resources,
|
||
|
in this case pods.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label
|
||
|
selector requirements. The requirements are
|
||
|
ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement
|
||
|
is a selector that contains values, a key,
|
||
|
and an operator that relates the key and
|
||
|
values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that
|
||
|
the selector applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's
|
||
|
relationship to a set of values. Valid
|
||
|
operators are In, NotIn, Exists and
|
||
|
DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string
|
||
|
values. If the operator is In or NotIn,
|
||
|
the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist,
|
||
|
the values array must be empty. This
|
||
|
array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value}
|
||
|
pairs. A single {key,value} in the matchLabels
|
||
|
map is equivalent to an element of matchExpressions,
|
||
|
whose key field is "key", the operator is
|
||
|
"In", and the values array contains only "value".
|
||
|
The requirements are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
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.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label
|
||
|
selector requirements. The requirements are
|
||
|
ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement
|
||
|
is a selector that contains values, a key,
|
||
|
and an operator that relates the key and
|
||
|
values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that
|
||
|
the selector applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's
|
||
|
relationship to a set of values. Valid
|
||
|
operators are In, NotIn, Exists and
|
||
|
DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string
|
||
|
values. If the operator is In or NotIn,
|
||
|
the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist,
|
||
|
the values array must be empty. This
|
||
|
array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value}
|
||
|
pairs. A single {key,value} in the matchLabels
|
||
|
map is equivalent to an element of matchExpressions,
|
||
|
whose key field is "key", the operator is
|
||
|
"In", and the values array contains only "value".
|
||
|
The requirements are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
namespaces:
|
||
|
description:
|
||
|
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".
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
topologyKey:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- topologyKey
|
||
|
type: object
|
||
|
weight:
|
||
|
description:
|
||
|
weight associated with matching the corresponding
|
||
|
podAffinityTerm, in the range 1-100.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
required:
|
||
|
- podAffinityTerm
|
||
|
- weight
|
||
|
type: object
|
||
|
type: array
|
||
|
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.
|
||
|
items:
|
||
|
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
|
||
|
properties:
|
||
|
labelSelector:
|
||
|
description:
|
||
|
A label query over a set of resources,
|
||
|
in this case pods.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label
|
||
|
selector requirements. The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a
|
||
|
selector that contains values, a key, and an
|
||
|
operator that relates the key and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the
|
||
|
selector applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship
|
||
|
to a set of values. Valid operators are
|
||
|
In, NotIn, Exists and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string
|
||
|
values. If the operator is In or NotIn,
|
||
|
the values array must be non-empty. If the
|
||
|
operator is Exists or DoesNotExist, the
|
||
|
values array must be empty. This array is
|
||
|
replaced during a strategic merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value}
|
||
|
pairs. A single {key,value} in the matchLabels
|
||
|
map is equivalent to an element of matchExpressions,
|
||
|
whose key field is "key", the operator is "In",
|
||
|
and the values array contains only "value". The
|
||
|
requirements are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
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.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label
|
||
|
selector requirements. The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a
|
||
|
selector that contains values, a key, and an
|
||
|
operator that relates the key and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the
|
||
|
selector applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship
|
||
|
to a set of values. Valid operators are
|
||
|
In, NotIn, Exists and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string
|
||
|
values. If the operator is In or NotIn,
|
||
|
the values array must be non-empty. If the
|
||
|
operator is Exists or DoesNotExist, the
|
||
|
values array must be empty. This array is
|
||
|
replaced during a strategic merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value}
|
||
|
pairs. A single {key,value} in the matchLabels
|
||
|
map is equivalent to an element of matchExpressions,
|
||
|
whose key field is "key", the operator is "In",
|
||
|
and the values array contains only "value". The
|
||
|
requirements are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
namespaces:
|
||
|
description:
|
||
|
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".
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
topologyKey:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- topologyKey
|
||
|
type: object
|
||
|
type: array
|
||
|
type: object
|
||
|
type: object
|
||
|
alerting:
|
||
|
description: Defines the settings related to Alertmanager.
|
||
|
properties:
|
||
|
alertmanagers:
|
||
|
description:
|
||
|
AlertmanagerEndpoints Prometheus should fire alerts
|
||
|
against.
|
||
|
items:
|
||
|
description:
|
||
|
AlertmanagerEndpoints defines a selection of a
|
||
|
single Endpoints object containing Alertmanager IPs to fire
|
||
|
alerts against.
|
||
|
properties:
|
||
|
apiVersion:
|
||
|
description:
|
||
|
Version of the Alertmanager API that Prometheus
|
||
|
uses to send alerts. It can be "v1" or "v2".
|
||
|
type: string
|
||
|
authorization:
|
||
|
description:
|
||
|
"Authorization section for Alertmanager. \n
|
||
|
Cannot be set at the same time as `basicAuth`, `bearerTokenFile`
|
||
|
or `sigv4`."
|
||
|
properties:
|
||
|
credentials:
|
||
|
description:
|
||
|
Selects a key of a Secret in the namespace
|
||
|
that contains the credentials for authentication.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type:
|
||
|
description:
|
||
|
"Defines the authentication type. The value
|
||
|
is case-insensitive. \n \"Basic\" is not a supported
|
||
|
value. \n Default: \"Bearer\""
|
||
|
type: string
|
||
|
type: object
|
||
|
basicAuth:
|
||
|
description:
|
||
|
"BasicAuth configuration for Alertmanager.
|
||
|
\n Cannot be set at the same time as `bearerTokenFile`,
|
||
|
`authorization` or `sigv4`."
|
||
|
properties:
|
||
|
password:
|
||
|
description:
|
||
|
"`password` specifies a key of a Secret
|
||
|
containing the password for authentication."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
username:
|
||
|
description:
|
||
|
"`username` specifies a key of a Secret
|
||
|
containing the username for authentication."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
bearerTokenFile:
|
||
|
description:
|
||
|
"File to read bearer token for Alertmanager.
|
||
|
\n Cannot be set at the same time as `basicAuth`, `authorization`,
|
||
|
or `sigv4`. \n *Deprecated: this will be removed in a
|
||
|
future release. Prefer using `authorization`.*"
|
||
|
type: string
|
||
|
enableHttp2:
|
||
|
description: Whether to enable HTTP2.
|
||
|
type: boolean
|
||
|
name:
|
||
|
description: Name of the Endpoints object in the namespace.
|
||
|
type: string
|
||
|
namespace:
|
||
|
description: Namespace of the Endpoints object.
|
||
|
type: string
|
||
|
pathPrefix:
|
||
|
description:
|
||
|
Prefix for the HTTP path alerts are pushed
|
||
|
to.
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description: Port on which the Alertmanager API is exposed.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
scheme:
|
||
|
description: Scheme to use when firing alerts.
|
||
|
type: string
|
||
|
sigv4:
|
||
|
description:
|
||
|
"Sigv4 allows to configures AWS's Signature
|
||
|
Verification 4 for the URL. \n It requires Prometheus
|
||
|
>= v2.48.0. \n Cannot be set at the same time as `basicAuth`,
|
||
|
`bearerTokenFile` or `authorization`."
|
||
|
properties:
|
||
|
accessKey:
|
||
|
description:
|
||
|
AccessKey is the AWS API key. If not specified,
|
||
|
the environment variable `AWS_ACCESS_KEY_ID` is used.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
profile:
|
||
|
description:
|
||
|
Profile is the named AWS profile used to
|
||
|
authenticate.
|
||
|
type: string
|
||
|
region:
|
||
|
description:
|
||
|
Region is the AWS region. If blank, the
|
||
|
region from the default credentials chain used.
|
||
|
type: string
|
||
|
roleArn:
|
||
|
description:
|
||
|
RoleArn is the named AWS profile used to
|
||
|
authenticate.
|
||
|
type: string
|
||
|
secretKey:
|
||
|
description:
|
||
|
SecretKey is the AWS API secret. If not
|
||
|
specified, the environment variable `AWS_SECRET_ACCESS_KEY`
|
||
|
is used.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
timeout:
|
||
|
description:
|
||
|
Timeout is a per-target Alertmanager timeout
|
||
|
when pushing alerts.
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
tlsConfig:
|
||
|
description: TLS Config to use for Alertmanager.
|
||
|
properties:
|
||
|
ca:
|
||
|
description:
|
||
|
Certificate authority used when verifying
|
||
|
server certificates.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for
|
||
|
the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info:
|
||
|
https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion,
|
||
|
kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or
|
||
|
its key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description:
|
||
|
Secret containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select
|
||
|
from. Must be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info:
|
||
|
https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion,
|
||
|
kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
caFile:
|
||
|
description:
|
||
|
Path to the CA cert in the Prometheus container
|
||
|
to use for the targets.
|
||
|
type: string
|
||
|
cert:
|
||
|
description:
|
||
|
Client certificate to present when doing
|
||
|
client-authentication.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for
|
||
|
the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info:
|
||
|
https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion,
|
||
|
kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or
|
||
|
its key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description:
|
||
|
Secret containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select
|
||
|
from. Must be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info:
|
||
|
https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion,
|
||
|
kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
certFile:
|
||
|
description:
|
||
|
Path to the client cert file in the Prometheus
|
||
|
container for the targets.
|
||
|
type: string
|
||
|
insecureSkipVerify:
|
||
|
description: Disable target certificate validation.
|
||
|
type: boolean
|
||
|
keyFile:
|
||
|
description:
|
||
|
Path to the client key file in the Prometheus
|
||
|
container for the targets.
|
||
|
type: string
|
||
|
keySecret:
|
||
|
description:
|
||
|
Secret containing the client key file for
|
||
|
the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
serverName:
|
||
|
description: Used to verify the hostname for the targets.
|
||
|
type: string
|
||
|
type: object
|
||
|
required:
|
||
|
- name
|
||
|
- namespace
|
||
|
- port
|
||
|
type: object
|
||
|
type: array
|
||
|
required:
|
||
|
- alertmanagers
|
||
|
type: object
|
||
|
allowOverlappingBlocks:
|
||
|
description:
|
||
|
"AllowOverlappingBlocks enables vertical compaction and
|
||
|
vertical query merge in Prometheus. \n *Deprecated: this flag has
|
||
|
no effect for Prometheus >= 2.39.0 where overlapping blocks are
|
||
|
enabled by default.*"
|
||
|
type: boolean
|
||
|
apiserverConfig:
|
||
|
description:
|
||
|
"APIServerConfig allows specifying a host and auth methods
|
||
|
to access the Kuberntees API server. If null, Prometheus is assumed
|
||
|
to run inside of the cluster: it will discover the API servers automatically
|
||
|
and use the Pod's CA certificate and bearer token file at /var/run/secrets/kubernetes.io/serviceaccount/."
|
||
|
properties:
|
||
|
authorization:
|
||
|
description:
|
||
|
"Authorization section for the API server. \n Cannot
|
||
|
be set at the same time as `basicAuth`, `bearerToken`, or `bearerTokenFile`."
|
||
|
properties:
|
||
|
credentials:
|
||
|
description:
|
||
|
Selects a key of a Secret in the namespace that
|
||
|
contains the credentials for authentication.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
credentialsFile:
|
||
|
description:
|
||
|
File to read a secret from, mutually exclusive
|
||
|
with `credentials`.
|
||
|
type: string
|
||
|
type:
|
||
|
description:
|
||
|
"Defines the authentication type. The value is
|
||
|
case-insensitive. \n \"Basic\" is not a supported value.
|
||
|
\n Default: \"Bearer\""
|
||
|
type: string
|
||
|
type: object
|
||
|
basicAuth:
|
||
|
description:
|
||
|
"BasicAuth configuration for the API server. \n Cannot
|
||
|
be set at the same time as `authorization`, `bearerToken`, or
|
||
|
`bearerTokenFile`."
|
||
|
properties:
|
||
|
password:
|
||
|
description:
|
||
|
"`password` specifies a key of a Secret containing
|
||
|
the password for authentication."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
username:
|
||
|
description:
|
||
|
"`username` specifies a key of a Secret containing
|
||
|
the username for authentication."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
bearerToken:
|
||
|
description:
|
||
|
"*Warning: this field shouldn't be used because the
|
||
|
token value appears in clear-text. Prefer using `authorization`.*
|
||
|
\n *Deprecated: this will be removed in a future release.*"
|
||
|
type: string
|
||
|
bearerTokenFile:
|
||
|
description:
|
||
|
"File to read bearer token for accessing apiserver.
|
||
|
\n Cannot be set at the same time as `basicAuth`, `authorization`,
|
||
|
or `bearerToken`. \n *Deprecated: this will be removed in a
|
||
|
future release. Prefer using `authorization`.*"
|
||
|
type: string
|
||
|
host:
|
||
|
description:
|
||
|
Kubernetes API address consisting of a hostname or
|
||
|
IP address followed by an optional port number.
|
||
|
type: string
|
||
|
tlsConfig:
|
||
|
description: TLS Config to use for the API server.
|
||
|
properties:
|
||
|
ca:
|
||
|
description:
|
||
|
Certificate authority used when verifying server
|
||
|
certificates.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
caFile:
|
||
|
description:
|
||
|
Path to the CA cert in the Prometheus container
|
||
|
to use for the targets.
|
||
|
type: string
|
||
|
cert:
|
||
|
description: Client certificate to present when doing client-authentication.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
certFile:
|
||
|
description:
|
||
|
Path to the client cert file in the Prometheus
|
||
|
container for the targets.
|
||
|
type: string
|
||
|
insecureSkipVerify:
|
||
|
description: Disable target certificate validation.
|
||
|
type: boolean
|
||
|
keyFile:
|
||
|
description:
|
||
|
Path to the client key file in the Prometheus
|
||
|
container for the targets.
|
||
|
type: string
|
||
|
keySecret:
|
||
|
description:
|
||
|
Secret containing the client key file for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
serverName:
|
||
|
description: Used to verify the hostname for the targets.
|
||
|
type: string
|
||
|
type: object
|
||
|
required:
|
||
|
- host
|
||
|
type: object
|
||
|
arbitraryFSAccessThroughSMs:
|
||
|
description:
|
||
|
When true, ServiceMonitor, PodMonitor and Probe object
|
||
|
are forbidden to reference arbitrary files on the file system of
|
||
|
the 'prometheus' container. When a ServiceMonitor's endpoint specifies
|
||
|
a `bearerTokenFile` value (e.g. '/var/run/secrets/kubernetes.io/serviceaccount/token'),
|
||
|
a malicious target can get access to the Prometheus service account's
|
||
|
token in the Prometheus' scrape request. Setting `spec.arbitraryFSAccessThroughSM`
|
||
|
to 'true' would prevent the attack. Users should instead provide
|
||
|
the credentials using the `spec.bearerTokenSecret` field.
|
||
|
properties:
|
||
|
deny:
|
||
|
type: boolean
|
||
|
type: object
|
||
|
baseImage:
|
||
|
description: "*Deprecated: use 'spec.image' instead.*"
|
||
|
type: string
|
||
|
bodySizeLimit:
|
||
|
description:
|
||
|
BodySizeLimit defines per-scrape on response body size.
|
||
|
Only valid in Prometheus versions 2.45.0 and newer.
|
||
|
pattern: (^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$
|
||
|
type: string
|
||
|
configMaps:
|
||
|
description:
|
||
|
ConfigMaps is a list of ConfigMaps in the same namespace
|
||
|
as the Prometheus object, which shall be mounted into the Prometheus
|
||
|
Pods. Each ConfigMap is added to the StatefulSet definition as a
|
||
|
volume named `configmap-<configmap-name>`. The ConfigMaps are mounted
|
||
|
into /etc/prometheus/configmaps/<configmap-name> in the 'prometheus'
|
||
|
container.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
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. \n The names
|
||
|
of containers managed by the operator are: * `prometheus` * `config-reloader`
|
||
|
* `thanos-sidecar` \n Overriding containers is entirely outside
|
||
|
the scope of what the maintainers will support and by doing so,
|
||
|
you accept that this behaviour may break at any time without notice."
|
||
|
items:
|
||
|
description:
|
||
|
A single application container that you want to run
|
||
|
within a pod.
|
||
|
properties:
|
||
|
args:
|
||
|
description:
|
||
|
'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'
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
command:
|
||
|
description:
|
||
|
'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'
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
env:
|
||
|
description:
|
||
|
List of environment variables to set in the container.
|
||
|
Cannot be updated.
|
||
|
items:
|
||
|
description:
|
||
|
EnvVar represents an environment variable present
|
||
|
in a Container.
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
Name of the environment variable. Must be
|
||
|
a C_IDENTIFIER.
|
||
|
type: string
|
||
|
value:
|
||
|
description:
|
||
|
'Variable references $(VAR_NAME) are expanded
|
||
|
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 "".'
|
||
|
type: string
|
||
|
valueFrom:
|
||
|
description:
|
||
|
Source for the environment variable's value.
|
||
|
Cannot be used if value is not empty.
|
||
|
properties:
|
||
|
configMapKeyRef:
|
||
|
description: Selects a key of a ConfigMap.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info:
|
||
|
https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or
|
||
|
its key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
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."
|
||
|
properties:
|
||
|
apiVersion:
|
||
|
description:
|
||
|
Version of the schema the FieldPath
|
||
|
is written in terms of, defaults to "v1".
|
||
|
type: string
|
||
|
fieldPath:
|
||
|
description:
|
||
|
Path of the field to select in the
|
||
|
specified API version.
|
||
|
type: string
|
||
|
required:
|
||
|
- fieldPath
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
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."
|
||
|
properties:
|
||
|
containerName:
|
||
|
description:
|
||
|
"Container name: required for volumes,
|
||
|
optional for env vars"
|
||
|
type: string
|
||
|
divisor:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
Specifies the output format of the
|
||
|
exposed resources, defaults to "1"
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
resource:
|
||
|
description: "Required: resource to select"
|
||
|
type: string
|
||
|
required:
|
||
|
- resource
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secretKeyRef:
|
||
|
description:
|
||
|
Selects a key of a secret in the pod's
|
||
|
namespace
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info:
|
||
|
https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
envFrom:
|
||
|
description:
|
||
|
List of sources to populate environment variables
|
||
|
in the container. The keys defined within a source must be
|
||
|
a C_IDENTIFIER. All invalid keys will be reported as an event
|
||
|
when the container is starting. When a key exists in multiple
|
||
|
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.
|
||
|
items:
|
||
|
description:
|
||
|
EnvFromSource represents the source of a set
|
||
|
of ConfigMaps
|
||
|
properties:
|
||
|
configMapRef:
|
||
|
description: The ConfigMap to select from
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap must be
|
||
|
defined
|
||
|
type: boolean
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
prefix:
|
||
|
description:
|
||
|
An optional identifier to prepend to each
|
||
|
key in the ConfigMap. Must be a C_IDENTIFIER.
|
||
|
type: string
|
||
|
secretRef:
|
||
|
description: The Secret to select from
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description: Specify whether the Secret must be defined
|
||
|
type: boolean
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
type: array
|
||
|
image:
|
||
|
description:
|
||
|
"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."
|
||
|
type: string
|
||
|
imagePullPolicy:
|
||
|
description:
|
||
|
"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"
|
||
|
type: string
|
||
|
lifecycle:
|
||
|
description:
|
||
|
Actions that the management system should take
|
||
|
in response to container lifecycle events. Cannot be updated.
|
||
|
properties:
|
||
|
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"
|
||
|
properties:
|
||
|
exec:
|
||
|
description: Exec specifies the action to take.
|
||
|
properties:
|
||
|
command:
|
||
|
description:
|
||
|
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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
type: object
|
||
|
httpGet:
|
||
|
description: HTTPGet specifies the http request to perform.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
Host name to connect to, defaults to
|
||
|
the pod IP. You probably want to set "Host" in
|
||
|
httpHeaders instead.
|
||
|
type: string
|
||
|
httpHeaders:
|
||
|
description:
|
||
|
Custom headers to set in the request.
|
||
|
HTTP allows repeated headers.
|
||
|
items:
|
||
|
description:
|
||
|
HTTPHeader describes a custom header
|
||
|
to be used in HTTP probes
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
The header field name. This will
|
||
|
be canonicalized upon output, so case-variant
|
||
|
names will be understood as the same header.
|
||
|
type: string
|
||
|
value:
|
||
|
description: The header field value
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
- value
|
||
|
type: object
|
||
|
type: array
|
||
|
path:
|
||
|
description: Path to access on the HTTP server.
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
scheme:
|
||
|
description:
|
||
|
Scheme to use for connecting to the
|
||
|
host. Defaults to HTTP.
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
tcpSocket:
|
||
|
description:
|
||
|
Deprecated. TCPSocket is NOT supported
|
||
|
as a LifecycleHandler and kept for the backward compatibility.
|
||
|
There are no validation of this field and lifecycle
|
||
|
hooks will fail in runtime when tcp handler is specified.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
"Optional: Host name to connect to,
|
||
|
defaults to the pod IP."
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
type: object
|
||
|
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"
|
||
|
properties:
|
||
|
exec:
|
||
|
description: Exec specifies the action to take.
|
||
|
properties:
|
||
|
command:
|
||
|
description:
|
||
|
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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
type: object
|
||
|
httpGet:
|
||
|
description: HTTPGet specifies the http request to perform.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
Host name to connect to, defaults to
|
||
|
the pod IP. You probably want to set "Host" in
|
||
|
httpHeaders instead.
|
||
|
type: string
|
||
|
httpHeaders:
|
||
|
description:
|
||
|
Custom headers to set in the request.
|
||
|
HTTP allows repeated headers.
|
||
|
items:
|
||
|
description:
|
||
|
HTTPHeader describes a custom header
|
||
|
to be used in HTTP probes
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
The header field name. This will
|
||
|
be canonicalized upon output, so case-variant
|
||
|
names will be understood as the same header.
|
||
|
type: string
|
||
|
value:
|
||
|
description: The header field value
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
- value
|
||
|
type: object
|
||
|
type: array
|
||
|
path:
|
||
|
description: Path to access on the HTTP server.
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
scheme:
|
||
|
description:
|
||
|
Scheme to use for connecting to the
|
||
|
host. Defaults to HTTP.
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
tcpSocket:
|
||
|
description:
|
||
|
Deprecated. TCPSocket is NOT supported
|
||
|
as a LifecycleHandler and kept for the backward compatibility.
|
||
|
There are no validation of this field and lifecycle
|
||
|
hooks will fail in runtime when tcp handler is specified.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
"Optional: Host name to connect to,
|
||
|
defaults to the pod IP."
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
type: object
|
||
|
type: object
|
||
|
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"
|
||
|
properties:
|
||
|
exec:
|
||
|
description: Exec specifies the action to take.
|
||
|
properties:
|
||
|
command:
|
||
|
description:
|
||
|
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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
type: object
|
||
|
failureThreshold:
|
||
|
description:
|
||
|
Minimum consecutive failures for the probe
|
||
|
to be considered failed after having succeeded. Defaults
|
||
|
to 3. Minimum value is 1.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
grpc:
|
||
|
description: GRPC specifies an action involving a GRPC port.
|
||
|
properties:
|
||
|
port:
|
||
|
description:
|
||
|
Port number of the gRPC service. Number
|
||
|
must be in the range 1 to 65535.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
service:
|
||
|
description:
|
||
|
"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).
|
||
|
\n If this is not specified, the default behavior
|
||
|
is defined by gRPC."
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
httpGet:
|
||
|
description: HTTPGet specifies the http request to perform.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
Host name to connect to, defaults to the
|
||
|
pod IP. You probably want to set "Host" in httpHeaders
|
||
|
instead.
|
||
|
type: string
|
||
|
httpHeaders:
|
||
|
description:
|
||
|
Custom headers to set in the request. HTTP
|
||
|
allows repeated headers.
|
||
|
items:
|
||
|
description:
|
||
|
HTTPHeader describes a custom header
|
||
|
to be used in HTTP probes
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
The header field name. This will
|
||
|
be canonicalized upon output, so case-variant
|
||
|
names will be understood as the same header.
|
||
|
type: string
|
||
|
value:
|
||
|
description: The header field value
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
- value
|
||
|
type: object
|
||
|
type: array
|
||
|
path:
|
||
|
description: Path to access on the HTTP server.
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
scheme:
|
||
|
description:
|
||
|
Scheme to use for connecting to the host.
|
||
|
Defaults to HTTP.
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
initialDelaySeconds:
|
||
|
description:
|
||
|
"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"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
periodSeconds:
|
||
|
description:
|
||
|
How often (in seconds) to perform the probe.
|
||
|
Default to 10 seconds. Minimum value is 1.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
successThreshold:
|
||
|
description:
|
||
|
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.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
tcpSocket:
|
||
|
description:
|
||
|
TCPSocket specifies an action involving a TCP
|
||
|
port.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
"Optional: Host name to connect to, defaults
|
||
|
to the pod IP."
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
terminationGracePeriodSeconds:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
timeoutSeconds:
|
||
|
description:
|
||
|
"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"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
type: object
|
||
|
name:
|
||
|
description:
|
||
|
Name of the container specified as a DNS_LABEL.
|
||
|
Each container in a pod must have a unique name (DNS_LABEL).
|
||
|
Cannot be updated.
|
||
|
type: string
|
||
|
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.
|
||
|
items:
|
||
|
description:
|
||
|
ContainerPort represents a network port in a
|
||
|
single container.
|
||
|
properties:
|
||
|
containerPort:
|
||
|
description:
|
||
|
Number of port to expose on the pod's IP
|
||
|
address. This must be a valid port number, 0 < x < 65536.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
hostIP:
|
||
|
description: What host IP to bind the external port to.
|
||
|
type: string
|
||
|
hostPort:
|
||
|
description:
|
||
|
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.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
name:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
protocol:
|
||
|
default: TCP
|
||
|
description:
|
||
|
Protocol for port. Must be UDP, TCP, or SCTP.
|
||
|
Defaults to "TCP".
|
||
|
type: string
|
||
|
required:
|
||
|
- containerPort
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-map-keys:
|
||
|
- containerPort
|
||
|
- protocol
|
||
|
x-kubernetes-list-type: map
|
||
|
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"
|
||
|
properties:
|
||
|
exec:
|
||
|
description: Exec specifies the action to take.
|
||
|
properties:
|
||
|
command:
|
||
|
description:
|
||
|
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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
type: object
|
||
|
failureThreshold:
|
||
|
description:
|
||
|
Minimum consecutive failures for the probe
|
||
|
to be considered failed after having succeeded. Defaults
|
||
|
to 3. Minimum value is 1.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
grpc:
|
||
|
description: GRPC specifies an action involving a GRPC port.
|
||
|
properties:
|
||
|
port:
|
||
|
description:
|
||
|
Port number of the gRPC service. Number
|
||
|
must be in the range 1 to 65535.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
service:
|
||
|
description:
|
||
|
"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).
|
||
|
\n If this is not specified, the default behavior
|
||
|
is defined by gRPC."
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
httpGet:
|
||
|
description: HTTPGet specifies the http request to perform.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
Host name to connect to, defaults to the
|
||
|
pod IP. You probably want to set "Host" in httpHeaders
|
||
|
instead.
|
||
|
type: string
|
||
|
httpHeaders:
|
||
|
description:
|
||
|
Custom headers to set in the request. HTTP
|
||
|
allows repeated headers.
|
||
|
items:
|
||
|
description:
|
||
|
HTTPHeader describes a custom header
|
||
|
to be used in HTTP probes
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
The header field name. This will
|
||
|
be canonicalized upon output, so case-variant
|
||
|
names will be understood as the same header.
|
||
|
type: string
|
||
|
value:
|
||
|
description: The header field value
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
- value
|
||
|
type: object
|
||
|
type: array
|
||
|
path:
|
||
|
description: Path to access on the HTTP server.
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
scheme:
|
||
|
description:
|
||
|
Scheme to use for connecting to the host.
|
||
|
Defaults to HTTP.
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
initialDelaySeconds:
|
||
|
description:
|
||
|
"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"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
periodSeconds:
|
||
|
description:
|
||
|
How often (in seconds) to perform the probe.
|
||
|
Default to 10 seconds. Minimum value is 1.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
successThreshold:
|
||
|
description:
|
||
|
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.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
tcpSocket:
|
||
|
description:
|
||
|
TCPSocket specifies an action involving a TCP
|
||
|
port.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
"Optional: Host name to connect to, defaults
|
||
|
to the pod IP."
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
terminationGracePeriodSeconds:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
timeoutSeconds:
|
||
|
description:
|
||
|
"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"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
type: object
|
||
|
resizePolicy:
|
||
|
description: Resources resize policy for the container.
|
||
|
items:
|
||
|
description:
|
||
|
ContainerResizePolicy represents resource resize
|
||
|
policy for the container.
|
||
|
properties:
|
||
|
resourceName:
|
||
|
description:
|
||
|
"Name of the resource to which this resource
|
||
|
resize policy applies. Supported values: cpu, memory."
|
||
|
type: string
|
||
|
restartPolicy:
|
||
|
description:
|
||
|
Restart policy to apply when specified resource
|
||
|
is resized. If not specified, it defaults to NotRequired.
|
||
|
type: string
|
||
|
required:
|
||
|
- resourceName
|
||
|
- restartPolicy
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-type: atomic
|
||
|
resources:
|
||
|
description:
|
||
|
"Compute Resources required by this container.
|
||
|
Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
|
||
|
properties:
|
||
|
claims:
|
||
|
description:
|
||
|
"Claims lists the names of resources, defined
|
||
|
in spec.resourceClaims, that are used by this container.
|
||
|
\n This is an alpha field and requires enabling the DynamicResourceAllocation
|
||
|
feature gate. \n This field is immutable. It can only
|
||
|
be set for containers."
|
||
|
items:
|
||
|
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-map-keys:
|
||
|
- name
|
||
|
x-kubernetes-list-type: map
|
||
|
limits:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"Limits describes the maximum amount of compute
|
||
|
resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
|
||
|
type: object
|
||
|
requests:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"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/"
|
||
|
type: object
|
||
|
type: object
|
||
|
restartPolicy:
|
||
|
description:
|
||
|
'RestartPolicy defines the restart behavior of
|
||
|
individual containers in a pod. This field may only be set
|
||
|
for init containers, and the only allowed value is "Always".
|
||
|
For non-init containers or when this field is not specified,
|
||
|
the restart behavior is defined by the Pod''s restart policy
|
||
|
and the container type. Setting the RestartPolicy as "Always"
|
||
|
for the init container will have the following effect: 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.'
|
||
|
type: string
|
||
|
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/"
|
||
|
properties:
|
||
|
allowPrivilegeEscalation:
|
||
|
description:
|
||
|
"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."
|
||
|
type: boolean
|
||
|
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.
|
||
|
properties:
|
||
|
add:
|
||
|
description: Added capabilities
|
||
|
items:
|
||
|
description:
|
||
|
Capability represent POSIX capabilities
|
||
|
type
|
||
|
type: string
|
||
|
type: array
|
||
|
drop:
|
||
|
description: Removed capabilities
|
||
|
items:
|
||
|
description:
|
||
|
Capability represent POSIX capabilities
|
||
|
type
|
||
|
type: string
|
||
|
type: array
|
||
|
type: object
|
||
|
privileged:
|
||
|
description:
|
||
|
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.
|
||
|
type: boolean
|
||
|
procMount:
|
||
|
description:
|
||
|
procMount denotes the type of proc mount to
|
||
|
use for the containers. The default is DefaultProcMount
|
||
|
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.
|
||
|
type: string
|
||
|
readOnlyRootFilesystem:
|
||
|
description:
|
||
|
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.
|
||
|
type: boolean
|
||
|
runAsGroup:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
runAsNonRoot:
|
||
|
description:
|
||
|
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.
|
||
|
type: boolean
|
||
|
runAsUser:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
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.
|
||
|
properties:
|
||
|
level:
|
||
|
description:
|
||
|
Level is SELinux level label that applies
|
||
|
to the container.
|
||
|
type: string
|
||
|
role:
|
||
|
description:
|
||
|
Role is a SELinux role label that applies
|
||
|
to the container.
|
||
|
type: string
|
||
|
type:
|
||
|
description:
|
||
|
Type is a SELinux type label that applies
|
||
|
to the container.
|
||
|
type: string
|
||
|
user:
|
||
|
description:
|
||
|
User is a SELinux user label that applies
|
||
|
to the container.
|
||
|
type: string
|
||
|
type: object
|
||
|
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.
|
||
|
properties:
|
||
|
localhostProfile:
|
||
|
description:
|
||
|
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:
|
||
|
description:
|
||
|
"type indicates which kind of seccomp profile
|
||
|
will be applied. Valid options are: \n 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."
|
||
|
type: string
|
||
|
required:
|
||
|
- type
|
||
|
type: object
|
||
|
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.
|
||
|
properties:
|
||
|
gmsaCredentialSpec:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
gmsaCredentialSpecName:
|
||
|
description:
|
||
|
GMSACredentialSpecName is the name of the
|
||
|
GMSA credential spec to use.
|
||
|
type: string
|
||
|
hostProcess:
|
||
|
description:
|
||
|
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.
|
||
|
type: boolean
|
||
|
runAsUserName:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
type: object
|
||
|
type: object
|
||
|
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"
|
||
|
properties:
|
||
|
exec:
|
||
|
description: Exec specifies the action to take.
|
||
|
properties:
|
||
|
command:
|
||
|
description:
|
||
|
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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
type: object
|
||
|
failureThreshold:
|
||
|
description:
|
||
|
Minimum consecutive failures for the probe
|
||
|
to be considered failed after having succeeded. Defaults
|
||
|
to 3. Minimum value is 1.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
grpc:
|
||
|
description: GRPC specifies an action involving a GRPC port.
|
||
|
properties:
|
||
|
port:
|
||
|
description:
|
||
|
Port number of the gRPC service. Number
|
||
|
must be in the range 1 to 65535.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
service:
|
||
|
description:
|
||
|
"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).
|
||
|
\n If this is not specified, the default behavior
|
||
|
is defined by gRPC."
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
httpGet:
|
||
|
description: HTTPGet specifies the http request to perform.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
Host name to connect to, defaults to the
|
||
|
pod IP. You probably want to set "Host" in httpHeaders
|
||
|
instead.
|
||
|
type: string
|
||
|
httpHeaders:
|
||
|
description:
|
||
|
Custom headers to set in the request. HTTP
|
||
|
allows repeated headers.
|
||
|
items:
|
||
|
description:
|
||
|
HTTPHeader describes a custom header
|
||
|
to be used in HTTP probes
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
The header field name. This will
|
||
|
be canonicalized upon output, so case-variant
|
||
|
names will be understood as the same header.
|
||
|
type: string
|
||
|
value:
|
||
|
description: The header field value
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
- value
|
||
|
type: object
|
||
|
type: array
|
||
|
path:
|
||
|
description: Path to access on the HTTP server.
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
scheme:
|
||
|
description:
|
||
|
Scheme to use for connecting to the host.
|
||
|
Defaults to HTTP.
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
initialDelaySeconds:
|
||
|
description:
|
||
|
"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"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
periodSeconds:
|
||
|
description:
|
||
|
How often (in seconds) to perform the probe.
|
||
|
Default to 10 seconds. Minimum value is 1.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
successThreshold:
|
||
|
description:
|
||
|
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.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
tcpSocket:
|
||
|
description:
|
||
|
TCPSocket specifies an action involving a TCP
|
||
|
port.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
"Optional: Host name to connect to, defaults
|
||
|
to the pod IP."
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
terminationGracePeriodSeconds:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
timeoutSeconds:
|
||
|
description:
|
||
|
"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"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
type: object
|
||
|
stdin:
|
||
|
description:
|
||
|
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.
|
||
|
type: boolean
|
||
|
stdinOnce:
|
||
|
description:
|
||
|
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
|
||
|
type: boolean
|
||
|
terminationMessagePath:
|
||
|
description:
|
||
|
"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."
|
||
|
type: string
|
||
|
terminationMessagePolicy:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
tty:
|
||
|
description:
|
||
|
Whether this container should allocate a TTY for
|
||
|
itself, also requires 'stdin' to be true. Default is false.
|
||
|
type: boolean
|
||
|
volumeDevices:
|
||
|
description:
|
||
|
volumeDevices is the list of block devices to be
|
||
|
used by the container.
|
||
|
items:
|
||
|
description:
|
||
|
volumeDevice describes a mapping of a raw block
|
||
|
device within a container.
|
||
|
properties:
|
||
|
devicePath:
|
||
|
description:
|
||
|
devicePath is the path inside of the container
|
||
|
that the device will be mapped to.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
name must match the name of a persistentVolumeClaim
|
||
|
in the pod
|
||
|
type: string
|
||
|
required:
|
||
|
- devicePath
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
volumeMounts:
|
||
|
description:
|
||
|
Pod volumes to mount into the container's filesystem.
|
||
|
Cannot be updated.
|
||
|
items:
|
||
|
description:
|
||
|
VolumeMount describes a mounting of a Volume
|
||
|
within a container.
|
||
|
properties:
|
||
|
mountPath:
|
||
|
description:
|
||
|
Path within the container at which the volume
|
||
|
should be mounted. Must not contain ':'.
|
||
|
type: string
|
||
|
mountPropagation:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
name:
|
||
|
description: This must match the Name of a Volume.
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
Mounted read-only if true, read-write otherwise
|
||
|
(false or unspecified). Defaults to false.
|
||
|
type: boolean
|
||
|
subPath:
|
||
|
description:
|
||
|
Path within the volume from which the container's
|
||
|
volume should be mounted. Defaults to "" (volume's root).
|
||
|
type: string
|
||
|
subPathExpr:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- mountPath
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
workingDir:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
disableCompaction:
|
||
|
description: When true, the Prometheus compaction is disabled.
|
||
|
type: boolean
|
||
|
enableAdminAPI:
|
||
|
description:
|
||
|
"Enables access to the Prometheus web admin API. \n WARNING:
|
||
|
Enabling the admin APIs enables mutating endpoints, to delete data,
|
||
|
shutdown Prometheus, and more. Enabling this should be done with
|
||
|
care and the user is advised to add additional authentication authorization
|
||
|
via a proxy to ensure only clients authorized to perform these actions
|
||
|
can do so. \n For more information: https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-admin-apis"
|
||
|
type: boolean
|
||
|
enableFeatures:
|
||
|
description:
|
||
|
"Enable access to Prometheus feature flags. By default,
|
||
|
no features are enabled. \n 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. \n For more information see https://prometheus.io/docs/prometheus/latest/feature_flags/"
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
enableRemoteWriteReceiver:
|
||
|
description:
|
||
|
"Enable Prometheus to be used as a receiver for the Prometheus
|
||
|
remote write protocol. \n WARNING: This is not considered an efficient
|
||
|
way of ingesting samples. Use it with caution for specific low-volume
|
||
|
use cases. It is not suitable for replacing the ingestion via scraping
|
||
|
and turning Prometheus into a push-based metrics collection system.
|
||
|
For more information see https://prometheus.io/docs/prometheus/latest/querying/api/#remote-write-receiver
|
||
|
\n It requires Prometheus >= v2.33.0."
|
||
|
type: boolean
|
||
|
enforcedBodySizeLimit:
|
||
|
description:
|
||
|
"When defined, enforcedBodySizeLimit specifies a global
|
||
|
limit on the size of uncompressed response body that will be accepted
|
||
|
by Prometheus. Targets responding with a body larger than this many
|
||
|
bytes will cause the scrape to fail. \n It requires Prometheus >=
|
||
|
v2.28.0."
|
||
|
pattern: (^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$
|
||
|
type: string
|
||
|
enforcedKeepDroppedTargets:
|
||
|
description:
|
||
|
"When defined, enforcedKeepDroppedTargets specifies a
|
||
|
global limit on the number of targets dropped by relabeling that
|
||
|
will be kept in memory. The value overrides any `spec.keepDroppedTargets`
|
||
|
set by ServiceMonitor, PodMonitor, Probe objects unless `spec.keepDroppedTargets`
|
||
|
is greater than zero and less than `spec.enforcedKeepDroppedTargets`.
|
||
|
\n It requires Prometheus >= v2.47.0."
|
||
|
format: int64
|
||
|
type: integer
|
||
|
enforcedLabelLimit:
|
||
|
description:
|
||
|
"When defined, enforcedLabelLimit specifies a global
|
||
|
limit on the number of labels per sample. The value overrides any
|
||
|
`spec.labelLimit` set by ServiceMonitor, PodMonitor, Probe objects
|
||
|
unless `spec.labelLimit` is greater than zero and less than `spec.enforcedLabelLimit`.
|
||
|
\n It requires Prometheus >= v2.27.0."
|
||
|
format: int64
|
||
|
type: integer
|
||
|
enforcedLabelNameLengthLimit:
|
||
|
description:
|
||
|
"When defined, enforcedLabelNameLengthLimit specifies
|
||
|
a global limit on the length of labels name per sample. The value
|
||
|
overrides any `spec.labelNameLengthLimit` set by ServiceMonitor,
|
||
|
PodMonitor, Probe objects unless `spec.labelNameLengthLimit` is
|
||
|
greater than zero and less than `spec.enforcedLabelNameLengthLimit`.
|
||
|
\n It requires Prometheus >= v2.27.0."
|
||
|
format: int64
|
||
|
type: integer
|
||
|
enforcedLabelValueLengthLimit:
|
||
|
description:
|
||
|
"When not null, enforcedLabelValueLengthLimit defines
|
||
|
a global limit on the length of labels value per sample. The value
|
||
|
overrides any `spec.labelValueLengthLimit` set by ServiceMonitor,
|
||
|
PodMonitor, Probe objects unless `spec.labelValueLengthLimit` is
|
||
|
greater than zero and less than `spec.enforcedLabelValueLengthLimit`.
|
||
|
\n It requires Prometheus >= v2.27.0."
|
||
|
format: int64
|
||
|
type: integer
|
||
|
enforcedNamespaceLabel:
|
||
|
description:
|
||
|
"When not empty, a label will be added to \n 1. All metrics
|
||
|
scraped from `ServiceMonitor`, `PodMonitor`, `Probe` and `ScrapeConfig`
|
||
|
objects. 2. All metrics generated from recording rules defined in
|
||
|
`PrometheusRule` objects. 3. All alerts generated from alerting
|
||
|
rules defined in `PrometheusRule` objects. 4. All vector selectors
|
||
|
of PromQL expressions defined in `PrometheusRule` objects. \n The
|
||
|
label will not added for objects referenced in `spec.excludedFromEnforcement`.
|
||
|
\n The label's name is this field's value. The label's value is
|
||
|
the namespace of the `ServiceMonitor`, `PodMonitor`, `Probe` or
|
||
|
`PrometheusRule` object."
|
||
|
type: string
|
||
|
enforcedSampleLimit:
|
||
|
description:
|
||
|
"When defined, enforcedSampleLimit specifies a global
|
||
|
limit on the number of scraped samples that will be accepted. This
|
||
|
overrides any `spec.sampleLimit` set by ServiceMonitor, PodMonitor,
|
||
|
Probe objects unless `spec.sampleLimit` is greater than zero and
|
||
|
less than than `spec.enforcedSampleLimit`. \n It is meant to be
|
||
|
used by admins to keep the overall number of samples/series under
|
||
|
a desired limit."
|
||
|
format: int64
|
||
|
type: integer
|
||
|
enforcedTargetLimit:
|
||
|
description:
|
||
|
"When defined, enforcedTargetLimit specifies a global
|
||
|
limit on the number of scraped targets. The value overrides any
|
||
|
`spec.targetLimit` set by ServiceMonitor, PodMonitor, Probe objects
|
||
|
unless `spec.targetLimit` is greater than zero and less than `spec.enforcedTargetLimit`.
|
||
|
\n It is meant to be used by admins to to keep the overall number
|
||
|
of targets under a desired limit."
|
||
|
format: int64
|
||
|
type: integer
|
||
|
evaluationInterval:
|
||
|
default: 30s
|
||
|
description: 'Interval between rule evaluations. Default: "30s"'
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
excludedFromEnforcement:
|
||
|
description:
|
||
|
"List of references to PodMonitor, ServiceMonitor, Probe
|
||
|
and PrometheusRule objects to be excluded from enforcing a namespace
|
||
|
label of origin. \n It is only applicable if `spec.enforcedNamespaceLabel`
|
||
|
set to true."
|
||
|
items:
|
||
|
description:
|
||
|
ObjectReference references a PodMonitor, ServiceMonitor,
|
||
|
Probe or PrometheusRule object.
|
||
|
properties:
|
||
|
group:
|
||
|
default: monitoring.coreos.com
|
||
|
description:
|
||
|
Group of the referent. When not specified, it defaults
|
||
|
to `monitoring.coreos.com`
|
||
|
enum:
|
||
|
- monitoring.coreos.com
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
Name of the referent. When not set, all resources
|
||
|
in the namespace are matched.
|
||
|
type: string
|
||
|
namespace:
|
||
|
description: "Namespace of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/"
|
||
|
minLength: 1
|
||
|
type: string
|
||
|
resource:
|
||
|
description: Resource of the referent.
|
||
|
enum:
|
||
|
- prometheusrules
|
||
|
- servicemonitors
|
||
|
- podmonitors
|
||
|
- probes
|
||
|
- scrapeconfigs
|
||
|
type: string
|
||
|
required:
|
||
|
- namespace
|
||
|
- resource
|
||
|
type: object
|
||
|
type: array
|
||
|
exemplars:
|
||
|
description:
|
||
|
Exemplars related settings that are runtime reloadable.
|
||
|
It requires to enable the `exemplar-storage` feature flag to be
|
||
|
effective.
|
||
|
properties:
|
||
|
maxSize:
|
||
|
description:
|
||
|
"Maximum number of exemplars stored in memory for
|
||
|
all series. \n exemplar-storage itself must be enabled using
|
||
|
the `spec.enableFeature` option for exemplars to be scraped
|
||
|
in the first place. \n If not set, Prometheus uses its default
|
||
|
value. A value of zero or less than zero disables the storage."
|
||
|
format: int64
|
||
|
type: integer
|
||
|
type: object
|
||
|
externalLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
The labels to add to any time series or alerts when communicating
|
||
|
with external systems (federation, remote storage, Alertmanager).
|
||
|
Labels defined by `spec.replicaExternalLabelName` and `spec.prometheusExternalLabelName`
|
||
|
take precedence over this list.
|
||
|
type: object
|
||
|
externalUrl:
|
||
|
description:
|
||
|
The external URL under which the Prometheus service is
|
||
|
externally available. This is necessary to generate correct URLs
|
||
|
(for instance if Prometheus is accessible behind an Ingress resource).
|
||
|
type: string
|
||
|
hostAliases:
|
||
|
description:
|
||
|
Optional list of hosts and IPs that will be injected
|
||
|
into the Pod's hosts file if specified.
|
||
|
items:
|
||
|
description:
|
||
|
HostAlias holds the mapping between IP and hostnames
|
||
|
that will be injected as an entry in the pod's hosts file.
|
||
|
properties:
|
||
|
hostnames:
|
||
|
description: Hostnames for the above IP address.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
ip:
|
||
|
description: IP address of the host file entry.
|
||
|
type: string
|
||
|
required:
|
||
|
- hostnames
|
||
|
- ip
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-map-keys:
|
||
|
- ip
|
||
|
x-kubernetes-list-type: map
|
||
|
hostNetwork:
|
||
|
description:
|
||
|
"Use the host's network namespace if true. \n Make sure
|
||
|
to understand the security implications if you want to enable it
|
||
|
(https://kubernetes.io/docs/concepts/configuration/overview/). \n
|
||
|
When hostNetwork is enabled, this will set the DNS policy to `ClusterFirstWithHostNet`
|
||
|
automatically."
|
||
|
type: boolean
|
||
|
ignoreNamespaceSelectors:
|
||
|
description:
|
||
|
When true, `spec.namespaceSelector` from all PodMonitor,
|
||
|
ServiceMonitor and Probe objects will be ignored. They will only
|
||
|
discover targets within the namespace of the PodMonitor, ServiceMonitor
|
||
|
and Probe object.
|
||
|
type: boolean
|
||
|
image:
|
||
|
description:
|
||
|
"Container image name for Prometheus. If specified, it
|
||
|
takes precedence over the `spec.baseImage`, `spec.tag` and `spec.sha`
|
||
|
fields. \n Specifying `spec.version` is still necessary to ensure
|
||
|
the Prometheus Operator knows which version of Prometheus is being
|
||
|
configured. \n If neither `spec.image` nor `spec.baseImage` are
|
||
|
defined, the operator will use the latest upstream version of Prometheus
|
||
|
available at the time when the operator was released."
|
||
|
type: string
|
||
|
imagePullPolicy:
|
||
|
description:
|
||
|
Image pull policy for the 'prometheus', 'init-config-reloader'
|
||
|
and 'config-reloader' containers. See https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy
|
||
|
for more details.
|
||
|
enum:
|
||
|
- ""
|
||
|
- Always
|
||
|
- Never
|
||
|
- IfNotPresent
|
||
|
type: string
|
||
|
imagePullSecrets:
|
||
|
description:
|
||
|
An optional list of references to Secrets in the same
|
||
|
namespace to use for pulling images from registries. See http://kubernetes.io/docs/user-guide/images#specifying-imagepullsecrets-on-a-pod
|
||
|
items:
|
||
|
description:
|
||
|
LocalObjectReference contains enough information to
|
||
|
let you locate the referenced object inside the same namespace.
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: array
|
||
|
initContainers:
|
||
|
description:
|
||
|
"InitContainers allows injecting initContainers to the
|
||
|
Pod definition. Those can be used to e.g. fetch secrets for injection
|
||
|
into the Prometheus configuration from external sources. Any errors
|
||
|
during the execution of an initContainer will lead to a restart
|
||
|
of the Pod. More info: https://kubernetes.io/docs/concepts/workloads/pods/init-containers/
|
||
|
InitContainers described here modify an operator generated init
|
||
|
containers if they share the same name and modifications are done
|
||
|
via a strategic merge patch. \n The names of init container name
|
||
|
managed by the operator are: * `init-config-reloader`. \n Overriding
|
||
|
init containers is entirely outside the scope of what the maintainers
|
||
|
will support and by doing so, you accept that this behaviour may
|
||
|
break at any time without notice."
|
||
|
items:
|
||
|
description:
|
||
|
A single application container that you want to run
|
||
|
within a pod.
|
||
|
properties:
|
||
|
args:
|
||
|
description:
|
||
|
'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'
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
command:
|
||
|
description:
|
||
|
'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'
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
env:
|
||
|
description:
|
||
|
List of environment variables to set in the container.
|
||
|
Cannot be updated.
|
||
|
items:
|
||
|
description:
|
||
|
EnvVar represents an environment variable present
|
||
|
in a Container.
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
Name of the environment variable. Must be
|
||
|
a C_IDENTIFIER.
|
||
|
type: string
|
||
|
value:
|
||
|
description:
|
||
|
'Variable references $(VAR_NAME) are expanded
|
||
|
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 "".'
|
||
|
type: string
|
||
|
valueFrom:
|
||
|
description:
|
||
|
Source for the environment variable's value.
|
||
|
Cannot be used if value is not empty.
|
||
|
properties:
|
||
|
configMapKeyRef:
|
||
|
description: Selects a key of a ConfigMap.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info:
|
||
|
https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or
|
||
|
its key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
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."
|
||
|
properties:
|
||
|
apiVersion:
|
||
|
description:
|
||
|
Version of the schema the FieldPath
|
||
|
is written in terms of, defaults to "v1".
|
||
|
type: string
|
||
|
fieldPath:
|
||
|
description:
|
||
|
Path of the field to select in the
|
||
|
specified API version.
|
||
|
type: string
|
||
|
required:
|
||
|
- fieldPath
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
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."
|
||
|
properties:
|
||
|
containerName:
|
||
|
description:
|
||
|
"Container name: required for volumes,
|
||
|
optional for env vars"
|
||
|
type: string
|
||
|
divisor:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
Specifies the output format of the
|
||
|
exposed resources, defaults to "1"
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
resource:
|
||
|
description: "Required: resource to select"
|
||
|
type: string
|
||
|
required:
|
||
|
- resource
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secretKeyRef:
|
||
|
description:
|
||
|
Selects a key of a secret in the pod's
|
||
|
namespace
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info:
|
||
|
https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
envFrom:
|
||
|
description:
|
||
|
List of sources to populate environment variables
|
||
|
in the container. The keys defined within a source must be
|
||
|
a C_IDENTIFIER. All invalid keys will be reported as an event
|
||
|
when the container is starting. When a key exists in multiple
|
||
|
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.
|
||
|
items:
|
||
|
description:
|
||
|
EnvFromSource represents the source of a set
|
||
|
of ConfigMaps
|
||
|
properties:
|
||
|
configMapRef:
|
||
|
description: The ConfigMap to select from
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap must be
|
||
|
defined
|
||
|
type: boolean
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
prefix:
|
||
|
description:
|
||
|
An optional identifier to prepend to each
|
||
|
key in the ConfigMap. Must be a C_IDENTIFIER.
|
||
|
type: string
|
||
|
secretRef:
|
||
|
description: The Secret to select from
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description: Specify whether the Secret must be defined
|
||
|
type: boolean
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
type: array
|
||
|
image:
|
||
|
description:
|
||
|
"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."
|
||
|
type: string
|
||
|
imagePullPolicy:
|
||
|
description:
|
||
|
"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"
|
||
|
type: string
|
||
|
lifecycle:
|
||
|
description:
|
||
|
Actions that the management system should take
|
||
|
in response to container lifecycle events. Cannot be updated.
|
||
|
properties:
|
||
|
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"
|
||
|
properties:
|
||
|
exec:
|
||
|
description: Exec specifies the action to take.
|
||
|
properties:
|
||
|
command:
|
||
|
description:
|
||
|
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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
type: object
|
||
|
httpGet:
|
||
|
description: HTTPGet specifies the http request to perform.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
Host name to connect to, defaults to
|
||
|
the pod IP. You probably want to set "Host" in
|
||
|
httpHeaders instead.
|
||
|
type: string
|
||
|
httpHeaders:
|
||
|
description:
|
||
|
Custom headers to set in the request.
|
||
|
HTTP allows repeated headers.
|
||
|
items:
|
||
|
description:
|
||
|
HTTPHeader describes a custom header
|
||
|
to be used in HTTP probes
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
The header field name. This will
|
||
|
be canonicalized upon output, so case-variant
|
||
|
names will be understood as the same header.
|
||
|
type: string
|
||
|
value:
|
||
|
description: The header field value
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
- value
|
||
|
type: object
|
||
|
type: array
|
||
|
path:
|
||
|
description: Path to access on the HTTP server.
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
scheme:
|
||
|
description:
|
||
|
Scheme to use for connecting to the
|
||
|
host. Defaults to HTTP.
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
tcpSocket:
|
||
|
description:
|
||
|
Deprecated. TCPSocket is NOT supported
|
||
|
as a LifecycleHandler and kept for the backward compatibility.
|
||
|
There are no validation of this field and lifecycle
|
||
|
hooks will fail in runtime when tcp handler is specified.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
"Optional: Host name to connect to,
|
||
|
defaults to the pod IP."
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
type: object
|
||
|
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"
|
||
|
properties:
|
||
|
exec:
|
||
|
description: Exec specifies the action to take.
|
||
|
properties:
|
||
|
command:
|
||
|
description:
|
||
|
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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
type: object
|
||
|
httpGet:
|
||
|
description: HTTPGet specifies the http request to perform.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
Host name to connect to, defaults to
|
||
|
the pod IP. You probably want to set "Host" in
|
||
|
httpHeaders instead.
|
||
|
type: string
|
||
|
httpHeaders:
|
||
|
description:
|
||
|
Custom headers to set in the request.
|
||
|
HTTP allows repeated headers.
|
||
|
items:
|
||
|
description:
|
||
|
HTTPHeader describes a custom header
|
||
|
to be used in HTTP probes
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
The header field name. This will
|
||
|
be canonicalized upon output, so case-variant
|
||
|
names will be understood as the same header.
|
||
|
type: string
|
||
|
value:
|
||
|
description: The header field value
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
- value
|
||
|
type: object
|
||
|
type: array
|
||
|
path:
|
||
|
description: Path to access on the HTTP server.
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
scheme:
|
||
|
description:
|
||
|
Scheme to use for connecting to the
|
||
|
host. Defaults to HTTP.
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
tcpSocket:
|
||
|
description:
|
||
|
Deprecated. TCPSocket is NOT supported
|
||
|
as a LifecycleHandler and kept for the backward compatibility.
|
||
|
There are no validation of this field and lifecycle
|
||
|
hooks will fail in runtime when tcp handler is specified.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
"Optional: Host name to connect to,
|
||
|
defaults to the pod IP."
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
type: object
|
||
|
type: object
|
||
|
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"
|
||
|
properties:
|
||
|
exec:
|
||
|
description: Exec specifies the action to take.
|
||
|
properties:
|
||
|
command:
|
||
|
description:
|
||
|
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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
type: object
|
||
|
failureThreshold:
|
||
|
description:
|
||
|
Minimum consecutive failures for the probe
|
||
|
to be considered failed after having succeeded. Defaults
|
||
|
to 3. Minimum value is 1.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
grpc:
|
||
|
description: GRPC specifies an action involving a GRPC port.
|
||
|
properties:
|
||
|
port:
|
||
|
description:
|
||
|
Port number of the gRPC service. Number
|
||
|
must be in the range 1 to 65535.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
service:
|
||
|
description:
|
||
|
"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).
|
||
|
\n If this is not specified, the default behavior
|
||
|
is defined by gRPC."
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
httpGet:
|
||
|
description: HTTPGet specifies the http request to perform.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
Host name to connect to, defaults to the
|
||
|
pod IP. You probably want to set "Host" in httpHeaders
|
||
|
instead.
|
||
|
type: string
|
||
|
httpHeaders:
|
||
|
description:
|
||
|
Custom headers to set in the request. HTTP
|
||
|
allows repeated headers.
|
||
|
items:
|
||
|
description:
|
||
|
HTTPHeader describes a custom header
|
||
|
to be used in HTTP probes
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
The header field name. This will
|
||
|
be canonicalized upon output, so case-variant
|
||
|
names will be understood as the same header.
|
||
|
type: string
|
||
|
value:
|
||
|
description: The header field value
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
- value
|
||
|
type: object
|
||
|
type: array
|
||
|
path:
|
||
|
description: Path to access on the HTTP server.
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
scheme:
|
||
|
description:
|
||
|
Scheme to use for connecting to the host.
|
||
|
Defaults to HTTP.
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
initialDelaySeconds:
|
||
|
description:
|
||
|
"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"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
periodSeconds:
|
||
|
description:
|
||
|
How often (in seconds) to perform the probe.
|
||
|
Default to 10 seconds. Minimum value is 1.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
successThreshold:
|
||
|
description:
|
||
|
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.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
tcpSocket:
|
||
|
description:
|
||
|
TCPSocket specifies an action involving a TCP
|
||
|
port.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
"Optional: Host name to connect to, defaults
|
||
|
to the pod IP."
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
terminationGracePeriodSeconds:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
timeoutSeconds:
|
||
|
description:
|
||
|
"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"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
type: object
|
||
|
name:
|
||
|
description:
|
||
|
Name of the container specified as a DNS_LABEL.
|
||
|
Each container in a pod must have a unique name (DNS_LABEL).
|
||
|
Cannot be updated.
|
||
|
type: string
|
||
|
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.
|
||
|
items:
|
||
|
description:
|
||
|
ContainerPort represents a network port in a
|
||
|
single container.
|
||
|
properties:
|
||
|
containerPort:
|
||
|
description:
|
||
|
Number of port to expose on the pod's IP
|
||
|
address. This must be a valid port number, 0 < x < 65536.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
hostIP:
|
||
|
description: What host IP to bind the external port to.
|
||
|
type: string
|
||
|
hostPort:
|
||
|
description:
|
||
|
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.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
name:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
protocol:
|
||
|
default: TCP
|
||
|
description:
|
||
|
Protocol for port. Must be UDP, TCP, or SCTP.
|
||
|
Defaults to "TCP".
|
||
|
type: string
|
||
|
required:
|
||
|
- containerPort
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-map-keys:
|
||
|
- containerPort
|
||
|
- protocol
|
||
|
x-kubernetes-list-type: map
|
||
|
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"
|
||
|
properties:
|
||
|
exec:
|
||
|
description: Exec specifies the action to take.
|
||
|
properties:
|
||
|
command:
|
||
|
description:
|
||
|
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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
type: object
|
||
|
failureThreshold:
|
||
|
description:
|
||
|
Minimum consecutive failures for the probe
|
||
|
to be considered failed after having succeeded. Defaults
|
||
|
to 3. Minimum value is 1.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
grpc:
|
||
|
description: GRPC specifies an action involving a GRPC port.
|
||
|
properties:
|
||
|
port:
|
||
|
description:
|
||
|
Port number of the gRPC service. Number
|
||
|
must be in the range 1 to 65535.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
service:
|
||
|
description:
|
||
|
"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).
|
||
|
\n If this is not specified, the default behavior
|
||
|
is defined by gRPC."
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
httpGet:
|
||
|
description: HTTPGet specifies the http request to perform.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
Host name to connect to, defaults to the
|
||
|
pod IP. You probably want to set "Host" in httpHeaders
|
||
|
instead.
|
||
|
type: string
|
||
|
httpHeaders:
|
||
|
description:
|
||
|
Custom headers to set in the request. HTTP
|
||
|
allows repeated headers.
|
||
|
items:
|
||
|
description:
|
||
|
HTTPHeader describes a custom header
|
||
|
to be used in HTTP probes
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
The header field name. This will
|
||
|
be canonicalized upon output, so case-variant
|
||
|
names will be understood as the same header.
|
||
|
type: string
|
||
|
value:
|
||
|
description: The header field value
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
- value
|
||
|
type: object
|
||
|
type: array
|
||
|
path:
|
||
|
description: Path to access on the HTTP server.
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
scheme:
|
||
|
description:
|
||
|
Scheme to use for connecting to the host.
|
||
|
Defaults to HTTP.
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
initialDelaySeconds:
|
||
|
description:
|
||
|
"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"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
periodSeconds:
|
||
|
description:
|
||
|
How often (in seconds) to perform the probe.
|
||
|
Default to 10 seconds. Minimum value is 1.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
successThreshold:
|
||
|
description:
|
||
|
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.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
tcpSocket:
|
||
|
description:
|
||
|
TCPSocket specifies an action involving a TCP
|
||
|
port.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
"Optional: Host name to connect to, defaults
|
||
|
to the pod IP."
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
terminationGracePeriodSeconds:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
timeoutSeconds:
|
||
|
description:
|
||
|
"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"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
type: object
|
||
|
resizePolicy:
|
||
|
description: Resources resize policy for the container.
|
||
|
items:
|
||
|
description:
|
||
|
ContainerResizePolicy represents resource resize
|
||
|
policy for the container.
|
||
|
properties:
|
||
|
resourceName:
|
||
|
description:
|
||
|
"Name of the resource to which this resource
|
||
|
resize policy applies. Supported values: cpu, memory."
|
||
|
type: string
|
||
|
restartPolicy:
|
||
|
description:
|
||
|
Restart policy to apply when specified resource
|
||
|
is resized. If not specified, it defaults to NotRequired.
|
||
|
type: string
|
||
|
required:
|
||
|
- resourceName
|
||
|
- restartPolicy
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-type: atomic
|
||
|
resources:
|
||
|
description:
|
||
|
"Compute Resources required by this container.
|
||
|
Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
|
||
|
properties:
|
||
|
claims:
|
||
|
description:
|
||
|
"Claims lists the names of resources, defined
|
||
|
in spec.resourceClaims, that are used by this container.
|
||
|
\n This is an alpha field and requires enabling the DynamicResourceAllocation
|
||
|
feature gate. \n This field is immutable. It can only
|
||
|
be set for containers."
|
||
|
items:
|
||
|
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-map-keys:
|
||
|
- name
|
||
|
x-kubernetes-list-type: map
|
||
|
limits:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"Limits describes the maximum amount of compute
|
||
|
resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
|
||
|
type: object
|
||
|
requests:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"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/"
|
||
|
type: object
|
||
|
type: object
|
||
|
restartPolicy:
|
||
|
description:
|
||
|
'RestartPolicy defines the restart behavior of
|
||
|
individual containers in a pod. This field may only be set
|
||
|
for init containers, and the only allowed value is "Always".
|
||
|
For non-init containers or when this field is not specified,
|
||
|
the restart behavior is defined by the Pod''s restart policy
|
||
|
and the container type. Setting the RestartPolicy as "Always"
|
||
|
for the init container will have the following effect: 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.'
|
||
|
type: string
|
||
|
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/"
|
||
|
properties:
|
||
|
allowPrivilegeEscalation:
|
||
|
description:
|
||
|
"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."
|
||
|
type: boolean
|
||
|
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.
|
||
|
properties:
|
||
|
add:
|
||
|
description: Added capabilities
|
||
|
items:
|
||
|
description:
|
||
|
Capability represent POSIX capabilities
|
||
|
type
|
||
|
type: string
|
||
|
type: array
|
||
|
drop:
|
||
|
description: Removed capabilities
|
||
|
items:
|
||
|
description:
|
||
|
Capability represent POSIX capabilities
|
||
|
type
|
||
|
type: string
|
||
|
type: array
|
||
|
type: object
|
||
|
privileged:
|
||
|
description:
|
||
|
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.
|
||
|
type: boolean
|
||
|
procMount:
|
||
|
description:
|
||
|
procMount denotes the type of proc mount to
|
||
|
use for the containers. The default is DefaultProcMount
|
||
|
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.
|
||
|
type: string
|
||
|
readOnlyRootFilesystem:
|
||
|
description:
|
||
|
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.
|
||
|
type: boolean
|
||
|
runAsGroup:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
runAsNonRoot:
|
||
|
description:
|
||
|
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.
|
||
|
type: boolean
|
||
|
runAsUser:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
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.
|
||
|
properties:
|
||
|
level:
|
||
|
description:
|
||
|
Level is SELinux level label that applies
|
||
|
to the container.
|
||
|
type: string
|
||
|
role:
|
||
|
description:
|
||
|
Role is a SELinux role label that applies
|
||
|
to the container.
|
||
|
type: string
|
||
|
type:
|
||
|
description:
|
||
|
Type is a SELinux type label that applies
|
||
|
to the container.
|
||
|
type: string
|
||
|
user:
|
||
|
description:
|
||
|
User is a SELinux user label that applies
|
||
|
to the container.
|
||
|
type: string
|
||
|
type: object
|
||
|
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.
|
||
|
properties:
|
||
|
localhostProfile:
|
||
|
description:
|
||
|
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:
|
||
|
description:
|
||
|
"type indicates which kind of seccomp profile
|
||
|
will be applied. Valid options are: \n 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."
|
||
|
type: string
|
||
|
required:
|
||
|
- type
|
||
|
type: object
|
||
|
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.
|
||
|
properties:
|
||
|
gmsaCredentialSpec:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
gmsaCredentialSpecName:
|
||
|
description:
|
||
|
GMSACredentialSpecName is the name of the
|
||
|
GMSA credential spec to use.
|
||
|
type: string
|
||
|
hostProcess:
|
||
|
description:
|
||
|
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.
|
||
|
type: boolean
|
||
|
runAsUserName:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
type: object
|
||
|
type: object
|
||
|
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"
|
||
|
properties:
|
||
|
exec:
|
||
|
description: Exec specifies the action to take.
|
||
|
properties:
|
||
|
command:
|
||
|
description:
|
||
|
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.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
type: object
|
||
|
failureThreshold:
|
||
|
description:
|
||
|
Minimum consecutive failures for the probe
|
||
|
to be considered failed after having succeeded. Defaults
|
||
|
to 3. Minimum value is 1.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
grpc:
|
||
|
description: GRPC specifies an action involving a GRPC port.
|
||
|
properties:
|
||
|
port:
|
||
|
description:
|
||
|
Port number of the gRPC service. Number
|
||
|
must be in the range 1 to 65535.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
service:
|
||
|
description:
|
||
|
"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).
|
||
|
\n If this is not specified, the default behavior
|
||
|
is defined by gRPC."
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
httpGet:
|
||
|
description: HTTPGet specifies the http request to perform.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
Host name to connect to, defaults to the
|
||
|
pod IP. You probably want to set "Host" in httpHeaders
|
||
|
instead.
|
||
|
type: string
|
||
|
httpHeaders:
|
||
|
description:
|
||
|
Custom headers to set in the request. HTTP
|
||
|
allows repeated headers.
|
||
|
items:
|
||
|
description:
|
||
|
HTTPHeader describes a custom header
|
||
|
to be used in HTTP probes
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
The header field name. This will
|
||
|
be canonicalized upon output, so case-variant
|
||
|
names will be understood as the same header.
|
||
|
type: string
|
||
|
value:
|
||
|
description: The header field value
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
- value
|
||
|
type: object
|
||
|
type: array
|
||
|
path:
|
||
|
description: Path to access on the HTTP server.
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
scheme:
|
||
|
description:
|
||
|
Scheme to use for connecting to the host.
|
||
|
Defaults to HTTP.
|
||
|
type: string
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
initialDelaySeconds:
|
||
|
description:
|
||
|
"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"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
periodSeconds:
|
||
|
description:
|
||
|
How often (in seconds) to perform the probe.
|
||
|
Default to 10 seconds. Minimum value is 1.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
successThreshold:
|
||
|
description:
|
||
|
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.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
tcpSocket:
|
||
|
description:
|
||
|
TCPSocket specifies an action involving a TCP
|
||
|
port.
|
||
|
properties:
|
||
|
host:
|
||
|
description:
|
||
|
"Optional: Host name to connect to, defaults
|
||
|
to the pod IP."
|
||
|
type: string
|
||
|
port:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
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.
|
||
|
x-kubernetes-int-or-string: true
|
||
|
required:
|
||
|
- port
|
||
|
type: object
|
||
|
terminationGracePeriodSeconds:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
timeoutSeconds:
|
||
|
description:
|
||
|
"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"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
type: object
|
||
|
stdin:
|
||
|
description:
|
||
|
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.
|
||
|
type: boolean
|
||
|
stdinOnce:
|
||
|
description:
|
||
|
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
|
||
|
type: boolean
|
||
|
terminationMessagePath:
|
||
|
description:
|
||
|
"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."
|
||
|
type: string
|
||
|
terminationMessagePolicy:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
tty:
|
||
|
description:
|
||
|
Whether this container should allocate a TTY for
|
||
|
itself, also requires 'stdin' to be true. Default is false.
|
||
|
type: boolean
|
||
|
volumeDevices:
|
||
|
description:
|
||
|
volumeDevices is the list of block devices to be
|
||
|
used by the container.
|
||
|
items:
|
||
|
description:
|
||
|
volumeDevice describes a mapping of a raw block
|
||
|
device within a container.
|
||
|
properties:
|
||
|
devicePath:
|
||
|
description:
|
||
|
devicePath is the path inside of the container
|
||
|
that the device will be mapped to.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
name must match the name of a persistentVolumeClaim
|
||
|
in the pod
|
||
|
type: string
|
||
|
required:
|
||
|
- devicePath
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
volumeMounts:
|
||
|
description:
|
||
|
Pod volumes to mount into the container's filesystem.
|
||
|
Cannot be updated.
|
||
|
items:
|
||
|
description:
|
||
|
VolumeMount describes a mounting of a Volume
|
||
|
within a container.
|
||
|
properties:
|
||
|
mountPath:
|
||
|
description:
|
||
|
Path within the container at which the volume
|
||
|
should be mounted. Must not contain ':'.
|
||
|
type: string
|
||
|
mountPropagation:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
name:
|
||
|
description: This must match the Name of a Volume.
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
Mounted read-only if true, read-write otherwise
|
||
|
(false or unspecified). Defaults to false.
|
||
|
type: boolean
|
||
|
subPath:
|
||
|
description:
|
||
|
Path within the volume from which the container's
|
||
|
volume should be mounted. Defaults to "" (volume's root).
|
||
|
type: string
|
||
|
subPathExpr:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- mountPath
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
workingDir:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
keepDroppedTargets:
|
||
|
description:
|
||
|
"Per-scrape limit on the number of targets dropped by
|
||
|
relabeling that will be kept in memory. 0 means no limit. \n It
|
||
|
requires Prometheus >= v2.47.0."
|
||
|
format: int64
|
||
|
type: integer
|
||
|
labelLimit:
|
||
|
description:
|
||
|
Per-scrape limit on number of labels that will be accepted
|
||
|
for a sample. Only valid in Prometheus versions 2.45.0 and newer.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
labelNameLengthLimit:
|
||
|
description:
|
||
|
Per-scrape limit on length of labels name that will be
|
||
|
accepted for a sample. Only valid in Prometheus versions 2.45.0
|
||
|
and newer.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
labelValueLengthLimit:
|
||
|
description:
|
||
|
Per-scrape limit on length of labels value that will
|
||
|
be accepted for a sample. Only valid in Prometheus versions 2.45.0
|
||
|
and newer.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
listenLocal:
|
||
|
description:
|
||
|
When true, the Prometheus server listens on the loopback
|
||
|
address instead of the Pod IP's address.
|
||
|
type: boolean
|
||
|
logFormat:
|
||
|
description:
|
||
|
Log format for Log level for Prometheus and the config-reloader
|
||
|
sidecar.
|
||
|
enum:
|
||
|
- ""
|
||
|
- logfmt
|
||
|
- json
|
||
|
type: string
|
||
|
logLevel:
|
||
|
description: Log level for Prometheus and the config-reloader sidecar.
|
||
|
enum:
|
||
|
- ""
|
||
|
- debug
|
||
|
- info
|
||
|
- warn
|
||
|
- error
|
||
|
type: string
|
||
|
minReadySeconds:
|
||
|
description:
|
||
|
"Minimum number of seconds for which a newly created
|
||
|
Pod should be ready without any of its container crashing for it
|
||
|
to be considered available. Defaults to 0 (pod will be considered
|
||
|
available as soon as it is ready) \n This is an alpha field from
|
||
|
kubernetes 1.22 until 1.24 which requires enabling the StatefulSetMinReadySeconds
|
||
|
feature gate."
|
||
|
format: int32
|
||
|
type: integer
|
||
|
nodeSelector:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description: Defines on which Nodes the Pods are scheduled.
|
||
|
type: object
|
||
|
overrideHonorLabels:
|
||
|
description:
|
||
|
When true, Prometheus resolves label conflicts by renaming
|
||
|
the labels in the scraped data to "exported_<label value>" for all
|
||
|
targets created from service and pod monitors. Otherwise the HonorLabels
|
||
|
field of the service or pod monitor applies.
|
||
|
type: boolean
|
||
|
overrideHonorTimestamps:
|
||
|
description:
|
||
|
When true, Prometheus ignores the timestamps for all
|
||
|
the targets created from service and pod monitors. Otherwise the
|
||
|
HonorTimestamps field of the service or pod monitor applies.
|
||
|
type: boolean
|
||
|
paused:
|
||
|
description:
|
||
|
When a Prometheus deployment is paused, no actions except
|
||
|
for deletion will be performed on the underlying objects.
|
||
|
type: boolean
|
||
|
persistentVolumeClaimRetentionPolicy:
|
||
|
description:
|
||
|
The field controls if and how PVCs are deleted during
|
||
|
the lifecycle of a StatefulSet. The default behavior is all PVCs
|
||
|
are retained. This is an alpha field from kubernetes 1.23 until
|
||
|
1.26 and a beta field from 1.26. It requires enabling the StatefulSetAutoDeletePVC
|
||
|
feature gate.
|
||
|
properties:
|
||
|
whenDeleted:
|
||
|
description:
|
||
|
WhenDeleted specifies what happens to PVCs created
|
||
|
from StatefulSet VolumeClaimTemplates when the StatefulSet is
|
||
|
deleted. The default policy of `Retain` causes PVCs to not be
|
||
|
affected by StatefulSet deletion. The `Delete` policy causes
|
||
|
those PVCs to be deleted.
|
||
|
type: string
|
||
|
whenScaled:
|
||
|
description:
|
||
|
WhenScaled specifies what happens to PVCs created
|
||
|
from StatefulSet VolumeClaimTemplates when the StatefulSet is
|
||
|
scaled down. The default policy of `Retain` causes PVCs to not
|
||
|
be affected by a scaledown. The `Delete` policy causes the associated
|
||
|
PVCs for any excess pods above the replica count to be deleted.
|
||
|
type: string
|
||
|
type: object
|
||
|
podMetadata:
|
||
|
description:
|
||
|
"PodMetadata configures labels and annotations which
|
||
|
are propagated to the Prometheus pods. \n The following items are
|
||
|
reserved and cannot be overridden: * \"prometheus\" label, set to
|
||
|
the name of the Prometheus object. * \"app.kubernetes.io/instance\"
|
||
|
label, set to the name of the Prometheus object. * \"app.kubernetes.io/managed-by\"
|
||
|
label, set to \"prometheus-operator\". * \"app.kubernetes.io/name\"
|
||
|
label, set to \"prometheus\". * \"app.kubernetes.io/version\" label,
|
||
|
set to the Prometheus version. * \"operator.prometheus.io/name\"
|
||
|
label, set to the name of the Prometheus object. * \"operator.prometheus.io/shard\"
|
||
|
label, set to the shard number of the Prometheus object. * \"kubectl.kubernetes.io/default-container\"
|
||
|
annotation, set to \"prometheus\"."
|
||
|
properties:
|
||
|
annotations:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
"Annotations is an unstructured key value map stored
|
||
|
with a resource that may be set by external tools to store and
|
||
|
retrieve arbitrary metadata. They are not queryable and should
|
||
|
be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
|
||
|
type: object
|
||
|
labels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
"Map of string keys and values that can be used to
|
||
|
organize and categorize (scope and select) objects. May match
|
||
|
selectors of replication controllers and services. More info:
|
||
|
http://kubernetes.io/docs/user-guide/labels"
|
||
|
type: object
|
||
|
name:
|
||
|
description:
|
||
|
"Name must be unique within a namespace. Is required
|
||
|
when creating resources, although some resources may allow a
|
||
|
client to request the generation of an appropriate name automatically.
|
||
|
Name is primarily intended for creation idempotence and configuration
|
||
|
definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
|
||
|
type: string
|
||
|
type: object
|
||
|
podMonitorNamespaceSelector:
|
||
|
description:
|
||
|
Namespaces to match for PodMonitors discovery. An empty
|
||
|
label selector matches all namespaces. A null label selector matches
|
||
|
the current namespace only.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label selector requirements.
|
||
|
The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a selector that
|
||
|
contains values, a key, and an operator that relates the key
|
||
|
and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the selector applies
|
||
|
to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship to
|
||
|
a set of values. Valid operators are In, NotIn, Exists
|
||
|
and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string values. If the
|
||
|
operator is In or NotIn, the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist, the values
|
||
|
array must be empty. This array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value} pairs. A single
|
||
|
{key,value} in the matchLabels map is equivalent to an element
|
||
|
of matchExpressions, whose key field is "key", the operator
|
||
|
is "In", and the values array contains only "value". The requirements
|
||
|
are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
podMonitorSelector:
|
||
|
description:
|
||
|
"*Experimental* PodMonitors to be selected for target
|
||
|
discovery. An empty label selector matches all objects. A null label
|
||
|
selector matches no objects. \n If `spec.serviceMonitorSelector`,
|
||
|
`spec.podMonitorSelector`, `spec.probeSelector` and `spec.scrapeConfigSelector`
|
||
|
are null, the Prometheus configuration is unmanaged. The Prometheus
|
||
|
operator will ensure that the Prometheus configuration's Secret
|
||
|
exists, but it is the responsibility of the user to provide the
|
||
|
raw gzipped Prometheus configuration under the `prometheus.yaml.gz`
|
||
|
key. This behavior is *deprecated* and will be removed in the next
|
||
|
major version of the custom resource definition. It is recommended
|
||
|
to use `spec.additionalScrapeConfigs` instead."
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label selector requirements.
|
||
|
The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a selector that
|
||
|
contains values, a key, and an operator that relates the key
|
||
|
and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the selector applies
|
||
|
to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship to
|
||
|
a set of values. Valid operators are In, NotIn, Exists
|
||
|
and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string values. If the
|
||
|
operator is In or NotIn, the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist, the values
|
||
|
array must be empty. This array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value} pairs. A single
|
||
|
{key,value} in the matchLabels map is equivalent to an element
|
||
|
of matchExpressions, whose key field is "key", the operator
|
||
|
is "In", and the values array contains only "value". The requirements
|
||
|
are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
podTargetLabels:
|
||
|
description:
|
||
|
PodTargetLabels are appended to the `spec.podTargetLabels`
|
||
|
field of all PodMonitor and ServiceMonitor objects.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
portName:
|
||
|
default: web
|
||
|
description:
|
||
|
'Port name used for the pods and governing service. Default:
|
||
|
"web"'
|
||
|
type: string
|
||
|
priorityClassName:
|
||
|
description: Priority class assigned to the Pods.
|
||
|
type: string
|
||
|
probeNamespaceSelector:
|
||
|
description:
|
||
|
"*Experimental* Namespaces to match for Probe discovery.
|
||
|
An empty label selector matches all namespaces. A null label selector
|
||
|
matches the current namespace only."
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label selector requirements.
|
||
|
The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a selector that
|
||
|
contains values, a key, and an operator that relates the key
|
||
|
and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the selector applies
|
||
|
to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship to
|
||
|
a set of values. Valid operators are In, NotIn, Exists
|
||
|
and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string values. If the
|
||
|
operator is In or NotIn, the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist, the values
|
||
|
array must be empty. This array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value} pairs. A single
|
||
|
{key,value} in the matchLabels map is equivalent to an element
|
||
|
of matchExpressions, whose key field is "key", the operator
|
||
|
is "In", and the values array contains only "value". The requirements
|
||
|
are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
probeSelector:
|
||
|
description:
|
||
|
"*Experimental* Probes to be selected for target discovery.
|
||
|
An empty label selector matches all objects. A null label selector
|
||
|
matches no objects. \n If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`,
|
||
|
`spec.probeSelector` and `spec.scrapeConfigSelector` are null, the
|
||
|
Prometheus configuration is unmanaged. The Prometheus operator will
|
||
|
ensure that the Prometheus configuration's Secret exists, but it
|
||
|
is the responsibility of the user to provide the raw gzipped Prometheus
|
||
|
configuration under the `prometheus.yaml.gz` key. This behavior
|
||
|
is *deprecated* and will be removed in the next major version of
|
||
|
the custom resource definition. It is recommended to use `spec.additionalScrapeConfigs`
|
||
|
instead."
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label selector requirements.
|
||
|
The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a selector that
|
||
|
contains values, a key, and an operator that relates the key
|
||
|
and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the selector applies
|
||
|
to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship to
|
||
|
a set of values. Valid operators are In, NotIn, Exists
|
||
|
and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string values. If the
|
||
|
operator is In or NotIn, the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist, the values
|
||
|
array must be empty. This array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value} pairs. A single
|
||
|
{key,value} in the matchLabels map is equivalent to an element
|
||
|
of matchExpressions, whose key field is "key", the operator
|
||
|
is "In", and the values array contains only "value". The requirements
|
||
|
are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
prometheusExternalLabelName:
|
||
|
description:
|
||
|
"Name of Prometheus external label used to denote the
|
||
|
Prometheus instance name. The external label will _not_ be added
|
||
|
when the field is set to the empty string (`\"\"`). \n Default:
|
||
|
\"prometheus\""
|
||
|
type: string
|
||
|
prometheusRulesExcludedFromEnforce:
|
||
|
description:
|
||
|
"Defines the list of PrometheusRule objects to which
|
||
|
the namespace label enforcement doesn't apply. This is only relevant
|
||
|
when `spec.enforcedNamespaceLabel` is set to true. *Deprecated:
|
||
|
use `spec.excludedFromEnforcement` instead.*"
|
||
|
items:
|
||
|
description:
|
||
|
PrometheusRuleExcludeConfig enables users to configure
|
||
|
excluded PrometheusRule names and their namespaces to be ignored
|
||
|
while enforcing namespace label for alerts and metrics.
|
||
|
properties:
|
||
|
ruleName:
|
||
|
description: Name of the excluded PrometheusRule object.
|
||
|
type: string
|
||
|
ruleNamespace:
|
||
|
description: Namespace of the excluded PrometheusRule object.
|
||
|
type: string
|
||
|
required:
|
||
|
- ruleName
|
||
|
- ruleNamespace
|
||
|
type: object
|
||
|
type: array
|
||
|
query:
|
||
|
description:
|
||
|
QuerySpec defines the configuration of the Promethus
|
||
|
query service.
|
||
|
properties:
|
||
|
lookbackDelta:
|
||
|
description:
|
||
|
The delta difference allowed for retrieving metrics
|
||
|
during expression evaluations.
|
||
|
type: string
|
||
|
maxConcurrency:
|
||
|
description: Number of concurrent queries that can be run at once.
|
||
|
format: int32
|
||
|
minimum: 1
|
||
|
type: integer
|
||
|
maxSamples:
|
||
|
description:
|
||
|
Maximum number of samples a single query can load
|
||
|
into memory. Note that queries will fail if they would load
|
||
|
more samples than this into memory, so this also limits the
|
||
|
number of samples a query can return.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
timeout:
|
||
|
description: Maximum time a query may take before being aborted.
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
type: object
|
||
|
queryLogFile:
|
||
|
description:
|
||
|
"queryLogFile specifies where the file to which PromQL
|
||
|
queries are logged. \n If the filename has an empty path, e.g. 'query.log',
|
||
|
The Prometheus Pods will mount the file into an emptyDir volume
|
||
|
at `/var/log/prometheus`. If a full path is provided, e.g. '/var/log/prometheus/query.log',
|
||
|
you must mount a volume in the specified directory and it must be
|
||
|
writable. This is because the prometheus container runs with a read-only
|
||
|
root filesystem for security reasons. Alternatively, the location
|
||
|
can be set to a standard I/O stream, e.g. `/dev/stdout`, to log
|
||
|
query information to the default Prometheus log stream."
|
||
|
type: string
|
||
|
reloadStrategy:
|
||
|
description:
|
||
|
Defines the strategy used to reload the Prometheus configuration.
|
||
|
If not specified, the configuration is reloaded using the /-/reload
|
||
|
HTTP endpoint.
|
||
|
enum:
|
||
|
- HTTP
|
||
|
- ProcessSignal
|
||
|
type: string
|
||
|
remoteRead:
|
||
|
description: Defines the list of remote read configurations.
|
||
|
items:
|
||
|
description:
|
||
|
RemoteReadSpec defines the configuration for Prometheus
|
||
|
to read back samples from a remote endpoint.
|
||
|
properties:
|
||
|
authorization:
|
||
|
description:
|
||
|
"Authorization section for the URL. \n It requires
|
||
|
Prometheus >= v2.26.0. \n Cannot be set at the same time as
|
||
|
`basicAuth`, or `oauth2`."
|
||
|
properties:
|
||
|
credentials:
|
||
|
description:
|
||
|
Selects a key of a Secret in the namespace
|
||
|
that contains the credentials for authentication.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
credentialsFile:
|
||
|
description:
|
||
|
File to read a secret from, mutually exclusive
|
||
|
with `credentials`.
|
||
|
type: string
|
||
|
type:
|
||
|
description:
|
||
|
"Defines the authentication type. The value
|
||
|
is case-insensitive. \n \"Basic\" is not a supported value.
|
||
|
\n Default: \"Bearer\""
|
||
|
type: string
|
||
|
type: object
|
||
|
basicAuth:
|
||
|
description:
|
||
|
"BasicAuth configuration for the URL. \n Cannot
|
||
|
be set at the same time as `authorization`, or `oauth2`."
|
||
|
properties:
|
||
|
password:
|
||
|
description:
|
||
|
"`password` specifies a key of a Secret containing
|
||
|
the password for authentication."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
username:
|
||
|
description:
|
||
|
"`username` specifies a key of a Secret containing
|
||
|
the username for authentication."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
bearerToken:
|
||
|
description:
|
||
|
"*Warning: this field shouldn't be used because
|
||
|
the token value appears in clear-text. Prefer using `authorization`.*
|
||
|
\n *Deprecated: this will be removed in a future release.*"
|
||
|
type: string
|
||
|
bearerTokenFile:
|
||
|
description:
|
||
|
"File from which to read the bearer token for the
|
||
|
URL. \n *Deprecated: this will be removed in a future release.
|
||
|
Prefer using `authorization`.*"
|
||
|
type: string
|
||
|
filterExternalLabels:
|
||
|
description:
|
||
|
"Whether to use the external labels as selectors
|
||
|
for the remote read endpoint. \n It requires Prometheus >=
|
||
|
v2.34.0."
|
||
|
type: boolean
|
||
|
followRedirects:
|
||
|
description:
|
||
|
"Configure whether HTTP requests follow HTTP 3xx
|
||
|
redirects. \n It requires Prometheus >= v2.26.0."
|
||
|
type: boolean
|
||
|
headers:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
Custom HTTP headers to be sent along with each
|
||
|
remote read request. Be aware that headers that are set by
|
||
|
Prometheus itself can't be overwritten. Only valid in Prometheus
|
||
|
versions 2.26.0 and newer.
|
||
|
type: object
|
||
|
name:
|
||
|
description:
|
||
|
"The name of the remote read queue, it must be
|
||
|
unique if specified. The name is used in metrics and logging
|
||
|
in order to differentiate read configurations. \n It requires
|
||
|
Prometheus >= v2.15.0."
|
||
|
type: string
|
||
|
oauth2:
|
||
|
description:
|
||
|
"OAuth2 configuration for the URL. \n It requires
|
||
|
Prometheus >= v2.27.0. \n Cannot be set at the same time as
|
||
|
`authorization`, or `basicAuth`."
|
||
|
properties:
|
||
|
clientId:
|
||
|
description:
|
||
|
"`clientId` specifies a key of a Secret or
|
||
|
ConfigMap containing the OAuth2 client's ID."
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
clientSecret:
|
||
|
description:
|
||
|
"`clientSecret` specifies a key of a Secret
|
||
|
containing the OAuth2 client's secret."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
endpointParams:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
"`endpointParams` configures the HTTP parameters
|
||
|
to append to the token URL."
|
||
|
type: object
|
||
|
scopes:
|
||
|
description:
|
||
|
"`scopes` defines the OAuth2 scopes used for
|
||
|
the token request."
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
tokenUrl:
|
||
|
description:
|
||
|
"`tokenURL` configures the URL to fetch the
|
||
|
token from."
|
||
|
minLength: 1
|
||
|
type: string
|
||
|
required:
|
||
|
- clientId
|
||
|
- clientSecret
|
||
|
- tokenUrl
|
||
|
type: object
|
||
|
proxyUrl:
|
||
|
description: Optional ProxyURL.
|
||
|
type: string
|
||
|
readRecent:
|
||
|
description:
|
||
|
Whether reads should be made for queries for time
|
||
|
ranges that the local storage should have complete data for.
|
||
|
type: boolean
|
||
|
remoteTimeout:
|
||
|
description: Timeout for requests to the remote read endpoint.
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
requiredMatchers:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
An optional list of equality matchers which have
|
||
|
to be present in a selector to query the remote read endpoint.
|
||
|
type: object
|
||
|
tlsConfig:
|
||
|
description: TLS Config to use for the URL.
|
||
|
properties:
|
||
|
ca:
|
||
|
description:
|
||
|
Certificate authority used when verifying server
|
||
|
certificates.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
caFile:
|
||
|
description:
|
||
|
Path to the CA cert in the Prometheus container
|
||
|
to use for the targets.
|
||
|
type: string
|
||
|
cert:
|
||
|
description: Client certificate to present when doing client-authentication.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
certFile:
|
||
|
description:
|
||
|
Path to the client cert file in the Prometheus
|
||
|
container for the targets.
|
||
|
type: string
|
||
|
insecureSkipVerify:
|
||
|
description: Disable target certificate validation.
|
||
|
type: boolean
|
||
|
keyFile:
|
||
|
description:
|
||
|
Path to the client key file in the Prometheus
|
||
|
container for the targets.
|
||
|
type: string
|
||
|
keySecret:
|
||
|
description:
|
||
|
Secret containing the client key file for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
serverName:
|
||
|
description: Used to verify the hostname for the targets.
|
||
|
type: string
|
||
|
type: object
|
||
|
url:
|
||
|
description: The URL of the endpoint to query from.
|
||
|
type: string
|
||
|
required:
|
||
|
- url
|
||
|
type: object
|
||
|
type: array
|
||
|
remoteWrite:
|
||
|
description: Defines the list of remote write configurations.
|
||
|
items:
|
||
|
description:
|
||
|
RemoteWriteSpec defines the configuration to write
|
||
|
samples from Prometheus to a remote endpoint.
|
||
|
properties:
|
||
|
authorization:
|
||
|
description:
|
||
|
"Authorization section for the URL. \n It requires
|
||
|
Prometheus >= v2.26.0. \n Cannot be set at the same time as
|
||
|
`sigv4`, `basicAuth`, `oauth2`, or `azureAd`."
|
||
|
properties:
|
||
|
credentials:
|
||
|
description:
|
||
|
Selects a key of a Secret in the namespace
|
||
|
that contains the credentials for authentication.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
credentialsFile:
|
||
|
description:
|
||
|
File to read a secret from, mutually exclusive
|
||
|
with `credentials`.
|
||
|
type: string
|
||
|
type:
|
||
|
description:
|
||
|
"Defines the authentication type. The value
|
||
|
is case-insensitive. \n \"Basic\" is not a supported value.
|
||
|
\n Default: \"Bearer\""
|
||
|
type: string
|
||
|
type: object
|
||
|
azureAd:
|
||
|
description:
|
||
|
"AzureAD for the URL. \n It requires Prometheus
|
||
|
>= v2.45.0. \n Cannot be set at the same time as `authorization`,
|
||
|
`basicAuth`, `oauth2`, or `sigv4`."
|
||
|
properties:
|
||
|
cloud:
|
||
|
description:
|
||
|
The Azure Cloud. Options are 'AzurePublic',
|
||
|
'AzureChina', or 'AzureGovernment'.
|
||
|
enum:
|
||
|
- AzureChina
|
||
|
- AzureGovernment
|
||
|
- AzurePublic
|
||
|
type: string
|
||
|
managedIdentity:
|
||
|
description:
|
||
|
ManagedIdentity defines the Azure User-assigned
|
||
|
Managed identity. Cannot be set at the same time as `oauth`.
|
||
|
properties:
|
||
|
clientId:
|
||
|
description: The client id
|
||
|
type: string
|
||
|
required:
|
||
|
- clientId
|
||
|
type: object
|
||
|
oauth:
|
||
|
description:
|
||
|
"OAuth defines the oauth config that is being
|
||
|
used to authenticate. Cannot be set at the same time as
|
||
|
`managedIdentity`. \n It requires Prometheus >= v2.48.0."
|
||
|
properties:
|
||
|
clientId:
|
||
|
description:
|
||
|
"`clientID` is the clientId of the Azure
|
||
|
Active Directory application that is being used to
|
||
|
authenticate."
|
||
|
minLength: 1
|
||
|
type: string
|
||
|
clientSecret:
|
||
|
description:
|
||
|
"`clientSecret` specifies a key of a Secret
|
||
|
containing the client secret of the Azure Active Directory
|
||
|
application that is being used to authenticate."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
tenantId:
|
||
|
description:
|
||
|
"`tenantID` is the tenant ID of the Azure
|
||
|
Active Directory application that is being used to
|
||
|
authenticate."
|
||
|
minLength: 1
|
||
|
pattern: ^[0-9a-zA-Z-.]+$
|
||
|
type: string
|
||
|
required:
|
||
|
- clientId
|
||
|
- clientSecret
|
||
|
- tenantId
|
||
|
type: object
|
||
|
type: object
|
||
|
basicAuth:
|
||
|
description:
|
||
|
"BasicAuth configuration for the URL. \n Cannot
|
||
|
be set at the same time as `sigv4`, `authorization`, `oauth2`,
|
||
|
or `azureAd`."
|
||
|
properties:
|
||
|
password:
|
||
|
description:
|
||
|
"`password` specifies a key of a Secret containing
|
||
|
the password for authentication."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
username:
|
||
|
description:
|
||
|
"`username` specifies a key of a Secret containing
|
||
|
the username for authentication."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
bearerToken:
|
||
|
description:
|
||
|
"*Warning: this field shouldn't be used because
|
||
|
the token value appears in clear-text. Prefer using `authorization`.*
|
||
|
\n *Deprecated: this will be removed in a future release.*"
|
||
|
type: string
|
||
|
bearerTokenFile:
|
||
|
description:
|
||
|
"File from which to read bearer token for the URL.
|
||
|
\n *Deprecated: this will be removed in a future release.
|
||
|
Prefer using `authorization`.*"
|
||
|
type: string
|
||
|
headers:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
"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. \n It requires Prometheus
|
||
|
>= v2.25.0."
|
||
|
type: object
|
||
|
metadataConfig:
|
||
|
description:
|
||
|
MetadataConfig configures the sending of series
|
||
|
metadata to the remote storage.
|
||
|
properties:
|
||
|
send:
|
||
|
description:
|
||
|
Defines whether metric metadata is sent to
|
||
|
the remote storage or not.
|
||
|
type: boolean
|
||
|
sendInterval:
|
||
|
description:
|
||
|
Defines how frequently metric metadata is sent
|
||
|
to the remote storage.
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
type: object
|
||
|
name:
|
||
|
description:
|
||
|
"The name of the remote write queue, it must be
|
||
|
unique if specified. The name is used in metrics and logging
|
||
|
in order to differentiate queues. \n It requires Prometheus
|
||
|
>= v2.15.0."
|
||
|
type: string
|
||
|
oauth2:
|
||
|
description:
|
||
|
"OAuth2 configuration for the URL. \n It requires
|
||
|
Prometheus >= v2.27.0. \n Cannot be set at the same time as
|
||
|
`sigv4`, `authorization`, `basicAuth`, or `azureAd`."
|
||
|
properties:
|
||
|
clientId:
|
||
|
description:
|
||
|
"`clientId` specifies a key of a Secret or
|
||
|
ConfigMap containing the OAuth2 client's ID."
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
clientSecret:
|
||
|
description:
|
||
|
"`clientSecret` specifies a key of a Secret
|
||
|
containing the OAuth2 client's secret."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
endpointParams:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
"`endpointParams` configures the HTTP parameters
|
||
|
to append to the token URL."
|
||
|
type: object
|
||
|
scopes:
|
||
|
description:
|
||
|
"`scopes` defines the OAuth2 scopes used for
|
||
|
the token request."
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
tokenUrl:
|
||
|
description:
|
||
|
"`tokenURL` configures the URL to fetch the
|
||
|
token from."
|
||
|
minLength: 1
|
||
|
type: string
|
||
|
required:
|
||
|
- clientId
|
||
|
- clientSecret
|
||
|
- tokenUrl
|
||
|
type: object
|
||
|
proxyUrl:
|
||
|
description: Optional ProxyURL.
|
||
|
type: string
|
||
|
queueConfig:
|
||
|
description:
|
||
|
QueueConfig allows tuning of the remote write queue
|
||
|
parameters.
|
||
|
properties:
|
||
|
batchSendDeadline:
|
||
|
description:
|
||
|
BatchSendDeadline is the maximum time a sample
|
||
|
will wait in buffer.
|
||
|
type: string
|
||
|
capacity:
|
||
|
description:
|
||
|
Capacity is the number of samples to buffer
|
||
|
per shard before we start dropping them.
|
||
|
type: integer
|
||
|
maxBackoff:
|
||
|
description: MaxBackoff is the maximum retry delay.
|
||
|
type: string
|
||
|
maxRetries:
|
||
|
description:
|
||
|
MaxRetries is the maximum number of times to
|
||
|
retry a batch on recoverable errors.
|
||
|
type: integer
|
||
|
maxSamplesPerSend:
|
||
|
description:
|
||
|
MaxSamplesPerSend is the maximum number of
|
||
|
samples per send.
|
||
|
type: integer
|
||
|
maxShards:
|
||
|
description:
|
||
|
MaxShards is the maximum number of shards,
|
||
|
i.e. amount of concurrency.
|
||
|
type: integer
|
||
|
minBackoff:
|
||
|
description:
|
||
|
MinBackoff is the initial retry delay. Gets
|
||
|
doubled for every retry.
|
||
|
type: string
|
||
|
minShards:
|
||
|
description:
|
||
|
MinShards is the minimum number of shards,
|
||
|
i.e. amount of concurrency.
|
||
|
type: integer
|
||
|
retryOnRateLimit:
|
||
|
description:
|
||
|
Retry upon receiving a 429 status code from
|
||
|
the remote-write storage. This is experimental feature
|
||
|
and might change in the future.
|
||
|
type: boolean
|
||
|
type: object
|
||
|
remoteTimeout:
|
||
|
description: Timeout for requests to the remote write endpoint.
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
sendExemplars:
|
||
|
description:
|
||
|
"Enables sending of exemplars over remote write.
|
||
|
Note that exemplar-storage itself must be enabled using the
|
||
|
`spec.enableFeature` option for exemplars to be scraped in
|
||
|
the first place. \n It requires Prometheus >= v2.27.0."
|
||
|
type: boolean
|
||
|
sendNativeHistograms:
|
||
|
description:
|
||
|
"Enables sending of native histograms, also known
|
||
|
as sparse histograms over remote write. \n It requires Prometheus
|
||
|
>= v2.40.0."
|
||
|
type: boolean
|
||
|
sigv4:
|
||
|
description:
|
||
|
"Sigv4 allows to configures AWS's Signature Verification
|
||
|
4 for the URL. \n It requires Prometheus >= v2.26.0. \n Cannot
|
||
|
be set at the same time as `authorization`, `basicAuth`, `oauth2`,
|
||
|
or `azureAd`."
|
||
|
properties:
|
||
|
accessKey:
|
||
|
description:
|
||
|
AccessKey is the AWS API key. If not specified,
|
||
|
the environment variable `AWS_ACCESS_KEY_ID` is used.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
profile:
|
||
|
description: Profile is the named AWS profile used to authenticate.
|
||
|
type: string
|
||
|
region:
|
||
|
description:
|
||
|
Region is the AWS region. If blank, the region
|
||
|
from the default credentials chain used.
|
||
|
type: string
|
||
|
roleArn:
|
||
|
description: RoleArn is the named AWS profile used to authenticate.
|
||
|
type: string
|
||
|
secretKey:
|
||
|
description:
|
||
|
SecretKey is the AWS API secret. If not specified,
|
||
|
the environment variable `AWS_SECRET_ACCESS_KEY` is used.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
tlsConfig:
|
||
|
description: TLS Config to use for the URL.
|
||
|
properties:
|
||
|
ca:
|
||
|
description:
|
||
|
Certificate authority used when verifying server
|
||
|
certificates.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
caFile:
|
||
|
description:
|
||
|
Path to the CA cert in the Prometheus container
|
||
|
to use for the targets.
|
||
|
type: string
|
||
|
cert:
|
||
|
description: Client certificate to present when doing client-authentication.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
certFile:
|
||
|
description:
|
||
|
Path to the client cert file in the Prometheus
|
||
|
container for the targets.
|
||
|
type: string
|
||
|
insecureSkipVerify:
|
||
|
description: Disable target certificate validation.
|
||
|
type: boolean
|
||
|
keyFile:
|
||
|
description:
|
||
|
Path to the client key file in the Prometheus
|
||
|
container for the targets.
|
||
|
type: string
|
||
|
keySecret:
|
||
|
description:
|
||
|
Secret containing the client key file for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
serverName:
|
||
|
description: Used to verify the hostname for the targets.
|
||
|
type: string
|
||
|
type: object
|
||
|
url:
|
||
|
description: The URL of the endpoint to send samples to.
|
||
|
type: string
|
||
|
writeRelabelConfigs:
|
||
|
description: The list of remote write relabel configurations.
|
||
|
items:
|
||
|
description:
|
||
|
"RelabelConfig allows dynamic rewriting of the
|
||
|
label set for targets, alerts, scraped samples and remote
|
||
|
write samples. \n More info: https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config"
|
||
|
properties:
|
||
|
action:
|
||
|
default: replace
|
||
|
description:
|
||
|
"Action to perform based on the regex matching.
|
||
|
\n `Uppercase` and `Lowercase` actions require Prometheus
|
||
|
>= v2.36.0. `DropEqual` and `KeepEqual` actions require
|
||
|
Prometheus >= v2.41.0. \n Default: \"Replace\""
|
||
|
enum:
|
||
|
- replace
|
||
|
- Replace
|
||
|
- keep
|
||
|
- Keep
|
||
|
- drop
|
||
|
- Drop
|
||
|
- hashmod
|
||
|
- HashMod
|
||
|
- labelmap
|
||
|
- LabelMap
|
||
|
- labeldrop
|
||
|
- LabelDrop
|
||
|
- labelkeep
|
||
|
- LabelKeep
|
||
|
- lowercase
|
||
|
- Lowercase
|
||
|
- uppercase
|
||
|
- Uppercase
|
||
|
- keepequal
|
||
|
- KeepEqual
|
||
|
- dropequal
|
||
|
- DropEqual
|
||
|
type: string
|
||
|
modulus:
|
||
|
description:
|
||
|
"Modulus to take of the hash of the source
|
||
|
label values. \n Only applicable when the action is
|
||
|
`HashMod`."
|
||
|
format: int64
|
||
|
type: integer
|
||
|
regex:
|
||
|
description:
|
||
|
Regular expression against which the extracted
|
||
|
value is matched.
|
||
|
type: string
|
||
|
replacement:
|
||
|
description:
|
||
|
"Replacement value against which a Replace
|
||
|
action is performed if the regular expression matches.
|
||
|
\n Regex capture groups are available."
|
||
|
type: string
|
||
|
separator:
|
||
|
description:
|
||
|
Separator is the string between concatenated
|
||
|
SourceLabels.
|
||
|
type: string
|
||
|
sourceLabels:
|
||
|
description:
|
||
|
The source labels select values from existing
|
||
|
labels. Their content is concatenated using the configured
|
||
|
Separator and matched against the configured regular
|
||
|
expression.
|
||
|
items:
|
||
|
description:
|
||
|
LabelName is a valid Prometheus label name
|
||
|
which may only contain ASCII letters, numbers, as
|
||
|
well as underscores.
|
||
|
pattern: ^[a-zA-Z_][a-zA-Z0-9_]*$
|
||
|
type: string
|
||
|
type: array
|
||
|
targetLabel:
|
||
|
description:
|
||
|
"Label to which the resulting string is written
|
||
|
in a replacement. \n It is mandatory for `Replace`,
|
||
|
`HashMod`, `Lowercase`, `Uppercase`, `KeepEqual` and
|
||
|
`DropEqual` actions. \n Regex capture groups are available."
|
||
|
type: string
|
||
|
type: object
|
||
|
type: array
|
||
|
required:
|
||
|
- url
|
||
|
type: object
|
||
|
type: array
|
||
|
replicaExternalLabelName:
|
||
|
description:
|
||
|
"Name of Prometheus external label used to denote the
|
||
|
replica name. The external label will _not_ be added when the field
|
||
|
is set to the empty string (`\"\"`). \n Default: \"prometheus_replica\""
|
||
|
type: string
|
||
|
replicas:
|
||
|
description:
|
||
|
"Number of replicas of each shard to deploy for a Prometheus
|
||
|
deployment. `spec.replicas` multiplied by `spec.shards` is the total
|
||
|
number of Pods created. \n Default: 1"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
resources:
|
||
|
description:
|
||
|
Defines the resources requests and limits of the 'prometheus'
|
||
|
container.
|
||
|
properties:
|
||
|
claims:
|
||
|
description:
|
||
|
"Claims lists the names of resources, defined in
|
||
|
spec.resourceClaims, that are used by this container. \n This
|
||
|
is an alpha field and requires enabling the DynamicResourceAllocation
|
||
|
feature gate. \n This field is immutable. It can only be set
|
||
|
for containers."
|
||
|
items:
|
||
|
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-map-keys:
|
||
|
- name
|
||
|
x-kubernetes-list-type: map
|
||
|
limits:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"Limits describes the maximum amount of compute resources
|
||
|
allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
|
||
|
type: object
|
||
|
requests:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"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/"
|
||
|
type: object
|
||
|
type: object
|
||
|
retention:
|
||
|
description:
|
||
|
"How long to retain the Prometheus data. \n Default:
|
||
|
\"24h\" if `spec.retention` and `spec.retentionSize` are empty."
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
retentionSize:
|
||
|
description: Maximum number of bytes used by the Prometheus data.
|
||
|
pattern: (^0|([0-9]*[.])?[0-9]+((K|M|G|T|E|P)i?)?B)$
|
||
|
type: string
|
||
|
routePrefix:
|
||
|
description:
|
||
|
"The route prefix Prometheus registers HTTP handlers
|
||
|
for. \n This is useful when using `spec.externalURL`, and a proxy
|
||
|
is rewriting HTTP routes of a request, and the actual ExternalURL
|
||
|
is still true, but the server serves requests under a different
|
||
|
route prefix. For example for use with `kubectl proxy`."
|
||
|
type: string
|
||
|
ruleNamespaceSelector:
|
||
|
description:
|
||
|
Namespaces to match for PrometheusRule discovery. An
|
||
|
empty label selector matches all namespaces. A null label selector
|
||
|
matches the current namespace only.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label selector requirements.
|
||
|
The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a selector that
|
||
|
contains values, a key, and an operator that relates the key
|
||
|
and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the selector applies
|
||
|
to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship to
|
||
|
a set of values. Valid operators are In, NotIn, Exists
|
||
|
and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string values. If the
|
||
|
operator is In or NotIn, the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist, the values
|
||
|
array must be empty. This array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value} pairs. A single
|
||
|
{key,value} in the matchLabels map is equivalent to an element
|
||
|
of matchExpressions, whose key field is "key", the operator
|
||
|
is "In", and the values array contains only "value". The requirements
|
||
|
are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
ruleSelector:
|
||
|
description:
|
||
|
PrometheusRule objects to be selected for rule evaluation.
|
||
|
An empty label selector matches all objects. A null label selector
|
||
|
matches no objects.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label selector requirements.
|
||
|
The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a selector that
|
||
|
contains values, a key, and an operator that relates the key
|
||
|
and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the selector applies
|
||
|
to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship to
|
||
|
a set of values. Valid operators are In, NotIn, Exists
|
||
|
and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string values. If the
|
||
|
operator is In or NotIn, the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist, the values
|
||
|
array must be empty. This array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value} pairs. A single
|
||
|
{key,value} in the matchLabels map is equivalent to an element
|
||
|
of matchExpressions, whose key field is "key", the operator
|
||
|
is "In", and the values array contains only "value". The requirements
|
||
|
are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
rules:
|
||
|
description: Defines the configuration of the Prometheus rules' engine.
|
||
|
properties:
|
||
|
alert:
|
||
|
description:
|
||
|
"Defines the parameters of the Prometheus rules'
|
||
|
engine. \n Any update to these parameters trigger a restart
|
||
|
of the pods."
|
||
|
properties:
|
||
|
forGracePeriod:
|
||
|
description:
|
||
|
"Minimum duration between alert and restored
|
||
|
'for' state. \n This is maintained only for alerts with
|
||
|
a configured 'for' time greater than the grace period."
|
||
|
type: string
|
||
|
forOutageTolerance:
|
||
|
description:
|
||
|
Max time to tolerate prometheus outage for restoring
|
||
|
'for' state of alert.
|
||
|
type: string
|
||
|
resendDelay:
|
||
|
description:
|
||
|
Minimum amount of time to wait before resending
|
||
|
an alert to Alertmanager.
|
||
|
type: string
|
||
|
type: object
|
||
|
type: object
|
||
|
sampleLimit:
|
||
|
description:
|
||
|
SampleLimit defines per-scrape limit on number of scraped
|
||
|
samples that will be accepted. Only valid in Prometheus versions
|
||
|
2.45.0 and newer.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
scrapeConfigNamespaceSelector:
|
||
|
description:
|
||
|
Namespaces to match for ScrapeConfig discovery. An empty
|
||
|
label selector matches all namespaces. A null label selector matches
|
||
|
the current current namespace only.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label selector requirements.
|
||
|
The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a selector that
|
||
|
contains values, a key, and an operator that relates the key
|
||
|
and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the selector applies
|
||
|
to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship to
|
||
|
a set of values. Valid operators are In, NotIn, Exists
|
||
|
and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string values. If the
|
||
|
operator is In or NotIn, the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist, the values
|
||
|
array must be empty. This array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value} pairs. A single
|
||
|
{key,value} in the matchLabels map is equivalent to an element
|
||
|
of matchExpressions, whose key field is "key", the operator
|
||
|
is "In", and the values array contains only "value". The requirements
|
||
|
are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
scrapeConfigSelector:
|
||
|
description:
|
||
|
"*Experimental* ScrapeConfigs to be selected for target
|
||
|
discovery. An empty label selector matches all objects. A null label
|
||
|
selector matches no objects. \n If `spec.serviceMonitorSelector`,
|
||
|
`spec.podMonitorSelector`, `spec.probeSelector` and `spec.scrapeConfigSelector`
|
||
|
are null, the Prometheus configuration is unmanaged. The Prometheus
|
||
|
operator will ensure that the Prometheus configuration's Secret
|
||
|
exists, but it is the responsibility of the user to provide the
|
||
|
raw gzipped Prometheus configuration under the `prometheus.yaml.gz`
|
||
|
key. This behavior is *deprecated* and will be removed in the next
|
||
|
major version of the custom resource definition. It is recommended
|
||
|
to use `spec.additionalScrapeConfigs` instead."
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label selector requirements.
|
||
|
The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a selector that
|
||
|
contains values, a key, and an operator that relates the key
|
||
|
and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the selector applies
|
||
|
to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship to
|
||
|
a set of values. Valid operators are In, NotIn, Exists
|
||
|
and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string values. If the
|
||
|
operator is In or NotIn, the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist, the values
|
||
|
array must be empty. This array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value} pairs. A single
|
||
|
{key,value} in the matchLabels map is equivalent to an element
|
||
|
of matchExpressions, whose key field is "key", the operator
|
||
|
is "In", and the values array contains only "value". The requirements
|
||
|
are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
scrapeInterval:
|
||
|
default: 30s
|
||
|
description: "Interval between consecutive scrapes. \n Default: \"30s\""
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
scrapeTimeout:
|
||
|
description:
|
||
|
Number of seconds to wait until a scrape request times
|
||
|
out.
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
secrets:
|
||
|
description:
|
||
|
Secrets is a list of Secrets in the same namespace as
|
||
|
the Prometheus object, which shall be mounted into the Prometheus
|
||
|
Pods. Each Secret is added to the StatefulSet definition as a volume
|
||
|
named `secret-<secret-name>`. The Secrets are mounted into /etc/prometheus/secrets/<secret-name>
|
||
|
in the 'prometheus' container.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
securityContext:
|
||
|
description:
|
||
|
SecurityContext holds pod-level security attributes and
|
||
|
common container settings. This defaults to the default PodSecurityContext.
|
||
|
properties:
|
||
|
fsGroup:
|
||
|
description:
|
||
|
"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:
|
||
|
\n 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---- \n 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."
|
||
|
format: int64
|
||
|
type: integer
|
||
|
fsGroupChangePolicy:
|
||
|
description:
|
||
|
'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.'
|
||
|
type: string
|
||
|
runAsGroup:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
runAsNonRoot:
|
||
|
description:
|
||
|
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.
|
||
|
type: boolean
|
||
|
runAsUser:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
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.
|
||
|
properties:
|
||
|
level:
|
||
|
description:
|
||
|
Level is SELinux level label that applies to
|
||
|
the container.
|
||
|
type: string
|
||
|
role:
|
||
|
description:
|
||
|
Role is a SELinux role label that applies to
|
||
|
the container.
|
||
|
type: string
|
||
|
type:
|
||
|
description:
|
||
|
Type is a SELinux type label that applies to
|
||
|
the container.
|
||
|
type: string
|
||
|
user:
|
||
|
description:
|
||
|
User is a SELinux user label that applies to
|
||
|
the container.
|
||
|
type: string
|
||
|
type: object
|
||
|
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.
|
||
|
properties:
|
||
|
localhostProfile:
|
||
|
description:
|
||
|
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:
|
||
|
description:
|
||
|
"type indicates which kind of seccomp profile
|
||
|
will be applied. Valid options are: \n 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."
|
||
|
type: string
|
||
|
required:
|
||
|
- type
|
||
|
type: object
|
||
|
supplementalGroups:
|
||
|
description:
|
||
|
A list of groups applied to the first process run
|
||
|
in each container, in addition to the container's primary GID,
|
||
|
the fsGroup (if specified), and group memberships defined in
|
||
|
the container image for the uid of the container process. If
|
||
|
unspecified, no additional groups are added to any container.
|
||
|
Note that group memberships defined in the container image for
|
||
|
the uid of the container process are still effective, even if
|
||
|
they are not included in this list. Note that this field cannot
|
||
|
be set when spec.os.name is windows.
|
||
|
items:
|
||
|
format: int64
|
||
|
type: integer
|
||
|
type: array
|
||
|
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.
|
||
|
items:
|
||
|
description: Sysctl defines a kernel parameter to be set
|
||
|
properties:
|
||
|
name:
|
||
|
description: Name of a property to set
|
||
|
type: string
|
||
|
value:
|
||
|
description: Value of a property to set
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
- value
|
||
|
type: object
|
||
|
type: array
|
||
|
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.
|
||
|
properties:
|
||
|
gmsaCredentialSpec:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
gmsaCredentialSpecName:
|
||
|
description:
|
||
|
GMSACredentialSpecName is the name of the GMSA
|
||
|
credential spec to use.
|
||
|
type: string
|
||
|
hostProcess:
|
||
|
description:
|
||
|
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.
|
||
|
type: boolean
|
||
|
runAsUserName:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
type: object
|
||
|
type: object
|
||
|
serviceAccountName:
|
||
|
description:
|
||
|
ServiceAccountName is the name of the ServiceAccount
|
||
|
to use to run the Prometheus Pods.
|
||
|
type: string
|
||
|
serviceMonitorNamespaceSelector:
|
||
|
description:
|
||
|
Namespaces to match for ServicedMonitors discovery. An
|
||
|
empty label selector matches all namespaces. A null label selector
|
||
|
matches the current namespace only.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label selector requirements.
|
||
|
The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a selector that
|
||
|
contains values, a key, and an operator that relates the key
|
||
|
and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the selector applies
|
||
|
to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship to
|
||
|
a set of values. Valid operators are In, NotIn, Exists
|
||
|
and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string values. If the
|
||
|
operator is In or NotIn, the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist, the values
|
||
|
array must be empty. This array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value} pairs. A single
|
||
|
{key,value} in the matchLabels map is equivalent to an element
|
||
|
of matchExpressions, whose key field is "key", the operator
|
||
|
is "In", and the values array contains only "value". The requirements
|
||
|
are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
serviceMonitorSelector:
|
||
|
description:
|
||
|
"ServiceMonitors to be selected for target discovery.
|
||
|
An empty label selector matches all objects. A null label selector
|
||
|
matches no objects. \n If `spec.serviceMonitorSelector`, `spec.podMonitorSelector`,
|
||
|
`spec.probeSelector` and `spec.scrapeConfigSelector` are null, the
|
||
|
Prometheus configuration is unmanaged. The Prometheus operator will
|
||
|
ensure that the Prometheus configuration's Secret exists, but it
|
||
|
is the responsibility of the user to provide the raw gzipped Prometheus
|
||
|
configuration under the `prometheus.yaml.gz` key. This behavior
|
||
|
is *deprecated* and will be removed in the next major version of
|
||
|
the custom resource definition. It is recommended to use `spec.additionalScrapeConfigs`
|
||
|
instead."
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label selector requirements.
|
||
|
The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a selector that
|
||
|
contains values, a key, and an operator that relates the key
|
||
|
and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the selector applies
|
||
|
to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship to
|
||
|
a set of values. Valid operators are In, NotIn, Exists
|
||
|
and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string values. If the
|
||
|
operator is In or NotIn, the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist, the values
|
||
|
array must be empty. This array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value} pairs. A single
|
||
|
{key,value} in the matchLabels map is equivalent to an element
|
||
|
of matchExpressions, whose key field is "key", the operator
|
||
|
is "In", and the values array contains only "value". The requirements
|
||
|
are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
sha:
|
||
|
description:
|
||
|
"*Deprecated: use 'spec.image' instead. The image's
|
||
|
digest can be specified as part of the image name.*"
|
||
|
type: string
|
||
|
shards:
|
||
|
description:
|
||
|
"EXPERIMENTAL: Number of shards to distribute targets
|
||
|
onto. `spec.replicas` multiplied by `spec.shards` is the total number
|
||
|
of Pods created. \n Note that scaling down shards will not reshard
|
||
|
data onto remaining instances, it must be manually moved. Increasing
|
||
|
shards will not reshard data either but it will continue to be available
|
||
|
from the same instances. To query globally, use Thanos sidecar and
|
||
|
Thanos querier or remote write data to a central location. \n Sharding
|
||
|
is performed on the content of the `__address__` target meta-label
|
||
|
for PodMonitors and ServiceMonitors and `__param_target__` for Probes.
|
||
|
\n Default: 1"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
storage:
|
||
|
description: Storage defines the storage used by Prometheus.
|
||
|
properties:
|
||
|
disableMountSubPath:
|
||
|
description:
|
||
|
"*Deprecated: subPath usage will be removed in a
|
||
|
future release.*"
|
||
|
type: boolean
|
||
|
emptyDir:
|
||
|
description:
|
||
|
"EmptyDirVolumeSource to be used by the StatefulSet.
|
||
|
If specified, it takes precedence over `ephemeral` and `volumeClaimTemplate`.
|
||
|
More info: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir"
|
||
|
properties:
|
||
|
medium:
|
||
|
description:
|
||
|
'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'
|
||
|
type: string
|
||
|
sizeLimit:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
"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"
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
type: object
|
||
|
ephemeral:
|
||
|
description:
|
||
|
"EphemeralVolumeSource 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"
|
||
|
properties:
|
||
|
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). \n 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. \n This field is read-only and no changes
|
||
|
will be made by Kubernetes to the PVC after it has been
|
||
|
created. \n Required, must not be nil."
|
||
|
properties:
|
||
|
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:
|
||
|
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.
|
||
|
properties:
|
||
|
accessModes:
|
||
|
description:
|
||
|
"accessModes contains the desired access
|
||
|
modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
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."
|
||
|
properties:
|
||
|
apiGroup:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
kind:
|
||
|
description:
|
||
|
Kind is the type of resource being
|
||
|
referenced
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
Name is the name of resource being
|
||
|
referenced
|
||
|
type: string
|
||
|
required:
|
||
|
- kind
|
||
|
- name
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
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."
|
||
|
properties:
|
||
|
apiGroup:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
kind:
|
||
|
description:
|
||
|
Kind is the type of resource being
|
||
|
referenced
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
Name is the name of resource being
|
||
|
referenced
|
||
|
type: string
|
||
|
namespace:
|
||
|
description:
|
||
|
Namespace is the namespace of resource
|
||
|
being referenced 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.
|
||
|
type: string
|
||
|
required:
|
||
|
- kind
|
||
|
- name
|
||
|
type: object
|
||
|
resources:
|
||
|
description:
|
||
|
"resources represents the minimum resources
|
||
|
the volume should have. If RecoverVolumeExpansionFailure
|
||
|
feature is enabled 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"
|
||
|
properties:
|
||
|
claims:
|
||
|
description:
|
||
|
"Claims lists the names of resources,
|
||
|
defined in spec.resourceClaims, that are used
|
||
|
by this container. \n This is an alpha field
|
||
|
and requires enabling the DynamicResourceAllocation
|
||
|
feature gate. \n This field is immutable. It
|
||
|
can only be set for containers."
|
||
|
items:
|
||
|
description:
|
||
|
ResourceClaim references one entry
|
||
|
in PodSpec.ResourceClaims.
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-map-keys:
|
||
|
- name
|
||
|
x-kubernetes-list-type: map
|
||
|
limits:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"Limits describes the maximum amount
|
||
|
of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
|
||
|
type: object
|
||
|
requests:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"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/"
|
||
|
type: object
|
||
|
type: object
|
||
|
selector:
|
||
|
description:
|
||
|
selector is a label query over volumes
|
||
|
to consider for binding.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label
|
||
|
selector requirements. The requirements are
|
||
|
ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is
|
||
|
a selector that contains values, a key, and
|
||
|
an operator that relates the key and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the
|
||
|
selector applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's
|
||
|
relationship to a set of values. Valid
|
||
|
operators are In, NotIn, Exists and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string
|
||
|
values. If the operator is In or NotIn,
|
||
|
the values array must be non-empty. If
|
||
|
the operator is Exists or DoesNotExist,
|
||
|
the values array must be empty. This array
|
||
|
is replaced during a strategic merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value}
|
||
|
pairs. A single {key,value} in the matchLabels
|
||
|
map is equivalent to an element of matchExpressions,
|
||
|
whose key field is "key", the operator is "In",
|
||
|
and the values array contains only "value".
|
||
|
The requirements are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
storageClassName:
|
||
|
description:
|
||
|
"storageClassName is the name of the
|
||
|
StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"
|
||
|
type: string
|
||
|
volumeMode:
|
||
|
description:
|
||
|
volumeMode defines what type of volume
|
||
|
is required by the claim. Value of Filesystem is
|
||
|
implied when not included in claim spec.
|
||
|
type: string
|
||
|
volumeName:
|
||
|
description:
|
||
|
volumeName is the binding reference to
|
||
|
the PersistentVolume backing this claim.
|
||
|
type: string
|
||
|
type: object
|
||
|
required:
|
||
|
- spec
|
||
|
type: object
|
||
|
type: object
|
||
|
volumeClaimTemplate:
|
||
|
description:
|
||
|
Defines the PVC spec to be used by the Prometheus
|
||
|
StatefulSets. The easiest way to use a volume that cannot be
|
||
|
automatically provisioned is to use a label selector alongside
|
||
|
manually created PersistentVolumes.
|
||
|
properties:
|
||
|
apiVersion:
|
||
|
description:
|
||
|
"APIVersion defines the versioned schema of this
|
||
|
representation of an object. Servers should convert recognized
|
||
|
schemas to the latest internal value, and may reject unrecognized
|
||
|
values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources"
|
||
|
type: string
|
||
|
kind:
|
||
|
description:
|
||
|
"Kind is a string value representing the REST
|
||
|
resource this object represents. Servers may infer this
|
||
|
from the endpoint the client submits requests to. Cannot
|
||
|
be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds"
|
||
|
type: string
|
||
|
metadata:
|
||
|
description:
|
||
|
EmbeddedMetadata contains metadata relevant to
|
||
|
an EmbeddedResource.
|
||
|
properties:
|
||
|
annotations:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
"Annotations is an unstructured key value
|
||
|
map stored with a resource that may be set by external
|
||
|
tools to store and retrieve arbitrary metadata. They
|
||
|
are not queryable and should be preserved when modifying
|
||
|
objects. More info: http://kubernetes.io/docs/user-guide/annotations"
|
||
|
type: object
|
||
|
labels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
"Map of string keys and values that can be
|
||
|
used to organize and categorize (scope and select) objects.
|
||
|
May match selectors of replication controllers and services.
|
||
|
More info: http://kubernetes.io/docs/user-guide/labels"
|
||
|
type: object
|
||
|
name:
|
||
|
description:
|
||
|
"Name must be unique within a namespace.
|
||
|
Is required when creating resources, although some resources
|
||
|
may allow a client to request the generation of an appropriate
|
||
|
name automatically. Name is primarily intended for creation
|
||
|
idempotence and configuration definition. Cannot be
|
||
|
updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
|
||
|
type: string
|
||
|
type: object
|
||
|
spec:
|
||
|
description:
|
||
|
"Defines the desired characteristics of a volume
|
||
|
requested by a pod author. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"
|
||
|
properties:
|
||
|
accessModes:
|
||
|
description:
|
||
|
"accessModes contains the desired access
|
||
|
modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
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."
|
||
|
properties:
|
||
|
apiGroup:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
kind:
|
||
|
description: Kind is the type of resource being referenced
|
||
|
type: string
|
||
|
name:
|
||
|
description: Name is the name of resource being referenced
|
||
|
type: string
|
||
|
required:
|
||
|
- kind
|
||
|
- name
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
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."
|
||
|
properties:
|
||
|
apiGroup:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
kind:
|
||
|
description: Kind is the type of resource being referenced
|
||
|
type: string
|
||
|
name:
|
||
|
description: Name is the name of resource being referenced
|
||
|
type: string
|
||
|
namespace:
|
||
|
description:
|
||
|
Namespace is the namespace of resource
|
||
|
being referenced 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.
|
||
|
type: string
|
||
|
required:
|
||
|
- kind
|
||
|
- name
|
||
|
type: object
|
||
|
resources:
|
||
|
description:
|
||
|
"resources represents the minimum resources
|
||
|
the volume should have. If RecoverVolumeExpansionFailure
|
||
|
feature is enabled 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"
|
||
|
properties:
|
||
|
claims:
|
||
|
description:
|
||
|
"Claims lists the names of resources,
|
||
|
defined in spec.resourceClaims, that are used by
|
||
|
this container. \n This is an alpha field and requires
|
||
|
enabling the DynamicResourceAllocation feature gate.
|
||
|
\n This field is immutable. It can only be set for
|
||
|
containers."
|
||
|
items:
|
||
|
description:
|
||
|
ResourceClaim references one entry
|
||
|
in PodSpec.ResourceClaims.
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-map-keys:
|
||
|
- name
|
||
|
x-kubernetes-list-type: map
|
||
|
limits:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"Limits describes the maximum amount
|
||
|
of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
|
||
|
type: object
|
||
|
requests:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"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/"
|
||
|
type: object
|
||
|
type: object
|
||
|
selector:
|
||
|
description:
|
||
|
selector is a label query over volumes to
|
||
|
consider for binding.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label selector
|
||
|
requirements. The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a selector
|
||
|
that contains values, a key, and an operator that
|
||
|
relates the key and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the selector
|
||
|
applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship
|
||
|
to a set of values. Valid operators are In,
|
||
|
NotIn, Exists and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string values.
|
||
|
If the operator is In or NotIn, the values
|
||
|
array must be non-empty. If the operator is
|
||
|
Exists or DoesNotExist, the values array must
|
||
|
be empty. This array is replaced during a
|
||
|
strategic merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value} pairs.
|
||
|
A single {key,value} in the matchLabels map is equivalent
|
||
|
to an element of matchExpressions, whose key field
|
||
|
is "key", the operator is "In", and the values array
|
||
|
contains only "value". The requirements are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
storageClassName:
|
||
|
description:
|
||
|
"storageClassName is the name of the StorageClass
|
||
|
required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"
|
||
|
type: string
|
||
|
volumeMode:
|
||
|
description:
|
||
|
volumeMode defines what type of volume is
|
||
|
required by the claim. Value of Filesystem is implied
|
||
|
when not included in claim spec.
|
||
|
type: string
|
||
|
volumeName:
|
||
|
description:
|
||
|
volumeName is the binding reference to the
|
||
|
PersistentVolume backing this claim.
|
||
|
type: string
|
||
|
type: object
|
||
|
status:
|
||
|
description: "*Deprecated: this field is never set.*"
|
||
|
properties:
|
||
|
accessModes:
|
||
|
description:
|
||
|
"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"
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
allocatedResourceStatuses:
|
||
|
additionalProperties:
|
||
|
description:
|
||
|
When a controller receives persistentvolume
|
||
|
claim update with ClaimResourceStatus for a resource
|
||
|
that it does not recognizes, then it should ignore
|
||
|
that update and let other controllers handle it.
|
||
|
type: string
|
||
|
description:
|
||
|
"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. \n 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. \n 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. \n This is an alpha field and requires enabling
|
||
|
RecoverVolumeExpansionFailure feature."
|
||
|
type: object
|
||
|
x-kubernetes-map-type: granular
|
||
|
allocatedResources:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"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. \n 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. \n 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.
|
||
|
\n This is an alpha field and requires enabling RecoverVolumeExpansionFailure
|
||
|
feature."
|
||
|
type: object
|
||
|
capacity:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
capacity represents the actual resources
|
||
|
of the underlying volume.
|
||
|
type: object
|
||
|
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 'ResizeStarted'.
|
||
|
items:
|
||
|
description:
|
||
|
PersistentVolumeClaimCondition contains
|
||
|
details about state of pvc
|
||
|
properties:
|
||
|
lastProbeTime:
|
||
|
description:
|
||
|
lastProbeTime is the time we probed
|
||
|
the condition.
|
||
|
format: date-time
|
||
|
type: string
|
||
|
lastTransitionTime:
|
||
|
description:
|
||
|
lastTransitionTime is the time the
|
||
|
condition transitioned from one status to another.
|
||
|
format: date-time
|
||
|
type: string
|
||
|
message:
|
||
|
description:
|
||
|
message is the human-readable message
|
||
|
indicating details about last transition.
|
||
|
type: string
|
||
|
reason:
|
||
|
description:
|
||
|
reason is a unique, this should be
|
||
|
a short, machine understandable string that gives
|
||
|
the reason for condition's last transition. If
|
||
|
it reports "ResizeStarted" that means the underlying
|
||
|
persistent volume is being resized.
|
||
|
type: string
|
||
|
status:
|
||
|
type: string
|
||
|
type:
|
||
|
description:
|
||
|
PersistentVolumeClaimConditionType
|
||
|
is a valid value of PersistentVolumeClaimCondition.Type
|
||
|
type: string
|
||
|
required:
|
||
|
- status
|
||
|
- type
|
||
|
type: object
|
||
|
type: array
|
||
|
phase:
|
||
|
description: phase represents the current phase of PersistentVolumeClaim.
|
||
|
type: string
|
||
|
type: object
|
||
|
type: object
|
||
|
type: object
|
||
|
tag:
|
||
|
description:
|
||
|
"*Deprecated: use 'spec.image' instead. The image's
|
||
|
tag can be specified as part of the image name.*"
|
||
|
type: string
|
||
|
targetLimit:
|
||
|
description:
|
||
|
TargetLimit defines a limit on the number of scraped
|
||
|
targets that will be accepted. Only valid in Prometheus versions
|
||
|
2.45.0 and newer.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
thanos:
|
||
|
description:
|
||
|
"Defines the configuration of the optional Thanos sidecar.
|
||
|
\n This section is experimental, it may change significantly without
|
||
|
deprecation notice in any release."
|
||
|
properties:
|
||
|
additionalArgs:
|
||
|
description:
|
||
|
AdditionalArgs allows setting additional arguments
|
||
|
for the Thanos container. The arguments are passed as-is to
|
||
|
the Thanos container which may cause issues if they are invalid
|
||
|
or not supported the given Thanos version. In case of an argument
|
||
|
conflict (e.g. an argument which is already set by the operator
|
||
|
itself) or when providing an invalid argument, the reconciliation
|
||
|
will fail and an error will be logged.
|
||
|
items:
|
||
|
description: Argument as part of the AdditionalArgs list.
|
||
|
properties:
|
||
|
name:
|
||
|
description: Name of the argument, e.g. "scrape.discovery-reload-interval".
|
||
|
minLength: 1
|
||
|
type: string
|
||
|
value:
|
||
|
description:
|
||
|
Argument value, e.g. 30s. Can be empty for
|
||
|
name-only arguments (e.g. --storage.tsdb.no-lockfile)
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
baseImage:
|
||
|
description: "*Deprecated: use 'image' instead.*"
|
||
|
type: string
|
||
|
blockSize:
|
||
|
default: 2h
|
||
|
description:
|
||
|
"BlockDuration controls the size of TSDB blocks produced
|
||
|
by Prometheus. The default value is 2h to match the upstream
|
||
|
Prometheus defaults. \n WARNING: Changing the block duration
|
||
|
can impact the performance and efficiency of the entire Prometheus/Thanos
|
||
|
stack due to how it interacts with memory and Thanos compactors.
|
||
|
It is recommended to keep this value set to a multiple of 120
|
||
|
times your longest scrape or rule interval. For example, 30s
|
||
|
* 120 = 1h."
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
getConfigInterval:
|
||
|
description: How often to retrieve the Prometheus configuration.
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
getConfigTimeout:
|
||
|
description:
|
||
|
Maximum time to wait when retrieving the Prometheus
|
||
|
configuration.
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
grpcListenLocal:
|
||
|
description:
|
||
|
"When true, the Thanos sidecar listens on the loopback
|
||
|
interface instead of the Pod IP's address for the gRPC endpoints.
|
||
|
\n It has no effect if `listenLocal` is true."
|
||
|
type: boolean
|
||
|
grpcServerTlsConfig:
|
||
|
description:
|
||
|
"Configures the TLS parameters for the gRPC server
|
||
|
providing the StoreAPI. \n Note: Currently only the `caFile`,
|
||
|
`certFile`, and `keyFile` fields are supported."
|
||
|
properties:
|
||
|
ca:
|
||
|
description:
|
||
|
Certificate authority used when verifying server
|
||
|
certificates.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
caFile:
|
||
|
description:
|
||
|
Path to the CA cert in the Prometheus container
|
||
|
to use for the targets.
|
||
|
type: string
|
||
|
cert:
|
||
|
description: Client certificate to present when doing client-authentication.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
certFile:
|
||
|
description:
|
||
|
Path to the client cert file in the Prometheus
|
||
|
container for the targets.
|
||
|
type: string
|
||
|
insecureSkipVerify:
|
||
|
description: Disable target certificate validation.
|
||
|
type: boolean
|
||
|
keyFile:
|
||
|
description:
|
||
|
Path to the client key file in the Prometheus
|
||
|
container for the targets.
|
||
|
type: string
|
||
|
keySecret:
|
||
|
description:
|
||
|
Secret containing the client key file for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
serverName:
|
||
|
description: Used to verify the hostname for the targets.
|
||
|
type: string
|
||
|
type: object
|
||
|
httpListenLocal:
|
||
|
description:
|
||
|
"When true, the Thanos sidecar listens on the loopback
|
||
|
interface instead of the Pod IP's address for the HTTP endpoints.
|
||
|
\n It has no effect if `listenLocal` is true."
|
||
|
type: boolean
|
||
|
image:
|
||
|
description:
|
||
|
"Container image name for Thanos. If specified, it
|
||
|
takes precedence over the `spec.thanos.baseImage`, `spec.thanos.tag`
|
||
|
and `spec.thanos.sha` fields. \n Specifying `spec.thanos.version`
|
||
|
is still necessary to ensure the Prometheus Operator knows which
|
||
|
version of Thanos is being configured. \n If neither `spec.thanos.image`
|
||
|
nor `spec.thanos.baseImage` are defined, the operator will use
|
||
|
the latest upstream version of Thanos available at the time
|
||
|
when the operator was released."
|
||
|
type: string
|
||
|
listenLocal:
|
||
|
description:
|
||
|
"*Deprecated: use `grpcListenLocal` and `httpListenLocal`
|
||
|
instead.*"
|
||
|
type: boolean
|
||
|
logFormat:
|
||
|
description: Log format for the Thanos sidecar.
|
||
|
enum:
|
||
|
- ""
|
||
|
- logfmt
|
||
|
- json
|
||
|
type: string
|
||
|
logLevel:
|
||
|
description: Log level for the Thanos sidecar.
|
||
|
enum:
|
||
|
- ""
|
||
|
- debug
|
||
|
- info
|
||
|
- warn
|
||
|
- error
|
||
|
type: string
|
||
|
minTime:
|
||
|
description:
|
||
|
Defines the start of time range limit served by the
|
||
|
Thanos sidecar's StoreAPI. The field's value should be a constant
|
||
|
time in RFC3339 format or a time duration relative to current
|
||
|
time, such as -1d or 2h45m. Valid duration units are ms, s,
|
||
|
m, h, d, w, y.
|
||
|
type: string
|
||
|
objectStorageConfig:
|
||
|
description:
|
||
|
"Defines the Thanos sidecar's configuration to upload
|
||
|
TSDB blocks to object storage. \n More info: https://thanos.io/tip/thanos/storage.md/
|
||
|
\n objectStorageConfigFile takes precedence over this field."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must be
|
||
|
a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must be
|
||
|
defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
objectStorageConfigFile:
|
||
|
description:
|
||
|
"Defines the Thanos sidecar's configuration file
|
||
|
to upload TSDB blocks to object storage. \n More info: https://thanos.io/tip/thanos/storage.md/
|
||
|
\n This field takes precedence over objectStorageConfig."
|
||
|
type: string
|
||
|
readyTimeout:
|
||
|
description:
|
||
|
ReadyTimeout is the maximum time that the Thanos
|
||
|
sidecar will wait for Prometheus to start.
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
resources:
|
||
|
description:
|
||
|
Defines the resources requests and limits of the
|
||
|
Thanos sidecar.
|
||
|
properties:
|
||
|
claims:
|
||
|
description:
|
||
|
"Claims lists the names of resources, defined
|
||
|
in spec.resourceClaims, that are used by this container.
|
||
|
\n This is an alpha field and requires enabling the DynamicResourceAllocation
|
||
|
feature gate. \n This field is immutable. It can only be
|
||
|
set for containers."
|
||
|
items:
|
||
|
description: ResourceClaim references one entry in PodSpec.ResourceClaims.
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-map-keys:
|
||
|
- name
|
||
|
x-kubernetes-list-type: map
|
||
|
limits:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"Limits describes the maximum amount of compute
|
||
|
resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
|
||
|
type: object
|
||
|
requests:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"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/"
|
||
|
type: object
|
||
|
type: object
|
||
|
sha:
|
||
|
description:
|
||
|
"*Deprecated: use 'image' instead. The image digest
|
||
|
can be specified as part of the image name.*"
|
||
|
type: string
|
||
|
tag:
|
||
|
description:
|
||
|
"*Deprecated: use 'image' instead. The image's
|
||
|
tag can be specified as part of the image name.*"
|
||
|
type: string
|
||
|
tracingConfig:
|
||
|
description:
|
||
|
"Defines the tracing configuration for the Thanos
|
||
|
sidecar. \n More info: https://thanos.io/tip/thanos/tracing.md/
|
||
|
\n This is an experimental feature, it may change in any upcoming
|
||
|
release in a breaking way. \n tracingConfigFile takes precedence
|
||
|
over this field."
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must be
|
||
|
a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must be
|
||
|
defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
tracingConfigFile:
|
||
|
description:
|
||
|
"Defines the tracing configuration file for the Thanos
|
||
|
sidecar. \n More info: https://thanos.io/tip/thanos/tracing.md/
|
||
|
\n This is an experimental feature, it may change in any upcoming
|
||
|
release in a breaking way. \n This field takes precedence over
|
||
|
tracingConfig."
|
||
|
type: string
|
||
|
version:
|
||
|
description:
|
||
|
"Version of Thanos being deployed. The operator uses
|
||
|
this information to generate the Prometheus StatefulSet + configuration
|
||
|
files. \n If not specified, the operator assumes the latest
|
||
|
upstream release of Thanos available at the time when the version
|
||
|
of the operator was released."
|
||
|
type: string
|
||
|
volumeMounts:
|
||
|
description:
|
||
|
VolumeMounts allows configuration of additional VolumeMounts
|
||
|
for Thanos. VolumeMounts specified will be appended to other
|
||
|
VolumeMounts in the 'thanos-sidecar' container.
|
||
|
items:
|
||
|
description:
|
||
|
VolumeMount describes a mounting of a Volume within
|
||
|
a container.
|
||
|
properties:
|
||
|
mountPath:
|
||
|
description:
|
||
|
Path within the container at which the volume
|
||
|
should be mounted. Must not contain ':'.
|
||
|
type: string
|
||
|
mountPropagation:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
name:
|
||
|
description: This must match the Name of a Volume.
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
Mounted read-only if true, read-write otherwise
|
||
|
(false or unspecified). Defaults to false.
|
||
|
type: boolean
|
||
|
subPath:
|
||
|
description:
|
||
|
Path within the volume from which the container's
|
||
|
volume should be mounted. Defaults to "" (volume's root).
|
||
|
type: string
|
||
|
subPathExpr:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- mountPath
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
type: object
|
||
|
tolerations:
|
||
|
description: Defines the Pods' tolerations if specified.
|
||
|
items:
|
||
|
description:
|
||
|
The pod this Toleration is attached to tolerates any
|
||
|
taint that matches the triple <key,value,effect> using the matching
|
||
|
operator <operator>.
|
||
|
properties:
|
||
|
effect:
|
||
|
description:
|
||
|
Effect indicates the taint effect to match. Empty
|
||
|
means match all taint effects. When specified, allowed values
|
||
|
are NoSchedule, PreferNoSchedule and NoExecute.
|
||
|
type: string
|
||
|
key:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
Operator represents a key's relationship to the
|
||
|
value. Valid operators are Exists and Equal. Defaults to Equal.
|
||
|
Exists is equivalent to wildcard for value, so that a pod
|
||
|
can tolerate all taints of a particular category.
|
||
|
type: string
|
||
|
tolerationSeconds:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
value:
|
||
|
description:
|
||
|
Value is the taint value the toleration matches
|
||
|
to. If the operator is Exists, the value should be empty,
|
||
|
otherwise just a regular string.
|
||
|
type: string
|
||
|
type: object
|
||
|
type: array
|
||
|
topologySpreadConstraints:
|
||
|
description: Defines the pod's topology spread constraints if specified.
|
||
|
items:
|
||
|
description:
|
||
|
TopologySpreadConstraint specifies how to spread matching
|
||
|
pods among the given topology.
|
||
|
properties:
|
||
|
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.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label selector
|
||
|
requirements. The requirements are ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement is a selector
|
||
|
that contains values, a key, and an operator that relates
|
||
|
the key and values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that the selector
|
||
|
applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's relationship
|
||
|
to a set of values. Valid operators are In, NotIn,
|
||
|
Exists and DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string values.
|
||
|
If the operator is In or NotIn, the values array
|
||
|
must be non-empty. If the operator is Exists or
|
||
|
DoesNotExist, the values array must be empty. This
|
||
|
array is replaced during a strategic merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value} pairs.
|
||
|
A single {key,value} in the matchLabels map is equivalent
|
||
|
to an element of matchExpressions, whose key field is
|
||
|
"key", the operator is "In", and the values array contains
|
||
|
only "value". The requirements are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
matchLabelKeys:
|
||
|
description:
|
||
|
"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. \n This is a
|
||
|
beta field and requires the MatchLabelKeysInPodTopologySpread
|
||
|
feature gate to be enabled (enabled by default)."
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
x-kubernetes-list-type: atomic
|
||
|
maxSkew:
|
||
|
description:
|
||
|
"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."
|
||
|
format: int32
|
||
|
type: integer
|
||
|
minDomains:
|
||
|
description:
|
||
|
"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. \n 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. \n This is a beta field
|
||
|
and requires the MinDomainsInPodTopologySpread feature gate
|
||
|
to be enabled (enabled by default)."
|
||
|
format: int32
|
||
|
type: integer
|
||
|
nodeAffinityPolicy:
|
||
|
description:
|
||
|
"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. \n
|
||
|
If this value is nil, the behavior is equivalent to the Honor
|
||
|
policy. This is a beta-level feature default enabled by the
|
||
|
NodeInclusionPolicyInPodTopologySpread feature flag."
|
||
|
type: string
|
||
|
nodeTaintsPolicy:
|
||
|
description:
|
||
|
"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.
|
||
|
\n If this value is nil, the behavior is equivalent to the
|
||
|
Ignore policy. This is a beta-level feature default enabled
|
||
|
by the NodeInclusionPolicyInPodTopologySpread feature flag."
|
||
|
type: string
|
||
|
topologyKey:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
whenUnsatisfiable:
|
||
|
description:
|
||
|
'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.'
|
||
|
type: string
|
||
|
required:
|
||
|
- maxSkew
|
||
|
- topologyKey
|
||
|
- whenUnsatisfiable
|
||
|
type: object
|
||
|
type: array
|
||
|
tracingConfig:
|
||
|
description:
|
||
|
"EXPERIMENTAL: TracingConfig configures tracing in Prometheus.
|
||
|
This is an experimental feature, it may change in any upcoming release
|
||
|
in a breaking way."
|
||
|
properties:
|
||
|
clientType:
|
||
|
description:
|
||
|
Client used to export the traces. Supported values
|
||
|
are `http` or `grpc`.
|
||
|
enum:
|
||
|
- http
|
||
|
- grpc
|
||
|
type: string
|
||
|
compression:
|
||
|
description:
|
||
|
Compression key for supported compression types.
|
||
|
The only supported value is `gzip`.
|
||
|
enum:
|
||
|
- gzip
|
||
|
type: string
|
||
|
endpoint:
|
||
|
description:
|
||
|
Endpoint to send the traces to. Should be provided
|
||
|
in format <host>:<port>.
|
||
|
minLength: 1
|
||
|
type: string
|
||
|
headers:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
Key-value pairs to be used as headers associated
|
||
|
with gRPC or HTTP requests.
|
||
|
type: object
|
||
|
insecure:
|
||
|
description: If disabled, the client will use a secure connection.
|
||
|
type: boolean
|
||
|
samplingFraction:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
Sets the probability a given trace will be sampled.
|
||
|
Must be a float from 0 through 1.
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
timeout:
|
||
|
description:
|
||
|
Maximum time the exporter will wait for each batch
|
||
|
export.
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
tlsConfig:
|
||
|
description: TLS Config to use when sending traces.
|
||
|
properties:
|
||
|
ca:
|
||
|
description:
|
||
|
Certificate authority used when verifying server
|
||
|
certificates.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
caFile:
|
||
|
description:
|
||
|
Path to the CA cert in the Prometheus container
|
||
|
to use for the targets.
|
||
|
type: string
|
||
|
cert:
|
||
|
description: Client certificate to present when doing client-authentication.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
certFile:
|
||
|
description:
|
||
|
Path to the client cert file in the Prometheus
|
||
|
container for the targets.
|
||
|
type: string
|
||
|
insecureSkipVerify:
|
||
|
description: Disable target certificate validation.
|
||
|
type: boolean
|
||
|
keyFile:
|
||
|
description:
|
||
|
Path to the client key file in the Prometheus
|
||
|
container for the targets.
|
||
|
type: string
|
||
|
keySecret:
|
||
|
description:
|
||
|
Secret containing the client key file for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
serverName:
|
||
|
description: Used to verify the hostname for the targets.
|
||
|
type: string
|
||
|
type: object
|
||
|
required:
|
||
|
- endpoint
|
||
|
type: object
|
||
|
tsdb:
|
||
|
description:
|
||
|
Defines the runtime reloadable configuration of the timeseries
|
||
|
database (TSDB).
|
||
|
properties:
|
||
|
outOfOrderTimeWindow:
|
||
|
description:
|
||
|
"Configures how old an out-of-order/out-of-bounds
|
||
|
sample can be with respect to the TSDB max time. \n An out-of-order/out-of-bounds
|
||
|
sample is ingested into the TSDB as long as the timestamp of
|
||
|
the sample is >= (TSDB.MaxTime - outOfOrderTimeWindow). \n Out
|
||
|
of order ingestion is an experimental feature. \n It requires
|
||
|
Prometheus >= v2.39.0."
|
||
|
pattern: ^(0|(([0-9]+)y)?(([0-9]+)w)?(([0-9]+)d)?(([0-9]+)h)?(([0-9]+)m)?(([0-9]+)s)?(([0-9]+)ms)?)$
|
||
|
type: string
|
||
|
type: object
|
||
|
version:
|
||
|
description:
|
||
|
"Version of Prometheus being deployed. The operator uses
|
||
|
this information to generate the Prometheus StatefulSet + configuration
|
||
|
files. \n If not specified, the operator assumes the latest upstream
|
||
|
version of Prometheus available at the time when the version of
|
||
|
the operator was released."
|
||
|
type: string
|
||
|
volumeMounts:
|
||
|
description:
|
||
|
"VolumeMounts allows the configuration of additional
|
||
|
VolumeMounts. \n VolumeMounts will be appended to other VolumeMounts
|
||
|
in the 'prometheus' container, that are generated as a result of
|
||
|
StorageSpec objects."
|
||
|
items:
|
||
|
description:
|
||
|
VolumeMount describes a mounting of a Volume within
|
||
|
a container.
|
||
|
properties:
|
||
|
mountPath:
|
||
|
description:
|
||
|
Path within the container at which the volume should
|
||
|
be mounted. Must not contain ':'.
|
||
|
type: string
|
||
|
mountPropagation:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
name:
|
||
|
description: This must match the Name of a Volume.
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
Mounted read-only if true, read-write otherwise
|
||
|
(false or unspecified). Defaults to false.
|
||
|
type: boolean
|
||
|
subPath:
|
||
|
description:
|
||
|
Path within the volume from which the container's
|
||
|
volume should be mounted. Defaults to "" (volume's root).
|
||
|
type: string
|
||
|
subPathExpr:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- mountPath
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
volumes:
|
||
|
description:
|
||
|
Volumes allows the configuration of additional volumes
|
||
|
on the output StatefulSet definition. Volumes specified will be
|
||
|
appended to other volumes that are generated as a result of StorageSpec
|
||
|
objects.
|
||
|
items:
|
||
|
description:
|
||
|
Volume represents a named volume in a pod that may
|
||
|
be accessed by any container in the pod.
|
||
|
properties:
|
||
|
awsElasticBlockStore:
|
||
|
description:
|
||
|
"awsElasticBlockStore represents an AWS 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#awselasticblockstore"
|
||
|
properties:
|
||
|
fsType:
|
||
|
description:
|
||
|
'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
|
||
|
TODO: how do we prevent errors in the filesystem from
|
||
|
compromising the machine'
|
||
|
type: string
|
||
|
partition:
|
||
|
description:
|
||
|
'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).'
|
||
|
format: int32
|
||
|
type: integer
|
||
|
readOnly:
|
||
|
description:
|
||
|
"readOnly value true will force the readOnly
|
||
|
setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"
|
||
|
type: boolean
|
||
|
volumeID:
|
||
|
description:
|
||
|
"volumeID is unique ID of the persistent disk
|
||
|
resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore"
|
||
|
type: string
|
||
|
required:
|
||
|
- volumeID
|
||
|
type: object
|
||
|
azureDisk:
|
||
|
description:
|
||
|
azureDisk represents an Azure Data Disk mount on
|
||
|
the host and bind mount to the pod.
|
||
|
properties:
|
||
|
cachingMode:
|
||
|
description:
|
||
|
"cachingMode is the Host Caching mode: None,
|
||
|
Read Only, Read Write."
|
||
|
type: string
|
||
|
diskName:
|
||
|
description:
|
||
|
diskName is the Name of the data disk in the
|
||
|
blob storage
|
||
|
type: string
|
||
|
diskURI:
|
||
|
description:
|
||
|
diskURI is the URI of data disk in the blob
|
||
|
storage
|
||
|
type: string
|
||
|
fsType:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
kind:
|
||
|
description:
|
||
|
"kind expected values are Shared: multiple
|
||
|
blob disks per storage account Dedicated: single blob
|
||
|
disk per storage account Managed: azure managed data
|
||
|
disk (only in managed availability set). defaults to shared"
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
readOnly Defaults to false (read/write). ReadOnly
|
||
|
here will force the ReadOnly setting in VolumeMounts.
|
||
|
type: boolean
|
||
|
required:
|
||
|
- diskName
|
||
|
- diskURI
|
||
|
type: object
|
||
|
azureFile:
|
||
|
description:
|
||
|
azureFile represents an Azure File Service mount
|
||
|
on the host and bind mount to the pod.
|
||
|
properties:
|
||
|
readOnly:
|
||
|
description:
|
||
|
readOnly defaults to false (read/write). ReadOnly
|
||
|
here will force the ReadOnly setting in VolumeMounts.
|
||
|
type: boolean
|
||
|
secretName:
|
||
|
description:
|
||
|
secretName is the name of secret that contains
|
||
|
Azure Storage Account Name and Key
|
||
|
type: string
|
||
|
shareName:
|
||
|
description: shareName is the azure share Name
|
||
|
type: string
|
||
|
required:
|
||
|
- secretName
|
||
|
- shareName
|
||
|
type: object
|
||
|
cephfs:
|
||
|
description:
|
||
|
cephFS represents a Ceph FS mount on the host that
|
||
|
shares a pod's lifetime
|
||
|
properties:
|
||
|
monitors:
|
||
|
description:
|
||
|
"monitors is Required: Monitors is a collection
|
||
|
of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it"
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
path:
|
||
|
description:
|
||
|
"path is Optional: Used as the mounted root,
|
||
|
rather than the full Ceph tree, default is /"
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
"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"
|
||
|
type: boolean
|
||
|
secretFile:
|
||
|
description:
|
||
|
"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"
|
||
|
type: string
|
||
|
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"
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
user:
|
||
|
description:
|
||
|
"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"
|
||
|
type: string
|
||
|
required:
|
||
|
- monitors
|
||
|
type: object
|
||
|
cinder:
|
||
|
description:
|
||
|
"cinder represents a cinder volume attached and
|
||
|
mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md"
|
||
|
properties:
|
||
|
fsType:
|
||
|
description:
|
||
|
'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'
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
"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"
|
||
|
type: boolean
|
||
|
secretRef:
|
||
|
description:
|
||
|
"secretRef is optional: points to a secret
|
||
|
object containing parameters used to connect to OpenStack."
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
volumeID:
|
||
|
description:
|
||
|
"volumeID used to identify the volume in cinder.
|
||
|
More info: https://examples.k8s.io/mysql-cinder-pd/README.md"
|
||
|
type: string
|
||
|
required:
|
||
|
- volumeID
|
||
|
type: object
|
||
|
configMap:
|
||
|
description:
|
||
|
configMap represents a configMap that should populate
|
||
|
this volume
|
||
|
properties:
|
||
|
defaultMode:
|
||
|
description:
|
||
|
"defaultMode is optional: mode bits used to
|
||
|
set permissions on created files by default. 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."
|
||
|
format: int32
|
||
|
type: integer
|
||
|
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 '..'.
|
||
|
items:
|
||
|
description: Maps a string key to a path within a volume.
|
||
|
properties:
|
||
|
key:
|
||
|
description: key is the key to project.
|
||
|
type: string
|
||
|
mode:
|
||
|
description:
|
||
|
"mode is Optional: mode bits used to
|
||
|
set permissions on this file. 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."
|
||
|
format: int32
|
||
|
type: integer
|
||
|
path:
|
||
|
description:
|
||
|
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 '..'.
|
||
|
type: string
|
||
|
required:
|
||
|
- key
|
||
|
- path
|
||
|
type: object
|
||
|
type: array
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
optional specify whether the ConfigMap or its
|
||
|
keys must be defined
|
||
|
type: boolean
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
csi:
|
||
|
description:
|
||
|
csi (Container Storage Interface) represents ephemeral
|
||
|
storage that is handled by certain external CSI drivers (Beta
|
||
|
feature).
|
||
|
properties:
|
||
|
driver:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
fsType:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
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.
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
readOnly:
|
||
|
description:
|
||
|
readOnly specifies a read-only configuration
|
||
|
for the volume. Defaults to false (read/write).
|
||
|
type: boolean
|
||
|
volumeAttributes:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
volumeAttributes stores driver-specific properties
|
||
|
that are passed to the CSI driver. Consult your driver's
|
||
|
documentation for supported values.
|
||
|
type: object
|
||
|
required:
|
||
|
- driver
|
||
|
type: object
|
||
|
downwardAPI:
|
||
|
description:
|
||
|
downwardAPI represents downward API about the pod
|
||
|
that should populate this volume
|
||
|
properties:
|
||
|
defaultMode:
|
||
|
description:
|
||
|
"Optional: mode bits to use on created files
|
||
|
by default. Must be a 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."
|
||
|
format: int32
|
||
|
type: integer
|
||
|
items:
|
||
|
description: Items is a list of downward API volume file
|
||
|
items:
|
||
|
description:
|
||
|
DownwardAPIVolumeFile represents information
|
||
|
to create the file containing the pod field
|
||
|
properties:
|
||
|
fieldRef:
|
||
|
description:
|
||
|
"Required: Selects a field of the pod:
|
||
|
only annotations, labels, name and namespace are
|
||
|
supported."
|
||
|
properties:
|
||
|
apiVersion:
|
||
|
description:
|
||
|
Version of the schema the FieldPath
|
||
|
is written in terms of, defaults to "v1".
|
||
|
type: string
|
||
|
fieldPath:
|
||
|
description:
|
||
|
Path of the field to select in the
|
||
|
specified API version.
|
||
|
type: string
|
||
|
required:
|
||
|
- fieldPath
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
mode:
|
||
|
description:
|
||
|
"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."
|
||
|
format: int32
|
||
|
type: integer
|
||
|
path:
|
||
|
description:
|
||
|
"Required: Path is the relative path
|
||
|
name of the file to be created. Must not be absolute
|
||
|
or contain the '..' path. Must be utf-8 encoded.
|
||
|
The first item of the relative path must not start
|
||
|
with '..'"
|
||
|
type: string
|
||
|
resourceFieldRef:
|
||
|
description:
|
||
|
"Selects a resource of the container:
|
||
|
only resources limits and requests (limits.cpu,
|
||
|
limits.memory, requests.cpu and requests.memory)
|
||
|
are currently supported."
|
||
|
properties:
|
||
|
containerName:
|
||
|
description:
|
||
|
"Container name: required for volumes,
|
||
|
optional for env vars"
|
||
|
type: string
|
||
|
divisor:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
Specifies the output format of the
|
||
|
exposed resources, defaults to "1"
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
resource:
|
||
|
description: "Required: resource to select"
|
||
|
type: string
|
||
|
required:
|
||
|
- resource
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
required:
|
||
|
- path
|
||
|
type: object
|
||
|
type: array
|
||
|
type: object
|
||
|
emptyDir:
|
||
|
description:
|
||
|
"emptyDir represents a temporary directory that
|
||
|
shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir"
|
||
|
properties:
|
||
|
medium:
|
||
|
description:
|
||
|
'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'
|
||
|
type: string
|
||
|
sizeLimit:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
"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"
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
type: object
|
||
|
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. \n 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). \n Use PersistentVolumeClaim
|
||
|
or one of the vendor-specific APIs for volumes that persist
|
||
|
for longer than the lifecycle of an individual pod. \n 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. \n A pod can use both types of
|
||
|
ephemeral volumes and persistent volumes at the same time."
|
||
|
properties:
|
||
|
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). \n
|
||
|
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. \n This
|
||
|
field is read-only and no changes will be made by Kubernetes
|
||
|
to the PVC after it has been created. \n Required, must
|
||
|
not be nil."
|
||
|
properties:
|
||
|
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:
|
||
|
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.
|
||
|
properties:
|
||
|
accessModes:
|
||
|
description:
|
||
|
"accessModes contains the desired access
|
||
|
modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1"
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
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."
|
||
|
properties:
|
||
|
apiGroup:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
kind:
|
||
|
description:
|
||
|
Kind is the type of resource being
|
||
|
referenced
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
Name is the name of resource being
|
||
|
referenced
|
||
|
type: string
|
||
|
required:
|
||
|
- kind
|
||
|
- name
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
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."
|
||
|
properties:
|
||
|
apiGroup:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
kind:
|
||
|
description:
|
||
|
Kind is the type of resource being
|
||
|
referenced
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
Name is the name of resource being
|
||
|
referenced
|
||
|
type: string
|
||
|
namespace:
|
||
|
description:
|
||
|
Namespace is the namespace of resource
|
||
|
being referenced 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.
|
||
|
type: string
|
||
|
required:
|
||
|
- kind
|
||
|
- name
|
||
|
type: object
|
||
|
resources:
|
||
|
description:
|
||
|
"resources represents the minimum resources
|
||
|
the volume should have. If RecoverVolumeExpansionFailure
|
||
|
feature is enabled 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"
|
||
|
properties:
|
||
|
claims:
|
||
|
description:
|
||
|
"Claims lists the names of resources,
|
||
|
defined in spec.resourceClaims, that are used
|
||
|
by this container. \n This is an alpha field
|
||
|
and requires enabling the DynamicResourceAllocation
|
||
|
feature gate. \n This field is immutable.
|
||
|
It can only be set for containers."
|
||
|
items:
|
||
|
description:
|
||
|
ResourceClaim references one
|
||
|
entry in PodSpec.ResourceClaims.
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-map-keys:
|
||
|
- name
|
||
|
x-kubernetes-list-type: map
|
||
|
limits:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"Limits describes the maximum amount
|
||
|
of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/"
|
||
|
type: object
|
||
|
requests:
|
||
|
additionalProperties:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
description:
|
||
|
"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/"
|
||
|
type: object
|
||
|
type: object
|
||
|
selector:
|
||
|
description:
|
||
|
selector is a label query over volumes
|
||
|
to consider for binding.
|
||
|
properties:
|
||
|
matchExpressions:
|
||
|
description:
|
||
|
matchExpressions is a list of label
|
||
|
selector requirements. The requirements are
|
||
|
ANDed.
|
||
|
items:
|
||
|
description:
|
||
|
A label selector requirement
|
||
|
is a selector that contains values, a key,
|
||
|
and an operator that relates the key and
|
||
|
values.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
key is the label key that
|
||
|
the selector applies to.
|
||
|
type: string
|
||
|
operator:
|
||
|
description:
|
||
|
operator represents a key's
|
||
|
relationship to a set of values. Valid
|
||
|
operators are In, NotIn, Exists and
|
||
|
DoesNotExist.
|
||
|
type: string
|
||
|
values:
|
||
|
description:
|
||
|
values is an array of string
|
||
|
values. If the operator is In or NotIn,
|
||
|
the values array must be non-empty.
|
||
|
If the operator is Exists or DoesNotExist,
|
||
|
the values array must be empty. This
|
||
|
array is replaced during a strategic
|
||
|
merge patch.
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
required:
|
||
|
- key
|
||
|
- operator
|
||
|
type: object
|
||
|
type: array
|
||
|
matchLabels:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
matchLabels is a map of {key,value}
|
||
|
pairs. A single {key,value} in the matchLabels
|
||
|
map is equivalent to an element of matchExpressions,
|
||
|
whose key field is "key", the operator is
|
||
|
"In", and the values array contains only "value".
|
||
|
The requirements are ANDed.
|
||
|
type: object
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
storageClassName:
|
||
|
description:
|
||
|
"storageClassName is the name of the
|
||
|
StorageClass required by the claim. More info:
|
||
|
https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1"
|
||
|
type: string
|
||
|
volumeMode:
|
||
|
description:
|
||
|
volumeMode defines what type of volume
|
||
|
is required by the claim. Value of Filesystem
|
||
|
is implied when not included in claim spec.
|
||
|
type: string
|
||
|
volumeName:
|
||
|
description:
|
||
|
volumeName is the binding reference
|
||
|
to the PersistentVolume backing this claim.
|
||
|
type: string
|
||
|
type: object
|
||
|
required:
|
||
|
- spec
|
||
|
type: object
|
||
|
type: object
|
||
|
fc:
|
||
|
description:
|
||
|
fc represents a Fibre Channel resource that is
|
||
|
attached to a kubelet's host machine and then exposed to the
|
||
|
pod.
|
||
|
properties:
|
||
|
fsType:
|
||
|
description:
|
||
|
'fsType is the filesystem type to mount. Must
|
||
|
be a filesystem type supported by the host operating system.
|
||
|
Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4"
|
||
|
if unspecified. TODO: how do we prevent errors in the
|
||
|
filesystem from compromising the machine'
|
||
|
type: string
|
||
|
lun:
|
||
|
description: "lun is Optional: FC target lun number"
|
||
|
format: int32
|
||
|
type: integer
|
||
|
readOnly:
|
||
|
description:
|
||
|
"readOnly is Optional: Defaults to false (read/write).
|
||
|
ReadOnly here will force the ReadOnly setting in VolumeMounts."
|
||
|
type: boolean
|
||
|
targetWWNs:
|
||
|
description:
|
||
|
"targetWWNs is Optional: FC target worldwide
|
||
|
names (WWNs)"
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
wwids:
|
||
|
description:
|
||
|
"wwids Optional: FC volume world wide identifiers
|
||
|
(wwids) Either wwids or combination of targetWWNs and
|
||
|
lun must be set, but not both simultaneously."
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
type: object
|
||
|
flexVolume:
|
||
|
description:
|
||
|
flexVolume represents a generic volume resource
|
||
|
that is provisioned/attached using an exec based plugin.
|
||
|
properties:
|
||
|
driver:
|
||
|
description:
|
||
|
driver is the name of the driver to use for
|
||
|
this volume.
|
||
|
type: string
|
||
|
fsType:
|
||
|
description:
|
||
|
fsType is the filesystem type to mount. Must
|
||
|
be a filesystem type supported by the host operating system.
|
||
|
Ex. "ext4", "xfs", "ntfs". The default filesystem depends
|
||
|
on FlexVolume script.
|
||
|
type: string
|
||
|
options:
|
||
|
additionalProperties:
|
||
|
type: string
|
||
|
description:
|
||
|
"options is Optional: this field holds extra
|
||
|
command options if any."
|
||
|
type: object
|
||
|
readOnly:
|
||
|
description:
|
||
|
"readOnly is Optional: defaults to false (read/write).
|
||
|
ReadOnly here will force the ReadOnly setting in VolumeMounts."
|
||
|
type: boolean
|
||
|
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."
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
required:
|
||
|
- driver
|
||
|
type: object
|
||
|
flocker:
|
||
|
description:
|
||
|
flocker represents a Flocker volume attached to
|
||
|
a kubelet's host machine. This depends on the Flocker control
|
||
|
service being running
|
||
|
properties:
|
||
|
datasetName:
|
||
|
description:
|
||
|
datasetName is Name of the dataset stored as
|
||
|
metadata -> name on the dataset for Flocker should be
|
||
|
considered as deprecated
|
||
|
type: string
|
||
|
datasetUUID:
|
||
|
description:
|
||
|
datasetUUID is the UUID of the dataset. This
|
||
|
is unique identifier of a Flocker dataset
|
||
|
type: string
|
||
|
type: object
|
||
|
gcePersistentDisk:
|
||
|
description:
|
||
|
"gcePersistentDisk represents a GCE 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#gcepersistentdisk"
|
||
|
properties:
|
||
|
fsType:
|
||
|
description:
|
||
|
'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
|
||
|
TODO: how do we prevent errors in the filesystem from
|
||
|
compromising the machine'
|
||
|
type: string
|
||
|
partition:
|
||
|
description:
|
||
|
'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'
|
||
|
format: int32
|
||
|
type: integer
|
||
|
pdName:
|
||
|
description:
|
||
|
"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"
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
"readOnly here will force the ReadOnly setting
|
||
|
in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk"
|
||
|
type: boolean
|
||
|
required:
|
||
|
- pdName
|
||
|
type: object
|
||
|
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."
|
||
|
properties:
|
||
|
directory:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
repository:
|
||
|
description: repository is the URL
|
||
|
type: string
|
||
|
revision:
|
||
|
description:
|
||
|
revision is the commit hash for the specified
|
||
|
revision.
|
||
|
type: string
|
||
|
required:
|
||
|
- repository
|
||
|
type: object
|
||
|
glusterfs:
|
||
|
description:
|
||
|
"glusterfs represents a Glusterfs mount on the
|
||
|
host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md"
|
||
|
properties:
|
||
|
endpoints:
|
||
|
description:
|
||
|
"endpoints is the endpoint name that details
|
||
|
Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"
|
||
|
type: string
|
||
|
path:
|
||
|
description:
|
||
|
"path is the Glusterfs volume path. More info:
|
||
|
https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
"readOnly here will force the Glusterfs volume
|
||
|
to be mounted with read-only permissions. Defaults to
|
||
|
false. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod"
|
||
|
type: boolean
|
||
|
required:
|
||
|
- endpoints
|
||
|
- path
|
||
|
type: object
|
||
|
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
|
||
|
--- TODO(jonesdl) We need to restrict who can use host directory
|
||
|
mounts and who can/can not mount host directories as read/write."
|
||
|
properties:
|
||
|
path:
|
||
|
description:
|
||
|
"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:
|
||
|
description:
|
||
|
'type for HostPath Volume Defaults to "" More
|
||
|
info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath'
|
||
|
type: string
|
||
|
required:
|
||
|
- path
|
||
|
type: object
|
||
|
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://examples.k8s.io/volumes/iscsi/README.md"
|
||
|
properties:
|
||
|
chapAuthDiscovery:
|
||
|
description:
|
||
|
chapAuthDiscovery defines whether support iSCSI
|
||
|
Discovery CHAP authentication
|
||
|
type: boolean
|
||
|
chapAuthSession:
|
||
|
description:
|
||
|
chapAuthSession defines whether support iSCSI
|
||
|
Session CHAP authentication
|
||
|
type: boolean
|
||
|
fsType:
|
||
|
description:
|
||
|
'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
|
||
|
TODO: how do we prevent errors in the filesystem from
|
||
|
compromising the machine'
|
||
|
type: string
|
||
|
initiatorName:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
iqn:
|
||
|
description: iqn is the target iSCSI Qualified Name.
|
||
|
type: string
|
||
|
iscsiInterface:
|
||
|
description:
|
||
|
iscsiInterface is the interface Name that uses
|
||
|
an iSCSI transport. Defaults to 'default' (tcp).
|
||
|
type: string
|
||
|
lun:
|
||
|
description: lun represents iSCSI Target Lun number.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
portals:
|
||
|
description:
|
||
|
portals is the iSCSI Target Portal List. The
|
||
|
portal is either an IP or ip_addr:port if the port is
|
||
|
other than default (typically TCP ports 860 and 3260).
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
readOnly:
|
||
|
description:
|
||
|
readOnly here will force the ReadOnly setting
|
||
|
in VolumeMounts. Defaults to false.
|
||
|
type: boolean
|
||
|
secretRef:
|
||
|
description:
|
||
|
secretRef is the CHAP Secret for iSCSI target
|
||
|
and initiator authentication
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
targetPortal:
|
||
|
description:
|
||
|
targetPortal is iSCSI Target Portal. The Portal
|
||
|
is either an IP or ip_addr:port if the port is other than
|
||
|
default (typically TCP ports 860 and 3260).
|
||
|
type: string
|
||
|
required:
|
||
|
- iqn
|
||
|
- lun
|
||
|
- targetPortal
|
||
|
type: object
|
||
|
name:
|
||
|
description:
|
||
|
"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"
|
||
|
type: string
|
||
|
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"
|
||
|
properties:
|
||
|
path:
|
||
|
description:
|
||
|
"path that is exported by the NFS server. More
|
||
|
info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
"readOnly here will force the NFS export to
|
||
|
be mounted with read-only permissions. Defaults to false.
|
||
|
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"
|
||
|
type: boolean
|
||
|
server:
|
||
|
description:
|
||
|
"server is the hostname or IP address of the
|
||
|
NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs"
|
||
|
type: string
|
||
|
required:
|
||
|
- path
|
||
|
- server
|
||
|
type: object
|
||
|
persistentVolumeClaim:
|
||
|
description:
|
||
|
"persistentVolumeClaimVolumeSource represents a
|
||
|
reference to a PersistentVolumeClaim in the same namespace.
|
||
|
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"
|
||
|
properties:
|
||
|
claimName:
|
||
|
description:
|
||
|
"claimName is the name of a PersistentVolumeClaim
|
||
|
in the same namespace as the pod using this volume. More
|
||
|
info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims"
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
readOnly Will force the ReadOnly setting in
|
||
|
VolumeMounts. Default false.
|
||
|
type: boolean
|
||
|
required:
|
||
|
- claimName
|
||
|
type: object
|
||
|
photonPersistentDisk:
|
||
|
description:
|
||
|
photonPersistentDisk represents a PhotonController
|
||
|
persistent disk attached and mounted on kubelets host machine
|
||
|
properties:
|
||
|
fsType:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
pdID:
|
||
|
description:
|
||
|
pdID is the ID that identifies Photon Controller
|
||
|
persistent disk
|
||
|
type: string
|
||
|
required:
|
||
|
- pdID
|
||
|
type: object
|
||
|
portworxVolume:
|
||
|
description:
|
||
|
portworxVolume represents a portworx volume attached
|
||
|
and mounted on kubelets host machine
|
||
|
properties:
|
||
|
fsType:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
readOnly defaults to false (read/write). ReadOnly
|
||
|
here will force the ReadOnly setting in VolumeMounts.
|
||
|
type: boolean
|
||
|
volumeID:
|
||
|
description: volumeID uniquely identifies a Portworx volume
|
||
|
type: string
|
||
|
required:
|
||
|
- volumeID
|
||
|
type: object
|
||
|
projected:
|
||
|
description:
|
||
|
projected items for all in one resources secrets,
|
||
|
configmaps, and downward API
|
||
|
properties:
|
||
|
defaultMode:
|
||
|
description:
|
||
|
defaultMode are the mode bits used to set permissions
|
||
|
on created files by default. 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.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
sources:
|
||
|
description: sources is the list of volume projections
|
||
|
items:
|
||
|
description:
|
||
|
Projection that may be projected along with
|
||
|
other supported volume types
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
configMap information about the configMap
|
||
|
data to project
|
||
|
properties:
|
||
|
items:
|
||
|
description:
|
||
|
items if unspecified, each key-value
|
||
|
pair in the Data field of the referenced 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:
|
||
|
description:
|
||
|
Maps a string key to a path within
|
||
|
a volume.
|
||
|
properties:
|
||
|
key:
|
||
|
description: key is the key to project.
|
||
|
type: string
|
||
|
mode:
|
||
|
description:
|
||
|
"mode is Optional: mode bits
|
||
|
used to set permissions on this file.
|
||
|
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."
|
||
|
format: int32
|
||
|
type: integer
|
||
|
path:
|
||
|
description:
|
||
|
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 '..'.
|
||
|
type: string
|
||
|
required:
|
||
|
- key
|
||
|
- path
|
||
|
type: object
|
||
|
type: array
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info:
|
||
|
https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
optional specify whether the ConfigMap
|
||
|
or its keys must be defined
|
||
|
type: boolean
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
downwardAPI:
|
||
|
description:
|
||
|
downwardAPI information about the downwardAPI
|
||
|
data to project
|
||
|
properties:
|
||
|
items:
|
||
|
description:
|
||
|
Items is a list of DownwardAPIVolume
|
||
|
file
|
||
|
items:
|
||
|
description:
|
||
|
DownwardAPIVolumeFile represents
|
||
|
information to create the file containing
|
||
|
the pod field
|
||
|
properties:
|
||
|
fieldRef:
|
||
|
description:
|
||
|
"Required: Selects a field
|
||
|
of the pod: only annotations, labels,
|
||
|
name and namespace are supported."
|
||
|
properties:
|
||
|
apiVersion:
|
||
|
description:
|
||
|
Version of the schema the
|
||
|
FieldPath is written in terms of,
|
||
|
defaults to "v1".
|
||
|
type: string
|
||
|
fieldPath:
|
||
|
description:
|
||
|
Path of the field to select
|
||
|
in the specified API version.
|
||
|
type: string
|
||
|
required:
|
||
|
- fieldPath
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
mode:
|
||
|
description:
|
||
|
"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."
|
||
|
format: int32
|
||
|
type: integer
|
||
|
path:
|
||
|
description:
|
||
|
"Required: Path is the relative
|
||
|
path name of the file to be created. Must
|
||
|
not be absolute or contain the '..'
|
||
|
path. Must be utf-8 encoded. The first
|
||
|
item of the relative path must not start
|
||
|
with '..'"
|
||
|
type: string
|
||
|
resourceFieldRef:
|
||
|
description:
|
||
|
"Selects a resource of the
|
||
|
container: only resources limits and requests
|
||
|
(limits.cpu, limits.memory, requests.cpu
|
||
|
and requests.memory) are currently supported."
|
||
|
properties:
|
||
|
containerName:
|
||
|
description:
|
||
|
"Container name: required
|
||
|
for volumes, optional for env vars"
|
||
|
type: string
|
||
|
divisor:
|
||
|
anyOf:
|
||
|
- type: integer
|
||
|
- type: string
|
||
|
description:
|
||
|
Specifies the output format
|
||
|
of the exposed resources, defaults
|
||
|
to "1"
|
||
|
pattern: ^(\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))(([KMGTPE]i)|[numkMGTPE]|([eE](\+|-)?(([0-9]+(\.[0-9]*)?)|(\.[0-9]+))))?$
|
||
|
x-kubernetes-int-or-string: true
|
||
|
resource:
|
||
|
description:
|
||
|
"Required: resource to
|
||
|
select"
|
||
|
type: string
|
||
|
required:
|
||
|
- resource
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
required:
|
||
|
- path
|
||
|
type: object
|
||
|
type: array
|
||
|
type: object
|
||
|
secret:
|
||
|
description:
|
||
|
secret information about the secret data
|
||
|
to project
|
||
|
properties:
|
||
|
items:
|
||
|
description:
|
||
|
items if unspecified, each key-value
|
||
|
pair in the Data field of the referenced 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:
|
||
|
description:
|
||
|
Maps a string key to a path within
|
||
|
a volume.
|
||
|
properties:
|
||
|
key:
|
||
|
description: key is the key to project.
|
||
|
type: string
|
||
|
mode:
|
||
|
description:
|
||
|
"mode is Optional: mode bits
|
||
|
used to set permissions on this file.
|
||
|
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."
|
||
|
format: int32
|
||
|
type: integer
|
||
|
path:
|
||
|
description:
|
||
|
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 '..'.
|
||
|
type: string
|
||
|
required:
|
||
|
- key
|
||
|
- path
|
||
|
type: object
|
||
|
type: array
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info:
|
||
|
https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
optional field specify whether the
|
||
|
Secret or its key must be defined
|
||
|
type: boolean
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
serviceAccountToken:
|
||
|
description:
|
||
|
serviceAccountToken is information about
|
||
|
the serviceAccountToken data to project
|
||
|
properties:
|
||
|
audience:
|
||
|
description:
|
||
|
audience is the intended audience
|
||
|
of the token. A recipient of a token 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.
|
||
|
type: string
|
||
|
expirationSeconds:
|
||
|
description:
|
||
|
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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
path:
|
||
|
description:
|
||
|
path is the path relative to the
|
||
|
mount point of the file to project the token
|
||
|
into.
|
||
|
type: string
|
||
|
required:
|
||
|
- path
|
||
|
type: object
|
||
|
type: object
|
||
|
type: array
|
||
|
type: object
|
||
|
quobyte:
|
||
|
description:
|
||
|
quobyte represents a Quobyte mount on the host
|
||
|
that shares a pod's lifetime
|
||
|
properties:
|
||
|
group:
|
||
|
description:
|
||
|
group to map volume access to Default is no
|
||
|
group
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
readOnly here will force the Quobyte volume
|
||
|
to be mounted with read-only permissions. Defaults to
|
||
|
false.
|
||
|
type: boolean
|
||
|
registry:
|
||
|
description:
|
||
|
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
|
||
|
type: string
|
||
|
tenant:
|
||
|
description:
|
||
|
tenant owning the given Quobyte volume in the
|
||
|
Backend Used with dynamically provisioned Quobyte volumes,
|
||
|
value is set by the plugin
|
||
|
type: string
|
||
|
user:
|
||
|
description:
|
||
|
user to map volume access to Defaults to serivceaccount
|
||
|
user
|
||
|
type: string
|
||
|
volume:
|
||
|
description:
|
||
|
volume is a string that references an already
|
||
|
created Quobyte volume by name.
|
||
|
type: string
|
||
|
required:
|
||
|
- registry
|
||
|
- volume
|
||
|
type: object
|
||
|
rbd:
|
||
|
description:
|
||
|
"rbd represents a Rados Block Device mount on the
|
||
|
host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/rbd/README.md"
|
||
|
properties:
|
||
|
fsType:
|
||
|
description:
|
||
|
'fsType is the filesystem type of the volume
|
||
|
that you want to mount. 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
|
||
|
TODO: how do we prevent errors in the filesystem from
|
||
|
compromising the machine'
|
||
|
type: string
|
||
|
image:
|
||
|
description:
|
||
|
"image is the rados image name. More info:
|
||
|
https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"
|
||
|
type: string
|
||
|
keyring:
|
||
|
description:
|
||
|
"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"
|
||
|
type: string
|
||
|
monitors:
|
||
|
description:
|
||
|
"monitors is a collection of Ceph monitors.
|
||
|
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
pool:
|
||
|
description:
|
||
|
"pool is the rados pool name. Default is rbd.
|
||
|
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
"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"
|
||
|
type: boolean
|
||
|
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"
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
user:
|
||
|
description:
|
||
|
"user is the rados user name. Default is admin.
|
||
|
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it"
|
||
|
type: string
|
||
|
required:
|
||
|
- image
|
||
|
- monitors
|
||
|
type: object
|
||
|
scaleIO:
|
||
|
description:
|
||
|
scaleIO represents a ScaleIO persistent volume
|
||
|
attached and mounted on Kubernetes nodes.
|
||
|
properties:
|
||
|
fsType:
|
||
|
description:
|
||
|
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".
|
||
|
type: string
|
||
|
gateway:
|
||
|
description:
|
||
|
gateway is the host address of the ScaleIO
|
||
|
API Gateway.
|
||
|
type: string
|
||
|
protectionDomain:
|
||
|
description:
|
||
|
protectionDomain is the name of the ScaleIO
|
||
|
Protection Domain for the configured storage.
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
readOnly Defaults to false (read/write). ReadOnly
|
||
|
here will force the ReadOnly setting in VolumeMounts.
|
||
|
type: boolean
|
||
|
secretRef:
|
||
|
description:
|
||
|
secretRef references to the secret for ScaleIO
|
||
|
user and other sensitive information. If this is not provided,
|
||
|
Login operation will fail.
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
sslEnabled:
|
||
|
description:
|
||
|
sslEnabled Flag enable/disable SSL communication
|
||
|
with Gateway, default false
|
||
|
type: boolean
|
||
|
storageMode:
|
||
|
description:
|
||
|
storageMode indicates whether the storage for
|
||
|
a volume should be ThickProvisioned or ThinProvisioned.
|
||
|
Default is ThinProvisioned.
|
||
|
type: string
|
||
|
storagePool:
|
||
|
description:
|
||
|
storagePool is the ScaleIO Storage Pool associated
|
||
|
with the protection domain.
|
||
|
type: string
|
||
|
system:
|
||
|
description:
|
||
|
system is the name of the storage system as
|
||
|
configured in ScaleIO.
|
||
|
type: string
|
||
|
volumeName:
|
||
|
description:
|
||
|
volumeName is the name of a volume already
|
||
|
created in the ScaleIO system that is associated with
|
||
|
this volume source.
|
||
|
type: string
|
||
|
required:
|
||
|
- gateway
|
||
|
- secretRef
|
||
|
- system
|
||
|
type: object
|
||
|
secret:
|
||
|
description:
|
||
|
"secret represents a secret that should populate
|
||
|
this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"
|
||
|
properties:
|
||
|
defaultMode:
|
||
|
description:
|
||
|
"defaultMode is Optional: mode bits used to
|
||
|
set permissions on created files by default. 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."
|
||
|
format: int32
|
||
|
type: integer
|
||
|
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 '..'.
|
||
|
items:
|
||
|
description: Maps a string key to a path within a volume.
|
||
|
properties:
|
||
|
key:
|
||
|
description: key is the key to project.
|
||
|
type: string
|
||
|
mode:
|
||
|
description:
|
||
|
"mode is Optional: mode bits used to
|
||
|
set permissions on this file. 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."
|
||
|
format: int32
|
||
|
type: integer
|
||
|
path:
|
||
|
description:
|
||
|
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 '..'.
|
||
|
type: string
|
||
|
required:
|
||
|
- key
|
||
|
- path
|
||
|
type: object
|
||
|
type: array
|
||
|
optional:
|
||
|
description:
|
||
|
optional field specify whether the Secret or
|
||
|
its keys must be defined
|
||
|
type: boolean
|
||
|
secretName:
|
||
|
description:
|
||
|
"secretName is the name of the secret in the
|
||
|
pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret"
|
||
|
type: string
|
||
|
type: object
|
||
|
storageos:
|
||
|
description:
|
||
|
storageOS represents a StorageOS volume attached
|
||
|
and mounted on Kubernetes nodes.
|
||
|
properties:
|
||
|
fsType:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
readOnly:
|
||
|
description:
|
||
|
readOnly defaults to false (read/write). ReadOnly
|
||
|
here will force the ReadOnly setting in VolumeMounts.
|
||
|
type: boolean
|
||
|
secretRef:
|
||
|
description:
|
||
|
secretRef specifies the secret to use for obtaining
|
||
|
the StorageOS API credentials. If not specified, default
|
||
|
values will be attempted.
|
||
|
properties:
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
volumeName:
|
||
|
description:
|
||
|
volumeName is the human-readable name of the
|
||
|
StorageOS volume. Volume names are only unique within
|
||
|
a namespace.
|
||
|
type: string
|
||
|
volumeNamespace:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
type: object
|
||
|
vsphereVolume:
|
||
|
description:
|
||
|
vsphereVolume represents a vSphere volume attached
|
||
|
and mounted on kubelets host machine
|
||
|
properties:
|
||
|
fsType:
|
||
|
description:
|
||
|
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.
|
||
|
type: string
|
||
|
storagePolicyID:
|
||
|
description:
|
||
|
storagePolicyID is the storage Policy Based
|
||
|
Management (SPBM) profile ID associated with the StoragePolicyName.
|
||
|
type: string
|
||
|
storagePolicyName:
|
||
|
description:
|
||
|
storagePolicyName is the storage Policy Based
|
||
|
Management (SPBM) profile name.
|
||
|
type: string
|
||
|
volumePath:
|
||
|
description:
|
||
|
volumePath is the path that identifies vSphere
|
||
|
volume vmdk
|
||
|
type: string
|
||
|
required:
|
||
|
- volumePath
|
||
|
type: object
|
||
|
required:
|
||
|
- name
|
||
|
type: object
|
||
|
type: array
|
||
|
walCompression:
|
||
|
description:
|
||
|
"Configures compression of the write-ahead log (WAL)
|
||
|
using Snappy. \n WAL compression is enabled by default for Prometheus
|
||
|
>= 2.20.0 \n Requires Prometheus v2.11.0 and above."
|
||
|
type: boolean
|
||
|
web:
|
||
|
description: Defines the configuration of the Prometheus web server.
|
||
|
properties:
|
||
|
httpConfig:
|
||
|
description: Defines HTTP parameters for web server.
|
||
|
properties:
|
||
|
headers:
|
||
|
description: List of headers that can be added to HTTP responses.
|
||
|
properties:
|
||
|
contentSecurityPolicy:
|
||
|
description:
|
||
|
Set the Content-Security-Policy header to
|
||
|
HTTP responses. Unset if blank.
|
||
|
type: string
|
||
|
strictTransportSecurity:
|
||
|
description:
|
||
|
Set 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
|
||
|
type: string
|
||
|
xContentTypeOptions:
|
||
|
description:
|
||
|
Set the X-Content-Type-Options header to
|
||
|
HTTP responses. Unset if blank. Accepted value is nosniff.
|
||
|
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options
|
||
|
enum:
|
||
|
- ""
|
||
|
- NoSniff
|
||
|
type: string
|
||
|
xFrameOptions:
|
||
|
description:
|
||
|
Set the X-Frame-Options header to HTTP responses.
|
||
|
Unset if blank. Accepted values are deny and sameorigin.
|
||
|
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options
|
||
|
enum:
|
||
|
- ""
|
||
|
- Deny
|
||
|
- SameOrigin
|
||
|
type: string
|
||
|
xXSSProtection:
|
||
|
description:
|
||
|
Set the X-XSS-Protection header to all responses.
|
||
|
Unset if blank. https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection
|
||
|
type: string
|
||
|
type: object
|
||
|
http2:
|
||
|
description:
|
||
|
Enable HTTP/2 support. Note that HTTP/2 is only
|
||
|
supported with TLS. When TLSConfig is not configured, HTTP/2
|
||
|
will be disabled. Whenever the value of the field changes,
|
||
|
a rolling update will be triggered.
|
||
|
type: boolean
|
||
|
type: object
|
||
|
maxConnections:
|
||
|
description:
|
||
|
Defines the maximum number of simultaneous connections
|
||
|
A zero value means that Prometheus doesn't accept any incoming
|
||
|
connection.
|
||
|
format: int32
|
||
|
minimum: 0
|
||
|
type: integer
|
||
|
pageTitle:
|
||
|
description: The prometheus web page title.
|
||
|
type: string
|
||
|
tlsConfig:
|
||
|
description: Defines the TLS parameters for HTTPS.
|
||
|
properties:
|
||
|
cert:
|
||
|
description: Contains the TLS certificate for the server.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
cipherSuites:
|
||
|
description:
|
||
|
"List of supported cipher suites for TLS versions
|
||
|
up to TLS 1.2. If empty, Go default cipher suites are used.
|
||
|
Available cipher suites are documented in the go documentation:
|
||
|
https://golang.org/pkg/crypto/tls/#pkg-constants"
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
client_ca:
|
||
|
description:
|
||
|
Contains the CA certificate for client certificate
|
||
|
authentication to the server.
|
||
|
properties:
|
||
|
configMap:
|
||
|
description:
|
||
|
ConfigMap containing data to use for the
|
||
|
targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description: The key to select.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the ConfigMap or its
|
||
|
key must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
secret:
|
||
|
description: Secret containing data to use for the targets.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind,
|
||
|
uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key
|
||
|
must be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
type: object
|
||
|
clientAuthType:
|
||
|
description:
|
||
|
"Server policy for client authentication. Maps
|
||
|
to ClientAuth Policies. For more detail on clientAuth options:
|
||
|
https://golang.org/pkg/crypto/tls/#ClientAuthType"
|
||
|
type: string
|
||
|
curvePreferences:
|
||
|
description:
|
||
|
"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"
|
||
|
items:
|
||
|
type: string
|
||
|
type: array
|
||
|
keySecret:
|
||
|
description: Secret containing the TLS key for the server.
|
||
|
properties:
|
||
|
key:
|
||
|
description:
|
||
|
The key of the secret to select from. Must
|
||
|
be a valid secret key.
|
||
|
type: string
|
||
|
name:
|
||
|
description:
|
||
|
"Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
|
||
|
TODO: Add other useful fields. apiVersion, kind, uid?"
|
||
|
type: string
|
||
|
optional:
|
||
|
description:
|
||
|
Specify whether the Secret or its key must
|
||
|
be defined
|
||
|
type: boolean
|
||
|
required:
|
||
|
- key
|
||
|
type: object
|
||
|
x-kubernetes-map-type: atomic
|
||
|
maxVersion:
|
||
|
description:
|
||
|
Maximum TLS version that is acceptable. Defaults
|
||
|
to TLS13.
|
||
|
type: string
|
||
|
minVersion:
|
||
|
description:
|
||
|
Minimum TLS version that is acceptable. Defaults
|
||
|
to TLS12.
|
||
|
type: string
|
||
|
preferServerCipherSuites:
|
||
|
description:
|
||
|
Controls 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.
|
||
|
type: boolean
|
||
|
required:
|
||
|
- cert
|
||
|
- keySecret
|
||
|
type: object
|
||
|
type: object
|
||
|
type: object
|
||
|
status:
|
||
|
description:
|
||
|
"Most recent observed status of the Prometheus cluster. Read-only.
|
||
|
More info: https://github.com/kubernetes/community/blob/master/contributors/devel/sig-architecture/api-conventions.md#spec-and-status"
|
||
|
properties:
|
||
|
availableReplicas:
|
||
|
description:
|
||
|
Total number of available pods (ready for at least minReadySeconds)
|
||
|
targeted by this Prometheus deployment.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
conditions:
|
||
|
description: The current state of the Prometheus deployment.
|
||
|
items:
|
||
|
description:
|
||
|
Condition represents the state of the resources associated
|
||
|
with the Prometheus, Alertmanager or ThanosRuler resource.
|
||
|
properties:
|
||
|
lastTransitionTime:
|
||
|
description:
|
||
|
lastTransitionTime is the time of the last update
|
||
|
to the current status property.
|
||
|
format: date-time
|
||
|
type: string
|
||
|
message:
|
||
|
description:
|
||
|
Human-readable message indicating details for the
|
||
|
condition's last transition.
|
||
|
type: string
|
||
|
observedGeneration:
|
||
|
description:
|
||
|
ObservedGeneration represents 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.
|
||
|
format: int64
|
||
|
type: integer
|
||
|
reason:
|
||
|
description: Reason for the condition's last transition.
|
||
|
type: string
|
||
|
status:
|
||
|
description: Status of the condition.
|
||
|
type: string
|
||
|
type:
|
||
|
description: Type of the condition being reported.
|
||
|
type: string
|
||
|
required:
|
||
|
- lastTransitionTime
|
||
|
- status
|
||
|
- type
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-map-keys:
|
||
|
- type
|
||
|
x-kubernetes-list-type: map
|
||
|
paused:
|
||
|
description:
|
||
|
Represents whether any actions on the underlying managed
|
||
|
objects are being performed. Only delete actions will be performed.
|
||
|
type: boolean
|
||
|
replicas:
|
||
|
description:
|
||
|
Total number of non-terminated pods targeted by this
|
||
|
Prometheus deployment (their labels match the selector).
|
||
|
format: int32
|
||
|
type: integer
|
||
|
shardStatuses:
|
||
|
description:
|
||
|
The list has one entry per shard. Each entry provides
|
||
|
a summary of the shard status.
|
||
|
items:
|
||
|
properties:
|
||
|
availableReplicas:
|
||
|
description:
|
||
|
Total number of available pods (ready for at least
|
||
|
minReadySeconds) targeted by this shard.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
replicas:
|
||
|
description: Total number of pods targeted by this shard.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
shardID:
|
||
|
description: Identifier of the shard.
|
||
|
type: string
|
||
|
unavailableReplicas:
|
||
|
description:
|
||
|
Total number of unavailable pods targeted by this
|
||
|
shard.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
updatedReplicas:
|
||
|
description:
|
||
|
Total number of non-terminated pods targeted by
|
||
|
this shard that have the desired spec.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
required:
|
||
|
- availableReplicas
|
||
|
- replicas
|
||
|
- shardID
|
||
|
- unavailableReplicas
|
||
|
- updatedReplicas
|
||
|
type: object
|
||
|
type: array
|
||
|
x-kubernetes-list-map-keys:
|
||
|
- shardID
|
||
|
x-kubernetes-list-type: map
|
||
|
unavailableReplicas:
|
||
|
description:
|
||
|
Total number of unavailable pods targeted by this Prometheus
|
||
|
deployment.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
updatedReplicas:
|
||
|
description:
|
||
|
Total number of non-terminated pods targeted by this
|
||
|
Prometheus deployment that have the desired version spec.
|
||
|
format: int32
|
||
|
type: integer
|
||
|
required:
|
||
|
- availableReplicas
|
||
|
- paused
|
||
|
- replicas
|
||
|
- unavailableReplicas
|
||
|
- updatedReplicas
|
||
|
type: object
|
||
|
required:
|
||
|
- spec
|
||
|
type: object
|
||
|
served: true
|
||
|
storage: true
|
||
|
subresources:
|
||
|
status: {}
|