# Packages
No description provided by the author
# Functions
AddFinalizer determines whether to add a finalizer marking the provisioner as the owner of the PV with clean up duty.
AdditionalProvisionerNames sets additional names for the provisioner.
ClaimsInformer sets the informer to use for accessing PersistentVolumeClaims.
ClassesInformer sets the informer to use for accessing StorageClasses.
CreateProvisionedPVBackoff is the configuration of exponential backoff between retries when we create a PV object for a provisioned volume.
CreateProvisionedPVInterval is the interval between retries when we create a PV object for a provisioned volume.
CreateProvisionedPVLimiter is the configuration of rate limiter for queue of unsaved PersistentVolumes.
CreateProvisionedPVRetryCount is the number of retries when we create a PV object for a provisioned volume.
ExponentialBackOffOnError determines whether to exponentially back off from failures of Provision and Delete.
FailedDeleteThreshold is the threshold for max number of retries on failures of Delete.
FailedProvisionThreshold is the threshold for max number of retries on failures of Provision.
LeaderElection determines whether to enable leader election or not.
LeaderElectionNamespace is the kubernetes namespace in which to create the leader election object.
LeaseDuration is the duration that non-leader candidates will wait to force acquire leadership.
MetricsAddress sets the ip address that metrics serve serves on.
MetricsPath sets the endpoint path of metrics server.
MetricsPort sets the port that metrics server serves on.
NewBackoffStore returns VolumeStore that uses blocking exponential backoff to save PVs.
NewProvisionController creates a new provision controller using the given configuration parameters and with private (non-shared) informers.
NewVolumeStoreQueue returns VolumeStore that uses asynchronous workqueue to save PVs.
RateLimiter is the workqueue.RateLimiter to use for the provisioning and deleting work queues.
RenewDeadline is the duration that the acting master will retry refreshing leadership before giving up.
ResyncPeriod is how often the controller relists PVCs, PVs, & storage classes.
RetryPeriod is the duration the LeaderElector clients should wait between tries of actions.
Threadiness is the number of claim and volume workers each to launch.
VolumesInformer sets the informer to use for accessing PersistentVolumes.
# Constants
DefaultAddFinalizer is used when option function AddFinalizer is omitted.
DefaultCreateProvisionedPVInterval is used when option function CreateProvisionedPVInterval is omitted.
DefaultCreateProvisionedPVRetryCount is used when option function CreateProvisionedPVRetryCount is omitted.
DefaultExponentialBackOffOnError is used when option function ExponentialBackOffOnError is omitted.
DefaultFailedDeleteThreshold is used when option function FailedDeleteThreshold is omitted.
DefaultFailedProvisionThreshold is used when option function FailedProvisionThreshold is omitted.
DefaultLeaderElection is used when option function LeaderElection is omitted.
DefaultLeaseDuration is used when option function LeaseDuration is omitted.
DefaultMetricsAddress is used when option function MetricsAddress is omitted.
DefaultMetricsPath is used when option function MetricsPath is omitted.
DefaultMetricsPort is used when option function MetricsPort is omitted.
DefaultRenewDeadline is used when option function RenewDeadline is omitted.
DefaultResyncPeriod is used when option function ResyncPeriod is omitted.
DefaultRetryPeriod is used when option function RetryPeriod is omitted.
DefaultThreadiness is used when option function Threadiness is omitted.
ProvisioningFinished tells the controller that provisioning for sure does not continue in background, error code of ProvisionExt() is final.
ProvisioningInBackground tells the controller that provisioning may be in progress in background after ProvisionExt call finished.
ProvisioningNoChange tells the controller that provisioning state is the same as before the call - either ProvisioningInBackground or ProvisioningFinished from the previous ProvisionExt().
# Structs
IgnoredError is the value for Delete to return to indicate that the call has been ignored and no action taken.
ProvisionController is a controller that provisions PersistentVolumes for PersistentVolumeClaims.
ProvisionOptions contains all information required to provision a volume.
# Interfaces
BlockProvisioner is an optional interface implemented by provisioners to determine whether it supports block volume.
DeletionGuard is an optional interface implemented by provisioners to determine whether a PV should be deleted.
Provisioner is an interface that creates templates for PersistentVolumes and can create the volume as a new resource in the infrastructure provider.
ProvisionerExt is an optional interface implemented by provisioners that can return enhanced error code from provisioner.
Qualifier is an optional interface implemented by provisioners to determine whether a claim should be provisioned as early as possible (e.g.
VolumeStore is an interface that's used to save PersistentVolumes to API server.
# Type aliases
ProvisioningState is state of volume provisioning.