operator

Documentation

Index

• type Git
• type GitSource
• type Operator
• type Version
  • func (v Version) Version() string

Types

type Git

type Git struct {
	// Source references a 'GitSource' name. The source's Git repository is
	// cloned and the specified tag is checked out.
	Source string

	// Directory where the KUDO operator is defined in the Git repository.
	Directory string

	// Tag of the KUDO operator version. Either this or 'SHA' has to be set.
	Tag string

	// SHA of the KUDO operator version if a branch is used instead of
	// a tag. Either this or 'Tag' has to be set.
	SHA string
}

Git references a specific tag of a Git repository of a KUDO operator.

type GitSource

type GitSource struct {
	// Name of this source. This name is referenced by 'Version' entries setting
	// a 'Git' field.
	Name string

	URL string
}

GitSource is the location of a git repository.

type Operator

type Operator struct {
	// Name of the operator.
	Name string

	// GitSources are optional references to Git repositories.
	GitSources []GitSource

	// Versions of the operator.
	Versions []Version
}

Operator describes the location of a KUDO operator.

type Version

type Version struct {
	// OperatorVersion of the KUDO operator.
	OperatorVersion string

	// AppVersion of the KUDO operator, optional.
	AppVersion string

	// Git specifies a version as a directory in a Git repository with a
	// specific tag.
	Git *Git

	// URL specifies a version as a URL of a package tarball.
	URL *string
}

Version describes a version of a KUDO operator.

func (Version) Version

func (v Version) Version() string

Version prints the version as a combination of appVersion and operatorVersion as described in KEP-19.