squashoverlay

package module
v0.0.0-...-4649b42 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 24, 2021 License: Apache-2.0 Imports: 16 Imported by: 0

README

containerd SquashOverlay snapshotter plugin

SquashOverlay snapshotter plugin for containerd. It is based on the overlayfs plugin and change the underlying RO layers storage to squashfs.

This plugin is tested on Linux with Fedora.

Usage

  1. Build the plugin binary: go build cmd/main.go

  2. Run plugin: ./main /var/run/squashoverlay.sock /tmp/squashoverlay, where /tmp/squashoverlay is the directory that snapshots will be stored.

  3. Condig containerd: add following section to your /etc/containerd/config.toml file

[proxy_plugins]
  [proxy_plugins.squashoverlay]
    type = "snapshot"
    address = "/var/run/squashoverlay.sock"
  1. Start containerd.

  2. e.g. ctr pull --snapshotter=squashoverlay ... or CONTAINERD_SNAPSHOTTER=squashoverlay ctr ...

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

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.

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

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL