probe

Documentation

Overview

Package probe contains utilities for health probing, as well as health status information.

Index

• func ProbeDialer() *net.Dialer
• func ResolveContainerPort(param intstr.IntOrString, container *v1.Container) (int, error)
• type Result

Functions

func ProbeDialer

func ProbeDialer() *net.Dialer

ProbeDialer returns a dialer optimized for probes to avoid lingering sockets on TIME-WAIT state. The dialer reduces the TIME-WAIT period to 1 seconds instead of the OS default of 60 seconds. Using 1 second instead of 0 because SO_LINGER socket option to 0 causes pending data to be discarded and the connection to be aborted with an RST rather than for the pending data to be transmitted and the connection closed cleanly with a FIN. Ref: https://issues.k8s.io/89898

func ResolveContainerPort

func ResolveContainerPort(param intstr.IntOrString, container *v1.Container) (int, error)

Types

type Result

type Result string

Result is a string used to handle the results for probing container readiness/liveness

const (
	// Success Result
	Success Result = "success"
	// Warning Result. Logically success, but with additional debugging information attached.
	Warning Result = "warning"
	// Failure Result
	Failure Result = "failure"
	// Unknown Result
	Unknown Result = "unknown"
)