Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix Infinite loop with PreviewReplicaCount set #308

Merged
merged 2 commits into from
Dec 3, 2019
Merged

Fix Infinite loop with PreviewReplicaCount set #308

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
22e60e6
Fix Infinite loop with PreviewReplicaCount set
dthomson25 Nov 27, 2019
abcfd3c
Use xlarge instead of large
dthomson25 Nov 27, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ jobs:
docker:
# CircleCI Go images available at: https://hub.docker.com/r/circleci/golang/
- image: circleci/golang:1.13.1
resource_class: large
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was getting repeated failed workflows with the following error

/usr/local/go/pkg/tool/linux_amd64/link: signal: killed

https://app.circleci.com/jobs/github/argoproj/argo-rollouts/651
https://app.circleci.com/jobs/github/argoproj/argo-rollouts/652
https://app.circleci.com/jobs/github/argoproj/argo-rollouts/650

This Stackoverflow suggested it was a resourcing issue: https://stackoverflow.com/questions/52129612/golang-circleci-2-0-test-failing-with-signal-killed

resource_class: xlarge
environment:
TEST_RESULTS: /tmp/test-results
steps:
Expand Down
32 changes: 14 additions & 18 deletions rollout/bluegreen.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -262,15 +262,23 @@ func (c *RolloutController) syncRolloutStatusBlueGreen(previewSvc *corev1.Servic
func calculateScaleUpPreviewCheckPoint(roCtx *blueGreenContext, activeRS *appsv1.ReplicaSet) bool {
r := roCtx.Rollout()
newRS := roCtx.NewRS()
newRSAvailableCount := replicasetutil.GetAvailableReplicaCountForReplicaSets([]*appsv1.ReplicaSet{newRS})
if r.Spec.Strategy.BlueGreen.PreviewReplicaCount != nil && newRSAvailableCount == *r.Spec.Strategy.BlueGreen.PreviewReplicaCount {
return true
} else if reconcileBlueGreenTemplateChange(roCtx) {

if reconcileBlueGreenTemplateChange(roCtx) || r.Spec.Strategy.BlueGreen.PreviewReplicaCount == nil {
return false
} else if newRS != nil && activeRS != nil && activeRS.Name == newRS.Name {
}

if newRS == nil || activeRS == nil || activeRS.Name == newRS.Name {
return false
}
return r.Status.BlueGreen.ScaleUpPreviewCheckPoint

// Once the ScaleUpPreviewCheckPoint is set to true, the rollout should keep that value until
// the newRS becomes the new activeRS or there is a template change.
if r.Status.BlueGreen.ScaleUpPreviewCheckPoint {
return r.Status.BlueGreen.ScaleUpPreviewCheckPoint
}

newRSAvailableCount := replicasetutil.GetAvailableReplicaCountForReplicaSets([]*appsv1.ReplicaSet{newRS})
return newRSAvailableCount == *r.Spec.Strategy.BlueGreen.PreviewReplicaCount
}

// Should run only on scaling events and not during the normal rollout process.
Expand Down Expand Up @@ -303,18 +311,6 @@ func (c *RolloutController) scaleBlueGreen(rollout *v1alpha1.Rollout, newRS *app
}
}

previewRS, _ := replicasetutil.GetReplicaSetByTemplateHash(allRS, rollout.Status.BlueGreen.PreviewSelector)
if previewRS != nil {
previewReplicas := rolloutReplicas
if rollout.Spec.Strategy.BlueGreen.PreviewReplicaCount != nil && !rollout.Status.BlueGreen.ScaleUpPreviewCheckPoint {
previewReplicas = *rollout.Spec.Strategy.BlueGreen.PreviewReplicaCount
}
if *(previewRS.Spec.Replicas) != previewReplicas {
_, _, err := c.scaleReplicaSetAndRecordEvent(previewRS, previewReplicas, rollout)
return err
}
}

if newRS != nil {
newRSReplicaCount, err := replicasetutil.NewRSNewReplicas(rollout, allRS, newRS)
if err != nil {
Expand Down
99 changes: 99 additions & 0 deletions rollout/bluegreen_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -742,6 +742,105 @@ func TestBlueGreenRolloutScaleUpdateActiveRS(t *testing.T) {
f.run(getKey(r2, t))
}

func TestPreviewReplicaCountHandleScaleUpPreviewCheckPoint(t *testing.T) {
t.Run("TrueAfterMeetingMinAvailable", func(t *testing.T) {
f := newFixture(t)
defer f.Close()

r1 := newBlueGreenRollout("foo", 5, nil, "active", "")
r1.Spec.Strategy.BlueGreen.PreviewReplicaCount = pointer.Int32Ptr(3)
r1.Spec.Strategy.BlueGreen.AutoPromotionEnabled = pointer.BoolPtr(false)
rs1 := newReplicaSetWithStatus(r1, 5, 5)
r2 := bumpVersion(r1)

rs2 := newReplicaSetWithStatus(r2, 3, 3)
f.kubeobjects = append(f.kubeobjects, rs1, rs2)
f.replicaSetLister = append(f.replicaSetLister, rs1, rs2)

rs1PodHash := rs1.Labels[v1alpha1.DefaultRolloutUniqueLabelKey]
rs2PodHash := rs2.Labels[v1alpha1.DefaultRolloutUniqueLabelKey]

activeSvc := newService("active", 80, map[string]string{v1alpha1.DefaultRolloutUniqueLabelKey: rs1PodHash})

r2 = updateBlueGreenRolloutStatus(r2, rs2PodHash, rs1PodHash, 3, 3, 8, 5, false, true)
f.rolloutLister = append(f.rolloutLister, r2)
f.objects = append(f.objects, r2)
f.kubeobjects = append(f.kubeobjects, activeSvc)
f.serviceLister = append(f.serviceLister, activeSvc)

patchIndex := f.expectPatchRolloutAction(r1)
f.run(getKey(r2, t))
patch := f.getPatchedRollout(patchIndex)

assert.Contains(t, patch, `"scaleUpPreviewCheckPoint":true`)

})
t.Run("FalseAfterActiveServiceSwitch", func(t *testing.T) {
f := newFixture(t)
defer f.Close()

r1 := newBlueGreenRollout("foo", 5, nil, "active", "")
r1.Spec.Strategy.BlueGreen.PreviewReplicaCount = pointer.Int32Ptr(3)
r1.Spec.Strategy.BlueGreen.AutoPromotionEnabled = pointer.BoolPtr(false)
rs1 := newReplicaSetWithStatus(r1, 5, 5)
now := metav1.Now().Add(10 * time.Second)
rs1.Annotations[v1alpha1.DefaultReplicaSetScaleDownDeadlineAnnotationKey] = now.UTC().Format(time.RFC3339)
r2 := bumpVersion(r1)

rs2 := newReplicaSetWithStatus(r2, 5, 5)
f.kubeobjects = append(f.kubeobjects, rs1, rs2)
f.replicaSetLister = append(f.replicaSetLister, rs1, rs2)

rs1PodHash := rs1.Labels[v1alpha1.DefaultRolloutUniqueLabelKey]
rs2PodHash := rs2.Labels[v1alpha1.DefaultRolloutUniqueLabelKey]

activeSvc := newService("active", 80, map[string]string{v1alpha1.DefaultRolloutUniqueLabelKey: rs2PodHash})

r2 = updateBlueGreenRolloutStatus(r2, rs2PodHash, rs1PodHash, 5, 5, 8, 5, false, true)
r2.Status.BlueGreen.ScaleUpPreviewCheckPoint = true
f.rolloutLister = append(f.rolloutLister, r2)
f.objects = append(f.objects, r2)
f.kubeobjects = append(f.kubeobjects, activeSvc)
f.serviceLister = append(f.serviceLister, activeSvc)

f.expectPatchReplicaSetAction(rs1)
patchIndex := f.expectPatchRolloutAction(r1)

f.run(getKey(r2, t))
patch := f.getPatchedRollout(patchIndex)
assert.Contains(t, patch, `"scaleUpPreviewCheckPoint":null`)
})
t.Run("TrueWhenScalingUpPreview", func(t *testing.T) {
f := newFixture(t)
defer f.Close()

r1 := newBlueGreenRollout("foo", 5, nil, "active", "")
r1.Spec.Strategy.BlueGreen.PreviewReplicaCount = pointer.Int32Ptr(3)
rs1 := newReplicaSetWithStatus(r1, 5, 5)
r2 := bumpVersion(r1)

rs2 := newReplicaSetWithStatus(r2, 3, 3)
f.kubeobjects = append(f.kubeobjects, rs1, rs2)
f.replicaSetLister = append(f.replicaSetLister, rs1, rs2)

rs1PodHash := rs1.Labels[v1alpha1.DefaultRolloutUniqueLabelKey]
rs2PodHash := rs2.Labels[v1alpha1.DefaultRolloutUniqueLabelKey]

activeSvc := newService("active", 80, map[string]string{v1alpha1.DefaultRolloutUniqueLabelKey: rs1PodHash})

r2 = updateBlueGreenRolloutStatus(r2, rs2PodHash, rs1PodHash, 5, 5, 8, 5, false, true)
r2.Status.BlueGreen.ScaleUpPreviewCheckPoint = true
f.rolloutLister = append(f.rolloutLister, r2)
f.objects = append(f.objects, r2)
f.kubeobjects = append(f.kubeobjects, activeSvc)
f.serviceLister = append(f.serviceLister, activeSvc)

f.expectUpdateReplicaSetAction(rs1)
f.expectPatchRolloutAction(r2)
f.run(getKey(r2, t))
})
}

func TestBlueGreenRolloutIgnoringScalingUsePreviewRSCount(t *testing.T) {
f := newFixture(t)
defer f.Close()
Expand Down
12 changes: 0 additions & 12 deletions rollout/replicaset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,18 +77,6 @@ func (c *RolloutController) reconcileNewReplicaSet(roCtx rolloutContext) (bool,
}
roCtx.Log().Infof("Reconciling new ReplicaSet '%s'", newRS.Name)
allRSs := roCtx.AllRSs()
if rollout.Spec.Strategy.BlueGreen != nil {
rolloutReplicas := defaults.GetReplicasOrDefault(rollout.Spec.Replicas)
if *(newRS.Spec.Replicas) == rolloutReplicas {
// Scaling not required.
return false, nil
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have the same if statement in scaleReplicaSetAndRecordEvent() (https://github.com/argoproj/argo-rollouts/blob/master/rollout/sync.go#L295) so this check is not needed.

}
if *(newRS.Spec.Replicas) > rolloutReplicas {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically, if someone set their previewReplicaCount to greater than the .Spec.Replica, the controller would get into an infinite loop as it jump between the two values as a result of this check

// Scale down.
scaled, _, err := c.scaleReplicaSetAndRecordEvent(newRS, rolloutReplicas, rollout)
return scaled, err
}
}
newReplicasCount, err := replicasetutil.NewRSNewReplicas(rollout, allRSs, newRS)
if err != nil {
return false, err
Expand Down