tool

Documentation

Index

• func Merge(option MergeOption) ([]digest.Digest, error)
• func Pack(option PackOption) error
• func Unpack(option UnpackOption) error
• type Feature
• type Features
  • func DetectFeatures(builder string, required Features) Features
  • func (features *Features) Contains(feature Feature) bool
  • func (features *Features) Remove(feature Feature)
• type MergeOption
• type PackOption
• type UnpackOption

Functions

func Merge

func Merge(option MergeOption) ([]digest.Digest, error)

func Pack

func Pack(option PackOption) error

func Unpack

func Unpack(option UnpackOption) error

Types

type Feature

type Feature string

const (
	// The option `--type tar-rafs` enables converting OCI tar blob
	// stream into nydus blob directly, the tar2rafs eliminates the
	// need to decompress it to a local directory first, thus greatly
	// accelerating the pack process.
	FeatureTar2Rafs Feature = "--type tar-rafs"
)

type Features

type Features []Feature

func DetectFeatures

func DetectFeatures(builder string, required Features) Features

DetectFeatures returns supported feature list from required feature list.

func (*Features) Contains

func (features *Features) Contains(feature Feature) bool

func (*Features) Remove

func (features *Features) Remove(feature Feature)

type MergeOption

type MergeOption struct {
	BuilderPath string

	SourceBootstrapPaths []string
	RafsBlobDigests      []string
	RafsBlobTOCDigests   []string
	RafsBlobSizes        []int64

	TargetBootstrapPath string
	ChunkDictPath       string
	ParentBootstrapPath string
	PrefetchPatterns    string
	OutputJSONPath      string
	Timeout             *time.Duration
}

type PackOption

type PackOption struct {
	BuilderPath string

	BootstrapPath    string
	BlobPath         string
	FsVersion        string
	SourcePath       string
	ChunkDictPath    string
	PrefetchPatterns string
	Compressor       string
	OCIRef           bool
	AlignedChunk     bool
	ChunkSize        string
	BatchSize        string
	Timeout          *time.Duration

	Features Features
}

type UnpackOption

type UnpackOption struct {
	BuilderPath       string
	BootstrapPath     string
	BlobPath          string
	BackendConfigPath string
	TarPath           string
	Timeout           *time.Duration
}