-
Notifications
You must be signed in to change notification settings - Fork 35
/
route_controller.go
385 lines (353 loc) · 12.4 KB
/
route_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
package route
import (
"context"
errs "errors"
"reflect"
routev1 "github.com/openshift/api/route/v1"
"github.com/redhat-cop/cert-utils-operator/pkg/controller/util"
outils "github.com/redhat-cop/operator-utils/pkg/util"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/util/workqueue"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"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"
logf "sigs.k8s.io/controller-runtime/pkg/runtime/log"
"sigs.k8s.io/controller-runtime/pkg/source"
)
const controllerName = "route_controller"
const certAnnotation = util.AnnotationBase + "/certs-from-secret"
const destCAAnnotation = util.AnnotationBase + "/destinationCA-from-secret"
var log = logf.Log.WithName(controllerName)
/**
* USER ACTION REQUIRED: This is a scaffold file intended for the user to modify with their own Controller
* business logic. Delete these comments after modifying this file.*
*/
// Add creates a new Route 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 {
return add(mgr, newReconciler(mgr))
}
// newReconciler returns a new reconcile.Reconciler
func newReconciler(mgr manager.Manager) reconcile.Reconciler {
return &ReconcileRoute{
ReconcilerBase: outils.NewReconcilerBase(mgr.GetClient(), mgr.GetScheme(), mgr.GetConfig(), mgr.GetEventRecorderFor(controllerName)),
}
}
// add adds a new Controller to mgr with r as the reconcile.Reconciler
func add(mgr manager.Manager, r reconcile.Reconciler) error {
// Create a new controller
c, err := controller.New(controllerName, mgr, controller.Options{Reconciler: r})
if err != nil {
return err
}
reconcileRoute, ok := r.(*ReconcileRoute)
if !ok {
return errs.New("unable to convert to ReconcileRoute")
}
if ok, err := reconcileRoute.IsAPIResourceAvailable(schema.GroupVersionKind{
Group: "route.openshift.io",
Version: "v1",
Kind: "Route",
}); !ok || err != nil {
if err != nil {
return err
}
return nil
}
// this will filter routes that have the annotation and on update only if the annotation is changed.
isAnnotatedAndSecureRoute := predicate.Funcs{
UpdateFunc: func(e event.UpdateEvent) bool {
newRoute, ok := e.ObjectNew.DeepCopyObject().(*routev1.Route)
if !ok || newRoute.Spec.TLS == nil || !(newRoute.Spec.TLS.Termination == "edge" || newRoute.Spec.TLS.Termination == "reencrypt") {
return false
}
oldSecret, _ := e.MetaOld.GetAnnotations()[certAnnotation]
newSecret, _ := e.MetaNew.GetAnnotations()[certAnnotation]
if oldSecret != newSecret {
return true
}
oldRoute, _ := e.ObjectOld.DeepCopyObject().(*routev1.Route)
if newSecret != "" {
if newRoute.Spec.TLS.Key != oldRoute.Spec.TLS.Key {
return true
}
if newRoute.Spec.TLS.Certificate != oldRoute.Spec.TLS.Certificate {
return true
}
if newRoute.Spec.TLS.CACertificate != oldRoute.Spec.TLS.CACertificate {
return true
}
}
oldCASecret, _ := e.MetaOld.GetAnnotations()[destCAAnnotation]
newCASecret, _ := e.MetaNew.GetAnnotations()[destCAAnnotation]
if newCASecret != oldCASecret {
return true
}
if newCASecret != "" {
if newRoute.Spec.TLS.DestinationCACertificate != oldRoute.Spec.TLS.DestinationCACertificate {
return true
}
}
return false
},
CreateFunc: func(e event.CreateEvent) bool {
route, ok := e.Object.DeepCopyObject().(*routev1.Route)
if !ok || route.Spec.TLS == nil || !(route.Spec.TLS.Termination == "edge" || route.Spec.TLS.Termination == "reencrypt") {
return false
}
_, ok = e.Meta.GetAnnotations()[certAnnotation]
_, okca := e.Meta.GetAnnotations()[destCAAnnotation]
return ok || okca
},
DeleteFunc: func(e event.DeleteEvent) bool {
return false
},
GenericFunc: func(e event.GenericEvent) bool {
return false
},
}
// Watch for changes to primary resource Route
err = c.Watch(&source.Kind{Type: &routev1.Route{
TypeMeta: v1.TypeMeta{
Kind: "Route",
},
}}, &handler.EnqueueRequestForObject{}, isAnnotatedAndSecureRoute)
if err != nil {
return err
}
// this will filter new secrets and secrets where the content changed
// secret that are actually referenced by routes will be filtered by the handler
isContentChanged := predicate.Funcs{
UpdateFunc: func(e event.UpdateEvent) bool {
oldSecret, ok := e.ObjectOld.(*corev1.Secret)
if !ok {
return false
}
newSecret, ok := e.ObjectNew.(*corev1.Secret)
if !ok {
return false
}
if newSecret.Type != util.TLSSecret {
return false
}
return !reflect.DeepEqual(newSecret.Data[util.Cert], oldSecret.Data[util.Cert]) ||
!reflect.DeepEqual(newSecret.Data[util.Key], oldSecret.Data[util.Key]) ||
!reflect.DeepEqual(newSecret.Data[util.CA], oldSecret.Data[util.CA])
},
CreateFunc: func(e event.CreateEvent) bool {
secret, ok := e.Object.(*corev1.Secret)
if !ok {
return false
}
if secret.Type != util.TLSSecret {
return false
}
return true
},
}
// TODO(user): Modify this to be the types you create that are owned by the primary resource
// Watch for changes to secondary resource Pods and requeue the owner Route
err = c.Watch(&source.Kind{Type: &corev1.Secret{
TypeMeta: v1.TypeMeta{
Kind: "Secret",
},
}}, &enqueueRequestForReferecingRoutes{
Client: mgr.GetClient(),
}, isContentChanged)
if err != nil {
return err
}
return nil
}
var _ reconcile.Reconciler = &ReconcileRoute{}
// ReconcileRoute reconciles a Route object
type ReconcileRoute struct {
// This client, initialized using mgr.Client() above, is a split client
// that reads objects from the cache and writes to the apiserver
outils.ReconcilerBase
}
// Reconcile reads that state of the cluster for a Route object and makes changes based on the state read
// and what is in the Route.Spec
// TODO(user): Modify this Reconcile function to implement your Controller logic. This example creates
// a Pod as an example
// 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 *ReconcileRoute) Reconcile(request reconcile.Request) (reconcile.Result, error) {
reqLogger := log.WithValues("Request.Namespace", request.Namespace, "Request.Name", request.Name)
reqLogger.Info("Reconciling Route")
// Fetch the Route instance
instance := &routev1.Route{}
err := r.GetClient().Get(context.TODO(), request.NamespacedName, instance)
if 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 reconcile.Result{}, nil
}
// Error reading the object - requeue the request.
return reconcile.Result{}, err
}
if instance.Spec.TLS == nil {
return reconcile.Result{}, nil
}
secretName, ok := instance.GetAnnotations()[certAnnotation]
caSecretName, okca := instance.GetAnnotations()[destCAAnnotation]
shouldUpdate := false
if !ok {
if instance.Spec.TLS.Key != "" {
instance.Spec.TLS.Key = ""
shouldUpdate = true
}
if instance.Spec.TLS.Certificate != "" {
instance.Spec.TLS.Certificate = ""
shouldUpdate = true
}
if instance.Spec.TLS.CACertificate != "" {
instance.Spec.TLS.CACertificate = ""
shouldUpdate = true
}
} else {
secret := &corev1.Secret{}
err = r.GetClient().Get(context.TODO(), types.NamespacedName{
Namespace: instance.GetNamespace(),
Name: secretName,
}, secret)
if err != nil {
log.Error(err, "unable to find referenced secret", "secret", secretName)
return r.ManageError(instance, err)
}
shouldUpdate = shouldUpdate || populateRouteWithCertifcates(instance, secret)
}
if !okca {
if instance.Spec.TLS.DestinationCACertificate != "" {
instance.Spec.TLS.DestinationCACertificate = ""
shouldUpdate = true
}
} else {
secret := &corev1.Secret{}
err = r.GetClient().Get(context.TODO(), types.NamespacedName{
Namespace: instance.GetNamespace(),
Name: caSecretName,
}, secret)
if err != nil {
log.Error(err, "unable to find referenced ca secret", "secret", secretName)
return r.ManageError(instance, err)
}
shouldUpdate = shouldUpdate || populateRouteDestCA(instance, secret)
}
if shouldUpdate {
err = r.GetClient().Update(context.TODO(), instance)
if err != nil {
log.Error(err, "unable to update route", "route", instance)
return r.ManageError(instance, err)
}
}
// if we are here we know it's because a route was create/modified or its referenced secret was created/modified
// therefore the only think we need to do is to update the route certificates
return r.ManageSuccess(instance)
}
func matchSecret(c client.Client, secret types.NamespacedName) ([]routev1.Route, error) {
routeList := &routev1.RouteList{}
err := c.List(context.TODO(), routeList, &client.ListOptions{
Namespace: secret.Namespace,
})
if err != nil {
log.Error(err, "unable to list routes for this namespace: ", "namespace", secret.Namespace)
return []routev1.Route{}, err
}
result := []routev1.Route{}
for _, route := range routeList.Items {
if secretName := route.GetAnnotations()[certAnnotation]; secretName == secret.Name && route.Spec.TLS != nil {
result = append(result, route)
break
}
if secretName := route.GetAnnotations()[destCAAnnotation]; secretName == secret.Name && route.Spec.TLS != nil {
result = append(result, route)
break
}
}
return result, nil
}
type enqueueRequestForReferecingRoutes struct {
client.Client
}
// trigger a router reconcile event for those routes that reference this secret
func (e *enqueueRequestForReferecingRoutes) Create(evt event.CreateEvent, q workqueue.RateLimitingInterface) {
routes, _ := matchSecret(e.Client, types.NamespacedName{
Name: evt.Meta.GetName(),
Namespace: evt.Meta.GetNamespace(),
})
for _, route := range routes {
q.Add(reconcile.Request{NamespacedName: types.NamespacedName{
Namespace: route.GetNamespace(),
Name: route.GetName(),
}})
}
}
// Update implements EventHandler
// trigger a router reconcile event for those routes that reference this secret
func (e *enqueueRequestForReferecingRoutes) Update(evt event.UpdateEvent, q workqueue.RateLimitingInterface) {
routes, _ := matchSecret(e.Client, types.NamespacedName{
Name: evt.MetaNew.GetName(),
Namespace: evt.MetaNew.GetNamespace(),
})
for _, route := range routes {
q.Add(reconcile.Request{NamespacedName: types.NamespacedName{
Namespace: route.GetNamespace(),
Name: route.GetName(),
}})
}
}
// Delete implements EventHandler
func (e *enqueueRequestForReferecingRoutes) Delete(evt event.DeleteEvent, q workqueue.RateLimitingInterface) {
return
}
// Generic implements EventHandler
func (e *enqueueRequestForReferecingRoutes) Generic(evt event.GenericEvent, q workqueue.RateLimitingInterface) {
return
}
func populateRouteWithCertifcates(route *routev1.Route, secret *corev1.Secret) bool {
shouldUpdate := false
if route.Spec.TLS.Termination == "edge" || route.Spec.TLS.Termination == "reencrypt" {
// here we need to replace the terminating certifciate
if value, ok := secret.Data[util.Key]; ok && len(value) != 0 {
if route.Spec.TLS.Key != string(value) {
route.Spec.TLS.Key = string(value)
shouldUpdate = true
}
}
if value, ok := secret.Data[util.Cert]; ok && len(value) != 0 {
if route.Spec.TLS.Certificate != string(value) {
route.Spec.TLS.Certificate = string(value)
shouldUpdate = true
}
}
if value, ok := secret.Data[util.CA]; ok && len(value) != 0 {
if route.Spec.TLS.CACertificate != string(value) {
route.Spec.TLS.CACertificate = string(value)
shouldUpdate = true
}
}
}
return shouldUpdate
}
func populateRouteDestCA(route *routev1.Route, secret *corev1.Secret) bool {
shouldUpdate := false
if value, ok := secret.Data[util.CA]; ok && len(value) != 0 {
if route.Spec.TLS.DestinationCACertificate != string(value) {
route.Spec.TLS.DestinationCACertificate = string(value)
shouldUpdate = true
}
}
return shouldUpdate
}