packages

Documentation

Index

• Constants
• type Files
• type OperatorFile
• type Package
• type Parameter
  • func (p *Parameter) HasDefault() bool
  • func (p Parameter) IsImmutable() bool
  • func (p Parameter) IsRequired() bool
• type Parameters
  • func (p Parameters) Len() int
  • func (p Parameters) Less(x, y int) bool
  • func (p Parameters) Swap(i, j int)
• type ParamsFile
• type Resources
• type Templates
• type Verifier

Constants

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

Types

type Files

type Files struct {
	Templates Templates
	Operator  *OperatorFile
	Params    *ParamsFile
}

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

type OperatorFile

type OperatorFile struct {
	APIVersion        string                  `json:"apiVersion,omitempty"`
	Name              string                  `json:"name"`
	Description       string                  `json:"description,omitempty"`
	OperatorVersion   string                  `json:"operatorVersion"`
	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"`
	NamespaceManifest string                  `json:"namespaceManifest,omitempty"`
}

OperatorFile is a representation of the package operator.yaml

type Package

type Package struct {
	// transformed server view
	Resources *Resources
	// working with local package files
	Files *Files
}

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

type Parameter

type Parameter struct {
	DisplayName string                `json:"displayName,omitempty"`
	Name        string                `json:"name,omitempty"`
	Description string                `json:"description,omitempty"`
	Required    *bool                 `json:"required,omitempty"`
	Default     interface{}           `json:"default,omitempty"`
	Trigger     string                `json:"trigger,omitempty"`
	Type        v1beta1.ParameterType `json:"type,omitempty"`
	Immutable   *bool                 `json:"immutable,omitempty"`
}

Modified v1beta1.Parameter that allows for defaults provided as YAML.

func (*Parameter) HasDefault

func (p *Parameter) HasDefault() bool

func (Parameter) IsImmutable

func (p Parameter) IsImmutable() bool

func (Parameter) IsRequired

func (p Parameter) IsRequired() bool

type Parameters

type Parameters []Parameter

func (Parameters) Len

func (p Parameters) Len() int

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

func (Parameters) Less

func (p Parameters) 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 (Parameters) Swap

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

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

type ParamsFile

type ParamsFile struct {
	APIVersion string     `json:"apiVersion,omitempty"`
	Parameters Parameters `json:"parameters"`
}

ParamsFile is a representation of the package params.yaml

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

type Templates

type Templates map[string]string

Templates is a map of file names and stringified files in the template folder of an operator

type Verifier

type Verifier interface {
	Verify(pf *Files) verifier.Result
}

Verifier defines the interface for all parameter verifiers