Packages

case class Volume(name: String, awsElasticBlockStore: Option[AWSElasticBlockStoreVolumeSource] = None, azureDisk: Option[AzureDiskVolumeSource] = None, azureFile: Option[AzureFileVolumeSource] = None, cephfs: Option[CephFSVolumeSource] = None, cinder: Option[CinderVolumeSource] = None, configMap: Option[ConfigMapVolumeSource] = None, csi: Option[CSIVolumeSource] = None, downwardAPI: Option[DownwardAPIVolumeSource] = None, emptyDir: Option[EmptyDirVolumeSource] = None, ephemeral: Option[EphemeralVolumeSource] = None, fc: Option[FCVolumeSource] = None, flexVolume: Option[FlexVolumeSource] = None, flocker: Option[FlockerVolumeSource] = None, gcePersistentDisk: Option[GCEPersistentDiskVolumeSource] = None, gitRepo: Option[GitRepoVolumeSource] = None, glusterfs: Option[GlusterfsVolumeSource] = None, hostPath: Option[HostPathVolumeSource] = None, iscsi: Option[ISCSIVolumeSource] = None, nfs: Option[NFSVolumeSource] = None, persistentVolumeClaim: Option[PersistentVolumeClaimVolumeSource] = None, photonPersistentDisk: Option[PhotonPersistentDiskVolumeSource] = None, portworxVolume: Option[PortworxVolumeSource] = None, projected: Option[ProjectedVolumeSource] = None, quobyte: Option[QuobyteVolumeSource] = None, rbd: Option[RBDVolumeSource] = None, scaleIO: Option[ScaleIOVolumeSource] = None, secret: Option[SecretVolumeSource] = None, storageos: Option[StorageOSVolumeSource] = None, vsphereVolume: Option[VsphereVirtualDiskVolumeSource] = None) extends Product with Serializable

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

name

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

awsElasticBlockStore

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

azureDisk

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

azureFile

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

cephfs

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

cinder

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

configMap

configMap represents a configMap that should populate this volume

csi

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

downwardAPI

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

emptyDir

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

ephemeral

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.

fc

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

flexVolume

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

flocker

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

gcePersistentDisk

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

gitRepo

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.

glusterfs

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

hostPath

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

iscsi

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

nfs

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

persistentVolumeClaim

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

photonPersistentDisk

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

portworxVolume

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

projected

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

quobyte

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

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

scaleIO

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

secret

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

storageos

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

vsphereVolume

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

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Volume
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Volume(name: String, awsElasticBlockStore: Option[AWSElasticBlockStoreVolumeSource] = None, azureDisk: Option[AzureDiskVolumeSource] = None, azureFile: Option[AzureFileVolumeSource] = None, cephfs: Option[CephFSVolumeSource] = None, cinder: Option[CinderVolumeSource] = None, configMap: Option[ConfigMapVolumeSource] = None, csi: Option[CSIVolumeSource] = None, downwardAPI: Option[DownwardAPIVolumeSource] = None, emptyDir: Option[EmptyDirVolumeSource] = None, ephemeral: Option[EphemeralVolumeSource] = None, fc: Option[FCVolumeSource] = None, flexVolume: Option[FlexVolumeSource] = None, flocker: Option[FlockerVolumeSource] = None, gcePersistentDisk: Option[GCEPersistentDiskVolumeSource] = None, gitRepo: Option[GitRepoVolumeSource] = None, glusterfs: Option[GlusterfsVolumeSource] = None, hostPath: Option[HostPathVolumeSource] = None, iscsi: Option[ISCSIVolumeSource] = None, nfs: Option[NFSVolumeSource] = None, persistentVolumeClaim: Option[PersistentVolumeClaimVolumeSource] = None, photonPersistentDisk: Option[PhotonPersistentDiskVolumeSource] = None, portworxVolume: Option[PortworxVolumeSource] = None, projected: Option[ProjectedVolumeSource] = None, quobyte: Option[QuobyteVolumeSource] = None, rbd: Option[RBDVolumeSource] = None, scaleIO: Option[ScaleIOVolumeSource] = None, secret: Option[SecretVolumeSource] = None, storageos: Option[StorageOSVolumeSource] = None, vsphereVolume: Option[VsphereVirtualDiskVolumeSource] = None)

    name

    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

    awsElasticBlockStore

    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

    azureDisk

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

    azureFile

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

    cephfs

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

    cinder

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

    configMap

    configMap represents a configMap that should populate this volume

    csi

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

    downwardAPI

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

    emptyDir

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

    ephemeral

    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.

    fc

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

    flexVolume

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

    flocker

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

    gcePersistentDisk

    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

    gitRepo

    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.

    glusterfs

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

    hostPath

    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

    iscsi

    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

    nfs

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

    persistentVolumeClaim

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

    photonPersistentDisk

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

    portworxVolume

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

    projected

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

    quobyte

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

    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

    scaleIO

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

    secret

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

    storageos

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

    vsphereVolume

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

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val awsElasticBlockStore: Option[AWSElasticBlockStoreVolumeSource]
  6. val azureDisk: Option[AzureDiskVolumeSource]
  7. val azureFile: Option[AzureFileVolumeSource]
  8. val cephfs: Option[CephFSVolumeSource]
  9. val cinder: Option[CinderVolumeSource]
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  11. val configMap: Option[ConfigMapVolumeSource]
  12. val csi: Option[CSIVolumeSource]
  13. val downwardAPI: Option[DownwardAPIVolumeSource]
  14. val emptyDir: Option[EmptyDirVolumeSource]
  15. val ephemeral: Option[EphemeralVolumeSource]
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. val fc: Option[FCVolumeSource]
  18. val flexVolume: Option[FlexVolumeSource]
  19. val flocker: Option[FlockerVolumeSource]
  20. val gcePersistentDisk: Option[GCEPersistentDiskVolumeSource]
  21. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. val gitRepo: Option[GitRepoVolumeSource]
  23. val glusterfs: Option[GlusterfsVolumeSource]
  24. val hostPath: Option[HostPathVolumeSource]
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. val iscsi: Option[ISCSIVolumeSource]
  27. val name: String
  28. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  29. val nfs: Option[NFSVolumeSource]
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. val persistentVolumeClaim: Option[PersistentVolumeClaimVolumeSource]
  33. val photonPersistentDisk: Option[PhotonPersistentDiskVolumeSource]
  34. val portworxVolume: Option[PortworxVolumeSource]
  35. def productElementNames: Iterator[String]
    Definition Classes
    Product
  36. val projected: Option[ProjectedVolumeSource]
  37. val quobyte: Option[QuobyteVolumeSource]
  38. val rbd: Option[RBDVolumeSource]
  39. val scaleIO: Option[ScaleIOVolumeSource]
  40. val secret: Option[SecretVolumeSource]
  41. val storageos: Option[StorageOSVolumeSource]
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. val vsphereVolume: Option[VsphereVirtualDiskVolumeSource]
  44. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  45. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped