common

Documentation

Index

• Constants
• func BuildKubectlNameForLocalBin(v semver.Version) string
• func BuildKubectlNameForSystemBin(version semver.Version) string
• func HomeDir() string
• func HomeDirEnvKey() string
• func IsNoVersionFound(err error) bool
• func IsShaMismatch(err error) bool
• func LocalDownloadDir() string
• type NoVersionFoundError
  • func (e *NoVersionFoundError) Error() string
• type ShaMismatchError
  • func (e *ShaMismatchError) Error() string

Constants

const (
	VerbosityOne
	VerbosityTwo
)

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

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

const KubectlSystemNamingScheme = "kubectl%d.%d"

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

const SystemPath = "/usr/bin"

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

Functions

func BuildKubectlNameForLocalBin

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

func BuildKubectlNameForSystemBin(version semver.Version) string

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

func HomeDir

func HomeDir() string

HomeDir returns current user home directory.

func HomeDirEnvKey

func HomeDirEnvKey() string

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

func IsNoVersionFound

func IsNoVersionFound(err error) bool

IsNoVersionFound returns true when the given error is of type NoVersionFoundError.

func IsShaMismatch

func IsShaMismatch(err error) bool

IsShaMismatch returns true when the given error is of type ShaMismatchError.

func LocalDownloadDir

func LocalDownloadDir() string

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

Types

type NoVersionFoundError

type NoVersionFoundError struct {
	Err error
}

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

func (*NoVersionFoundError) Error

func (e *NoVersionFoundError) Error() string

Error returns a human description of the error.

type ShaMismatchError

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 (*ShaMismatchError) Error

func (e *ShaMismatchError) Error() string

Error returns a human description of the error.