planner

Documentation

Overview

Package planner provides a piped component that decides the deployment pipeline of a deployment. The planner bases on the changes from git commits then builds the deployment manifests to know the behavior of the deployment. From that behavior the planner can decides which pipeline should be applied.

Index

• Constants
• func GetPredefinedStage(id string) (config.PipelineStage, bool)
• func MakeInitialStageMetadata(cfg config.PipelineStage) map[string]string
• type Input
• type Output
• type Planner

Constants

const (
	PredefinedStageK8sSync       = "K8sSync"
	PredefinedStageTerraformSync = "TerraformSync"
	PredefinedStageCloudRunSync  = "CloudRunSync"
	PredefinedStageLambdaSync    = "LambdaSync"
	PredefinedStageRollback      = "Rollback"
)

Functions

func GetPredefinedStage

func GetPredefinedStage(id string) (config.PipelineStage, bool)

GetPredefinedStage finds and returns the predefined stage for the given id.

func MakeInitialStageMetadata

func MakeInitialStageMetadata(cfg config.PipelineStage) map[string]string

MakeInitialStageMetadata makes the initial metadata for the given state configuration.

Types

type Input

type Input struct {
	// Readonly deployment model.
	Deployment                     *model.Deployment
	MostRecentSuccessfulCommitHash string
	TargetDSP                      deploysource.Provider
	RunningDSP                     deploysource.Provider
	AppManifestsCache              cache.Cache
	RegexPool                      *regexpool.Pool
	Logger                         *zap.Logger
}

type Output

type Output struct {
	Version string
	Stages  []*model.PipelineStage
	Summary string
}

type Planner

type Planner interface {
	Plan(ctx context.Context, in Input) (Output, error)
}