# Packages
Package aws_ebs contains the internal representation of AWS Elastic Block Store volumes.
Package azure_file contains the internal representation of Azure File Service Volume.
Package nfs contains the internal representation of Ceph file system (CephFS) volumes.
Package cinder contains the internal representation of cinder volumes.
Package configmap contains the internal representation of configMap volumes.
No description provided by the author
Package empty_dir contains the internal representation of emptyDir volumes.
Package fc contains the internal representation of Fibre Channel (fc) volumes.
No description provided by the author
Package flocker contains the internal representation of Flocker volumes.
Package gce_pd contains the internal representation of GCE PersistentDisk volumes.
Package git_repo contains the internal representation of git repo volumes.
Package glusterfs contains the internal representation of glusterfs volumes.
Package host_path contains the internal representation of hostPath volumes.
Package iscsi contains the internal representation of Internet Small Computer System Interface (iSCSI) volumes.
Package nfs contains the internal representation of network file system (NFS) volumes.
Package persistent_claim contains the internal representation of persistent volume claims.
Package rbd contains the internal representation of Rados Block Store (Ceph) volumes.
Package secret contains the internal representation of secret volumes.
No description provided by the author
Contains utility code for use by volume plugins.
# Functions
CalculateTimeoutForVolume calculates time for a Recycler pod to complete a recycle operation.
GenerateVolumeName returns a PV name with clusterName prefix.
NewCachedMetrics creates a new cachedMetrics wrapping another MetricsProvider and caching the results.
NewMetricsDu creates a new metricsDu with the Volume path.
NewPersistentVolumeRecyclerPodTemplate creates a template for a recycler pod.
NewSpecFromPersistentVolume creates an Spec from an api.PersistentVolume.
NewSpecFromVolume creates an Spec from an api.Volume.
RecycleVolumeByWatchingPodUntilCompletion is intended for use with volume Recyclers.
No description provided by the author
RoundUpSize calculates how many allocation units are needed to accommodate a volume of given size.
SetVolumeOwnership modifies the given volume to be owned by fsGroup, and sets SetGid so that newly created files are owned by fsGroup.
# Constants
Name of a volume in external cloud that is being provisioned and thus should be ignored by rest of Kubernetes.
# Structs
Attributes represents the attributes of this mounter.
Metrics represents the used and available bytes of the Volume.
MetricsNil represents a MetricsProvider that does not support returning Metrics.
Spec is an internal representation of a volume.
VolumeConfig is how volume plugins receive configuration.
VolumeOptions contains option information about a volume.
VolumePluginMgr tracks registered plugins.
# Interfaces
AttachableVolumePlugin is an extended interface of VolumePlugin and is used for volumes that require attachment to a node before mounting.
Attacher can attach a volume to a node.
DeletableVolumePlugin is an extended interface of VolumePlugin and is used by persistent volumes that want to be deleted from the cluster after their release from a PersistentVolumeClaim.
Deleter removes the resource from the underlying storage provider.
Detacher can detach a volume from a node.
MetricsProvider exposes metrics (e.g.
Mounter interface provides methods to set up/mount the volume.
PersistentVolumePlugin is an extended interface of VolumePlugin and is used by volumes that want to provide long term persistence of data.
ProvisionableVolumePlugin is an extended interface of VolumePlugin and is used to create volumes for the cluster.
Provisioner is an interface that creates templates for PersistentVolumes and can create the volume as a new resource in the infrastructure provider.
RecyclableVolumePlugin is an extended interface of VolumePlugin and is used by persistent volumes that want to be recycled before being made available again to new claims.
Recycler provides methods to reclaim the volume resource.
Unmounter interface provides methods to cleanup/unmount the volumes.
Volume represents a directory used by pods or hosts on a node.
VolumeHost is an interface that plugins can use to access the kubelet.
VolumePlugin is an interface to volume plugins that can be used on a kubernetes node (e.g.