README

a volman driver for local disk

This driver is intended for test purposes only. Watch this space in case that changes...

Reporting issues and requesting features

Please report all issues and feature requests in cloudfoundry/diego-release.

Usage of localdriver:

  -caFile string
        the certificate authority public key file to use with ssl authentication
  -certFile string
        the public key file to use with ssl authentication
  -clientCertFile string
        the public key file to use with client ssl authentication
  -clientKeyFile string
        the private key file to use with client ssl authentication
  -debugAddr string
        host:port for serving pprof debugging info
  -driversPath string
        Path to directory where drivers are installed
  -insecureSkipVerify
        whether SSL communication should skip verification of server IP addresses in the certificate
  -keyFile string
        the private key file to use with ssl authentication
  -listenAddr string
        host:port to serve volume management functions (default "0.0.0.0:9750")
  -logLevel string
        log level: debug, info, error or fatal (default "info")
  -mountDir string
        Path to directory where fake volumes are created (default "/tmp/volumes")
  -requireSSL
        whether the fake driver should require ssl-secured communication
  -transport string
        Transport protocol to transmit HTTP over (default "tcp")

Specific Options

Create

dockerdriver.CreateRequest{
    Name: "Volume",
    Opts: map[string]interface{}{
        "volume_id": "something_different_than_test",
        "passcode" : "someStringPasscode",              <- OPTIONAL
    },
})

Mount

localDriver.Mount(logger, dockerdriver.MountRequest{
    Name: "Volume",
    Opts: map[string]interface{}{
        "passcode":"someStringPasscode"                 <- REQUIRED if used in Create
    },
})
Expand ▾ Collapse ▴

Documentation

Index

Constants

View Source 
const MountsRootDir = "_mounts"
View Source 
const VolumesRootDir = "_volumes"

Variables

This section is empty.

Functions

This section is empty.

Types

type LocalDriver 

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

func NewLocalDriver 

func NewLocalDriver(os osshim.Os, filepath filepathshim.Filepath, mountPathRoot string, osHelper OsHelper, uniqueVolumeIds bool) *LocalDriver

func NewLocalDriverWithState 

func NewLocalDriverWithState(state map[string]*LocalVolumeInfo, os osshim.Os, filepath filepathshim.Filepath, mountPathRoot string, osHelper OsHelper, uniqueVolumeIds bool) *LocalDriver

func (*LocalDriver) Activate 

func (d *LocalDriver) Activate(_ dockerdriver.Env) dockerdriver.ActivateResponse

func (*LocalDriver) Capabilities 

func (d *LocalDriver) Capabilities(_ dockerdriver.Env) dockerdriver.CapabilitiesResponse

func (*LocalDriver) Create 

func (d *LocalDriver) Create(env dockerdriver.Env, createRequest dockerdriver.CreateRequest) dockerdriver.ErrorResponse

func (*LocalDriver) Get 

func (d *LocalDriver) Get(env dockerdriver.Env, getRequest dockerdriver.GetRequest) dockerdriver.GetResponse

func (*LocalDriver) List 

func (d *LocalDriver) List(env dockerdriver.Env) dockerdriver.ListResponse

func (*LocalDriver) Mount 

func (d *LocalDriver) Mount(env dockerdriver.Env, mountRequest dockerdriver.MountRequest) dockerdriver.MountResponse

func (*LocalDriver) Path 

func (d *LocalDriver) Path(env dockerdriver.Env, pathRequest dockerdriver.PathRequest) dockerdriver.PathResponse

func (*LocalDriver) Remove 

func (d *LocalDriver) Remove(env dockerdriver.Env, removeRequest dockerdriver.RemoveRequest) dockerdriver.ErrorResponse

func (*LocalDriver) Unmount 

func (d *LocalDriver) Unmount(env dockerdriver.Env, unmountRequest dockerdriver.UnmountRequest) dockerdriver.ErrorResponse

type LocalVolumeInfo 

type LocalVolumeInfo struct {
	dockerdriver.VolumeInfo // see dockerdriver.resources.go
}

type OsHelper 

type OsHelper interface {
	Umask(mask int) (oldmask int)
}

Source Files

View all

Directories

Path Synopsis
cmd
localdriver