-
Notifications
You must be signed in to change notification settings - Fork 63
/
topology_controller.go
255 lines (231 loc) · 8.94 KB
/
topology_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
package controllers
import (
"context"
"crypto/x509"
"encoding/json"
"errors"
"fmt"
"github.com/go-logr/logr"
topology "github.com/rabbitmq/messaging-topology-operator/api/v1beta1"
"github.com/rabbitmq/messaging-topology-operator/rabbitmqclient"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/client-go/tools/record"
clientretry "k8s.io/client-go/util/retry"
"reflect"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"strings"
"time"
)
// TopologyReconciler reconciles any topology rabbitmq objects
type TopologyReconciler struct {
client.Client
ReconcileFunc
Type client.Object
WatchTypes []client.Object
Log logr.Logger
Scheme *runtime.Scheme
Recorder record.EventRecorder
RabbitmqClientFactory rabbitmqclient.Factory
KubernetesClusterDomain string
ConnectUsingPlainHTTP bool
}
func (r *TopologyReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
logger := ctrl.LoggerFrom(ctx)
obj := r.Type.DeepCopyObject().(topology.TopologyResource)
if err := r.Get(ctx, req.NamespacedName, obj); err != nil {
return ctrl.Result{}, client.IgnoreNotFound(err)
}
// generate RabbitMQ client
systemCertPool, err := extractSystemCertPool(ctx, r.Recorder, obj)
if err != nil {
return ctrl.Result{}, err
}
credsProvider, tlsEnabled, err := rabbitmqclient.ParseReference(ctx, r.Client, obj.RabbitReference(), obj.GetNamespace(), r.KubernetesClusterDomain, r.ConnectUsingPlainHTTP)
if err != nil {
return r.handleRMQReferenceParseError(ctx, obj, err)
}
rabbitClient, err := r.RabbitmqClientFactory(credsProvider, tlsEnabled, systemCertPool)
if err != nil {
logger.Error(err, failedGenerateRabbitClient)
return ctrl.Result{}, err
}
// call DeleteFunc if obj has been marked for deletion
objKind := strings.ToLower(obj.GetObjectKind().GroupVersionKind().Kind)
if obj.GetDeletionTimestamp() != nil {
logger.Info("Deleting")
if err := r.DeleteFunc(ctx, rabbitClient, obj); err != nil {
// log and publish failed event when DeleteFunc errored
failureMsg := fmt.Sprintf("failed to delete %s", objKind)
r.Recorder.Event(obj, corev1.EventTypeWarning, "FailedDelete", failureMsg)
logger.Error(err, failureMsg)
return ctrl.Result{}, err
}
successMsg := fmt.Sprintf("successfully deleted %s", objKind)
logger.Info(successMsg)
r.Recorder.Event(obj, corev1.EventTypeNormal, "SuccessfulDelete", successMsg)
return ctrl.Result{}, removeFinalizer(ctx, r.Client, obj)
}
if err := addFinalizerIfNeeded(ctx, r.Client, obj); err != nil {
return ctrl.Result{}, err
}
spec, err := json.Marshal(r.getTopLevelField(obj, "Spec"))
if err != nil {
logger.Error(err, failedMarshalSpec)
}
logger.Info("Start reconciling", "spec", string(spec))
if err := r.DeclareFunc(ctx, rabbitClient, obj); err != nil {
// log, publish failed event, and set obj status when DeclareFunc errored
failureMsg := fmt.Sprintf("failed to declare %s", objKind)
r.Recorder.Event(obj, corev1.EventTypeWarning, "FailedDeclare", failureMsg)
logger.Error(err, failureMsg)
obj.SetStatusConditions([]topology.Condition{topology.NotReady(err.Error(), r.getStatusConditions(obj))})
r.statusUpdate(ctx, obj, logger)
return ctrl.Result{}, err
}
// log, publish successful event, and set obj status
successMsg := fmt.Sprintf("Successfully declare %s", objKind)
logger.Info(successMsg)
r.Recorder.Event(obj, corev1.EventTypeNormal, "SuccessfulDeclare", successMsg)
obj.SetStatusConditions([]topology.Condition{topology.Ready(r.getStatusConditions(obj))})
r.setObservedGeneration(obj)
r.statusUpdate(ctx, obj, logger)
logger.Info("Finished reconciling")
return ctrl.Result{}, nil
}
func extractSystemCertPool(ctx context.Context, recorder record.EventRecorder, object runtime.Object) (*x509.CertPool, error) {
logger := ctrl.LoggerFrom(ctx)
systemCertPool, err := x509.SystemCertPool()
if err != nil {
recorder.Event(object, corev1.EventTypeWarning, "FailedUpdate", failedRetrieveSysCertPool)
logger.Error(err, failedRetrieveSysCertPool)
}
return systemCertPool, err
}
func (r *TopologyReconciler) statusUpdate(ctx context.Context, obj topology.TopologyResource, logger logr.Logger) {
if writerErr := clientretry.RetryOnConflict(clientretry.DefaultRetry, func() error {
return r.Status().Update(ctx, obj)
}); writerErr != nil {
logger.Error(writerErr, failedStatusUpdate, "status", r.getTopLevelField(obj, "Status"))
}
}
func (r *TopologyReconciler) handleRMQReferenceParseError(ctx context.Context, object topology.TopologyResource, err error) (ctrl.Result, error) {
logger := ctrl.LoggerFrom(ctx)
if err == nil {
logger.Error(errors.New("expected error to parse, but it was nil"), "Failed to parse error from RabbitmqClusterReference parsing")
return ctrl.Result{}, err
}
if errors.Is(err, rabbitmqclient.NoSuchRabbitmqClusterError) && !object.GetDeletionTimestamp().IsZero() {
logger.Info(noSuchRabbitDeletion, "object", object.GetName())
r.Recorder.Event(object, corev1.EventTypeNormal, "SuccessfulDelete", "successfully deleted "+object.GetName())
return ctrl.Result{}, removeFinalizer(ctx, r.Client, object)
}
if errors.Is(err, rabbitmqclient.NoSuchRabbitmqClusterError) {
// If the object is not being deleted, but the RabbitmqCluster no longer exists, it could be that
// the Cluster is temporarily down. Requeue until it comes back up.
logger.Info("Could not generate rabbitClient for non existent cluster: " + err.Error())
return reconcile.Result{RequeueAfter: 10 * time.Second}, err
}
if errors.Is(err, rabbitmqclient.ResourceNotAllowedError) {
logger.Info("Could not create resource: " + err.Error())
object.SetStatusConditions([]topology.Condition{topology.NotReady(rabbitmqclient.ResourceNotAllowedError.Error(), r.getStatusConditions(object))})
if writerErr := clientretry.RetryOnConflict(clientretry.DefaultRetry, func() error {
return r.Status().Update(ctx, object)
}); writerErr != nil {
logger.Error(writerErr, failedStatusUpdate, "object", object.GetName())
}
return ctrl.Result{}, nil
}
// set status condition and publish event for any other error
logger.Error(err, failedParseClusterRef)
msg := fmt.Sprintf("%s: %s", failedParseClusterRef, err.Error())
r.Recorder.Event(object, corev1.EventTypeWarning, "FailedCreateOrUpdate", msg)
object.SetStatusConditions([]topology.Condition{topology.NotReady(msg, r.getStatusConditions(object))})
if writerErr := clientretry.RetryOnConflict(clientretry.DefaultRetry, func() error {
return r.Status().Update(ctx, object)
}); writerErr != nil {
logger.Error(writerErr, failedStatusUpdate, "object", object.GetName())
}
return ctrl.Result{}, err
}
func (r *TopologyReconciler) setObservedGeneration(obj topology.TopologyResource) {
status := r.getTopLevelField(obj, "Status")
if status == nil {
return
}
statusValue := reflect.ValueOf(status).Elem()
if !statusValue.IsValid() {
return
}
observedGenerationValue := statusValue.FieldByName("ObservedGeneration")
if observedGenerationValue.Kind() != reflect.Int64 || !observedGenerationValue.CanSet() {
return
}
generation := obj.GetGeneration()
observedGenerationValue.SetInt(generation)
}
func (r *TopologyReconciler) getStatusConditions(obj topology.TopologyResource) []topology.Condition {
status := r.getTopLevelField(obj, "Status")
if status == nil {
return nil
}
statusValue := reflect.ValueOf(status).Elem()
conditionsValue := statusValue.FieldByName("Conditions")
if !conditionsValue.IsValid() || conditionsValue.IsZero() {
return nil
}
conditions, ok := conditionsValue.Interface().([]topology.Condition)
if !ok {
return nil
}
return conditions
}
func (r *TopologyReconciler) getTopLevelField(obj topology.TopologyResource, path string) interface{} {
if obj == nil {
return nil
}
value := reflect.ValueOf(obj).Elem().FieldByName(path)
if value.Kind() == reflect.Ptr {
value = value.Elem()
}
if !value.IsValid() || !value.CanAddr() {
return nil
}
return value.Addr().Interface()
}
func (r *TopologyReconciler) SetupWithManager(mgr ctrl.Manager) error {
if len(r.WatchTypes) == 0 {
return ctrl.NewControllerManagedBy(mgr).
For(r.Type).
Complete(r)
}
builder := ctrl.NewControllerManagedBy(mgr).For(r.Type)
for _, t := range r.WatchTypes {
if err := mgr.GetFieldIndexer().IndexField(context.Background(), t, ownerKey, addResourceToIndex); err != nil {
return err
}
builder = builder.Owns(t)
}
return builder.Complete(r)
}
func addResourceToIndex(rawObj client.Object) []string {
switch resourceObject := rawObj.(type) {
case *corev1.Secret:
owner := metav1.GetControllerOf(resourceObject)
return validateAndGetOwner(owner)
default:
return nil
}
}
func validateAndGetOwner(owner *metav1.OwnerReference) []string {
if owner == nil {
return nil
}
if owner.APIVersion != apiGVStr || owner.Kind != ownerKind {
return nil
}
return []string{owner.Name}
}