util

Documentation

Index

• Constants
• func CloneMap(src map[string]interface{}) map[string]interface{}
• func CopyMap(src, dest map[string]interface{})
• func CreateSelectorsString(namespace, labelSelector, fieldSelector string) string
• func GetBool(dict map[string]interface{}, key string) (bool, error)
• func GetBoolOrDefault(dict map[string]interface{}, key string, defaultValue bool) (bool, error)
• func GetDuration(dict map[string]interface{}, key string) (time.Duration, error)
• func GetDurationOrDefault(dict map[string]interface{}, key string, defaultValue time.Duration) (time.Duration, error)
• func GetFloat64(dict map[string]interface{}, key string) (float64, error)
• func GetFloat64OrDefault(dict map[string]interface{}, key string, defaultValue float64) (float64, error)
• func GetInt(dict map[string]interface{}, key string) (int, error)
• func GetIntOrDefault(dict map[string]interface{}, key string, defaultValue int) (int, error)
• func GetLabelSelector(dict map[string]interface{}, key string) (*labels.Selector, error)
• func GetMap(dict map[string]interface{}, key string) (map[string]interface{}, error)
• func GetMapArray(dict map[string]interface{}, key string) ([]map[string]interface{}, error)
• func GetMasterIPs(c clientset.Interface, addressType corev1.NodeAddressType) ([]string, error)
• func GetMasterName(c clientset.Interface) (string, error)
• func GetSchedulableUntainedNodes(c clientset.Interface) ([]corev1.Node, error)
• func GetSchedulableUntainedNodesNumber(c clientset.Interface) (int, error)
• func GetSigner(provider string) (ssh.Signer, error)
• func GetString(dict map[string]interface{}, key string) (string, error)
• func GetStringArray(dict map[string]interface{}, key string) ([]string, error)
• func GetStringOrDefault(dict map[string]interface{}, key string, defaultValue string) (string, error)
• func IsControlPlaneNode(node *corev1.Node) bool
• func IsErrKeyNotFound(err error) bool
• func IsNodeSchedulableAndUntainted(node *corev1.Node) bool
• func IssueSSHCommand(ctx context.Context, cmd, provider string, node *v1.Node) error
• func LegacyIsMasterNode(node *corev1.Node) bool
• func LogClusterNodes(c clientset.Interface) error
• func LogResult(result Result)
• func NodeSSHHosts(ctx context.Context, c clientset.Interface) ([]string, error)
• func PrettyPrintJSON(data interface{}) (string, error)
• func RandomDNS1123String(length int) string
• func ToStruct(dict map[string]interface{}, out interface{}) error
• type ErrKeyNotFound
  • func (e *ErrKeyNotFound) Error() string
• type GCloudSSHExecutor
  • func (e *GCloudSSHExecutor) Exec(command string, node *v1.Node, stdin io.Reader) error
• type ObjectSelector
  • func NewObjectSelector() *ObjectSelector
  • func (o *ObjectSelector) ApplySelectors(options *metav1.ListOptions)
  • func (o *ObjectSelector) Parse(params map[string]interface{}) error
  • func (o *ObjectSelector) String() string
• type Result
  • func IssueSSHCommandWithResult(ctx context.Context, cmd, provider string, node *v1.Node) (*Result, error)
  • func SSH(ctx context.Context, cmd, host, provider string) (Result, error)
• type SSHExecutor

Constants

const (
	// SSHPort is tcp port number of SSH
	SSHPort = "22"
)

Functions

func CloneMap

func CloneMap(src map[string]interface{}) map[string]interface{}

CloneMap returns clone of the provided map.

func CopyMap

func CopyMap(src, dest map[string]interface{})

CopyMap copies values from one map to the other.

func CreateSelectorsString

func CreateSelectorsString(namespace, labelSelector, fieldSelector string) string

CreateSelectorsString creates a string representation for given namespace, label selector and field selector.

func GetBool

func GetBool(dict map[string]interface{}, key string) (bool, error)

GetBool tries to return value from map cast to bool type. If value doesn't exist, error is returned.

func GetBoolOrDefault

func GetBoolOrDefault(dict map[string]interface{}, key string, defaultValue bool) (bool, error)

GetBoolOrDefault tries to return value from map cast to bool type. If value doesn't exist default value is used.

func GetDuration

func GetDuration(dict map[string]interface{}, key string) (time.Duration, error)

GetDuration tries to return value from map cast to duration type. If value doesn't exist, error is returned.

func GetDurationOrDefault

func GetDurationOrDefault(dict map[string]interface{}, key string, defaultValue time.Duration) (time.Duration, error)

GetDurationOrDefault tries to return value from map cast to duration type. If value doesn't exist default value is used.

func GetFloat64

func GetFloat64(dict map[string]interface{}, key string) (float64, error)

GetFloat64 tries to return value from map cast to float64 type. If value doesn't exist, error is returned.

func GetFloat64OrDefault

func GetFloat64OrDefault(dict map[string]interface{}, key string, defaultValue float64) (float64, error)

GetFloat64OrDefault tries to return value from map cast to float64 type. If value doesn't exist default value is used.

func GetInt

func GetInt(dict map[string]interface{}, key string) (int, error)

GetInt tries to return value from map cast to int type. If value doesn't exist, error is returned.

func GetIntOrDefault

func GetIntOrDefault(dict map[string]interface{}, key string, defaultValue int) (int, error)

GetIntOrDefault tries to return value from map cast to int type. If value doesn't exist default value is used.

func GetLabelSelector

func GetLabelSelector(dict map[string]interface{}, key string) (*labels.Selector, error)

GetLabelSelector tries to return value from map parsed as labels.Selector type. If value doesn't exist, error is returned.

func GetMap

func GetMap(dict map[string]interface{}, key string) (map[string]interface{}, error)

GetMap tries to return value from map of type map. If value doesn't exist, error is returned.

func GetMapArray

func GetMapArray(dict map[string]interface{}, key string) ([]map[string]interface{}, error)

GetMapArray tries to return value from map of type []map. If value doesn't exist, error is returned.

func GetMasterIPs

func GetMasterIPs(c clientset.Interface, addressType corev1.NodeAddressType) ([]string, error)

GetMasterIPs returns master node ips of the given type.

func GetMasterName

func GetMasterName(c clientset.Interface) (string, error)

GetMasterName returns master node name.

func GetSchedulableUntainedNodes

func GetSchedulableUntainedNodes(c clientset.Interface) ([]corev1.Node, error)

GetSchedulableUntainedNodes returns nodes in the cluster.

func GetSchedulableUntainedNodesNumber

func GetSchedulableUntainedNodesNumber(c clientset.Interface) (int, error)

GetSchedulableUntainedNodesNumber returns number of nodes in the cluster.

func GetSigner

func GetSigner(provider string) (ssh.Signer, error)

GetSigner returns an ssh.Signer for the provider ("gce", etc.) that can be used to SSH to their nodes.

func GetString

func GetString(dict map[string]interface{}, key string) (string, error)

GetString tries to return value from map cast to string type. If value doesn't exist, error is returned.

func GetStringArray

func GetStringArray(dict map[string]interface{}, key string) ([]string, error)

GetStringArray tries to return value from map cast to a []string, using fmt.Sprintf for elements. If value doesn't exist, error is returned.

func GetStringOrDefault

func GetStringOrDefault(dict map[string]interface{}, key string, defaultValue string) (string, error)

GetStringOrDefault tries to return value from map cast to string type. If value doesn't exist default value is used.

func IsControlPlaneNode

func IsControlPlaneNode(node *corev1.Node) bool

func IsErrKeyNotFound

func IsErrKeyNotFound(err error) bool

IsErrKeyNotFound returns true only if error type is ErrKeyNotFound.

func IsNodeSchedulableAndUntainted

func IsNodeSchedulableAndUntainted(node *corev1.Node) bool

IsNodeSchedulableAndUntainted returns true whether node is schedulable and untainted.

func IssueSSHCommand

func IssueSSHCommand(ctx context.Context, cmd, provider string, node *v1.Node) error

IssueSSHCommand tries to execute a SSH command

func LegacyIsMasterNode

func LegacyIsMasterNode(node *corev1.Node) bool

LegacyIsMasterNode returns true if given node is a registered master according to the logic historically used for this function. This code path is deprecated and the node disruption exclusion label should be used in the future. This code will not be allowed to update to use the node-role label, since node-roles may not be used for feature enablement. DEPRECATED: this will be removed in Kubernetes 1.19

func LogClusterNodes

func LogClusterNodes(c clientset.Interface) error

LogClusterNodes prints nodes information (name, internal ip, external ip) to log.

func LogResult

func LogResult(result Result)

LogResult records result log

func NodeSSHHosts

func NodeSSHHosts(ctx context.Context, c clientset.Interface) ([]string, error)

NodeSSHHosts returns SSH-able host names for all schedulable nodes. If it can't find any external IPs, it falls back to looking for internal IPs. If it can't find an internal IP for every node it returns an error, though it still returns all hosts that it found in that case.

func PrettyPrintJSON

func PrettyPrintJSON(data interface{}) (string, error)

PrettyPrintJSON converts given data into formatted json.

func RandomDNS1123String

func RandomDNS1123String(length int) string

RandomDNS1123String generates random string of a given length.

func ToStruct

func ToStruct(dict map[string]interface{}, out interface{}) error

ToStruct converts map[string]interface{} to standard object (e.g. struct). It preserves fields that are not set in dict.

Types

type ErrKeyNotFound

type ErrKeyNotFound struct {
	// contains filtered or unexported fields
}

ErrKeyNotFound is returned when key doesn't exists in a map.

func (*ErrKeyNotFound) Error

func (e *ErrKeyNotFound) Error() string

Erros is an error interface implementation.

type GCloudSSHExecutor

type GCloudSSHExecutor struct{}

GCloudSSHExecutor runs commands in GCloud cluster nodes

func (*GCloudSSHExecutor) Exec

func (e *GCloudSSHExecutor) Exec(command string, node *v1.Node, stdin io.Reader) error

Exec executes command on a given node with stdin provided. If stdin is nil, the process reads from null device.

type ObjectSelector

type ObjectSelector struct {
	Namespace     string
	LabelSelector string
	FieldSelector string
}

ObjectSelector is an aggregation of namespace, labelSelector and fieldSelector.

func NewObjectSelector

func NewObjectSelector() *ObjectSelector

NewObjectSelector creates default object selector.

func (*ObjectSelector) ApplySelectors

func (o *ObjectSelector) ApplySelectors(options *metav1.ListOptions)

ApplySelectors sets label and field selectors in a given ListOptions object.

func (*ObjectSelector) Parse

func (o *ObjectSelector) Parse(params map[string]interface{}) error

Parse parses namespace, labelSelector and fieldSelector from params map.

func (*ObjectSelector) String

func (o *ObjectSelector) String() string

String returns string representation of the selector.

type Result

type Result struct {
	User   string
	Host   string
	Cmd    string
	Stdout string
	Stderr string
	Code   int
}

Result holds the execution result of SSH command

func IssueSSHCommandWithResult

func IssueSSHCommandWithResult(ctx context.Context, cmd, provider string, node *v1.Node) (*Result, error)

IssueSSHCommandWithResult tries to execute a SSH command and returns the execution result

func SSH

func SSH(ctx context.Context, cmd, host, provider string) (Result, error)

SSH synchronously SSHs to a node running on provider and runs cmd. If there is no error performing the SSH, the stdout, stderr, and exit code are returned.

type SSHExecutor

type SSHExecutor interface {
	Exec(command string, node *v1.Node, stdin io.Reader) error
}

SSHExecutor interface can run commands in cluster nodes via SSH