util

Documentation

Index

• Constants
• Variables
• func Append(base string, inc string) string
• func BackgroundRun(cmdCtx *CMDContext) error
• func CanRun(cmd *exec.Cmd) bool
• func CleanRsaKeys()
• func Contains(obj interface{}, target interface{}) bool
• func CreateDirIfNotExist(dir string)
• func DropHosts()
• func DumpHosts(hostsMap map[string]string) bool
• func ExtractErrorMessage(msg string) string
• func ExtractNetMaskFromCidr(cidr string) string
• func FindBrokenPort(exposePorts string) string
• func FixFileOwner(path string)
• func GetDaemonRunning(componentName string) int
• func GetLocalDomains() string
• func GetLocalUserName() string
• func GetOutboundIP() (address string)
• func GetRandomSSHPort() int
• func GetTimestamp() string
• func IsCmd() bool
• func IsLinux() bool
• func IsPidFileExist() bool
• func IsProcessExist(pid int) bool
• func IsWindows() bool
• func KubeConfig() string
• func MapContains(subset, fullset map[string]string) bool
• func MapEquals(src, target map[string]string) bool
• func MapPut(m map[string]string, k, v string)
• func MergeMap(m1 map[string]string, m2 map[string]string) map[string]string
• func ParsePortMapping(exposePort string) (int, int, error)
• func PrivateKeyPath(name string) string
• func RandomPort() int
• func RandomSeconds(min, max int) time.Duration
• func RandomString(n int) string
• func RemoveColor(msg string) string
• func RunAndWait(cmd *exec.Cmd, isDebug bool) error
• func SetupConfigMapHeartBeat(ctx context.Context, client coreV1.ConfigMapInterface, name string)
• func SetupPodHeartBeat(ctx context.Context, client coreV1.PodInterface, name string)
• func SetupPortForwardHeartBeat(port int)
• func SetupServiceHeartBeat(ctx context.Context, client coreV1.ServiceInterface, name string)
• func String2Map(str string) map[string]string
• func WaitPortBeReady(waitTime, port int) bool
• func WritePidFile(componentName string) error
• func WritePrivateKey(privateKeyPath string, data []byte) error
• type CMDContext
• type SSHCredential
  • func NewDefaultSSHCredential() *SSHCredential
• type SSHGenerator
  • func Generate(privateKeyPath string) (*SSHGenerator, error)
  • func NewSSHGenerator(privateKey string, publicKey string, privateKeyPath string) *SSHGenerator

Constants

const (
	ResolvConf      = "/etc/resolv.conf"
	FieldNameserver = "nameserver"
	FieldDomain     = "domain"
	FieldSearch     = "search"
)

const ResourceHeartBeatIntervalMinus = 5

Variables

var KtHome = fmt.Sprintf("%s/.ktctl", UserHome)

var UserHome = os.Getenv("HOME")

Functions

func Append

func Append(base string, inc string) string

Append Add segment to a comma separated string

func BackgroundRun

func BackgroundRun(cmdCtx *CMDContext) error

BackgroundRun run cmd in background with context

func CanRun

func CanRun(cmd *exec.Cmd) bool

CanRun check whether a command can execute successful

func CleanRsaKeys

func CleanRsaKeys()

CleanRsaKeys ...

func Contains

func Contains(obj interface{}, target interface{}) bool

Contains check whether obj exist in target, the type of target can be an array, slice or map

func CreateDirIfNotExist

func CreateDirIfNotExist(dir string)

CreateDirIfNotExist create dir

func DropHosts

func DropHosts()

DropHosts ...

func DumpHosts

func DumpHosts(hostsMap map[string]string) bool

DumpHosts DumpToHosts

func ExtractErrorMessage

func ExtractErrorMessage(msg string) string

ExtractErrorMessage extract error from log

func ExtractNetMaskFromCidr

func ExtractNetMaskFromCidr(cidr string) string

ExtractNetMaskFromCidr extract net mask length (e.g. 16) from cidr (e.g. 1.2.3.4/16)

func FindBrokenPort

func FindBrokenPort(exposePorts string) string

FindBrokenPort Check if all ports has process listening to Return empty string if all ports are listened, otherwise return the first broken port

func FixFileOwner

func FixFileOwner(path string)

FixFileOwner set owner to original user when run with sudo

func GetDaemonRunning

func GetDaemonRunning(componentName string) int

GetDaemonRunning fetch daemon pid if exist

func GetLocalDomains

func GetLocalDomains() string

func GetLocalUserName

func GetLocalUserName() string

GetLocalUserName get current username

func GetOutboundIP

func GetOutboundIP() (address string)

GetOutboundIP Get preferred outbound ip of this machine

func GetRandomSSHPort

func GetRandomSSHPort() int

GetRandomSSHPort get pod random ssh port

func GetTimestamp

func GetTimestamp() string

GetTimestamp get current time stamp

func IsCmd

func IsCmd() bool

IsCmd check running in windows cmd shell

func IsLinux

func IsLinux() bool

IsLinux check runtime is windows

func IsPidFileExist

func IsPidFileExist() bool

IsPidFileExist check pid file is exist or not

func IsProcessExist

func IsProcessExist(pid int) bool

IsProcessExist check whether specified process still running

func IsWindows

func IsWindows() bool

IsWindows check runtime is windows

func KubeConfig

func KubeConfig() string

KubeConfig location of kube-config file

func MapContains

func MapContains(subset, fullset map[string]string) bool

func MapEquals

func MapEquals(src, target map[string]string) bool

func MapPut

func MapPut(m map[string]string, k, v string)

func MergeMap

func MergeMap(m1 map[string]string, m2 map[string]string) map[string]string

func ParsePortMapping

func ParsePortMapping(exposePort string) (int, int, error)

ParsePortMapping parse <port> or <localPort>:<removePort> parameter

func PrivateKeyPath

func PrivateKeyPath(name string) string

PrivateKeyPath ...

func RandomPort

func RandomPort() int

RandomPort Generate random number [1024, 65535)

func RandomSeconds

func RandomSeconds(min, max int) time.Duration

RandomSeconds Generate random duration number in second

func RandomString

func RandomString(n int) string

RandomString Generate random string

func RemoveColor

func RemoveColor(msg string) string

RemoveColor remove shell color character in text

func RunAndWait

func RunAndWait(cmd *exec.Cmd, isDebug bool) error

RunAndWait run cmd

func SetupConfigMapHeartBeat

func SetupConfigMapHeartBeat(ctx context.Context, client coreV1.ConfigMapInterface, name string)

SetupConfigMapHeartBeat setup heartbeat watcher for config map

func SetupPodHeartBeat

func SetupPodHeartBeat(ctx context.Context, client coreV1.PodInterface, name string)

SetupPodHeartBeat setup heartbeat watcher for deployment

func SetupPortForwardHeartBeat

func SetupPortForwardHeartBeat(port int)

SetupPortForwardHeartBeat setup heartbeat watcher for port forward

func SetupServiceHeartBeat

func SetupServiceHeartBeat(ctx context.Context, client coreV1.ServiceInterface, name string)

SetupServiceHeartBeat setup heartbeat watcher for service

func String2Map

func String2Map(str string) map[string]string

String2Map Convert parameter string to real map "k1=v1,k2=v2" -> {"k1":"v1","k2","v2"}

func WaitPortBeReady

func WaitPortBeReady(waitTime, port int) bool

WaitPortBeReady return true when port is ready It waits at most waitTime seconds, then return false.

func WritePidFile

func WritePidFile(componentName string) error

WritePidFile write pid to file

func WritePrivateKey

func WritePrivateKey(privateKeyPath string, data []byte) error

WritePrivateKey write ssh private key to privateKeyPath

Types

type CMDContext

type CMDContext struct {
	Ctx     context.Context
	Cmd     *exec.Cmd
	Name    string
	IsDebug bool
	Stop    chan struct{} // notify parent current Cmd occur error
}

CMDContext context of cmd

type SSHCredential

type SSHCredential struct {
	RemoteHost     string
	Port           string
	PrivateKeyPath string
}

SSHCredential ssh info

func NewDefaultSSHCredential

func NewDefaultSSHCredential() *SSHCredential

NewDefaultSSHCredential ...

type SSHGenerator

type SSHGenerator struct {
	PrivateKey, PublicKey []byte
	PrivateKeyPath        string
}

SSHGenerator ssh key pair generator

func Generate

func Generate(privateKeyPath string) (*SSHGenerator, error)

Generate generate SSHGenerator

func NewSSHGenerator

func NewSSHGenerator(privateKey string, publicKey string, privateKeyPath string) *SSHGenerator

NewSSHGenerator create ssh generator