Documentation ¶
Index ¶
- Constants
- func ConvertHookFunc(opt MergeOption) converter.ConvertHookFunc
- func IsNydusBlob(ctx context.Context, desc ocispec.Descriptor) bool
- func IsNydusBlobAndExists(ctx context.Context, cs content.Store, desc ocispec.Descriptor) bool
- func LayerConvertFunc(opt PackOption) converter.ConvertFunc
- func Merge(ctx context.Context, layers []Layer, dest io.Writer, opt MergeOption) error
- func MergeLayers(ctx context.Context, cs content.Store, descs []ocispec.Descriptor, ...) (*ocispec.Descriptor, error)
- func Pack(ctx context.Context, dest io.Writer, opt PackOption) (io.WriteCloser, error)
- func Unpack(ctx context.Context, ia content.ReaderAt, dest io.Writer, opt UnpackOption) error
- type Backend
- type Layer
- type MergeOption
- type PackOption
- type UnpackOption
Constants ¶
View Source
const ( ManifestOSFeatureNydus = "nydus.remoteimage.v1" MediaTypeNydusBlob = "application/vnd.oci.image.layer.nydus.blob.v1" BootstrapFileNameInLayer = "image/image.boot" ManifestNydusCache = "containerd.io/snapshot/nydus-cache" LayerAnnotationFSVersion = "containerd.io/snapshot/nydus-fs-version" LayerAnnotationNydusBlob = "containerd.io/snapshot/nydus-blob" LayerAnnotationNydusBlobDigest = "containerd.io/snapshot/nydus-blob-digest" LayerAnnotationNydusBlobSize = "containerd.io/snapshot/nydus-blob-size" LayerAnnotationNydusBlobIDs = "containerd.io/snapshot/nydus-blob-ids" LayerAnnotationNydusBootstrap = "containerd.io/snapshot/nydus-bootstrap" LayerAnnotationNydusSourceChainID = "containerd.io/snapshot/nydus-source-chainid" LayerAnnotationNydusReferenceBlobIDs = "containerd.io/snapshot/nydus-reference-blob-ids" LayerAnnotationUncompressed = "containerd.io/uncompressed" )
Variables ¶
This section is empty.
Functions ¶
func ConvertHookFunc ¶ added in v0.3.0
func ConvertHookFunc(opt MergeOption) converter.ConvertHookFunc
func IsNydusBlob ¶ added in v0.3.0
func IsNydusBlob(ctx context.Context, desc ocispec.Descriptor) bool
func IsNydusBlobAndExists ¶ added in v0.3.0
func LayerConvertFunc ¶ added in v0.3.0
func LayerConvertFunc(opt PackOption) converter.ConvertFunc
func MergeLayers ¶ added in v0.3.0
func MergeLayers(ctx context.Context, cs content.Store, descs []ocispec.Descriptor, opt MergeOption) (*ocispec.Descriptor, error)
func Pack ¶ added in v0.3.0
func Pack(ctx context.Context, dest io.Writer, opt PackOption) (io.WriteCloser, error)
Types ¶
type Backend ¶ added in v0.3.0
type Backend interface { // Push pushes specified blob file to remote storage backend. Push(ctx context.Context, ra content.ReaderAt, blobDigest digest.Digest) error // Check checks whether a blob exists in remote storage backend, // blob exists -> return (blobPath, nil) // blob not exists -> return ("", err) Check(blobDigest digest.Digest) (string, error) // Type returns backend type name. Type() string }
Backend uploads blobs generated by nydus-image builder to a backend storage such as: - oss: A object storage backend, which uses its SDK to upload blob file.
type MergeOption ¶
type MergeOption struct { // WorkDir is used as the work directory during layer merge. WorkDir string // BuilderPath holds the path of `nydus-image` binary tool. BuilderPath string // FsVersion specifies nydus RAFS format version, possible // values: `5`, `6` (EROFS-compatible), default is `5`. FsVersion string // ChunkDictPath holds the bootstrap path of chunk dict image. ChunkDictPath string // PrefetchPatterns holds file path pattern list want to prefetch. PrefetchPatterns string // WithTar puts bootstrap into a tar stream (no gzip). WithTar bool // Backend uploads blobs generated by nydus-image builder to a backend storage. Backend Backend // Timeout cancels execution once exceed the specified time. Timeout *time.Duration }
type PackOption ¶ added in v0.3.0
type PackOption struct { // WorkDir is used as the work directory during layer pack. WorkDir string // BuilderPath holds the path of `nydus-image` binary tool. BuilderPath string // FsVersion specifies nydus RAFS format version, possible // values: `5`, `6` (EROFS-compatible), default is `5`. FsVersion string // ChunkDictPath holds the bootstrap path of chunk dict image. ChunkDictPath string // PrefetchPatterns holds file path pattern list want to prefetch. PrefetchPatterns string // Compressor specifies nydus blob compression algorithm. Compressor string // Backend uploads blobs generated by nydus-image builder to a backend storage. Backend Backend // Timeout cancels execution once exceed the specified time. Timeout *time.Duration }
type UnpackOption ¶ added in v0.3.0
Click to show internal directories.
Click to hide internal directories.