-
Notifications
You must be signed in to change notification settings - Fork 10
/
serviceaccount_controller.go
341 lines (276 loc) · 11.5 KB
/
serviceaccount_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
/*
SPDX-FileCopyrightText: 2021 SAP SE or an SAP affiliate company and Gardener contributors
SPDX-License-Identifier: Apache-2.0
*/
package controllers
import (
"context"
"sync"
"github.com/go-logr/logr"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/types"
"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"
"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/predicate"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
extensionsv1alpha1 "github.com/gardener/terminal-controller-manager/api/v1alpha1"
"github.com/gardener/terminal-controller-manager/internal/gardenclient"
"github.com/gardener/terminal-controller-manager/internal/utils"
)
// ServiceAccountReconciler reconciles a ServiceAccount object
type ServiceAccountReconciler struct {
client.Client
Log logr.Logger
Recorder record.EventRecorder
Config *extensionsv1alpha1.ControllerManagerConfiguration
configMutex sync.RWMutex
}
// SetupWithManager sets up manager with a new controller and r as the reconcile.Reconciler
func (r *ServiceAccountReconciler) SetupWithManager(mgr ctrl.Manager, config extensionsv1alpha1.ServiceAccountControllerConfiguration) error {
return ctrl.NewControllerManagedBy(mgr).
For(&corev1.ServiceAccount{}, builder.WithPredicates(r.serviceAccountPredicate())).
Watches(
&extensionsv1alpha1.Terminal{},
handler.EnqueueRequestsFromMapFunc(func(_ context.Context, obj client.Object) []reconcile.Request {
// request reconciliation for service accounts that are referenced in deleted terminals and for which CleanupProjectMembership was set to true.
logger := r.Log.WithValues("terminal", client.ObjectKeyFromObject(obj))
terminal, ok := obj.(*extensionsv1alpha1.Terminal)
if !ok {
logger.Error(nil, "object cannot be converted to Terminal")
return []reconcile.Request{}
}
if !ptr.Deref(terminal.Spec.Target.CleanupProjectMembership, false) || terminal.Spec.Target.Credentials.ServiceAccountRef == nil {
// cleanup project membership not set or no service account referenced - nothing to do
return []reconcile.Request{}
}
return []reconcile.Request{
{
NamespacedName: types.NamespacedName{
Namespace: terminal.Spec.Target.Credentials.ServiceAccountRef.Namespace,
Name: terminal.Spec.Target.Credentials.ServiceAccountRef.Name,
},
},
}
}),
builder.WithPredicates(r.terminalPredicate())).
Named("serviceaccount").
WithOptions(controller.Options{
MaxConcurrentReconciles: config.MaxConcurrentReconciles,
}).
Complete(r)
}
// serviceAccountPredicate returns true for service accounts having the TerminalReference label
func (r *ServiceAccountReconciler) serviceAccountPredicate() predicate.Funcs {
return predicate.Funcs{
CreateFunc: func(e event.CreateEvent) bool {
logger := r.Log.WithValues("event", e)
if e.Object == nil {
logger.Error(nil, "Create event has no runtime object to create")
return false
}
obj, ok := e.Object.(*corev1.ServiceAccount)
if !ok {
logger.Error(nil, "Update event runtime object cannot be converted to ServiceAccount")
return false
}
nameAllowed := utils.IsAllowed(r.getConfig().Controllers.ServiceAccount.AllowedServiceAccountNames, obj.Name)
if !nameAllowed {
logger.Info("service account name is not on allow-list -> event will be ignored")
return false
}
if obj.Labels[extensionsv1alpha1.TerminalReference] == "true" {
return true
}
// no change detected that is relevant for this controller
return false
},
UpdateFunc: func(e event.UpdateEvent) bool {
logger := r.Log.WithValues("event", e)
if e.ObjectOld == nil {
logger.Error(nil, "Update event has no old runtime object to update")
return false
}
if e.ObjectNew == nil {
logger.Error(nil, "Update event has no new runtime object for update")
return false
}
oldObj, ok := e.ObjectOld.(*corev1.ServiceAccount)
if !ok {
logger.Error(nil, "Update event old runtime object cannot be converted to ServiceAccount")
return false
}
nameAllowed := utils.IsAllowed(r.getConfig().Controllers.ServiceAccount.AllowedServiceAccountNames, oldObj.Name)
if !nameAllowed {
logger.Info("service account name is not on allow-list -> event will be ignored")
return false
}
newObj, ok := e.ObjectNew.(*corev1.ServiceAccount)
if !ok {
logger.Error(nil, "Update event new runtime object cannot be converted to ServiceAccount")
return false
}
// TerminalReference label has changed to true - event should be processed
if oldObj.Labels[extensionsv1alpha1.TerminalReference] != newObj.Labels[extensionsv1alpha1.TerminalReference] &&
newObj.Labels[extensionsv1alpha1.TerminalReference] == "true" {
return true
}
// ServiceAccount was marked for deletion - event should be processed
if oldObj.ObjectMeta.DeletionTimestamp.IsZero() && !newObj.ObjectMeta.DeletionTimestamp.IsZero() {
return true
}
// no change detected that is relevant for this controller
return false
},
DeleteFunc: func(e event.DeleteEvent) bool {
logger := r.Log.WithValues("event", e)
if e.Object == nil {
logger.Error(nil, "Create event has no runtime object to create")
return false
}
obj, ok := e.Object.(*corev1.ServiceAccount)
if !ok {
logger.Error(nil, "Update event runtime object cannot be converted to ServiceAccount")
return false
}
nameAllowed := utils.IsAllowed(r.getConfig().Controllers.ServiceAccount.AllowedServiceAccountNames, obj.Name)
if !nameAllowed {
logger.Info("service account name is not on allow-list -> event will be ignored")
return false
}
if controllerutil.ContainsFinalizer(obj, extensionsv1alpha1.ExternalTerminalName) {
return true
}
if obj.Labels[extensionsv1alpha1.TerminalReference] == "true" {
return true
}
// no change detected that is relevant for this controller
return false
},
}
}
// terminalPredicate returns true for delete events of Terminal resources, where a service account is referenced and the CleanupProjectMembership flag is true
func (r *ServiceAccountReconciler) terminalPredicate() predicate.Funcs {
return predicate.Funcs{
CreateFunc: func(_ event.CreateEvent) bool {
return false
},
UpdateFunc: func(_ event.UpdateEvent) bool {
return false
},
DeleteFunc: func(e event.DeleteEvent) bool {
logger := r.Log.WithValues("event", e)
if e.Object == nil {
logger.Error(nil, "Delete event has no old runtime object to update")
return false
}
terminal, ok := e.Object.(*extensionsv1alpha1.Terminal)
if !ok {
logger.Error(nil, "Delete event runtime object cannot be converted to Terminal")
return false
}
if !ptr.Deref(terminal.Spec.Target.CleanupProjectMembership, false) || terminal.Spec.Target.Credentials.ServiceAccountRef == nil {
// cleanup project membership not set or no service account referenced - terminal resource is not relevant for this controller
return false
}
return true
},
GenericFunc: func(_ event.GenericEvent) bool {
return false
},
}
}
func (r *ServiceAccountReconciler) getConfig() *extensionsv1alpha1.ControllerManagerConfiguration {
r.configMutex.RLock()
defer r.configMutex.RUnlock()
return r.Config
}
// Reconcile implements reconcile.Reconciler.
func (r *ServiceAccountReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
logger := r.Log.WithValues("serviceAccount", req.NamespacedName)
logger.Info("Reconciling ServiceAccount")
{ // serviceAccount-variable scope
serviceAccount := &corev1.ServiceAccount{}
if err := r.Get(ctx, req.NamespacedName, serviceAccount); err != nil {
// IgnoreNotFound: if the service account is already gone we assume the project membership is already clean and do not attempt to clean it up
return ctrl.Result{}, client.IgnoreNotFound(err)
}
if serviceAccount.Labels[extensionsv1alpha1.TerminalReference] != "true" {
logger.Info("service account is not labeled to have a terminal reference. Removing finalizer")
return ctrl.Result{}, r.removeFinalizer(ctx, req)
}
}
nameAllowed := utils.IsAllowed(r.getConfig().Controllers.ServiceAccount.AllowedServiceAccountNames, req.Name)
if !nameAllowed {
logger.Info("service account name is not on allow-list and thus will not be reconciled. Removing terminal reference label and finalizer")
return ctrl.Result{}, r.removeTerminalReferenceLabelAndFinalizer(ctx, req)
}
terminals := &extensionsv1alpha1.TerminalList{}
// only consider terminal resources in the same namespace as the service account
err := r.List(ctx, terminals, &client.ListOptions{Namespace: req.Namespace})
if err != nil {
// Error reading the list - requeue the request.
return ctrl.Result{}, err
}
referenced := false
for _, t := range terminals.Items {
if matchesNamespaceAndName(t.Spec.Target.Credentials.ServiceAccountRef, req.NamespacedName) {
referenced = true
break
}
if matchesNamespaceAndName(t.Spec.Host.Credentials.ServiceAccountRef, req.NamespacedName) {
referenced = true
break
}
}
if referenced {
logger.Info("ServiceAccount is still in use. Defer project membership cleanup")
// nothing to do for now as it is still referenced. A reconcile request will be created once a terminal was deleted
return ctrl.Result{}, nil
}
projectNamespace := req.Namespace
if ptr.Deref(r.getConfig().HonourCleanupProjectMembership, false) {
logger.Info("Removing ServiceAccount from project member list")
if err := r.removeServiceAccountFromProjectMember(ctx, req.NamespacedName, projectNamespace); err != nil {
return ctrl.Result{}, err
}
}
logger.Info("Done. Removing finalizer")
return ctrl.Result{}, r.removeFinalizer(ctx, req)
}
func (r *ServiceAccountReconciler) removeFinalizer(ctx context.Context, req ctrl.Request) error {
serviceAccount := &corev1.ServiceAccount{}
err := r.Get(ctx, req.NamespacedName, serviceAccount)
if err != nil {
return client.IgnoreNotFound(err)
}
controllerutil.RemoveFinalizer(serviceAccount, extensionsv1alpha1.ExternalTerminalName)
return client.IgnoreNotFound(r.Update(ctx, serviceAccount))
}
func (r *ServiceAccountReconciler) removeTerminalReferenceLabelAndFinalizer(ctx context.Context, req ctrl.Request) error {
serviceAccount := &corev1.ServiceAccount{}
err := r.Get(ctx, req.NamespacedName, serviceAccount)
if err != nil {
return client.IgnoreNotFound(err)
}
delete(serviceAccount.Labels, extensionsv1alpha1.TerminalReference)
controllerutil.RemoveFinalizer(serviceAccount, extensionsv1alpha1.ExternalTerminalName)
return client.IgnoreNotFound(r.Update(ctx, serviceAccount))
}
// matchesNamespaceAndName returns true if namespace and name matches for the given ObjectReference and NamespacedName
func matchesNamespaceAndName(ref *corev1.ObjectReference, serviceAccount types.NamespacedName) bool {
return ref != nil && ref.Namespace == serviceAccount.Namespace && ref.Name == serviceAccount.Name
}
func (r *ServiceAccountReconciler) removeServiceAccountFromProjectMember(ctx context.Context, serviceAccount types.NamespacedName, projectNamespace string) error {
project, err := gardenclient.GetProjectByNamespace(ctx, r.Client, projectNamespace)
if err != nil {
return err
}
return gardenclient.RemoveServiceAccountFromProjectMember(ctx, r.Client, project, serviceAccount)
}