graphdriver
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Index¶
- Variables
- func HasPriorDriver(root string) bool
- func IsDriverNotSupported(err error) bool
- func IsRegistered(name string) bool
- func ParseStorageOptKeyValue(opt string) (key string, value string, err error)
- func Register(name string, initFunc InitFunc) error
- type CreateOpts
- type DiffDriver
- type DiffGetterDriver
- type Driver
- type ErrUnSupported
- type FileGetCloser
- type InitFunc
- type NaiveDiffDriver
- func (gdw *NaiveDiffDriver) ApplyDiff(id, parent string, diff io.Reader) (size int64, _ error)
- func (gdw *NaiveDiffDriver) Changes(id, parent string) ([]archive.Change, error)
- func (gdw *NaiveDiffDriver) Diff(id, parent string) (arch io.ReadCloser, retErr error)
- func (gdw *NaiveDiffDriver) DiffSize(id, parent string) (size int64, _ error)
- type NotSupportedError
- type Options
- type ProtoDriver
Constants¶
This section is empty.
Variables¶
var ApplyUncompressedLayer =chrootarchive.ApplyUncompressedLayerApplyUncompressedLayer defines the unpack method used by the graphdriver.
Functions¶
funcHasPriorDriver¶
HasPriorDriver returns true if any prior driver is found
funcIsDriverNotSupported¶
IsDriverNotSupported returns true if the error initializingthe graph driver is a non-supported error.
funcIsRegistered¶
IsRegistered checks to see if the drive with the given name is registered
funcParseStorageOptKeyValue¶
ParseStorageOptKeyValue parses and validates the specified string as a key/valuepair (key=value).
Types¶
typeCreateOpts¶
CreateOpts contains optional arguments for Create() and CreateReadWrite()methods.
typeDiffDriver¶
type DiffDriver interface {// Diff produces an archive of the changes between the specified// layer and its parent layer which may be "".Diff(id, parentstring) (io.ReadCloser,error)// Changes produces a list of changes between the specified layer// and its parent layer. If parent is "", then all changes will be ADD changes.Changes(id, parentstring) ([]archive.Change,error)// ApplyDiff extracts the changeset from the given diff into the// layer with the specified id and parent, returning the size of the// new layer in bytes.// The archive.Reader must be an uncompressed stream.ApplyDiff(id, parentstring, diffio.Reader) (sizeint64, errerror)// DiffSize calculates the changes between the specified id// and its parent and returns the size in bytes of the changes// relative to its base filesystem directory.DiffSize(id, parentstring) (sizeint64, errerror)}DiffDriver is the interface to use to implement graph diffs
typeDiffGetterDriver¶
type DiffGetterDriver interface {Driver// DiffGetter returns an interface to efficiently retrieve the contents// of files in a layer.DiffGetter(idstring) (FileGetCloser,error)}DiffGetterDriver is the interface for layered file system drivers thatprovide a specialized function for getting file contents for tar-split.
typeDriver¶
type Driver interface {ProtoDriverDiffDriver}Driver is the interface for layered/snapshot file system drivers.
funcNew¶
New creates the driver and initializes it at the specified root.
It is recommended to pass a name for the driver to use, but If no nameis provided, it attempts to detect the prior storage driver based onexisting state, or otherwise selects a storage driver based on a prioritylist and the underlying filesystem.
It returns an error if the requested storage driver is not supported,if scanning prior drivers is ambiguous (i.e., if state is found formultiple drivers), or if no compatible driver is available for theplatform and underlying filesystem.
funcNewNaiveDiffDriver¶
func NewNaiveDiffDriver(driverProtoDriver, idMapuser.IdentityMapping)Driver
NewNaiveDiffDriver returns a fully functional driver that wraps thegiven ProtoDriver and adds the capability of the following methods whichit may or may not support on its own:
Diff(id, parent string) (archive.Archive, error)Changes(id, parent string) ([]archive.Change, error)ApplyDiff(id, parent string, diff archive.Reader) (size int64, err error)DiffSize(id, parent string) (size int64, err error)
typeErrUnSupported¶
type ErrUnSupported interface {NotSupported()}ErrUnSupported signals that the graph-driver is not supported on the current configuration
typeFileGetCloser¶
type FileGetCloser interface {storage.FileGetter// Close cleans up any resources associated with the FileGetCloser.Close()error}FileGetCloser extends the storage.FileGetter interface with a Close methodfor cleaning up.
typeNaiveDiffDriver¶
type NaiveDiffDriver struct {ProtoDriverIDMapuser.IdentityMapping// If true, allow ApplyDiff to succeed in spite of failures to set// extended attributes on the unpacked files due to the destination// filesystem not supporting them or a lack of permissions. The// resulting unpacked layer may be subtly broken.BestEffortXattrsbool}NaiveDiffDriver takes a ProtoDriver and adds thecapability of the Diffing methods on the local file system,which it may or may not support on its own. See the commenton the exported NewNaiveDiffDriver function below.
func (*NaiveDiffDriver)ApplyDiff¶
ApplyDiff extracts the changeset from the given diff into thelayer with the specified id and parent, returning the size of thenew layer in bytes.
func (*NaiveDiffDriver)Changes¶
func (gdw *NaiveDiffDriver) Changes(id, parentstring) ([]archive.Change,error)
Changes produces a list of changes between the specified layerand its parent layer. If parent is "", then all changes will be ADD changes.
func (*NaiveDiffDriver)Diff¶
func (gdw *NaiveDiffDriver) Diff(id, parentstring) (archio.ReadCloser, retErrerror)
Diff produces an archive of the changes between the specifiedlayer and its parent layer which may be "".
typeNotSupportedError¶
type NotSupportedErrorstring
NotSupportedError signals that the graph-driver is not supported on the current configuration
const (// ErrNotSupported returned when driver is not supported.ErrNotSupportedNotSupportedError = "driver not supported"// ErrPrerequisites returned when driver does not meet prerequisites.ErrPrerequisitesNotSupportedError = "prerequisites for driver not satisfied (wrong filesystem?)"// ErrIncompatibleFS returned when file system is not supported.ErrIncompatibleFSNotSupportedError = "backing file system is unsupported for this graph driver")
func (NotSupportedError)Error¶
func (eNotSupportedError) Error()string
func (NotSupportedError)NotSupported¶
func (eNotSupportedError) NotSupported()
NotSupported signals that a graph-driver is not supported.
typeOptions¶
type Options struct {RootstringDriverOptions []stringIDMapuser.IdentityMappingExperimentalEnabledbool}Options is used to initialize a graphdriver
typeProtoDriver¶
type ProtoDriver interface {// String returns a string representation of this driver.String()string// CreateReadWrite creates a new, empty filesystem layer that is ready// to be used as the storage for a container. Additional options can// be passed in opts. parent may be "" and opts may be nil.CreateReadWrite(id, parentstring, opts *CreateOpts)error// Create creates a new, empty, filesystem layer with the// specified id and parent and options passed in opts. Parent// may be "" and opts may be nil.Create(id, parentstring, opts *CreateOpts)error// Remove attempts to remove the filesystem layer with this id.Remove(idstring)error// Get returns the mountpoint for the layered filesystem referred// to by this id. You can optionally specify a mountLabel or "".// Returns the absolute path to the mounted layered filesystem.Get(id, mountLabelstring) (fsstring, errerror)// Put releases the system resources for the specified id,// e.g, unmounting layered filesystem.Put(idstring)error// Exists returns whether a filesystem layer with the specified// ID exists on this driver.Exists(idstring)bool// Status returns a set of key-value pairs which give low// level diagnostic status about this driver.Status() [][2]string// GetMetadata returns a set of key-value pairs which give driver-specific// low-level information about the image/container that the driver is managing.GetMetadata(idstring) (map[string]string,error)// Cleanup performs necessary tasks to release resources// held by the driver, e.g., unmounting all layered filesystems// known to this driver.Cleanup()error}ProtoDriver defines the basic capabilities of a driver.This interface exists solely to be a minimum set of methodsfor client code which choose not to implement the entire Driverinterface and use the NaiveDiffDriver wrapper constructor.
Use of ProtoDriver directly by client code is not recommended.