caasunitterminationworker

Documentation

Index

• Constants
• func Manifold(config ManifoldConfig) dependency.Manifold
• func NewWorker(config Config) worker.Worker
• type Config
• type ManifoldConfig
  • func (config *ManifoldConfig) Validate() error
• type State
• type UnitTerminator

Constants

const TerminationSignal = syscall.SIGTERM

TerminationSignal is SIGTERM which is sent by most container runtimes when a container should terminate gracefully.

Functions

func Manifold

func Manifold(config ManifoldConfig) dependency.Manifold

Manifold returns a manifold whose worker returns ErrTerminateAgent if a termination signal is received by the process it's running in.

func NewWorker

func NewWorker(config Config) worker.Worker

NewWorker returns a worker that waits for a TerminationSignal signal, and then exits with worker.ErrTerminateAgent.

Types

type Config

type Config struct {
	Agent          agent.Agent
	State          State
	UnitTerminator UnitTerminator
	Logger         logger.Logger
	Clock          clock.Clock
}

type ManifoldConfig

type ManifoldConfig struct {
	AgentName     string
	APICallerName string
	UniterName    string
	Clock         clock.Clock
	Logger        logger.Logger
}

ManifoldConfig defines the names of the manifolds on which a Manifold will depend.

func (*ManifoldConfig) Validate

func (config *ManifoldConfig) Validate() error

Validate ensures all the required values for the config are set.

type State

type State interface {
	UnitTerminating(ctx context.Context, tag names.UnitTag) (caasapplication.UnitTermination, error)
}

type UnitTerminator

type UnitTerminator interface {
	Terminate() error
}