controller

Documentation

Overview

Package controller provides a piped component that handles all of the not completed deployments by managing a pool of planners and schedulers. Whenever a new PENDING deployment is detected, controller spawns a new planner for deciding the deployment pipeline and update the deployment status to PLANNED. Whenever a new PLANNED deployment is detected, controller spawns a new scheduler for scheduling and running its pipeline executors.

Package controller provides a piped component that handles all of the not completed deployments by managing a pool of planners and schedulers. Whenever a new PENDING deployment is detected, controller spawns a new planner for deciding the deployment pipeline and update the deployment status to PLANNED. Whenever a new PLANNED deployment is detected, controller spawns a new scheduler for scheduling and running its pipeline executors.

Index

• func NewStopSignal() (StopSignal, StopSignalHandler)
• type DeploymentController
  • func NewController(apiClient apiClient, gitClient gitClient, deploymentLister deploymentLister, ...) DeploymentController
• type PluginRegistry
  • func DefaultPluginRegistry() PluginRegistry
• type StopSignal
• type StopSignalHandler
• type StopSignalType

Functions

func NewStopSignal

func NewStopSignal() (StopSignal, StopSignalHandler)

Types

type DeploymentController

type DeploymentController interface {
	Run(ctx context.Context) error
}

func NewController

func NewController(
	apiClient apiClient,
	gitClient gitClient,
	deploymentLister deploymentLister,
	commandLister commandLister,
	notifier notifier,
	gracePeriod time.Duration,
	logger *zap.Logger,
	tracerProvider trace.TracerProvider,
) DeploymentController

NewController creates a new instance for DeploymentController.

type PluginRegistry

type PluginRegistry interface {
	Plugin(k model.ApplicationKind) (pluginapi.PluginClient, bool)
}

func DefaultPluginRegistry

func DefaultPluginRegistry() PluginRegistry

type StopSignal

type StopSignal interface {
	Context() context.Context
	Ch() <-chan StopSignalType
	Signal() StopSignalType
	Terminated() bool
}

type StopSignalHandler

type StopSignalHandler interface {
	Cancel()
	Timeout()
	Terminate()
}

type StopSignalType

type StopSignalType string

const (
	// StopSignalTerminate means the executor should stop its execution
	// because the program was asked to terminate.
	StopSignalTerminate StopSignalType = "terminate"
	// StopSignalCancel means the executor should stop its execution
	// because the deployment was cancelled.
	StopSignalCancel StopSignalType = "cancel"
	// StopSignalTimeout means the executor should stop its execution
	// because of timeout.
	StopSignalTimeout StopSignalType = "timeout"
	// StopSignalNone means the excutor can be continuously executed.
	StopSignalNone StopSignalType = "none"
)