oci

Documentation

Index

• Variables
• func BuildImage(sourcePath string, opts ...BuildOption) (gcrv1.Image, error)
• func CreateTempOCIContentDir() (tempDir string, err error)
• func ErrAppendingLayer(err error) error
• func ErrCompressingLayer(err error) error
• func ErrGettingImage(err error) error
• func ErrGettingLayer(err error) error
• func ErrReadingFile(err error) error
• func ErrUnSupportedLayerType(err error) error
• func ErrUnTaringLayer(err error) error
• func ErrValidatingImage(err error) error
• func SaveOCIArtifact(img gcrv1.Image, artifactPath, name string) error
• func UnCompressOCIArtifact(source, destination string) error
• type BuildOption
• type BuildOptions
• type LayerType

Variables

var (
	ErrAppendingLayerCode       = "11107"
	ErrReadingFileCode          = "11108"
	ErrUnSupportedLayerTypeCode = "11109"
	ErrGettingLayerCode         = "11110"
	ErrCompressingLayerCode     = "11111"
	ErrUnTaringLayerCode        = "11112"
	ErrGettingImageCode         = "11113"
	ErrValidatingImageCode      = "11114"
)

Functions

func BuildImage

func BuildImage(sourcePath string, opts ...BuildOption) (gcrv1.Image, error)

Builds OCI Img for the artifacts in the given path. Returns v1.Image manifest.

func CreateTempOCIContentDir

func CreateTempOCIContentDir() (tempDir string, err error)

func ErrAppendingLayer

func ErrAppendingLayer(err error) error

func ErrCompressingLayer

func ErrCompressingLayer(err error) error

func ErrGettingImage

func ErrGettingImage(err error) error

func ErrGettingLayer

func ErrGettingLayer(err error) error

func ErrReadingFile

func ErrReadingFile(err error) error

func ErrUnSupportedLayerType

func ErrUnSupportedLayerType(err error) error

func ErrUnTaringLayer

func ErrUnTaringLayer(err error) error

func ErrValidatingImage

func ErrValidatingImage(err error) error

func SaveOCIArtifact

func SaveOCIArtifact(img gcrv1.Image, artifactPath, name string) error

saves the oci artifact to the given path as tarball type

func UnCompressOCIArtifact

func UnCompressOCIArtifact(source, destination string) error

uncompress the OCI Artifact tarball at the given destination path

Types

type BuildOption

type BuildOption func(o *BuildOptions)

BuildOption is a function for configuring BuildOptions.

type BuildOptions

type BuildOptions struct {
	// contains filtered or unexported fields
}

BuildOptions are options for configuring the Push operation.

type LayerType

type LayerType string

LayerType is an enumeration of the supported layer types when pushing an image.

const (
	// LayerTypeTarball produces a layer that contains a gzipped archive
	LayerTypeTarball LayerType = "tarball"
	// LayerTypeStatic produces a layer that contains the contents of a
	// file without any compression.
	LayerTypeStatic LayerType = "static"
)