blockfile

Documentation

Index

• func NewSnapshotter(root string, opts ...Opt) (snapshots.Snapshotter, error)
• type Opt
  • func WithFSType(fsType string) Opt
  • func WithMountOptions(options []string) Opt
  • func WithRecreateScratch(recreate bool) Opt
  • func WithScratchFile(src string) Opt
• type SnapshotterConfig

Functions

func NewSnapshotter

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

NewSnapshotter returns a Snapshotter which copies layers on the underlying file system. A metadata file is stored under the root.

Types

type Opt

type Opt func(string, *SnapshotterConfig)

Opt is an option to configure the overlay snapshotter

func WithFSType

func WithFSType(fsType string) Opt

WithFSType defines the filesystem type to apply to mounts of the blockfile

func WithMountOptions

func WithMountOptions(options []string) Opt

WithMountOptions defines the mount options used for the mount

func WithRecreateScratch

func WithRecreateScratch(recreate bool) Opt

WithRecreateScratch is used to determine that scratch should be recreated even if already exists.

func WithScratchFile

func WithScratchFile(src string) Opt

WithScratchFile provides a scratch file which will get copied on startup if the scratch file needs to be generated.

type SnapshotterConfig

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

SnapshotterConfig holds the configurable properties for the blockfile snapshotter