overlay

Documentation

Index

• func AsynchronousRemove(config *SnapshotterConfig) error
• func NewSnapshotter(root string, opts ...Opt) (snapshots.Snapshotter, error)
• func WithUpperdirLabel(config *SnapshotterConfig) error
• type MetaStore
• type Opt
  • func WithMetaStore(ms MetaStore) Opt
  • func WithMountOptions(options []string) Opt
• type SnapshotterConfig

Functions

func AsynchronousRemove

func AsynchronousRemove(config *SnapshotterConfig) error

AsynchronousRemove defers removal of filesystem content until the Cleanup method is called. Removals will make the snapshot referred to by the key unavailable and make the key immediately available for re-use.

func NewSnapshotter

func NewSnapshotter(root string, opts ...Opt) (snapshots.Snapshotter, error)

NewSnapshotter returns a Snapshotter which uses overlayfs. The overlayfs diffs are stored under the provided root. A metadata file is stored under the root.

func WithUpperdirLabel

func WithUpperdirLabel(config *SnapshotterConfig) error

WithUpperdirLabel adds as an optional label "containerd.io/snapshot/overlay.upperdir". This stores the location of the upperdir that contains the changeset between the labelled snapshot and its parent.

Types

type MetaStore

type MetaStore interface {
	TransactionContext(ctx context.Context, writable bool) (context.Context, storage.Transactor, error)
	WithTransaction(ctx context.Context, writable bool, fn storage.TransactionCallback) error
	Close() error
}

type Opt

type Opt func(config *SnapshotterConfig) error

Opt is an option to configure the overlay snapshotter

func WithMetaStore

func WithMetaStore(ms MetaStore) Opt

WithMetaStore allows the MetaStore to be created outside the snapshotter and passed in.

func WithMountOptions

func WithMountOptions(options []string) Opt

WithMountOptions defines the default mount options used for the overlay mount. NOTE: Options are not applied to bind mounts.

type SnapshotterConfig

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

SnapshotterConfig is used to configure the overlay snapshotter instance