node

Documentation

Index

• Constants
• func AreAllReady() bool
• func AreNNodesReady(nodeCount int) bool
• func DescribeNodes()
• func WaitOnReady(nodeCount int, sleep, timeout time.Duration) bool
• type Address
• type Condition
• type GetNodesResult
  • func GetByRegexAsync(regex string) GetNodesResult
  • func GetNodesAsync() GetNodesResult
• type Info
• type List
  • func Get() (*List, error)
  • func GetReady() (*List, error)
• type Metadata
• type Node
  • func GetByAnnotations(key, value string) ([]Node, error)
  • func GetByLabel(label string) ([]Node, error)
  • func GetByRegex(regex string) ([]Node, error)
  • func GetByRegexWithRetry(regex string, sleep, timeout time.Duration) ([]Node, error)
  • func GetByTaint(key, value, effect string) ([]Node, error)
  • func GetWithRetry(sleep, timeout time.Duration) ([]Node, error)
  • func (n *Node) Describe() error
  • func (n *Node) HasSubstring(substrings []string) bool
  • func (n *Node) IsLinux() bool
  • func (n *Node) IsReady() bool
  • func (n *Node) IsUbuntu() bool
  • func (n *Node) IsWindows() bool
  • func (n *Node) Version() string
• type Spec
• type Status
  • func (ns *Status) GetAddressByType(t string) *Address
• type Taint

Constants

const (
	//ServerVersion is used to parse out the version of the API running
	ServerVersion = `(Server Version:\s)+(.*)`
)

Functions

func AreAllReady

func AreAllReady() bool

AreAllReady returns if all nodes are ready

func AreNNodesReady

func AreNNodesReady(nodeCount int) bool

AreNNodesReady returns a bool depending on cluster state

func DescribeNodes

func DescribeNodes()

DescribeNodes describes all nodes

func WaitOnReady

func WaitOnReady(nodeCount int, sleep, timeout time.Duration) bool

WaitOnReady will block until all nodes are in ready state

Types

type Address

type Address struct {
	Address string `json:"address"`
	Type    string `json:"type"`
}

Address contains an address and a type

type Condition

type Condition struct {
	LastHeartbeatTime  time.Time `json:"lastHeartbeatTime"`
	LastTransitionTime time.Time `json:"lastTransitionTime"`
	Message            string    `json:"message"`
	Reason             string    `json:"reason"`
	Status             string    `json:"status"`
	Type               string    `json:"type"`
}

Condition contains various status information

type GetNodesResult

type GetNodesResult struct {
	Nodes []Node
	Err   error
}

GetNodesResult is the result type for GetAllByPrefixAsync

func GetByRegexAsync

func GetByRegexAsync(regex string) GetNodesResult

GetByRegexAsync wraps GetByRegex with a struct response for goroutine + channel usage

func GetNodesAsync

func GetNodesAsync() GetNodesResult

GetNodesAsync wraps Get with a struct response for goroutine + channel usage

type Info

type Info struct {
	ContainerRuntimeVersion string `json:"containerRuntimeVersion"`
	KubeProxyVersion        string `json:"kubeProxyVersion"`
	KubeletVersion          string `json:"kubeletVersion"`
	OperatingSystem         string `json:"operatingSystem"`
	OSImage                 string `json:"osImage"`
}

Info contains node information like what version the kubelet is running

type List

type List struct {
	Nodes []Node `json:"items"`
}

List is used to parse out Nodes from a list

func Get

func Get() (*List, error)

Get returns the current nodes for a given kubeconfig

func GetReady

func GetReady() (*List, error)

GetReady returns the current nodes for a given kubeconfig

type Metadata

type Metadata struct {
	Name        string            `json:"name"`
	CreatedAt   time.Time         `json:"creationTimestamp"`
	Labels      map[string]string `json:"labels"`
	Annotations map[string]string `json:"annotations"`
}

Metadata contains things like name and created at

type Node

type Node struct {
	Status   Status   `json:"status"`
	Metadata Metadata `json:"metadata"`
	Spec     Spec     `json:"spec"`
}

Node represents the kubernetes Node Resource

func GetByAnnotations

func GetByAnnotations(key, value string) ([]Node, error)

GetByAnnotations will return a []Node of all nodes that have a matching annotation

func GetByLabel

func GetByLabel(label string) ([]Node, error)

GetByLabel will return a []Node of all nodes that have a matching label

func GetByRegex

func GetByRegex(regex string) ([]Node, error)

GetByRegex will return a []Node of all nodes that have a name that match the regular expression

func GetByRegexWithRetry

func GetByRegexWithRetry(regex string, sleep, timeout time.Duration) ([]Node, error)

GetByRegexWithRetry gets nodes that match a regular expression, allowing for retries

func GetByTaint

func GetByTaint(key, value, effect string) ([]Node, error)

GetByTaint will return a []Node of all nodes that have a matching taint

func GetWithRetry

func GetWithRetry(sleep, timeout time.Duration) ([]Node, error)

GetWithRetry gets nodes, allowing for retries

func (*Node) Describe

func (n *Node) Describe() error

Describe will describe a node resource

func (*Node) HasSubstring

func (n *Node) HasSubstring(substrings []string) bool

HasSubstring determines if a node name matches includes the passed in substring

func (*Node) IsLinux

func (n *Node) IsLinux() bool

IsLinux checks for a Linux node

func (*Node) IsReady

func (n *Node) IsReady() bool

IsReady returns if the node is in a Ready state

func (*Node) IsUbuntu

func (n *Node) IsUbuntu() bool

IsUbuntu checks for an Ubuntu-backed node

func (*Node) IsWindows

func (n *Node) IsWindows() bool

IsWindows checks for a Windows node

func (*Node) Version

func (n *Node) Version() string

Version returns the version of the kubelet on the node

type Spec

type Spec struct {
	Taints []Taint `json:"taints"`
}

Spec contains things like taints

type Status

type Status struct {
	NodeInfo      Info        `json:"nodeInfo"`
	NodeAddresses []Address   `json:"addresses"`
	Conditions    []Condition `json:"conditions"`
}

Status parses information from the status key

func (*Status) GetAddressByType

func (ns *Status) GetAddressByType(t string) *Address

GetAddressByType will return the Address object for a given Kubernetes node

type Taint

type Taint struct {
	Effect string `json:"effect"`
	Key    string `json:"key"`
	Value  string `json:"value"`
}

Taint defines a Node Taint