-
Notifications
You must be signed in to change notification settings - Fork 20
/
secret_finalizer_gc_controller.go
190 lines (163 loc) · 6.09 KB
/
secret_finalizer_gc_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
// Copyright (c) 2024 Aiven, Helsinki, Finland. https://aiven.io/
package controllers
import (
"context"
"fmt"
"reflect"
"github.com/go-logr/logr"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
"k8s.io/apimachinery/pkg/fields"
"k8s.io/apimachinery/pkg/types"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"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"
"sigs.k8s.io/controller-runtime/pkg/source"
"github.com/aiven/aiven-operator/api/v1alpha1"
)
// SecretFinalizerGCController manages the protection finalizer of the
// client token secrets, to give the controllers a chance to delete the
// aiven instances
type SecretFinalizerGCController struct {
client.Client
Log logr.Logger
}
func (c *SecretFinalizerGCController) SetupWithManager(mgr ctrl.Manager, hasDefaultToken bool) error {
aivenManagedTypes := c.knownInstanceTypes()
if err := indexClientSecretRefFields(context.Background(), mgr, aivenManagedTypes...); err != nil {
return fmt.Errorf("unable to add index for secret ref fields: %w", err)
}
builder := ctrl.NewControllerManagedBy(mgr)
builder.For(&corev1.Secret{})
// only watch for delete events
builder.WithEventFilter(predicate.Funcs{
CreateFunc: func(e event.CreateEvent) bool { return false },
UpdateFunc: func(e event.UpdateEvent) bool { return false },
DeleteFunc: func(e event.DeleteEvent) bool { return true },
GenericFunc: func(e event.GenericEvent) bool { return false },
})
// watch aiven CRDs to queue secret reconciliations
for i := range aivenManagedTypes {
builder.Watches(
&source.Kind{Type: aivenManagedTypes[i]},
handler.EnqueueRequestsFromMapFunc(func(a client.Object) []reconcile.Request {
ao := a.(v1alpha1.AivenManagedObject)
if auth := ao.AuthSecretRef(); auth != nil {
return []reconcile.Request{
{
NamespacedName: types.NamespacedName{
Name: auth.Name,
Namespace: ao.GetNamespace(),
},
},
}
} else if !hasDefaultToken {
gvk := ao.GetObjectKind().GroupVersionKind().String()
namespacedName := types.NamespacedName{
Name: ao.GetName(),
Namespace: ao.GetNamespace(),
}
c.Log.Error(fmt.Errorf("%w: resource %s %s", errNoTokenProvided, gvk, namespacedName), "")
}
return nil
}),
)
}
return builder.Complete(c)
}
func (c *SecretFinalizerGCController) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
secret := &corev1.Secret{}
if err := c.Get(ctx, req.NamespacedName, secret); err != nil {
if errors.IsNotFound(err) {
return ctrl.Result{}, nil
}
return ctrl.Result{}, err
}
// we only care about secrets that have our finalizer
if !controllerutil.ContainsFinalizer(secret, secretProtectionFinalizer) {
return ctrl.Result{}, nil
}
c.Log.Info("handling reconciliation request", "request", req)
// check for dangeling instances that still need the secret for deletion
if isStillNeeded, err := c.secretIsStillNeeded(ctx, secret); err != nil {
return ctrl.Result{}, fmt.Errorf("unable to check if secret is still needed: %w", err)
} else if isStillNeeded {
c.Log.Info("secret is still needed, waiting for next reconciliation")
return ctrl.Result{}, nil
}
c.Log.Info("removing secret protection finalizer")
// secret is not needed anymore
if err := removeFinalizer(ctx, c, secret, secretProtectionFinalizer); err != nil {
return ctrl.Result{}, fmt.Errorf("unable to remove secret protection finalizer: %w", err)
}
return ctrl.Result{}, nil
}
func (c *SecretFinalizerGCController) knownListTypes() []client.ObjectList {
res := make([]client.ObjectList, 0)
for _, t := range c.Scheme().KnownTypes(v1alpha1.GroupVersion) {
if list, ok := reflect.New(t).Interface().(client.ObjectList); ok {
res = append(res, list)
}
}
return res
}
func (c *SecretFinalizerGCController) knownInstanceTypes() []v1alpha1.AivenManagedObject {
res := make([]v1alpha1.AivenManagedObject, 0)
for _, t := range c.Scheme().KnownTypes(v1alpha1.GroupVersion) {
if obj, ok := reflect.New(t).Interface().(v1alpha1.AivenManagedObject); ok {
res = append(res, obj)
}
}
return res
}
func (c *SecretFinalizerGCController) secretIsStillNeeded(ctx context.Context, secret *corev1.Secret) (bool, error) {
for _, listType := range c.knownListTypes() {
if needed, err := c.secretIsStillNeededBy(ctx, secret, listType); err != nil {
return false, fmt.Errorf("unable to decide if secret is still used by some aiven resource: %w", err)
} else if needed {
return true, nil
}
}
return false, nil
}
const (
// secretRefIndexKey is the key we index the name of the secret with
// so we can efficiently list all resources that use this secret
secretRefIndexKey = "spec.auth_secret_ref.name"
)
// secretRefIndexFunc indexes the client token secret names of aiven managed objects
func secretRefIndexFunc(o client.Object) []string {
if aivenObj, ok := o.(v1alpha1.AivenManagedObject); ok {
if auth := aivenObj.AuthSecretRef(); auth != nil {
return []string{auth.Name}
}
}
return nil
}
func indexClientSecretRefFields(ctx context.Context, mgr ctrl.Manager, objs ...v1alpha1.AivenManagedObject) error {
for i := range objs {
if err := mgr.GetFieldIndexer().IndexField(ctx, objs[i], secretRefIndexKey, secretRefIndexFunc); err != nil {
return err
}
}
return nil
}
// check if an instance uses this secret
func instancesThatUseThisSecret(secret *corev1.Secret) *client.ListOptions {
return &client.ListOptions{
Namespace: secret.GetNamespace(),
FieldSelector: fields.OneTermEqualSelector(secretRefIndexKey, secret.GetName()),
Limit: 1,
}
}
func (c *SecretFinalizerGCController) secretIsStillNeededBy(ctx context.Context, secret *corev1.Secret, list client.ObjectList) (bool, error) {
if err := c.List(ctx, list, instancesThatUseThisSecret(secret)); err != nil {
return false, client.IgnoreNotFound(err)
}
return meta.LenList(list) > 0, nil
}