probes

Documentation

Index

• type CMDProbeConfig
  • func (config CMDProbeConfig) Create() *core.Probe
  • func (config *CMDProbeConfig) SetSpec(spec *api.ServerGroupProbeSpec)
• type HTTPProbeConfig
  • func (config HTTPProbeConfig) Create() *core.Probe
  • func (config *HTTPProbeConfig) SetSpec(spec *api.ServerGroupProbeSpec)

Types

type CMDProbeConfig

type CMDProbeConfig struct {
	// Command to be executed
	Command []string
	// Number of seconds after the container has started before liveness probes are initiated (defaults to 30)
	InitialDelaySeconds int32
	// Number of seconds after which the probe times out (defaults to 2).
	TimeoutSeconds int32
	// How often (in seconds) to perform the probe (defaults to 10).
	PeriodSeconds int32
	// Minimum consecutive successes for the probe to be considered successful after having failed (defaults to 1).
	SuccessThreshold int32
	// Minimum consecutive failures for the probe to be considered failed after having succeeded (defaults to 3).
	FailureThreshold int32
}

func (CMDProbeConfig) Create

func (config CMDProbeConfig) Create() *core.Probe

Create creates a probe from given config

func (*CMDProbeConfig) SetSpec

func (config *CMDProbeConfig) SetSpec(spec *api.ServerGroupProbeSpec)

type HTTPProbeConfig

type HTTPProbeConfig struct {
	// Local path to GET
	LocalPath string // `e.g. /_api/version`
	// Secure connection?
	Secure bool
	// Value for an Authorization header (can be empty)
	Authorization string
	// PortName define port name used to connect to the server for probes
	PortName string
	// Number of seconds after the container has started before liveness probes are initiated (defaults to 30)
	InitialDelaySeconds int32
	// Number of seconds after which the probe times out (defaults to 2).
	TimeoutSeconds int32
	// How often (in seconds) to perform the probe (defaults to 10).
	PeriodSeconds int32
	// Minimum consecutive successes for the probe to be considered successful after having failed (defaults to 1).
	SuccessThreshold int32
	// Minimum consecutive failures for the probe to be considered failed after having succeeded (defaults to 3).
	FailureThreshold int32
}

HTTPProbeConfig contains settings for creating a liveness/readiness probe.

func (HTTPProbeConfig) Create

func (config HTTPProbeConfig) Create() *core.Probe

Create creates a probe from given config

func (*HTTPProbeConfig) SetSpec

func (config *HTTPProbeConfig) SetSpec(spec *api.ServerGroupProbeSpec)