annotations

Documentation

Index

• Constants
• func GetDesiredReplicasAnnotation(rs *appsv1.ReplicaSet) (int32, bool)
• func GetRevisionAnnotation(anyObj metav1.Object) (int32, bool)
• func GetWorkloadGenerationAnnotation(ro *v1alpha1.Rollout) (int32, bool)
• func IsSaturated(rollout *v1alpha1.Rollout, rs *appsv1.ReplicaSet) bool
• func RemoveRolloutWorkloadRefGeneration(rollout *v1alpha1.Rollout)
• func ReplicasAnnotationsNeedUpdate(rs *appsv1.ReplicaSet, desiredReplicas int32) bool
• func SetNewReplicaSetAnnotations(rollout *v1alpha1.Rollout, newRS *appsv1.ReplicaSet, newRevision string, ...) bool
• func SetReplicasAnnotations(rs *appsv1.ReplicaSet, desiredReplicas int32) bool
• func SetRolloutRevision(rollout *v1alpha1.Rollout, revision string) bool
• func SetRolloutWorkloadRefGeneration(rollout *v1alpha1.Rollout, workloadGeneration string) bool

Constants

const (
	// RolloutLabel key value for the label in the annotations and selector
	RolloutLabel = "rollout.argoproj.io"
	// RevisionAnnotation is the revision annotation of a rollout's replica sets which records its rollout sequence
	RevisionAnnotation = RolloutLabel + "/revision"
	// RevisionHistoryAnnotation maintains the history of all old revisions that a replica set has served for a rollout.
	RevisionHistoryAnnotation = RolloutLabel + "/revision-history"
	// DesiredReplicasAnnotation is the desired replicas for a rollout recorded as an annotation
	// in its replica sets. Helps in separating scaling events from the rollout process and for
	// determining if the new replica set for a rollout is really saturated.
	DesiredReplicasAnnotation = RolloutLabel + "/desired-replicas"
	// WorkloadGenerationAnnotation is the generation of the referenced workload
	WorkloadGenerationAnnotation = RolloutLabel + "/workload-generation"
	// NotificationEngineAnnotation the annotation notification engine uses to determine if it should notify
	NotificationEngineAnnotation = "notified.notifications.argoproj.io"
)

Functions

func GetDesiredReplicasAnnotation

func GetDesiredReplicasAnnotation(rs *appsv1.ReplicaSet) (int32, bool)

GetDesiredReplicasAnnotation returns the number of desired replicas

func GetRevisionAnnotation

func GetRevisionAnnotation(anyObj metav1.Object) (int32, bool)

GetRevisionAnnotation returns revision of rollout

func GetWorkloadGenerationAnnotation

func GetWorkloadGenerationAnnotation(ro *v1alpha1.Rollout) (int32, bool)

GetWorkloadGenerationAnnotation returns generation of referenced workload

func IsSaturated

func IsSaturated(rollout *v1alpha1.Rollout, rs *appsv1.ReplicaSet) bool

IsSaturated checks if the new replica set is saturated by comparing its size with its rollout size. Both the rollout and the replica set have to believe this replica set can own all of the desired replicas in the rollout and the annotation helps in achieving that. All pods of the ReplicaSet need to be available.

func RemoveRolloutWorkloadRefGeneration

func RemoveRolloutWorkloadRefGeneration(rollout *v1alpha1.Rollout)

RemoveRolloutWorkloadRefGeneration remove the annotation of workload ref generation

func ReplicasAnnotationsNeedUpdate

func ReplicasAnnotationsNeedUpdate(rs *appsv1.ReplicaSet, desiredReplicas int32) bool

ReplicasAnnotationsNeedUpdate return true if ReplicasAnnotations need to be updated

func SetNewReplicaSetAnnotations

func SetNewReplicaSetAnnotations(rollout *v1alpha1.Rollout, newRS *appsv1.ReplicaSet, newRevision string, exists bool) bool

SetNewReplicaSetAnnotations sets new replica set's annotations appropriately by updating its revision and copying required rollout annotations to it; it returns true if replica set's annotation is changed.

func SetReplicasAnnotations

func SetReplicasAnnotations(rs *appsv1.ReplicaSet, desiredReplicas int32) bool

SetReplicasAnnotations sets the desiredReplicas into the annotations

func SetRolloutRevision

func SetRolloutRevision(rollout *v1alpha1.Rollout, revision string) bool

SetRolloutRevision updates the revision for a rollout.

func SetRolloutWorkloadRefGeneration

func SetRolloutWorkloadRefGeneration(rollout *v1alpha1.Rollout, workloadGeneration string) bool

SetRolloutWorkloadRefGeneration updates the workflow generation annotation for a rollout.