util

Documentation

Index

• Variables
• func CleanRsaKeys()
• func Contains(obj interface{}, target interface{}) bool
• func CreateDirIfNotExist(dir string)
• func DropHosts()
• func DumpHosts(hostsMap map[string]string)
• func GetOutboundIP() (address string)
• func GetRandomSSHPort(podIP string) string
• func Interrupt() chan string
• func IsDaemonRunning(componentName string) bool
• func IsPidFileExist() bool
• func IsProcessExist(pid int) bool
• func IsWindows() bool
• func KubeConfig() string
• func PrivateKeyPath(component, identifier string) string
• func RandomString(n int) string
• func StopBackendProcess(stop string, cancel func())
• 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 SSHCredential
  • func NewDefaultSSHCredential() *SSHCredential
• type SSHGenerator
  • func Generate(privateKeyPath string) (*SSHGenerator, error)
  • func NewSSHGenerator(privateKey string, publicKey string, privateKeyPath string) *SSHGenerator

Variables

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

var UserHome = os.Getenv("HOME")

Functions

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 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)

DumpHosts DumpToHosts

func GetOutboundIP

func GetOutboundIP() (address string)

GetOutboundIP Get preferred outbound ip of this machine

func GetRandomSSHPort

func GetRandomSSHPort(podIP string) string

GetRandomSSHPort get pod random ssh port

func Interrupt

func Interrupt() chan string

Interrupt ...

func IsDaemonRunning

func IsDaemonRunning(componentName string) bool

IsDaemonRunning check daemon is running or not

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 PrivateKeyPath

func PrivateKeyPath(component, identifier string) string

PrivateKeyPath ...

func RandomString

func RandomString(n int) string

RandomString Generate RandomString

func StopBackendProcess

func StopBackendProcess(stop string, cancel func())

StopBackendProcess ...

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 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