forked from knative/serving
-
Notifications
You must be signed in to change notification settings - Fork 1
/
configuration.go
421 lines (357 loc) · 15.2 KB
/
configuration.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
/*
Copyright 2018 The Knative Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package configuration
import (
"context"
"fmt"
"reflect"
"sort"
"time"
"github.com/knative/pkg/configmap"
"github.com/knative/pkg/controller"
"github.com/knative/pkg/logging"
"github.com/knative/serving/pkg/apis/serving"
"github.com/knative/serving/pkg/apis/serving/v1alpha1"
"github.com/knative/serving/pkg/apis/serving/v1beta1"
servinginformers "github.com/knative/serving/pkg/client/informers/externalversions/serving/v1alpha1"
listers "github.com/knative/serving/pkg/client/listers/serving/v1alpha1"
"github.com/knative/serving/pkg/reconciler"
configns "github.com/knative/serving/pkg/reconciler/configuration/config"
"github.com/knative/serving/pkg/reconciler/configuration/resources"
errutil "github.com/pkg/errors"
"go.uber.org/zap"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
"k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/client-go/tools/cache"
)
const controllerAgentName = "configuration-controller"
type configStore interface {
ToContext(ctx context.Context) context.Context
WatchConfigs(w configmap.Watcher)
}
// Reconciler implements controller.Reconciler for Configuration resources.
type Reconciler struct {
*reconciler.Base
// listers index properties about resources
configurationLister listers.ConfigurationLister
revisionLister listers.RevisionLister
configStore configStore
}
// Check that our Reconciler implements controller.Reconciler
var _ controller.Reconciler = (*Reconciler)(nil)
// NewController creates a new Configuration controller
func NewController(
opt reconciler.Options,
configurationInformer servinginformers.ConfigurationInformer,
revisionInformer servinginformers.RevisionInformer,
) *controller.Impl {
c := &Reconciler{
Base: reconciler.NewBase(opt, controllerAgentName),
configurationLister: configurationInformer.Lister(),
revisionLister: revisionInformer.Lister(),
}
impl := controller.NewImpl(c, c.Logger, "Configurations", reconciler.MustNewStatsReporter("Configurations", c.Logger))
c.Logger.Info("Setting up event handlers")
configurationInformer.Informer().AddEventHandler(reconciler.Handler(impl.Enqueue))
revisionInformer.Informer().AddEventHandler(cache.FilteringResourceEventHandler{
FilterFunc: controller.Filter(v1alpha1.SchemeGroupVersion.WithKind("Configuration")),
Handler: reconciler.Handler(impl.EnqueueControllerOf),
})
c.Logger.Info("Setting up ConfigMap receivers")
c.configStore = configns.NewStore(c.Logger.Named("config-store"))
c.configStore.WatchConfigs(opt.ConfigMapWatcher)
return impl
}
// Reconcile compares the actual state with the desired, and attempts to
// converge the two. It then updates the Status block of the Configuration
// resource with the current status of the resource.
func (c *Reconciler) Reconcile(ctx context.Context, key string) error {
// Convert the namespace/name string into a distinct namespace and name.
namespace, name, err := cache.SplitMetaNamespaceKey(key)
if err != nil {
c.Logger.Errorf("invalid resource key: %s", key)
return nil
}
logger := logging.FromContext(ctx)
ctx = c.configStore.ToContext(ctx)
// Get the Configuration resource with this namespace/name.
original, err := c.configurationLister.Configurations(namespace).Get(name)
if errors.IsNotFound(err) {
// The resource no longer exists, in which case we stop processing.
logger.Errorf("configuration %q in work queue no longer exists", key)
return nil
} else if err != nil {
return err
}
// Don't modify the informer's copy.
config := original.DeepCopy()
// Reconcile this copy of the configuration and then write back any status
// updates regardless of whether the reconciliation errored out.
reconcileErr := c.reconcile(ctx, config)
if equality.Semantic.DeepEqual(original.Status, config.Status) {
// If we didn't change anything then don't call updateStatus.
// This is important because the copy we loaded from the informer's
// cache may be stale and we don't want to overwrite a prior update
// to status with this stale state.
} else if _, err = c.updateStatus(config); err != nil {
logger.Warnw("Failed to update configuration status", zap.Error(err))
c.Recorder.Eventf(config, corev1.EventTypeWarning, "UpdateFailed",
"Failed to update status for Configuration %q: %v", config.Name, err)
return err
}
if reconcileErr != nil {
c.Recorder.Event(config, corev1.EventTypeWarning, "InternalError", reconcileErr.Error())
}
return reconcileErr
}
func (c *Reconciler) reconcile(ctx context.Context, config *v1alpha1.Configuration) error {
logger := logging.FromContext(ctx)
if config.GetDeletionTimestamp() != nil {
return nil
}
// We may be reading a version of the object that was stored at an older version
// and may not have had all of the assumed defaults specified. This won't result
// in this getting written back to the API Server, but lets downstream logic make
// assumptions about defaulting.
config.SetDefaults(ctx)
config.Status.InitializeConditions()
if err := config.ConvertUp(ctx, &v1beta1.Configuration{}); err != nil {
if ce, ok := err.(*v1alpha1.CannotConvertError); ok {
config.Status.MarkResourceNotConvertible(ce)
} else {
return err
}
}
// First, fetch the revision that should exist for the current generation.
lcr, err := c.latestCreatedRevision(config)
if errors.IsNotFound(err) {
lcr, err = c.createRevision(ctx, config)
if err != nil {
errMsg := fmt.Sprintf("Failed to create Revision for Configuration %q: %v", config.Name, err)
logger.Error(errMsg)
c.Recorder.Event(config, corev1.EventTypeWarning, "CreationFailed", errMsg)
// Mark the Configuration as not-Ready since creating
// its latest revision failed.
config.Status.MarkRevisionCreationFailed(err.Error())
return err
}
} else if errors.IsAlreadyExists(err) {
// If we get an already-exists error from latestCreatedRevision it means
// that the Revision name already exists for another Configuration or at
// the wrong generation of this configuration.
config.Status.MarkRevisionCreationFailed(err.Error())
return nil
} else if err != nil {
logger.Errorf("Failed to reconcile Configuration %q - failed to get Revision: %v", config.Name, err)
return err
}
revName := lcr.Name
// Second, set this to be the latest revision that we have created.
config.Status.SetLatestCreatedRevisionName(revName)
config.Status.ObservedGeneration = config.Generation
// Last, determine whether we should set LatestReadyRevisionName to our
// LatestCreatedRevision based on its readiness.
rc := lcr.Status.GetCondition(v1alpha1.RevisionConditionReady)
switch {
case rc == nil || rc.Status == corev1.ConditionUnknown:
logger.Infof("Revision %q of configuration %q is not ready", revName, config.Name)
case rc.Status == corev1.ConditionTrue:
logger.Infof("Revision %q of configuration %q is ready", revName, config.Name)
created, ready := config.Status.LatestCreatedRevisionName, config.Status.LatestReadyRevisionName
if ready == "" {
// 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 %q has failed", revName, config.Name)
// 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",
"Latest created revision %q has failed", lcr.Name)
default:
err := fmt.Errorf("unrecognized condition status: %v on revision %q", rc.Status, revName)
logger.Errorf("Error reconciling Configuration %q: %v", config.Name, err)
return err
}
return c.gcRevisions(ctx, config)
}
// 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) {
// If config.Spec.GetTemplate().Name is set, then we can directly look up
// the revision by name.
name := config.Spec.GetTemplate().Name
if name == "" {
return nil, nil
}
errConflict := errors.NewAlreadyExists(v1alpha1.Resource("revisions"), name)
rev, err := lister.Revisions(config.Namespace).Get(name)
if errors.IsNotFound(err) {
// Does not exist, we must be good!
// note: for the name to change the generation must change.
return nil, err
} else if err != nil {
return nil, err
} else if !metav1.IsControlledBy(rev, config) {
// If the revision isn't controller by this configuration, then
// do not use it.
return nil, errConflict
}
// Check the generation on this revision.
generationKey := serving.ConfigurationGenerationLabelKey
expectedValue := resources.RevisionLabelValueForKey(generationKey, config)
if rev.Labels != nil && rev.Labels[generationKey] == expectedValue {
return rev, nil
}
// We only require spec equality because the rest is immutable and the user may have
// annotated or labeled the Revision (beyond what the Configuration might have).
if !equality.Semantic.DeepEqual(config.Spec.GetTemplate().Spec, rev.Spec) {
return nil, errConflict
}
return rev, nil
}
func (c *Reconciler) latestCreatedRevision(config *v1alpha1.Configuration) (*v1alpha1.Revision, error) {
if rev, err := CheckNameAvailability(config, c.revisionLister); rev != nil || err != nil {
return rev, err
}
lister := c.revisionLister.Revisions(config.Namespace)
generationKey := serving.ConfigurationGenerationLabelKey
list, err := lister.List(labels.SelectorFromSet(map[string]string{
generationKey: resources.RevisionLabelValueForKey(generationKey, config),
serving.ConfigurationLabelKey: config.Name,
}))
if err == nil && len(list) > 0 {
return list[0], nil
}
return nil, errors.NewNotFound(v1alpha1.Resource("revisions"), fmt.Sprintf("revision for %s", config.Name))
}
func (c *Reconciler) createRevision(ctx context.Context, config *v1alpha1.Configuration) (*v1alpha1.Revision, error) {
logger := logging.FromContext(ctx)
var buildRef *corev1.ObjectReference
if config.Spec.DeprecatedBuild != nil {
// TODO(mattmoor): Determine whether we reuse the previous build.
build := resources.MakeBuild(config)
gvr, _ := meta.UnsafeGuessKindToResource(build.GroupVersionKind())
// First, see if a build with this spec already exists.
buildHash := build.GetLabels()[serving.BuildHashLabelKey]
ul, err := c.DynamicClientSet.Resource(gvr).Namespace(build.GetNamespace()).List(metav1.ListOptions{
LabelSelector: fmt.Sprintf("%s=%s", serving.BuildHashLabelKey, buildHash),
})
if err != nil {
return nil, errutil.Wrapf(err, "Failed to list GroupVersionResource %+v", gvr)
}
var result *unstructured.Unstructured
if len(ul.Items) != 0 {
// If one exists, then have the Revision reference it.
result = &ul.Items[0]
} else {
// Otherwise, create a build and reference that.
result, err = c.DynamicClientSet.Resource(gvr).Namespace(build.GetNamespace()).Create(build, metav1.CreateOptions{})
if err != nil {
return nil, errutil.Wrapf(err, "Failed to create Build for Configuration %q", config.GetName())
}
logger.Infof("Created Build: %+v", result)
c.Recorder.Eventf(config, corev1.EventTypeNormal, "Created", "Created Build %q", result.GetName())
}
buildRef = &corev1.ObjectReference{
APIVersion: result.GetAPIVersion(),
Kind: result.GetKind(),
Name: result.GetName(),
}
}
rev := resources.MakeRevision(config, buildRef)
created, err := c.ServingClientSet.ServingV1alpha1().Revisions(config.Namespace).Create(rev)
if err != nil {
return nil, err
}
c.Recorder.Eventf(config, corev1.EventTypeNormal, "Created", "Created Revision %q", created.Name)
logger.Infof("Created Revision: %+v", created)
return created, nil
}
func (c *Reconciler) updateStatus(desired *v1alpha1.Configuration) (*v1alpha1.Configuration, error) {
config, err := c.configurationLister.Configurations(desired.Namespace).Get(desired.Name)
if err != nil {
return nil, err
}
// If there's nothing to update, just return.
if reflect.DeepEqual(config.Status, desired.Status) {
return config, nil
}
// Don't modify the informers copy
existing := config.DeepCopy()
existing.Status = desired.Status
return c.ServingClientSet.ServingV1alpha1().Configurations(desired.Namespace).UpdateStatus(existing)
}
func (c *Reconciler) gcRevisions(ctx context.Context, config *v1alpha1.Configuration) error {
cfg := configns.FromContext(ctx).RevisionGC
logger := logging.FromContext(ctx)
selector := labels.Set{serving.ConfigurationLabelKey: config.Name}.AsSelector()
revs, err := c.revisionLister.Revisions(config.Namespace).List(selector)
if err != nil {
return err
}
gcSkipOffset := cfg.StaleRevisionMinimumGenerations
if gcSkipOffset >= int64(len(revs)) {
return nil
}
// Sort by creation timestamp descending
sort.Slice(revs, func(i, j int) bool {
return revs[j].CreationTimestamp.Before(&revs[i].CreationTimestamp)
})
for _, rev := range revs[gcSkipOffset:] {
if isRevisionStale(ctx, rev, config) {
err := c.ServingClientSet.ServingV1alpha1().Revisions(rev.Namespace).Delete(rev.Name, &metav1.DeleteOptions{})
if err != nil {
logger.Errorf("Failed to delete stale revision: %v", err)
return err
}
}
}
return nil
}
func isRevisionStale(ctx context.Context, rev *v1alpha1.Revision, config *v1alpha1.Configuration) bool {
cfg := configns.FromContext(ctx).RevisionGC
logger := logging.FromContext(ctx)
if config.Status.LatestReadyRevisionName == rev.Name {
return false
}
curTime := time.Now()
if rev.ObjectMeta.CreationTimestamp.Add(cfg.StaleRevisionCreateDelay).After(curTime) {
// Revision was created sooner than staleRevisionCreateDelay. Ignore it.
return false
}
lastPin, err := rev.GetLastPinned()
if err != nil {
if err.(v1alpha1.LastPinnedParseError).Type != v1alpha1.AnnotationParseErrorTypeMissing {
logger.Errorf("Failed to determine revision last pinned: %v", err)
}
return false
}
ret := lastPin.Add(cfg.StaleRevisionTimeout).Before(curTime)
if ret {
logger.Infof("Detected stale revision %v with creation time %v and lastPinned time %v.", rev.ObjectMeta.Name, rev.ObjectMeta.CreationTimestamp, lastPin)
}
return ret
}