-
Notifications
You must be signed in to change notification settings - Fork 21
Expand file tree
/
Copy pathredpanda_controller.go
More file actions
1113 lines (922 loc) · 38.6 KB
/
redpanda_controller.go
File metadata and controls
1113 lines (922 loc) · 38.6 KB
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
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2025 Redpanda Data, Inc.
//
// Use of this software is governed by the Business Source License
// included in the file licenses/BSL.md
//
// As of the Change Date specified in that file, in accordance with
// the Business Source License, use of this software will be governed
// by the Apache License, Version 2.0
// Package redpanda contains reconciliation logic for cluster.redpanda.com CRDs
package redpanda
import (
"context"
"crypto/sha256"
"encoding/base64"
"fmt"
"slices"
"sort"
"strings"
"time"
"github.com/cockroachdb/errors"
helmv2beta1 "github.com/fluxcd/helm-controller/api/v2beta1"
helmv2beta2 "github.com/fluxcd/helm-controller/api/v2beta2"
"github.com/fluxcd/pkg/apis/meta"
"github.com/fluxcd/pkg/runtime/logger"
sourcev1 "github.com/fluxcd/source-controller/api/v1beta2"
"github.com/redpanda-data/common-go/rpadmin"
appsv1 "k8s.io/api/apps/v1"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
apimeta "k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/client-go/rest"
kuberecorder "k8s.io/client-go/tools/record"
"k8s.io/utils/ptr"
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/predicate"
"sigs.k8s.io/yaml"
"github.com/redpanda-data/redpanda-operator/charts/redpanda/v5"
redpandav1alpha2 "github.com/redpanda-data/redpanda-operator/operator/api/redpanda/v1alpha2"
"github.com/redpanda-data/redpanda-operator/operator/cmd/syncclusterconfig"
internalclient "github.com/redpanda-data/redpanda-operator/operator/pkg/client"
"github.com/redpanda-data/redpanda-operator/operator/pkg/resources"
"github.com/redpanda-data/redpanda-operator/pkg/gotohelm/helmette"
"github.com/redpanda-data/redpanda-operator/pkg/kube"
)
const (
FinalizerKey = "operator.redpanda.com/finalizer"
FluxFinalizerKey = "finalizers.fluxcd.io"
NotManaged = "false"
resourceReadyStrFmt = "%s '%s/%s' is ready"
resourceNotReadyStrFmt = "%s '%s/%s' is not ready"
resourceTypeHelmRepository = "HelmRepository"
resourceTypeHelmRelease = "HelmRelease"
managedPath = "/managed"
revisionPath = "/revision"
componentLabelValue = "redpanda-statefulset"
)
type gvkKey struct {
GVK schema.GroupVersionKind
Key client.ObjectKey
}
// RedpandaReconciler reconciles a Redpanda object
type RedpandaReconciler struct {
// KubeConfig is the [kube.Config] that provides the go helm chart
// Kubernetes access. It should be the same config used to create client.
KubeConfig kube.Config
Client client.Client
Scheme *runtime.Scheme
EventRecorder kuberecorder.EventRecorder
ClientFactory internalclient.ClientFactory
DefaultDisableFlux bool
// HelmRepositorySpec.URL points to Redpanda helm repository where the following charts can be located:
// * Redpanda
// * Console
// * Connectors
// If not provided the v1alpha2.RedpandaChartRepository constant will be used.
HelmRepositoryURL string
}
// flux resources main resources
// +kubebuilder:rbac:groups=helm.toolkit.fluxcd.io,namespace=default,resources=helmreleases,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=helm.toolkit.fluxcd.io,namespace=default,resources=helmreleases/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=helm.toolkit.fluxcd.io,namespace=default,resources=helmreleases/finalizers,verbs=update
// +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,namespace=default,resources=helmcharts,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,namespace=default,resources=helmcharts/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,namespace=default,resources=helmcharts/finalizers,verbs=get;create;update;patch;delete
// +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,namespace=default,resources=helmrepositories,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,namespace=default,resources=helmrepositories/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,namespace=default,resources=helmrepositories/finalizers,verbs=get;create;update;patch;delete
// +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,namespace=default,resources=gitrepository,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,namespace=default,resources=gitrepository/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,namespace=default,resources=gitrepository/finalizers,verbs=get;create;update;patch;delete
// flux additional resources
// +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,namespace=default,resources=buckets,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=source.toolkit.fluxcd.io,namespace=default,resources=gitrepositories,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=apps,namespace=default,resources=replicasets,verbs=get;list;watch;create;update;patch;delete
// any resource that Redpanda helm creates and flux controller needs to reconcile them
// +kubebuilder:rbac:groups="",namespace=default,resources=pods,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=rbac.authorization.k8s.io,resources=clusterroles;clusterrolebindings,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=rbac.authorization.k8s.io,namespace=default,resources=roles;rolebindings,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=batch,namespace=default,resources=jobs,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=core,namespace=default,resources=configmaps;secrets;services;serviceaccounts,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=apps,namespace=default,resources=statefulsets,verbs=get;list;watch;create;update;patch;delete;
// +kubebuilder:rbac:groups=policy,namespace=default,resources=poddisruptionbudgets,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=apps,namespace=default,resources=deployments,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=cert-manager.io,namespace=default,resources=certificates,verbs=get;create;update;patch;delete;list;watch
// +kubebuilder:rbac:groups=cert-manager.io,namespace=default,resources=issuers,verbs=get;create;update;patch;delete;list;watch
// +kubebuilder:rbac:groups="monitoring.coreos.com",namespace=default,resources=podmonitors;servicemonitors,verbs=get;list;watch;create;update;patch;delete
// Console chart
// +kubebuilder:rbac:groups=autoscaling,namespace=default,resources=horizontalpodautoscalers,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=networking.k8s.io,namespace=default,resources=ingresses,verbs=get;list;watch;create;update;patch;delete
// redpanda resources
// +kubebuilder:rbac:groups=cluster.redpanda.com,resources=redpandas,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=cluster.redpanda.com,resources=redpandas/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=cluster.redpanda.com,resources=redpandas/finalizers,verbs=update
// +kubebuilder:rbac:groups=core,namespace=default,resources=events,verbs=create;patch
// sidecar resources
// The leases is used by controller-runtime in sidecar. Operator main reconciliation needs to have leases permissions in order to create role that have the same permissions.
// +kubebuilder:rbac:groups=coordination.k8s.io,namespace=default,resources=leases,verbs=get;list;watch;create;update;patch;delete
// rpk bundle additional rbac permissions
// When Redpanda chart values has set `rbac.enabled = true`, then operator needs to have elevated permissions to create ClusterRole
// +kubebuilder:rbac:groups=core,resources=endpoints;events;limitranges;persistentvolumeclaims;pods;pods/log;replicationcontrollers;resourcequotas;serviceaccounts;services,verbs=get;list
// SetupWithManager sets up the controller with the Manager.
func (r *RedpandaReconciler) SetupWithManager(ctx context.Context, mgr ctrl.Manager) error {
if err := registerHelmReferencedIndex(ctx, mgr, "statefulset", &appsv1.StatefulSet{}); err != nil {
return err
}
if err := registerHelmReferencedIndex(ctx, mgr, "deployment", &appsv1.Deployment{}); err != nil {
return err
}
helmManagedComponentPredicate, err := predicate.LabelSelectorPredicate(
metav1.LabelSelector{
MatchExpressions: []metav1.LabelSelectorRequirement{{
Key: "app.kubernetes.io/name", // look for only redpanda or console pods
Operator: metav1.LabelSelectorOpIn,
Values: []string{"redpanda", "console", "connectors"},
}, {
Key: "app.kubernetes.io/instance", // make sure we have a cluster name
Operator: metav1.LabelSelectorOpExists,
}, {
Key: "batch.kubernetes.io/job-name", // filter out the job pods since they also have name=redpanda
Operator: metav1.LabelSelectorOpDoesNotExist,
}},
},
)
if err != nil {
return err
}
managedWatchOption := builder.WithPredicates(helmManagedComponentPredicate)
return ctrl.NewControllerManagedBy(mgr).
For(&redpandav1alpha2.Redpanda{}).
Owns(&sourcev1.HelmRepository{}).
Owns(&helmv2beta1.HelmRelease{}).
Owns(&helmv2beta2.HelmRelease{}).
Watches(&appsv1.StatefulSet{}, enqueueClusterFromHelmManagedObject(), managedWatchOption).
Watches(&appsv1.Deployment{}, enqueueClusterFromHelmManagedObject(), managedWatchOption).
Complete(r)
}
func (r *RedpandaReconciler) Reconcile(c context.Context, req ctrl.Request) (ctrl.Result, error) {
ctx, done := context.WithCancel(c)
defer done()
start := time.Now()
log := ctrl.LoggerFrom(ctx).WithName("RedpandaReconciler.Reconcile")
defer func() {
durationMsg := fmt.Sprintf("reconciliation finished in %s", time.Since(start).String())
log.V(logger.TraceLevel).Info(durationMsg)
}()
log.V(logger.TraceLevel).Info("Starting reconcile loop")
rp := &redpandav1alpha2.Redpanda{}
if err := r.Client.Get(ctx, req.NamespacedName, rp); err != nil {
return ctrl.Result{}, client.IgnoreNotFound(err)
}
// Examine if the object is under deletion
if !rp.ObjectMeta.DeletionTimestamp.IsZero() {
return ctrl.Result{}, r.reconcileDelete(ctx, rp)
}
if !isRedpandaManaged(ctx, rp) {
if controllerutil.ContainsFinalizer(rp, FinalizerKey) {
// if no longer managed by us, attempt to remove the finalizer
controllerutil.RemoveFinalizer(rp, FinalizerKey)
if err := r.Client.Update(ctx, rp); err != nil {
return ctrl.Result{}, err
}
}
return ctrl.Result{}, nil
}
_, ok := rp.GetAnnotations()[resources.ManagedDecommissionAnnotation]
if ok {
log.V(logger.TraceLevel).Info("Managed decommission")
return ctrl.Result{}, nil
}
// add finalizer if not exist
if !controllerutil.ContainsFinalizer(rp, FinalizerKey) {
patch := client.MergeFrom(rp.DeepCopy())
controllerutil.AddFinalizer(rp, FinalizerKey)
if err := r.Client.Patch(ctx, rp, patch); err != nil {
log.Error(err, "unable to register finalizer")
return ctrl.Result{}, err
}
}
rp, err := r.reconcileFlux(ctx, rp)
if err != nil {
return ctrl.Result{}, err
}
if err := r.reconcileDefluxed(ctx, rp); err != nil {
return ctrl.Result{}, err
}
if err := r.reconcileStatus(ctx, rp); err != nil {
return ctrl.Result{}, err
}
if err := r.reconcileLicense(ctx, rp); err != nil {
return ctrl.Result{}, err
}
if err := r.reconcileClusterConfig(ctx, rp); err != nil {
return ctrl.Result{}, err
}
// Reconciliation has completed without any errors, therefore we observe our
// generation and persist any status changes.
rp.Status.ObservedGeneration = rp.Generation
// Update status after reconciliation.
if updateStatusErr := r.patchRedpandaStatus(ctx, rp); updateStatusErr != nil {
log.Error(updateStatusErr, "unable to update status after reconciliation")
return ctrl.Result{}, updateStatusErr
}
return ctrl.Result{}, nil
}
func (r *RedpandaReconciler) reconcileStatus(ctx context.Context, rp *redpandav1alpha2.Redpanda) error {
if !ptr.Deref(rp.Status.HelmRepositoryReady, false) {
// strip out all of the requeues since this will get requeued based on the Owns in the setup of the reconciler
msgNotReady := fmt.Sprintf(resourceNotReadyStrFmt, resourceTypeHelmRepository, rp.Namespace, rp.Status.HelmRepository)
_ = redpandav1alpha2.RedpandaNotReady(rp, "ArtifactFailed", msgNotReady)
return nil
}
if !ptr.Deref(rp.Status.HelmReleaseReady, false) {
// strip out all of the requeues since this will get requeued based on the Owns in the setup of the reconciler
msgNotReady := fmt.Sprintf(resourceNotReadyStrFmt, resourceTypeHelmRelease, rp.GetNamespace(), rp.GetHelmReleaseName())
_ = redpandav1alpha2.RedpandaNotReady(rp, "ArtifactFailed", msgNotReady)
return nil
}
// pull our deployments and stateful sets
redpandaStatefulSets, err := redpandaStatefulSetsForCluster(ctx, r.Client, rp)
if err != nil {
return err
}
consoleDeployments, err := consoleDeploymentsForCluster(ctx, r.Client, rp)
if err != nil {
return err
}
connectorsDeployments, err := connectorsDeploymentsForCluster(ctx, r.Client, rp)
if err != nil {
return err
}
deployments := append(consoleDeployments, connectorsDeployments...)
if len(redpandaStatefulSets) == 0 {
_ = redpandav1alpha2.RedpandaNotReady(rp, "RedpandaPodsNotReady", "Redpanda StatefulSet not yet created")
return nil
}
// check to make sure that our stateful set pods are all current
if message, ready := checkStatefulSetStatus(redpandaStatefulSets); !ready {
_ = redpandav1alpha2.RedpandaNotReady(rp, "RedpandaPodsNotReady", message)
return nil
}
// check to make sure that our deployment pods are all current
if message, ready := checkDeploymentsStatus(deployments); !ready {
_ = redpandav1alpha2.RedpandaNotReady(rp, "ConsolePodsNotReady", message)
return nil
}
// Once we know that STS Pods are up and running, make sure that we don't
// need to perform a decommission.
needsDecommission, err := r.needsDecommission(ctx, rp, redpandaStatefulSets)
if err != nil {
return err
}
if needsDecommission {
_ = redpandav1alpha2.RedpandaNotReady(rp, "RedpandaPodsNotReady", "Cluster currently decommissioning dead nodes")
return nil
}
_ = redpandav1alpha2.RedpandaReady(rp)
return nil
}
func (r *RedpandaReconciler) reconcileDefluxed(ctx context.Context, rp *redpandav1alpha2.Redpanda) error {
log := ctrl.LoggerFrom(ctx)
if r.IsFluxEnabled(rp.Spec.ChartRef.UseFlux) {
log.V(logger.TraceLevel).Info("useFlux is true; skipping non-flux reconciliation...")
return nil
}
chartVersion := rp.Spec.ChartRef.ChartVersion
desiredChartVersion := redpanda.Chart.Metadata().Version
if !(chartVersion == "" || chartVersion == desiredChartVersion) {
msg := fmt.Sprintf(".spec.chartRef.chartVersion needs to be %q or %q. got %q", desiredChartVersion, "", chartVersion)
// NB: passing `nil` as err is acceptable for log.Error.
log.Error(nil, msg, "chart version", rp.Spec.ChartRef.ChartVersion)
r.EventRecorder.Eventf(rp, "Warning", redpandav1alpha2.EventSeverityError, msg)
redpandav1alpha2.RedpandaNotReady(rp, "ChartRefUnsupported", msg)
// Do not error out to not requeue. User needs to first migrate helm release to either "" or the pinned chart's version.
return nil
}
// DeepCopy values to prevent any accidental mutations that may occur
// within the chart itself.
values := rp.Spec.ClusterSpec.DeepCopy()
objs, err := redpanda.Chart.Render(&r.KubeConfig, helmette.Release{
Namespace: rp.Namespace,
Name: rp.GetHelmReleaseName(),
Service: "Helm",
IsUpgrade: true,
}, values)
if err != nil {
return err
}
var errs []error
// set for tracking which objects are expected to exist in this reconciliation run.
created := make(map[gvkKey]struct{}, len(objs))
for _, obj := range objs {
// Namespace is inconsistently set across all our charts. Set it
// explicitly here to be safe.
obj.SetNamespace(rp.Namespace)
obj.SetOwnerReferences([]metav1.OwnerReference{rp.OwnerShipRefObj()})
labels := obj.GetLabels()
if labels == nil {
labels = map[string]string{}
}
annos := obj.GetAnnotations()
if annos == nil {
annos = map[string]string{}
}
// Needed for interop with flux.
// Without these the flux controller will refuse to take ownership.
annos["meta.helm.sh/release-name"] = rp.GetHelmReleaseName()
annos["meta.helm.sh/release-namespace"] = rp.Namespace
labels["helm.toolkit.fluxcd.io/name"] = rp.GetHelmReleaseName()
labels["helm.toolkit.fluxcd.io/namespace"] = rp.Namespace
obj.SetLabels(labels)
obj.SetAnnotations(annos)
if _, ok := annos["helm.sh/hook"]; ok {
log.V(logger.TraceLevel).Info(fmt.Sprintf("skipping helm hook %T: %q", obj, obj.GetName()))
continue
}
// TODO: how to handle immutable issues?
if err := r.apply(ctx, obj); err != nil {
errs = append(errs, errors.Wrapf(err, "deploying %T: %q", obj, obj.GetName()))
continue
}
log.V(logger.TraceLevel).Info(fmt.Sprintf("deployed %T: %q", obj, obj.GetName()))
// Record creation
created[gvkKey{
Key: client.ObjectKeyFromObject(obj),
GVK: obj.GetObjectKind().GroupVersionKind(),
}] = struct{}{}
}
if len(errs) > 0 {
return errors.Join(errs...)
}
// If our ObservedGeneration is up to date, .Spec hasn't changed since the
// last successful reconciliation so everything that we'd do here is likely
// to be a no-op.
// This check could likely be hoisted above the deployment loop as well.
if rp.Generation == rp.Status.ObservedGeneration && rp.Generation != 0 {
log.V(logger.TraceLevel).Info("observed generation is up to date. skipping garbage collection", "generation", rp.Generation, "observedGeneration", rp.Status.ObservedGeneration)
return nil
}
// Garbage collect any objects that are no longer needed.
if err := r.reconcileDefluxGC(ctx, rp, created); err != nil {
return err
}
return nil
}
func (r *RedpandaReconciler) ratelimitCondition(ctx context.Context, rp *redpandav1alpha2.Redpanda, conditionType string) bool {
log := ctrl.LoggerFrom(ctx)
redpandaReady := apimeta.IsStatusConditionTrue(rp.Status.Conditions, meta.ReadyCondition)
if !(rp.GenerationObserved() || redpandaReady) {
log.V(logger.TraceLevel).Info(fmt.Sprintf("redpanda not yet ready. skipping %s reconciliation.", conditionType))
apimeta.SetStatusCondition(rp.GetConditions(), metav1.Condition{
Type: conditionType,
Status: metav1.ConditionUnknown,
ObservedGeneration: rp.Generation,
Reason: "RedpandaNotReady",
Message: "redpanda cluster is not yet ready or up to date",
})
// NB: Redpanda becoming ready and/or observing it's generation will
// trigger a re-queue for us.
return true
}
cond := apimeta.FindStatusCondition(rp.Status.Conditions, conditionType)
if cond == nil {
cond = &metav1.Condition{
Type: conditionType,
Status: metav1.ConditionUnknown,
}
}
recheck := time.Since(cond.LastTransitionTime.Time) > time.Minute
previouslySynced := cond.Status == metav1.ConditionTrue
generationChanged := cond.ObservedGeneration != 0 && cond.ObservedGeneration < rp.Generation
// NB: This controller re-queues fairly frequently as is (Watching STS
// which watches Pods), so we're largely relying on that to ensure we eventually run our rechecks.
return previouslySynced && !(generationChanged || recheck)
}
func (r *RedpandaReconciler) reconcileLicense(ctx context.Context, rp *redpandav1alpha2.Redpanda) error {
if r.ratelimitCondition(ctx, rp, redpandav1alpha2.ClusterLicenseValid) {
return nil
}
client, err := r.ClientFactory.RedpandaAdminClient(ctx, rp)
if err != nil {
return err
}
defer client.Close()
features, err := client.GetEnterpriseFeatures(ctx)
if err != nil {
if internalclient.IsTerminalClientError(err) {
apimeta.SetStatusCondition(rp.GetConditions(), metav1.Condition{
Type: redpandav1alpha2.ClusterLicenseValid,
Status: metav1.ConditionUnknown,
ObservedGeneration: rp.Generation,
Reason: "TerminalError",
Message: err.Error(),
})
return nil
}
return err
}
licenseInfo, err := client.GetLicenseInfo(ctx)
if err != nil {
if internalclient.IsTerminalClientError(err) {
apimeta.SetStatusCondition(rp.GetConditions(), metav1.Condition{
Type: redpandav1alpha2.ClusterLicenseValid,
Status: metav1.ConditionUnknown,
ObservedGeneration: rp.Generation,
Reason: "TerminalError",
Message: err.Error(),
})
return nil
}
return err
}
var message string
var reason string
status := metav1.ConditionUnknown
switch features.LicenseStatus {
case rpadmin.LicenseStatusExpired:
status = metav1.ConditionFalse
reason = "LicenseExpired"
message = "Expired"
case rpadmin.LicenseStatusNotPresent:
status = metav1.ConditionFalse
reason = "LicenseNotPresent"
message = "Not Present"
case rpadmin.LicenseStatusValid:
status = metav1.ConditionTrue
reason = "LicenseValid"
message = "Valid"
}
apimeta.SetStatusCondition(rp.GetConditions(), metav1.Condition{
Type: redpandav1alpha2.ClusterLicenseValid,
Status: status,
ObservedGeneration: rp.Generation,
Reason: reason,
Message: message,
})
licenseStatus := func() *redpandav1alpha2.RedpandaLicenseStatus {
inUseFeatures := []string{}
for _, feature := range features.Features {
if feature.Enabled {
inUseFeatures = append(inUseFeatures, feature.Name)
}
}
status := &redpandav1alpha2.RedpandaLicenseStatus{
InUseFeatures: inUseFeatures,
Violation: features.Violation,
}
// make sure we can actually format the extend license properties
if !licenseInfo.Loaded {
return status
}
status.Organization = ptr.To(licenseInfo.Properties.Organization)
status.Type = ptr.To(licenseInfo.Properties.Type)
expirationTime := time.Unix(licenseInfo.Properties.Expires, 0)
// if we have an expiration that is below 0 we are already expired
// so no need to set the expiration time
status.Expired = ptr.To(licenseInfo.Properties.Expires <= 0 || expirationTime.Before(time.Now()))
if !*status.Expired {
status.Expiration = &metav1.Time{Time: expirationTime.UTC()}
}
return status
}
rp.Status.LicenseStatus = licenseStatus()
return nil
}
func (r *RedpandaReconciler) reconcileClusterConfig(ctx context.Context, rp *redpandav1alpha2.Redpanda) error {
if r.ratelimitCondition(ctx, rp, redpandav1alpha2.ClusterConfigSynced) {
return nil
}
if r.IsFluxEnabled(rp.Spec.ChartRef.UseFlux) {
apimeta.SetStatusCondition(rp.GetConditions(), metav1.Condition{
Type: redpandav1alpha2.ClusterConfigSynced,
Status: metav1.ConditionUnknown,
ObservedGeneration: rp.Generation,
Reason: "HandledByFlux",
Message: "cluster configuration is not managed by the operator when Flux is enabled",
})
return nil
}
client, err := r.ClientFactory.RedpandaAdminClient(ctx, rp)
if err != nil {
return err
}
defer client.Close()
config, err := r.clusterConfigFor(ctx, rp)
if err != nil {
return err
}
usersTXT, err := r.usersTXTFor(ctx, rp)
if err != nil {
return err
}
syncer := syncclusterconfig.Syncer{Client: client}
if err := syncer.Sync(ctx, config, usersTXT); err != nil {
return err
}
apimeta.SetStatusCondition(rp.GetConditions(), metav1.Condition{
Type: redpandav1alpha2.ClusterConfigSynced,
Status: metav1.ConditionTrue,
ObservedGeneration: rp.Generation,
Reason: "ConfigSynced",
})
return nil
}
func (r *RedpandaReconciler) usersTXTFor(ctx context.Context, rp *redpandav1alpha2.Redpanda) (map[string][]byte, error) {
values, err := rp.GetValues()
if err != nil {
return nil, err
}
if !values.Auth.SASL.Enabled {
return map[string][]byte{}, nil
}
key := client.ObjectKey{Namespace: rp.Namespace, Name: values.Auth.SASL.SecretRef}
var users corev1.Secret
if err := r.Client.Get(ctx, key, &users); err != nil {
if apierrors.IsNotFound(err) {
return map[string][]byte{}, nil
}
return nil, err
}
return users.Data, nil
}
func (r *RedpandaReconciler) clusterConfigFor(ctx context.Context, rp *redpandav1alpha2.Redpanda) (_ map[string]any, err error) {
// Parinoided panic catch as we're calling directly into helm functions.
defer func() {
if r := recover(); r != nil {
err = errors.Newf("recovered panic: %+v", r)
}
}()
dot, err := rp.GetDot(&rest.Config{})
if err != nil {
return nil, err
}
// The most reliable way to get the correct and full cluster config is to
// "envsubst" the bootstrap file itself as various components feed into the
// final cluster config and they may be referencing values stored in
// configmaps or secrets.
job := redpanda.PostInstallUpgradeJob(dot)
clusterConfigTemplate := redpanda.BootstrapFile(dot)
expander := kube.EnvExpander{
Client: r.Client,
Namespace: rp.Namespace,
Env: job.Spec.Template.Spec.InitContainers[0].Env,
EnvFrom: job.Spec.Template.Spec.InitContainers[0].EnvFrom,
}
expanded, err := expander.Expand(ctx, clusterConfigTemplate)
if err != nil {
return nil, err
}
var desired map[string]any
if err := yaml.Unmarshal([]byte(expanded), &desired); err != nil {
return nil, err
}
return desired, nil
}
func (r *RedpandaReconciler) reconcileDefluxGC(ctx context.Context, rp *redpandav1alpha2.Redpanda, created map[gvkKey]struct{}) error {
log := ctrl.LoggerFrom(ctx)
types, err := allListTypes(r.Client)
if err != nil {
return err
}
// For all types in the redpanda helm chart,
var toDelete []kube.Object
for _, typ := range types {
// Find all objects that have flux's internal label selector.
if err := r.Client.List(ctx, typ, client.InNamespace(rp.Namespace), client.MatchingLabels{
"helm.toolkit.fluxcd.io/name": rp.GetHelmReleaseName(),
"helm.toolkit.fluxcd.io/namespace": rp.Namespace,
}); err != nil {
// Some types from 3rd parties (monitoring, cert-manager) may not
// exists. If they don't skip over them without erroring out.
if apimeta.IsNoMatchError(err) {
log.Info("Skipping unknown GVK", "gvk", fmt.Sprintf("%T", typ))
continue
}
return err
}
if err := apimeta.EachListItem(typ, func(o runtime.Object) error {
obj := o.(client.Object)
gvk, err := r.Client.GroupVersionKindFor(obj)
if err != nil {
return errors.WithStack(err)
}
key := gvkKey{Key: client.ObjectKeyFromObject(obj), GVK: gvk}
isOwned := slices.ContainsFunc(obj.GetOwnerReferences(), func(owner metav1.OwnerReference) bool {
return owner.UID == rp.UID
})
// If we've just created this object, don't consider it for
// deletion.
if _, ok := created[key]; ok {
return nil
}
// Similarly, if the object isn't owned by `rp`, don't consider it
// for deletion.
if !isOwned {
return nil
}
toDelete = append(toDelete, obj)
return nil
}); err != nil {
return err
}
}
log.V(logger.TraceLevel).Info(fmt.Sprintf("identified %d objects to gc", len(toDelete)))
var errs []error
for _, obj := range toDelete {
if err := r.Client.Delete(ctx, obj); err != nil {
errs = append(errs, errors.Wrapf(err, "gc'ing %T: %s", obj, obj.GetName()))
}
}
return errors.Join(errs...)
}
func (r *RedpandaReconciler) reconcileFlux(ctx context.Context, rp *redpandav1alpha2.Redpanda) (*redpandav1alpha2.Redpanda, error) {
log := ctrl.LoggerFrom(ctx)
log.WithName("RedpandaReconciler.reconcile")
// Check if HelmRepository exists or create it
if err := r.reconcileHelmRepository(ctx, rp); err != nil {
return rp, err
}
if !ptr.Deref(rp.Status.HelmRepositoryReady, false) {
return rp, nil
}
// Check if HelmRelease exists or create it also
if err := r.reconcileHelmRelease(ctx, rp); err != nil {
return rp, err
}
return rp, nil
}
func (r *RedpandaReconciler) needsDecommission(ctx context.Context, rp *redpandav1alpha2.Redpanda, stses []*appsv1.StatefulSet) (bool, error) {
client, err := r.ClientFactory.RedpandaAdminClient(ctx, rp)
if err != nil {
return false, err
}
defer client.Close()
health, err := client.GetHealthOverview(ctx)
if err != nil {
return false, errors.WithStack(err)
}
desiredReplicas := 0
for _, sts := range stses {
desiredReplicas += int(ptr.Deref(sts.Spec.Replicas, 0))
}
if len(health.AllNodes) == 0 || desiredReplicas == 0 {
return false, nil
}
return len(health.AllNodes) > desiredReplicas, nil
}
func (r *RedpandaReconciler) reconcileHelmRelease(ctx context.Context, rp *redpandav1alpha2.Redpanda) error {
hr, err := r.createHelmReleaseFromTemplate(ctx, rp)
if err != nil {
return err
}
if err := r.apply(ctx, hr); err != nil {
return err
}
isGenerationCurrent := hr.Generation == hr.Status.ObservedGeneration
isStatusConditionReady := apimeta.IsStatusConditionTrue(hr.Status.Conditions, meta.ReadyCondition) || apimeta.IsStatusConditionTrue(hr.Status.Conditions, helmv2beta2.RemediatedCondition)
// When UseFlux is false, we suspend the HelmRelease which completely
// disables the controller. In such cases, we have to lie a bit to keep
// everything else chugging along as expected.
if hr.Spec.Suspend {
isGenerationCurrent = true
isStatusConditionReady = true
}
rp.Status.HelmRelease = hr.Name
rp.Status.HelmReleaseReady = ptr.To(isGenerationCurrent && isStatusConditionReady)
return nil
}
func (r *RedpandaReconciler) reconcileHelmRepository(ctx context.Context, rp *redpandav1alpha2.Redpanda) error {
repo := r.HelmRepositoryFromTemplate(rp)
if err := r.apply(ctx, repo); err != nil {
return fmt.Errorf("applying HelmRepository: %w", err)
}
isGenerationCurrent := repo.Generation == repo.Status.ObservedGeneration
isStatusConditionReady := apimeta.IsStatusConditionTrue(repo.Status.Conditions, meta.ReadyCondition)
// When UseFlux is false, we suspend the HelmRepository which completely
// disables the controller. In such cases, we have to lie a bit to keep
// everything else chugging along as expected.
if repo.Spec.Suspend {
isGenerationCurrent = true
isStatusConditionReady = true
}
rp.Status.HelmRepository = repo.Name
rp.Status.HelmRepositoryReady = ptr.To(isStatusConditionReady && isGenerationCurrent)
return nil
}
func (r *RedpandaReconciler) reconcileDelete(ctx context.Context, rp *redpandav1alpha2.Redpanda) error {
if err := r.deleteHelmChart(ctx, rp); err != nil {
return err
}
if controllerutil.ContainsFinalizer(rp, FinalizerKey) {
controllerutil.RemoveFinalizer(rp, FinalizerKey)
if err := r.Client.Update(ctx, rp); err != nil {
return err
}
}
return nil
}
func (r *RedpandaReconciler) deleteHelmChart(ctx context.Context, rp *redpandav1alpha2.Redpanda) error {
// When HelmRelease is suspended it will not delete child resource HelmChart. In this function there is attempt
// to delete HelmChart custom resource.
// Reference:
// https://github.com/fluxcd/helm-controller/blob/2d335f2aa0e2e0df2a631ebf19394aed07c556f3/internal/reconcile/helmchart_template.go#L163-L166
// https://github.com/fluxcd/helm-controller/blob/2d335f2aa0e2e0df2a631ebf19394aed07c556f3/internal/controller/helmrelease_controller.go#L375-L388
namespacedName := client.ObjectKey{Namespace: rp.Namespace, Name: rp.Namespace + "-" + rp.Name}
var chart sourcev1.HelmChart
err := r.Client.Get(ctx, namespacedName, &chart)
if err != nil && !apierrors.IsNotFound(err) {
// Return error to retry until we succeed.
return fmt.Errorf("failed to get flux HelmChart '%s': %w", namespacedName.Name, err)
} else if err == nil {
if controllerutil.ContainsFinalizer(&chart, FluxFinalizerKey) {
controllerutil.RemoveFinalizer(&chart, FluxFinalizerKey)
if err := r.Client.Update(ctx, &chart); err != nil {
return fmt.Errorf("failed to update flux HelmChart '%s': %w", namespacedName.Name, err)
}
}
// Delete the HelmChart.
if err = r.Client.Delete(ctx, &chart); err != nil {
return fmt.Errorf("failed to delete flux HelmChart '%s': %w", namespacedName.Name, err)
}
}
return nil
}
func (r *RedpandaReconciler) createHelmReleaseFromTemplate(ctx context.Context, rp *redpandav1alpha2.Redpanda) (*helmv2beta2.HelmRelease, error) {
log := ctrl.LoggerFrom(ctx).WithName("RedpandaReconciler.createHelmReleaseFromTemplate")
values, err := rp.ValuesJSON()
if err != nil {
return nil, fmt.Errorf("could not parse clusterSpec to json: %w", err)
}
log.V(logger.DebugLevel).Info("helm release values", "raw-values", string(values.Raw))
hasher := sha256.New()
hasher.Write(values.Raw)
sha := base64.URLEncoding.EncodeToString(hasher.Sum(nil))
// TODO possibly add the SHA to the status
log.V(logger.TraceLevel).Info(fmt.Sprintf("SHA of values file to use: %s", sha))
timeout := rp.Spec.ChartRef.Timeout
if timeout == nil {
timeout = &metav1.Duration{Duration: 15 * time.Minute}
}
chartVersion := rp.Spec.ChartRef.ChartVersion
if chartVersion == "" {
chartVersion = redpanda.Chart.Metadata().Version
}
upgrade := &helmv2beta2.Upgrade{
// we skip waiting since relying on the Helm release process
// to actually happen means that we block running any sort
// of pending upgrades while we are attempting the upgrade job.
DisableWait: true,
DisableWaitForJobs: true,
}
helmUpgrade := rp.Spec.ChartRef.Upgrade
if rp.Spec.ChartRef.Upgrade != nil {
if helmUpgrade.Force != nil {
upgrade.Force = ptr.Deref(helmUpgrade.Force, false)
}
if helmUpgrade.CleanupOnFail != nil {
upgrade.CleanupOnFail = ptr.Deref(helmUpgrade.CleanupOnFail, false)
}
if helmUpgrade.PreserveValues != nil {
upgrade.PreserveValues = ptr.Deref(helmUpgrade.PreserveValues, false)
}
if helmUpgrade.Remediation != nil {
upgrade.Remediation = helmUpgrade.Remediation
}
}
return &helmv2beta2.HelmRelease{
ObjectMeta: metav1.ObjectMeta{
Name: rp.GetHelmReleaseName(),
Namespace: rp.Namespace,
OwnerReferences: []metav1.OwnerReference{rp.OwnerShipRefObj()},
},
Spec: helmv2beta2.HelmReleaseSpec{
Suspend: !r.IsFluxEnabled(rp.Spec.ChartRef.UseFlux),
Chart: helmv2beta2.HelmChartTemplate{
Spec: helmv2beta2.HelmChartTemplateSpec{
Chart: "redpanda",
Version: chartVersion,
Interval: &metav1.Duration{Duration: 1 * time.Minute},
SourceRef: helmv2beta2.CrossNamespaceObjectReference{
Kind: "HelmRepository",
Name: rp.GetHelmRepositoryName(),
Namespace: rp.Namespace,
},
},
},
Values: values,
Interval: metav1.Duration{Duration: 30 * time.Second},
Timeout: timeout,
Upgrade: upgrade,
Install: &helmv2beta2.Install{
Remediation: &helmv2beta2.InstallRemediation{
// Per the flux helm remediation docs negative value is set to
// reconcile even if client-side cache has stale data.
//
// Flux Docs:
// Retries is the number of retries that should be attempted on
// failures before bailing. Remediation, using an uninstall,
// is performed between each attempt. Defaults to '0', a negative
// integer equals to unlimited retries.
Retries: -1,
},