image

Documentation

Overview

Package image defines methods for validating, and unpacking OCI images.

Index

• Constants
• Variables
• func Autodetect(path string) (string, error)
• func CreateRuntimeBundle(tarFile, dest, ref, root string) error
• func CreateRuntimeBundleLayout(src, dest, ref, root string) error
• func Unpack(tarFile, dest, ref string) error
• func UnpackLayout(src, dest, ref string) error
• func Validate(tarFile string, refs []string, out *log.Logger) error
• func ValidateLayout(src string, refs []string, out *log.Logger) error

Constants

const (
	TypeImageLayout  = "imageLayout"
	TypeImage        = "image"
	TypeManifest     = "manifest"
	TypeManifestList = "manifestList"
	TypeConfig       = "config"
)

supported autodetection types

Variables

var IssuesURL = "https://github.com/opencontainers/image-tools/issues"

IssuesURL is the URL for the issues of image-tools

var SpecURL = "https://github.com/opencontainers/image-spec"

SpecURL is the URL for the image-spec repository

Functions

func Autodetect

func Autodetect(path string) (string, error)

Autodetect detects the validation type for the given path or an error if the validation type could not be resolved.

func CreateRuntimeBundle

func CreateRuntimeBundle(tarFile, dest, ref, root string) error

CreateRuntimeBundle walks through the given .tar file and creates an OCI runtime bundle in the given destination dest or returns an error if the unpacking failed.

func CreateRuntimeBundleLayout

func CreateRuntimeBundleLayout(src, dest, ref, root string) error

CreateRuntimeBundleLayout walks through the file tree given by src and creates an OCI runtime bundle in the given destination dest or returns an error if the unpacking failed.

func Unpack

func Unpack(tarFile, dest, ref string) error

Unpack walks through the given .tar file and, using the layers specified in the manifest pointed to by the given ref, unpacks all layers in the given destination directory or returns an error if the unpacking failed.

func UnpackLayout

func UnpackLayout(src, dest, ref string) error

UnpackLayout walks through the file tree given by src and, using the layers specified in the manifest pointed to by the given ref, unpacks all layers in the given destination directory or returns an error if the unpacking failed.

func Validate

func Validate(tarFile string, refs []string, out *log.Logger) error

Validate walks through the given .tar file and validates the manifest pointed to by the given refs or returns an error if the validation failed.

func ValidateLayout

func ValidateLayout(src string, refs []string, out *log.Logger) error

ValidateLayout walks through the given file tree and validates the manifest pointed to by the given refs or returns an error if the validation failed.