docker

Documentation

Index

• Constants
• func Init(osdm *osm.OSDriverManager, sdm *storage.StorageDriverManager) (volume.Driver, error)
• type Driver
  • func (driver *Driver) Attach(volumeName, instanceID string) (string, error)
  • func (driver *Driver) Create(volumeName string, volumeOpts volume.VolumeOpts) error
  • func (driver *Driver) Detach(volumeName, instanceID string) error
  • func (driver *Driver) Mount(volumeName, volumeID string, overwriteFs bool, newFsType string) (string, error)
  • func (driver *Driver) Name() string
  • func (driver *Driver) NetworkName(volumeName, instanceID string) (string, error)
  • func (driver *Driver) Path(volumeName, volumeID string) (string, error)
  • func (driver *Driver) Remove(volumeName string) error
  • func (driver *Driver) Unmount(volumeName, volumeID string) error

Constants

const (
	ProviderName            = "docker"
	DefaultVolumeSize int64 = 16
)

Functions

func Init

func Init(
	osdm *osm.OSDriverManager,
	sdm *storage.StorageDriverManager) (volume.Driver, error)

Types

type Driver

type Driver struct {
	// contains filtered or unexported fields
}

func (*Driver) Attach

func (driver *Driver) Attach(volumeName, instanceID string) (string, error)

Attach will attach a volume to an instance

func (*Driver) Create

func (driver *Driver) Create(volumeName string, volumeOpts volume.VolumeOpts) error

Create will create a remote volume

func (*Driver) Detach

func (driver *Driver) Detach(volumeName, instanceID string) error

Remove will remove a remote volume

func (*Driver) Mount

func (driver *Driver) Mount(volumeName, volumeID string, overwriteFs bool, newFsType string) (string, error)

Mount will perform the steps to get an existing Volume with or without a fileystem mounted to a guest

func (*Driver) Name

func (driver *Driver) Name() string

Name will return the name of the volume driver manager

func (*Driver) NetworkName

func (driver *Driver) NetworkName(volumeName, instanceID string) (string, error)

NetworkName will return relevant information about how a volume can be discovered on an OS

func (*Driver) Path

func (driver *Driver) Path(volumeName, volumeID string) (string, error)

Path returns the mounted path of the volume

func (*Driver) Remove

func (driver *Driver) Remove(volumeName string) error

Remove will remove a remote volume

func (*Driver) Unmount

func (driver *Driver) Unmount(volumeName, volumeID string) error

Unmount will perform the steps to unmount and existing volume and detach