Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface PersistentVolumeSpec

PersistentVolumeSpec is the specification of a persistent volume.

schema

io.k8s.api.core.v1.PersistentVolumeSpec

Hierarchy

  • PersistentVolumeSpec

Index

Properties

Optional Readonly accessModes

accessModes: string[]

AccessModes contains all ways the volume can be mounted. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#access-modes

schema

io.k8s.api.core.v1.PersistentVolumeSpec#accessModes

Optional Readonly awsElasticBlockStore

awsElasticBlockStore: AwsElasticBlockStoreVolumeSource

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#awsElasticBlockStore

Optional Readonly azureDisk

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#azureDisk

Optional Readonly azureFile

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#azureFile

Optional Readonly capacity

capacity: {}

A description of the persistent volume's resources and capacity. More info: https://kubernetes.io/docs/concepts/storage/persistent-volumes#capacity

schema

io.k8s.api.core.v1.PersistentVolumeSpec#capacity

Type declaration

Optional Readonly cephfs

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#cephfs

Optional Readonly cinder

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#cinder

Optional Readonly claimRef

claimRef: ObjectReference

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#claimRef

Optional Readonly csi

CSI represents storage that is handled by an external CSI driver (Beta feature).

schema

io.k8s.api.core.v1.PersistentVolumeSpec#csi

Optional Readonly fc

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#fc

Optional Readonly flexVolume

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#flexVolume

Optional Readonly flocker

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#flocker

Optional Readonly gcePersistentDisk

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. More info: https://kubernetes.io/docs/concepts/storage/volumes#gcepersistentdisk

schema

io.k8s.api.core.v1.PersistentVolumeSpec#gcePersistentDisk

Optional Readonly glusterfs

Glusterfs represents a Glusterfs volume that is attached to a host and exposed to the pod. Provisioned by an admin. More info: https://examples.k8s.io/volumes/glusterfs/README.md

schema

io.k8s.api.core.v1.PersistentVolumeSpec#glusterfs

Optional Readonly hostPath

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#hostPath

Optional Readonly iscsi

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.

schema

io.k8s.api.core.v1.PersistentVolumeSpec#iscsi

Optional Readonly local

Local represents directly-attached storage with node affinity

schema

io.k8s.api.core.v1.PersistentVolumeSpec#local

Optional Readonly mountOptions

mountOptions: string[]

A 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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#mountOptions

Optional Readonly nfs

NFS represents an NFS mount on the host. Provisioned by an admin. More info: https://kubernetes.io/docs/concepts/storage/volumes#nfs

schema

io.k8s.api.core.v1.PersistentVolumeSpec#nfs

Optional Readonly nodeAffinity

nodeAffinity: VolumeNodeAffinity

NodeAffinity defines constraints that limit what nodes this volume can be accessed from. This field influences the scheduling of pods that use this volume.

schema

io.k8s.api.core.v1.PersistentVolumeSpec#nodeAffinity

Optional Readonly persistentVolumeReclaimPolicy

persistentVolumeReclaimPolicy: string

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#persistentVolumeReclaimPolicy

Optional Readonly photonPersistentDisk

photonPersistentDisk: PhotonPersistentDiskVolumeSource

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#photonPersistentDisk

Optional Readonly portworxVolume

portworxVolume: PortworxVolumeSource

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#portworxVolume

Optional Readonly quobyte

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#quobyte

Optional Readonly rbd

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#rbd

Optional Readonly scaleIo

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#scaleIO

Optional Readonly storageClassName

storageClassName: string

Name of StorageClass to which this persistent volume belongs. Empty value means that this volume does not belong to any StorageClass.

schema

io.k8s.api.core.v1.PersistentVolumeSpec#storageClassName

Optional Readonly storageos

StorageOS represents a StorageOS volume that is attached to the kubelet's host machine and mounted into the pod More info: https://examples.k8s.io/volumes/storageos/README.md

schema

io.k8s.api.core.v1.PersistentVolumeSpec#storageos

Optional Readonly volumeMode

volumeMode: string

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.

schema

io.k8s.api.core.v1.PersistentVolumeSpec#volumeMode

Optional Readonly vsphereVolume

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

schema

io.k8s.api.core.v1.PersistentVolumeSpec#vsphereVolume

Generated using TypeDoc