package
1.14.0-alpha.0
Repository: https://github.com/everpeace/kubernetes.git
Documentation: pkg.go.dev
# Packages
Package awsebs contains the internal representation of AWS Elastic Block Store volumes.
No description provided by the author
Package azure_file contains the internal representation of Azure File Service Volume.
Package cephfs 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
No description provided by the author
Package emptydir 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 gcepd 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 local contains the internal representation of local volumes.
Package nfs contains the internal representation of network file system (NFS) volumes.
No description provided by the author
Package portworx contains the internal representation of Portworx Block Device volumes.
No description provided by the author
Package quobyte contains the internal representation of Quobyte volumes.
Package rbd contains the internal representation of Rados Block Store (Ceph) volumes.
No description provided by the author
Package secret contains the internal representation of secret volumes.
Package storageos contains the internal representation of StorageOS PersistentDisk volumes.
No description provided by the author
Package util contains utility code for use by volume plugins.
No description provided by the author
No description provided by the author
# Functions
IsDeletedVolumeInUse returns true if an error returned from Delete() is deletedVolumeInUseError.
IsNotSupported returns true if and only if err is "key" not found error.
NewCachedMetrics creates a new cachedMetrics wrapping another MetricsProvider and caching the results.
NewDeletedVolumeInUseError returns a new instance of DeletedVolumeInUseError error.
NewFsInfoFailedError creates a new MetricsError with code FsInfoFailed.
NewMetricsDu creates a new metricsDu with the Volume path.
NewMetricsStatfs creates a new metricsStatFS with the Volume path.
NewNoPathDefined creates a new MetricsError with code NoPathDefined.
NewNotSupportedError creates a new MetricsError with code NotSupported.
NewPersistentVolumeRecyclerPodTemplate creates a template for a recycler pod.
NewSpecFromPersistentVolume creates an Spec from an v1.PersistentVolume.
NewSpecFromVolume creates an Spec from an v1.Volume.
SetVolumeOwnership modifies the given volume to be owned by fsGroup, and sets SetGid so that newly created files are owned by fsGroup.
Check validity of recycle pod template List of checks: - at least one volume is defined in the recycle pod template If successful, returns nil if unsuccessful, returns an error.
# Constants
No description provided by the author
No description provided by the author
ErrCodeNotSupported code for NotSupported Errors.
No description provided by the author
No description provided by the author
Name of a volume in external cloud that is being provisioned and thus should be ignored by rest of Kubernetes.
Common parameter which can be specified in StorageClass to specify the desired FSType Provisioners SHOULD implement support for this if they are block device based Must be a filesystem type supported by the host operating system.
# Structs
Attributes represents the attributes of this mounter.
Metrics represents the used and available bytes of the Volume.
MetricsError to distinguish different Metrics Errors.
MetricsNil represents a MetricsProvider that does not support returning Metrics.
No description provided by the author
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.
BlockVolume interface provides methods to generate global map path and pod device map path.
BlockVolumeMapper interface provides methods to set up/map the volume.
BlockVolumePlugin is an extend interface of VolumePlugin and is used for block volumes support.
BlockVolumeUnmapper interface provides methods to cleanup/unmap the volumes.
No description provided by the author
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.
DeviceMountableVolumePlugin is an extended interface of VolumePlugin and is used for volumes that requires mount device to a node before binding to volume to pod.
DeviceMounter can mount a block volume to a global path.
DeviceUnmounter can unmount a block volume from the global path.
No description provided by the author
ExpandableVolumePlugin is an extended interface of VolumePlugin and is used for volumes that can be expanded.
FSResizableVolumePlugin is an extension of ExpandableVolumePlugin and is used for volumes (flex) that require extra steps on nodes for expansion to complete.
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.
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.
VolumePluginWithAttachLimits is an extended interface of VolumePlugin that restricts number of volumes that can be attached to a node.
# Type aliases
No description provided by the author