health

Documentation

Index

• Constants
• func AddToManager(mgr manager.Manager) error
• func AddToManagerWithOptions(mgr manager.Manager, conf ControllerConfig) error
• func CheckHealth(ctx context.Context, c client.Client, obj runtime.Object) (bool, error)
• type ControllerConfig
• type ControllerOptions
  • func (o *ControllerOptions) AddFlags(fs *pflag.FlagSet)
  • func (o *ControllerOptions) Complete() error
  • func (o *ControllerOptions) Completed() *ControllerConfig

Constants

const ControllerName = "health-controller"

ControllerName is the name of the health controller.

Functions

func AddToManager

func AddToManager(mgr manager.Manager) error

AddToManager adds the controller to a Manager using the default config.

func AddToManagerWithOptions

func AddToManagerWithOptions(mgr manager.Manager, conf ControllerConfig) error

AddToManagerWithOptions adds the controller to a Manager with the given config.

func CheckHealth

func CheckHealth(ctx context.Context, c client.Client, obj runtime.Object) (bool, error)

CheckHealth checks whether the given object is healthy. It returns a bool indicating whether the object was actually checked and an error if any health check failed.

Types

type ControllerConfig

type ControllerConfig struct {
	MaxConcurrentWorkers int
	SyncPeriod           time.Duration

	ClassFilter   managerpredicate.ClassFilter
	TargetCluster cluster.Cluster
}

ControllerConfig is the completed configuration for the controller.

type ControllerOptions

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

ControllerOptions are options for adding the controller to a Manager.

func (*ControllerOptions) AddFlags

func (o *ControllerOptions) AddFlags(fs *pflag.FlagSet)

AddFlags adds the needed command line flags to the given FlagSet.

func (*ControllerOptions) Complete

func (o *ControllerOptions) Complete() error

Complete completes the given command line flags and set the defaultControllerConfig accordingly.

func (*ControllerOptions) Completed

func (o *ControllerOptions) Completed() *ControllerConfig

Completed returns the completed ControllerConfig.