bundle

Documentation

Index

• Constants
• func BuildFile(fileName string, b Bundle, imageReference string) (reference.NamedTagged, ocispec.Descriptor, error)
• func BuildFromSpecFile(specFileName string, filenameFunc func(Bundle) (string, error), ...) (string, reference.NamedTagged, ocispec.Descriptor, error)
• func BuildWriter(w io.Writer, b Bundle, imageReference string) (reference.NamedTagged, ocispec.Descriptor, error)
• func ReadSpec(specReader io.Reader) (*specsv1.Bundle, error)
• func ReadSpecFile(specFileName string) (*specsv1.Bundle, error)
• func StringFromBundleTemplate(tmplStr string) func(b Bundle) (string, error)
• type Bundle
  • func LoadFromSpec(spec specsv1.Bundle, baseDir string) (Bundle, error)
  • func NewRegistry(root fs.FS, extraAnnotations map[string]string) (Bundle, error)

Constants

const (
	MediaTypeOLMOperatorFrameworkRegistryV1 = "olm.operatorframework.io/registry+v1"
)

Functions

func BuildFile

func BuildFile(fileName string, b Bundle, imageReference string) (reference.NamedTagged, ocispec.Descriptor, error)

func BuildFromSpecFile

func BuildFromSpecFile(specFileName string, filenameFunc func(Bundle) (string, error), bundleHooks ...func(Bundle) error) (string, reference.NamedTagged, ocispec.Descriptor, error)

func BuildWriter

func BuildWriter(w io.Writer, b Bundle, imageReference string) (reference.NamedTagged, ocispec.Descriptor, error)

BuildWriter writes a bundle to a writer

func ReadSpec

func ReadSpec(specReader io.Reader) (*specsv1.Bundle, error)

func ReadSpecFile

func ReadSpecFile(specFileName string) (*specsv1.Bundle, error)

func StringFromBundleTemplate

func StringFromBundleTemplate(tmplStr string) func(b Bundle) (string, error)

Types

type Bundle

type Bundle interface {
	FS() fs.FS
	PackageName() string
	Version() semver.Version
	Annotations() map[string]string
	WriteOCIArchive(w io.Writer, tagged reference.NamedTagged) (ocispec.Descriptor, error)
}

func LoadFromSpec

func LoadFromSpec(spec specsv1.Bundle, baseDir string) (Bundle, error)

func NewRegistry

func NewRegistry(root fs.FS, extraAnnotations map[string]string) (Bundle, error)