archive

Documentation

Index

• func Apply(ctx context.Context, root string, r io.Reader, opts ...ApplyOpt) (int64, error)
• func Diff(ctx context.Context, a, b string) io.ReadCloser
• func WriteDiff(ctx context.Context, w io.Writer, a, b string) error
• type ApplyOpt
  • func AsWindowsContainerLayer() ApplyOpt
  • func WithParentLayers(parentPaths []string) ApplyOpt
• type ApplyOptions

Functions

func Apply

func Apply(ctx context.Context, root string, r io.Reader, opts ...ApplyOpt) (int64, error)

Apply applies a tar stream of an OCI style diff tar. See https://github.com/opencontainers/image-spec/blob/master/layer.md#applying-changesets

func Diff

func Diff(ctx context.Context, a, b string) io.ReadCloser

Diff returns a tar stream of the computed filesystem difference between the provided directories.

Produces a tar using OCI style file markers for deletions. Deleted files will be prepended with the prefix ".wh.". This style is based off AUFS whiteouts. See https://github.com/opencontainers/image-spec/blob/master/layer.md

func WriteDiff

func WriteDiff(ctx context.Context, w io.Writer, a, b string) error

WriteDiff writes a tar stream of the computed difference between the provided directories.

Produces a tar using OCI style file markers for deletions. Deleted files will be prepended with the prefix ".wh.". This style is based off AUFS whiteouts. See https://github.com/opencontainers/image-spec/blob/master/layer.md

Types

type ApplyOpt

type ApplyOpt func(options *ApplyOptions) error

ApplyOpt allows setting mutable archive apply properties on creation

func AsWindowsContainerLayer

func AsWindowsContainerLayer() ApplyOpt

AsWindowsContainerLayer indicates that the tar stream to apply is that of a Windows Container Layer. The caller must be holding SeBackupPrivilege and SeRestorePrivilege.

func WithParentLayers

func WithParentLayers(parentPaths []string) ApplyOpt

WithParentLayers adds parent layers to the apply process this is required for all Windows layers except the base layer.

type ApplyOptions

type ApplyOptions struct {
	ParentLayerPaths        []string // Parent layer paths used for Windows layer apply
	IsWindowsContainerLayer bool     // True if the tar stream to be applied is a Windows Container Layer
}

ApplyOptions provides additional options for an Apply operation