-
Notifications
You must be signed in to change notification settings - Fork 451
/
extension.go
431 lines (378 loc) · 17.8 KB
/
extension.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
// Copyright 2020 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// 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 extension
import (
"context"
"time"
"github.com/go-logr/logr"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/util/sets"
"sigs.k8s.io/controller-runtime/pkg/client"
gardencorev1beta1 "github.com/gardener/gardener/pkg/apis/core/v1beta1"
v1beta1constants "github.com/gardener/gardener/pkg/apis/core/v1beta1/constants"
extensionsv1alpha1 "github.com/gardener/gardener/pkg/apis/extensions/v1alpha1"
"github.com/gardener/gardener/pkg/controllerutils"
"github.com/gardener/gardener/pkg/extensions"
"github.com/gardener/gardener/pkg/utils/flow"
)
const (
// DefaultInterval is the default interval for retry operations.
DefaultInterval = 5 * time.Second
// DefaultSevereThreshold is the default threshold until an error reported by another component is treated as 'severe'.
DefaultSevereThreshold = 30 * time.Second
// DefaultTimeout is the default timeout and defines how long Gardener should wait
// for a successful reconciliation of an Extension resource.
DefaultTimeout = 3 * time.Minute
)
// TimeNow returns the current time. Exposed for testing.
var TimeNow = time.Now
// Interface contains references to an Extension deployer.
type Interface interface {
// DeleteStaleResources deletes unused Extension resources from the shoot namespace in the seed.
DeleteStaleResources(context.Context) error
// WaitCleanupStaleResources waits until all unused Extension resources are cleaned up.
WaitCleanupStaleResources(context.Context) error
// Extensions returns the map of extensions where the key is the type and the value is an Extension structure.
Extensions() map[string]Extension
// DeployBeforeKubeAPIServer deploys extensions that should be handled before the kube-apiserver.
DeployBeforeKubeAPIServer(context.Context) error
// RestoreBeforeKubeAPIServer restores extensions that should be handled before the kube-apiserver.
RestoreBeforeKubeAPIServer(context.Context, *gardencorev1beta1.ShootState) error
// WaitBeforeKubeAPIServer waits until all extensions that should be handled before the kube-apiserver are deployed and report readiness.
WaitBeforeKubeAPIServer(context.Context) error
// DeployAfterKubeAPIServer deploys extensions that should be handled after the kube-apiserver.
DeployAfterKubeAPIServer(ctx context.Context) error
// RestoreAfterKubeAPIServer restores extensions that should be handled after the kube-apiserver.
RestoreAfterKubeAPIServer(ctx context.Context, shootState *gardencorev1beta1.ShootState) error
// WaitAfterKubeAPIServer waits until all extensions that should be handled after the kube-apiserver are deployed and report readiness.
WaitAfterKubeAPIServer(ctx context.Context) error
// DestroyBeforeKubeAPIServer deletes the extensions that should be handled before the kube-apiserver.
DestroyBeforeKubeAPIServer(context.Context) error
// WaitCleanupBeforeKubeAPIServer waits until the extensions that should be handled before the kube-apiserver are cleaned up.
WaitCleanupBeforeKubeAPIServer(context.Context) error
// DestroyAfterKubeAPIServer deletes the extensions that should be handled after the kube-apiserver.
DestroyAfterKubeAPIServer(context.Context) error
// WaitCleanupAfterKubeAPIServer waits until the extensions that should be handled after the kube-apiserver are cleaned up.
WaitCleanupAfterKubeAPIServer(context.Context) error
// WaitCleanup waits until all extensions are cleaned up.
WaitCleanup(ctx context.Context) error
// MigrateBeforeKubeAPIServer migrates all Extension resources that should be handled before the kube-apiserver.
MigrateBeforeKubeAPIServer(ctx context.Context) error
// WaitMigrateBeforeKubeAPIServer waits until all Extension resources that should be handled before the kube-apiserver are migrated.
WaitMigrateBeforeKubeAPIServer(ctx context.Context) error
// MigrateAfterKubeAPIServer migrates all Extension resources that should be handled after the kube-apiserver.
MigrateAfterKubeAPIServer(ctx context.Context) error
// WaitMigrateAfterKubeAPIServer waits until all Extension resources that should be handled after the kube-apiserver are migrated.
WaitMigrateAfterKubeAPIServer(ctx context.Context) error
}
// Extension contains information about the desired Extension resources as well as configuration information.
type Extension struct {
extensionsv1alpha1.Extension
// Timeout is the maximum waiting time for the Extension status to report readiness.
Timeout time.Duration
// Lifecycle defines when an extension resource should be updated during different operations.
Lifecycle *gardencorev1beta1.ControllerResourceLifecycle
}
// Values contains the values used to create an Extension resources.
type Values struct {
// Namespace is the namespace into which the Extension resources should be deployed.
Namespace string
// Extensions is the map of extensions where the key is the type and the value is an Extension structure.
Extensions map[string]Extension
}
type extension struct {
values *Values
log logr.Logger
client client.Client
waitInterval time.Duration
waitSevereThreshold time.Duration
waitTimeout time.Duration
extensions map[string]*extensionsv1alpha1.Extension
}
// New creates a new instance of Extension deployer.
func New(
log logr.Logger,
client client.Client,
values *Values,
waitInterval time.Duration,
waitSevereThreshold time.Duration,
waitTimeout time.Duration,
) Interface {
return &extension{
values: values,
log: log,
client: client,
waitInterval: waitInterval,
waitSevereThreshold: waitSevereThreshold,
waitTimeout: waitTimeout,
extensions: make(map[string]*extensionsv1alpha1.Extension),
}
}
// DeployAfterKubeAPIServer uses the seed client to create or update the Extension resources that should be deployed after the kube-apiserver.
func (e *extension) DeployAfterKubeAPIServer(ctx context.Context) error {
fns := e.forEach(func(ctx context.Context, ext *extensionsv1alpha1.Extension, extType string, providerConfig *runtime.RawExtension, _ time.Duration) error {
_, err := e.deploy(ctx, ext, extType, providerConfig, v1beta1constants.GardenerOperationReconcile)
return err
}, deployAfterKubeAPIServer)
return flow.Parallel(fns...)(ctx)
}
// DeployBeforeKubeAPIServer uses the seed client to create or update the Extension resources that should be deployed before the kube-apiserver.
func (e *extension) DeployBeforeKubeAPIServer(ctx context.Context) error {
fns := e.forEach(func(ctx context.Context, ext *extensionsv1alpha1.Extension, extType string, providerConfig *runtime.RawExtension, _ time.Duration) error {
_, err := e.deploy(ctx, ext, extType, providerConfig, v1beta1constants.GardenerOperationReconcile)
return err
}, deployBeforeKubeAPIServer)
return flow.Parallel(fns...)(ctx)
}
func (e *extension) deploy(ctx context.Context, ext *extensionsv1alpha1.Extension, extType string, providerConfig *runtime.RawExtension, operation string) (extensionsv1alpha1.Object, error) {
_, err := controllerutils.GetAndCreateOrMergePatch(ctx, e.client, ext, func() error {
metav1.SetMetaDataAnnotation(&ext.ObjectMeta, v1beta1constants.GardenerOperation, operation)
metav1.SetMetaDataAnnotation(&ext.ObjectMeta, v1beta1constants.GardenerTimestamp, TimeNow().UTC().Format(time.RFC3339Nano))
ext.Spec.Type = extType
ext.Spec.ProviderConfig = providerConfig
return nil
})
return ext, err
}
// DestroyBeforeKubeAPIServer deletes all Extension resources that should be handled before the kube-apiserver.
func (e *extension) DestroyBeforeKubeAPIServer(ctx context.Context) error {
extensionsBeforeKAPI := e.filterExtensions(deleteBeforeKubeAPIServer)
return e.deleteExtensionResources(ctx, func(obj extensionsv1alpha1.Object) bool {
return extensionsBeforeKAPI.Has(obj.GetExtensionSpec().GetExtensionType())
})
}
// DestroyAfterKubeAPIServer deletes all Extension resources that should be handled after the kube-apiserver.
func (e *extension) DestroyAfterKubeAPIServer(ctx context.Context) error {
extensionsAfterKAPI := e.filterExtensions(deleteAfterKubeAPIServer)
return e.deleteExtensionResources(ctx, func(obj extensionsv1alpha1.Object) bool {
return extensionsAfterKAPI.Has(obj.GetExtensionSpec().GetExtensionType())
})
}
// WaitAfterKubeAPIServer waits until the Extension resources that should be deployed after the kube-apiserver are ready.
func (e *extension) WaitAfterKubeAPIServer(ctx context.Context) error {
fns := e.forEach(func(ctx context.Context, ext *extensionsv1alpha1.Extension, _ string, _ *runtime.RawExtension, timeout time.Duration) error {
return extensions.WaitUntilExtensionObjectReady(
ctx,
e.client,
e.log,
ext,
extensionsv1alpha1.ExtensionResource,
e.waitInterval,
e.waitSevereThreshold,
timeout,
nil,
)
}, deployAfterKubeAPIServer)
return flow.ParallelExitOnError(fns...)(ctx)
}
// Wait waits until the Extension resources that should be deployed before the kube-apiserver are ready.
func (e *extension) WaitBeforeKubeAPIServer(ctx context.Context) error {
fns := e.forEach(func(ctx context.Context, ext *extensionsv1alpha1.Extension, _ string, _ *runtime.RawExtension, timeout time.Duration) error {
return extensions.WaitUntilExtensionObjectReady(
ctx,
e.client,
e.log,
ext,
extensionsv1alpha1.ExtensionResource,
e.waitInterval,
e.waitSevereThreshold,
timeout,
nil,
)
}, deployBeforeKubeAPIServer)
return flow.ParallelExitOnError(fns...)(ctx)
}
// WaitCleanup waits until the Extension resources are cleaned up.
func (e *extension) WaitCleanup(ctx context.Context) error {
return e.waitCleanup(ctx, nil)
}
// WaitCleanupBeforeKubeAPIServer waits until all Extension resources that are handled before the kube-apiserver are cleaned up.
func (e *extension) WaitCleanupBeforeKubeAPIServer(ctx context.Context) error {
extensionsBeforeKAPI := e.filterExtensions(deleteBeforeKubeAPIServer)
return e.waitCleanup(ctx, func(obj extensionsv1alpha1.Object) bool {
return extensionsBeforeKAPI.Has(obj.GetExtensionSpec().GetExtensionType())
})
}
// WaitCleanupAfterKubeAPIServer waits until all Extension resources that are handled after the kube-apiserver are cleaned up.
func (e *extension) WaitCleanupAfterKubeAPIServer(ctx context.Context) error {
extensionsAfterKAPI := e.filterExtensions(deleteAfterKubeAPIServer)
return e.waitCleanup(ctx, func(obj extensionsv1alpha1.Object) bool {
return extensionsAfterKAPI.Has(obj.GetExtensionSpec().GetExtensionType())
})
}
// RestoreAfterKubeAPIServer uses the seed client and the ShootState to create the Extension resources that should be deployed after the kube-apiserver and restore their state.
func (e *extension) RestoreAfterKubeAPIServer(ctx context.Context, shootState *gardencorev1beta1.ShootState) error {
fns := e.forEach(func(ctx context.Context, ext *extensionsv1alpha1.Extension, extType string, providerConfig *runtime.RawExtension, _ time.Duration) error {
return extensions.RestoreExtensionWithDeployFunction(
ctx,
e.client,
shootState,
extensionsv1alpha1.ExtensionResource,
func(ctx context.Context, operationAnnotation string) (extensionsv1alpha1.Object, error) {
return e.deploy(ctx, ext, extType, providerConfig, operationAnnotation)
},
)
}, deployAfterKubeAPIServer)
return flow.Parallel(fns...)(ctx)
}
// Restore uses the seed client and the ShootState to create the Extension resources that should be deployed before the kube-apiserver and restore their state.
func (e *extension) RestoreBeforeKubeAPIServer(ctx context.Context, shootState *gardencorev1beta1.ShootState) error {
fns := e.forEach(func(ctx context.Context, ext *extensionsv1alpha1.Extension, extType string, providerConfig *runtime.RawExtension, _ time.Duration) error {
return extensions.RestoreExtensionWithDeployFunction(
ctx,
e.client,
shootState,
extensionsv1alpha1.ExtensionResource,
func(ctx context.Context, operationAnnotation string) (extensionsv1alpha1.Object, error) {
return e.deploy(ctx, ext, extType, providerConfig, operationAnnotation)
},
)
}, deployBeforeKubeAPIServer)
return flow.Parallel(fns...)(ctx)
}
// MigrateBeforeKubeAPIServer migrates all Extension resources that should be handled before the kube-apiserver.
func (e *extension) MigrateBeforeKubeAPIServer(ctx context.Context) error {
extensionsBeforeKAPI := e.filterExtensions(migrateBeforeKubeAPIServer)
return extensions.MigrateExtensionObjects(
ctx,
e.client,
&extensionsv1alpha1.ExtensionList{},
e.values.Namespace,
func(obj extensionsv1alpha1.Object) bool {
return extensionsBeforeKAPI.Has(obj.GetExtensionSpec().GetExtensionType())
},
)
}
// WaitMigrateBeforeKubeAPIServer waits until all Extension resources that should be handled before the kube-apiserver are migrated.
func (e *extension) WaitMigrateBeforeKubeAPIServer(ctx context.Context) error {
extensionsBeforeKAPI := e.filterExtensions(migrateBeforeKubeAPIServer)
return extensions.WaitUntilExtensionObjectsMigrated(
ctx,
e.client,
&extensionsv1alpha1.ExtensionList{},
extensionsv1alpha1.ExtensionResource,
e.values.Namespace,
e.waitInterval,
e.waitTimeout,
func(obj extensionsv1alpha1.Object) bool {
return extensionsBeforeKAPI.Has(obj.GetExtensionSpec().GetExtensionType())
},
)
}
// MigrateAfterKubeAPIServer migrates all Extension resources that should be handled after the kube-apiserver.
func (e *extension) MigrateAfterKubeAPIServer(ctx context.Context) error {
extensionsAfterKAPI := e.filterExtensions(migrateAfterKubeAPIServer)
return extensions.MigrateExtensionObjects(
ctx,
e.client,
&extensionsv1alpha1.ExtensionList{},
e.values.Namespace,
func(obj extensionsv1alpha1.Object) bool {
return extensionsAfterKAPI.Has(obj.GetExtensionSpec().GetExtensionType())
},
)
}
// WaitMigrateAfterKubeAPIServer waits until all Extension resources that should be handled after the kube-apiserver are migrated.
func (e *extension) WaitMigrateAfterKubeAPIServer(ctx context.Context) error {
extensionsAfterKAPI := e.filterExtensions(migrateAfterKubeAPIServer)
return extensions.WaitUntilExtensionObjectsMigrated(
ctx,
e.client,
&extensionsv1alpha1.ExtensionList{},
extensionsv1alpha1.ExtensionResource,
e.values.Namespace,
e.waitInterval,
e.waitTimeout,
func(obj extensionsv1alpha1.Object) bool {
return extensionsAfterKAPI.Has(obj.GetExtensionSpec().GetExtensionType())
},
)
}
// DeleteStaleResources deletes unused Extension resources from the shoot namespace in the seed.
func (e *extension) DeleteStaleResources(ctx context.Context) error {
wantedExtensionTypes := e.getWantedExtensionTypes()
return e.deleteExtensionResources(ctx, func(obj extensionsv1alpha1.Object) bool {
return !wantedExtensionTypes.Has(obj.GetExtensionSpec().GetExtensionType())
})
}
// WaitCleanupStaleResources waits until all unused Extension resources are cleaned up.
func (e *extension) WaitCleanupStaleResources(ctx context.Context) error {
wantedExtensionTypes := e.getWantedExtensionTypes()
return e.waitCleanup(ctx, func(obj extensionsv1alpha1.Object) bool {
return !wantedExtensionTypes.Has(obj.GetExtensionSpec().GetExtensionType())
})
}
func (e *extension) deleteExtensionResources(ctx context.Context, predicate func(obj extensionsv1alpha1.Object) bool) error {
return extensions.DeleteExtensionObjects(
ctx,
e.client,
&extensionsv1alpha1.ExtensionList{},
e.values.Namespace,
predicate,
)
}
func (e *extension) waitCleanup(ctx context.Context, predicate func(obj extensionsv1alpha1.Object) bool) error {
return extensions.WaitUntilExtensionObjectsDeleted(
ctx,
e.client,
e.log,
&extensionsv1alpha1.ExtensionList{},
extensionsv1alpha1.ExtensionResource,
e.values.Namespace,
e.waitInterval,
e.waitTimeout,
predicate,
)
}
// getWantedExtensionTypes returns the types of all extension resources, that are currently needed based
// on the configured shoot settings and globally enabled extensions.
func (e *extension) getWantedExtensionTypes() sets.Set[string] {
wantedExtensionTypes := sets.New[string]()
for _, ext := range e.values.Extensions {
wantedExtensionTypes.Insert(ext.Spec.Type)
}
return wantedExtensionTypes
}
func (e *extension) forEach(
fn func(ctx context.Context, ext *extensionsv1alpha1.Extension, extType string, providerConfig *runtime.RawExtension, timeout time.Duration) error,
f filter,
) []flow.TaskFn {
fns := make([]flow.TaskFn, 0, len(e.values.Extensions))
for _, ext := range e.values.Extensions {
if !f(ext) {
continue
}
extensionTemplate := ext
extensionObj, ok := e.extensions[extensionTemplate.Name]
if !ok {
extensionObj = &extensionsv1alpha1.Extension{
ObjectMeta: metav1.ObjectMeta{
Name: extensionTemplate.Name,
Namespace: e.values.Namespace,
},
}
// store object for later usage (we want to pass a filled object to WaitUntil*)
e.extensions[extensionTemplate.Name] = extensionObj
}
fns = append(fns, func(ctx context.Context) error {
return fn(ctx, extensionObj, extensionTemplate.Spec.Type, extensionTemplate.Spec.ProviderConfig, extensionTemplate.Timeout)
})
}
return fns
}
// Extensions returns the map of extensions where the key is the type and the value is an Extension structure.
func (e *extension) Extensions() map[string]Extension {
return e.values.Extensions
}