prober

Documentation

Index

• type FakeManager
  • func (_ FakeManager) AddPod(_ *api.Pod)
  • func (_ FakeManager) CleanupPods(_ []*api.Pod)
  • func (_ FakeManager) RemovePod(_ *api.Pod)
  • func (_ FakeManager) UpdatePodStatus(_ types.UID, podStatus *api.PodStatus)
• type FakeProber
  • func (f FakeProber) ProbeLiveness(_ *api.Pod, _ api.PodStatus, c api.Container, _ kubecontainer.ContainerID, ...) (probe.Result, error)
  • func (f FakeProber) ProbeReadiness(_ *api.Pod, _ api.PodStatus, c api.Container, _ kubecontainer.ContainerID) (probe.Result, error)
• type Manager
  • func NewManager(defaultProbePeriod time.Duration, statusManager status.Manager, prober Prober) Manager
• type Prober
  • func New(runner kubecontainer.ContainerCommandRunner, ...) Prober

Types

type FakeManager

type FakeManager struct{}

func (FakeManager) AddPod

func (_ FakeManager) AddPod(_ *api.Pod)

Unused methods.

func (FakeManager) CleanupPods

func (_ FakeManager) CleanupPods(_ []*api.Pod)

func (FakeManager) RemovePod

func (_ FakeManager) RemovePod(_ *api.Pod)

func (FakeManager) UpdatePodStatus

func (_ FakeManager) UpdatePodStatus(_ types.UID, podStatus *api.PodStatus)

type FakeProber

type FakeProber struct {
	Readiness probe.Result
	Liveness  probe.Result
	Error     error
}

func (FakeProber) ProbeLiveness

func (f FakeProber) ProbeLiveness(_ *api.Pod, _ api.PodStatus, c api.Container, _ kubecontainer.ContainerID, _ int64) (probe.Result, error)

func (FakeProber) ProbeReadiness

func (f FakeProber) ProbeReadiness(_ *api.Pod, _ api.PodStatus, c api.Container, _ kubecontainer.ContainerID) (probe.Result, error)

type Manager

type Manager interface {
	// AddPod creates new probe workers for every container probe. This should be called for every
	// pod created.
	AddPod(pod *api.Pod)

	// RemovePod handles cleaning up the removed pod state, including terminating probe workers and
	// deleting cached results.
	RemovePod(pod *api.Pod)

	// CleanupPods handles cleaning up pods which should no longer be running.
	// It takes a list of "active pods" which should not be cleaned up.
	CleanupPods(activePods []*api.Pod)

	// UpdatePodStatus modifies the given PodStatus with the appropriate Ready state for each
	// container based on container running status, cached probe results and worker states.
	UpdatePodStatus(types.UID, *api.PodStatus)
}

Manager manages pod probing. It creates a probe "worker" for every container that specifies a probe (AddPod). The worker periodically probes its assigned container and caches the results. The manager usse the cached probe results to set the appropriate Ready state in the PodStatus when requested (UpdatePodStatus). Updating probe parameters is not currently supported. TODO: Move liveness probing out of the runtime, to here.

func NewManager

func NewManager(
	defaultProbePeriod time.Duration,
	statusManager status.Manager,
	prober Prober) Manager

type Prober

type Prober interface {
	ProbeLiveness(pod *api.Pod, status api.PodStatus, container api.Container, containerID kubecontainer.ContainerID, createdAt int64) (probe.Result, error)
	ProbeReadiness(pod *api.Pod, status api.PodStatus, container api.Container, containerID kubecontainer.ContainerID) (probe.Result, error)
}

Prober checks the healthiness of a container.

func New

func New(
	runner kubecontainer.ContainerCommandRunner,
	refManager *kubecontainer.RefManager,
	recorder record.EventRecorder) Prober

NewProber creates a Prober, it takes a command runner and several container info managers.