healthcheck

Documentation

Overview

Package healthcheck contains an interface for assessing the health of resources configured in a CR.

Index

• type HealthCheck
  • func NewHealthCheck(parent HealthChecker, statusPoller *polling.StatusPoller) *HealthCheck
  • func (hc *HealthCheck) Assess(pollInterval time.Duration) error
• type HealthChecker

Types

type HealthCheck

type HealthCheck struct {
	// contains filtered or unexported fields
}

HealthCheck is able to assess whether the configured health checks for a CR are all ready.

func NewHealthCheck

func NewHealthCheck(parent HealthChecker, statusPoller *polling.StatusPoller) *HealthCheck

NewHealthCheck returns a new HealthCheck able to assess the given CR.

func (*HealthCheck) Assess

func (hc *HealthCheck) Assess(pollInterval time.Duration) error

Assess will check if the configured health checks are all ready. It will poll at the given pollInterval.

type HealthChecker

type HealthChecker interface {
	client.Object

	GetTimeout() time.Duration
	GetHealthChecks() []meta.NamespacedObjectKindReference
}