diagnostics

Documentation

Overview

Package diagnostics provides Talos diagnostics specific checks.

Index

• func AddressOverlapCheck(ctx context.Context, r controller.Reader, logger *zap.Logger) (*runtime.DiagnosticSpec, error)
• func KubeletCSRNotApprovedCheck(ctx context.Context, r controller.Reader, logger *zap.Logger) (*runtime.DiagnosticSpec, error)
• type Check
• type CheckDescription
  • func Checks() []CheckDescription

Functions

func AddressOverlapCheck

func AddressOverlapCheck(ctx context.Context, r controller.Reader, logger *zap.Logger) (*runtime.DiagnosticSpec, error)

AddressOverlapCheck checks for overlapping host and Kubernetes pod/service CIDR addresses.

func KubeletCSRNotApprovedCheck

func KubeletCSRNotApprovedCheck(ctx context.Context, r controller.Reader, logger *zap.Logger) (*runtime.DiagnosticSpec, error)

KubeletCSRNotApprovedCheck checks for kubelet server certificate rotation and no CSR approvers.

Types

type Check

type Check func(ctx context.Context, r controller.Reader, logger *zap.Logger) (*runtime.DiagnosticSpec, error)

Check defines a function that checks for a specific issue.

If the check produces a warning, it should return a non-nil warning and nil error. If the check produces an error, the error will be logged, and other checks will proceed running.

type CheckDescription

type CheckDescription struct {
	// Semantic ID is used to identify the check and help message.
	ID string

	// Hysteresis time to wait before announcing the warning after the first appearance.
	Hysteresis time.Duration

	// Check function to run.
	Check Check
}

CheckDescription combines a check with a semantic ID.

func Checks

func Checks() []CheckDescription

Checks returns a list of checks to be run by the diagnostics engine.