forked from knative/serving
/
traffic.go
349 lines (308 loc) · 10.8 KB
/
traffic.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
/*
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
https://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 traffic
import (
"context"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
"knative.dev/pkg/ptr"
net "knative.dev/serving/pkg/apis/networking"
netv1alpha1 "knative.dev/serving/pkg/apis/networking/v1alpha1"
"knative.dev/serving/pkg/apis/serving"
v1 "knative.dev/serving/pkg/apis/serving/v1"
listers "knative.dev/serving/pkg/client/listers/serving/v1"
"knative.dev/serving/pkg/reconciler/route/domains"
"knative.dev/serving/pkg/reconciler/route/resources/labels"
)
const (
// DefaultTarget is the unnamed default target for the traffic.
DefaultTarget = ""
)
// A RevisionTarget adds the Active/Inactive state and the transport protocol of a
// Revision to a flattened TrafficTarget.
type RevisionTarget struct {
v1.TrafficTarget
Active bool
Protocol net.ProtocolType
ServiceName string // Revision service name.
}
// RevisionTargets is a collection of revision targets.
type RevisionTargets []RevisionTarget
// Config encapsulates details of our traffic so that we don't need to make API calls, or use details of the
// route beyond its ObjectMeta to make routing changes.
type Config struct {
// Group of traffic splits. Un-named targets are grouped together
// under the key `DefaultTarget`, and named target are under the respective
// name. This is used to configure network configuration to
// realize a route's setting.
Targets map[string]RevisionTargets
// Visibility of the traffic targets.
Visibility map[string]netv1alpha1.IngressVisibility
// A list traffic targets, flattened to the Revision level. This
// is used to populate the Route.Status.TrafficTarget field.
revisionTargets RevisionTargets
// The referred `Configuration`s and `Revision`s.
Configurations map[string]*v1.Configuration
Revisions map[string]*v1.Revision
// MissingTargets are references to Configuration's or Revision's
// that are missing
MissingTargets []corev1.ObjectReference
}
// BuildTrafficConfiguration consolidates and flattens the Route.Spec.Traffic to the Revision-level. It also provides a
// complete lists of Configurations and Revisions referred by the Route, directly or indirectly. These referred targets
// are keyed by name for easy access.
//
// In the case that some target is missing, an error of type TargetError will be returned.
func BuildTrafficConfiguration(configLister listers.ConfigurationLister, revLister listers.RevisionLister,
r *v1.Route) (*Config, error) {
builder := newBuilder(configLister, revLister, r.Namespace, len(r.Spec.Traffic))
builder.applySpecTraffic(r.Spec.Traffic)
return builder.build()
}
// GetRevisionTrafficTargets returns a list of TrafficTarget flattened to the RevisionName, and having ConfigurationName cleared out.
func (t *Config) GetRevisionTrafficTargets(ctx context.Context, r *v1.Route) ([]v1.TrafficTarget, error) {
results := make([]v1.TrafficTarget, len(t.revisionTargets))
for i, tt := range t.revisionTargets {
var pp *int64
if tt.Percent != nil {
pp = ptr.Int64(*tt.Percent)
}
// We cannot `DeepCopy` here, since tt.TrafficTarget might contain both
// configuration and revision.
results[i] = v1.TrafficTarget{
Tag: tt.Tag,
RevisionName: tt.RevisionName,
Percent: pp,
LatestRevision: tt.LatestRevision,
}
if tt.Tag != "" {
meta := r.ObjectMeta.DeepCopy()
hostname, err := domains.HostnameFromTemplate(ctx, meta.Name, tt.Tag)
if err != nil {
return nil, err
}
labels.SetVisibility(meta, t.Visibility[tt.Tag] == netv1alpha1.IngressVisibilityClusterLocal)
// http is currently the only supported scheme
fullDomain, err := domains.DomainNameFromTemplate(ctx, *meta, hostname)
if err != nil {
return nil, err
}
results[i].URL = domains.URL(domains.HTTPScheme, fullDomain)
}
}
return results, nil
}
type configBuilder struct {
configLister listers.ConfigurationLister
revLister listers.RevisionLister
namespace string
// targets is a grouping of traffic targets serving the same origin.
targets map[string]RevisionTargets
// revisionTargets is the original list of targets, at the Revision level.
revisionTargets RevisionTargets
// configurations contains all the referred Configuration, keyed by their name.
configurations map[string]*v1.Configuration
// revisions contains all the referred Revision, keyed by their name.
revisions map[string]*v1.Revision
// missingTargets is a collection of targets that weren't present
// in our listers
missingTargets []corev1.ObjectReference
// TargetError are deferred until we got a complete list of all referred targets.
deferredTargetErr TargetError
}
func newBuilder(
configLister listers.ConfigurationLister, revLister listers.RevisionLister,
namespace string, trafficSize int) *configBuilder {
return &configBuilder{
configLister: configLister,
revLister: revLister,
namespace: namespace,
targets: make(map[string]RevisionTargets),
revisionTargets: make(RevisionTargets, 0, trafficSize),
configurations: make(map[string]*v1.Configuration),
revisions: make(map[string]*v1.Revision),
}
}
func (t *configBuilder) applySpecTraffic(traffic []v1.TrafficTarget) error {
for _, tt := range traffic {
if err := t.addTrafficTarget(&tt); err != nil {
// Other non-traffic target errors shouldn't be ignored.
return err
}
}
return nil
}
func (t *configBuilder) getConfiguration(name string) (*v1.Configuration, error) {
if _, ok := t.configurations[name]; !ok {
config, err := t.configLister.Configurations(t.namespace).Get(name)
if errors.IsNotFound(err) {
return nil, errMissingConfiguration(name)
} else if err != nil {
return nil, err
}
t.configurations[name] = config
}
return t.configurations[name], nil
}
func (t *configBuilder) getRevision(name string) (*v1.Revision, error) {
if _, ok := t.revisions[name]; !ok {
rev, err := t.revLister.Revisions(t.namespace).Get(name)
if errors.IsNotFound(err) {
return nil, errMissingRevision(name)
} else if err != nil {
return nil, err
}
t.revisions[name] = rev
}
return t.revisions[name], nil
}
// deferTargetError will record a TargetError. A TargetError with
// IsFailure()=true will always overwrite a previous TargetError.
func (t *configBuilder) deferTargetError(err TargetError) {
if t.deferredTargetErr == nil || err.IsFailure() {
t.deferredTargetErr = err
}
}
func (t *configBuilder) addTrafficTarget(tt *v1.TrafficTarget) error {
var err error
if tt.RevisionName != "" {
err = t.addRevisionTarget(tt)
} else if tt.ConfigurationName != "" {
err = t.addConfigurationTarget(tt)
}
if err, ok := err.(*missingTargetError); err != nil && ok {
apiVersion, kind := v1.SchemeGroupVersion.
WithKind(err.kind).
ToAPIVersionAndKind()
t.missingTargets = append(t.missingTargets, corev1.ObjectReference{
APIVersion: apiVersion,
Kind: kind,
Name: err.name,
Namespace: t.namespace,
})
}
if err, ok := err.(TargetError); err != nil && ok {
// Defer target errors, as we still want to compile a list of
// all referred targets, including missing ones.
t.deferTargetError(err)
return nil
}
return err
}
// addConfigurationTarget flattens a traffic target to the Revision level, by looking up for the LatestReadyRevisionName
// on the referred Configuration. It adds both to the lists of directly referred targets.
func (t *configBuilder) addConfigurationTarget(tt *v1.TrafficTarget) error {
config, err := t.getConfiguration(tt.ConfigurationName)
if err != nil {
return err
}
if config.Status.LatestReadyRevisionName == "" {
return errUnreadyConfiguration(config)
}
rev, err := t.getRevision(config.Status.LatestReadyRevisionName)
if err != nil {
return err
}
ntt := tt.DeepCopy()
target := RevisionTarget{
TrafficTarget: *ntt,
Active: !rev.Status.IsActivationRequired(),
Protocol: rev.GetProtocol(),
ServiceName: rev.Status.ServiceName,
}
target.TrafficTarget.RevisionName = rev.Name
t.addFlattenedTarget(target)
return nil
}
func (t *configBuilder) addRevisionTarget(tt *v1.TrafficTarget) error {
rev, err := t.getRevision(tt.RevisionName)
if err != nil {
return err
}
if !rev.Status.IsReady() {
return errUnreadyRevision(rev)
}
ntt := tt.DeepCopy()
target := RevisionTarget{
TrafficTarget: *ntt,
Active: !rev.Status.IsActivationRequired(),
Protocol: rev.GetProtocol(),
ServiceName: rev.Status.ServiceName,
}
if configName, ok := rev.Labels[serving.ConfigurationLabelKey]; ok {
target.TrafficTarget.ConfigurationName = configName
if _, err := t.getConfiguration(configName); err != nil {
return err
}
}
t.addFlattenedTarget(target)
return nil
}
func (t *configBuilder) addFlattenedTarget(target RevisionTarget) {
name := target.TrafficTarget.Tag
t.revisionTargets = append(t.revisionTargets, target)
t.targets[DefaultTarget] = append(t.targets[DefaultTarget], target)
if name != "" {
t.targets[name] = append(t.targets[name], target)
}
}
func consolidate(targets RevisionTargets) RevisionTargets {
byName := make(map[string]RevisionTarget)
names := []string{}
for _, tt := range targets {
name := tt.TrafficTarget.RevisionName
cur, ok := byName[name]
if !ok {
byName[name] = tt
names = append(names, name)
} else {
if tt.TrafficTarget.Percent != nil {
current := int64(0)
if cur.TrafficTarget.Percent != nil {
current += *cur.TrafficTarget.Percent
}
current += *tt.TrafficTarget.Percent
cur.TrafficTarget.Percent = ptr.Int64(current)
}
byName[name] = cur
}
}
consolidated := make([]RevisionTarget, len(names))
for i, name := range names {
consolidated[i] = byName[name]
}
if len(consolidated) == 1 {
consolidated[0].TrafficTarget.Percent = ptr.Int64(100)
}
return consolidated
}
func consolidateAll(targets map[string]RevisionTargets) map[string]RevisionTargets {
consolidated := make(map[string]RevisionTargets)
for name, tts := range targets {
consolidated[name] = consolidate(tts)
}
return consolidated
}
func (t *configBuilder) build() (*Config, error) {
if t.deferredTargetErr != nil {
t.targets = nil
t.revisionTargets = nil
}
return &Config{
Targets: consolidateAll(t.targets),
revisionTargets: t.revisionTargets,
Configurations: t.configurations,
Revisions: t.revisions,
MissingTargets: t.missingTargets,
}, t.deferredTargetErr
}