volumedrivers

Documentation

Index

• func Lookup(name string) (volume.Driver, error)
• func NewVolumeDriver(name string, c client) volume.Driver
• func Register(extension volume.Driver, name string) bool
• func Unregister(name string) bool
• type VolumeDriver

Functions

func Lookup

func Lookup(name string) (volume.Driver, error)

Lookup returns the driver associated with the given name. If a driver with the given name has not been registered it checks if there is a VolumeDriver plugin available with the given name.

func NewVolumeDriver

func NewVolumeDriver(name string, c client) volume.Driver

NewVolumeDriver returns a driver has the given name mapped on the given client.

func Register

func Register(extension volume.Driver, name string) bool

Register associates the given driver to the given name, checking if the name is already associated

func Unregister

func Unregister(name string) bool

Unregister dissociates the name from it's driver, if the association exists.

Types

type VolumeDriver

type VolumeDriver interface {
	// Create a volume with the given name
	Create(name string, opts opts) (err error)
	// Remove the volume with the given name
	Remove(name string) (err error)
	// Get the mountpoint of the given volume
	Path(name string) (mountpoint string, err error)
	// Mount the given volume and return the mountpoint
	Mount(name string) (mountpoint string, err error)
	// Unmount the given volume
	Unmount(name string) (err error)
}

VolumeDriver defines the available functions that volume plugins must implement.