pinnedversion

Documentation

Index

• func GenerateOperatorComponents(outputDir string) (registry.OperatorComponent, string, error)
• func LoadHashrelease(repoRootDir, tmpDir, srcDir string) (*hashreleaseserver.Hashrelease, error)
• func RandomWord() string
• func RetrieveComponentsToValidate(outputDir string) (map[string]registry.Component, error)
• func RetrievePinnedOperator(outputDir string) (registry.OperatorComponent, error)
• type Config
• type PinnedVersion
  • func RetrievePinnedVersion(outputDir string) (PinnedVersion, error)
• type PinnedVersionData
  • func GeneratePinnedVersionFile(cfg Config, outputDir string) (string, *PinnedVersionData, error)
• type PinnedVersionFile

Functions

func GenerateOperatorComponents

func GenerateOperatorComponents(outputDir string) (registry.OperatorComponent, string, error)

GenerateOperatorComponents generates the components-version.yaml for operator.

func LoadHashrelease

func LoadHashrelease(repoRootDir, tmpDir, srcDir string) (*hashreleaseserver.Hashrelease, error)

func RandomWord

func RandomWord() string

RandomWord returns a random word from the word list

func RetrieveComponentsToValidate

func RetrieveComponentsToValidate(outputDir string) (map[string]registry.Component, error)

RetrieveComponentsToValidate retrieves the components to validate from the pinned version file.

func RetrievePinnedOperator

func RetrievePinnedOperator(outputDir string) (registry.OperatorComponent, error)

RetrievePinnedOperatorVersion retrieves the operator version from the pinned version file.

Types

type Config

type Config struct {
	// RootDir is the root directory of the repository.
	RootDir string

	// ReleaseBranchPrefix is the prefix for the release branch.
	ReleaseBranchPrefix string

	// Operator is the configuration for the operator.
	Operator config.OperatorConfig
}

Config represents the configuration needed to generate the pinned version file.

type PinnedVersion

type PinnedVersion struct {
	Title          string                        `yaml:"title"`
	ManifestURL    string                        `yaml:"manifest_url"`
	ReleaseName    string                        `yaml:"release_name"`
	Note           string                        `yaml:"note"`
	Hash           string                        `yaml:"full_hash"`
	TigeraOperator registry.Component            `yaml:"tigera-operator"`
	Components     map[string]registry.Component `yaml:"components"`
}

PinnedVersion represents an entry in pinned version file.

func RetrievePinnedVersion

func RetrievePinnedVersion(outputDir string) (PinnedVersion, error)

RetrievePinnedVersion retrieves the pinned version from the pinned version file.

type PinnedVersionData

type PinnedVersionData struct {
	// ReleaseName is the name of the release.
	ReleaseName string

	// BaseDomain is the base domain for the docs site.
	BaseDomain string

	// ProductVersion is the version of the product.
	ProductVersion string

	// Operator is the operator component.
	Operator registry.Component

	// Note is the note for the release.
	Note string

	// Hash is the hash of the release.
	Hash string

	// ReleaseBranch is the release branch of the release.
	ReleaseBranch string
}

PinnedVersionData represents the data needed to generate the pinned version file from the template.

func GeneratePinnedVersionFile

func GeneratePinnedVersionFile(cfg Config, outputDir string) (string, *PinnedVersionData, error)

GeneratePinnedVersionFile generates the pinned version file.

type PinnedVersionFile

type PinnedVersionFile []PinnedVersion

PinnedVersionFile represents the pinned version file.