Packages > pkg.pkl-lang.org/pkl-k8s/k8s

k8s.api.core.v1.Volume1.2.1

Properties
Methods
Classes
Type Aliases

module k8s.api.core.v1.Volume extends k8s.K8sObject

Volume represents a named volume in a pod that may be accessed by any container in the pod.

Module URI:: package://pkg.pkl-lang.org/pkl-k8s/k8s@1.2.1#/api/core/v1/Volume.pkl
Pkl version:: 0.25.0 or higher
Source code:: Volume.pkl
Known subtypes:
Known usages:: PodPresetSpec, PodSpec
All versions:: 1.2.1, 1.2.0, 1.1.3, 1.1.2, 1.1.1, 1.1.0, 1.0.1

Properties(show inherited)

link

hidden

output: ModuleOutput (pkl.base)Source

The output of this module.

Defaults to all module properties rendered as either Pcf or the format specified on the command line.
link

quobyte: QuobyteVolumeSource?Source

Deprecated.

quobyte represents a Quobyte mount on the host that shares a pod's lifetime.
Deprecated: Quobyte is deprecated and the in-tree quobyte type is no longer supported.
link

azureFile: AzureFileVolumeSource?Source

Deprecated.

azureFile represents an Azure File Service mount on the host and bind mount to the pod.
Deprecated: AzureFile is deprecated. All operations for the in-tree azureFile type are redirected to the file.csi.azure.com CSI driver.
link

flexVolume: FlexVolumeSource?Source

Deprecated.

flexVolume represents a generic volume resource that is provisioned/attached using an exec based plugin.
Deprecated: FlexVolume is deprecated. Consider using a CSIDriver instead.
link

ephemeral: EphemeralVolumeSource?Source

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

secret: SecretVolumeSource?Source

secret represents a secret that should populate this volume.

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

projected: ProjectedVolumeSource?Source

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

cephfs: CephFSVolumeSource?Source

Deprecated.

cephFS represents a Ceph FS mount on the host that shares a pod's lifetime.
Deprecated: CephFS is deprecated and the in-tree cephfs type is no longer supported.
link

scaleIO: ScaleIOVolumeSource?Source

Deprecated.

scaleIO represents a ScaleIO persistent volume attached and mounted on Kubernetes nodes.
Deprecated: ScaleIO is deprecated and the in-tree scaleIO type is no longer supported.
link

emptyDir: EmptyDirVolumeSource?Source

emptyDir represents a temporary directory that shares a pod's lifetime.

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

glusterfs: GlusterfsVolumeSource?Source

Deprecated.

glusterfs represents a Glusterfs mount on the host that shares a pod's lifetime.
Deprecated: Glusterfs is deprecated and the in-tree glusterfs type is no longer supported. More info: https://examples.k8s.io/volumes/glusterfs/README.md
link

gcePersistentDisk: GCEPersistentDiskVolumeSource?Source

Deprecated.

gcePersistentDisk represents a GCE Disk resource that is attached to a kubelet's host machine and then exposed to the pod.
Deprecated: GCEPersistentDisk is deprecated. All operations for the in-tree gcePersistentDisk type are redirected to the pd.csi.storage.gke.io CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk
link
image: ImageVolumeSource?Source

image represents an OCI object (a container image or artifact) pulled and mounted on the kubelet's host machine.
The volume is resolved at pod startup depending on which PullPolicy value is provided:
- Always: the kubelet always attempts to pull the reference. Container creation will fail If the pull fails.
- Never: the kubelet never pulls the reference and only uses a local image or artifact. Container creation will fail if the reference isn't present.
- IfNotPresent: the kubelet pulls if the reference isn't already present on disk. Container creation will fail if the reference isn't present and the pull fails.
The volume gets re-resolved if the pod gets deleted and recreated, which means that new remote content will become available on pod recreation. A failure to resolve or pull the image during pod startup will block containers from starting and may add significant latency. Failures will be retried using normal volume backoff and will be reported on the pod reason and message. The types of objects that may be mounted by this volume are defined by the container runtime implementation on a host machine and at minimum must include all valid types supported by the container image field. The OCI object gets mounted in a single directory (spec.containers*.volumeMounts.mountPath) by merging the manifest layers in the same way as for container images. The volume will be mounted read-only (ro) and non-executable files (noexec). Sub path mounts for containers are not supported (spec.containers*.volumeMounts.subpath). The field spec.securityContext.fsGroupChangePolicy has no effect on this volume type.
link

photonPersistentDisk: PhotonPersistentDiskVolumeSource?Source

Deprecated.

photonPersistentDisk represents a PhotonController persistent disk attached and mounted on kubelets host machine.
Deprecated: PhotonPersistentDisk is deprecated and the in-tree photonPersistentDisk type is no longer supported.
link

azureDisk: AzureDiskVolumeSource?Source

Deprecated.

azureDisk represents an Azure Data Disk mount on the host and bind mount to the pod.
Deprecated: AzureDisk is deprecated. All operations for the in-tree azureDisk type are redirected to the disk.csi.azure.com CSI driver.
link

cinder: CinderVolumeSource?Source

Deprecated.

cinder represents a cinder volume attached and mounted on kubelets host machine.
Deprecated: Cinder is deprecated. All operations for the in-tree cinder type are redirected to the cinder.csi.openstack.org CSI driver. More info: https://examples.k8s.io/mysql-cinder-pd/README.md
link

downwardAPI: DownwardAPIVolumeSource?Source

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

awsElasticBlockStore: AWSElasticBlockStoreVolumeSource?Source

Deprecated.

awsElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod.
Deprecated: AWSElasticBlockStore is deprecated. All operations for the in-tree awsElasticBlockStore type are redirected to the ebs.csi.aws.com CSI driver. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore
link

flocker: FlockerVolumeSource?Source

Deprecated.

flocker represents a Flocker volume attached to a kubelet's host machine.
This depends on the Flocker control service being running. Deprecated: Flocker is deprecated and the in-tree flocker type is no longer supported.
link

iscsi: ISCSIVolumeSource?Source

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
link

rbd: RBDVolumeSource?Source

Deprecated.

rbd represents a Rados Block Device mount on the host that shares a pod's lifetime.
Deprecated: RBD is deprecated and the in-tree rbd type is no longer supported. More info: https://examples.k8s.io/volumes/rbd/README.md
link

configMap: ConfigMapVolumeSource?Source

configMap represents a configMap that should populate this volume
link

storageos: StorageOSVolumeSource?Source

Deprecated.

storageOS represents a StorageOS volume attached and mounted on Kubernetes nodes.
Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported.
link

csi: CSIVolumeSource?Source

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

name: Rfc1035Label Source

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
link

nfs: NFSVolumeSource?Source

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

persistentVolumeClaim: PersistentVolumeClaimVolumeSource?Source

persistentVolumeClaimVolumeSource represents a reference to a PersistentVolumeClaim in the same namespace.

More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#persistentvolumeclaims
link

gitRepo: GitRepoVolumeSource?Source

Deprecated.

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

portworxVolume: PortworxVolumeSource?Source

Deprecated.

portworxVolume represents a portworx volume attached and mounted on kubelets host machine.
Deprecated: PortworxVolume is deprecated. All operations for the in-tree portworxVolume type are redirected to the pxd.portworx.com CSI driver when the CSIMigrationPortworx feature-gate is on.
link

vsphereVolume: VsphereVirtualDiskVolumeSource?Source

Deprecated.

vsphereVolume represents a vSphere volume attached and mounted on kubelets host machine.
Deprecated: VsphereVolume is deprecated. All operations for the in-tree vsphereVolume type are redirected to the csi.vsphere.vmware.com CSI driver.
link

fc: FCVolumeSource?Source

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

hostPath: HostPathVolumeSource?Source

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

Methods(show inherited)

link

function

getClass(): Class (pkl.base)Source

Returns the class of this.
link

function

toString(): String (pkl.base)Source

Returns a string representation of this.

This method is used to convert the values of string interpolation expressions to strings.
link

function

ifNonNull<Result>(transform: (NonNull) -> Result): Result? (pkl.base)Source

Returns this |> transform if this is non-null, and null otherwise.

This method is the complement of the ?? operator and the equivalent of an Option type's map and flatMap methods.
link

function

hasProperty(name: String): Boolean (pkl.base)Source

Tells if this object has a property with the given name.
link

function

getProperty(name: String): unknown (pkl.base)Source

Returns the value of the property with the given name.

Throws if a property with this name does not exist.
link

function

getPropertyOrNull(name: String): unknown? (pkl.base)Source

Returns the value of the property with the given name.

Returns null if a property with this name does not exist.
link

function

toDynamic(): Dynamic (pkl.base)Source

Converts this object to a Dynamic object.
link

function

toMap(): Map<String, unknown> (pkl.base)Source

Converts this object to a Map.
link

function
relativePathTo(other: Module): List<String> (pkl.base)Source

Returns the relative, descendent directory path between this module and other.
Throws if no such path exists.

For example, if module mod1 has path /dir1/mod1.pkl, and module mod2 has path /dir1/dir2/dir3/mod2.pkl, then mod1.relativePathTo(mod2) will return List("dir2", "dir3").

A common use case is to compute the directory path between a template located at the root of a hierarchy (say rootModule.pkl) and the currently evaluated module (accessible via the module keyword):
```
import "rootModule.pkl" // self-import
path = rootModule.relativePathTo(module)
```
link

function

hasUniquePortNames(l: Listing): Boolean (k8s.K8sObject)

Tells if every port in l has a unique name. null names are ignored.
link

function

hasNonNullPortNames(l: Listing): Boolean (k8s.K8sObject)

Tells if every port in l has a non-null name, unless l has just a single port.
link

function

exactlyOneSet(a: Any, b: Any, c: Any): unknown (k8s.K8sObject)

Tells if exactly one of the three arguments is non-null.
link

function

exactlyOneSet4(a: Any, b: Any, c: Any, d: Any): unknown (k8s.K8sObject)

Tells if exactly one of the four arguments is non-null.
link

function

onlyAllowedIf(str: String?, cond: Boolean): unknown (k8s.K8sObject)

Tells if str is only set when cond holds.

Classes(show inherited)

link

class

K8sVersion extends Annotation (k8s.K8sObject)

Indicates Kubernetes version information for the annotated member.
link

class

AzureFileVolumeSource Source

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

class

FlexVolumeSource Source

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

class

EphemeralVolumeSource Source

Represents an ephemeral volume that is handled by a normal storage driver.
link

class

PersistentVolumeClaimTemplate Source

PersistentVolumeClaimTemplate is used to produce PersistentVolumeClaim objects as part of an EphemeralVolumeSource.
link

class

SecretVolumeSource Source

Adapts a Secret into a volume.
link

class

KeyToPath Source

Maps a string key to a path within a volume.
link

class

ProjectedVolumeSource Source

Represents a projected volume source
link

class

VolumeProjection Source

Projection that may be projected along with other supported volume types.
link

class

DownwardAPIProjection Source

Represents downward API info for projecting into a projected volume.
link

class

DownwardAPIVolumeFile Source

DownwardAPIVolumeFile represents information to create the file containing the pod field
link

class

ConfigMapProjection Source

Adapts a ConfigMap into a projected volume.
link

class

SecretProjection Source

Adapts a secret into a projected volume.
link

class

ServiceAccountTokenProjection Source

ServiceAccountTokenProjection represents a projected service account token volume.
link

class

ClusterTrustBundleProjection Source

ClusterTrustBundleProjection describes how to select a set of ClusterTrustBundle objects and project their contents into the pod filesystem.
link

class

CephFSVolumeSource Source

Represents a Ceph Filesystem mount that lasts the lifetime of a pod Cephfs volumes do not support ownership management or SELinux relabeling.
link

class

ScaleIOVolumeSource Source

ScaleIOVolumeSource represents a persistent ScaleIO volume
link

class

EmptyDirVolumeSource Source

Represents an empty directory for a pod.
link

class

GlusterfsVolumeSource Source

Represents a Glusterfs mount that lasts the lifetime of a pod.
link

class

ImageVolumeSource Source

ImageVolumeSource represents a image volume resource.
link

class

CinderVolumeSource Source

Represents a cinder volume resource in Openstack.
link

class

DownwardAPIVolumeSource Source

DownwardAPIVolumeSource represents a volume containing downward API info.
link

class

ISCSIVolumeSource Source

Represents an ISCSI disk.
link

class

RBDVolumeSource Source

Represents a Rados Block Device mount that lasts the lifetime of a pod.
link

class

ConfigMapVolumeSource Source

Adapts a ConfigMap into a volume.
link

class

StorageOSVolumeSource Source

Represents a StorageOS persistent volume resource.
link

class

CSIVolumeSource Source

Represents a source location of a volume to mount, managed by an external CSI driver
link

class

PersistentVolumeClaimVolumeSource Source

PersistentVolumeClaimVolumeSource references the user's PVC in the same namespace.
link

class

GitRepoVolumeSource Source

Deprecated.

Type Aliases(show inherited)

link

typealias
Quantity = DataSize|Int|Float|String(matches(Regex(#"[+-]?(\d+(.\d*)?|\.\d+)([eE][+-]?(\d+(.\d*)?|\.\d+)|m|k|Ki|Mi?|Gi?|Ti?|Pi?|Ei?)?"#))) (k8s.K8sObject)

A fixed-point representation of a number.
Examples:
```
12
12e6
12.34
"12Mi" (12 * 2^20)
"12M"  (12 * 10^6)
12.mb (a [DataSize])
```
link

typealias

Time = String (k8s.K8sObject)

An RFC 3339 date and time value.

Example: "2016-04-21T08:47:53Z"
link

typealias

MicroTime = String (k8s.K8sObject)

A version of Time with microsecond level precision.
link

typealias

PortNumber = Int(isBetween(1, 65535)) (k8s.K8sObject)

A port number.
link

typealias

PortName = String(length <= 15, matches(Regex("[a-z0-9]+(-[a-z0-9]+)*")), contains(Regex("[a-z]"))) (k8s.K8sObject)

A port name conforming to RFC 6335 IANA service name syntax.

Contrary to the RFC, Kubernetes does not allow uppercase letters.
link

typealias

Rfc1035Label = String(length <= 63, matches(Regex("[a-z]([-a-z0-9]*[a-z0-9])?"))) (k8s.K8sObject)

An RFC 1035 DNS label.

Contrary to the RFC, Kubernetes does not allow uppercase letters.
link

typealias

Rfc1123Label = String(length <= 63, matches(Regex("[a-z0-9]([-a-z0-9]*[a-z0-9])?"))) (k8s.K8sObject)

An RFC 1123 DNS label.

Contrary to the RFC, Kubernetes does not allow uppercase letters.
link

typealias

Rfc1123Hostname = String(length <= 253, matches(Regex("[a-z0-9]([-a-z0-9]*[a-z0-9])?(\\.[a-z0-9]([-a-z0-9]*[a-z0-9])?)*"))) (k8s.K8sObject)

An RFC 1123 hostname.

Contrary to the RFC, Kubernetes does not allow uppercase letters.
link

typealias

ApiRequestVerb = "get"|"list"|"watch"|"create"|"update"|"patch"|"delete"|"deletecollection"|"*"|"use"|"bind"|"escalate"|"impersonate"|String (k8s.K8sObject)

API verbs like get, list, create, update, patch, watch, delete, and deletecollection are used for resource requests.

To determine the request verb for a resource API endpoint, see Determine the request verb. CRDs may use verbs outside of the predefined set.
link

typealias

HttpRequestVerb = "get"|"post"|"put"|"delete"|"patch"|"head"|"*" (k8s.K8sObject)

Lowercased HTTP methods like get, post, put, and delete are used for non-resource requests.
link

typealias
FieldsV1 = String (k8s.K8sObject)

FieldsV1 stores a set of fields in a data structure like a Trie, in JSON format.
Each key is either a '.' representing the field itself, and will always map to an empty set, or a string representing a sub-field or item. The string will follow one of these four formats:
- 'f:', where is the name of a field in a struct, or key in a map
- 'v:', where is the exact json formatted value of a list item
- 'i:', where is position of a item in a list
- 'k:', where is a map of a list item's key fields to their unique values
If a key maps to an empty Fields value, the field that key represents is part of the set. The exact format is defined in sigs.k8s.io/structured-merge-diff.
link

typealias

RawExtension = Dynamic (k8s.K8sObject)

RawExtension is used to hold extensions in external versions.