vbatts/containerd
1
0
Fork 0
Code Pull requests Releases Activity

Merge pull request #566 from samuelkarp/snapshot-design

Browse source 
design: Update snapshots.md with current design
This commit is contained in:
Stephen Day 2017-02-27 14:55:28 -08:00 • committed by GitHub
commit be20bb1eb8
3 changed files with 92 additions and 91 deletions
Download patch file Download diff file Expand all files Collapse all files

10
snapshot/snapshotter.go
View file

@ -67,7 +67,7 @@ type Info struct {
//
// Importing a Layer
//
// To import a layer, we simply have the Manager provide a list of
// To import a layer, we simply have the Snapshotter provide a list of
// mounts to be applied such that our dst will capture a changeset. We start
// out by getting a path to the layer tar file and creating a temp location to
// unpack it to:
@ -122,7 +122,7 @@ type Info struct {
// above except that the parent is provided as parent when calling
// Manager.Prepare, assuming a clean tmpLocation:
//
// mounts, err := sm.Prepare(tmpLocation, parentDigest)
// mounts, err := snapshotter.Prepare(tmpLocation, parentDigest)
//
// We then mount, apply and commit, as we did above. The new snapshot will be
// based on the content of the previous one.
@ -133,15 +133,15 @@ type Info struct {
// snapshot as the parent. After mounting, the prepared path can
// be used directly as the container's filesystem:
//
// mounts, err := sm.Prepare(containerKey, imageRootFSChainID)
// mounts, err := snapshotter.Prepare(containerKey, imageRootFSChainID)
//
// The returned mounts can then be passed directly to the container runtime. If
// one would like to create a new image from the filesystem, Manager.Commit is
// called:
//
// if err := sm.Commit(newImageSnapshot, containerKey); err != nil { ... }
// if err := snapshotter.Commit(newImageSnapshot, containerKey); err != nil { ... }
//
// Alternatively, for most container runs, Manager.Remove will be called to
// Alternatively, for most container runs, Snapshotter.Remove will be called to
// signal the Snapshotter to abandon the changes.
type Snapshotter interface {
// Stat returns the info for an active or committed snapshot by name or