controller

Documentation

Index

• type Debuggable
• type HealthCheckable
• type Interface

Types

type Debuggable

type Debuggable interface {
	// DebuggingHandler returns a Handler that expose debugging information
	// for the controller, or nil if a debugging handler is not desired.
	//
	// The handler will be accessible at "/debug/controllers/{controllerName}/".
	DebuggingHandler() http.Handler
}

Debuggable defines a controller that allows the controller manager to expose a debugging handler for the controller

If a controller implements Debuggable, and the returned handler is not nil, the controller manager can mount the handler during startup.

type HealthCheckable

type HealthCheckable interface {
	// HealthChecker returns a UnnamedHealthChecker that the controller manager
	// can choose to mount on the /healthz endpoint, or nil if no custom
	// health check is desired.
	HealthChecker() healthz.UnnamedHealthChecker
}

HealthCheckable defines a controller that allows the controller manager to include it in the health checks.

If a controller implements HealthCheckable, and the returned check is not nil, the controller manager can expose the check to the /healthz endpoint.

type Interface

type Interface interface {
	// Name returns the canonical name of the controller.
	Name() string
}

Interface defines the base of a controller managed by a controller manager