promotion

Documentation

Index

• type Mechanism
  • func NewMechanisms(argoClient client.Client, credentialsDB credentials.Database) Mechanism

Types

type Mechanism

type Mechanism interface {
	// GetName returns the name of a promotion mechanism.
	GetName() string
	// Promote consults rules in the provided Stage to perform some portion of the
	// transition into the specified Freight. It returns current promo status
	// and Freight, which may possibly be updated by the process.
	Promote(
		context.Context,
		*kargoapi.Stage,
		*kargoapi.Promotion,
		kargoapi.SimpleFreight,
	) (*kargoapi.PromotionStatus, kargoapi.SimpleFreight, error)
}

Mechanism provides a consistent interface for all promotion mechanisms.

func NewMechanisms

func NewMechanisms(
	argoClient client.Client,
	credentialsDB credentials.Database,
) Mechanism

NewMechanisms returns the entrypoint to a hierarchical tree of promotion mechanisms.