util

Documentation

Index

• Constants
• Variables
• func CacheOc(openShiftVersion string) string
• func DoesVMExist(profileName string) bool
• func ExitIfNotRunning(driver drivers.Driver, machineName string)
• func ExitIfUndefined(client *libmachine.Client, machineName string)
• func GetBoolEnv(varName string) (bool, error)
• func GetNoProxyConfig(api libmachine.API) (string, string, error)
• func GetOcPathForProfile(profileName string) (error, string)
• func GetVMStatus(profileName string) string
• func IsHostRunning(driver drivers.Driver) bool
• func IsHostStopped(driver drivers.Driver) bool
• func IsValidProfile(profileName string) bool
• func IsValidProfileName(profileName string) bool
• func NewStringSliceValue(val []string, p *[]string) *stringSliceValue
• func NewStringValue(val string, p *string) *stringValue
• func RemoveCurrentContext() error
• func ReplaceEnv(variables []string, varName string, value string) []string
• func SetOcContext(profileName string) error
• func UnpackAddons(addonsDir string) error
• func VMExists(client *libmachine.Client, machineName string) bool

Constants

const (
	HttpProxy  = "http-proxy"
	HttpsProxy = "https-proxy"
	AddOnEnv   = "addon-env"
)

Variables

var (
	BooleanFormatError  = errors.New("Invalid format for boolean value.")
	BooleanNoValueError = errors.New("No value given.")
)

var AddOnEnvFlag = &flag.Flag{
	Name:      AddOnEnv,
	Shorthand: "a",
	Usage:     "Specify key-value pairs to be added to the add-on interpolation context.",
	Value:     NewStringSliceValue([]string{}, &[]string{}),
}

var (
	DefaultAssets = []string{"anyuid", "admin-user", "xpaas", "registry-route"}
)

var HttpProxyFlag = &flag.Flag{
	Name:      HttpProxy,
	Shorthand: "",
	Usage:     "HTTP proxy in the format http://<username>:<password>@<proxy_host>:<proxy_port>. Overrides potential HTTP_PROXY setting in the environment.",
	Value:     NewStringValue("", new(string)),
	DefValue:  "",
}

var HttpsProxyFlag = &flag.Flag{
	Name:      HttpsProxy,
	Shorthand: "",
	Usage:     "HTTPS proxy in the format https://<username>:<password>@<proxy_host>:<proxy_port>. Overrides potential HTTPS_PROXY setting in the environment.",
	Value:     NewStringValue("", new(string)),
	DefValue:  "",
}

Functions

func CacheOc

func CacheOc(openShiftVersion string) string

CacheOc ensures that the oc binary matching the requested OpenShift version is cached on the host

func DoesVMExist

func DoesVMExist(profileName string) bool

func ExitIfNotRunning

func ExitIfNotRunning(driver drivers.Driver, machineName string)

func ExitIfUndefined

func ExitIfUndefined(client *libmachine.Client, machineName string)

func GetBoolEnv

func GetBoolEnv(varName string) (bool, error)

GetBoolEnv returns truthy or falsy value of given environmental variable. It returns an error on failure with a default of false.

func GetNoProxyConfig

func GetNoProxyConfig(api libmachine.API) (string, string, error)

func GetOcPathForProfile

func GetOcPathForProfile(profileName string) (error, string)

func GetVMStatus

func GetVMStatus(profileName string) string

func IsHostRunning

func IsHostRunning(driver drivers.Driver) bool

func IsHostStopped

func IsHostStopped(driver drivers.Driver) bool

func IsValidProfile

func IsValidProfile(profileName string) bool

IsValidProfile return true if a given profile exist

func IsValidProfileName

func IsValidProfileName(profileName string) bool

IsValidProfileName return true if profile name follow ^[a-zA-Z0-9]+[\w+-]*$

func NewStringSliceValue

func NewStringSliceValue(val []string, p *[]string) *stringSliceValue

func NewStringValue

func NewStringValue(val string, p *string) *stringValue

func RemoveCurrentContext

func RemoveCurrentContext() error

RemoveCurrentContext removes the current context from `machinename_kubeconfig`

func ReplaceEnv

func ReplaceEnv(variables []string, varName string, value string) []string

ReplaceEnv changes the value of an environment variable It drops the existing value and appends the new value in-place

func SetOcContext

func SetOcContext(profileName string) error

func UnpackAddons

func UnpackAddons(addonsDir string) error

UnpackAddons will unpack the default addons into addons default dir

func VMExists

func VMExists(client *libmachine.Client, machineName string) bool