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

k8s.api.core.v1.PersistentVolumeSpec1.2.1

Properties
Methods
Classes
Type Aliases

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

PersistentVolumeSpec is the specification of a persistent volume.

Module URI:: package://pkg.pkl-lang.org/pkl-k8s/k8s@1.2.1#/api/core/v1/PersistentVolumeSpec.pkl
Pkl version:: 0.25.0 or higher
Source code:: PersistentVolumeSpec.pkl
Known subtypes:
Known usages:: PersistentVolume, VolumeAttachmentSource, VolumeAttachmentSource, VolumeAttachmentSource
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

claimRef: ObjectReference?Source

claimRef is part of a bi-directional binding between PersistentVolume and PersistentVolumeClaim.

Expected to be non-nil when bound. claim.VolumeName is the authoritative bind between PV and PVC. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#binding
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: AzureFilePersistentVolumeSource?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: FlexPersistentVolumeSource?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

volumeAttributesClassName: String?Source

Name of VolumeAttributesClass to which this persistent volume belongs.

Empty value is not allowed. When this field is not set, it indicates that this volume does not belong to any VolumeAttributesClass. This field is mutable and can be changed by the CSI driver after a volume has been updated successfully to a new class. For an unbound PersistentVolume, the volumeAttributesClassName will be matched with unbound PersistentVolumeClaims during the binding process. This is a beta field and requires enabling VolumeAttributesClass feature (off by default).
link

mountOptions: Listing<String>?Source

mountOptions is the list of mount options, e.g. "ro", "soft".

Not validated - mount will simply fail if one is invalid. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#mount-options
link

`local`: LocalVolumeSource?Source

local represents directly-attached storage with node affinity
link

capacity: Mapping<String, Quantity>?Source

capacity is the description of the persistent volume's resources and capacity.

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

cephfs: CephFSPersistentVolumeSource?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: ScaleIOPersistentVolumeSource?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

accessModes: Listing<String>?Source

accessModes contains all ways the volume can be mounted.

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

glusterfs: GlusterfsPersistentVolumeSource?Source

Deprecated.

glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod.
Provisioned by an admin. 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.
Provisioned by an admin. 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

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: CinderPersistentVolumeSource?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

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

nodeAffinity: VolumeNodeAffinity?Source

nodeAffinity defines constraints that limit what nodes this volume can be accessed from.

This field influences the scheduling of pods that use this volume.
link

flocker: FlockerVolumeSource?Source

Deprecated.

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

volumeMode: String?Source

volumeMode defines if a volume is intended to be used with a formatted filesystem or to remain in raw block state.

Value of Filesystem is implied when not included in spec.
link

iscsi: ISCSIPersistentVolumeSource?Source

iscsi represents an ISCSI Disk resource that is attached to a kubelet's host machine and then exposed to the pod.

Provisioned by an admin.
link

rbd: RBDPersistentVolumeSource?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

storageClassName: String?Source

storageClassName is the name of StorageClass to which this persistent volume belongs.

Empty value means that this volume does not belong to any StorageClass.
link

storageos: StorageOSPersistentVolumeSource?Source

Deprecated.

storageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod.
Deprecated: StorageOS is deprecated and the in-tree storageos type is no longer supported. More info: https://examples.k8s.io/volumes/storageos/README.md
link

csi: CSIPersistentVolumeSource?Source

csi represents storage that is handled by an external CSI driver.
link

nfs: NFSVolumeSource?Source

nfs represents an NFS mount on the host.

Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs
link

persistentVolumeReclaimPolicy: ("Retain"|"Delete"|"Recycle")?Source

persistentVolumeReclaimPolicy defines what happens to a persistent volume when released from its claim.

Valid options are Retain (default for manually created PersistentVolumes), Delete (default for dynamically provisioned PersistentVolumes), and Recycle (deprecated). Recycle must be supported by the volume plugin underlying this PersistentVolume. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#reclaiming
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 directory on the host.

Provisioned by a developer or tester. This is useful for single-node development and testing only! On-host storage is not supported in any way and WILL NOT WORK in a multi-node cluster. 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

AzureFilePersistentVolumeSource Source

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

class

FlexPersistentVolumeSource Source

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

class

SecretReference Source

SecretReference represents a Secret Reference.
link

class

LocalVolumeSource Source

Local represents directly-attached storage with node affinity
link

class

CephFSPersistentVolumeSource 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

ScaleIOPersistentVolumeSource Source

ScaleIOPersistentVolumeSource represents a persistent ScaleIO volume
link

class

GlusterfsPersistentVolumeSource Source

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

class

CinderPersistentVolumeSource Source

Represents a cinder volume resource in Openstack.
link

class

VolumeNodeAffinity Source

VolumeNodeAffinity defines constraints that limit what nodes this volume can be accessed from.
link

class

ISCSIPersistentVolumeSource Source

ISCSIPersistentVolumeSource represents an ISCSI disk.
link

class

RBDPersistentVolumeSource Source

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

class

StorageOSPersistentVolumeSource Source

Represents a StorageOS persistent volume resource.
link

class

CSIPersistentVolumeSource Source

Represents storage that is managed by an external CSI volume driver

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.