overlay

Documentation

Index

• func AsynchronousRemove(config *SnapshotterConfig) error
• func NewBoltSnapshotter(root string, opts ...Opt) (snapshots.Snapshotter, error)
• func NewEtcdSnapshotter(root string, ecfg *clientv3.Config, opts ...Opt) (snapshots.Snapshotter, error)
• func UpperdirPathSetter(upperdirPath string) func(*SnapshotterConfig) error
• func WithOverlaynfs(config *SnapshotterConfig) error
• func WithUpperdirLabel(config *SnapshotterConfig) error
• func WithUserXAttr(config *SnapshotterConfig) error
• type 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 NewBoltSnapshotter

func NewBoltSnapshotter(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 NewEtcdSnapshotter

func NewEtcdSnapshotter(root string, ecfg *clientv3.Config, 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 UpperdirPathSetter

func UpperdirPathSetter(upperdirPath string) func(*SnapshotterConfig) error

func WithOverlaynfs

func WithOverlaynfs(config *SnapshotterConfig) error

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.

func WithUserXAttr

func WithUserXAttr(config *SnapshotterConfig) error

Types

type Opt

type Opt func(config *SnapshotterConfig) error

Opt is an option to configure the overlay snapshotter

type SnapshotterConfig

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

SnapshotterConfig is used to configure the overlay snapshotter instance