servicecheck

Documentation

Overview

Package servicecheck implements the checks the kubenurse performs.

Index

• Constants
• type Check
• type Checker
  • func New(cl client.Client, promRegistry *prometheus.Registry, allowUnschedulable bool, ...) (*Checker, error)
  • func (c *Checker) APIServerDNS(ctx context.Context) string
  • func (c *Checker) APIServerDirect(ctx context.Context) string
  • func (c *Checker) MeIngress(ctx context.Context) string
  • func (c *Checker) MeService(ctx context.Context) string
  • func (c *Checker) Run(ctx context.Context)
• type Neighbour
• type RoundTripperFunc
  • func (rt RoundTripperFunc) RoundTrip(r *http.Request) (*http.Response, error)
• type Uint64Heap
  • func (h Uint64Heap) Len() int
  • func (h Uint64Heap) Less(i, j int) bool
  • func (h *Uint64Heap) Pop() any
  • func (h *Uint64Heap) Push(x any)
  • func (h Uint64Heap) Swap(i, j int)

Constants

const (
	NeighbourhoodState = "neighbourhood_state"
	Neighbourhood      = "neighbourhood"

	APIServerDirect = "api_server_direct"
	APIServerDNS    = "api_server_dns"
)

const (
	//nolint:gosec // This is the well-known path to Kubernetes serviceaccount tokens.
	K8sTokenFile = "/var/run/secrets/kubernetes.io/serviceaccount/token"
)

const (
	MetricsNamespace = "kubenurse"
)

const (
	NeighbourOriginHeader = "KUBENURSE-NEIGHBOUR-ORIGIN"
)

Types

type Check

type Check func(ctx context.Context) string

Check is the signature used by all checks that the checker can execute.

type Checker

type Checker struct {
	// Ingress and service config
	KubenurseIngressURL string
	KubenurseServiceURL string
	SkipCheckMeIngress  bool
	SkipCheckMeService  bool

	// shutdownDuration defines the time during which kubenurse will accept https requests during shutdown
	ShutdownDuration time.Duration

	// Kubernetes API
	KubernetesServiceDNS     string
	KubernetesServiceHost    string
	KubernetesServicePort    string
	SkipCheckAPIServerDirect bool
	SkipCheckAPIServerDNS    bool

	// Neighbourhood
	KubenurseNamespace string
	NeighbourFilter    string
	NeighbourLimit     int

	SkipCheckNeighbourhood bool

	// Additional endpoints
	ExtraChecks map[string]string

	// TLS
	UseTLS bool

	// LastCheckResult represents a cached check result
	LastCheckResult map[string]any
	// contains filtered or unexported fields
}

Checker implements the kubenurse checker

func New

func New(cl client.Client, promRegistry *prometheus.Registry,
	allowUnschedulable bool, cacheTTL time.Duration, durationHistogramBuckets []float64) (*Checker, error)

New configures the checker with a httpClient and a cache timeout for check results. Other parameters of the Checker struct need to be configured separately.

func (*Checker) APIServerDNS

func (c *Checker) APIServerDNS(ctx context.Context) string

APIServerDNS checks the /version endpoint of the Kubernetes API Server through the Cluster DNS URL

func (*Checker) APIServerDirect

func (c *Checker) APIServerDirect(ctx context.Context) string

APIServerDirect checks the /version endpoint of the Kubernetes API Server through the direct link

func (*Checker) MeIngress

func (c *Checker) MeIngress(ctx context.Context) string

MeIngress checks if the kubenurse is reachable at the /alwayshappy endpoint behind the ingress

func (*Checker) MeService

func (c *Checker) MeService(ctx context.Context) string

MeService checks if the kubenurse is reachable at the /alwayshappy endpoint through the kubernetes service

func (*Checker) Run

func (c *Checker) Run(ctx context.Context)

Run runs all servicechecks and returns the result togeter with a boolean which indicates success. The cache is respected.

type Neighbour

type Neighbour struct {
	PodName  string
	PodIP    string
	HostIP   string
	NodeName string
	NodeHash uint64
}

Neighbour represents a kubenurse which should be reachable

type RoundTripperFunc

type RoundTripperFunc func(req *http.Request) (*http.Response, error)

// http.RoundTripper

func (RoundTripperFunc) RoundTrip

func (rt RoundTripperFunc) RoundTrip(r *http.Request) (*http.Response, error)

type Uint64Heap

type Uint64Heap []uint64

func (Uint64Heap) Len

func (h Uint64Heap) Len() int

func (Uint64Heap) Less

func (h Uint64Heap) Less(i, j int) bool

func (*Uint64Heap) Pop

func (h *Uint64Heap) Pop() any

func (*Uint64Heap) Push

func (h *Uint64Heap) Push(x any)

func (Uint64Heap) Swap

func (h Uint64Heap) Swap(i, j int)