Documentation ¶
Overview ¶
Package local provides the default implementation for volumes. It is used to mount data volume containers and directories local to the host server.
Package local provides the default implementation for volumes. It is used to mount data volume containers and directories local to the host server.
Index ¶
Constants ¶
const (
VolumeDataPathName = "_data"
)
VolumeDataPathName is the name of the directory where the volume data is stored. It uses a very distintive name to avoid collisions migrating data between Docker versions.
Variables ¶
var ( // ErrNotFound is the typed error returned when the requested volume name can't be found ErrNotFound = errors.New("volume not found") )
Functions ¶
This section is empty.
Types ¶
type Root ¶
type Root struct {
// contains filtered or unexported fields
}
Root implements the Driver interface for the volume package and manages the creation/removal of volumes. It uses only standard vfs commands to create/remove dirs within its provided scope.
func New ¶
New instantiates a new Root instance with the provided scope. Scope is the base path that the Root instance uses to store its volumes. The base path is created here if it does not exist.
func (*Root) Create ¶
Create creates a new volume.Volume with the provided name, creating the underlying directory tree required for this volume in the process.
func (*Root) Get ¶ added in v1.9.0
Get looks up the volume for the given name and returns it if found
func (*Root) Name ¶
Name returns the name of Root, defined in the volume package in the DefaultDriverName constant.