driver

Documentation

Index

• type CreateRequest
• type RemoveRequest
• type VolumeDriver

Types

type CreateRequest

type CreateRequest struct {
	Name    string
	Path    string
	Options map[string]string
}

CreateRequest holds fields necessary for creating a volume

type RemoveRequest

type RemoveRequest struct {
	Name string
}

RemoveRequest holds fields necessary for removing a volume

type VolumeDriver

type VolumeDriver interface {
	// Setup is used to add a volume to the driver's state.
	// It should be called when the state of a volume is being loaded from storage.
	Setup(volumeName string, volume *types.Volume)

	// Create mounts the volume on the host.
	Create(createRequest *CreateRequest) error

	// Remove unmounts the volume from the host.
	Remove(removeRequest *RemoveRequest) error

	// Method to check if a volume is currently mounted.
	IsMounted(volumeName string) bool
}

VolumeDriver contains the methods for volume drivers to implement