forked from cisco-open/operator-tools
/
native.go
552 lines (485 loc) · 16.2 KB
/
native.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
// Copyright © 2020 Banzai Cloud
//
// 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 reconciler
import (
"context"
"strings"
"emperror.dev/errors"
"github.com/banzaicloud/operator-tools/pkg/resources"
"github.com/banzaicloud/operator-tools/pkg/wait"
"github.com/go-logr/logr"
corev1 "k8s.io/api/core/v1"
v1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
"k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1beta1"
k8serrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
apimeta "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/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
clientgoscheme "k8s.io/client-go/kubernetes/scheme"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"github.com/banzaicloud/operator-tools/pkg/types"
"github.com/banzaicloud/operator-tools/pkg/utils"
)
type ResourceOwner interface {
// to be aware of metadata
metav1.Object
// to be aware of the owner's type
runtime.Object
}
type ResourceOwnerWithControlNamespace interface {
ResourceOwner
// control namespace dictates where namespaced objects should belong to
GetControlNamespace() string
}
type ResourceBuilders func(parent ResourceOwner, object interface{}) []ResourceBuilder
type ResourceBuilder func() (runtime.Object, DesiredState, error)
type ResourceTranslate func(runtime.Object) (parent ResourceOwner, config interface{})
type PurgeTypesFunc func() []schema.GroupVersionKind
func GetResourceBuildersFromObjects(objects []runtime.Object, state DesiredState, modifierFuncs ...resources.ObjectModifierFunc) ([]ResourceBuilder, error) {
resources := []ResourceBuilder{}
utils.RuntimeObjects(objects).Sort(utils.InstallResourceOrder)
for _, o := range objects {
o := o
for _, modifierFunc := range modifierFuncs {
var err error
o, err = modifierFunc(o)
if err != nil {
return nil, err
}
}
resources = append(resources, func() (runtime.Object, DesiredState, error) {
if desired, ok := o.(*corev1.Service); ok {
beforeUpdateHook := DesiredStateHook(func(current runtime.Object) error {
if s, ok := current.(*corev1.Service); ok {
desired.Spec.ClusterIP = s.Spec.ClusterIP
} else {
return errors.Errorf("failed to cast service object %+v", current)
}
return nil
})
return o, beforeUpdateHook, nil
}
return o, state, nil
})
}
return resources, nil
}
type NativeReconciledComponent interface {
ResourceBuilders(parent ResourceOwner, object interface{}) []ResourceBuilder
RegisterWatches(*builder.Builder)
PurgeTypes() []schema.GroupVersionKind
}
type DefaultReconciledComponent struct {
builders ResourceBuilders
watches func(b *builder.Builder)
purgeTypes func() []schema.GroupVersionKind
}
func NewReconciledComponent(b ResourceBuilders, w func(b *builder.Builder), p func() []schema.GroupVersionKind) NativeReconciledComponent {
if p == nil {
p = func() []schema.GroupVersionKind {
return nil
}
}
if w == nil {
w = func(*builder.Builder) {}
}
return &DefaultReconciledComponent{
builders: b,
watches: w,
purgeTypes: p,
}
}
func (d *DefaultReconciledComponent) ResourceBuilders(parent ResourceOwner, object interface{}) []ResourceBuilder {
return d.builders(parent, object)
}
func (d *DefaultReconciledComponent) RegisterWatches(b *builder.Builder) {
if d.watches != nil {
d.watches(b)
}
}
func (d *DefaultReconciledComponent) PurgeTypes() []schema.GroupVersionKind {
return d.purgeTypes()
}
type NativeReconciler struct {
*GenericResourceReconciler
client.Client
scheme *runtime.Scheme
restMapper meta.RESTMapper
reconciledComponent NativeReconciledComponent
configTranslate ResourceTranslate
componentName string
setControllerRef bool
reconciledObjectStates map[reconciledObjectState][]runtime.Object
waitBackoff *wait.Backoff
objectModifiers []resources.ObjectModifierWithParentFunc
}
type NativeReconcilerOpt func(*NativeReconciler)
func NativeReconcilerWithScheme(scheme *runtime.Scheme) NativeReconcilerOpt {
return func(r *NativeReconciler) {
r.scheme = scheme
}
}
func NativeReconcilerSetControllerRef() NativeReconcilerOpt {
return func(r *NativeReconciler) {
r.setControllerRef = true
}
}
func NativeReconcilerSetRESTMapper(mapper meta.RESTMapper) NativeReconcilerOpt {
return func(r *NativeReconciler) {
r.restMapper = mapper
}
}
func NativeReconcilerWithWait(backoff *wait.Backoff) NativeReconcilerOpt {
return func(r *NativeReconciler) {
r.waitBackoff = backoff
}
}
func NativeReconcilerWithModifier(modifierFunc resources.ObjectModifierWithParentFunc) NativeReconcilerOpt {
return func(r *NativeReconciler) {
r.objectModifiers = append(r.objectModifiers, modifierFunc)
}
}
func NewNativeReconcilerWithDefaults(
component string,
client client.Client,
scheme *runtime.Scheme,
logger logr.Logger,
resourceBuilders ResourceBuilders,
purgeTypes PurgeTypesFunc,
resourceTranslate ResourceTranslate,
opts ...NativeReconcilerOpt,
) *NativeReconciler {
reconcilerOpts := &ReconcilerOpts{
EnableRecreateWorkloadOnImmutableFieldChange: true,
Scheme: scheme,
}
return NewNativeReconciler(
component,
NewGenericReconciler(
client,
logger,
*reconcilerOpts,
),
client,
NewReconciledComponent(
resourceBuilders,
nil,
purgeTypes,
),
resourceTranslate,
opts...,
)
}
func NewNativeReconciler(
componentName string,
rec *GenericResourceReconciler,
client client.Client,
reconciledComponent NativeReconciledComponent,
resourceTranslate func(runtime.Object) (parent ResourceOwner, config interface{}),
opts ...NativeReconcilerOpt) *NativeReconciler {
reconciler := &NativeReconciler{
GenericResourceReconciler: rec,
Client: client,
reconciledComponent: reconciledComponent,
configTranslate: resourceTranslate,
componentName: componentName,
}
reconciler.initReconciledObjectStates()
for _, opt := range opts {
opt(reconciler)
}
if reconciler.scheme == nil {
reconciler.scheme = runtime.NewScheme()
_ = clientgoscheme.AddToScheme(reconciler.scheme)
}
return reconciler
}
func (rec *NativeReconciler) Reconcile(owner runtime.Object) (*reconcile.Result, error) {
if rec.componentName == "" {
return nil, errors.New("component name cannot be empty")
}
componentID, ownerMeta, err := rec.generateComponentID(owner)
if err != nil {
return nil, err
}
// visited objects wont be purged
excludeFromPurge := map[string]bool{}
combinedResult := &CombinedResult{}
LOOP:
for _, r := range rec.reconciledComponent.ResourceBuilders(rec.configTranslate(owner)) {
o, state, err := r()
if err != nil {
combinedResult.CombineErr(err)
} else if o == nil || state == nil {
rec.Log.Info("skipping resource builder reconciliation due to object or desired state was nil")
continue
} else {
var objectMeta metav1.Object
objectMeta, err = rec.addComponentIDAnnotation(o, componentID)
if err != nil {
combinedResult.CombineErr(err)
continue
}
rec.addRelatedToAnnotation(objectMeta, ownerMeta)
if rec.setControllerRef {
skipControllerRef := false
switch o.(type) {
case *v1beta1.CustomResourceDefinition:
skipControllerRef = true
case *v1.CustomResourceDefinition:
skipControllerRef = true
case *corev1.Namespace:
skipControllerRef = true
}
if !skipControllerRef {
// namespaced resource can only own resources in the same namespace
if ownerMeta.GetNamespace() == "" || ownerMeta.GetNamespace() == objectMeta.GetNamespace() {
if err := controllerutil.SetControllerReference(ownerMeta, objectMeta, rec.scheme); err != nil {
combinedResult.CombineErr(err)
continue
}
}
}
}
if len(rec.objectModifiers) > 0 {
for _, om := range rec.objectModifiers {
o, err = om(o, owner)
if err != nil {
combinedResult.CombineErr(errors.WrapIf(err, "unable to apply object modifier"))
continue LOOP
}
}
}
var result *reconcile.Result
result, err = rec.ReconcileResource(o, state)
if err == nil {
resourceID, err := rec.generateResourceID(o)
if err != nil {
combinedResult.CombineErr(err)
continue
}
excludeFromPurge[resourceID] = true
s := ReconciledObjectStatePresent
if state == StateAbsent {
s = ReconciledObjectStateAbsent
}
rec.addReconciledObjectState(s, o.DeepCopyObject())
}
combinedResult.Combine(result, err)
}
}
if combinedResult.Err == nil {
if err := rec.purge(excludeFromPurge, componentID); err != nil {
combinedResult.CombineErr(err)
}
} else {
rec.Log.Error(combinedResult.Err, "skip purging results due to previous errors")
}
if rec.waitBackoff != nil {
if err := rec.waitForResources(*rec.waitBackoff); err != nil {
combinedResult.CombineErr(err)
}
}
return &combinedResult.Result, combinedResult.Err
}
func (rec *NativeReconciler) generateComponentID(owner runtime.Object) (string, metav1.Object, error) {
ownerMeta, err := meta.Accessor(owner)
if err != nil {
return "", nil, errors.WrapIf(err, "failed to access owner object meta")
}
// generated componentId will be used to purge unwanted objects
identifiers := []string{}
if ownerMeta.GetName() == "" {
return "", nil, errors.New("unable to generate component id for resource without a name")
}
identifiers = append(identifiers, ownerMeta.GetName())
if ownerMeta.GetNamespace() != "" {
identifiers = append(identifiers, ownerMeta.GetNamespace())
}
if rec.componentName == "" {
return "", nil, errors.New("unable to generate component id without a component name")
}
identifiers = append(identifiers, rec.componentName)
gvk, err := apiutil.GVKForObject(owner, rec.scheme)
if err != nil {
return "", nil, errors.WrapIf(err, "")
}
apiVersion, kind := gvk.ToAPIVersionAndKind()
identifiers = append(identifiers, apiVersion, strings.ToLower(kind))
return strings.Join(identifiers, "-"), ownerMeta, nil
}
func (rec *NativeReconciler) generateResourceID(resource runtime.Object) (string, error) {
resourceMeta, err := meta.Accessor(resource)
if err != nil {
return "", errors.WrapIf(err, "failed to access owner object meta")
}
// generated componentId will be used to purge unwanted objects
identifiers := []string{}
if resourceMeta.GetName() == "" {
return "", errors.New("unable to generate component id for resource without a name")
}
identifiers = append(identifiers, resourceMeta.GetName())
if resourceMeta.GetNamespace() != "" {
identifiers = append(identifiers, resourceMeta.GetNamespace())
}
gvk, err := apiutil.GVKForObject(resource, rec.scheme)
if err != nil {
return "", errors.WrapIf(err, "")
}
apiVersion, kind := gvk.ToAPIVersionAndKind()
identifiers = append(identifiers, apiVersion, strings.ToLower(kind))
return strings.Join(identifiers, "-"), nil
}
func (rec *NativeReconciler) gvkExists(gvk schema.GroupVersionKind) bool {
if rec.restMapper == nil {
return true
}
mappings, err := rec.restMapper.RESTMappings(gvk.GroupKind(), gvk.Version)
if apimeta.IsNoMatchError(err) {
return false
}
if err != nil {
return true
}
for _, m := range mappings {
if gvk == m.GroupVersionKind {
return true
}
}
return false
}
func (rec *NativeReconciler) purge(excluded map[string]bool, componentId string) error {
var allErr error
var purgeObjects []runtime.Object
for _, gvk := range rec.reconciledComponent.PurgeTypes() {
rec.Log.V(2).Info("purging GVK", "gvk", gvk)
if !rec.gvkExists(gvk) {
continue
}
objects := &unstructured.UnstructuredList{}
objects.SetGroupVersionKind(gvk)
err := rec.List(context.TODO(), objects)
if apimeta.IsNoMatchError(err) {
// skip unknown GVKs
continue
}
if err != nil {
rec.Log.Error(err, "failed list objects to prune",
"groupversion", gvk.GroupVersion().String(),
"kind", gvk.Kind)
continue
}
for _, o := range objects.Items {
objectMeta, err := meta.Accessor(&o)
if err != nil {
allErr = errors.Combine(allErr, errors.WrapIf(err, "failed to get object metadata"))
continue
}
resourceID, err := rec.generateResourceID(&o)
if err != nil {
allErr = errors.Combine(allErr, err)
continue
}
if excluded[resourceID] {
continue
}
if objectMeta.GetAnnotations()[types.BanzaiCloudManagedComponent] == componentId {
rec.Log.Info("will prune unmmanaged resource",
"name", objectMeta.GetName(),
"namespace", objectMeta.GetNamespace(),
"group", gvk.Group,
"version", gvk.Version,
"listKind", gvk.Kind)
purgeObjects = append(purgeObjects, o.DeepCopyObject())
}
}
}
utils.RuntimeObjects(purgeObjects).Sort(utils.UninstallResourceOrder)
for _, o := range purgeObjects {
if err := rec.Client.Delete(context.TODO(), o.(client.Object)); err != nil && !k8serrors.IsNotFound(err) {
allErr = errors.Combine(allErr, err)
} else {
rec.addReconciledObjectState(ReconciledObjectStatePurged, o.DeepCopyObject())
}
}
return allErr
}
type reconciledObjectState string
const (
ReconciledObjectStateAbsent reconciledObjectState = "Absent"
ReconciledObjectStatePresent reconciledObjectState = "Present"
ReconciledObjectStatePurged reconciledObjectState = "Purged"
)
func (rec *NativeReconciler) initReconciledObjectStates() {
rec.reconciledObjectStates = make(map[reconciledObjectState][]runtime.Object)
}
func (rec *NativeReconciler) addReconciledObjectState(state reconciledObjectState, o runtime.Object) {
rec.reconciledObjectStates[state] = append(rec.reconciledObjectStates[state], o)
}
func (rec *NativeReconciler) GetReconciledObjectWithState(state reconciledObjectState) []runtime.Object {
return rec.reconciledObjectStates[state]
}
func (rec *NativeReconciler) addRelatedToAnnotation(objectMeta, ownerMeta metav1.Object) {
annotations := objectMeta.GetAnnotations()
if annotations == nil {
annotations = make(map[string]string)
}
annotations[types.BanzaiCloudRelatedTo] = utils.ObjectKeyFromObjectMeta(ownerMeta).String()
objectMeta.SetAnnotations(annotations)
}
func (rec *NativeReconciler) addComponentIDAnnotation(o runtime.Object, componentId string) (metav1.Object, error) {
objectMeta, err := meta.Accessor(o)
if err != nil {
return nil, errors.Wrapf(err, "failed to access object metadata")
}
annotations := objectMeta.GetAnnotations()
if annotations == nil {
annotations = make(map[string]string)
}
if currentComponentId, ok := annotations[types.BanzaiCloudManagedComponent]; ok {
if currentComponentId != componentId {
return nil, errors.Errorf(
"object actual component id `%s` is different from the one defined by the component `%s`",
currentComponentId, componentId)
}
} else {
annotations[types.BanzaiCloudManagedComponent] = componentId
objectMeta.SetAnnotations(annotations)
}
return objectMeta, nil
}
func (rec *NativeReconciler) RegisterWatches(b *builder.Builder) {
rec.reconciledComponent.RegisterWatches(b)
}
func (rec *NativeReconciler) waitForResources(backoff wait.Backoff) error {
rcc := wait.NewResourceConditionChecks(rec.Client, backoff, rec.Log, rec.scheme)
presentObjects := rec.GetReconciledObjectWithState(ReconciledObjectStatePresent)
err := rcc.WaitForResources("readiness", presentObjects, wait.ExistsConditionCheck, wait.ReadyReplicasConditionCheck)
if err != nil {
return err
}
absentObjects := append(rec.GetReconciledObjectWithState(ReconciledObjectStateAbsent), rec.GetReconciledObjectWithState(ReconciledObjectStatePurged)...)
err = rcc.WaitForResources("removal", absentObjects, wait.NonExistsConditionCheck)
if err != nil {
return err
}
return nil
}