-
-
Notifications
You must be signed in to change notification settings - Fork 729
/
clusterexternalsecret_controller.go
391 lines (332 loc) · 12.8 KB
/
clusterexternalsecret_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
/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package clusterexternalsecret
import (
"context"
"fmt"
"reflect"
"slices"
"sort"
"time"
"github.com/go-logr/logr"
v1 "k8s.io/api/core/v1"
apierrors "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/types"
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"
esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
"github.com/external-secrets/external-secrets/pkg/controllers/clusterexternalsecret/cesmetrics"
ctrlmetrics "github.com/external-secrets/external-secrets/pkg/controllers/metrics"
)
// ClusterExternalSecretReconciler reconciles a ClusterExternalSecret object.
type Reconciler struct {
client.Client
Log logr.Logger
Scheme *runtime.Scheme
RequeueInterval time.Duration
}
const (
errGetCES = "could not get ClusterExternalSecret"
errPatchStatus = "unable to patch status"
errConvertLabelSelector = "unable to convert labelselector"
errGetExistingES = "could not get existing ExternalSecret"
errNamespacesFailed = "one or more namespaces failed"
)
func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
log := r.Log.WithValues("ClusterExternalSecret", req.NamespacedName)
resourceLabels := ctrlmetrics.RefineNonConditionMetricLabels(map[string]string{"name": req.Name, "namespace": req.Namespace})
start := time.Now()
externalSecretReconcileDuration := cesmetrics.GetGaugeVec(cesmetrics.ClusterExternalSecretReconcileDurationKey)
defer func() { externalSecretReconcileDuration.With(resourceLabels).Set(float64(time.Since(start))) }()
var clusterExternalSecret esv1beta1.ClusterExternalSecret
err := r.Get(ctx, req.NamespacedName, &clusterExternalSecret)
if err != nil {
if apierrors.IsNotFound(err) {
cesmetrics.RemoveMetrics(req.Namespace, req.Name)
return ctrl.Result{}, nil
}
log.Error(err, errGetCES)
return ctrl.Result{}, err
}
// skip reconciliation if deletion timestamp is set on cluster external secret
if clusterExternalSecret.DeletionTimestamp != nil {
log.Info("skipping as it is in deletion")
return ctrl.Result{}, nil
}
p := client.MergeFrom(clusterExternalSecret.DeepCopy())
defer r.deferPatch(ctx, log, &clusterExternalSecret, p)
refreshInt := r.RequeueInterval
if clusterExternalSecret.Spec.RefreshInterval != nil {
refreshInt = clusterExternalSecret.Spec.RefreshInterval.Duration
}
esName := clusterExternalSecret.Spec.ExternalSecretName
if esName == "" {
esName = clusterExternalSecret.ObjectMeta.Name
}
if prevName := clusterExternalSecret.Status.ExternalSecretName; prevName != esName {
// ExternalSecretName has changed, so remove the old ones
for _, ns := range clusterExternalSecret.Status.ProvisionedNamespaces {
if err := r.deleteExternalSecret(ctx, prevName, clusterExternalSecret.Name, ns); err != nil {
log.Error(err, "could not delete ExternalSecret")
return ctrl.Result{}, err
}
}
}
clusterExternalSecret.Status.ExternalSecretName = esName
namespaces, err := r.getTargetNamespaces(ctx, &clusterExternalSecret)
if err != nil {
log.Error(err, "failed to get target Namespaces")
return ctrl.Result{}, err
}
failedNamespaces := r.deleteOutdatedExternalSecrets(ctx, namespaces, esName, clusterExternalSecret.Name, clusterExternalSecret.Status.ProvisionedNamespaces)
provisionedNamespaces := []string{}
for _, namespace := range namespaces {
var existingES esv1beta1.ExternalSecret
err = r.Get(ctx, types.NamespacedName{
Name: esName,
Namespace: namespace.Name,
}, &existingES)
if err != nil && !apierrors.IsNotFound(err) {
log.Error(err, errGetExistingES)
failedNamespaces[namespace.Name] = err
continue
}
if err == nil && !isExternalSecretOwnedBy(&existingES, clusterExternalSecret.Name) {
failedNamespaces[namespace.Name] = fmt.Errorf("external secret already exists in namespace")
continue
}
if err := r.createOrUpdateExternalSecret(ctx, &clusterExternalSecret, namespace, esName, clusterExternalSecret.Spec.ExternalSecretMetadata); err != nil {
log.Error(err, "failed to create or update external secret")
failedNamespaces[namespace.Name] = err
continue
}
provisionedNamespaces = append(provisionedNamespaces, namespace.Name)
}
condition := NewClusterExternalSecretCondition(failedNamespaces)
SetClusterExternalSecretCondition(&clusterExternalSecret, *condition)
clusterExternalSecret.Status.FailedNamespaces = toNamespaceFailures(failedNamespaces)
sort.Strings(provisionedNamespaces)
clusterExternalSecret.Status.ProvisionedNamespaces = provisionedNamespaces
return ctrl.Result{RequeueAfter: refreshInt}, nil
}
func (r *Reconciler) getTargetNamespaces(ctx context.Context, ces *esv1beta1.ClusterExternalSecret) ([]v1.Namespace, error) {
selectors := []*metav1.LabelSelector{}
if s := ces.Spec.NamespaceSelector; s != nil {
selectors = append(selectors, s)
}
for _, ns := range ces.Spec.Namespaces {
selectors = append(selectors, &metav1.LabelSelector{
MatchLabels: map[string]string{
"kubernetes.io/metadata.name": ns,
},
})
}
selectors = append(selectors, ces.Spec.NamespaceSelectors...)
var namespaces []v1.Namespace
namespaceSet := make(map[string]struct{})
for _, selector := range selectors {
labelSelector, err := metav1.LabelSelectorAsSelector(selector)
if err != nil {
return nil, fmt.Errorf("failed to convert label selector %s: %w", selector, err)
}
var nl v1.NamespaceList
err = r.List(ctx, &nl, &client.ListOptions{LabelSelector: labelSelector})
if err != nil {
return nil, fmt.Errorf("failed to list namespaces by label selector %s: %w", selector, err)
}
for _, n := range nl.Items {
if _, exist := namespaceSet[n.Name]; exist {
continue
}
namespaceSet[n.Name] = struct{}{}
namespaces = append(namespaces, n)
}
}
return namespaces, nil
}
func (r *Reconciler) createOrUpdateExternalSecret(ctx context.Context, clusterExternalSecret *esv1beta1.ClusterExternalSecret, namespace v1.Namespace, esName string, esMetadata esv1beta1.ExternalSecretMetadata) error {
externalSecret := &esv1beta1.ExternalSecret{
ObjectMeta: metav1.ObjectMeta{
Namespace: namespace.Name,
Name: esName,
},
}
mutateFunc := func() error {
externalSecret.Labels = esMetadata.Labels
externalSecret.Annotations = esMetadata.Annotations
externalSecret.Spec = clusterExternalSecret.Spec.ExternalSecretSpec
if err := controllerutil.SetControllerReference(clusterExternalSecret, externalSecret, r.Scheme); err != nil {
return fmt.Errorf("could not set the controller owner reference %w", err)
}
return nil
}
if _, err := ctrl.CreateOrUpdate(ctx, r.Client, externalSecret, mutateFunc); err != nil {
return fmt.Errorf("could not create or update ExternalSecret: %w", err)
}
return nil
}
func (r *Reconciler) deleteExternalSecret(ctx context.Context, esName, cesName, namespace string) error {
var existingES esv1beta1.ExternalSecret
err := r.Get(ctx, types.NamespacedName{
Name: esName,
Namespace: namespace,
}, &existingES)
if err != nil {
// If we can't find it then just leave
if apierrors.IsNotFound(err) {
return nil
}
return err
}
if !isExternalSecretOwnedBy(&existingES, cesName) {
return nil
}
err = r.Delete(ctx, &existingES, &client.DeleteOptions{})
if err != nil {
return fmt.Errorf("external secret in non matching namespace could not be deleted: %w", err)
}
return nil
}
func (r *Reconciler) deferPatch(ctx context.Context, log logr.Logger, clusterExternalSecret *esv1beta1.ClusterExternalSecret, p client.Patch) {
if err := r.Status().Patch(ctx, clusterExternalSecret, p); err != nil {
log.Error(err, errPatchStatus)
}
}
func (r *Reconciler) deleteOutdatedExternalSecrets(ctx context.Context, namespaces []v1.Namespace, esName, cesName string, provisionedNamespaces []string) map[string]error {
failedNamespaces := map[string]error{}
// Loop through existing namespaces first to make sure they still have our labels
for _, namespace := range getRemovedNamespaces(namespaces, provisionedNamespaces) {
err := r.deleteExternalSecret(ctx, esName, cesName, namespace)
if err != nil {
r.Log.Error(err, "unable to delete external secret")
failedNamespaces[namespace] = err
}
}
return failedNamespaces
}
func isExternalSecretOwnedBy(es *esv1beta1.ExternalSecret, cesName string) bool {
owner := metav1.GetControllerOf(es)
return owner != nil && owner.APIVersion == esv1beta1.SchemeGroupVersion.String() && owner.Kind == esv1beta1.ClusterExtSecretKind && owner.Name == cesName
}
func getRemovedNamespaces(currentNSs []v1.Namespace, provisionedNSs []string) []string {
currentNSSet := map[string]struct{}{}
for _, currentNs := range currentNSs {
currentNSSet[currentNs.Name] = struct{}{}
}
var removedNSs []string
for _, ns := range provisionedNSs {
if _, ok := currentNSSet[ns]; !ok {
removedNSs = append(removedNSs, ns)
}
}
return removedNSs
}
func toNamespaceFailures(failedNamespaces map[string]error) []esv1beta1.ClusterExternalSecretNamespaceFailure {
namespaceFailures := make([]esv1beta1.ClusterExternalSecretNamespaceFailure, len(failedNamespaces))
i := 0
for namespace, err := range failedNamespaces {
namespaceFailures[i] = esv1beta1.ClusterExternalSecretNamespaceFailure{
Namespace: namespace,
Reason: err.Error(),
}
i++
}
sort.Slice(namespaceFailures, func(i, j int) bool { return namespaceFailures[i].Namespace < namespaceFailures[j].Namespace })
return namespaceFailures
}
// SetupWithManager sets up the controller with the Manager.
func (r *Reconciler) SetupWithManager(mgr ctrl.Manager, opts controller.Options) error {
return ctrl.NewControllerManagedBy(mgr).
WithOptions(opts).
For(&esv1beta1.ClusterExternalSecret{}).
Owns(&esv1beta1.ExternalSecret{}).
Watches(
&v1.Namespace{},
handler.EnqueueRequestsFromMapFunc(r.findObjectsForNamespace),
builder.WithPredicates(namespacePredicate()),
).
Complete(r)
}
func (r *Reconciler) findObjectsForNamespace(ctx context.Context, namespace client.Object) []reconcile.Request {
var clusterExternalSecrets esv1beta1.ClusterExternalSecretList
if err := r.List(ctx, &clusterExternalSecrets); err != nil {
r.Log.Error(err, errGetCES)
return []reconcile.Request{}
}
var requests []reconcile.Request
for i := range clusterExternalSecrets.Items {
clusterExternalSecret := &clusterExternalSecrets.Items[i]
var selectors []*metav1.LabelSelector
if s := clusterExternalSecret.Spec.NamespaceSelector; s != nil {
selectors = append(selectors, s)
}
selectors = append(selectors, clusterExternalSecret.Spec.NamespaceSelectors...)
var selected bool
for _, selector := range selectors {
labelSelector, err := metav1.LabelSelectorAsSelector(selector)
if err != nil {
r.Log.Error(err, errConvertLabelSelector)
continue
}
if labelSelector.Matches(labels.Set(namespace.GetLabels())) {
requests = append(requests, reconcile.Request{
NamespacedName: types.NamespacedName{
Name: clusterExternalSecret.GetName(),
Namespace: clusterExternalSecret.GetNamespace(),
},
})
selected = true
break
}
}
// Prevent the object from being added twice if it happens to be listed
// by Namespaces selector as well.
if selected {
continue
}
if slices.Contains(clusterExternalSecret.Spec.Namespaces, namespace.GetName()) {
requests = append(requests, reconcile.Request{
NamespacedName: types.NamespacedName{
Name: clusterExternalSecret.GetName(),
Namespace: clusterExternalSecret.GetNamespace(),
},
})
}
}
return requests
}
func namespacePredicate() predicate.Predicate {
return predicate.Funcs{
CreateFunc: func(e event.CreateEvent) bool {
return true
},
UpdateFunc: func(e event.UpdateEvent) bool {
if e.ObjectOld == nil || e.ObjectNew == nil {
return false
}
return !reflect.DeepEqual(e.ObjectOld.GetLabels(), e.ObjectNew.GetLabels())
},
DeleteFunc: func(deleteEvent event.DeleteEvent) bool {
return true
},
}
}