-
Notifications
You must be signed in to change notification settings - Fork 4
/
feature_controller.go
510 lines (453 loc) · 14.4 KB
/
feature_controller.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
/*
Copyright AppsCode Inc. and Contributors.
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 feature
import (
"context"
"fmt"
fluxhelm "github.com/fluxcd/helm-controller/api/v2"
"github.com/go-logr/logr"
"gomodules.xyz/pointer"
kerr "k8s.io/apimachinery/pkg/api/errors"
"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/fields"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/types"
cu "kmodules.xyz/client-go/client"
meta_util "kmodules.xyz/client-go/meta"
uiapi "kmodules.xyz/resource-metadata/apis/ui/v1alpha1"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)
// FeatureReconciler reconciles a Feature object
type FeatureReconciler struct {
client.Client
Scheme *runtime.Scheme
APIReader client.Reader
}
const (
featureSetReferencePath = ".spec.featureSet"
)
type frReconciler struct {
client client.Client
apiReader client.Reader
logger logr.Logger
feature *uiapi.Feature
}
// Reconcile is part of the main kubernetes reconciliation loop which aims to
// move the current state of the cluster closer to the desired state.
// For more details, check Reconcile and its Result here:
// - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.13.1/pkg/reconcile
func (r *FeatureReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
logger := log.FromContext(ctx)
logger.Info("Reconciling......")
f := &uiapi.Feature{}
err := r.Get(ctx, req.NamespacedName, f)
if err != nil {
return ctrl.Result{}, client.IgnoreNotFound(err)
}
fr := frReconciler{
client: r.Client,
apiReader: r.APIReader,
logger: logger,
feature: f,
}
if fr.feature.DeletionTimestamp != nil {
err = fr.updateFeatureSetAndRemoveFinalizer(ctx)
if err != nil && kerr.IsNotFound(err) {
return ctrl.Result{}, err
}
return ctrl.Result{}, nil
}
err = fr.reconcile(ctx)
if err != nil && !kerr.IsNotFound(err) {
logger.Error(err, "failed to reconcile")
return ctrl.Result{}, nil
}
if err = fr.updateStatus(ctx); err != nil {
return ctrl.Result{}, err
}
err = fr.updateFeatureSetEntry(ctx)
if err != nil && !kerr.IsNotFound(err) {
return ctrl.Result{}, err
}
if err = fr.updateAllFeatureSetDependencies(ctx); err != nil {
return ctrl.Result{}, err
}
// We need to requeue the Feature periodically so that it works with third party resources.
// Here, we are requeueing every Feature after a random interval between 30s to 150s so that
// all Features do not get requeued at the same time.
requeueInterval := getRandomInterval()
fr.logger.Info(fmt.Sprintf("Requeuing after %v", requeueInterval.String()))
return ctrl.Result{RequeueAfter: requeueInterval}, nil
}
func (r *frReconciler) reconcile(ctx context.Context) error {
if err := r.ensureFinalizer(ctx); err != nil {
return err
}
r.resetFeatureStatus()
status, err := r.evaluateStatus(ctx)
if err != nil {
r.feature.Status.Note = err.Error()
r.logger.Error(err, "Failed to evaluate Feature status")
return nil
}
enabled, err := r.isFeatureEnabled(ctx, status)
if err != nil {
return err
}
if !enabled {
r.feature.Status.Enabled = pointer.BoolP(false)
return nil
}
r.feature.Status.Enabled = pointer.BoolP(true)
if !status.managed {
r.feature.Status.Managed = pointer.BoolP(false)
r.feature.Status.Note = "Feature is not managed by the UI"
if status.workload != nil {
r.feature.Status.Ready = &status.workload.ready
r.feature.Status.Note = status.workload.reason
}
return nil
}
r.feature.Status.Managed = pointer.BoolP(true)
ready, reason := r.isFeatureReady(status)
if !ready {
r.feature.Status.Ready = pointer.BoolP(false)
r.feature.Status.Note = reason
return nil
}
r.feature.Status.Ready = pointer.BoolP(true)
return nil
}
func (r *frReconciler) ensureFinalizer(ctx context.Context) error {
if changed := controllerutil.AddFinalizer(r.feature, uiapi.UIServerCleanupFinalizer); changed {
_, err := cu.CreateOrPatch(ctx, r.client, r.feature.DeepCopy(), func(obj client.Object, createOp bool) client.Object {
in := obj.(*uiapi.Feature)
in.ObjectMeta.Finalizers = r.feature.Finalizers
return in
})
return err
}
return nil
}
type featureStatus struct {
managed bool
dependency *requirementStatus
resources *requirementStatus
workload *requirementStatus
release *requirementStatus
}
type requirementStatus struct {
found bool
ready bool
reason string
}
func (r *frReconciler) evaluateStatus(ctx context.Context) (featureStatus, error) {
var status featureStatus
var err error
if len(r.feature.Spec.ReadinessChecks.Resources) != 0 {
satisfied, reason, err := r.checkRequiredResourcesExistence(ctx)
if err != nil {
return status, err
}
status.resources = &requirementStatus{
found: satisfied,
}
if !satisfied {
status.resources.reason = reason
}
}
if len(r.feature.Spec.ReadinessChecks.Workloads) != 0 {
status.workload, err = r.checkRequiredWorkloadExistence(ctx)
if err != nil {
return status, err
}
}
if len(r.feature.Spec.Requirements.Features) != 0 {
status.dependency, err = r.checkDependencyExistence(ctx)
if err != nil {
return status, err
}
}
release, err := r.getHelmRelease(ctx)
if err != nil {
if kerr.IsNotFound(err) {
status.managed = false
return status, nil
}
return status, err
}
status.release = &requirementStatus{
found: true,
}
status.release.ready = meta_util.IsConditionTrue(release.Status.Conditions, "Ready")
if metav1.HasLabel(release.ObjectMeta, meta_util.ComponentLabelKey) && release.Labels[meta_util.ComponentLabelKey] == r.feature.Name &&
metav1.HasLabel(release.ObjectMeta, meta_util.PartOfLabelKey) && release.Labels[meta_util.PartOfLabelKey] == r.feature.Spec.FeatureSet {
status.managed = true
}
return status, nil
}
func (r *frReconciler) resetFeatureStatus() {
r.feature.Status = uiapi.FeatureStatus{}
}
func (r *frReconciler) getHelmRelease(ctx context.Context) (fluxhelm.HelmRelease, error) {
selector := labels.SelectorFromSet(map[string]string{
meta_util.ComponentLabelKey: r.feature.Name,
meta_util.PartOfLabelKey: r.feature.Spec.FeatureSet,
})
releases := &fluxhelm.HelmReleaseList{}
err := r.client.List(ctx, releases, &client.ListOptions{LabelSelector: selector})
if err != nil {
return fluxhelm.HelmRelease{}, err
}
if len(releases.Items) > 0 {
return releases.Items[0], nil
}
return fluxhelm.HelmRelease{}, kerr.NewNotFound(schema.GroupResource{
Group: fluxhelm.GroupVersion.Group,
Resource: "helmreleases",
}, r.feature.Name)
}
func (r *frReconciler) isFeatureEnabled(ctx context.Context, status featureStatus) (bool, error) {
_, err := r.getHelmRelease(ctx)
if err != nil {
if kerr.IsNotFound(err) {
status.managed = false
return isRequiredResourcesExist(status) && isWorkloadOrReleaseExist(status), nil
}
return false, err
}
return true, nil
}
func (r *frReconciler) isFeatureReady(status featureStatus) (bool, string) {
if status.dependency != nil && !status.dependency.found {
return false, status.dependency.reason
}
if status.workload != nil && !status.workload.found {
return false, status.workload.reason
}
if status.release != nil && status.release.found && !status.release.ready {
return false, "Respective HelmRelease is not ready"
}
return true, ""
}
func (r *frReconciler) checkDependencyExistence(ctx context.Context) (*requirementStatus, error) {
status := &requirementStatus{}
for _, d := range r.feature.Spec.Requirements.Features {
f := &uiapi.Feature{}
if err := r.client.Get(ctx, types.NamespacedName{Name: d}, f); err != nil {
if kerr.IsNotFound(err) {
status.reason = fmt.Sprintf("Dependency not satisfied. Feature %q does not exist.", d)
return status, nil
}
return nil, err
}
if f.Status.Enabled == nil || !*f.Status.Enabled {
status.reason = fmt.Sprintf("Dependency not satisfied. Feature %q is not enabled.", d)
return status, nil
}
}
status.found = true
return status, nil
}
func (r *frReconciler) checkRequiredResourcesExistence(ctx context.Context) (bool, string, error) {
for _, gvk := range r.feature.Spec.ReadinessChecks.Resources {
objList := unstructured.UnstructuredList{}
objList.SetGroupVersionKind(schema.GroupVersionKind{
Group: gvk.Group,
Version: gvk.Version,
Kind: gvk.Kind,
})
if err := r.apiReader.List(ctx, &objList, &client.ListOptions{Limit: 1}); err != nil {
if meta.IsNoMatchError(err) {
return false, fmt.Sprintf("Required resource %q is not registered.", gvk.String()), err
}
return false, "", err
}
}
return true, "", nil
}
func (r *frReconciler) checkRequiredWorkloadExistence(ctx context.Context) (*requirementStatus, error) {
status := &requirementStatus{}
for _, w := range r.feature.Spec.ReadinessChecks.Workloads {
objList := unstructured.UnstructuredList{}
objList.SetGroupVersionKind(schema.GroupVersionKind{
Group: w.Group,
Version: w.Version,
Kind: w.Kind,
})
selector := labels.SelectorFromSet(w.Selector)
if err := r.apiReader.List(ctx, &objList, &client.ListOptions{Limit: 1, LabelSelector: selector}); err != nil {
if meta.IsNoMatchError(err) {
status.reason = fmt.Sprintf("Required resource %q is not registered.", w.String())
return status, nil
}
return nil, err
}
if len(objList.Items) == 0 {
status.reason = "Required workload does not exist"
return status, nil
}
if !isWorkLoadsReady(objList) {
status.found = true
status.reason = "Required workload is not ready"
return status, nil
}
}
status.ready = true
status.found = true
return status, nil
}
func (r *frReconciler) updateFeatureSetAndRemoveFinalizer(ctx context.Context) error {
if err := r.updateFeatureSetEntry(ctx); err != nil {
if !kerr.IsNotFound(err) {
return err
}
}
if changed := controllerutil.RemoveFinalizer(r.feature, uiapi.UIServerCleanupFinalizer); changed {
_, err := cu.CreateOrPatch(ctx, r.client, r.feature.DeepCopy(), func(obj client.Object, createOp bool) client.Object {
in := obj.(*uiapi.Feature)
in.ObjectMeta.Finalizers = r.feature.Finalizers
return in
})
return err
}
return nil
}
func (r *frReconciler) updateFeatureSetEntry(ctx context.Context) error {
fs := &uiapi.FeatureSet{}
err := r.client.Get(ctx, types.NamespacedName{Name: r.feature.Spec.FeatureSet}, fs)
if err != nil {
return err
}
found := false
for i, f := range fs.Status.Features {
if f.Name == r.feature.Name {
fs.Status.Features[i].Enabled = r.feature.Status.Enabled
fs.Status.Features[i].Ready = r.feature.Status.Ready
fs.Status.Features[i].Managed = r.feature.Status.Managed
found = true
}
}
if !found {
fs.Status.Features = append(fs.Status.Features, uiapi.ComponentStatus{
Name: r.feature.Name,
Enabled: r.feature.Status.Enabled,
Ready: r.feature.Status.Ready,
Managed: r.feature.Status.Managed,
})
}
return r.updateFeatureSetStatus(ctx, fs)
}
func (r *frReconciler) updateFeatureSetStatus(ctx context.Context, fs *uiapi.FeatureSet) error {
fs.Status.Enabled = pointer.BoolP(true)
fs.Status.Ready = pointer.BoolP(true)
fs.Status.Note = ""
if !atLeastOneFeatureEnabled(fs.Status.Features) {
fs.Status.Enabled = pointer.BoolP(false)
fs.Status.Ready = nil
fs.Status.Note = "No feature enabled yet for this feature set."
}
ready, reason := allEnabledFeaturesReady(fs)
if !ready {
fs.Status.Ready = pointer.BoolP(false)
fs.Status.Note = reason
}
_, err := cu.PatchStatus(
ctx,
r.client,
fs.DeepCopy(),
func(obj client.Object) client.Object {
in := obj.(*uiapi.FeatureSet)
in.Status = fs.Status
return in
},
)
return client.IgnoreNotFound(err)
}
func (r *frReconciler) updateStatus(ctx context.Context) error {
_, err := cu.PatchStatus(
ctx,
r.client,
r.feature.DeepCopy(),
func(obj client.Object) client.Object {
in := obj.(*uiapi.Feature)
in.Status = r.feature.Status
return in
},
)
return client.IgnoreNotFound(err)
}
// SetupWithManager sets up the controller with the Manager.
func (r *FeatureReconciler) SetupWithManager(mgr ctrl.Manager) error {
err := mgr.GetFieldIndexer().IndexField(context.Background(), &uiapi.Feature{}, featureSetReferencePath, func(object client.Object) []string {
feature := object.(*uiapi.Feature)
return []string{feature.Spec.FeatureSet}
})
if err != nil {
return err
}
return ctrl.NewControllerManagedBy(mgr).
For(&uiapi.Feature{}).
Watches(
&uiapi.FeatureSet{},
handler.EnqueueRequestsFromMapFunc(r.findFeaturesForFeatureSet),
builder.WithPredicates(predicate.GenerationChangedPredicate{}),
).
Watches(
&fluxhelm.HelmRelease{},
handler.EnqueueRequestsFromMapFunc(r.findFeatureForHelmRelease),
).
Complete(r)
}
func (r *FeatureReconciler) findFeaturesForFeatureSet(ctx context.Context, featureSet client.Object) []reconcile.Request {
featureList := &uiapi.FeatureList{}
err := r.List(ctx, featureList, &client.ListOptions{
FieldSelector: fields.OneTermEqualSelector(featureSetReferencePath, featureSet.GetName()),
})
if err != nil {
return []reconcile.Request{}
}
requests := make([]reconcile.Request, len(featureList.Items))
for i := range featureList.Items {
requests[i] = reconcile.Request{
NamespacedName: types.NamespacedName{
Name: featureList.Items[i].Name,
},
}
}
return requests
}
func (r *FeatureReconciler) findFeatureForHelmRelease(ctx context.Context, release client.Object) []reconcile.Request {
featureName, err := meta_util.GetStringValueForKeys(release.GetLabels(), meta_util.ComponentLabelKey)
if err != nil {
return []reconcile.Request{}
}
return []reconcile.Request{
{
NamespacedName: types.NamespacedName{
Name: featureName,
},
},
}
}