Options
All
  • Public
  • Public/Protected
  • All
Menu

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

schema

io.k8s.api.core.v1.Volume

Hierarchy

  • Volume

Implemented by

Index

Properties

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.Volume#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.Volume#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.Volume#azureFile

Optional Readonly cephfs

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

schema

io.k8s.api.core.v1.Volume#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.Volume#cinder

Optional Readonly configMap

ConfigMap represents a configMap that should populate this volume

schema

io.k8s.api.core.v1.Volume#configMap

Optional Readonly csi

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

schema

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

Optional Readonly downwardApi

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

schema

io.k8s.api.core.v1.Volume#downwardAPI

Optional Readonly emptyDir

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

schema

io.k8s.api.core.v1.Volume#emptyDir

Optional Readonly 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.

This is a beta feature and only available when the GenericEphemeralVolume feature gate is enabled.

schema

io.k8s.api.core.v1.Volume#ephemeral

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.Volume#fc

Optional Readonly flexVolume

flexVolume: FlexVolumeSource

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

schema

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

Optional Readonly flocker

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

schema

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

schema

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

Optional Readonly 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.

schema

io.k8s.api.core.v1.Volume#gitRepo

Optional Readonly 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

schema

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

Optional Readonly 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

schema

io.k8s.api.core.v1.Volume#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. More info: https://examples.k8s.io/volumes/iscsi/README.md

schema

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

Readonly name

name: string

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

schema

io.k8s.api.core.v1.Volume#name

Optional Readonly 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

schema

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

Optional Readonly persistentVolumeClaim

persistentVolumeClaim: PersistentVolumeClaimVolumeSource

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

schema

io.k8s.api.core.v1.Volume#persistentVolumeClaim

Optional Readonly photonPersistentDisk

photonPersistentDisk: PhotonPersistentDiskVolumeSource

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

schema

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

Optional Readonly portworxVolume

portworxVolume: PortworxVolumeSource

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

schema

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

Optional Readonly projected

Items for all in one resources secrets, configmaps, and downward API

schema

io.k8s.api.core.v1.Volume#projected

Optional Readonly quobyte

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

schema

io.k8s.api.core.v1.Volume#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.Volume#rbd

Optional Readonly scaleIo

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

schema

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

Optional Readonly secret

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

schema

io.k8s.api.core.v1.Volume#secret

Optional Readonly storageos

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

schema

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

Optional Readonly vsphereVolume

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

schema

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

Generated using TypeDoc