Version: 3.4

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

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

`apiVersion` required string

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

`metadata` required object

`name` required string

Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

`generateName` required string

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

`namespace` required string

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

`selfLink` required string

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

`uid` required string

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

`resourceVersion` required string

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

`generation` required integer

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

`creationTimestamp` required object

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

`deletionTimestamp` required object

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

`deletionGracePeriodSeconds` required integer

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.

`labels` required object

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

`annotations` required object

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

`ownerReferences` required object[]

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.

`apiVersion` required string

API version of the referent.

`controller` required boolean false

If true, this reference points to the managing controller.

`blockOwnerDeletion` required boolean false

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.

`finalizers` required string[]

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.

`managedFields` required object[]

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.

`manager` required string

Manager is an identifier of the workflow managing these fields.

`operation` required string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

`apiVersion` required string

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.

`time` required object

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.

`fieldsType` required string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

`fieldsV1` required object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

`subresource` required string

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.

`spec` required object

`displayName` required string

The display name shown in the UI

`description` required string

Description describes a cluster access object

`endpoint` required string

Endpoint is the hostname used to connect directly to the runner

`clusterRef` required object

If ClusterRef is defined, Loft will schedule the runner on the given cluster.

`cluster` required string

Cluster is the connected cluster the space will be created in

`namespace` required string

Namespace is the namespace inside the connected cluster holding the space

`persistentVolumeClaimTemplate` required object

PersistentVolumeClaimTemplate holds additional options for the persistent volume claim

`metadata` required object

Metadata holds the template metadata

`labels` required object

Labels are labels on the object

`annotations` required object

Annotations are annotations on the object

`spec` required object

Spec holds the template spec

`accessModes` required string[]

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

`storageClassName` required string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

`storageSize` required string

storageSize is the size of the storage to reserve for the pvc

`podTemplate` required object

PodTemplate holds additional options for the runner pod

`metadata` required object

Metadata holds the template metadata

`labels` required object

Labels are labels on the object

`annotations` required object

Annotations are annotations on the object

`spec` required object

Spec holds the template spec

`image` required string

Runner pod image to use other than default

`resource` required object

Resources requirements

`limits` required object

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

`requests` required object

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

`claims` required object[]

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.

`name` required string

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

`envFrom` required object[]

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.

`prefix` required string

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

`configMapRef` required object

The ConfigMap to select from

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`optional` required boolean false

Specify whether the ConfigMap must be defined

`secretRef` required object

The Secret to select from

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`optional` required boolean false

Specify whether the Secret must be defined

`env` required object[]

List of environment variables to set in the container. Cannot be updated.

`name` required string

Name of the environment variable. Must be a C_IDENTIFIER.

`value` required string

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

`valueFrom` required object

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

`fieldRef` required object

Selects a field of the pod: supports metadata.name, metadata.namespace, metadata.labels['(KEY)'], metadata.annotations['(KEY)'], spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

`apiVersion` required string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

`fieldPath` required string

Path of the field to select in the specified API version.

`resourceFieldRef` required object

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

`containerName` required string

Container name: required for volumes, optional for env vars

`resource` required string

Required: resource to select

`divisor` required object

Specifies the output format of the exposed resources, defaults to "1"

`Format` required string

`configMapKeyRef` required object

Selects a key of a ConfigMap.

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`key` required string

The key to select.

`optional` required boolean false

Specify whether the ConfigMap or its key must be defined

`secretKeyRef` required object

Selects a key of a secret in the pod's namespace

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`key` required string

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

`optional` required boolean false

Specify whether the Secret or its key must be defined

`nodeSelector` required object

Set the NodeSelector for the Runner Pod

`affinity` required object

Set the Affinity for the Runner Pod

`nodeAffinity` required object

Describes node affinity scheduling rules for the pod.

`requiredDuringSchedulingIgnoredDuringExecution` required object

`nodeSelectorTerms` required object[]

Required. A list of node selector terms. The terms are ORed.

`matchExpressions` required object[]

A list of node selector requirements by node's labels.

`key` required string

The label key that the selector applies to.

`operator` required string

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

`values` required string[]

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

`matchFields` required object[]

A list of node selector requirements by node's fields.

`key` required string

The label key that the selector applies to.

`operator` required string

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

`values` required string[]

`preferredDuringSchedulingIgnoredDuringExecution` required object[]

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

`weight` required integer

Weight associated with matching the corresponding nodeSelectorTerm, in the range 1-100.

`preference` required object

A node selector term, associated with the corresponding weight.

`matchExpressions` required object[]

A list of node selector requirements by node's labels.

`key` required string

The label key that the selector applies to.

`operator` required string

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

`values` required string[]

`matchFields` required object[]

A list of node selector requirements by node's fields.

`key` required string

The label key that the selector applies to.

`operator` required string

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

`values` required string[]

`podAffinity` required object

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

`requiredDuringSchedulingIgnoredDuringExecution` required object[]

If the affinity requirements specified by this field are not met at scheduling time, the pod will not be scheduled onto the node. If the affinity requirements specified by this field cease to be met at some point during pod execution (e.g. due to 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.

`labelSelector` required object

A label query over a set of resources, in this case pods.

`matchLabels` required object

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

`matchExpressions` required object[]

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

`key` required string

key is the label key that the selector applies to.

`operator` required string

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

`values` required string[]

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

`namespaces` required string[]

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

`topologyKey` required string

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

`namespaceSelector` required object

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

`matchLabels` required object

`matchExpressions` required object[]

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

`key` required string

key is the label key that the selector applies to.

`operator` required string

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

`values` required string[]

`preferredDuringSchedulingIgnoredDuringExecution` required object[]

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

`weight` required integer

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

`podAffinityTerm` required object

Required. A pod affinity term, associated with the corresponding weight.

`labelSelector` required object

A label query over a set of resources, in this case pods.

`matchLabels` required object

`matchExpressions` required object[]

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

`key` required string

key is the label key that the selector applies to.

`operator` required string

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

`values` required string[]

`namespaces` required string[]

`topologyKey` required string

`namespaceSelector` required object

`matchLabels` required object

`matchExpressions` required object[]

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

`key` required string

key is the label key that the selector applies to.

`operator` required string

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

`values` required string[]

`podAntiAffinity` required object

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

`requiredDuringSchedulingIgnoredDuringExecution` required object[]

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.

`labelSelector` required object

A label query over a set of resources, in this case pods.

`matchLabels` required object

`matchExpressions` required object[]

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

`key` required string

key is the label key that the selector applies to.

`operator` required string

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

`values` required string[]

`namespaces` required string[]

`topologyKey` required string

`namespaceSelector` required object

`matchLabels` required object

`matchExpressions` required object[]

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

`key` required string

key is the label key that the selector applies to.

`operator` required string

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

`values` required string[]

`preferredDuringSchedulingIgnoredDuringExecution` required object[]

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

`weight` required integer

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

`podAffinityTerm` required object

Required. A pod affinity term, associated with the corresponding weight.

`labelSelector` required object

A label query over a set of resources, in this case pods.

`matchLabels` required object

`matchExpressions` required object[]

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

`key` required string

key is the label key that the selector applies to.

`operator` required string

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

`values` required string[]

`namespaces` required string[]

`topologyKey` required string

`namespaceSelector` required object

`matchLabels` required object

`matchExpressions` required object[]

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

`key` required string

key is the label key that the selector applies to.

`operator` required string

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

`values` required string[]

`tolerations` required object[]

Set the Tolerations for the Runner Pod

`key` required string

Key is the taint key that the toleration applies to. Empty means match all taint keys. If the key is empty, operator must be Exists; this combination means to match all values and all keys.

`operator` required string

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.

`value` required string

Value is the taint value the toleration matches to. If the operator is Exists, the value should be empty, otherwise just a regular string.

`effect` required string

Effect indicates the taint effect to match. Empty means match all taint effects. When specified, allowed values are NoSchedule, PreferNoSchedule and NoExecute.

`tolerationSeconds` required integer

TolerationSeconds represents the period of time the toleration (which must be of effect NoExecute, otherwise this field is ignored) tolerates the taint. By default, it is not set, which means tolerate the taint forever (do not evict). Zero and negative values will be treated as 0 (evict immediately) by the system.

`volumeMounts` required object[]

Set Volume Mounts for the Runner Pod

`name` required string

This must match the Name of a Volume.

`readOnly` required boolean false

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

`mountPath` required string

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

`subPath` required string

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

`mountPropagation` required string

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

`subPathExpr` required string

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

`volumes` required object[]

Set Volumes for the Runner Pod

`name` required string

name of the volume. Must be a DNS_LABEL and unique within the pod. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

`hostPath` required object

hostPath represents a pre-existing file or directory on the host machine that is directly exposed to the container. This is generally used for system agents or other privileged things that are allowed to see the host machine. Most containers will NOT need this.

More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

TODO(jonesdl) We need to restrict who can use host directory mounts and who can/can not mount host directories as read/write.

`path` required string

path of the directory on the host. If the path is a symlink, it will follow the link to the real path. More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

`type` required string

type for HostPath Volume Defaults to "" More info: https://kubernetes.io/docs/concepts/storage/volumes#hostpath

`emptyDir` required object

emptyDir represents a temporary directory that shares a pod's lifetime. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

`medium` required string

medium represents what type of storage medium should back this directory. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir

`sizeLimit` required object

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

`Format` required string

`gcePersistentDisk` required object

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

`pdName` required string

pdName is unique name of the PD resource in GCE. Used to identify the disk in GCE. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

`fsType` required string

fsType is filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk TODO: how do we prevent errors in the filesystem from compromising the machine

`partition` required integer

partition is the partition in the volume that you want to mount. If omitted, the default is to mount by volume name. Examples: For volume /dev/sda1, you specify the partition as "1". Similarly, the volume partition for /dev/sda is "0" (or you can leave the property empty). More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

`readOnly` required boolean false

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

`awsElasticBlockStore` required object

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

`volumeID` required string

volumeID is unique ID of the persistent disk resource in AWS (Amazon EBS volume). More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

`fsType` required string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore TODO: how do we prevent errors in the filesystem from compromising the machine

`partition` required integer

`readOnly` required boolean false

readOnly value true will force the readOnly setting in VolumeMounts. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore

`gitRepo` required object

gitRepo represents a git repository at a particular revision. DEPRECATED: GitRepo is deprecated. To provision a container with a git repo, mount an EmptyDir into an InitContainer that clones the repo using git, then mount the EmptyDir into the Pod's container.

`repository` required string

repository is the URL

`revision` required string

revision is the commit hash for the specified revision.

`directory` required string

directory is the target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.

`secret` required object

secret represents a secret that should populate this volume. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

`secretName` required string

secretName is the name of the secret in the pod's namespace to use. More info: https://kubernetes.io/docs/concepts/storage/volumes#secret

`items` required object[]

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 '..'.

`key` required string

key is the key to project.

`path` required string

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

`mode` required integer

mode is Optional: mode bits used to set permissions on this file. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

`defaultMode` required integer

defaultMode is Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

`optional` required boolean false

optional field specify whether the Secret or its keys must be defined

`nfs` required object

nfs represents an NFS mount on the host that shares a pod's lifetime More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

`server` required string

server is the hostname or IP address of the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

`path` required string

path that is exported by the NFS server. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

`readOnly` required boolean false

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

`iscsi` required object

iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://examples.k8s.io/volumes/iscsi/README.md

`targetPortal` required string

targetPortal is iSCSI Target Portal. The Portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

`iqn` required string

iqn is the target iSCSI Qualified Name.

`lun` required integer

lun represents iSCSI Target Lun number.

`iscsiInterface` required string

iscsiInterface is the interface Name that uses an iSCSI transport. Defaults to 'default' (tcp).

`fsType` required string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#iscsi TODO: how do we prevent errors in the filesystem from compromising the machine

`readOnly` required boolean false

readOnly here will force the ReadOnly setting in VolumeMounts. Defaults to false.

`portals` required string[]

portals is the iSCSI Target Portal List. The portal is either an IP or ip_addr:port if the port is other than default (typically TCP ports 860 and 3260).

`chapAuthDiscovery` required boolean false

chapAuthDiscovery defines whether support iSCSI Discovery CHAP authentication

`chapAuthSession` required boolean false

chapAuthSession defines whether support iSCSI Session CHAP authentication

`secretRef` required object

secretRef is the CHAP Secret for iSCSI target and initiator authentication

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`initiatorName` required string

initiatorName is the custom iSCSI Initiator Name. If initiatorName is specified with iscsiInterface simultaneously, new iSCSI interface (target portal):(volume name) will be created for the connection.

`glusterfs` required object

glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime. More info: https://examples.k8s.io/volumes/glusterfs/README.md

`endpoints` required string

endpoints is the endpoint name that details Glusterfs topology. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

`path` required string

path is the Glusterfs volume path. More info: https://examples.k8s.io/volumes/glusterfs/README.md#create-a-pod

`readOnly` required boolean false

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

`persistentVolumeClaim` required object

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

`claimName` required string

claimName is the name of a PersistentVolumeClaim in the same namespace as the pod using this volume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims

`readOnly` required boolean false

readOnly Will force the ReadOnly setting in VolumeMounts. Default false.

`rbd` required object

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

`monitors` required string[]

monitors is a collection of Ceph monitors. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

`image` required string

image is the rados image name. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

`fsType` required string

fsType is the filesystem type of the volume that you want to mount. Tip: Ensure that the filesystem type is supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://kubernetes.io/docs/concepts/storage/volumes#rbd TODO: how do we prevent errors in the filesystem from compromising the machine

`pool` required string

pool is the rados pool name. Default is rbd. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

`user` required string

user is the rados user name. Default is admin. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

`keyring` required string

keyring is the path to key ring for RBDUser. Default is /etc/ceph/keyring. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

`secretRef` required object

secretRef is name of the authentication secret for RBDUser. If provided overrides keyring. Default is nil. More info: https://examples.k8s.io/volumes/rbd/README.md#how-to-use-it

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`readOnly` required boolean false

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

`flexVolume` required object

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.

`driver` required string

driver is the name of the driver to use for this volume.

`fsType` required string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". The default filesystem depends on FlexVolume script.

`secretRef` required object

secretRef is Optional: secretRef is reference to the secret object containing sensitive information to pass to the plugin scripts. This may be empty if no secret object is specified. If the secret object contains more than one secret, all secrets are passed to the plugin scripts.

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`readOnly` required boolean false

readOnly is Optional: defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

`options` required object

options is Optional: this field holds extra command options if any.

`cinder` required object

cinder represents a cinder volume attached and mounted on kubelets host machine. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

`volumeID` required string

volumeID used to identify the volume in cinder. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

`fsType` required string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Examples: "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

`readOnly` required boolean false

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts. More info: https://examples.k8s.io/mysql-cinder-pd/README.md

`secretRef` required object

secretRef is optional: points to a secret object containing parameters used to connect to OpenStack.

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`cephfs` required object

cephFS represents a Ceph FS mount on the host that shares a pod's lifetime

`monitors` required string[]

monitors is Required: Monitors is a collection of Ceph monitors More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

`path` required string

path is Optional: Used as the mounted root, rather than the full Ceph tree, default is /

`user` required string

user is optional: User is the rados user name, default is admin More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

`secretFile` required string

secretFile is Optional: SecretFile is the path to key ring for User, default is /etc/ceph/user.secret More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

`secretRef` required object

secretRef is Optional: SecretRef is reference to the authentication secret for User, default is empty. More info: https://examples.k8s.io/volumes/cephfs/README.md#how-to-use-it

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`readOnly` required boolean false

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

`flocker` required object

flocker represents a Flocker volume attached to a kubelet's host machine. This depends on the Flocker control service being running

`datasetName` required string

datasetName is Name of the dataset stored as metadata -) name on the dataset for Flocker should be considered as deprecated

`datasetUUID` required string

datasetUUID is the UUID of the dataset. This is unique identifier of a Flocker dataset

`downwardAPI` required object

downwardAPI represents downward API about the pod that should populate this volume

`items` required object[]

Items is a list of downward API volume file

`path` required string

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

`fieldRef` required object

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

`apiVersion` required string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

`fieldPath` required string

Path of the field to select in the specified API version.

`resourceFieldRef` required object

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

`containerName` required string

Container name: required for volumes, optional for env vars

`resource` required string

Required: resource to select

`divisor` required object

Specifies the output format of the exposed resources, defaults to "1"

`Format` required string

`mode` required integer

Optional: mode bits used to set permissions on this file, must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. If not specified, the volume defaultMode will be used. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

`defaultMode` required integer

Optional: mode bits to use on created files by default. Must be a Optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

`fc` required object

fc represents a Fibre Channel resource that is attached to a kubelet's host machine and then exposed to the pod.

`targetWWNs` required string[]

targetWWNs is Optional: FC target worldwide names (WWNs)

`lun` required integer

lun is Optional: FC target lun number

`fsType` required string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified. TODO: how do we prevent errors in the filesystem from compromising the machine

`readOnly` required boolean false

readOnly is Optional: Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

`wwids` required string[]

wwids Optional: FC volume world wide identifiers (wwids) Either wwids or combination of targetWWNs and lun must be set, but not both simultaneously.

`azureFile` required object

azureFile represents an Azure File Service mount on the host and bind mount to the pod.

`secretName` required string

secretName is the name of secret that contains Azure Storage Account Name and Key

`shareName` required string

shareName is the azure share Name

`readOnly` required boolean false

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

`configMap` required object

configMap represents a configMap that should populate this volume

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`items` required object[]

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 '..'.

`key` required string

key is the key to project.

`path` required string

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

`mode` required integer

`defaultMode` required integer

defaultMode is optional: mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Defaults to 0644. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

`optional` required boolean false

optional specify whether the ConfigMap or its keys must be defined

`vsphereVolume` required object

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine

`volumePath` required string

volumePath is the path that identifies vSphere volume vmdk

`fsType` required string

fsType is filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

`storagePolicyName` required string

storagePolicyName is the storage Policy Based Management (SPBM) profile name.

`storagePolicyID` required string

storagePolicyID is the storage Policy Based Management (SPBM) profile ID associated with the StoragePolicyName.

`quobyte` required object

quobyte represents a Quobyte mount on the host that shares a pod's lifetime

`registry` required string

registry represents a single or multiple Quobyte Registry services specified as a string as host:port pair (multiple entries are separated with commas) which acts as the central registry for volumes

`volume` required string

volume is a string that references an already created Quobyte volume by name.

`readOnly` required boolean false

readOnly here will force the Quobyte volume to be mounted with read-only permissions. Defaults to false.

`user` required string

user to map volume access to Defaults to serivceaccount user

`group` required string

group to map volume access to Default is no group

`tenant` required string

tenant owning the given Quobyte volume in the Backend Used with dynamically provisioned Quobyte volumes, value is set by the plugin

`azureDisk` required object

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.

`diskName` required string

diskName is the Name of the data disk in the blob storage

`diskURI` required string

diskURI is the URI of data disk in the blob storage

`cachingMode` required string

cachingMode is the Host Caching mode: None, Read Only, Read Write.

`fsType` required string

fsType is Filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

`readOnly` required boolean false

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

`kind` required string

kind expected values are Shared: multiple blob disks per storage account Dedicated: single blob disk per storage account Managed: azure managed data disk (only in managed availability set). defaults to shared

`photonPersistentDisk` required object

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine

`pdID` required string

pdID is the ID that identifies Photon Controller persistent disk

`fsType` required string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

`projected` required object

projected items for all in one resources secrets, configmaps, and downward API

`sources` required object[]

sources is the list of volume projections

`secret` required object

secret information about the secret data to project

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`items` required object[]

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 '..'.

`key` required string

key is the key to project.

`path` required string

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

`mode` required integer

`optional` required boolean false

optional field specify whether the Secret or its key must be defined

`downwardAPI` required object

downwardAPI information about the downwardAPI data to project

`items` required object[]

Items is a list of DownwardAPIVolume file

`path` required string

Required: Path is the relative path name of the file to be created. Must not be absolute or contain the '..' path. Must be utf-8 encoded. The first item of the relative path must not start with '..'

`fieldRef` required object

Required: Selects a field of the pod: only annotations, labels, name and namespace are supported.

`apiVersion` required string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

`fieldPath` required string

Path of the field to select in the specified API version.

`resourceFieldRef` required object

Selects a resource of the container: only resources limits and requests (limits.cpu, limits.memory, requests.cpu and requests.memory) are currently supported.

`containerName` required string

Container name: required for volumes, optional for env vars

`resource` required string

Required: resource to select

`divisor` required object

Specifies the output format of the exposed resources, defaults to "1"

`Format` required string

`mode` required integer

`configMap` required object

configMap information about the configMap data to project

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`items` required object[]

`key` required string

key is the key to project.

`path` required string

path is the relative path of the file to map the key to. May not be an absolute path. May not contain the path element '..'. May not start with the string '..'.

`mode` required integer

`optional` required boolean false

optional specify whether the ConfigMap or its keys must be defined

`serviceAccountToken` required object

serviceAccountToken is information about the serviceAccountToken data to project

`audience` required string

audience is the intended audience of the token. A recipient of a token must identify itself with an identifier specified in the audience of the token, and otherwise should reject the token. The audience defaults to the identifier of the apiserver.

`expirationSeconds` required integer

expirationSeconds is the requested duration of validity of the service account token. As the token approaches expiration, the kubelet volume plugin will proactively rotate the service account token. The kubelet will start trying to rotate the token if the token is older than 80 percent of its time to live or if the token is older than 24 hours.Defaults to 1 hour and must be at least 10 minutes.

`path` required string

path is the path relative to the mount point of the file to project the token into.

`defaultMode` required integer

defaultMode are the mode bits used to set permissions on created files by default. Must be an octal value between 0000 and 0777 or a decimal value between 0 and 511. YAML accepts both octal and decimal values, JSON requires decimal values for mode bits. Directories within the path are not affected by this setting. This might be in conflict with other options that affect the file mode, like fsGroup, and the result can be other mode bits set.

`portworxVolume` required object

portworxVolume represents a portworx volume attached and mounted on kubelets host machine

`volumeID` required string

volumeID uniquely identifies a Portworx volume

`fsType` required string

fSType represents the filesystem type to mount Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs". Implicitly inferred to be "ext4" if unspecified.

`readOnly` required boolean false

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

`scaleIO` required object

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.

`gateway` required string

gateway is the host address of the ScaleIO API Gateway.

`system` required string

system is the name of the storage system as configured in ScaleIO.

`secretRef` required object

secretRef references to the secret for ScaleIO user and other sensitive information. If this is not provided, Login operation will fail.

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`sslEnabled` required boolean false

sslEnabled Flag enable/disable SSL communication with Gateway, default false

`protectionDomain` required string

protectionDomain is the name of the ScaleIO Protection Domain for the configured storage.

`storagePool` required string

storagePool is the ScaleIO Storage Pool associated with the protection domain.

`storageMode` required string

storageMode indicates whether the storage for a volume should be ThickProvisioned or ThinProvisioned. Default is ThinProvisioned.

`volumeName` required string

volumeName is the name of a volume already created in the ScaleIO system that is associated with this volume source.

`fsType` required string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Default is "xfs".

`readOnly` required boolean false

readOnly Defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

`storageos` required object

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.

`volumeName` required string

volumeName is the human-readable name of the StorageOS volume. Volume names are only unique within a namespace.

`volumeNamespace` required string

volumeNamespace specifies the scope of the volume within StorageOS. If no namespace is specified then the Pod's namespace will be used. This allows the Kubernetes name scoping to be mirrored within StorageOS for tighter integration. Set VolumeName to any name to override the default behaviour. Set to "default" if you are not using namespaces within StorageOS. Namespaces that do not pre-exist within StorageOS will be created.

`fsType` required string

fsType is the filesystem type to mount. Must be a filesystem type supported by the host operating system. Ex. "ext4", "xfs", "ntfs". Implicitly inferred to be "ext4" if unspecified.

`readOnly` required boolean false

readOnly defaults to false (read/write). ReadOnly here will force the ReadOnly setting in VolumeMounts.

`secretRef` required object

secretRef specifies the secret to use for obtaining the StorageOS API credentials. If not specified, default values will be attempted.

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`csi` required object

csi (Container Storage Interface) represents ephemeral storage that is handled by certain external CSI drivers (Beta feature).

`driver` required string

driver is the name of the CSI driver that handles this volume. Consult with your admin for the correct name as registered in the cluster.

`readOnly` required boolean false

readOnly specifies a read-only configuration for the volume. Defaults to false (read/write).

`fsType` required string

fsType to mount. Ex. "ext4", "xfs", "ntfs". If not provided, the empty value is passed to the associated CSI driver which will determine the default filesystem to apply.

`volumeAttributes` required object

volumeAttributes stores driver-specific properties that are passed to the CSI driver. Consult your driver's documentation for supported values.

`nodePublishSecretRef` required object

nodePublishSecretRef is a reference to the secret object containing sensitive information to pass to the CSI driver to complete the CSI NodePublishVolume and NodeUnpublishVolume calls. This field is optional, and may be empty if no secret is required. If the secret object contains more than one secret, all secret references are passed.

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`ephemeral` required object

ephemeral represents a volume that is handled by a cluster storage driver. The volume's lifecycle is tied to the pod that defines it - it will be created before the pod starts, and deleted when the pod is removed.

Use this if: a) the volume is only needed while the pod runs, b) features of normal volumes like restoring from snapshot or capacity tracking are needed, c) the storage driver is specified through a storage class, and d) the storage driver supports dynamic volume provisioning through a PersistentVolumeClaim (see EphemeralVolumeSource for more information on the connection between this volume type and PersistentVolumeClaim).

Use PersistentVolumeClaim or one of the vendor-specific APIs for volumes that persist for longer than the lifecycle of an individual pod.

Use CSI for light-weight local ephemeral volumes if the CSI driver is meant to be used that way - see the documentation of the driver for more information.

A pod can use both types of ephemeral volumes and persistent volumes at the same time.

`volumeClaimTemplate` required object

Will be used to create a stand-alone PVC to provision the volume. The pod in which this EphemeralVolumeSource is embedded will be the owner of the PVC, i.e. the PVC will be deleted together with the pod. The name of the PVC will be (pod name)-(volume name) where (volume name) is the name from the PodSpec.Volumes array entry. Pod validation will reject the pod if the concatenated name is not valid for a PVC (for example, too long).

An existing PVC with that name that is not owned by the pod will not be used for the pod to avoid using an unrelated volume by mistake. Starting the pod is then blocked until the unrelated PVC is removed. If such a pre-created PVC is meant to be used by the pod, the PVC has to updated with an owner reference to the pod once the pod exists. Normally this should not be necessary, but it may be useful when manually reconstructing a broken cluster.

This field is read-only and no changes will be made by Kubernetes to the PVC after it has been created.

Required, must not be nil.

`metadata` required object

`name` required string

`generateName` required string

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

`namespace` required string

Must be a DNS_LABEL. Cannot be updated. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

`selfLink` required string

Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

`uid` required string

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

`resourceVersion` required string

`generation` required integer

A sequence number representing a specific generation of the desired state. Populated by the system. Read-only.

`creationTimestamp` required object

Populated by the system. Read-only. Null for lists. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

`deletionTimestamp` required object

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

`deletionGracePeriodSeconds` required integer

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.

`labels` required object

`annotations` required object

`ownerReferences` required object[]

`apiVersion` required string

API version of the referent.

`kind` required string

Kind of the referent. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

`uid` required string

UID of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

`controller` required boolean false

If true, this reference points to the managing controller.

`blockOwnerDeletion` required boolean false

`finalizers` required string[]

`managedFields` required object[]

`manager` required string

Manager is an identifier of the workflow managing these fields.

`operation` required string

Operation is the type of operation which lead to this ManagedFieldsEntry being created. The only valid values for this field are 'Apply' and 'Update'.

`apiVersion` required string

`time` required object

`fieldsType` required string

FieldsType is the discriminator for the different fields format and version. There is currently only one possible value: "FieldsV1"

`fieldsV1` required object

FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

`subresource` required string

`spec` required object

The specification for the PersistentVolumeClaim. The entire content is copied unchanged into the PVC that gets created from this template. The same fields as in a PersistentVolumeClaim are also valid here.

`accessModes` required string[]

accessModes contains the desired access modes the volume should have. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes-1

`selector` required object

selector is a label query over volumes to consider for binding.

`matchLabels` required object

`matchExpressions` required object[]

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

`key` required string

key is the label key that the selector applies to.

`operator` required string

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

`values` required string[]

`resources` required object

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

`limits` required object

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

`requests` required object

`claims` required object[]

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.

`name` required string

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

`volumeName` required string

volumeName is the binding reference to the PersistentVolume backing this claim.

`storageClassName` required string

storageClassName is the name of the StorageClass required by the claim. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#class-1

`volumeMode` required string

volumeMode defines what type of volume is required by the claim. Value of Filesystem is implied when not included in claim spec.

`dataSource` required object

dataSource field can be used to specify either:

An existing VolumeSnapshot object (snapshot.storage.k8s.io/VolumeSnapshot)
An existing PVC (PersistentVolumeClaim) If the provisioner or an external controller can support the specified data source, it will create a new volume based on the contents of the specified data source. When the AnyVolumeDataSource feature gate is enabled, dataSource contents will be copied to dataSourceRef, and dataSourceRef contents will be copied to dataSource when dataSourceRef.namespace is not specified. If the namespace is specified, then dataSourceRef will not be copied to dataSource.

`apiGroup` required string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

`kind` required string

Kind is the type of resource being referenced

`name` required string

Name is the name of resource being referenced

`dataSourceRef` required object

dataSourceRef specifies the object from which to populate the volume with data, if a non-empty volume is desired. This may be any object from a non-empty API group (non core object) or a PersistentVolumeClaim object. When this field is specified, volume binding will only succeed if the type of the specified object matches some installed volume populator or dynamic provisioner. This field will replace the functionality of the dataSource field and as such if both fields are non-empty, they must have the same value. For backwards compatibility, when namespace isn't specified in dataSourceRef, both fields (dataSource and dataSourceRef) will be set to the same value automatically if one of them is empty and the other is non-empty. When namespace is specified in dataSourceRef, dataSource isn't set to the same value and must be empty. There are three important differences between dataSource and dataSourceRef:

While dataSource only allows two specific types of objects, dataSourceRef allows any non-core object, as well as PersistentVolumeClaim objects.
While dataSource ignores disallowed values (dropping them), dataSourceRef preserves all values, and generates an error if a disallowed value is specified.
While dataSource only allows local objects, dataSourceRef allows objects in any namespaces. (Beta) Using this field requires the AnyVolumeDataSource feature gate to be enabled. (Alpha) Using the namespace field of dataSourceRef requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

`apiGroup` required string

APIGroup is the group for the resource being referenced. If APIGroup is not specified, the specified Kind must be in the core API group. For any other third-party types, APIGroup is required.

`kind` required string

Kind is the type of resource being referenced

`name` required string

Name is the name of resource being referenced

`namespace` required string

Namespace is the namespace of resource being referenced Note that when a namespace is specified, a gateway.networking.k8s.io/ReferenceGrant object is required in the referent namespace to allow that namespace's owner to accept the reference. See the ReferenceGrant documentation for details. (Alpha) This field requires the CrossNamespaceVolumeDataSource feature gate to be enabled.

`initContainers` required object[]

Set up Init Containers for the Runner

`name` required string

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

`image` required string

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

`command` required string[]

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

`args` required string[]

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

`workingDir` required string

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

`ports` required object[]

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.

`name` required string

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

`hostPort` required integer

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

`containerPort` required integer

Number of port to expose on the pod's IP address. This must be a valid port number, 0 ( x ( 65536.

`protocol` required string

Protocol for port. Must be UDP, TCP, or SCTP. Defaults to "TCP".

`hostIP` required string

What host IP to bind the external port to.

`envFrom` required object[]

`prefix` required string

An optional identifier to prepend to each key in the ConfigMap. Must be a C_IDENTIFIER.

`configMapRef` required object

The ConfigMap to select from

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`optional` required boolean false

Specify whether the ConfigMap must be defined

`secretRef` required object

The Secret to select from

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`optional` required boolean false

Specify whether the Secret must be defined

`env` required object[]

List of environment variables to set in the container. Cannot be updated.

`name` required string

Name of the environment variable. Must be a C_IDENTIFIER.

`value` required string

`valueFrom` required object

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

`fieldRef` required object

`apiVersion` required string

Version of the schema the FieldPath is written in terms of, defaults to "v1".

`fieldPath` required string

Path of the field to select in the specified API version.

`resourceFieldRef` required object

`containerName` required string

Container name: required for volumes, optional for env vars

`resource` required string

Required: resource to select

`divisor` required object

Specifies the output format of the exposed resources, defaults to "1"

`Format` required string

`configMapKeyRef` required object

Selects a key of a ConfigMap.

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`key` required string

The key to select.

`optional` required boolean false

Specify whether the ConfigMap or its key must be defined

`secretKeyRef` required object

Selects a key of a secret in the pod's namespace

`name` required string

Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names TODO: Add other useful fields. apiVersion, kind, uid?

`key` required string

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

`optional` required boolean false

Specify whether the Secret or its key must be defined

`resources` required object

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

`limits` required object

Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

`requests` required object

`claims` required object[]

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.

`name` required string

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

`resizePolicy` required object[]

Resources resize policy for the container.

`resourceName` required string

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

`restartPolicy` required string

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

`restartPolicy` required string

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.

`volumeMounts` required object[]

Pod volumes to mount into the container's filesystem. Cannot be updated.

`name` required string

This must match the Name of a Volume.

`readOnly` required boolean false

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

`mountPath` required string

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

`subPath` required string

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

`mountPropagation` required string

mountPropagation determines how mounts are propagated from the host to container and the other way around. When not set, MountPropagationNone is used. This field is beta in 1.10.

`subPathExpr` required string

`volumeDevices` required object[]

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

`name` required string

name must match the name of a persistentVolumeClaim in the pod

`devicePath` required string

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

`livenessProbe` required object

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

`exec` required object

Exec specifies the action to take.

`command` required string[]

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

`httpGet` required object

HTTPGet specifies the http request to perform.

`path` required string

Path to access on the HTTP server.

`port` required object

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.

`Type` required integer

`IntVal` required integer

`StrVal` required string

`host` required string

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

`scheme` required string

Scheme to use for connecting to the host. Defaults to HTTP.

`httpHeaders` required object[]

Custom headers to set in the request. HTTP allows repeated headers.

`name` required string

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

`value` required string

The header field value

`tcpSocket` required object

TCPSocket specifies an action involving a TCP port.

`port` required object

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

`Type` required integer

`IntVal` required integer

`StrVal` required string

`host` required string

Optional: Host name to connect to, defaults to the pod IP.

`grpc` required object

GRPC specifies an action involving a GRPC port.

`port` required integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

`service` required string

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

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

`initialDelaySeconds` required integer

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

`timeoutSeconds` required integer

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

`periodSeconds` required integer

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

`successThreshold` required integer

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

`failureThreshold` required integer

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

`terminationGracePeriodSeconds` required integer

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

`readinessProbe` required object

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

`exec` required object

Exec specifies the action to take.

`command` required string[]

`httpGet` required object

HTTPGet specifies the http request to perform.

`path` required string

Path to access on the HTTP server.

`port` required object

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.

`Type` required integer

`IntVal` required integer

`StrVal` required string

`host` required string

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

`scheme` required string

Scheme to use for connecting to the host. Defaults to HTTP.

`httpHeaders` required object[]

Custom headers to set in the request. HTTP allows repeated headers.

`name` required string

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

`value` required string

The header field value

`tcpSocket` required object

TCPSocket specifies an action involving a TCP port.

`port` required object

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

`Type` required integer

`IntVal` required integer

`StrVal` required string

`host` required string

Optional: Host name to connect to, defaults to the pod IP.

`grpc` required object

GRPC specifies an action involving a GRPC port.

`port` required integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

`service` required string

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

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

`initialDelaySeconds` required integer

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

`timeoutSeconds` required integer

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

`periodSeconds` required integer

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

`successThreshold` required integer

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

`failureThreshold` required integer

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

`terminationGracePeriodSeconds` required integer

`startupProbe` required object

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

`exec` required object

Exec specifies the action to take.

`command` required string[]

`httpGet` required object

HTTPGet specifies the http request to perform.

`path` required string

Path to access on the HTTP server.

`port` required object

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.

`Type` required integer

`IntVal` required integer

`StrVal` required string

`host` required string

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

`scheme` required string

Scheme to use for connecting to the host. Defaults to HTTP.

`httpHeaders` required object[]

Custom headers to set in the request. HTTP allows repeated headers.

`name` required string

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

`value` required string

The header field value

`tcpSocket` required object

TCPSocket specifies an action involving a TCP port.

`port` required object

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

`Type` required integer

`IntVal` required integer

`StrVal` required string

`host` required string

Optional: Host name to connect to, defaults to the pod IP.

`grpc` required object

GRPC specifies an action involving a GRPC port.

`port` required integer

Port number of the gRPC service. Number must be in the range 1 to 65535.

`service` required string

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

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

`initialDelaySeconds` required integer

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

`timeoutSeconds` required integer

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

`periodSeconds` required integer

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

`successThreshold` required integer

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

`failureThreshold` required integer

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

`terminationGracePeriodSeconds` required integer

`lifecycle` required object

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

`postStart` required object

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

`exec` required object

Exec specifies the action to take.

`command` required string[]

`httpGet` required object

HTTPGet specifies the http request to perform.

`path` required string

Path to access on the HTTP server.

`port` required object

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.

`Type` required integer

`IntVal` required integer

`StrVal` required string

`host` required string

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

`scheme` required string

Scheme to use for connecting to the host. Defaults to HTTP.

`httpHeaders` required object[]

Custom headers to set in the request. HTTP allows repeated headers.

`name` required string

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

`value` required string

The header field value

`tcpSocket` required object

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.

`port` required object

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

`Type` required integer

`IntVal` required integer

`StrVal` required string

`host` required string

Optional: Host name to connect to, defaults to the pod IP.

`preStop` required object

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

`exec` required object

Exec specifies the action to take.

`command` required string[]

`httpGet` required object

HTTPGet specifies the http request to perform.

`path` required string

Path to access on the HTTP server.

`port` required object

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.

`Type` required integer

`IntVal` required integer

`StrVal` required string

`host` required string

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

`scheme` required string

Scheme to use for connecting to the host. Defaults to HTTP.

`httpHeaders` required object[]

Custom headers to set in the request. HTTP allows repeated headers.

`name` required string

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

`value` required string

The header field value

`tcpSocket` required object

`port` required object

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

`Type` required integer

`IntVal` required integer

`StrVal` required string

`host` required string

Optional: Host name to connect to, defaults to the pod IP.

`terminationMessagePath` required string

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

`terminationMessagePolicy` required string

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

`imagePullPolicy` required string

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

`securityContext` required object

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

`capabilities` required object

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

`add` required string[]

Added capabilities

`drop` required string[]

Removed capabilities

`privileged` required boolean false

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.

`seLinuxOptions` required object

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

`user` required string

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

`role` required string

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

`type` required string

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

`level` required string

Level is SELinux level label that applies to the container.

`windowsOptions` required object

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

`gmsaCredentialSpecName` required string

GMSACredentialSpecName is the name of the GMSA credential spec to use.

`gmsaCredentialSpec` required string

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

`runAsUserName` required string

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

`hostProcess` required boolean false

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.

`runAsUser` required integer

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

`runAsGroup` required integer

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

`runAsNonRoot` required boolean false

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.

`readOnlyRootFilesystem` required boolean false

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.

`allowPrivilegeEscalation` required boolean false

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

`procMount` required string

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.

`seccompProfile` required object

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

`type` required string

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

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

`localhostProfile` required string

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

`stdin` required boolean false

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

`stdinOnce` required boolean false

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

`tty` required boolean false

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

`hostAliases` required object[]

Set host aliases for the Runner Pod

`ip` required string

IP address of the host file entry.

`hostnames` required string[]

Hostnames for the above IP address.

`owner` required object

Owner holds the owner of this object

`user` required string

User specifies a Loft user.

`team` required string

Team specifies a Loft team.

`unusable` required boolean false

If unusable is true, no DevPod workspaces can be scheduled on this runner.

`access` required object[]

Access holds the access rights for users and teams

`name` required string

Name is an optional name that is used for this access rule

`verbs` required string[]

Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.

`subresources` required string[]

Subresources defines the sub resources that are allowed by this access rule

`users` required string[]

Users specifies which users should be able to access this secret with the aforementioned verbs

`teams` required string[]

Teams specifies which teams should be able to access this secret with the aforementioned verbs

`status` required object

`phase` required string

Phase describes the current phase the space instance is in

`reason` required string

Reason describes the reason in machine-readable form

`message` required string

Message describes the reason in human-readable form

`conditions` required object

Conditions holds several conditions the virtual cluster might be in

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

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"

Example Runner​

Runner Reference​

kind required string ​

apiVersion required string ​

metadata required object ​

name required string ​

generateName required string ​

namespace required string ​

selfLink required string ​

uid required string ​

resourceVersion required string ​

generation required integer ​

creationTimestamp required object ​

deletionTimestamp required object ​

deletionGracePeriodSeconds required integer ​

labels required object ​

annotations required object ​

ownerReferences required object[] ​

apiVersion required string ​

kind required string ​

name required string ​

uid required string ​

controller required boolean false ​

blockOwnerDeletion required boolean false ​

finalizers required string[] ​

managedFields required object[] ​

manager required string ​

operation required string ​

apiVersion required string ​

time required object ​

fieldsType required string ​

fieldsV1 required object ​

subresource required string ​

spec required object ​

displayName required string ​

description required string ​

endpoint required string ​

clusterRef required object ​

cluster required string ​

namespace required string ​

persistentVolumeClaimTemplate required object ​

metadata required object ​

labels required object ​

annotations required object ​

spec required object ​

accessModes required string[] ​

storageClassName required string ​

storageSize required string ​

podTemplate required object ​

metadata required object ​

labels required object ​

annotations required object ​

spec required object ​

image required string ​

resource required object ​

limits required object ​

requests required object ​

claims required object[] ​

name required string ​

envFrom required object[] ​

prefix required string ​

configMapRef required object ​

name required string ​

optional required boolean false ​

secretRef required object ​

name required string ​

optional required boolean false ​

env required object[] ​

name required string ​

value required string ​

valueFrom required object ​

fieldRef required object ​

apiVersion required string ​

fieldPath required string ​

resourceFieldRef required object ​

containerName required string ​

resource required string ​

divisor required object ​

Format required string ​

configMapKeyRef required object ​

Example Runner

Runner Reference

`kind` required string

`apiVersion` required string

`metadata` required object

`name` required string

`generateName` required string

`namespace` required string

`selfLink` required string

`uid` required string

`resourceVersion` required string

`generation` required integer

`creationTimestamp` required object

`deletionTimestamp` required object

`deletionGracePeriodSeconds` required integer

`labels` required object

`annotations` required object

`ownerReferences` required object[]

`apiVersion` required string

`kind` required string

`name` required string

`uid` required string

`controller` required boolean false

`blockOwnerDeletion` required boolean false

`finalizers` required string[]

`managedFields` required object[]

`manager` required string

`operation` required string

`apiVersion` required string

`time` required object

`fieldsType` required string

`fieldsV1` required object

`subresource` required string

`spec` required object

`displayName` required string

`description` required string

`endpoint` required string

`clusterRef` required object

`cluster` required string

`namespace` required string

`persistentVolumeClaimTemplate` required object

`metadata` required object

`labels` required object

`annotations` required object

`spec` required object

`accessModes` required string[]

`storageClassName` required string

`storageSize` required string

`podTemplate` required object

`metadata` required object

`labels` required object

`annotations` required object

`spec` required object

`image` required string

`resource` required object

`limits` required object

`requests` required object

`claims` required object[]

`name` required string

`envFrom` required object[]

`prefix` required string

`configMapRef` required object

`name` required string

`optional` required boolean false

`secretRef` required object

`name` required string

`optional` required boolean false

`env` required object[]

`name` required string

`value` required string

`valueFrom` required object

`fieldRef` required object

`apiVersion` required string

`fieldPath` required string

`resourceFieldRef` required object

`containerName` required string

`resource` required string

`divisor` required object

`Format` required string

`configMapKeyRef` required object