upgrade

Documentation

Index

• type UpgradeFile
  • func ParseUpgradeFileFromBytes(upgradeNotes []byte) (*UpgradeFile, error)
  • func (u *UpgradeFile) GetUpgradeFileBetweenVersions(prev, target string) (*UpgradeFile, error)
• type UpgradeNote

Types

type UpgradeFile

type UpgradeFile struct {
	UpgradeNotes []*UpgradeNote `yaml:"upgrade_notes" json:"upgrade_notes"`
}

UpgradeFile is a collection of upgrade notes between specific versions

func ParseUpgradeFileFromBytes

func ParseUpgradeFileFromBytes(upgradeNotes []byte) (*UpgradeFile, error)

ParseUpgradeFileFromBytes parses the raw bytes of an upgrade file and returns an UpgradeFile object. sigs.k8s.io/yaml parser is used.

func (*UpgradeFile) GetUpgradeFileBetweenVersions

func (u *UpgradeFile) GetUpgradeFileBetweenVersions(prev, target string) (*UpgradeFile, error)

GetUpgradeFileBetweenVersions gets the set of upgrade notes that are applicable to an upgrade between a previous and target version.

type UpgradeNote

type UpgradeNote struct {
	PreviousVersion string `yaml:"previous" json:"previous"`
	TargetVersion   string `yaml:"target" json:"target"`
	Note            string `yaml:"note" json:"note"`
}

UpgradeNote is a single note for upgrading between a previous version and a target version.