csm

Documentation

Index

• Constants
• func Compare(version string) (string, int)
• func CompareMajorMinor(version string) (string, int)
• func DetectedVersion() (string, error)
• func IsCompatible() (string, error)

Constants

const APIEnvName = "CSM_RELEASE"

APIEnvName defines the environment variable to read the CSM installation version from for checking the API version against.

const APIKeyName = "csm-version"

APIKeyName defines the name of the parameter and input file's key that defines the target API version.

const MinimumVersion = "v1.4"

MinimumVersion defines the minimum CSI API version that this application is back-wards compatible with. NOTE: This should never change to a higher version, support should grow backwards or remain

the same (e.g. changing to v1.2 is acceptable, changing to v1.5 is not).

Functions

func Compare

func Compare(version string) (string, int)

Compare does a semver.Compare of the CurrentVersion against a given version.

func CompareMajorMinor

func CompareMajorMinor(version string) (string, int)

CompareMajorMinor is the same as Compare but only considers the major and minor version numbers. Useful for resolving whether a given full-release equal to a parent release. (e.g. v1.2.3 vs v1.2.4 evaluates as equal).

func DetectedVersion

func DetectedVersion() (string, error)

DetectedVersion returns the version of CSM detected in the environment by the APIEnvName.

func IsCompatible

func IsCompatible() (string, error)

IsCompatible returns whether the currently set version is compatible with this variant of CSI or not.