kverify

Documentation

Overview

Package kverify verifies a running Kubernetes cluster is healthy

Package kverify verifies a running Kubernetes cluster is healthy

Package kverify verifies a running Kubernetes cluster is healthy

Package kverify verifies a running Kubernetes cluster is healthy

Package kverify verifies a running Kubernetes cluster is healthy

Package kverify verifies a running Kubernetes cluster is healthy

Index

• Constants
• Variables
• func APIServerStatus(cr command.Runner, hostname string, port int) (state.State, error)
• func APIServerVersionMatch(client *kubernetes.Clientset, expected string) error
• func ExpectAppsRunning(cs *kubernetes.Clientset, expected []string) error
• func KubeletStatus(cr command.Runner) state.State
• func NodePressure(cs *kubernetes.Clientset) error
• func ShouldWait(wcs map[string]bool) bool
• func WaitForAPIServerProcess(r cruntime.Manager, bs bootstrapper.Bootstrapper, cfg config.ClusterConfig, ...) error
• func WaitForAppsRunning(cs *kubernetes.Clientset, expected []string, timeout time.Duration) error
• func WaitForDefaultSA(cs *kubernetes.Clientset, timeout time.Duration) error
• func WaitForHealthyAPIServer(r cruntime.Manager, bs bootstrapper.Bootstrapper, cfg config.ClusterConfig, ...) error
• func WaitForNodeReady(cs *kubernetes.Clientset, timeout time.Duration) error
• func WaitForSystemPods(r cruntime.Manager, bs bootstrapper.Bootstrapper, cfg config.ClusterConfig, ...) error
• type ErrDiskPressure
  • func (e *ErrDiskPressure) Error() string
• type ErrMemoryPressure
  • func (e *ErrMemoryPressure) Error() string
• type ErrNetworkNotReady
  • func (e *ErrNetworkNotReady) Error() string
• type ErrPIDPressure
  • func (e *ErrPIDPressure) Error() string
• type NodeCondition
  • func (pc *NodeCondition) DiskPressure() bool
  • func (pc *NodeCondition) MemoryPressure() bool
  • func (pc *NodeCondition) NetworkUnavailable() bool
  • func (pc *NodeCondition) PIDPressure() bool

Constants

const (
	// APIServerWaitKey is the name used in the flags for k8s api server
	APIServerWaitKey = "apiserver"
	// SystemPodsWaitKey is the name used in the flags for pods in the kube system
	SystemPodsWaitKey = "system_pods"
	// DefaultSAWaitKey is the name used in the flags for default service account
	DefaultSAWaitKey = "default_sa"
	// AppsRunningKey is the name used in the flags for waiting for k8s-apps to be running
	AppsRunningKey = "apps_running"
	// NodeReadyKey is the name used in the flags for waiting for the node status to be ready
	NodeReadyKey = "node_ready"
)

Variables

var (
	// DefaultComponents is map of the the default components to wait for
	DefaultComponents = map[string]bool{APIServerWaitKey: true, SystemPodsWaitKey: true}
	// NoWaitComponents is map of componets to wait for if specified 'none' or 'false'
	NoComponents = map[string]bool{APIServerWaitKey: false, SystemPodsWaitKey: false, DefaultSAWaitKey: false, AppsRunningKey: false, NodeReadyKey: false}
	// AllComponents is map for waiting for all components.
	AllComponents = map[string]bool{APIServerWaitKey: true, SystemPodsWaitKey: true, DefaultSAWaitKey: true, AppsRunningKey: true}
	// DefaultWaitList is list of all default components to wait for. only names to be used for start flags.
	DefaultWaitList = []string{APIServerWaitKey, SystemPodsWaitKey}
	// AllComponentsList list of all valid components keys to wait for. only names to be used used for start flags.
	AllComponentsList = []string{APIServerWaitKey, SystemPodsWaitKey, DefaultSAWaitKey, AppsRunningKey, NodeReadyKey}
	// AppsRunningList running list are valid k8s-app components to wait for them to be running
	AppsRunningList = []string{
		"kube-dns",
		"etcd",
		"kube-apiserver",
		"kube-controller-manager",
		"kube-proxy",
		"kube-scheduler",
	}
)

vars related to the --wait flag

Functions

func APIServerStatus

func APIServerStatus(cr command.Runner, hostname string, port int) (state.State, error)

APIServerStatus returns apiserver status in libmachine style state.State

func APIServerVersionMatch

func APIServerVersionMatch(client *kubernetes.Clientset, expected string) error

APIServerVersionMatch checks if the server version matches the expected

func ExpectAppsRunning

func ExpectAppsRunning(cs *kubernetes.Clientset, expected []string) error

ExpectAppsRunning returns whether or not all expected k8s-apps are running. (without waiting for them)

func KubeletStatus

func KubeletStatus(cr command.Runner) state.State

KubeletStatus checks the kubelet status

func NodePressure

func NodePressure(cs *kubernetes.Clientset) error

NodePressure verfies that node is not under disk, memory, pid or network pressure.

func ShouldWait

func ShouldWait(wcs map[string]bool) bool

ShouldWait will return true if the config says need to wait

func WaitForAPIServerProcess

func WaitForAPIServerProcess(r cruntime.Manager, bs bootstrapper.Bootstrapper, cfg config.ClusterConfig, cr command.Runner, start time.Time, timeout time.Duration) error

WaitForAPIServerProcess waits for api server to be healthy returns error if it doesn't

func WaitForAppsRunning

func WaitForAppsRunning(cs *kubernetes.Clientset, expected []string, timeout time.Duration) error

WaitForAppsRunning waits for expected Apps To be running

func WaitForDefaultSA

func WaitForDefaultSA(cs *kubernetes.Clientset, timeout time.Duration) error

WaitForDefaultSA waits for the default service account to be created.

func WaitForHealthyAPIServer

func WaitForHealthyAPIServer(r cruntime.Manager, bs bootstrapper.Bootstrapper, cfg config.ClusterConfig, cr command.Runner, client *kubernetes.Clientset, start time.Time, hostname string, port int, timeout time.Duration) error

WaitForHealthyAPIServer waits for api server status to be running

func WaitForNodeReady

func WaitForNodeReady(cs *kubernetes.Clientset, timeout time.Duration) error

WaitForNodeReady waits till kube client reports node status as "ready"

func WaitForSystemPods

func WaitForSystemPods(r cruntime.Manager, bs bootstrapper.Bootstrapper, cfg config.ClusterConfig, cr command.Runner, client *kubernetes.Clientset, start time.Time, timeout time.Duration) error

WaitForSystemPods verifies essential pods for running kurnetes is running

Types

type ErrDiskPressure

type ErrDiskPressure struct {
	NodeCondition
}

ErrDiskPressure is thrown when there is node disk pressure condition

func (*ErrDiskPressure) Error

func (e *ErrDiskPressure) Error() string

type ErrMemoryPressure

type ErrMemoryPressure struct {
	NodeCondition
}

ErrMemoryPressure is thrown when there is node memory pressure condition

func (*ErrMemoryPressure) Error

func (e *ErrMemoryPressure) Error() string

type ErrNetworkNotReady

type ErrNetworkNotReady struct {
	NodeCondition
}

ErrNetworkNotReady is thrown when there is node condition is network not ready

func (*ErrNetworkNotReady) Error

func (e *ErrNetworkNotReady) Error() string

type ErrPIDPressure

type ErrPIDPressure struct {
	NodeCondition
}

ErrPIDPressure is thrown when there is node PID pressure condition

func (*ErrPIDPressure) Error

func (e *ErrPIDPressure) Error() string

type NodeCondition

type NodeCondition struct {
	Type    v1.NodeConditionType
	Status  v1.ConditionStatus
	Reason  string
	Message string
}

NodeCondition represents a favorable or unfavorable node condition.

func (*NodeCondition) DiskPressure

func (pc *NodeCondition) DiskPressure() bool

DiskPressure detects if the condition is disk pressure

func (*NodeCondition) MemoryPressure

func (pc *NodeCondition) MemoryPressure() bool

MemoryPressure detects if the condition is memory pressure

func (*NodeCondition) NetworkUnavailable

func (pc *NodeCondition) NetworkUnavailable() bool

NetworkUnavailable detects if the condition is PID pressure

func (*NodeCondition) PIDPressure

func (pc *NodeCondition) PIDPressure() bool

PIDPressure detects if the condition is PID pressure