kargo

Documentation

Index

• func NewPromotion(ctx context.Context, stage kargoapi.Stage, freight string) kargoapi.Promotion
• type AbortRequested
  • func (p AbortRequested) Update(e event.UpdateEvent) bool
• 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 RefreshRequested
  • func (p RefreshRequested) Update(e event.UpdateEvent) bool
• type ReverifyRequested
  • func (r ReverifyRequested) Update(e event.UpdateEvent) bool

Functions

func NewPromotion

func NewPromotion(
	ctx context.Context,
	stage kargoapi.Stage,
	freight string,
) kargoapi.Promotion

NewPromotion returns a new Promotion from a given stage and freight with our naming convention.

Types

type AbortRequested

type AbortRequested struct {
	predicate.Funcs
}

AbortRequested 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 (AbortRequested) Update

func (p AbortRequested) 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.

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 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.