heartbeat

Documentation

Index

• Constants
• Variables
• func Add(mgr manager.Manager, args AddArgs) error
• func AddToManager(_ context.Context, mgr manager.Manager) error
• func NewReconciler(mgr manager.Manager, extensionName string, namespace string, ...) reconcile.Reconciler
• type AddArgs
• type AddOptions

Constants

const ControllerName = "heartbeat"

ControllerName is the name of the controller.

Variables

var DefaultAddOptions = AddOptions{
	RenewIntervalSeconds: 30,
}

DefaultAddOptions are the default AddOptions for AddToManager.

Functions

func Add

func Add(mgr manager.Manager, args AddArgs) error

Add creates a new heartbeat controller and adds it to the given manager.

func AddToManager

func AddToManager(_ context.Context, mgr manager.Manager) error

AddToManager adds the heartbeat controller with the default Options to the manager.

func NewReconciler

func NewReconciler(mgr manager.Manager, extensionName string, namespace string, renewIntervalSeconds int32, clock clock.Clock) reconcile.Reconciler

NewReconciler creates a new reconciler that will renew the heartbeat lease resource.

Types

type AddArgs

type AddArgs struct {
	// ControllerOptions are the controller.Options.
	ControllerOptions controller.Options
	// ExtensionName is the name of the extension controller.
	ExtensionName string
	// Namespace is the namespace which will be used for the heartbeat lease resource.
	Namespace string
	// RenewIntervalSeconds defines how often the heartbeat lease is renewed.
	RenewIntervalSeconds int32
	// Clock is the clock to use when renewing the heartbeat lease resource.
	Clock clock.Clock
}

AddArgs are arguments for adding a heartbeat controller to a manager.

type AddOptions

type AddOptions struct {
	// ExtensionName is the name of the extension that this heartbeat controller is part of.
	ExtensionName string
	// Namespace is the namespace which will be used for the heartbeat lease resource.
	Namespace string
	// RenewIntervalSeconds defines how often the heartbeat lease is renewed.
	RenewIntervalSeconds int32
}

AddOptions are options to apply when adding the heartbeat controller to the manager.