common

package

v0.4.5 Latest Latest Go to latest Published: Jan 8, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const KubectlLocalNamingScheme = "kubectl%d.%d.%d"

KubectlLocalNamingScheme holds the scheme used to name the kubectl binaries downloaded by kuberlr

View Source

const KubectlSystemNamingScheme = "kubectl%d.%d"

KubectlSystemNamingScheme holds the scheme used to name the kubectl binaries installed system-wide

View Source

const SystemPath = "/usr/bin"

SystemPath contains the default path to look for kubectl binaries installed system-wide

This section is empty.

func BuildKubectlNameForLocalBin(v semver.Version) string

BuildKubectlNameForLocalBin returns how kuberlr will name the kubectl binary with the specified version when downloading that to the user home

func BuildKubectlNameForSystemBin(version semver.Version) string

BuildKubectlNameForSystemBin returns how kuberlr expects system-wide kubectl binaries to be named

func HomeDir() string

HomeDir returns current user home directory

func HomeDirEnvKey() string

HomeDirEnvKey returns the name of the environment variable that holds the name of the user home directory

func IsNoVersionFound(err error) bool

IsNoVersionFound returns true when the given error is of type NoVersionFoundError

func IsShaMismatch(err error) bool

IsShaMismatch returns true when the given error is of type ShaMismatchError

func LocalDownloadDir() string

LocalDownloadDir return the path to where kuberlr saves the kubectl binaries downloaded from kubernetes' upstream mirror

type NoVersionFoundError struct {
	Err error
}

NoVersionFoundError error is raised when no kubectl binary has yet been downloaded by kuberlr

func (e *NoVersionFoundError) Error() string

Error returns a human description of the error

type ShaMismatchError struct {
	URL         string
	ShaExpected string
	ShaActual   string
}

ShaMismatchError error is raised when the downloaded kubectl's SHA doesn't match the recorded SHA

func (e *ShaMismatchError) Error() string

Error returns a human description of the error