version

Documentation

Overview

Package version provides methods to determine the correct version of components.

Index

• Variables
• func CatalogChannel() string
• func CatalogImage(v *goversion.Version) string
• func EverestVersionFromDeployment(ctx context.Context, dg deploymentGetter) (*goversion.Version, error)
• func FullVersionInfo() string
• func FullVersionJSON() (string, error)
• func ManifestURL(v *goversion.Version) string
• func Metadata(ctx context.Context, versionMetadataURL string) (*version.MetadataResponse, error)
• type RecommendedVersion
  • func RecommendedVersions(meta *version.MetadataVersion) (*RecommendedVersion, error)

Variables

var (
	// ProjectName is a component name, e.g. everest API Server, everestctl.
	ProjectName string //nolint:gochecknoglobals
	// Version is a component version e.g. v0.3.0-1-a93bef.
	Version string //nolint:gochecknoglobals
	// FullCommit is a git commit hash.
	FullCommit string //nolint:gochecknoglobals
	// EverestChannelOverride overrides the default olm channel for Everest operator.
	EverestChannelOverride string //nolint:gochecknoglobals

)

Functions

func CatalogChannel

func CatalogChannel() string

CatalogChannel returns a channel for Everest catalog.

func CatalogImage

func CatalogImage(v *goversion.Version) string

CatalogImage returns a catalog image name.

func EverestVersionFromDeployment

func EverestVersionFromDeployment(ctx context.Context, dg deploymentGetter) (*goversion.Version, error)

EverestVersionFromDeployment returns Everest version from the k8s deployment resource.

func FullVersionInfo

func FullVersionInfo() string

FullVersionInfo returns full version report.

func FullVersionJSON

func FullVersionJSON() (string, error)

FullVersionJSON returns version info as JSON.

func ManifestURL

func ManifestURL(v *goversion.Version) string

ManifestURL returns a manifest URL to install Everest.

func Metadata

func Metadata(ctx context.Context, versionMetadataURL string) (*version.MetadataResponse, error)

Metadata returns metadata from a given metadata URL.

Types

type RecommendedVersion

type RecommendedVersion struct {
	Catalog         *goversion.Version
	EverestOperator *goversion.Version
	OLM             *goversion.Version
	PG              *goversion.Version
	PSMDB           *goversion.Version
	PXC             *goversion.Version
}

RecommendedVersion holds recommended versions per component.

func RecommendedVersions

func RecommendedVersions(meta *version.MetadataVersion) (*RecommendedVersion, error)

RecommendedVersions returns recommended version information based on metadata.