-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
service.go
472 lines (416 loc) · 13.6 KB
/
service.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
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
/*
Copyright 2019 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 v1
import (
"context"
"fmt"
"time"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"knative.dev/pkg/apis"
duckv1 "knative.dev/pkg/apis/duck/v1"
"knative.dev/pkg/kmeta"
"knative.dev/pkg/ptr"
v1 "knative.dev/serving/pkg/apis/serving/v1"
"knative.dev/serving/pkg/reconciler/route/domains"
servicenames "knative.dev/serving/pkg/reconciler/service/resources/names"
)
// ServiceOption enables further configuration of a Service.
type ServiceOption func(*v1.Service)
// Service creates a service with ServiceOptions
func Service(name, namespace string, so ...ServiceOption) *v1.Service {
s := &v1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: name,
Namespace: namespace,
},
}
for _, opt := range so {
opt(s)
}
return s
}
// DefaultService creates a service with ServiceOptions and with default values set
func DefaultService(name, namespace string, so ...ServiceOption) *v1.Service {
return Service(name, namespace, append(so, WithServiceDefaults)...)
}
// ServiceWithoutNamespace creates a service with ServiceOptions but without a specific namespace
func ServiceWithoutNamespace(name string, so ...ServiceOption) *v1.Service {
s := &v1.Service{
ObjectMeta: metav1.ObjectMeta{
Name: name,
},
}
for _, opt := range so {
opt(s)
}
return s
}
// WithInitSvcConditions initializes the Service's conditions.
func WithInitSvcConditions(s *v1.Service) {
s.Status.InitializeConditions()
}
// WithConfigSpec confgures the Service to use the given config spec
func WithConfigSpec(config v1.ConfigurationSpec) ServiceOption {
return func(svc *v1.Service) {
svc.Spec.ConfigurationSpec = config
}
}
// WithRouteSpec configures the Service to use the given route spec
func WithRouteSpec(route v1.RouteSpec) ServiceOption {
return func(svc *v1.Service) {
svc.Spec.RouteSpec = route
}
}
// WithNamedPort sets the name on the Service's port to the provided name
func WithNamedPort(name string) ServiceOption {
return func(svc *v1.Service) {
c := &svc.Spec.Template.Spec.Containers[0]
if len(c.Ports) == 1 {
c.Ports[0].Name = name
} else {
c.Ports = []corev1.ContainerPort{{
Name: name,
}}
}
}
}
// WithNumberedPort sets the Service's port number to what's provided.
func WithNumberedPort(number int32) ServiceOption {
return func(svc *v1.Service) {
c := &svc.Spec.Template.Spec.Containers[0]
if len(c.Ports) == 1 {
c.Ports[0].ContainerPort = number
} else {
c.Ports = []corev1.ContainerPort{{
ContainerPort: number,
}}
}
}
}
// WithServiceDefaults will set the default values on the service.
func WithServiceDefaults(svc *v1.Service) {
svc.SetDefaults(context.Background())
}
// WithResourceRequirements attaches resource requirements to the service
func WithResourceRequirements(resourceRequirements corev1.ResourceRequirements) ServiceOption {
return func(svc *v1.Service) {
svc.Spec.Template.Spec.Containers[0].Resources = resourceRequirements
}
}
// WithServiceAnnotation adds the given annotation to the service.
func WithServiceAnnotation(k, v string) ServiceOption {
return func(svc *v1.Service) {
svc.Annotations = kmeta.UnionMaps(svc.Annotations, map[string]string{
k: v,
})
}
}
// WithServiceAnnotationRemoved adds the given annotation to the service.
func WithServiceAnnotationRemoved(k string) ServiceOption {
return func(svc *v1.Service) {
svc.Annotations = kmeta.FilterMap(svc.Annotations, func(s string) bool {
return k == s
})
}
}
// WithServiceImage sets the container image to be the provided string.
func WithServiceImage(img string) ServiceOption {
return func(svc *v1.Service) {
svc.Spec.Template.Spec.Containers[0].Image = img
}
}
// WithServiceTemplateMeta sets the container image to be the provided string.
func WithServiceTemplateMeta(m metav1.ObjectMeta) ServiceOption {
return func(svc *v1.Service) {
svc.Spec.Template.ObjectMeta = m
}
}
// WithRevisionTimeoutSeconds sets revision timeout
func WithRevisionTimeoutSeconds(revisionTimeoutSeconds int64) ServiceOption {
return func(service *v1.Service) {
service.Spec.Template.Spec.TimeoutSeconds = ptr.Int64(revisionTimeoutSeconds)
}
}
// WithServiceAccountName sets revision service account name
func WithServiceAccountName(serviceAccountName string) ServiceOption {
return func(service *v1.Service) {
service.Spec.Template.Spec.ServiceAccountName = serviceAccountName
}
}
// WithContainerConcurrency sets the given Service's concurrency.
func WithContainerConcurrency(cc int64) ServiceOption {
return func(svc *v1.Service) {
svc.Spec.Template.Spec.ContainerConcurrency = &cc
}
}
// WithVolume adds a volume to the service
func WithVolume(name, mountPath string, volumeSource corev1.VolumeSource) ServiceOption {
return func(svc *v1.Service) {
rt := &svc.Spec.ConfigurationSpec.Template.Spec
rt.Containers[0].VolumeMounts = append(rt.Containers[0].VolumeMounts,
corev1.VolumeMount{
Name: name,
MountPath: mountPath,
})
rt.Volumes = append(rt.Volumes, corev1.Volume{
Name: name,
VolumeSource: volumeSource,
})
}
}
// WithEnv configures the Service to use the provided environment variables.
func WithEnv(evs ...corev1.EnvVar) ServiceOption {
return func(s *v1.Service) {
s.Spec.Template.Spec.Containers[0].Env = evs
}
}
// WithEnvFrom configures the Service to use the provided environment variables.
func WithEnvFrom(evs ...corev1.EnvFromSource) ServiceOption {
return func(s *v1.Service) {
s.Spec.Template.Spec.Containers[0].EnvFrom = evs
}
}
// WithSecurityContext configures the Service to use the provided security context.
func WithSecurityContext(sc *corev1.SecurityContext) ServiceOption {
return func(s *v1.Service) {
s.Spec.Template.Spec.Containers[0].SecurityContext = sc
}
}
// WithWorkingDir configures the Service to use the provided working directory.
func WithWorkingDir(wd string) ServiceOption {
return func(s *v1.Service) {
s.Spec.Template.Spec.Containers[0].WorkingDir = wd
}
}
// WithServiceAnnotations adds the supplied annotations to the Service
func WithServiceAnnotations(annotations map[string]string) ServiceOption {
return func(service *v1.Service) {
service.Annotations = kmeta.UnionMaps(service.Annotations, annotations)
}
}
// WithConfigAnnotations assigns config annotations to a service
func WithConfigAnnotations(annotations map[string]string) ServiceOption {
return func(service *v1.Service) {
service.Spec.Template.Annotations = kmeta.UnionMaps(
service.Spec.Template.Annotations, annotations)
}
}
// WithBYORevisionName sets the given name to the config spec
func WithBYORevisionName(name string) ServiceOption {
return func(s *v1.Service) {
s.Spec.Template.Name = name
}
}
// WithServiceDeletionTimestamp will set the DeletionTimestamp on the Service.
func WithServiceDeletionTimestamp(r *v1.Service) {
t := metav1.NewTime(time.Unix(1e9, 0))
r.ObjectMeta.SetDeletionTimestamp(&t)
}
// WithNamedRevision configures the Service to use BYO Revision in the
// template spec and reference that same revision name in the route spec.
func WithNamedRevision(s *v1.Service) {
s.Spec = v1.ServiceSpec{
ConfigurationSpec: v1.ConfigurationSpec{
Template: v1.RevisionTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Name: s.Name + "-byo",
},
Spec: v1.RevisionSpec{
PodSpec: corev1.PodSpec{
Containers: []corev1.Container{{
Image: "busybox",
}},
},
TimeoutSeconds: ptr.Int64(60),
},
},
},
RouteSpec: v1.RouteSpec{
Traffic: []v1.TrafficTarget{{
RevisionName: s.Name + "-byo",
Percent: ptr.Int64(100),
}},
},
}
}
// WithOutOfDateConfig reflects the Configuration's readiness in the Service
// resource.
func WithOutOfDateConfig(s *v1.Service) {
s.Status.MarkConfigurationNotReconciled()
}
// WithServiceGeneration sets the service's generation
func WithServiceGeneration(generation int64) ServiceOption {
return func(svc *v1.Service) {
svc.Status.ObservedGeneration = generation
}
}
// WithServiceLabel attaches a particular label to the service.
func WithServiceLabel(key, value string) ServiceOption {
return func(service *v1.Service) {
if service.Labels == nil {
service.Labels = make(map[string]string)
}
service.Labels[key] = value
}
}
// WithServiceObservedGeneration sets the service's observed generation to it's generation
func WithServiceObservedGeneration(svc *v1.Service) {
svc.Status.ObservedGeneration = svc.Generation
}
// MarkRevisionNameTaken calls the function of the same name on the Service's status
func MarkRevisionNameTaken(service *v1.Service) {
service.Status.MarkRevisionNameTaken(service.Spec.GetTemplate().GetName())
}
// WithRunLatestRollout configures the Service to use a "runLatest" rollout.
func WithRunLatestRollout(s *v1.Service) {
s.Spec = v1.ServiceSpec{
ConfigurationSpec: *configSpec.DeepCopy(),
}
}
// WithReadyRoute reflects the Route's readiness in the Service resource.
func WithReadyRoute(s *v1.Service) {
s.Status.PropagateRouteStatus(&v1.RouteStatus{
Status: duckv1.Status{
Conditions: duckv1.Conditions{{
Type: "Ready",
Status: "True",
}},
},
})
}
// WithReadyConfig reflects the Configuration's readiness in the Service
// resource. This must coincide with the setting of Latest{Created,Ready}
// to the provided revision name.
func WithReadyConfig(name string) ServiceOption {
return func(s *v1.Service) {
s.Status.PropagateConfigurationStatus(&v1.ConfigurationStatus{
Status: duckv1.Status{
Conditions: duckv1.Conditions{{
Type: "Ready",
Status: "True",
}},
},
ConfigurationStatusFields: v1.ConfigurationStatusFields{
LatestCreatedRevisionName: name,
LatestReadyRevisionName: name,
},
})
}
}
// WithSvcStatusDomain propagates the domain name to the status of the Service.
func WithSvcStatusDomain(s *v1.Service) {
n, ns := s.GetName(), s.GetNamespace()
s.Status.URL = &apis.URL{
Scheme: "http",
Host: fmt.Sprintf("%s.%s.example.com", n, ns),
}
}
// WithSvcStatusAddress updates the service's status with the address.
func WithSvcStatusAddress(s *v1.Service) {
s.Status.Address = &duckv1.Addressable{
URL: &apis.URL{
Scheme: "http",
Host: fmt.Sprintf("%s.%s.svc.cluster.local", s.Name, s.Namespace),
},
}
}
// WithSvcStatusTraffic sets the Service's status traffic block to the specified traffic targets.
func WithSvcStatusTraffic(targets ...v1.TrafficTarget) ServiceOption {
return func(r *v1.Service) {
// Automatically inject URL into TrafficTarget status
for _, tt := range targets {
tt.URL = domains.URL(domains.HTTPScheme, tt.Tag+".example.com")
}
r.Status.Traffic = targets
}
}
// WithServiceLatestReadyRevision sets the latest ready revision on the Service's status.
func WithServiceLatestReadyRevision(lrr string) ServiceOption {
return func(s *v1.Service) {
s.Status.LatestReadyRevisionName = lrr
}
}
// WithReadinessProbe sets the provided probe to be the readiness
// probe on the service.
func WithReadinessProbe(p *corev1.Probe) ServiceOption {
return func(s *v1.Service) {
s.Spec.Template.Spec.Containers[0].ReadinessProbe = p
}
}
// MarkConfigurationNotReconciled calls the function of the same name on the Service's status.
func MarkConfigurationNotReconciled(service *v1.Service) {
service.Status.MarkConfigurationNotReconciled()
}
// WithServiceStatusRouteNotReady sets the `RoutesReady` condition on the service to `Unknown`.
func WithServiceStatusRouteNotReady(s *v1.Service) {
s.Status.MarkRouteNotYetReady()
}
// MarkConfigurationNotOwned calls the function of the same name on the Service's status.
func MarkConfigurationNotOwned(service *v1.Service) {
service.Status.MarkConfigurationNotOwned(servicenames.Configuration(service))
}
// MarkRouteNotOwned calls the function of the same name on the Service's status.
func MarkRouteNotOwned(service *v1.Service) {
service.Status.MarkRouteNotOwned(servicenames.Route(service))
}
// WithFailedRoute reflects a Route's failure in the Service resource.
func WithFailedRoute(reason, message string) ServiceOption {
return func(s *v1.Service) {
s.Status.PropagateRouteStatus(&v1.RouteStatus{
Status: duckv1.Status{
Conditions: duckv1.Conditions{{
Type: "Ready",
Status: "False",
Reason: reason,
Message: message,
}},
},
})
}
}
// WithFailedConfig reflects the Configuration's failure in the Service
// resource. The failing revision's name is reflected in LatestCreated.
func WithFailedConfig(name, reason, message string) ServiceOption {
return func(s *v1.Service) {
s.Status.PropagateConfigurationStatus(&v1.ConfigurationStatus{
Status: duckv1.Status{
Conditions: duckv1.Conditions{{
Type: "Ready",
Status: "False",
Reason: reason,
Message: fmt.Sprintf("Revision %q failed with message: %s.",
name, message),
}},
},
ConfigurationStatusFields: v1.ConfigurationStatusFields{
LatestCreatedRevisionName: name,
},
})
}
}
var (
// configSpec is the spec used for the different styles of Service rollout.
configSpec = v1.ConfigurationSpec{
Template: v1.RevisionTemplateSpec{
Spec: v1.RevisionSpec{
TimeoutSeconds: ptr.Int64(60),
PodSpec: corev1.PodSpec{
Containers: []corev1.Container{{
Image: "busybox",
}},
},
},
},
}
)