shutdownmanager

Documentation

Index

• Constants
• type Manager
  • func (mgr *Manager) Start(ctx context.Context) error

Constants

const (
	ShutdownEndpoint string = "/shutdown"
	DrainEndpoint    string = "/drain"
	HealthEndpoint   string = "/healthz"
)

Types

type Manager

type Manager struct {
	// HTTPServePort defines what port the shutdown-manager listens on
	HTTPServePort int
	// ShutdownReadyFile is the default file path used in the /shutdown endpoint
	ShutdownReadyFile string
	// ShutdownReadyCheckInterval is the polling interval for the file used in the /shutdown endpoint
	ShutdownReadyCheckInterval time.Duration
	// CheckDrainInterval defines time delay between polling Envoy for open connections
	CheckDrainInterval time.Duration
	// CheckDrainDelay defines time to wait before polling Envoy for open connections
	CheckDrainDelay time.Duration
	// StartDrainDelay defines time to wait before draining Envoy connections
	StartDrainDelay time.Duration
	// EnvoyAdminAddress specifies envoy's admin url
	EnvoyAdminAddress string
	// MinOpenConnections is the number of open connections allowed before performing envoy shutdown
	MinOpenConnections int
}

Manager holds configuration to run the shutdown manager

func (*Manager) Start

func (mgr *Manager) Start(ctx context.Context) error

Starts the shutdown manager