-
-
Notifications
You must be signed in to change notification settings - Fork 737
/
pushsecret_controller.go
467 lines (415 loc) · 15.5 KB
/
pushsecret_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
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
/*
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 pushsecret
import (
"context"
"errors"
"fmt"
"strings"
"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/runtime"
"k8s.io/apimachinery/pkg/types"
"k8s.io/client-go/tools/record"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
esapi "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
"github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
ctrlmetrics "github.com/external-secrets/external-secrets/pkg/controllers/metrics"
"github.com/external-secrets/external-secrets/pkg/controllers/pushsecret/psmetrics"
"github.com/external-secrets/external-secrets/pkg/controllers/secretstore"
"github.com/external-secrets/external-secrets/pkg/provider/util/locks"
"github.com/external-secrets/external-secrets/pkg/utils"
)
const (
errFailedGetSecret = "could not get source secret"
errPatchStatus = "error merging"
errGetSecretStore = "could not get SecretStore %q, %w"
errGetClusterSecretStore = "could not get ClusterSecretStore %q, %w"
errSetSecretFailed = "could not write remote ref %v to target secretstore %v: %v"
errFailedSetSecret = "set secret failed: %v"
errConvert = "could not apply conversion strategy to keys: %v"
pushSecretFinalizer = "pushsecret.externalsecrets.io/finalizer"
)
type Reconciler struct {
client.Client
Log logr.Logger
Scheme *runtime.Scheme
recorder record.EventRecorder
RequeueInterval time.Duration
ControllerClass string
}
func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
r.recorder = mgr.GetEventRecorderFor("pushsecret")
return ctrl.NewControllerManagedBy(mgr).
For(&esapi.PushSecret{}).
Complete(r)
}
func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
log := r.Log.WithValues("pushsecret", req.NamespacedName)
resourceLabels := ctrlmetrics.RefineNonConditionMetricLabels(map[string]string{"name": req.Name, "namespace": req.Namespace})
start := time.Now()
pushSecretReconcileDuration := psmetrics.GetGaugeVec(psmetrics.PushSecretReconcileDurationKey)
defer func() { pushSecretReconcileDuration.With(resourceLabels).Set(float64(time.Since(start))) }()
var ps esapi.PushSecret
mgr := secretstore.NewManager(r.Client, r.ControllerClass, false)
defer mgr.Close(ctx)
if err := r.Get(ctx, req.NamespacedName, &ps); err != nil {
if apierrors.IsNotFound(err) {
return ctrl.Result{}, nil
}
msg := "unable to get PushSecret"
r.recorder.Event(&ps, v1.EventTypeWarning, esapi.ReasonErrored, msg)
log.Error(err, msg)
return ctrl.Result{}, fmt.Errorf("get resource: %w", err)
}
refreshInt := r.RequeueInterval
if ps.Spec.RefreshInterval != nil {
refreshInt = ps.Spec.RefreshInterval.Duration
}
p := client.MergeFrom(ps.DeepCopy())
defer func() {
if err := r.Client.Status().Patch(ctx, &ps, p); err != nil {
log.Error(err, errPatchStatus)
}
}()
switch ps.Spec.DeletionPolicy {
case esapi.PushSecretDeletionPolicyDelete:
// finalizer logic. Only added if we should delete the secrets
if ps.ObjectMeta.DeletionTimestamp.IsZero() {
if !controllerutil.ContainsFinalizer(&ps, pushSecretFinalizer) {
controllerutil.AddFinalizer(&ps, pushSecretFinalizer)
if err := r.Client.Update(ctx, &ps, &client.UpdateOptions{}); err != nil {
return ctrl.Result{}, fmt.Errorf("could not update finalizers: %w", err)
}
return ctrl.Result{}, nil
}
} else {
if controllerutil.ContainsFinalizer(&ps, pushSecretFinalizer) {
// trigger a cleanup with no Synced Map
badState, err := r.DeleteSecretFromProviders(ctx, &ps, esapi.SyncedPushSecretsMap{}, mgr)
if err != nil {
msg := fmt.Sprintf("Failed to Delete Secrets from Provider: %v", err)
r.markAsFailed(msg, &ps, badState)
return ctrl.Result{}, err
}
controllerutil.RemoveFinalizer(&ps, pushSecretFinalizer)
if err := r.Client.Update(ctx, &ps, &client.UpdateOptions{}); err != nil {
return ctrl.Result{}, fmt.Errorf("could not update finalizers: %w", err)
}
return ctrl.Result{}, nil
}
}
case esapi.PushSecretDeletionPolicyNone:
default:
}
secret, err := r.GetSecret(ctx, ps)
if err != nil {
r.markAsFailed(errFailedGetSecret, &ps, nil)
return ctrl.Result{}, err
}
secretStores, err := r.GetSecretStores(ctx, ps)
if err != nil {
r.markAsFailed(err.Error(), &ps, nil)
return ctrl.Result{}, err
}
if err := r.applyTemplate(ctx, &ps, secret); err != nil {
return ctrl.Result{}, err
}
syncedSecrets, err := r.PushSecretToProviders(ctx, secretStores, ps, secret, mgr)
if err != nil {
if errors.Is(err, locks.ErrConflict) {
log.Info("retry to acquire lock to update the secret later", "error", err)
return ctrl.Result{Requeue: true}, nil
}
totalSecrets := mergeSecretState(syncedSecrets, ps.Status.SyncedPushSecrets)
msg := fmt.Sprintf(errFailedSetSecret, err)
r.markAsFailed(msg, &ps, totalSecrets)
return ctrl.Result{}, err
}
switch ps.Spec.DeletionPolicy {
case esapi.PushSecretDeletionPolicyDelete:
badSyncState, err := r.DeleteSecretFromProviders(ctx, &ps, syncedSecrets, mgr)
if err != nil {
msg := fmt.Sprintf("Failed to Delete Secrets from Provider: %v", err)
r.markAsFailed(msg, &ps, badSyncState)
return ctrl.Result{}, err
}
case esapi.PushSecretDeletionPolicyNone:
default:
}
r.markAsDone(&ps, syncedSecrets)
return ctrl.Result{RequeueAfter: refreshInt}, nil
}
func (r *Reconciler) markAsFailed(msg string, ps *esapi.PushSecret, syncState esapi.SyncedPushSecretsMap) {
cond := newPushSecretCondition(esapi.PushSecretReady, v1.ConditionFalse, esapi.ReasonErrored, msg)
setPushSecretCondition(ps, *cond)
if syncState != nil {
r.setSecrets(ps, syncState)
}
r.recorder.Event(ps, v1.EventTypeWarning, esapi.ReasonErrored, msg)
}
func (r *Reconciler) markAsDone(ps *esapi.PushSecret, secrets esapi.SyncedPushSecretsMap) {
msg := "PushSecret synced successfully"
if ps.Spec.UpdatePolicy == esapi.PushSecretUpdatePolicyIfNotExists {
msg += ". Existing secrets in providers unchanged."
}
cond := newPushSecretCondition(esapi.PushSecretReady, v1.ConditionTrue, esapi.ReasonSynced, msg)
setPushSecretCondition(ps, *cond)
r.setSecrets(ps, secrets)
r.recorder.Event(ps, v1.EventTypeNormal, esapi.ReasonSynced, msg)
}
func (r *Reconciler) setSecrets(ps *esapi.PushSecret, status esapi.SyncedPushSecretsMap) {
ps.Status.SyncedPushSecrets = status
}
func mergeSecretState(newMap, old esapi.SyncedPushSecretsMap) esapi.SyncedPushSecretsMap {
out := newMap.DeepCopy()
for k, v := range old {
_, ok := out[k]
if !ok {
out[k] = make(map[string]esapi.PushSecretData)
}
for kk, vv := range v {
out[k][kk] = vv
}
}
return out
}
func (r *Reconciler) DeleteSecretFromProviders(ctx context.Context, ps *esapi.PushSecret, newMap esapi.SyncedPushSecretsMap, mgr *secretstore.Manager) (esapi.SyncedPushSecretsMap, error) {
out := mergeSecretState(newMap, ps.Status.SyncedPushSecrets)
for storeName, oldData := range ps.Status.SyncedPushSecrets {
storeRef := v1beta1.SecretStoreRef{
Name: strings.Split(storeName, "/")[1],
Kind: strings.Split(storeName, "/")[0],
}
client, err := mgr.Get(ctx, storeRef, ps.Namespace, nil)
if err != nil {
return out, fmt.Errorf("could not get secrets client for store %v: %w", storeName, err)
}
newData, ok := newMap[storeName]
if !ok {
err = r.DeleteAllSecretsFromStore(ctx, client, oldData)
if err != nil {
return out, err
}
delete(out, storeName)
continue
}
for oldEntry, oldRef := range oldData {
_, ok := newData[oldEntry]
if !ok {
err = r.DeleteSecretFromStore(ctx, client, oldRef)
if err != nil {
return out, err
}
delete(out[storeName], oldRef.Match.RemoteRef.RemoteKey)
}
}
}
return out, nil
}
func (r *Reconciler) DeleteAllSecretsFromStore(ctx context.Context, client v1beta1.SecretsClient, data map[string]esapi.PushSecretData) error {
for _, v := range data {
err := r.DeleteSecretFromStore(ctx, client, v)
if err != nil {
return err
}
}
return nil
}
func (r *Reconciler) DeleteSecretFromStore(ctx context.Context, client v1beta1.SecretsClient, data esapi.PushSecretData) error {
return client.DeleteSecret(ctx, data.Match.RemoteRef)
}
func (r *Reconciler) PushSecretToProviders(ctx context.Context, stores map[esapi.PushSecretStoreRef]v1beta1.GenericStore, ps esapi.PushSecret, secret *v1.Secret, mgr *secretstore.Manager) (esapi.SyncedPushSecretsMap, error) {
out := make(esapi.SyncedPushSecretsMap)
for ref, store := range stores {
out, err := r.handlePushSecretDataForStore(ctx, ps, secret, out, mgr, store.GetName(), ref.Kind)
if err != nil {
return out, err
}
}
return out, nil
}
func (r *Reconciler) handlePushSecretDataForStore(ctx context.Context, ps esapi.PushSecret, secret *v1.Secret, out esapi.SyncedPushSecretsMap, mgr *secretstore.Manager, storeName, refKind string) (esapi.SyncedPushSecretsMap, error) {
storeKey := fmt.Sprintf("%v/%v", refKind, storeName)
out[storeKey] = make(map[string]esapi.PushSecretData)
storeRef := v1beta1.SecretStoreRef{
Name: storeName,
Kind: refKind,
}
originalSecretData := secret.Data
secretClient, err := mgr.Get(ctx, storeRef, ps.GetNamespace(), nil)
if err != nil {
return out, fmt.Errorf("could not get secrets client for store %v: %w", storeName, err)
}
for _, data := range ps.Spec.Data {
secretData, err := utils.ReverseKeys(data.ConversionStrategy, originalSecretData)
if err != nil {
return nil, fmt.Errorf(errConvert, err)
}
secret.Data = secretData
key := data.GetSecretKey()
if !secretKeyExists(key, secret) {
return out, fmt.Errorf("secret key %v does not exist", key)
}
switch ps.Spec.UpdatePolicy {
case esapi.PushSecretUpdatePolicyIfNotExists:
exists, err := secretClient.SecretExists(ctx, data.Match.RemoteRef)
if err != nil {
return out, fmt.Errorf("could not verify if secret exists in store: %w", err)
} else if exists {
out[storeKey][statusRef(data)] = data
continue
}
case esapi.PushSecretUpdatePolicyReplace:
default:
}
if err := secretClient.PushSecret(ctx, secret, data); err != nil {
return out, fmt.Errorf(errSetSecretFailed, key, storeName, err)
}
out[storeKey][statusRef(data)] = data
}
return out, nil
}
func secretKeyExists(key string, secret *v1.Secret) bool {
_, ok := secret.Data[key]
return key == "" || ok
}
func (r *Reconciler) GetSecret(ctx context.Context, ps esapi.PushSecret) (*v1.Secret, error) {
secretName := types.NamespacedName{Name: ps.Spec.Selector.Secret.Name, Namespace: ps.Namespace}
secret := &v1.Secret{}
err := r.Client.Get(ctx, secretName, secret)
if err != nil {
return nil, err
}
return secret, nil
}
func (r *Reconciler) GetSecretStores(ctx context.Context, ps esapi.PushSecret) (map[esapi.PushSecretStoreRef]v1beta1.GenericStore, error) {
stores := make(map[esapi.PushSecretStoreRef]v1beta1.GenericStore)
for _, refStore := range ps.Spec.SecretStoreRefs {
if refStore.LabelSelector != nil {
labelSelector, err := metav1.LabelSelectorAsSelector(refStore.LabelSelector)
if err != nil {
return nil, fmt.Errorf("could not convert labels: %w", err)
}
if refStore.Kind == v1beta1.ClusterSecretStoreKind {
clusterSecretStoreList := v1beta1.ClusterSecretStoreList{}
err = r.List(ctx, &clusterSecretStoreList, &client.ListOptions{LabelSelector: labelSelector})
if err != nil {
return nil, fmt.Errorf("could not list cluster Secret Stores: %w", err)
}
for k, v := range clusterSecretStoreList.Items {
key := esapi.PushSecretStoreRef{
Name: v.Name,
Kind: v1beta1.ClusterSecretStoreKind,
}
stores[key] = &clusterSecretStoreList.Items[k]
}
} else {
secretStoreList := v1beta1.SecretStoreList{}
err = r.List(ctx, &secretStoreList, &client.ListOptions{LabelSelector: labelSelector})
if err != nil {
return nil, fmt.Errorf("could not list Secret Stores: %w", err)
}
for k, v := range secretStoreList.Items {
key := esapi.PushSecretStoreRef{
Name: v.Name,
Kind: v1beta1.SecretStoreKind,
}
stores[key] = &secretStoreList.Items[k]
}
}
} else {
store, err := r.getSecretStoreFromName(ctx, refStore, ps.Namespace)
if err != nil {
return nil, err
}
stores[refStore] = store
}
}
return stores, nil
}
func (r *Reconciler) getSecretStoreFromName(ctx context.Context, refStore esapi.PushSecretStoreRef, ns string) (v1beta1.GenericStore, error) {
if refStore.Name == "" {
return nil, fmt.Errorf("refStore Name must be provided")
}
ref := types.NamespacedName{
Name: refStore.Name,
}
if refStore.Kind == v1beta1.ClusterSecretStoreKind {
var store v1beta1.ClusterSecretStore
err := r.Get(ctx, ref, &store)
if err != nil {
return nil, fmt.Errorf(errGetClusterSecretStore, ref.Name, err)
}
return &store, nil
}
ref.Namespace = ns
var store v1beta1.SecretStore
err := r.Get(ctx, ref, &store)
if err != nil {
return nil, fmt.Errorf(errGetSecretStore, ref.Name, err)
}
return &store, nil
}
func newPushSecretCondition(condType esapi.PushSecretConditionType, status v1.ConditionStatus, reason, message string) *esapi.PushSecretStatusCondition {
return &esapi.PushSecretStatusCondition{
Type: condType,
Status: status,
LastTransitionTime: metav1.Now(),
Reason: reason,
Message: message,
}
}
func setPushSecretCondition(ps *esapi.PushSecret, condition esapi.PushSecretStatusCondition) {
currentCond := getPushSecretCondition(ps.Status, condition.Type)
if currentCond != nil && currentCond.Status == condition.Status &&
currentCond.Reason == condition.Reason && currentCond.Message == condition.Message {
return
}
// Do not update lastTransitionTime if the status of the condition doesn't change.
if currentCond != nil && currentCond.Status == condition.Status {
condition.LastTransitionTime = currentCond.LastTransitionTime
}
ps.Status.Conditions = append(filterOutCondition(ps.Status.Conditions, condition.Type), condition)
}
// filterOutCondition returns an empty set of conditions with the provided type.
func filterOutCondition(conditions []esapi.PushSecretStatusCondition, condType esapi.PushSecretConditionType) []esapi.PushSecretStatusCondition {
newConditions := make([]esapi.PushSecretStatusCondition, 0, len(conditions))
for _, c := range conditions {
if c.Type == condType {
continue
}
newConditions = append(newConditions, c)
}
return newConditions
}
// getPushSecretCondition returns the condition with the provided type.
func getPushSecretCondition(status esapi.PushSecretStatus, condType esapi.PushSecretConditionType) *esapi.PushSecretStatusCondition {
for i := range status.Conditions {
c := status.Conditions[i]
if c.Type == condType {
return &c
}
}
return nil
}
func statusRef(ref v1beta1.PushSecretData) string {
if ref.GetProperty() != "" {
return ref.GetRemoteKey() + "/" + ref.GetProperty()
}
return ref.GetRemoteKey()
}