packages

Documentation

Index

• Constants
• func CreateTarball(fs afero.Fs, path string, destination string, overwrite bool) (target string, err error)
• func Untar(fs afero.Fs, path string, r io.Reader) (err error)
• type Operator
• type Package
  • func NewFromBytes(buf *bytes.Buffer) Package
  • func ReadPackage(fs afero.Fs, path string) (Package, error)
• type PackageFiles
  • func FromFolder(fs afero.Fs, packagePath string) (*PackageFiles, error)
• type PackageFilesDigest
  • func GetFilesDigest(fs afero.Fs, paths []string) []*PackageFilesDigest
• type ParametersFile
• type Params
  • func (p Params) Len() int
  • func (p Params) Less(x, y int) bool
  • func (p Params) Swap(i, j int)
• type Resources

Constants

const (
	APIVersion = "kudo.dev/v1beta1"
)

Functions

func CreateTarball

func CreateTarball(fs afero.Fs, path string, destination string, overwrite bool) (target string, err error)

CreateTarball takes a path to operator files and creates a tgz of those files with the destination and name provided

func Untar

func Untar(fs afero.Fs, path string, r io.Reader) (err error)

Untar takes a destination path and a reader; a tar reader loops over the tarfile creating the file structure at 'path' along the way, and writing any files

Types

type Operator

type Operator struct {
	APIVersion        string                  `json:"apiVersion,omitempty"`
	Name              string                  `json:"name"`
	Description       string                  `json:"description,omitempty"`
	Version           string                  `json:"version"`
	AppVersion        string                  `json:"appVersion,omitempty"`
	KUDOVersion       string                  `json:"kudoVersion,omitempty"`
	KubernetesVersion string                  `json:"kubernetesVersion,omitempty"`
	Maintainers       []*v1beta1.Maintainer   `json:"maintainers,omitempty"`
	URL               string                  `json:"url,omitempty"`
	Tasks             []v1beta1.Task          `json:"tasks"`
	Plans             map[string]v1beta1.Plan `json:"plans"`
}

Operator is a representation of the KEP-9 Operator YAML

type Package

type Package interface {
	// transformed server view
	GetCRDs() (*Resources, error)
	// working with local package files
	GetPkgFiles() (*PackageFiles, error)
}

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

func NewFromBytes

func NewFromBytes(buf *bytes.Buffer) Package

NewFromBytes creates a package from a byte Buffer

func ReadPackage

func ReadPackage(fs afero.Fs, path string) (Package, error)

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

type PackageFiles

type PackageFiles struct {
	Templates map[string]string
	Operator  *Operator
	Params    Params
}

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

func FromFolder

func FromFolder(fs afero.Fs, packagePath string) (*PackageFiles, error)

FromFolder walks the path provided and returns CRD package files or an error

type PackageFilesDigest

type PackageFilesDigest struct {
	PkgFiles *PackageFiles
	Digest   string
}

PackageFilesDigest is a tuple of data used to return the package files AND the digest of a tarball

func GetFilesDigest

func GetFilesDigest(fs afero.Fs, paths []string) []*PackageFilesDigest

GetFilesDigest maps []string of paths to the [] Operators

type ParametersFile

type ParametersFile struct {
	APIVersion string              `json:"apiVersion,omitempty"`
	Params     []v1beta1.Parameter `json:"parameters"`
}

type Params

type Params []v1beta1.Parameter

func (Params) Len

func (p Params) Len() int

Len returns the number of params. This is needed to allow sorting of params.

func (Params) Less

func (p Params) Less(x, y int) bool

Less returns true if the name of a param a is less than the name of param b. This is needed to allow sorting of params.

func (Params) Swap

func (p Params) Swap(i, j int)

Swap swaps the position of two items in the params slice. This is needed to allow sorting of params.

type Resources

type Resources struct {
	Operator        *v1beta1.Operator
	OperatorVersion *v1beta1.OperatorVersion
	Instance        *v1beta1.Instance
}

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