runnable

Documentation

Index

• type Graceful
  • func NewGraceful(run RunCall, stop StopCall, requireLeaderElection bool, wg *sync.WaitGroup, ...) *Graceful
  • func (g *Graceful) NeedLeaderElection() bool
  • func (g *Graceful) Start(ctx context.Context) error
• type RunCall
• type StopCall

Types

type Graceful

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

Graceful implements the Runnable interface and handles graceful shutdown of the component. This is useful for components that don't stop immediately.

func NewGraceful

func NewGraceful(run RunCall, stop StopCall, requireLeaderElection bool, wg *sync.WaitGroup, logger logr.Logger) *Graceful

NewGraceful creates a new graceful shutdown runnable. logger is optional. Pass nil for the default logger.

func (*Graceful) NeedLeaderElection

func (g *Graceful) NeedLeaderElection() bool

NeedLeaderElection implements the LeaderElectionRunnable interface, which helps the controller manager decide when to start the component.

func (*Graceful) Start

func (g *Graceful) Start(ctx context.Context) error

Start implements the Runnable interface which enables the component to be managed by the controller manager.

type RunCall

type RunCall func(context.Context) error

RunCall starts a component.

type StopCall

type StopCall func() error

StopCall stops a component.