-
Notifications
You must be signed in to change notification settings - Fork 7
/
certmerge_controller.go
441 lines (382 loc) · 14.3 KB
/
certmerge_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
package certmerge
import (
"context"
"time"
log "github.com/sirupsen/logrus"
"github.com/google/go-cmp/cmp"
certmergev1alpha1 "github.com/prune998/certmerge-operator/pkg/apis/certmerge/v1alpha1"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/labels"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/selection"
"k8s.io/apimachinery/pkg/types"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/event"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
)
var _ reconcile.Reconciler = &ReconcileCertMerge{}
// ReconcileCertMerge reconciles a CertMerge object
type ReconcileCertMerge struct {
// This client, initialized using mgr.Client() above, is a split client
// that reads objects from the cache and writes to the apiserver
client client.Client
scheme *runtime.Scheme
}
// Add creates a new CertMerge Controller and adds it to the Manager. The Manager will set fields on the Controller
// and Start it when the Manager is Started.
func Add(mgr manager.Manager) error {
r := newReconciler(mgr)
return add(mgr, r, r.SecretTriggerCertMerge)
}
// newReconciler returns a new reconcile.Reconciler
// orifginaly return reconcile.Reconciler
func newReconciler(mgr manager.Manager) *ReconcileCertMerge {
return &ReconcileCertMerge{client: mgr.GetClient(), scheme: mgr.GetScheme()}
}
// add adds a new Controller to mgr with r as the reconcile.Reconciler
func add(mgr manager.Manager, r reconcile.Reconciler, mapFn handler.ToRequestsFunc) error {
// Create a new controller
c, err := controller.New("certmerge-controller", mgr, controller.Options{Reconciler: r})
if err != nil {
return err
}
// Watch for changes to primary resource CertMerge
if err := c.Watch(&source.Kind{Type: &certmergev1alpha1.CertMerge{}}, &handler.EnqueueRequestForObject{}); err != nil {
return err
}
// This will trigger the Reconcile if the Merged Secret is modified
if err := c.Watch(&source.Kind{Type: &corev1.Secret{}}, &handler.EnqueueRequestForOwner{IsController: true, OwnerType: &certmergev1alpha1.CertMerge{}}); err != nil {
return err
}
// This predicate deduplicate the watch trigger if no data is modified inside the secret
// if the Secret is Deleted, don't send the delete event as we can trigger it from the update
updateFunc := func(e event.UpdateEvent) bool {
log.WithFields(log.Fields{
"event": e,
}).Debugf("Update Predicate event")
// This update is in fact a Delete event, process it
if e.MetaNew.GetDeletionGracePeriodSeconds() != nil {
return true
}
// if old and new data is the same, don't reconcile
newObj := e.ObjectNew.DeepCopyObject().(*corev1.Secret)
oldObj := e.ObjectOld.DeepCopyObject().(*corev1.Secret)
if cmp.Equal(newObj.Data, oldObj.Data) {
return false
}
return true
}
deleteFunc := func(e event.DeleteEvent) bool {
log.WithFields(log.Fields{
"event": e,
}).Debugf("Delete Predicate event")
return false
}
// Watch for Secret change and process them through the SecretTriggerCertMerge function
// This watch enables us to reconcile a CertMerge when a concerned Secret is changed (create/update/delete)
p := predicate.Funcs{
UpdateFunc: updateFunc,
// don't process any Delete event as we catch them in Update
DeleteFunc: deleteFunc,
}
s := &source.Kind{
Type: &corev1.Secret{},
}
h := &handler.EnqueueRequestsFromMapFunc{
ToRequests: mapFn,
}
if err := c.Watch(s, h, p); err != nil {
return err
}
return nil
}
// SecretTriggerCertMerge check if a Secret is concerned by a CertMerge and enque the CertMerge for Reconcile
func (r *ReconcileCertMerge) SecretTriggerCertMerge(o handler.MapObject) []reconcile.Request {
var result []reconcile.Request
// drop secrets if the Operator is the Onwer
// we don't support merging an already merged secret
for _, owner := range o.Meta.GetOwnerReferences() {
if owner.Kind == "CertMerge" {
log.WithFields(log.Fields{
"secret": o.Meta.GetName(),
"namespace": o.Meta.GetNamespace(),
}).Infof("Secret is managed by CertMerge, dropping event")
return nil
}
}
log.WithFields(log.Fields{
"secret": o.Meta.GetName(),
"namespace": o.Meta.GetNamespace(),
}).Infof("Secret update triggered, reconciling CertMerge CR")
// Fetch the triggered Secret Data
instance := &corev1.Secret{}
key := client.ObjectKey{Namespace: o.Meta.GetNamespace(), Name: o.Meta.GetName()}
err := r.client.Get(context.TODO(), key, instance)
if errors.IsNotFound(err) {
// in this case it's a deleted secret, keep going
// as we don't have the secret anymore, we need to trigger all the CertMerge CR
// for the moment we do nothing and keep outdated secrets merged
log.WithFields(log.Fields{
"secret": o.Meta.GetName(),
"namespace": o.Meta.GetNamespace(),
}).Infof("Secret not found, not reconciling any CertMerge CR")
return nil
}
if err != nil {
log.Errorf("Error retrieving Secret %v from store: %v", key, err)
return nil
}
// sec will hold the CertMerge CR List we find
cml := &certmergev1alpha1.CertMergeList{
TypeMeta: metav1.TypeMeta{
Kind: "CertMertgeList",
APIVersion: "certmerge.lecentre.net/v1alpha1",
},
}
// Get all CertMerges
if err := r.client.List(context.TODO(), nil, cml); err != nil {
return result
}
// parse each CertMerge CR and reconcile them if needed
for _, cm := range cml.Items {
if secretInCertMergeList(&cm, instance) || secretInCertMergeLabels(&cm, instance) {
// trigger the CertMerge Reconcile
result = append(result, reconcile.Request{
NamespacedName: client.ObjectKey{Namespace: cm.Namespace, Name: cm.Name}})
log.Infof("CertMerge %s/%s added to Reconcile List", cm.Namespace, cm.Name)
}
}
return result
}
// secretInCertMergeList returns true if the provided Secret Name is included in the CertMerge CR SecretList
func secretInCertMergeList(certmerge *certmergev1alpha1.CertMerge, secret *corev1.Secret) bool {
// check if secret name is explicitely listed
for _, sd := range certmerge.Spec.SecretList {
if sd.Name == secret.Name && sd.Namespace == secret.Namespace {
return true
}
}
return false
}
// secretInCertMergeLabels returns true if the provided Secret Labels match the Selector of the CertMerge CR
func secretInCertMergeLabels(certmerge *certmergev1alpha1.CertMerge, secret *corev1.Secret) bool {
// check if secret labels match a CertMerge Selector
for _, se := range certmerge.Spec.Selector {
if se.Namespace == secret.Namespace {
// create the labelSelector
labelSelector := labels.SelectorFromSet(se.LabelSelector.MatchLabels)
for _, r := range se.LabelSelector.MatchExpressions {
req, err := labels.NewRequirement(r.Key, selection.Operator(r.Operator), r.Values)
if err != nil {
return false
}
labelSelector = labelSelector.Add(*req)
}
// make this secret as selected if it matches
if labelSelector.Matches(labels.Set(secret.ObjectMeta.Labels)) {
return true
}
}
}
return false
}
// Reconcile reads that state of the cluster for a CertMerge object and makes changes based on the state read
// and what is in the CertMerge.Spec
// Note:
// The Controller will requeue the Request to be processed again if the returned error is non-nil or
// Result.Requeue is true, otherwise upon completion it will remove the work from the queue.
func (r *ReconcileCertMerge) Reconcile(request reconcile.Request) (reconcile.Result, error) {
ctx, cancel := context.WithTimeout(context.Background(), time.Second*2)
defer cancel()
log.WithFields(log.Fields{
"certmerge": request.Name,
"namespace": request.Namespace,
}).Infof("Reconciling CertMerge")
emptyRes := reconcile.Result{}
// Fetch the CertMerge instance
instance := &certmergev1alpha1.CertMerge{}
if err := r.client.Get(ctx, request.NamespacedName, instance); err != nil {
if errors.IsNotFound(err) {
// Request object not found, could have been deleted after reconcile request.
// Owned objects are automatically garbage collected. For additional cleanup logic use finalizers.
// Return and don't requeue
return emptyRes, nil
}
// Error reading the object - requeue the request.
return emptyRes, err
}
// Define a new Secret object
secret := newSecretForCR(instance)
// Set CertMerge instance as the owner and controller
if err := controllerutil.SetControllerReference(instance, secret, r.scheme); err != nil {
return emptyRes, err
}
// create the DATA for the new secret based on the CertMerge request
certData := make(map[string][]byte)
// build the Cert Data from the provided secret List
if len(instance.Spec.SecretList) > 0 {
for _, sec := range instance.Spec.SecretList {
secContent, err := r.searchSecretByName(ctx, sec.Name, sec.Namespace)
if err != nil {
log.WithFields(log.Fields{
"certmerge": instance.Name,
"namespace": instance.Namespace,
}).Errorf("requested certificate target not found, skipping (%s/%s) - %v", sec.Namespace, sec.Name, err)
continue
}
// search for key
if secContent.Type != corev1.SecretTypeTLS {
log.WithFields(log.Fields{
"certmerge": instance.Name,
"namespace": instance.Namespace,
}).Infof("certificate %s/%s is not of TLS type, skipping", secContent.Namespace, secContent.Name)
continue
}
log.WithFields(log.Fields{
"certmerge": instance.Name,
"namespace": instance.Namespace,
}).Infof("adding certificate %s/%s to merge list", secContent.Namespace, secContent.Name)
certData[sec.Name+".crt"] = secContent.Data["tls.crt"]
certData[sec.Name+".key"] = secContent.Data["tls.key"]
}
}
// building the Cert Data from the provided Labels
if len(instance.Spec.Selector) > 0 {
for _, sec := range instance.Spec.Selector {
// search for Secrets using the API
secContent, err := r.searchSecretByLabel(ctx, sec.LabelSelector, sec.Namespace)
if err != nil {
log.WithFields(log.Fields{
"certmerge": instance.Name,
"namespace": instance.Namespace,
"labels": sec.LabelSelector.MatchLabels,
}).Errorf("no certificates matching Label Selector %v in %s, skipping - %v", sec.LabelSelector, sec.Namespace, err)
continue
}
// add valid secret's data to the Merged Secret
log.WithFields(log.Fields{
"certmerge": instance.Name,
"namespace": instance.Namespace,
"labels": sec.LabelSelector.MatchLabels,
}).Infof("found %d certificates to merge in %s/%s", len(secContent.Items), instance.Spec.SecretNamespace, instance.Spec.SecretName)
// add valid secret's data to the Merged Secret
for _, secCert := range secContent.Items {
log.WithFields(log.Fields{
"certmerge": instance.Name,
"namespace": instance.Namespace,
}).Infof("adding cert %s/%s to %s/%s", secCert.Namespace, secCert.Name, instance.Spec.SecretNamespace, instance.Spec.SecretName)
certData[secCert.Name+".crt"] = secCert.Data["tls.crt"]
certData[secCert.Name+".key"] = secCert.Data["tls.key"]
}
}
}
// add the Data to the secret
secret.Data = certData
// Check if this Secret already exists
found := &corev1.Secret{}
if err := r.client.Get(ctx, types.NamespacedName{Name: secret.Name, Namespace: secret.Namespace}, found); err != nil {
if errors.IsNotFound(err) {
log.WithFields(log.Fields{
"certmerge": instance.Name,
"namespace": instance.Namespace,
}).Infof("Creating a new Secret %s/%s\n", secret.Namespace, secret.Name)
if err := r.client.Create(ctx, secret); err != nil {
log.WithFields(log.Fields{
"certmerge": instance.Name,
"namespace": instance.Namespace,
}).Errorf("Error creating new Secret %s/%s - %v\n", secret.Namespace, secret.Name, err)
return emptyRes, err
}
// Secret created successfully - don't requeue
return emptyRes, nil
}
// unknown error
return emptyRes, err
}
// if the Secret already exist, Update it
log.WithFields(log.Fields{
"certmerge": instance.Name,
"namespace": instance.Namespace,
}).Infof("Updating Secret %s/%s\n", secret.Namespace, secret.Name)
if err := r.client.Update(ctx, secret); err != nil {
log.WithFields(log.Fields{
"certmerge": instance.Name,
"namespace": instance.Namespace,
}).Errorf("Error updating Secret %s/%s - %v\n", secret.Namespace, secret.Name, err)
return emptyRes, err
}
return emptyRes, nil
}
// newSecretForCR returns an empty secret for holding the secrets merge
func newSecretForCR(cr *certmergev1alpha1.CertMerge) *corev1.Secret {
labels := map[string]string{
"certmerge": cr.Name,
"creator": "certmerge-operator",
}
return &corev1.Secret{
TypeMeta: metav1.TypeMeta{
Kind: "Secret",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: cr.Spec.SecretName,
Namespace: cr.Spec.SecretNamespace,
Labels: labels,
},
Type: corev1.SecretTypeOpaque,
}
}
// search on secret by it's namespace:name
func (r *ReconcileCertMerge) searchSecretByName(ctx context.Context, name, namespace string) (*corev1.Secret, error) {
ctx, cancel := context.WithTimeout(ctx, time.Second*2)
defer cancel()
sec := &corev1.Secret{
TypeMeta: metav1.TypeMeta{
Kind: "Secret",
APIVersion: "v1",
},
ObjectMeta: metav1.ObjectMeta{
Name: name,
Namespace: namespace,
},
}
if err := r.client.Get(ctx, types.NamespacedName{Name: name, Namespace: namespace}, sec); err != nil {
return nil, err
}
return sec, nil
}
// search all secrets with the supplied labels
func (r *ReconcileCertMerge) searchSecretByLabel(ctx context.Context, ls metav1.LabelSelector, namespace string) (*corev1.SecretList, error) {
ctx, cancel := context.WithTimeout(ctx, time.Second*2)
defer cancel()
// create the Search options
labelSelector := labels.SelectorFromSet(ls.MatchLabels)
for _, r := range ls.MatchExpressions {
req, err := labels.NewRequirement(r.Key, selection.Operator(r.Operator), r.Values)
if err != nil {
return nil, err
}
labelSelector = labelSelector.Add(*req)
}
listOps := &client.ListOptions{LabelSelector: labelSelector}
// sec will hold the Secret List we find
sec := &corev1.SecretList{
TypeMeta: metav1.TypeMeta{
Kind: "Secret",
APIVersion: "v1",
},
}
// search
if err := r.client.List(ctx, listOps, sec); err != nil {
return nil, err
}
return sec, nil
}