volumedriver

README

volumedriver

This template volume driver provides common function used in the NFS driver and SMB driverhttps://github.com/cloudfoundry/smb-volume-release/tree/develop/src/code.cloudfoundry.org/smbdriver.

[!NOTE]

This repository should be imported as code.cloudfoundry.org/volumedriver.

Contributing

See the Contributing.md for more information on how to contribute.

Working Group Charter

This repository is maintained by App Runtime Platform under Volume Services area.

[!IMPORTANT]

Content in this file is managed by the CI task sync-readme and is generated by CI following a convention.

Documentation

Index

• type Mounter
• type NfsVolumeInfo
• type OsHelper
• type VolumeDriver
  • func NewVolumeDriver(logger lager.Logger, os osshim.Os, filepath filepathshim.Filepath, ...) *VolumeDriver
  • func (d *VolumeDriver) Activate(env dockerdriver.Env) dockerdriver.ActivateResponse
  • func (d *VolumeDriver) Capabilities(env dockerdriver.Env) dockerdriver.CapabilitiesResponse
  • func (d *VolumeDriver) Create(env dockerdriver.Env, createRequest dockerdriver.CreateRequest) dockerdriver.ErrorResponse
  • func (d *VolumeDriver) Drain(env dockerdriver.Env) error
  • func (d *VolumeDriver) Get(env dockerdriver.Env, getRequest dockerdriver.GetRequest) dockerdriver.GetResponse
  • func (d *VolumeDriver) List(_ dockerdriver.Env) dockerdriver.ListResponse
  • func (d *VolumeDriver) Mount(env dockerdriver.Env, mountRequest dockerdriver.MountRequest) dockerdriver.MountResponse
  • func (d *VolumeDriver) Path(env dockerdriver.Env, pathRequest dockerdriver.PathRequest) dockerdriver.PathResponse
  • func (d *VolumeDriver) Remove(env dockerdriver.Env, removeRequest dockerdriver.RemoveRequest) dockerdriver.ErrorResponse
  • func (d *VolumeDriver) Unmount(env dockerdriver.Env, unmountRequest dockerdriver.UnmountRequest) dockerdriver.ErrorResponse

Types

type Mounter

type Mounter interface {
	Mount(env dockerdriver.Env, source string, target string, opts map[string]interface{}) error
	Unmount(env dockerdriver.Env, target string) error
	Check(env dockerdriver.Env, name, mountPoint string) bool
	Purge(env dockerdriver.Env, path string)
}

type NfsVolumeInfo

type NfsVolumeInfo struct {
	Opts                    map[string]interface{} `json:"-"` // don't store opts
	dockerdriver.VolumeInfo                        // see dockerdriver.resources.go
}

type OsHelper

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

type VolumeDriver

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

func NewVolumeDriver

func NewVolumeDriver(logger lager.Logger, os osshim.Os, filepath filepathshim.Filepath, time timeshim.Time, mountChecker mountchecker.MountChecker, mountPathRoot string, mounter Mounter, oshelper OsHelper) *VolumeDriver

func (*VolumeDriver) Activate

func (d *VolumeDriver) Activate(env dockerdriver.Env) dockerdriver.ActivateResponse

func (*VolumeDriver) Capabilities

func (d *VolumeDriver) Capabilities(env dockerdriver.Env) dockerdriver.CapabilitiesResponse

func (*VolumeDriver) Create

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

func (*VolumeDriver) Drain

func (d *VolumeDriver) Drain(env dockerdriver.Env) error

func (*VolumeDriver) Get

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

func (*VolumeDriver) List

func (d *VolumeDriver) List(_ dockerdriver.Env) dockerdriver.ListResponse

func (*VolumeDriver) Mount

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

func (*VolumeDriver) Path

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

func (*VolumeDriver) Remove

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

func (*VolumeDriver) Unmount

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