versioning

Documentation

Index

• Constants
• Variables
• type KabaneroRevision
  • func (KabaneroRevision KabaneroRevision) SoftwareComponent(softwareComponent string) *SoftwareRevision
• type SoftwareRevision
  • func (rev SoftwareRevision) OpenOrchestration(path string) (http.File, error)
• type VersionDocument
  • func (doc VersionDocument) KabaneroRevision(KabaneroRevision string) *KabaneroRevision

Constants

const REPOSITORY_IDENTIFIER = "repository"

The identifier key for image repositories

const TAG_IDENTIFIER = "tag"

The identifier key for tags

Variables

var Data = func() VersionDocument {
	f, err := config.Open("versions.yaml")
	if err != nil {
		panic(err)
	}

	dec := yaml.NewDecoder(f)
	var versionData VersionDocument
	err = dec.Decode(&versionData)
	if err != nil {
		panic(err)
	}

	for i, k := range versionData.KabaneroRevisions {
		k.Document = &versionData
		versionData.KabaneroRevisions[i] = k
	}

	return versionData
}()

Types

type KabaneroRevision

type KabaneroRevision struct {
	Version string `yaml:"version,omitempty"`

	// The versions associated with this Kabanero Version
	RelatedVersions map[string]string `yaml:"related-versions,omitempty"`

	Document *VersionDocument `yaml:"-"`
}

A specific version of Kabanero, contains the association to the other related software versions which match this Kabanero version

func (KabaneroRevision) SoftwareComponent

func (KabaneroRevision KabaneroRevision) SoftwareComponent(softwareComponent string) *SoftwareRevision

type SoftwareRevision

type SoftwareRevision struct {
	// The version of this piece of software that the orchestrations and identifiers apply to
	Version string `yaml:"version,omitempty"`

	// The path to orchestration sources
	OrchestrationPath string `yaml:"orchestrations,omitempty"`

	// Identifiers contains key/value pairs which are specific to this revision of the sofware
	Identifiers map[string]interface{} `yaml:"identifiers,omitempty"`
}

Contains version specific data for software which is orchestrated as part of Kabanero

func (SoftwareRevision) OpenOrchestration

func (rev SoftwareRevision) OpenOrchestration(path string) (http.File, error)

Opens the embedded orchestration file using the internal OrchestrationPath + provided path

type VersionDocument

type VersionDocument struct {
	// The version of Kabanero to use if otherwise unspecified
	DefaultKabaneroRevision string `yaml:"default,omitempty"`

	// The versions of Kabanero known to this operator
	KabaneroRevisions []KabaneroRevision `yaml:"kabanero,omitempty"`

	// The versions of related software known to this operator
	RelatedSoftwareRevisions map[string][]SoftwareRevision `yaml:"related-software,omitempty"`
}

The top level resource within the versioning model

func (VersionDocument) KabaneroRevision

func (doc VersionDocument) KabaneroRevision(KabaneroRevision string) *KabaneroRevision