bundle

Documentation

Index

• type Bundle
  • func NewBundle(path string) (Bundle, error)
  • func NewBundleFromReader(r io.Reader) Bundle
• type PackageCRDs
• type PackageFiles

Types

type Bundle

type Bundle interface {
	GetCRDs() (*PackageCRDs, error)
}

Bundle is an abstraction of the collection of files that makes up a package. It is anything we can retrieve the PackageCRDs from.

func NewBundle

func NewBundle(path string) (Bundle, error)

NewBundle creates the implementation of the bundle based on the path. The expectation is the bundle is always local . The path can be relative or absolute location of the bundle.

func NewBundleFromReader

func NewBundleFromReader(r io.Reader) Bundle

NewBundleFromReader is a bundle from a reader. This should only be used when a file cache isn't used.

type PackageCRDs

type PackageCRDs struct {
	Operator        *v1alpha1.Operator
	OperatorVersion *v1alpha1.OperatorVersion
	Instance        *v1alpha1.Instance
}

PackageCRDs is collection of CRDs that are used when installing operator during installation, package format is converted to this structure

type PackageFiles

type PackageFiles struct {
	Templates map[string]string
	Operator  *bundle.Operator
	Params    []v1alpha1.Parameter
}

PackageFiles represents the raw operator package format the way it is found in the tgz package bundles