Runner
A runner to execute DevPod workspaces.
Example Runner​
An example Runner:
apiVersion: management.loft.sh/v1
kind: Runner
metadata:
creationTimestamp: null
name: my-runner
spec:
displayName: my-display-name
status: {}
Runner Reference​
kind
required string pro​
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
kind
required string pro​apiVersion
required string pro​
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
apiVersion
required string pro​metadata
required object pro​
metadata
required object pro​name
required string pro​
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string pro​generateName
required string pro​
GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generateName
required string pro​namespace
required string pro​
Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
namespace
required string pro​selfLink
required string pro​
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink
required string pro​uid
required string pro​
UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.
Populated by the system.
Read-only.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string pro​resourceVersion
required string pro​
An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
resourceVersion
required string pro​generation
required integer pro​
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation
required integer pro​creationTimestamp
required object pro​
CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
creationTimestamp
required object pro​deletionTimestamp
required object pro​
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionTimestamp
required object pro​deletionGracePeriodSeconds
required integer pro​
Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
deletionGracePeriodSeconds
required integer pro​labels
required object pro​
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
labels
required object pro​annotations
required object pro​
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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
annotations
required object pro​ownerReferences
required object[] pro​
List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
ownerReferences
required object[] pro​apiVersion
required string pro​
API version of the referent.
apiVersion
required string pro​kind
required string pro​
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string pro​name
required string pro​
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string pro​uid
required string pro​
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string pro​controller
required boolean pro​
If true, this reference points to the managing controller.
controller
required boolean pro​blockOwnerDeletion
required boolean pro​
If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
blockOwnerDeletion
required boolean pro​finalizers
required string[] pro​
Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
finalizers
required string[] pro​managedFields
required object[] pro​
ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
managedFields
required object[] pro​manager
required string pro​
Manager is an identifier of the workflow managing these fields.
manager
required string pro​operation
required string pro​
Operation is the type of operation which lead to this ManagedFieldsEntry being created.
The only valid values for this field are 'Apply' and 'Update'.
operation
required string pro​apiVersion
required string pro​
APIVersion defines the version of this resource that this field set
applies to. The format is "group/version" just like the top-level
APIVersion field. It is necessary to track the version of a field
set because it cannot be automatically converted.
apiVersion
required string pro​time
required object pro​
Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
time
required object pro​fieldsType
required string pro​
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType
required string pro​fieldsV1
required object pro​
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1
required object pro​subresource
required string pro​
Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource.
subresource
required string pro​spec
required object pro​
spec
required object pro​displayName
required string pro​
The display name shown in the UI
displayName
required string pro​description
required string pro​
Description describes a cluster access object
description
required string pro​networkPeerName
required string pro​
NetworkPeerName is the network peer name used to connect directly to the runner
networkPeerName
required string pro​clusterRef
required object pro​
If ClusterRef is defined, Loft will schedule the runner on the given
cluster.
clusterRef
required object pro​cluster
required string pro​
Cluster is the connected cluster the space will be created in
cluster
required string pro​namespace
required string pro​
Namespace is the namespace inside the connected cluster holding the space
namespace
required string pro​persistentVolumeClaimTemplate
required object pro​
PersistentVolumeClaimTemplate holds additional options for the persistent volume claim
persistentVolumeClaimTemplate
required object pro​metadata
required object pro​
Metadata holds the template metadata
metadata
required object pro​spec
required object pro​
Spec holds the template spec
spec
required object pro​accessModes
required string[] pro​
accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
accessModes
required string[] pro​storageClassName
required string pro​
storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
storageClassName
required string pro​storageSize
required string pro​
storageSize is the size of the storage to reserve for the pvc
storageSize
required string pro​podTemplate
required object pro​
PodTemplate holds additional options for the runner pod
podTemplate
required object pro​metadata
required object pro​
Metadata holds the template metadata
metadata
required object pro​spec
required object pro​
Spec holds the template spec
spec
required object pro​image
required string pro​
Runner pod image to use other than default
image
required string pro​resource
required object pro​
Resources requirements
resource
required object pro​limits
required object pro​
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
limits
required object pro​requests
required object pro​
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/
requests
required object pro​claims
required object[] pro​
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
This is an alpha field and requires enabling the
DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
claims
required object[] pro​name
required string pro​
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.
name
required string pro​envFrom
required object[] pro​
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.
envFrom
required object[] pro​prefix
required string pro​
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
prefix
required string pro​configMapRef
required object pro​
The ConfigMap to select from
configMapRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.optional
required boolean pro​
Specify whether the ConfigMap must be defined
optional
required boolean pro​secretRef
required object pro​
The Secret to select from
secretRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.optional
required boolean pro​
Specify whether the Secret must be defined
optional
required boolean pro​env
required object[] pro​
List of environment variables to set in the container.
Cannot be updated.
env
required object[] pro​name
required string pro​
Name of the environment variable. Must be a C_IDENTIFIER.
name
required string pro​value
required string pro​
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 "".
value
required string pro​valueFrom
required object pro​
Source for the environment variable's value. Cannot be used if value is not empty.
valueFrom
required object pro​fieldRef
required object pro​
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.
fieldRef
required object pro​metadata.labels['(KEY)']
, metadata.annotations['(KEY)']
,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.resourceFieldRef
required object pro​
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.
resourceFieldRef
required object pro​configMapKeyRef
required object pro​
Selects a key of a ConfigMap.
configMapKeyRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string pro​
The key to select.
key
required string pro​optional
required boolean pro​
Specify whether the ConfigMap or its key must be defined
optional
required boolean pro​secretKeyRef
required object pro​
Selects a key of a secret in the pod's namespace
secretKeyRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string pro​
The key of the secret to select from. Must be a valid secret key.
key
required string pro​optional
required boolean pro​
Specify whether the Secret or its key must be defined
optional
required boolean pro​nodeSelector
required object pro​
Set the NodeSelector for the Runner Pod
nodeSelector
required object pro​affinity
required object pro​
Set the Affinity for the Runner Pod
affinity
required object pro​nodeAffinity
required object pro​
Describes node affinity scheduling rules for the pod.
nodeAffinity
required object pro​requiredDuringSchedulingIgnoredDuringExecution
required object pro​
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.
requiredDuringSchedulingIgnoredDuringExecution
required object pro​nodeSelectorTerms
required object[] pro​
Required. A list of node selector terms. The terms are ORed.
nodeSelectorTerms
required object[] pro​matchExpressions
required object[] pro​
A list of node selector requirements by node's labels.
matchExpressions
required object[] pro​key
required string pro​
The label key that the selector applies to.
key
required string pro​operator
required string pro​
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​matchFields
required object[] pro​
A list of node selector requirements by node's fields.
matchFields
required object[] pro​key
required string pro​
The label key that the selector applies to.
key
required string pro​operator
required string pro​
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​preferredDuringSchedulingIgnoredDuringExecution
required object[] pro​
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 with the highest sum are the most preferred.
preferredDuringSchedulingIgnoredDuringExecution
required object[] pro​weight
required integer pro​
Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.
weight
required integer pro​preference
required object pro​
A node selector term, associated with the corresponding weight.
preference
required object pro​matchExpressions
required object[] pro​
A list of node selector requirements by node's labels.
matchExpressions
required object[] pro​key
required string pro​
The label key that the selector applies to.
key
required string pro​operator
required string pro​
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​matchFields
required object[] pro​
A list of node selector requirements by node's fields.
matchFields
required object[] pro​key
required string pro​
The label key that the selector applies to.
key
required string pro​operator
required string pro​
Represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists, DoesNotExist. Gt, and Lt.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​podAffinity
required object pro​
Describes pod affinity scheduling rules (e.g. co-locate this pod in the same node, zone, etc. as some other pod.
podAffinity
required object pro​requiredDuringSchedulingIgnoredDuringExecution
required object[] pro​
If the affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to a pod label update), the
system may or may not try to eventually evict the pod from its node.
When there are multiple elements, the lists of nodes corresponding to each
podAffinityTerm are intersected, i.e. all terms must be satisfied.
requiredDuringSchedulingIgnoredDuringExecution
required object[] pro​labelSelector
required object pro​
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
labelSelector
required object pro​matchLabels
required object pro​
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.
matchLabels
required object pro​matchExpressions
required object[] pro​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] pro​key
required string pro​
key is the label key that the selector applies to.
key
required string pro​operator
required string pro​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​namespaces
required string[] pro​
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".
namespaces
required string[] pro​topologyKey
required string pro​
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.
topologyKey
required string pro​namespaceSelector
required object pro​
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.
namespaceSelector
required object pro​matchLabels
required object pro​
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.
matchLabels
required object pro​matchExpressions
required object[] pro​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] pro​key
required string pro​
key is the label key that the selector applies to.
key
required string pro​operator
required string pro​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​matchLabelKeys
required string[] pro​
MatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with labelSelector
as key in (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
matchLabelKeys
required string[] pro​labelSelector
as key in (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.mismatchLabelKeys
required string[] pro​
MismatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with labelSelector
as key notin (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
mismatchLabelKeys
required string[] pro​labelSelector
as key notin (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.preferredDuringSchedulingIgnoredDuringExecution
required object[] pro​
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 with the highest sum are the most preferred.
preferredDuringSchedulingIgnoredDuringExecution
required object[] pro​weight
required integer pro​
weight associated with matching the corresponding podAffinityTerm,
in the range 1-100.
weight
required integer pro​podAffinityTerm
required object pro​
Required. A pod affinity term, associated with the corresponding weight.
podAffinityTerm
required object pro​labelSelector
required object pro​
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
labelSelector
required object pro​matchLabels
required object pro​
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.
matchLabels
required object pro​matchExpressions
required object[] pro​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] pro​key
required string pro​
key is the label key that the selector applies to.
key
required string pro​operator
required string pro​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​namespaces
required string[] pro​
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".
namespaces
required string[] pro​topologyKey
required string pro​
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.
topologyKey
required string pro​namespaceSelector
required object pro​
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.
namespaceSelector
required object pro​matchLabels
required object pro​
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.
matchLabels
required object pro​matchExpressions
required object[] pro​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] pro​key
required string pro​
key is the label key that the selector applies to.
key
required string pro​operator
required string pro​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​matchLabelKeys
required string[] pro​
MatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with labelSelector
as key in (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
matchLabelKeys
required string[] pro​labelSelector
as key in (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.mismatchLabelKeys
required string[] pro​
MismatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with labelSelector
as key notin (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
mismatchLabelKeys
required string[] pro​labelSelector
as key notin (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.podAntiAffinity
required object pro​
Describes pod anti-affinity scheduling rules (e.g. avoid putting this pod in the same node, zone, etc. as some other pod.
podAntiAffinity
required object pro​requiredDuringSchedulingIgnoredDuringExecution
required object[] pro​
If the anti-affinity requirements specified by this field are not met at
scheduling time, the pod will not be scheduled onto the node.
If the anti-affinity requirements specified by this field cease to be met
at some point during pod execution (e.g. due to a pod label update), the
system may or may not try to eventually evict the pod from its node.
When there are multiple elements, the lists of nodes corresponding to each
podAffinityTerm are intersected, i.e. all terms must be satisfied.
requiredDuringSchedulingIgnoredDuringExecution
required object[] pro​labelSelector
required object pro​
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
labelSelector
required object pro​matchLabels
required object pro​
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.
matchLabels
required object pro​matchExpressions
required object[] pro​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] pro​key
required string pro​
key is the label key that the selector applies to.
key
required string pro​operator
required string pro​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​namespaces
required string[] pro​
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".
namespaces
required string[] pro​topologyKey
required string pro​
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.
topologyKey
required string pro​namespaceSelector
required object pro​
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.
namespaceSelector
required object pro​matchLabels
required object pro​
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.
matchLabels
required object pro​matchExpressions
required object[] pro​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] pro​key
required string pro​
key is the label key that the selector applies to.
key
required string pro​operator
required string pro​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​matchLabelKeys
required string[] pro​
MatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with labelSelector
as key in (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
matchLabelKeys
required string[] pro​labelSelector
as key in (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.mismatchLabelKeys
required string[] pro​
MismatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with labelSelector
as key notin (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
mismatchLabelKeys
required string[] pro​labelSelector
as key notin (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.preferredDuringSchedulingIgnoredDuringExecution
required object[] pro​
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 with the highest sum are the most preferred.
preferredDuringSchedulingIgnoredDuringExecution
required object[] pro​weight
required integer pro​
weight associated with matching the corresponding podAffinityTerm,
in the range 1-100.
weight
required integer pro​podAffinityTerm
required object pro​
Required. A pod affinity term, associated with the corresponding weight.
podAffinityTerm
required object pro​labelSelector
required object pro​
A label query over a set of resources, in this case pods.
If it's null, this PodAffinityTerm matches with no Pods.
labelSelector
required object pro​matchLabels
required object pro​
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.
matchLabels
required object pro​matchExpressions
required object[] pro​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] pro​key
required string pro​
key is the label key that the selector applies to.
key
required string pro​operator
required string pro​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​namespaces
required string[] pro​
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".
namespaces
required string[] pro​topologyKey
required string pro​
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.
topologyKey
required string pro​namespaceSelector
required object pro​
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.
namespaceSelector
required object pro​matchLabels
required object pro​
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.
matchLabels
required object pro​matchExpressions
required object[] pro​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] pro​key
required string pro​
key is the label key that the selector applies to.
key
required string pro​operator
required string pro​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​matchLabelKeys
required string[] pro​
MatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with labelSelector
as key in (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
matchLabelKeys
required string[] pro​labelSelector
as key in (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both matchLabelKeys and labelSelector.
Also, matchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.mismatchLabelKeys
required string[] pro​
MismatchLabelKeys is a set of pod label keys to select which pods will
be taken into consideration. The keys are used to lookup values from the
incoming pod labels, those key-value labels are merged with labelSelector
as key notin (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.
mismatchLabelKeys
required string[] pro​labelSelector
as key notin (value)
to select the group of existing pods which pods will be taken into consideration
for the incoming pod's pod (anti) affinity. Keys that don't exist in the incoming
pod labels will be ignored. The default value is empty.
The same key is forbidden to exist in both mismatchLabelKeys and labelSelector.
Also, mismatchLabelKeys cannot be set when labelSelector isn't set.
This is an alpha field and requires enabling MatchLabelKeysInPodAffinity feature gate.tolerations
required object[] pro​
Set the Tolerations for the Runner Pod
tolerations
required object[] pro​key
required string pro​
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.
key
required string pro​operator
required string pro​
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.
operator
required string pro​value
required string pro​
Value is the taint value the toleration matches to.
If the operator is Exists, the value should be empty, otherwise just a regular string.
value
required string pro​effect
required string pro​
Effect indicates the taint effect to match. Empty means match all taint effects.
When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.
effect
required string pro​tolerationSeconds
required integer pro​
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.
tolerationSeconds
required integer pro​volumeMounts
required object[] pro​
Set Volume Mounts for the Runner Pod
volumeMounts
required object[] pro​name
required string pro​
This must match the Name of a Volume.
name
required string pro​readOnly
required boolean pro​
Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
readOnly
required boolean pro​recursiveReadOnly
required string pro​
RecursiveReadOnly specifies whether read-only mounts should be handled
recursively.
If ReadOnly is false, this field has no meaning and must be unspecified.
If ReadOnly is true, and this field is set to Disabled, the mount is not made
recursively read-only. If this field is set to IfPossible, the mount is made
recursively read-only, if it is supported by the container runtime. If this
field is set to Enabled, the mount is made recursively read-only if it is
supported by the container runtime, otherwise the pod will not be started and
an error will be generated to indicate the reason.
If this field is set to IfPossible or Enabled, MountPropagation must be set to
None (or be unspecified, which defaults to None).
If this field is not specified, it is treated as an equivalent of Disabled.
recursiveReadOnly
required string pro​mountPath
required string pro​
Path within the container at which the volume should be mounted. Must
not contain ':'.
mountPath
required string pro​subPath
required string pro​
Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
subPath
required string pro​mountPropagation
required string pro​
mountPropagation determines how mounts are propagated from the host
to container and the other way around.
When not set, MountPropagationNone is used.
This field is beta in 1.10.
When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
(which defaults to None).
mountPropagation
required string pro​subPathExpr
required string pro​
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.
subPathExpr
required string pro​volumes
required object[] pro​
Set Volumes for the Runner Pod
volumes
required object[] pro​name
required string pro​
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
name
required string pro​hostPath
required object pro​
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.
hostPath
required object pro​path
required string pro​
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
path
required string pro​type
required string pro​
type for HostPath Volume
Defaults to ""
More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath
type
required string pro​emptyDir
required object pro​
emptyDir represents a temporary directory that shares a pod's lifetime.
More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir
emptyDir
required object pro​medium
required string pro​
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
medium
required string pro​sizeLimit
required object pro​
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
sizeLimit
required object pro​Format
required string pro​
Format
required string pro​gcePersistentDisk
required object pro​
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
gcePersistentDisk
required object pro​pdName
required string pro​
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
pdName
required string pro​fsType
required string pro​
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
fsType
required string pro​partition
required integer pro​
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
partition
required integer pro​readOnly
required boolean pro​
readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
readOnly
required boolean pro​awsElasticBlockStore
required object pro​
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
awsElasticBlockStore
required object pro​volumeID
required string pro​
volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume).
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
volumeID
required string pro​fsType
required string pro​
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
fsType
required string pro​partition
required integer pro​
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).
partition
required integer pro​readOnly
required boolean pro​
readOnly value true will force the readOnly setting in VolumeMounts.
More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
readOnly
required boolean pro​gitRepo
required object pro​
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.
gitRepo
required object pro​repository
required string pro​
repository is the URL
repository
required string pro​revision
required string pro​
revision is the commit hash for the specified revision.
revision
required string pro​directory
required string pro​
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.
directory
required string pro​secret
required object pro​
secret represents a secret that should populate this volume.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
secret
required object pro​secretName
required string pro​
secretName is the name of the secret in the pod's namespace to use.
More info: https://kubernetes.io/docs/concepts/storage/volumes#secret
secretName
required string pro​items
required object[] pro​
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
required object[] pro​key
required string pro​
key is the key to project.
key
required string pro​path
required string pro​
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 '..'.
path
required string pro​mode
required integer pro​
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.
mode
required integer pro​defaultMode
required integer pro​
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.
defaultMode
required integer pro​optional
required boolean pro​
optional field specify whether the Secret or its keys must be defined
optional
required boolean pro​nfs
required object pro​
nfs represents an NFS mount on the host that shares a pod's lifetime
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
nfs
required object pro​server
required string pro​
server is the hostname or IP address of the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
server
required string pro​path
required string pro​
path that is exported by the NFS server.
More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
path
required string pro​readOnly
required boolean pro​
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
readOnly
required boolean pro​iscsi
required object pro​
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
iscsi
required object pro​targetPortal
required string pro​
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).
targetPortal
required string pro​iqn
required string pro​
iqn is the target iSCSI Qualified Name.
iqn
required string pro​lun
required integer pro​
lun represents iSCSI Target Lun number.
lun
required integer pro​iscsiInterface
required string pro​
iscsiInterface is the interface Name that uses an iSCSI transport.
Defaults to 'default' (tcp).
iscsiInterface
required string pro​fsType
required string pro​
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
fsType
required string pro​readOnly
required boolean pro​
readOnly here will force the ReadOnly setting in VolumeMounts.
Defaults to false.
readOnly
required boolean pro​portals
required string[] pro​
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).
portals
required string[] pro​chapAuthDiscovery
required boolean pro​
chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication
chapAuthDiscovery
required boolean pro​chapAuthSession
required boolean pro​
chapAuthSession defines whether support iSCSI Session CHAP authentication
chapAuthSession
required boolean pro​secretRef
required object pro​
secretRef is the CHAP Secret for iSCSI target and initiator authentication
secretRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.initiatorName
required string pro​
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.
initiatorName
required string pro​glusterfs
required object pro​
glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
More info: https://examples.k8s.io/volumes/glusterfs/README.md
glusterfs
required object pro​endpoints
required string pro​
endpoints is the endpoint name that details Glusterfs topology.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
endpoints
required string pro​path
required string pro​
path is the Glusterfs volume path.
More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod
path
required string pro​readOnly
required boolean pro​
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
readOnly
required boolean pro​persistentVolumeClaim
required object pro​
persistentVolumeClaimVolumeSource represents a reference to a
PersistentVolumeClaim in the same namespace.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
persistentVolumeClaim
required object pro​claimName
required string pro​
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
claimName
required string pro​readOnly
required boolean pro​
readOnly Will force the ReadOnly setting in VolumeMounts.
Default false.
readOnly
required boolean pro​rbd
required object pro​
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
rbd
required object pro​monitors
required string[] pro​
monitors is a collection of Ceph monitors.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
monitors
required string[] pro​image
required string pro​
image is the rados image name.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
image
required string pro​fsType
required string pro​
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
fsType
required string pro​pool
required string pro​
pool is the rados pool name.
Default is rbd.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
pool
required string pro​user
required string pro​
user is the rados user name.
Default is admin.
More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it
user
required string pro​keyring
required string pro​
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
keyring
required string pro​secretRef
required object pro​
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
secretRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.readOnly
required boolean pro​
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
readOnly
required boolean pro​flexVolume
required object pro​
flexVolume represents a generic volume resource that is
provisioned/attached using an exec based plugin.
flexVolume
required object pro​driver
required string pro​
driver is the name of the driver to use for this volume.
driver
required string pro​fsType
required string pro​
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.
fsType
required string pro​secretRef
required object pro​
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.
secretRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.readOnly
required boolean pro​
readOnly is Optional: defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean pro​options
required object pro​
options is Optional: this field holds extra command options if any.
options
required object pro​cinder
required object pro​
cinder represents a cinder volume attached and mounted on kubelets host machine.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md
cinder
required object pro​volumeID
required string pro​
volumeID used to identify the volume in cinder.
More info: https://examples.k8s.io/mysql-cinder-pd/README.md
volumeID
required string pro​fsType
required string pro​
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
fsType
required string pro​readOnly
required boolean pro​
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
readOnly
required boolean pro​secretRef
required object pro​
secretRef is optional: points to a secret object containing parameters used to connect
to OpenStack.
secretRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.cephfs
required object pro​
cephFS represents a Ceph FS mount on the host that shares a pod's lifetime
cephfs
required object pro​monitors
required string[] pro​
monitors is Required: Monitors is a collection of Ceph monitors
More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it
monitors
required string[] pro​path
required string pro​
path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /
path
required string pro​user
required string pro​
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
user
required string pro​secretFile
required string pro​
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
secretFile
required string pro​secretRef
required object pro​
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
secretRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.readOnly
required boolean pro​
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
readOnly
required boolean pro​flocker
required object pro​
flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running
flocker
required object pro​downwardAPI
required object pro​
downwardAPI represents downward API about the pod that should populate this volume
downwardAPI
required object pro​items
required object[] pro​
Items is a list of downward API volume file
items
required object[] pro​path
required string pro​
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 '..'
path
required string pro​fieldRef
required object pro​
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
fieldRef
required object pro​resourceFieldRef
required object pro​
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
resourceFieldRef
required object pro​mode
required integer pro​
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.
mode
required integer pro​defaultMode
required integer pro​
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.
defaultMode
required integer pro​fc
required object pro​
fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.
fc
required object pro​targetWWNs
required string[] pro​
targetWWNs is Optional: FC target worldwide names (WWNs)
targetWWNs
required string[] pro​lun
required integer pro​
lun is Optional: FC target lun number
lun
required integer pro​fsType
required string pro​
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
fsType
required string pro​readOnly
required boolean pro​
readOnly is Optional: Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean pro​wwids
required string[] pro​
wwids Optional: FC volume world wide identifiers (wwids)
Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.
wwids
required string[] pro​azureFile
required object pro​
azureFile represents an Azure File Service mount on the host and bind mount to the pod.
azureFile
required object pro​secretName
required string pro​
secretName is the name of secret that contains Azure Storage Account Name and Key
secretName
required string pro​shareName
required string pro​
shareName is the azure share Name
shareName
required string pro​readOnly
required boolean pro​
readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean pro​configMap
required object pro​
configMap represents a configMap that should populate this volume
configMap
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.items
required object[] pro​
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
required object[] pro​key
required string pro​
key is the key to project.
key
required string pro​path
required string pro​
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 '..'.
path
required string pro​mode
required integer pro​
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.
mode
required integer pro​defaultMode
required integer pro​
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.
defaultMode
required integer pro​optional
required boolean pro​
optional specify whether the ConfigMap or its keys must be defined
optional
required boolean pro​vsphereVolume
required object pro​
vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine
vsphereVolume
required object pro​volumePath
required string pro​
volumePath is the path that identifies vSphere volume vmdk
volumePath
required string pro​fsType
required string pro​
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.
fsType
required string pro​storagePolicyName
required string pro​
storagePolicyName is the storage Policy Based Management (SPBM) profile name.
storagePolicyName
required string pro​storagePolicyID
required string pro​
storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.
storagePolicyID
required string pro​quobyte
required object pro​
quobyte represents a Quobyte mount on the host that shares a pod's lifetime
quobyte
required object pro​registry
required string pro​
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
registry
required string pro​volume
required string pro​
volume is a string that references an already created Quobyte volume by name.
volume
required string pro​readOnly
required boolean pro​
readOnly here will force the Quobyte volume to be mounted with read-only permissions.
Defaults to false.
readOnly
required boolean pro​user
required string pro​
user to map volume access to
Defaults to serivceaccount user
user
required string pro​group
required string pro​
group to map volume access to
Default is no group
group
required string pro​tenant
required string pro​
tenant owning the given Quobyte volume in the Backend
Used with dynamically provisioned Quobyte volumes, value is set by the plugin
tenant
required string pro​azureDisk
required object pro​
azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
azureDisk
required object pro​diskName
required string pro​
diskName is the Name of the data disk in the blob storage
diskName
required string pro​diskURI
required string pro​
diskURI is the URI of data disk in the blob storage
diskURI
required string pro​cachingMode
required string pro​
cachingMode is the Host Caching mode: None, Read Only, Read Write.
cachingMode
required string pro​fsType
required string pro​
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.
fsType
required string pro​readOnly
required boolean pro​
readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean pro​kind
required string pro​
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
kind
required string pro​photonPersistentDisk
required object pro​
photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine
photonPersistentDisk
required object pro​pdID
required string pro​
pdID is the ID that identifies Photon Controller persistent disk
pdID
required string pro​fsType
required string pro​
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.
fsType
required string pro​projected
required object pro​
projected items for all in one resources secrets, configmaps, and downward API
projected
required object pro​sources
required object[] pro​
sources is the list of volume projections
sources
required object[] pro​secret
required object pro​
secret information about the secret data to project
secret
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.items
required object[] pro​
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
required object[] pro​key
required string pro​
key is the key to project.
key
required string pro​path
required string pro​
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 '..'.
path
required string pro​mode
required integer pro​
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.
mode
required integer pro​optional
required boolean pro​
optional field specify whether the Secret or its key must be defined
optional
required boolean pro​downwardAPI
required object pro​
downwardAPI information about the downwardAPI data to project
downwardAPI
required object pro​items
required object[] pro​
Items is a list of DownwardAPIVolume file
items
required object[] pro​path
required string pro​
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 '..'
path
required string pro​fieldRef
required object pro​
Required: Selects a field of the pod: only annotations, labels, name, namespace and uid are supported.
fieldRef
required object pro​resourceFieldRef
required object pro​
Selects a resource of the container: only resources limits and requests
(limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.
resourceFieldRef
required object pro​mode
required integer pro​
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.
mode
required integer pro​configMap
required object pro​
configMap information about the configMap data to project
configMap
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.items
required object[] pro​
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
required object[] pro​key
required string pro​
key is the key to project.
key
required string pro​path
required string pro​
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 '..'.
path
required string pro​mode
required integer pro​
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.
mode
required integer pro​optional
required boolean pro​
optional specify whether the ConfigMap or its keys must be defined
optional
required boolean pro​serviceAccountToken
required object pro​
serviceAccountToken is information about the serviceAccountToken data to project
serviceAccountToken
required object pro​audience
required string pro​
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.
audience
required string pro​expirationSeconds
required integer pro​
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.
expirationSeconds
required integer pro​path
required string pro​
path is the path relative to the mount point of the file to project the
token into.
path
required string pro​clusterTrustBundle
required object pro​
ClusterTrustBundle allows a pod to access the .spec.trustBundle
field
of ClusterTrustBundle objects in an auto-updating file.
Alpha, gated by the ClusterTrustBundleProjection feature gate.
ClusterTrustBundle objects can either be selected by name, or by the
combination of signer name and a label selector.
Kubelet performs aggressive normalization of the PEM contents written
into the pod filesystem. Esoteric PEM features such as inter-block
comments and block headers are stripped. Certificates are deduplicated.
The ordering of certificates within the file is arbitrary, and Kubelet
may change the order over time.
clusterTrustBundle
required object pro​.spec.trustBundle
field
of ClusterTrustBundle objects in an auto-updating file.name
required string pro​
Select a single ClusterTrustBundle by object name. Mutually exclusive
with signerName and labelSelector.
name
required string pro​signerName
required string pro​
Select all ClusterTrustBundles that match this signer name.
Mutually exclusive with name. The contents of all selected
ClusterTrustBundles will be unified and deduplicated.
signerName
required string pro​labelSelector
required object pro​
Select all ClusterTrustBundles that match this label selector. Only has
effect if signerName is set. Mutually exclusive with name. If unset,
interpreted as "match nothing". If set but empty, interpreted as "match
everything".
labelSelector
required object pro​matchLabels
required object pro​
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.
matchLabels
required object pro​matchExpressions
required object[] pro​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] pro​key
required string pro​
key is the label key that the selector applies to.
key
required string pro​operator
required string pro​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​optional
required boolean pro​
If true, don't block pod startup if the referenced ClusterTrustBundle
aren't available. If using name, then the named ClusterTrustBundle is
allowed not to exist. If using signerName, then the combination of
signerName and labelSelector is allowed to match zero
ClusterTrustBundles.
optional
required boolean pro​path
required string pro​
Relative path from the volume root to write the bundle.
path
required string pro​defaultMode
required integer pro​
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.
defaultMode
required integer pro​portworxVolume
required object pro​
portworxVolume represents a portworx volume attached and mounted on kubelets host machine
portworxVolume
required object pro​volumeID
required string pro​
volumeID uniquely identifies a Portworx volume
volumeID
required string pro​fsType
required string pro​
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.
fsType
required string pro​readOnly
required boolean pro​
readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean pro​scaleIO
required object pro​
scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
scaleIO
required object pro​gateway
required string pro​
gateway is the host address of the ScaleIO API Gateway.
gateway
required string pro​system
required string pro​
system is the name of the storage system as configured in ScaleIO.
system
required string pro​secretRef
required object pro​
secretRef references to the secret for ScaleIO user and other
sensitive information. If this is not provided, Login operation will fail.
secretRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.sslEnabled
required boolean pro​
sslEnabled Flag enable/disable SSL communication with Gateway, default false
sslEnabled
required boolean pro​protectionDomain
required string pro​
protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.
protectionDomain
required string pro​storagePool
required string pro​
storagePool is the ScaleIO Storage Pool associated with the protection domain.
storagePool
required string pro​storageMode
required string pro​
storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned.
Default is ThinProvisioned.
storageMode
required string pro​volumeName
required string pro​
volumeName is the name of a volume already created in the ScaleIO system
that is associated with this volume source.
volumeName
required string pro​fsType
required string pro​
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".
fsType
required string pro​readOnly
required boolean pro​
readOnly Defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean pro​storageos
required object pro​
storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
storageos
required object pro​volumeName
required string pro​
volumeName is the human-readable name of the StorageOS volume. Volume
names are only unique within a namespace.
volumeName
required string pro​volumeNamespace
required string pro​
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.
volumeNamespace
required string pro​fsType
required string pro​
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.
fsType
required string pro​readOnly
required boolean pro​
readOnly defaults to false (read/write). ReadOnly here will force
the ReadOnly setting in VolumeMounts.
readOnly
required boolean pro​secretRef
required object pro​
secretRef specifies the secret to use for obtaining the StorageOS API
credentials. If not specified, default values will be attempted.
secretRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.csi
required object pro​
csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).
csi
required object pro​driver
required string pro​
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.
driver
required string pro​readOnly
required boolean pro​
readOnly specifies a read-only configuration for the volume.
Defaults to false (read/write).
readOnly
required boolean pro​fsType
required string pro​
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.
fsType
required string pro​volumeAttributes
required object pro​
volumeAttributes stores driver-specific properties that are passed to the CSI
driver. Consult your driver's documentation for supported values.
volumeAttributes
required object pro​nodePublishSecretRef
required object pro​
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.
nodePublishSecretRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.ephemeral
required object pro​
ephemeral represents a volume that is handled by a cluster storage driver.
The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts,
and deleted when the pod is removed.
Use this if:
a) the volume is only needed while the pod runs,
b) features of normal volumes like restoring from snapshot or capacity
tracking are needed,
c) the storage driver is specified through a storage class, and
d) the storage driver supports dynamic volume provisioning through
a PersistentVolumeClaim (see EphemeralVolumeSource for more
information on the connection between this volume type
and PersistentVolumeClaim).
Use PersistentVolumeClaim or one of the vendor-specific
APIs for volumes that persist for longer than the lifecycle
of an individual pod.
Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to
be used that way - see the documentation of the driver for
more information.
A pod can use both types of ephemeral volumes and
persistent volumes at the same time.
ephemeral
required object pro​volumeClaimTemplate
required object pro​
Will be used to create a stand-alone PVC to provision the volume.
The pod in which this EphemeralVolumeSource is embedded will be the
owner of the PVC, i.e. the PVC will be deleted together with the
pod. The name of the PVC will be (pod name)-(volume name)
where
(volume name)
is the name from the PodSpec.Volumes
array
entry. Pod validation will reject the pod if the concatenated name
is not valid for a PVC (for example, too long).
An existing PVC with that name that is not owned by the pod
will not be used for the pod to avoid using an unrelated
volume by mistake. Starting the pod is then blocked until
the unrelated PVC is removed. If such a pre-created PVC is
meant to be used by the pod, the PVC has to updated with an
owner reference to the pod once the pod exists. Normally
this should not be necessary, but it may be useful when
manually reconstructing a broken cluster.
This field is read-only and no changes will be made by Kubernetes
to the PVC after it has been created.
Required, must not be nil.
volumeClaimTemplate
required object pro​(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).metadata
required object pro​
metadata
required object pro​name
required string pro​
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string pro​generateName
required string pro​
GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generateName
required string pro​namespace
required string pro​
Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
namespace
required string pro​selfLink
required string pro​
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink
required string pro​uid
required string pro​
UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.
Populated by the system.
Read-only.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string pro​resourceVersion
required string pro​
An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
resourceVersion
required string pro​generation
required integer pro​
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation
required integer pro​creationTimestamp
required object pro​
CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
creationTimestamp
required object pro​deletionTimestamp
required object pro​
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionTimestamp
required object pro​deletionGracePeriodSeconds
required integer pro​
Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
deletionGracePeriodSeconds
required integer pro​labels
required object pro​
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
labels
required object pro​annotations
required object pro​
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: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
annotations
required object pro​ownerReferences
required object[] pro​
List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
ownerReferences
required object[] pro​apiVersion
required string pro​
API version of the referent.
apiVersion
required string pro​kind
required string pro​
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string pro​name
required string pro​
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string pro​uid
required string pro​
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string pro​controller
required boolean pro​
If true, this reference points to the managing controller.
controller
required boolean pro​blockOwnerDeletion
required boolean pro​
If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
blockOwnerDeletion
required boolean pro​finalizers
required string[] pro​
Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
finalizers
required string[] pro​managedFields
required object[] pro​
ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
managedFields
required object[] pro​manager
required string pro​
Manager is an identifier of the workflow managing these fields.
manager
required string pro​operation
required string pro​
Operation is the type of operation which lead to this ManagedFieldsEntry being created.
The only valid values for this field are 'Apply' and 'Update'.
operation
required string pro​apiVersion
required string pro​
APIVersion defines the version of this resource that this field set
applies to. The format is "group/version" just like the top-level
APIVersion field. It is necessary to track the version of a field
set because it cannot be automatically converted.
apiVersion
required string pro​time
required object pro​
Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
time
required object pro​fieldsType
required string pro​
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType
required string pro​fieldsV1
required object pro​
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1
required object pro​subresource
required string pro​
Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource.
subresource
required string pro​spec
required object pro​
The specification for the PersistentVolumeClaim. The entire content is
copied unchanged into the PVC that gets created from this
template. The same fields as in a PersistentVolumeClaim
are also valid here.
spec
required object pro​accessModes
required string[] pro​
accessModes contains the desired access modes the volume should have.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1
accessModes
required string[] pro​selector
required object pro​
selector is a label query over volumes to consider for binding.
selector
required object pro​matchLabels
required object pro​
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.
matchLabels
required object pro​matchExpressions
required object[] pro​
matchExpressions is a list of label selector requirements. The requirements are ANDed.
matchExpressions
required object[] pro​key
required string pro​
key is the label key that the selector applies to.
key
required string pro​operator
required string pro​
operator represents a key's relationship to a set of values.
Valid operators are In, NotIn, Exists and DoesNotExist.
operator
required string pro​values
required string[] pro​
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.
values
required string[] pro​resources
required object pro​
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
resources
required object pro​limits
required object pro​
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
limits
required object pro​requests
required object pro​
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/
requests
required object pro​volumeName
required string pro​
volumeName is the binding reference to the PersistentVolume backing this claim.
volumeName
required string pro​storageClassName
required string pro​
storageClassName is the name of the StorageClass required by the claim.
More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1
storageClassName
required string pro​volumeMode
required string pro​
volumeMode defines what type of volume is required by the claim.
Value of Filesystem is implied when not included in claim spec.
volumeMode
required string pro​dataSource
required object pro​
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.
dataSource
required object pro​apiGroup
required string pro​
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.
apiGroup
required string pro​kind
required string pro​
Kind is the type of resource being referenced
kind
required string pro​name
required string pro​
Name is the name of resource being referenced
name
required string pro​dataSourceRef
required object pro​
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.
dataSourceRef
required object pro​apiGroup
required string pro​
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.
apiGroup
required string pro​kind
required string pro​
Kind is the type of resource being referenced
kind
required string pro​name
required string pro​
Name is the name of resource being referenced
name
required string pro​namespace
required string pro​
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.
namespace
required string pro​volumeAttributesClassName
required string pro​
volumeAttributesClassName may be used to set the VolumeAttributesClass used by this claim.
If specified, the CSI driver will create or update the volume with the attributes defined
in the corresponding VolumeAttributesClass. This has a different purpose than storageClassName,
it can be changed after the claim is created. An empty string value means that no VolumeAttributesClass
will be applied to the claim but it's not allowed to reset this field to empty string once it is set.
If unspecified and the PersistentVolumeClaim is unbound, the default VolumeAttributesClass
will be set by the persistentvolume controller if it exists.
If the resource referred to by volumeAttributesClass does not exist, this PersistentVolumeClaim will be
set to a Pending state, as reflected by the modifyVolumeStatus field, until such as a resource
exists.
More info: https://kubernetes.io/docs/concepts/storage/volume-attributes-classes/
(Alpha) Using this field requires the VolumeAttributesClass feature gate to be enabled.
volumeAttributesClassName
required string pro​initContainers
required object[] pro​
Set up Init Containers for the Runner
initContainers
required object[] pro​name
required string pro​
Name of the container specified as a DNS_LABEL.
Each container in a pod must have a unique name (DNS_LABEL).
Cannot be updated.
name
required string pro​image
required string pro​
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.
image
required string pro​command
required string[] pro​
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
command
required string[] pro​args
required string[] pro​
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
args
required string[] pro​workingDir
required string pro​
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.
workingDir
required string pro​ports
required object[] pro​
List of ports to expose from the container. Not specifying a port here
DOES NOT prevent that port from being exposed. Any port which is
listening on the default "0.0.0.0" address inside a container will be
accessible from the network.
Modifying this array with strategic merge patch may corrupt the data.
For more information See https://github.com/kubernetes/kubernetes/issues/108255.
Cannot be updated.
ports
required object[] pro​name
required string pro​
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.
name
required string pro​hostPort
required integer pro​
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.
hostPort
required integer pro​containerPort
required integer pro​
Number of port to expose on the pod's IP address.
This must be a valid port number, 0 ( x ( 65536.
containerPort
required integer pro​protocol
required string pro​
Protocol for port. Must be UDP, TCP, or SCTP.
Defaults to "TCP".
protocol
required string pro​hostIP
required string pro​
What host IP to bind the external port to.
hostIP
required string pro​envFrom
required object[] pro​
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.
envFrom
required object[] pro​prefix
required string pro​
An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.
prefix
required string pro​configMapRef
required object pro​
The ConfigMap to select from
configMapRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.optional
required boolean pro​
Specify whether the ConfigMap must be defined
optional
required boolean pro​secretRef
required object pro​
The Secret to select from
secretRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.optional
required boolean pro​
Specify whether the Secret must be defined
optional
required boolean pro​env
required object[] pro​
List of environment variables to set in the container.
Cannot be updated.
env
required object[] pro​name
required string pro​
Name of the environment variable. Must be a C_IDENTIFIER.
name
required string pro​value
required string pro​
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 "".
value
required string pro​valueFrom
required object pro​
Source for the environment variable's value. Cannot be used if value is not empty.
valueFrom
required object pro​fieldRef
required object pro​
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.
fieldRef
required object pro​metadata.labels['(KEY)']
, metadata.annotations['(KEY)']
,
spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.resourceFieldRef
required object pro​
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.
resourceFieldRef
required object pro​configMapKeyRef
required object pro​
Selects a key of a ConfigMap.
configMapKeyRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string pro​
The key to select.
key
required string pro​optional
required boolean pro​
Specify whether the ConfigMap or its key must be defined
optional
required boolean pro​secretKeyRef
required object pro​
Selects a key of a secret in the pod's namespace
secretKeyRef
required object pro​name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string pro​
The key of the secret to select from. Must be a valid secret key.
key
required string pro​optional
required boolean pro​
Specify whether the Secret or its key must be defined
optional
required boolean pro​resources
required object pro​
Compute Resources required by this container.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
resources
required object pro​limits
required object pro​
Limits describes the maximum amount of compute resources allowed.
More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
limits
required object pro​requests
required object pro​
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/
requests
required object pro​claims
required object[] pro​
Claims lists the names of resources, defined in spec.resourceClaims,
that are used by this container.
This is an alpha field and requires enabling the
DynamicResourceAllocation feature gate.
This field is immutable. It can only be set for containers.
claims
required object[] pro​name
required string pro​
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.
name
required string pro​resizePolicy
required object[] pro​
Resources resize policy for the container.
resizePolicy
required object[] pro​restartPolicy
required string pro​
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.
restartPolicy
required string pro​volumeMounts
required object[] pro​
Pod volumes to mount into the container's filesystem.
Cannot be updated.
volumeMounts
required object[] pro​name
required string pro​
This must match the Name of a Volume.
name
required string pro​readOnly
required boolean pro​
Mounted read-only if true, read-write otherwise (false or unspecified).
Defaults to false.
readOnly
required boolean pro​recursiveReadOnly
required string pro​
RecursiveReadOnly specifies whether read-only mounts should be handled
recursively.
If ReadOnly is false, this field has no meaning and must be unspecified.
If ReadOnly is true, and this field is set to Disabled, the mount is not made
recursively read-only. If this field is set to IfPossible, the mount is made
recursively read-only, if it is supported by the container runtime. If this
field is set to Enabled, the mount is made recursively read-only if it is
supported by the container runtime, otherwise the pod will not be started and
an error will be generated to indicate the reason.
If this field is set to IfPossible or Enabled, MountPropagation must be set to
None (or be unspecified, which defaults to None).
If this field is not specified, it is treated as an equivalent of Disabled.
recursiveReadOnly
required string pro​mountPath
required string pro​
Path within the container at which the volume should be mounted. Must
not contain ':'.
mountPath
required string pro​subPath
required string pro​
Path within the volume from which the container's volume should be mounted.
Defaults to "" (volume's root).
subPath
required string pro​mountPropagation
required string pro​
mountPropagation determines how mounts are propagated from the host
to container and the other way around.
When not set, MountPropagationNone is used.
This field is beta in 1.10.
When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified
(which defaults to None).
mountPropagation
required string pro​subPathExpr
required string pro​
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.
subPathExpr
required string pro​volumeDevices
required object[] pro​
volumeDevices is the list of block devices to be used by the container.
volumeDevices
required object[] pro​livenessProbe
required object pro​
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
livenessProbe
required object pro​exec
required object pro​
Exec specifies the action to take.
exec
required object pro​command
required string[] pro​
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.
command
required string[] pro​httpGet
required object pro​
HTTPGet specifies the http request to perform.
httpGet
required object pro​path
required string pro​
Path to access on the HTTP server.
path
required string pro​port
required object pro​
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.
port
required object pro​host
required string pro​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string pro​scheme
required string pro​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string pro​httpHeaders
required object[] pro​
Custom headers to set in the request. HTTP allows repeated headers.
httpHeaders
required object[] pro​tcpSocket
required object pro​
TCPSocket specifies an action involving a TCP port.
tcpSocket
required object pro​grpc
required object pro​
GRPC specifies an action involving a GRPC port.
grpc
required object pro​port
required integer pro​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer pro​service
required string pro​
Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
If this is not specified, the default behavior is defined by gRPC.
service
required string pro​initialDelaySeconds
required integer pro​
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
initialDelaySeconds
required integer pro​timeoutSeconds
required integer pro​
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
timeoutSeconds
required integer pro​periodSeconds
required integer pro​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer pro​successThreshold
required integer pro​
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.
successThreshold
required integer pro​failureThreshold
required integer pro​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer pro​terminationGracePeriodSeconds
required integer pro​
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.
terminationGracePeriodSeconds
required integer pro​readinessProbe
required object pro​
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
readinessProbe
required object pro​exec
required object pro​
Exec specifies the action to take.
exec
required object pro​command
required string[] pro​
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.
command
required string[] pro​httpGet
required object pro​
HTTPGet specifies the http request to perform.
httpGet
required object pro​path
required string pro​
Path to access on the HTTP server.
path
required string pro​port
required object pro​
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.
port
required object pro​host
required string pro​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string pro​scheme
required string pro​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string pro​httpHeaders
required object[] pro​
Custom headers to set in the request. HTTP allows repeated headers.
httpHeaders
required object[] pro​tcpSocket
required object pro​
TCPSocket specifies an action involving a TCP port.
tcpSocket
required object pro​grpc
required object pro​
GRPC specifies an action involving a GRPC port.
grpc
required object pro​port
required integer pro​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer pro​service
required string pro​
Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
If this is not specified, the default behavior is defined by gRPC.
service
required string pro​initialDelaySeconds
required integer pro​
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
initialDelaySeconds
required integer pro​timeoutSeconds
required integer pro​
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
timeoutSeconds
required integer pro​periodSeconds
required integer pro​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer pro​successThreshold
required integer pro​
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.
successThreshold
required integer pro​failureThreshold
required integer pro​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer pro​terminationGracePeriodSeconds
required integer pro​
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.
terminationGracePeriodSeconds
required integer pro​startupProbe
required object pro​
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
startupProbe
required object pro​exec
required object pro​
Exec specifies the action to take.
exec
required object pro​command
required string[] pro​
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.
command
required string[] pro​httpGet
required object pro​
HTTPGet specifies the http request to perform.
httpGet
required object pro​path
required string pro​
Path to access on the HTTP server.
path
required string pro​port
required object pro​
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.
port
required object pro​host
required string pro​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string pro​scheme
required string pro​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string pro​httpHeaders
required object[] pro​
Custom headers to set in the request. HTTP allows repeated headers.
httpHeaders
required object[] pro​tcpSocket
required object pro​
TCPSocket specifies an action involving a TCP port.
tcpSocket
required object pro​grpc
required object pro​
GRPC specifies an action involving a GRPC port.
grpc
required object pro​port
required integer pro​
Port number of the gRPC service. Number must be in the range 1 to 65535.
port
required integer pro​service
required string pro​
Service is the name of the service to place in the gRPC HealthCheckRequest
(see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).
If this is not specified, the default behavior is defined by gRPC.
service
required string pro​initialDelaySeconds
required integer pro​
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
initialDelaySeconds
required integer pro​timeoutSeconds
required integer pro​
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
timeoutSeconds
required integer pro​periodSeconds
required integer pro​
How often (in seconds) to perform the probe.
Default to 10 seconds. Minimum value is 1.
periodSeconds
required integer pro​successThreshold
required integer pro​
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.
successThreshold
required integer pro​failureThreshold
required integer pro​
Minimum consecutive failures for the probe to be considered failed after having succeeded.
Defaults to 3. Minimum value is 1.
failureThreshold
required integer pro​terminationGracePeriodSeconds
required integer pro​
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.
terminationGracePeriodSeconds
required integer pro​lifecycle
required object pro​
Actions that the management system should take in response to container lifecycle events.
Cannot be updated.
lifecycle
required object pro​postStart
required object pro​
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
postStart
required object pro​exec
required object pro​
Exec specifies the action to take.
exec
required object pro​command
required string[] pro​
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.
command
required string[] pro​httpGet
required object pro​
HTTPGet specifies the http request to perform.
httpGet
required object pro​path
required string pro​
Path to access on the HTTP server.
path
required string pro​port
required object pro​
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.
port
required object pro​host
required string pro​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string pro​scheme
required string pro​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string pro​httpHeaders
required object[] pro​
Custom headers to set in the request. HTTP allows repeated headers.
httpHeaders
required object[] pro​tcpSocket
required object pro​
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.
tcpSocket
required object pro​preStop
required object pro​
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
preStop
required object pro​exec
required object pro​
Exec specifies the action to take.
exec
required object pro​command
required string[] pro​
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.
command
required string[] pro​httpGet
required object pro​
HTTPGet specifies the http request to perform.
httpGet
required object pro​path
required string pro​
Path to access on the HTTP server.
path
required string pro​port
required object pro​
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.
port
required object pro​host
required string pro​
Host name to connect to, defaults to the pod IP. You probably want to set
"Host" in httpHeaders instead.
host
required string pro​scheme
required string pro​
Scheme to use for connecting to the host.
Defaults to HTTP.
scheme
required string pro​httpHeaders
required object[] pro​
Custom headers to set in the request. HTTP allows repeated headers.
httpHeaders
required object[] pro​tcpSocket
required object pro​
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.
tcpSocket
required object pro​terminationMessagePath
required string pro​
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.
terminationMessagePath
required string pro​terminationMessagePolicy
required string pro​
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.
terminationMessagePolicy
required string pro​imagePullPolicy
required string pro​
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
imagePullPolicy
required string pro​securityContext
required object pro​
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/
securityContext
required object pro​capabilities
required object pro​
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.
capabilities
required object pro​privileged
required boolean pro​
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.
privileged
required boolean pro​seLinuxOptions
required object pro​
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.
seLinuxOptions
required object pro​user
required string pro​
User is a SELinux user label that applies to the container.
user
required string pro​role
required string pro​
Role is a SELinux role label that applies to the container.
role
required string pro​type
required string pro​
Type is a SELinux type label that applies to the container.
type
required string pro​level
required string pro​
Level is SELinux level label that applies to the container.
level
required string pro​windowsOptions
required object pro​
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.
windowsOptions
required object pro​gmsaCredentialSpecName
required string pro​
GMSACredentialSpecName is the name of the GMSA credential spec to use.
gmsaCredentialSpecName
required string pro​gmsaCredentialSpec
required string pro​
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.
gmsaCredentialSpec
required string pro​runAsUserName
required string pro​
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.
runAsUserName
required string pro​hostProcess
required boolean pro​
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.
hostProcess
required boolean pro​runAsUser
required integer pro​
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.
runAsUser
required integer pro​runAsGroup
required integer pro​
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.
runAsGroup
required integer pro​runAsNonRoot
required boolean pro​
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.
runAsNonRoot
required boolean pro​readOnlyRootFilesystem
required boolean pro​
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.
readOnlyRootFilesystem
required boolean pro​allowPrivilegeEscalation
required boolean pro​
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:
- run as Privileged
- has CAP_SYS_ADMIN
Note that this field cannot be set when spec.os.name is windows.
allowPrivilegeEscalation
required boolean pro​procMount
required string pro​
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.
procMount
required string pro​seccompProfile
required object pro​
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.
seccompProfile
required object pro​type
required string pro​
type indicates which kind of seccomp profile will be applied.
Valid options are:
Localhost - a profile defined in a file on the node should be used.
RuntimeDefault - the container runtime default profile should be used.
Unconfined - no profile should be applied.
type
required string pro​localhostProfile
required string pro​
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.
localhostProfile
required string pro​appArmorProfile
required object pro​
appArmorProfile is the AppArmor options to use by this container. If set, this profile
overrides the pod's appArmorProfile.
Note that this field cannot be set when spec.os.name is windows.
appArmorProfile
required object pro​type
required string pro​
type indicates which kind of AppArmor profile will be applied.
Valid options are:
Localhost - a profile pre-loaded on the node.
RuntimeDefault - the container runtime's default profile.
Unconfined - no AppArmor enforcement.
type
required string pro​localhostProfile
required string pro​
localhostProfile indicates a profile loaded on the node that should be used.
The profile must be preconfigured on the node to work.
Must match the loaded name of the profile.
Must be set if and only if type is "Localhost".
localhostProfile
required string pro​stdin
required boolean pro​
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.
stdin
required boolean pro​stdinOnce
required boolean pro​
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
stdinOnce
required boolean pro​tty
required boolean pro​
Whether this container should allocate a TTY for itself, also requires 'stdin' to be true.
Default is false.
tty
required boolean pro​owner
required object pro​
Owner holds the owner of this object
owner
required object pro​unusable
required boolean pro​
If unusable is true, no DevPod workspaces can be scheduled on this runner.
unusable
required boolean pro​access
required object[] pro​
Access holds the access rights for users and teams
access
required object[] pro​name
required string pro​
Name is an optional name that is used for this access rule
name
required string pro​verbs
required string[] pro​
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
verbs
required string[] pro​subresources
required string[] pro​
Subresources defines the sub resources that are allowed by this access rule
subresources
required string[] pro​users
required string[] pro​
Users specifies which users should be able to access this secret with the aforementioned verbs
users
required string[] pro​teams
required string[] pro​
Teams specifies which teams should be able to access this secret with the aforementioned verbs
teams
required string[] pro​status
required object pro​
status
required object pro​phase
required string pro​
Phase describes the current phase the space instance is in
phase
required string pro​reason
required string pro​
Reason describes the reason in machine-readable form
reason
required string pro​message
required string pro​
Message describes the reason in human-readable form
message
required string pro​conditions
required object pro​
Conditions holds several conditions the virtual cluster might be in
conditions
required object pro​Retrieve: Runners​
You can either use curl or kubectl to retrieve Runners.
- kubectl
- curl
Retrieve a list of Runners​
Run the following command to list all Runners:
kubectl get runners.management.loft.sh -o yaml
Retrieve a single Runner by name​
Run the following kubectl command to get Runner my-runner
:
kubectl get runners.management.loft.sh my-runner -o yaml
Retrieve a list of Runners​
Run the following curl command to list all Runners:
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/runners" \
-X GET --insecure \
-H "Authorization: Bearer $ACCESS_KEY"
Get a single Runner by name​
Run the following curl command to get Runner my-runner
:
# Exchange my-runner in the url below with the name of the Runner
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/runners/my-runner" \
-X GET --insecure \
-H "Authorization: Bearer $ACCESS_KEY"
Create: Runner​
You can either use curl or kubectl to create a new Runner.
- kubectl
- curl
Create a file object.yaml
with the following contents:
apiVersion: management.loft.sh/v1
kind: Runner
metadata:
creationTimestamp: null
name: my-runner
spec:
displayName: my-display-name
status: {}
Then create the Runner my-runner
with:
kubectl create -f object.yaml
Create a file object.yaml
with the following contents:
apiVersion: management.loft.sh/v1
kind: Runner
metadata:
creationTimestamp: null
name: my-runner
spec:
displayName: my-display-name
status: {}
Run the following curl command to create a new Runner my-runner
:
curl -s -X POST --insecure \
"https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/runners" \
--data-binary "$(cat object.yaml)" \
-H "Content-Type: application/yaml" \
-H "Authorization: Bearer $ACCESS_KEY"
Update: Runner​
You can either use curl or kubectl to update Runners.
- kubectl
- curl
Update Runner​
Run the following command to update Runner my-runner
:
kubectl edit runners.management.loft.sh my-runner
Then edit the object and upon save, kubectl will update the resource.
Patch Runner​
Patching a resource is useful if you want to generically exchange only a small portion of the object instead of retrieving the whole object first and then modifying it. To learn more about patches in Kubernetes, please take a look at the official docs.
Run the following kubectl command to add a new annotation my-annotation: my-value
to the Runner my-runner
via a patch:
kubectl patch runners.management.loft.sh my-runner \
--type json \
-p '[{"op": "add", "path": "/metadata/annotations/my-annotation", "value": "my-value"}]'
Update Runner​
First retrieve the current object into a file object.yaml
. This could look like:
apiVersion: management.loft.sh/v1
kind: Runner
metadata:
creationTimestamp: "2023-04-03T00:00:00Z"
generation: 12
name: my-runner
resourceVersion: "66325905"
uid: af5f9f0f-8ab9-4b4b-a595-a95a5921f3c2
spec:
displayName: my-display-name
status: {}
Run the following curl command to update a single Runner my-runner
:
# Replace the my-runner in the url below with the name of the Runner you want to update
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/runners/my-runner" \
-X PUT --insecure \
-H "Content-Type: application/yaml" \
-H "Authorization: Bearer $ACCESS_KEY" \
--data-binary "$(cat object.yaml)"
Patch Runner​
Patching a resource is useful if you want to generically exchange only a small portion of the object instead of retrieving the whole object first and then modifying it. To learn more about patches in Kubernetes, please take a look at the official docs.
Run the following curl command to add a new annotation my-annotation: my-value
to the Runner my-runner
via a patch:
# Replace the my-runner in the url below with the name of the Runner you want to update
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/runners/my-runner" \
-X PATCH --insecure \
-H "Content-Type: application/json-patch+json" \
-H "Authorization: Bearer $ACCESS_KEY" \
--data '[{"op": "add", "path": "/metadata/annotations/my-annotation", "value": "my-value"}]'
Delete: Runner​
You can either use curl or kubectl to delete Runners.
- kubectl
- curl
Run the following command to delete Runner my-runner
:
kubectl delete runners.management.loft.sh my-runner
Run the following curl command to delete Runner my-runner
:
# Replace the my-runner in the url below with the name of the Runner you want to delete
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/runners/my-runner" \
-X DELETE --insecure \
-H "Authorization: Bearer $ACCESS_KEY"