packages

package

v0.9.0 Latest Latest Go to latest Published: Dec 13, 2019 License: Apache-2.0 Imports: 9 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/kudobuilder/kudo

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Files
- func (p *Files) Resources() (*Resources, error)
type OperatorFile
type Package
type Parameter
type ParamsFile
type Resources
type Templates

Constants ¶

View Source

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

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Files ¶ added in v0.9.0

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

func (*Files) Resources ¶ added in v0.9.0

func (p *Files) Resources() (*Resources, error)

type OperatorFile ¶ added in v0.9.0

type OperatorFile 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"`
}

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 ¶ added in v0.9.0

type Parameter []v1beta1.Parameter

func (Parameter) Len ¶ added in v0.9.0

func (p Parameter) Len() int

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

func (Parameter) Less ¶ added in v0.9.0

func (p Parameter) 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 (Parameter) Swap ¶ added in v0.9.0

func (p Parameter) 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 ¶ added in v0.9.0

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

ParamsFile is a representation of the package params.yaml

type Resources ¶ added in v0.8.0

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 ¶ added in v0.9.0

type Templates map[string]string

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

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
reader
resolver
verifier
template
writer

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL