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.

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 for latestRevision routes may point to older revisions if latestCreated is not ready #5319

Merged
100 changes: 90 additions & 10 deletions pkg/reconciler/configuration/configuration.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,16 @@ import (
"context"
"fmt"
"reflect"
"sort"
"strconv"

"go.uber.org/zap"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/selection"
"k8s.io/client-go/tools/cache"
"knative.dev/pkg/controller"
"knative.dev/pkg/logging"
Expand Down Expand Up @@ -167,23 +170,14 @@ func (c *Reconciler) reconcile(ctx context.Context, config *v1alpha1.Configurati

case rc.Status == corev1.ConditionTrue:
logger.Infof("Revision %q of configuration is ready", revName)

created, ready := config.Status.LatestCreatedRevisionName, config.Status.LatestReadyRevisionName
if ready == "" {
if config.Status.LatestReadyRevisionName == "" {
// Surface an event for the first revision becoming ready.
c.Recorder.Event(config, corev1.EventTypeNormal, "ConfigurationReady",
"Configuration becomes ready")
}
// Update the LatestReadyRevisionName and surface an event for the transition.
config.Status.SetLatestReadyRevisionName(lcr.Name)
if created != ready {
c.Recorder.Eventf(config, corev1.EventTypeNormal, "LatestReadyUpdate",
"LatestReadyRevisionName updated to %q", lcr.Name)
}

case rc.Status == corev1.ConditionFalse:
logger.Infof("Revision %q of configuration has failed", revName)

// TODO(mattmoor): Only emit the event the first time we see this.
config.Status.MarkLatestCreatedFailed(lcr.Name, rc.Message)
c.Recorder.Eventf(config, corev1.EventTypeWarning, "LatestCreatedFailed",
Expand All @@ -193,9 +187,95 @@ func (c *Reconciler) reconcile(ctx context.Context, config *v1alpha1.Configurati
return fmt.Errorf("unrecognized condition status: %v on revision %q", rc.Status, revName)
}

lcrReady := rc != nil && rc.Status == corev1.ConditionTrue
if err = c.findAndSetLatestReadyRevision(config, lcrReady); err != nil {
return fmt.Errorf("failed to find and set latest ready revision: %w", err)
}

return nil
}

// findAndSetLatestReadyRevision finds the last ready revision and sets LatestReadyRevisionName to it.
// lcrReady indicates whether the latest created revision is ready or not.
func (c *Reconciler) findAndSetLatestReadyRevision(config *v1alpha1.Configuration, lcrReady bool) error {
Copy link
Member

Choose a reason for hiding this comment

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

Can we drop the unused param?

sortedRevisions, err := c.getSortedCreatedRevisions(config)
if err != nil {
return err
}
for _, rev := range sortedRevisions {
if rev.Status.IsReady() {
// No need to update latest ready revision in this case
if rev.Name == config.Status.LatestReadyRevisionName && !lcrReady {
Copy link
Member

Choose a reason for hiding this comment

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

I don't get the lcrReady check here. Why can't we return whenever the LRRN matches?

Copy link
Contributor Author

@taragu taragu Nov 6, 2019

Choose a reason for hiding this comment

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

This is for the failed revision recovers use case. We still need to call SetLatestReadyRevisionName(...) in this case because it marks the configuration ready to true.

Copy link
Member

Choose a reason for hiding this comment

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

I think threading through the added state probably makes things more confusing than its worth given that we save a tiny bit of redundancy in the SetLatestReadyRevision call when it's already true?

return nil
}
old, new := config.Status.LatestReadyRevisionName, rev.Name
config.Status.SetLatestReadyRevisionName(rev.Name)
if old != new {
Copy link
Member

Choose a reason for hiding this comment

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

Except for the lcrReady check, this is the same test as above, so this should be the only meaningful work we'd perform when not returning. Am I missing something?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think part of the issue is that SetLatestReadyRevisionName(..) not only sets the LRR, but also marks configuration as ready. So there are cases where we want to call SetLatestReadyRevisionName because we need to set the config to ready, but we don't really need to set the LRR because it's already the same as the current LRR.

c.Recorder.Eventf(config, corev1.EventTypeNormal, "LatestReadyUpdate",
"LatestReadyRevisionName updated to %q", rev.Name)
}
return nil
}
}
return nil
}

// getSortedCreatedRevisions returns the list of created revisions sorted in descending
// generation order between the generation of the latest ready revision and config's generation (both inclusive).
func (c *Reconciler) getSortedCreatedRevisions(config *v1alpha1.Configuration) ([]*v1alpha1.Revision, error) {
lister := c.revisionLister.Revisions(config.Namespace)
configSelector := labels.SelectorFromSet(map[string]string{
serving.ConfigurationLabelKey: config.Name,
})
mattmoor marked this conversation as resolved.
Show resolved Hide resolved
if config.Status.LatestReadyRevisionName != "" {
lrr, err := lister.Get(config.Status.LatestReadyRevisionName)
if err != nil {
return nil, err
}
start := lrr.Generation
var generations []string
for i := start; i <= int64(config.Generation); i++ {
generations = append(generations, strconv.FormatInt(i, 10))
}

// Add an "In" filter so that the configurations we get back from List have generation
// in range (config's latest ready generation, config's generation]
generationKey := serving.ConfigurationGenerationLabelKey
inReq, err := labels.NewRequirement(generationKey,
selection.In,
generations,
)
if err != nil {
return nil, err
}
configSelector = configSelector.Add(*inReq)
}

list, err := lister.List(configSelector)
if err != nil {
return nil, err
}
// Return a sorted list with Generation in descending order
if len(list) > 1 {
Copy link
Member

Choose a reason for hiding this comment

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

Do we need this?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I added this after Victor made this suggestion #5319 (comment)

sort.Slice(list, func(i, j int) bool {
// BYO name always be the first
if config.Spec.Template.Name == list[i].Name {
return true
}
if config.Spec.Template.Name == list[j].Name {
return false
}
intI, errI := strconv.Atoi(list[i].Labels[serving.ConfigurationGenerationLabelKey])
intJ, errJ := strconv.Atoi(list[j].Labels[serving.ConfigurationGenerationLabelKey])
if errI != nil || errJ != nil {
return true
}
return intI > intJ
})
}
return list, nil
}

// CheckNameAvailability checks that if the named Revision specified by the Configuration
// is available (not found), exists (but matches), or exists with conflict (doesn't match).
func CheckNameAvailability(config *v1alpha1.Configuration, lister listers.RevisionLister) (*v1alpha1.Revision, error) {
Expand Down
32 changes: 32 additions & 0 deletions pkg/reconciler/configuration/configuration_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,38 @@ func TestReconcile(t *testing.T) {
WithCreationTimestamp(now), MarkRevisionReady),
},
Key: "foo/double-trouble",
}, {
Name: "three revisions with the latest revision failed, the latest ready should be updated to the last ready revision",
Objects: []runtime.Object{
cfg("threerevs", "foo", 3,
WithLatestCreated("threerevs-00002"),
WithLatestReady("threerevs-00001"), WithObservedGen, func(cfg *v1alpha1.Configuration) {
cfg.Spec.GetTemplate().Name = "threerevs-00003"
},
),
rev("threerevs", "foo", 1,
WithRevName("threerevs-00001"),
WithCreationTimestamp(now), MarkRevisionReady),
rev("threerevs", "foo", 2,
WithRevName("threerevs-00002"),
WithCreationTimestamp(now), MarkRevisionReady),
rev("threerevs", "foo", 3,
WithRevName("threerevs-00003"),
WithCreationTimestamp(now), MarkInactive("", "")),
},
WantStatusUpdates: []clientgotesting.UpdateActionImpl{{
Object: cfg("threerevs", "foo", 3,
WithLatestCreated("threerevs-00003"),
WithLatestReady("threerevs-00002"),
WithObservedGen, func(cfg *v1alpha1.Configuration) {
cfg.Spec.GetTemplate().Name = "threerevs-00003"
},
),
}},
WantEvents: []string{
Eventf(corev1.EventTypeNormal, "LatestReadyUpdate", "LatestReadyRevisionName updated to %q", "threerevs-00002"),
},
Key: "foo/threerevs",
}}

table.Test(t, MakeFactory(func(ctx context.Context, listers *Listers, cmw configmap.Watcher) controller.Reconciler {
Expand Down