doytsujin / sig-storage-lib-external-provisioner

sig-storage-lib-external-provisioner

A library for writing external provisioners. Projects using this library include:

• https://github.com/kubernetes-sigs/nfs-subdir-external-provisioner - Dynamic sub-dir volume provisioner on a remote NFS server.
• https://github.com/kubernetes-sigs/nfs-ganesha-server-and-external-provisioner - NFS Ganesha Server and Volume Provisioner.
• https://github.com/kubernetes-csi/external-provisioner - Sidecar container that watches Kubernetes PersistentVolumeClaim objects and triggers CreateVolume/DeleteVolume against a CSI endpoint

Packages

controller

Contains the Provisioner interface and ProvisionController, a custom Kubernetes controller that watches PersistentVolumes and PersistentVolumeClaims. Implement the Provisioner interface, pass the implementation to a ProvisionController, and Run the controller, which then takes care of calling the Provisioner's Provision or Delete as needed.

Optional Packages

util

Contains an assortment of useful functions, e.g. any used by in-tree plugins that aren't otherwise easily importable.

gidallocator and allocator

gidallocator is used to allocate a GID from a range specified by StorageClass parameters gidMin & gidMax. allocator is the underlying implementation and can be used to write other allocators. An example use-case for gidallocator is an NFS-based provisioner that chowns each export to a unique GID. See Volume Security for more context. Adapted from the in-tree glusterfs plugin.

mount

Is used to read the mount table. Copied from moby.

Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the community page.

You can reach the maintainers of this project at:

• Slack
• Mailing List

Code of conduct

Participation in the Kubernetes community is governed by the Kubernetes Code of Conduct.