-
Notifications
You must be signed in to change notification settings - Fork 261
/
client.go
569 lines (492 loc) · 18.4 KB
/
client.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
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
// 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"
"errors"
"fmt"
"time"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/fields"
"knative.dev/pkg/apis"
"knative.dev/serving/pkg/client/clientset/versioned/scheme"
"knative.dev/client/pkg/serving"
"knative.dev/client/pkg/util"
"knative.dev/client/pkg/wait"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/watch"
apiserving "knative.dev/serving/pkg/apis/serving"
servingv1 "knative.dev/serving/pkg/apis/serving/v1"
clientv1 "knative.dev/serving/pkg/client/clientset/versioned/typed/serving/v1"
clienterrors "knative.dev/client/pkg/errors"
)
// Func signature for an updating function which returns the updated service object
// or an error
type ServiceUpdateFunc func(origService *servingv1.Service) (*servingv1.Service, error)
// Kn interface to serving. All methods are relative to the
// namespace specified during construction
type KnServingClient interface {
// Namespace in which this client is operating for
Namespace() string
// Get a service by its unique name
GetService(name string) (*servingv1.Service, error)
// List services
ListServices(opts ...ListConfig) (*servingv1.ServiceList, error)
// Create a new service
CreateService(service *servingv1.Service) error
// UpdateService updates the given service. For a more robust variant with automatic
// conflict resolution see UpdateServiceWithRetry
UpdateService(service *servingv1.Service) error
// UpdateServiceWithRetry updates service and retries if there is a version conflict.
// The updateFunc receives a deep copy of the existing service and can add update it in
// place.
UpdateServiceWithRetry(name string, updateFunc ServiceUpdateFunc, nrRetries int) error
// Apply a service's definition to the cluster. The full service declaration needs to be provided,
// which is different to UpdateService which can also do a partial update. If the given
// service does not already exists (identified by name) then the service is create.
// If the service exists, then a three-way merge will be performed between the original
// configuration given (from the last "apply" operation), the new configuration as given ]
// here and the current configuration as found on the cluster.
// The returned bool indicates whether the service has been changed or whether this operation
// was a no-op
// An error can indicate a general error or a conflict that occurred during the three way merge.
ApplyService(service *servingv1.Service) (bool, error)
// Delete a service by name
DeleteService(name string, timeout time.Duration) error
// Wait for a service to become ready, but not longer than provided timeout.
// Return error and how long has been waited
WaitForService(name string, timeout time.Duration, msgCallback wait.MessageCallback) (error, time.Duration)
// Get a configuration by name
GetConfiguration(name string) (*servingv1.Configuration, error)
// Get a revision by name
GetRevision(name string) (*servingv1.Revision, error)
// Get the "base" revision for a Service; the one that corresponds to the
// current template.
GetBaseRevision(service *servingv1.Service) (*servingv1.Revision, error)
// Create revision
CreateRevision(revision *servingv1.Revision) error
// Update revision
UpdateRevision(revision *servingv1.Revision) error
// List revisions
ListRevisions(opts ...ListConfig) (*servingv1.RevisionList, error)
// Delete a revision
DeleteRevision(name string, timeout time.Duration) error
// Get a route by its unique name
GetRoute(name string) (*servingv1.Route, error)
// List routes
ListRoutes(opts ...ListConfig) (*servingv1.RouteList, error)
}
type listConfigCollector struct {
// Labels to filter on
Labels labels.Set
// Labels to filter on
Fields fields.Set
}
// Config function for builder pattern
type ListConfig func(config *listConfigCollector)
type ListConfigs []ListConfig
// add selectors to a list options
func (opts ListConfigs) toListOptions() v1.ListOptions {
listConfig := listConfigCollector{labels.Set{}, fields.Set{}}
for _, f := range opts {
f(&listConfig)
}
options := v1.ListOptions{}
if len(listConfig.Fields) > 0 {
options.FieldSelector = listConfig.Fields.String()
}
if len(listConfig.Labels) > 0 {
options.LabelSelector = listConfig.Labels.String()
}
return options
}
// Filter list on the provided name
func WithName(name string) ListConfig {
return func(lo *listConfigCollector) {
lo.Fields["metadata.name"] = name
}
}
// Filter on the service name
func WithService(service string) ListConfig {
return func(lo *listConfigCollector) {
lo.Labels[apiserving.ServiceLabelKey] = service
}
}
// WithLabel filters on the provided label
func WithLabel(labelKey, labelValue string) ListConfig {
return func(lo *listConfigCollector) {
lo.Labels[labelKey] = labelValue
}
}
type knServingClient struct {
client clientv1.ServingV1Interface
namespace string
}
// Create a new client facade for the provided namespace
func NewKnServingClient(client clientv1.ServingV1Interface, namespace string) KnServingClient {
return &knServingClient{
client: client,
namespace: namespace,
}
}
// Return the client's namespace
func (cl *knServingClient) Namespace() string {
return cl.namespace
}
// Get a service by its unique name
func (cl *knServingClient) GetService(name string) (*servingv1.Service, error) {
service, err := cl.client.Services(cl.namespace).Get(context.TODO(), name, v1.GetOptions{})
if err != nil {
return nil, clienterrors.GetError(err)
}
err = updateServingGvk(service)
if err != nil {
return nil, err
}
return service, nil
}
func (cl *knServingClient) WatchService(name string, timeout time.Duration) (watch.Interface, error) {
return wait.NewWatcher(cl.client.Services(cl.namespace).Watch,
cl.client.RESTClient(), cl.namespace, "services", name, timeout)
}
func (cl *knServingClient) WatchRevision(name string, timeout time.Duration) (watch.Interface, error) {
return wait.NewWatcher(cl.client.Revisions(cl.namespace).Watch,
cl.client.RESTClient(), cl.namespace, "revision", name, timeout)
}
// List services
func (cl *knServingClient) ListServices(config ...ListConfig) (*servingv1.ServiceList, error) {
serviceList, err := cl.client.Services(cl.namespace).List(context.TODO(), ListConfigs(config).toListOptions())
if err != nil {
return nil, clienterrors.GetError(err)
}
serviceListNew := serviceList.DeepCopy()
err = updateServingGvk(serviceListNew)
if err != nil {
return nil, err
}
serviceListNew.Items = make([]servingv1.Service, len(serviceList.Items))
for idx, service := range serviceList.Items {
serviceClone := service.DeepCopy()
err := updateServingGvk(serviceClone)
if err != nil {
return nil, err
}
serviceListNew.Items[idx] = *serviceClone
}
return serviceListNew, nil
}
// Create a new service
func (cl *knServingClient) CreateService(service *servingv1.Service) error {
_, err := cl.client.Services(cl.namespace).Create(context.TODO(), service, v1.CreateOptions{})
if err != nil {
return clienterrors.GetError(err)
}
return updateServingGvk(service)
}
// Update the given service
func (cl *knServingClient) UpdateService(service *servingv1.Service) error {
_, err := cl.client.Services(cl.namespace).Update(context.TODO(), service, v1.UpdateOptions{})
if err != nil {
return err
}
return updateServingGvk(service)
}
// Update the given service with a retry in case of a conflict
func (cl *knServingClient) UpdateServiceWithRetry(name string, updateFunc ServiceUpdateFunc, nrRetries int) error {
return updateServiceWithRetry(cl, name, updateFunc, nrRetries)
}
// Extracted to be usable with the Mocking client
func updateServiceWithRetry(cl KnServingClient, name string, updateFunc ServiceUpdateFunc, nrRetries int) error {
var retries = 0
for {
service, err := cl.GetService(name)
if err != nil {
return err
}
if service.GetDeletionTimestamp() != nil {
return fmt.Errorf("can't update service %s because it has been marked for deletion", name)
}
updatedService, err := updateFunc(service.DeepCopy())
if err != nil {
return err
}
err = cl.UpdateService(updatedService)
if err != nil {
// Retry to update when a resource version conflict exists
if apierrors.IsConflict(err) && retries < nrRetries {
retries++
// Wait a second before doing the retry
time.Sleep(time.Second)
continue
}
return fmt.Errorf("giving up after %d retries: %w", nrRetries, err)
}
return nil
}
}
// ApplyService applies a service definition that contains the service's targer state
func (cl *knServingClient) ApplyService(modifiedService *servingv1.Service) (bool, error) {
currentService, err := cl.GetService(modifiedService.Name)
if err != nil && !apierrors.IsNotFound(err) {
return false, err
}
containers := modifiedService.Spec.Template.Spec.Containers
if len(containers) == 0 || containers[0].Image == "" && currentService != nil {
return false, errors.New("'service apply' requires the image name to run provided with the --image option")
}
// No current service --> create a new service
if currentService == nil {
err := updateLastAppliedAnnotation(modifiedService)
if err != nil {
return false, err
}
return true, cl.CreateService(modifiedService)
}
// Merge with existing service
uOriginalService := getOriginalConfiguration(currentService)
return cl.patch(modifiedService, currentService, uOriginalService)
}
// Delete a service by name
// Param `timeout` represents a duration to wait for a delete op to finish.
// For `timeout == 0` delete is performed async without any wait.
func (cl *knServingClient) DeleteService(serviceName string, timeout time.Duration) error {
if timeout == 0 {
return cl.deleteService(serviceName, v1.DeletePropagationBackground)
}
waitC := make(chan error)
go func() {
waitForEvent := wait.NewWaitForEvent("service", cl.WatchService, func(evt *watch.Event) bool { return evt.Type == watch.Deleted })
err, _ := waitForEvent.Wait(serviceName, wait.Options{Timeout: &timeout}, wait.NoopMessageCallback())
waitC <- err
}()
err := cl.deleteService(serviceName, v1.DeletePropagationForeground)
if err != nil {
return err
}
return <-waitC
}
func (cl *knServingClient) deleteService(serviceName string, propagationPolicy v1.DeletionPropagation) error {
err := cl.client.Services(cl.namespace).Delete(
context.TODO(),
serviceName,
v1.DeleteOptions{PropagationPolicy: &propagationPolicy},
)
if err != nil {
return clienterrors.GetError(err)
}
return nil
}
// Wait for a service to become ready, but not longer than provided timeout
func (cl *knServingClient) WaitForService(name string, timeout time.Duration, msgCallback wait.MessageCallback) (error, time.Duration) {
waitForReady := wait.NewWaitForReady("service", cl.WatchService, serviceConditionExtractor)
return waitForReady.Wait(name, wait.Options{Timeout: &timeout}, msgCallback)
}
// Get the configuration for a service
func (cl *knServingClient) GetConfiguration(name string) (*servingv1.Configuration, error) {
configuration, err := cl.client.Configurations(cl.namespace).Get(context.TODO(), name, v1.GetOptions{})
if err != nil {
return nil, err
}
err = updateServingGvk(configuration)
if err != nil {
return nil, err
}
return configuration, nil
}
// Get a revision by name
func (cl *knServingClient) GetRevision(name string) (*servingv1.Revision, error) {
revision, err := cl.client.Revisions(cl.namespace).Get(context.TODO(), name, v1.GetOptions{})
if err != nil {
return nil, clienterrors.GetError(err)
}
err = updateServingGvk(revision)
if err != nil {
return nil, err
}
return revision, nil
}
type NoBaseRevisionError struct {
msg string
}
func (e NoBaseRevisionError) Error() string {
return e.msg
}
var noBaseRevisionError = &NoBaseRevisionError{"base revision not found"}
// Get a "base" revision. This is the revision corresponding to the template of
// a Service. It may not be findable with our heuristics, in which case this
// method returns Errors()["no-base-revision"]. If it simply doesn't exist (like
// it wasn't yet created or was deleted), return the usual not found error.
func (cl *knServingClient) GetBaseRevision(service *servingv1.Service) (*servingv1.Revision, error) {
return getBaseRevision(cl, service)
}
func getBaseRevision(cl KnServingClient, service *servingv1.Service) (*servingv1.Revision, error) {
template := service.Spec.Template
// First, try to get it by name. If the template has a particular name, the
// base revision is the one created with that name.
if template.Name != "" {
return cl.GetRevision(template.Name)
}
// Next, let's try the LatestCreatedRevision, and see if that matches the
// template, at least in terms of the image (which is what we care about here).
if service.Status.LatestCreatedRevisionName != "" {
latestCreated, err := cl.GetRevision(service.Status.LatestCreatedRevisionName)
if err != nil {
return nil, err
}
latestContainer, err := serving.ContainerOfRevisionSpec(&latestCreated.Spec)
if err != nil {
return nil, err
}
container, err := serving.ContainerOfRevisionTemplate(&template)
if err != nil {
return nil, err
}
if latestContainer.Image != container.Image {
// At this point we know the latestCreatedRevision is out of date.
return nil, noBaseRevisionError
}
// There is still some chance the latestCreatedRevision is out of date,
// but we can't check the whole thing for equality because of
// server-side defaulting. Since what we probably want it for is to
// check the image digest anyway, keep it as good enough.
return latestCreated, nil
}
return nil, noBaseRevisionError
}
// Create a revision
func (cl *knServingClient) CreateRevision(revision *servingv1.Revision) error {
rev, err := cl.client.Revisions(cl.namespace).Create(context.TODO(), revision, v1.CreateOptions{})
if err != nil {
return clienterrors.GetError(err)
}
return updateServingGvk(rev)
}
// Update the given service
func (cl *knServingClient) UpdateRevision(revision *servingv1.Revision) error {
_, err := cl.client.Revisions(cl.namespace).Update(context.TODO(), revision, v1.UpdateOptions{})
if err != nil {
return err
}
return updateServingGvk(revision)
}
// Delete a revision by name
func (cl *knServingClient) DeleteRevision(name string, timeout time.Duration) error {
revision, err := cl.client.Revisions(cl.namespace).Get(context.TODO(), name, v1.GetOptions{})
if err != nil {
return clienterrors.GetError(err)
}
if revision.GetDeletionTimestamp() != nil {
return fmt.Errorf("can't delete revision '%s' because it has been already marked for deletion", name)
}
if timeout == 0 {
return cl.deleteRevision(name)
}
waitC := make(chan error)
go func() {
waitForEvent := wait.NewWaitForEvent("revision", cl.WatchRevision, func(evt *watch.Event) bool { return evt.Type == watch.Deleted })
err, _ := waitForEvent.Wait(name, wait.Options{Timeout: &timeout}, wait.NoopMessageCallback())
waitC <- err
}()
err = cl.deleteRevision(name)
if err != nil {
return clienterrors.GetError(err)
}
return <-waitC
}
func (cl *knServingClient) deleteRevision(name string) error {
err := cl.client.Revisions(cl.namespace).Delete(context.TODO(), name, v1.DeleteOptions{})
if err != nil {
return clienterrors.GetError(err)
}
return nil
}
// List revisions
func (cl *knServingClient) ListRevisions(config ...ListConfig) (*servingv1.RevisionList, error) {
revisionList, err := cl.client.Revisions(cl.namespace).List(context.TODO(), ListConfigs(config).toListOptions())
if err != nil {
return nil, clienterrors.GetError(err)
}
return updateServingGvkForRevisionList(revisionList)
}
// Get a route by its unique name
func (cl *knServingClient) GetRoute(name string) (*servingv1.Route, error) {
route, err := cl.client.Routes(cl.namespace).Get(context.TODO(), name, v1.GetOptions{})
if err != nil {
return nil, err
}
err = updateServingGvk(route)
if err != nil {
return nil, err
}
return route, nil
}
// List routes
func (cl *knServingClient) ListRoutes(config ...ListConfig) (*servingv1.RouteList, error) {
routeList, err := cl.client.Routes(cl.namespace).List(context.TODO(), ListConfigs(config).toListOptions())
if err != nil {
return nil, err
}
return updateServingGvkForRouteList(routeList)
}
// update all the list + all items contained in the list with
// the proper GroupVersionKind specific to Knative serving
func updateServingGvkForRevisionList(revisionList *servingv1.RevisionList) (*servingv1.RevisionList, error) {
revisionListNew := revisionList.DeepCopy()
err := updateServingGvk(revisionListNew)
if err != nil {
return nil, err
}
revisionListNew.Items = make([]servingv1.Revision, len(revisionList.Items))
for idx := range revisionList.Items {
revision := revisionList.Items[idx].DeepCopy()
err := updateServingGvk(revision)
if err != nil {
return nil, err
}
revisionListNew.Items[idx] = *revision
}
return revisionListNew, nil
}
// update all the list + all items contained in the list with
// the proper GroupVersionKind specific to Knative serving
func updateServingGvkForRouteList(routeList *servingv1.RouteList) (*servingv1.RouteList, error) {
routeListNew := routeList.DeepCopy()
err := updateServingGvk(routeListNew)
if err != nil {
return nil, err
}
routeListNew.Items = make([]servingv1.Route, len(routeList.Items))
for idx := range routeList.Items {
revision := routeList.Items[idx].DeepCopy()
err := updateServingGvk(revision)
if err != nil {
return nil, err
}
routeListNew.Items[idx] = *revision
}
return routeListNew, nil
}
// update with the servingv1 group + version
func updateServingGvk(obj runtime.Object) error {
return util.UpdateGroupVersionKindWithScheme(obj, servingv1.SchemeGroupVersion, scheme.Scheme)
}
func serviceConditionExtractor(obj runtime.Object) (apis.Conditions, error) {
service, ok := obj.(*servingv1.Service)
if !ok {
return nil, fmt.Errorf("%v is not a service", obj)
}
return apis.Conditions(service.Status.Conditions), nil
}