kargo

Documentation

Index

• Constants
• type PromoPhaseChanged
  • func NewPromoPhaseChangedPredicate(logger *logging.Logger) PromoPhaseChanged[*kargoapi.Promotion]
  • func (p PromoPhaseChanged[T]) Create(event.TypedCreateEvent[T]) bool
  • func (p PromoPhaseChanged[T]) Delete(e event.TypedDeleteEvent[T]) bool
  • func (p PromoPhaseChanged[T]) Generic(event.TypedGenericEvent[T]) bool
  • func (p PromoPhaseChanged[T]) Update(e event.TypedUpdateEvent[T]) bool
• type PromoWentTerminal
  • func NewPromoWentTerminalPredicate(logger *logging.Logger) PromoWentTerminal[*kargoapi.Promotion]
  • func (p PromoWentTerminal[T]) Create(event.TypedCreateEvent[T]) bool
  • func (p PromoWentTerminal[T]) Delete(e event.TypedDeleteEvent[T]) bool
  • func (p PromoWentTerminal[T]) Generic(event.TypedGenericEvent[T]) bool
  • func (p PromoWentTerminal[T]) Update(e event.TypedUpdateEvent[T]) bool
• type PromotionAbortRequested
  • func (p PromotionAbortRequested) Update(e event.UpdateEvent) bool
• type PromotionBuilder
  • func NewPromotionBuilder(c client.Client) *PromotionBuilder
  • func (b *PromotionBuilder) Build(ctx context.Context, stage kargoapi.Stage, freight string) (*kargoapi.Promotion, error)
  • func (b *PromotionBuilder) InflateSteps(ctx context.Context, promo *kargoapi.Promotion) error
• type RefreshRequested
  • func (p RefreshRequested) Update(e event.UpdateEvent) bool
• type ReverifyRequested
  • func (r ReverifyRequested) Update(e event.UpdateEvent) bool
• type VerificationAbortRequested
  • func (p VerificationAbortRequested) Update(e event.UpdateEvent) bool

Constants

const (
	// PromotionAliasSeparator is the separator used in the Promotion step alias
	// to separate the task alias from the step alias.
	PromotionAliasSeparator = "::"
)

Types

type PromoPhaseChanged

type PromoPhaseChanged[T any] struct {
	predicate.Funcs
	// contains filtered or unexported fields
}

PromoPhaseChanged is a predicate that returns true if the phase of a promotion has changed. It can be used to trigger the reconciliation of an associated object when the phase of a Promotion changes. A concrete example is to trigger the reconciliation of a Stage when the phase of a Promotion for that Stage changes, so that the Stage can update the last Promotion reference in its status.

func NewPromoPhaseChangedPredicate

func NewPromoPhaseChangedPredicate(logger *logging.Logger) PromoPhaseChanged[*kargoapi.Promotion]

func (PromoPhaseChanged[T]) Create

func (p PromoPhaseChanged[T]) Create(event.TypedCreateEvent[T]) bool

func (PromoPhaseChanged[T]) Delete

func (p PromoPhaseChanged[T]) Delete(e event.TypedDeleteEvent[T]) bool

func (PromoPhaseChanged[T]) Generic

func (p PromoPhaseChanged[T]) Generic(event.TypedGenericEvent[T]) bool

func (PromoPhaseChanged[T]) Update

func (p PromoPhaseChanged[T]) Update(e event.TypedUpdateEvent[T]) bool

type PromoWentTerminal

type PromoWentTerminal[T any] struct {
	predicate.Funcs
	// contains filtered or unexported fields
}

PromoWentTerminal is a predicate that returns true if a promotion went terminal. Used by stage reconciler to enqueue a stage when it's associated promo is complete. Also used by promo reconciler to enqueue the next highest priority promotion.

func NewPromoWentTerminalPredicate

func NewPromoWentTerminalPredicate(logger *logging.Logger) PromoWentTerminal[*kargoapi.Promotion]

func (PromoWentTerminal[T]) Create

func (p PromoWentTerminal[T]) Create(event.TypedCreateEvent[T]) bool

func (PromoWentTerminal[T]) Delete

func (p PromoWentTerminal[T]) Delete(e event.TypedDeleteEvent[T]) bool

func (PromoWentTerminal[T]) Generic

func (p PromoWentTerminal[T]) Generic(event.TypedGenericEvent[T]) bool

func (PromoWentTerminal[T]) Update

func (p PromoWentTerminal[T]) Update(e event.TypedUpdateEvent[T]) bool

Update implements default TypedUpdateEvent filter for checking if a promotion went terminal

type PromotionAbortRequested

type PromotionAbortRequested struct {
	predicate.Funcs
}

PromotionAbortRequested is a predicate that returns true if the abort annotation has been set on a resource, or the action of the request has changed compared to the previous state.

func (PromotionAbortRequested) Update

func (p PromotionAbortRequested) Update(e event.UpdateEvent) bool

Update returns true if the abort annotation has been set on the new object, or if the action of the request has changed compared to the old object.

type PromotionBuilder

type PromotionBuilder struct {
	// contains filtered or unexported fields
}

func NewPromotionBuilder

func NewPromotionBuilder(c client.Client) *PromotionBuilder

NewPromotionBuilder creates a new PromotionBuilder with the given client.

func (*PromotionBuilder) Build

func (b *PromotionBuilder) Build(
	ctx context.Context,
	stage kargoapi.Stage,
	freight string,
) (*kargoapi.Promotion, error)

Build creates a new Promotion for the Freight based on the PromotionTemplate of the given Stage.

func (*PromotionBuilder) InflateSteps

func (b *PromotionBuilder) InflateSteps(ctx context.Context, promo *kargoapi.Promotion) error

InflateSteps inflates the Promotion steps by resolving any references to PromotionTasks and expanding them into their individual steps. The inflated steps are then set on the Promotion, replacing the original steps.

type RefreshRequested

type RefreshRequested struct {
	predicate.Funcs
}

RefreshRequested is a predicate that returns true if the refresh annotation has been set on a resource, or the value of the annotation has changed compared to the previous state.

func (RefreshRequested) Update

func (p RefreshRequested) Update(e event.UpdateEvent) bool

Update returns true if the refresh annotation has been set on the new object, or if the value of the annotation has changed compared to the old object.

type ReverifyRequested

type ReverifyRequested struct {
	predicate.Funcs
}

ReverifyRequested is a predicate that returns true if the reverify annotation has been set on a resource, or the ID of the request has changed compared to the previous state.

func (ReverifyRequested) Update

func (r ReverifyRequested) Update(e event.UpdateEvent) bool

Update returns true if the reverify annotation has been set on the new object, or if the ID of the request has changed compared to the old object.

type VerificationAbortRequested

type VerificationAbortRequested struct {
	predicate.Funcs
}

VerificationAbortRequested is a predicate that returns true if the abort annotation has been set on a resource, or the ID of the request has changed compared to the previous state.

func (VerificationAbortRequested) Update

func (p VerificationAbortRequested) Update(e event.UpdateEvent) bool

Update returns true if the abort annotation has been set on the new object, or if the ID of the request has changed compared to the old object.