volumedriver

package module
v0.154.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 11, 2026 License: Apache-2.0 Imports: 15 Imported by: 12

README

volumedriver

Go Report Card Go Reference

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

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MountPointNotExistError added in v0.153.0

type MountPointNotExistError struct {
	VolumeName string
	MountPath  string
	// contains filtered or unexported fields
}

MountPointNotExistError indicates that the mount point does not exist. This error is created to handle the case when the mount point does not exist during an unmount operation. It wraps the original os.ErrNotExist error.

func (*MountPointNotExistError) Error added in v0.153.0

func (e *MountPointNotExistError) Error() string

func (*MountPointNotExistError) Unwrap added in v0.153.0

func (e *MountPointNotExistError) Unwrap() error

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 (*VolumeDriver) Capabilities

func (*VolumeDriver) Create

func (*VolumeDriver) Drain

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

func (*VolumeDriver) Get

func (*VolumeDriver) List

func (*VolumeDriver) Mount

func (*VolumeDriver) Path

func (*VolumeDriver) Remove

func (*VolumeDriver) Unmount

Directories

Path Synopsis
internal
Code generated by counterfeiter.
Code generated by counterfeiter.
Code generated by counterfeiter.
Code generated by counterfeiter.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL