agentkapp

Documentation

Index

• func NewCommand() *cobra.Command
• type CancelRunWhenLeaderFunc
• type LeaderElector
• type ModuleStartFunc
• type ModuleStopFunc
• type ModuleStopWaitFunc
• type Runner

Functions

func NewCommand

func NewCommand() *cobra.Command

Types

type CancelRunWhenLeaderFunc

type CancelRunWhenLeaderFunc func()

type LeaderElector

type LeaderElector interface {
	Run(ctx context.Context, onStartedLeading, onStoppedLeading func())
}

type ModuleStartFunc

type ModuleStartFunc func()

type ModuleStopFunc

type ModuleStopFunc func() ModuleStopWaitFunc

type ModuleStopWaitFunc

type ModuleStopWaitFunc func(context.Context) error

type Runner

type Runner interface {
	// RunWhenLeader registers the given start and stop functions for this module with the leader runner.
	// When the leader runner is elected as the leader it will execute the start function and
	// when the leader runner lost the leadership it will execute the stop function.
	// The start function must be able to be triggered multiple times (with intermediate stop executions)
	// without having to rely on a new agent configuration.
	// The function that is returned must be used to unregister the module
	// from the leader runner in case a shutdown is initiated or a previously registered start function
	// became invalid, for example because a new agent configuration turned out to be invalid.
	RunWhenLeader(ctx context.Context, startFn ModuleStartFunc, stopFunc ModuleStopFunc) (CancelRunWhenLeaderFunc, error)
}