-
Notifications
You must be signed in to change notification settings - Fork 450
/
secretbinding_control.go
227 lines (194 loc) · 9.47 KB
/
secretbinding_control.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
// Copyright (c) 2018 SAP SE or an SAP affiliate company. All rights reserved. This file is licensed under the Apache Software License, v. 2 except as noted otherwise in the LICENSE file
//
// 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 secretbinding
import (
"context"
"errors"
"fmt"
"time"
gardencorev1beta1 "github.com/gardener/gardener/pkg/apis/core/v1beta1"
v1beta1constants "github.com/gardener/gardener/pkg/apis/core/v1beta1/constants"
gardencoreinformers "github.com/gardener/gardener/pkg/client/core/informers/externalversions"
gardencorelisters "github.com/gardener/gardener/pkg/client/core/listers/core/v1beta1"
"github.com/gardener/gardener/pkg/client/kubernetes"
"github.com/gardener/gardener/pkg/controllerutils"
"github.com/gardener/gardener/pkg/logger"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/labels"
kubecorev1listers "k8s.io/client-go/listers/core/v1"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/tools/record"
)
func (c *Controller) secretBindingAdd(obj interface{}) {
key, err := cache.MetaNamespaceKeyFunc(obj)
if err != nil {
logger.Logger.Errorf("Couldn't get key for object %+v: %v", obj, err)
return
}
c.secretBindingQueue.Add(key)
}
func (c *Controller) secretBindingUpdate(oldObj, newObj interface{}) {
c.secretBindingAdd(newObj)
}
func (c *Controller) secretBindingDelete(obj interface{}) {
key, err := cache.DeletionHandlingMetaNamespaceKeyFunc(obj)
if err != nil {
logger.Logger.Errorf("Couldn't get key for object %+v: %v", obj, err)
return
}
c.secretBindingQueue.Add(key)
}
func (c *Controller) reconcileSecretBindingKey(key string) error {
namespace, name, err := cache.SplitMetaNamespaceKey(key)
if err != nil {
return err
}
secretBinding, err := c.secretBindingLister.SecretBindings(namespace).Get(name)
if apierrors.IsNotFound(err) {
logger.Logger.Debugf("[SECRETBINDING RECONCILE] %s - skipping because SecretBinding has been deleted", key)
return nil
}
if err != nil {
logger.Logger.Infof("[SECRETBINDING RECONCILE] %s - unable to retrieve object from store: %v", key, err)
return err
}
if err := c.control.ReconcileSecretBinding(secretBinding, key); err != nil {
c.secretBindingQueue.AddAfter(key, time.Minute)
}
return nil
}
// ControlInterface implements the control logic for updating SecretBindings. It is implemented as an interface to allow
// for extensions that provide different semantics. Currently, there is only one implementation.
type ControlInterface interface {
// ReconcileSecretBinding implements the control logic for SecretBinding creation, update, and deletion.
// If an implementation returns a non-nil error, the invocation will be retried using a rate-limited strategy.
// Implementors should sink any errors that they do not wish to trigger a retry, and they may feel free to
// exit exceptionally at any point provided they wish the update to be re-run at a later point in time.
ReconcileSecretBinding(secretBinding *gardencorev1beta1.SecretBinding, key string) error
}
// NewDefaultControl returns a new instance of the default implementation ControlInterface that
// implements the documented semantics for SecretBindings. You should use an instance returned from NewDefaultControl()
// for any scenario other than testing.
func NewDefaultControl(k8sGardenClient kubernetes.Interface, k8sGardenCoreInformers gardencoreinformers.SharedInformerFactory, recorder record.EventRecorder, secretBindingLister gardencorelisters.SecretBindingLister, secretLister kubecorev1listers.SecretLister, shootLister gardencorelisters.ShootLister) ControlInterface {
return &defaultControl{k8sGardenClient, k8sGardenCoreInformers, recorder, secretBindingLister, secretLister, shootLister}
}
type defaultControl struct {
k8sGardenClient kubernetes.Interface
k8sGardenCoreInformers gardencoreinformers.SharedInformerFactory
recorder record.EventRecorder
secretBindingLister gardencorelisters.SecretBindingLister
secretLister kubecorev1listers.SecretLister
shootLister gardencorelisters.ShootLister
}
func (c *defaultControl) ReconcileSecretBinding(obj *gardencorev1beta1.SecretBinding, key string) error {
_, err := cache.MetaNamespaceKeyFunc(obj)
if err != nil {
return err
}
var (
secretBinding = obj.DeepCopy()
secretBindingLogger = logger.NewFieldLogger(logger.Logger, "secretbinding", fmt.Sprintf("%s/%s", secretBinding.Namespace, secretBinding.Name))
ctx = context.TODO()
)
// The deletionTimestamp labels a SecretBinding as intended to get deleted. Before deletion,
// it has to be ensured that no Shoots are depending on the SecretBinding anymore.
// When this happens the controller will remove the finalizers from the SecretBinding so that it can be garbage collected.
if secretBinding.DeletionTimestamp != nil {
if !controllerutils.HasFinalizer(secretBinding, gardencorev1beta1.GardenerName) {
return nil
}
associatedShoots, err := controllerutils.DetermineShootsAssociatedTo(secretBinding, c.shootLister)
if err != nil {
secretBindingLogger.Error(err.Error())
return err
}
if len(associatedShoots) == 0 {
secretBindingLogger.Info("No Shoots are referencing the SecretBinding. Deletion accepted.")
mayReleaseSecret, err := c.mayReleaseSecret(secretBinding.Namespace, secretBinding.Name, secretBinding.SecretRef.Namespace, secretBinding.SecretRef.Name)
if err != nil {
secretBindingLogger.Error(err.Error())
return err
}
if mayReleaseSecret {
// Remove finalizer from referenced secret
secret, err := c.secretLister.Secrets(secretBinding.SecretRef.Namespace).Get(secretBinding.SecretRef.Name)
if err == nil {
if err2 := controllerutils.RemoveFinalizer(ctx, c.k8sGardenClient.Client(), secret.DeepCopy(), gardencorev1beta1.ExternalGardenerName); err2 != nil {
secretBindingLogger.Error(err2.Error())
return err2
}
// TODO: This code can be removed in a future version.
if controllerutils.HasFinalizer(secret, gardencorev1beta1.ExternalGardenerNameDeprecated) {
if err2 := controllerutils.RemoveFinalizer(ctx, c.k8sGardenClient.Client(), secret.DeepCopy(), gardencorev1beta1.ExternalGardenerNameDeprecated); err2 != nil {
secretBindingLogger.Errorf("Could not remove deprecated finalizer from Secret referenced in SecretBinding: %s", err2.Error())
return err2
}
}
} else if !apierrors.IsNotFound(err) {
return err
}
}
// Remove finalizer from SecretBinding
if err := controllerutils.RemoveFinalizer(ctx, c.k8sGardenClient.Client(), secretBinding, gardencorev1beta1.GardenerName); err != nil {
secretBindingLogger.Error(err.Error())
return err
}
return nil
}
message := fmt.Sprintf("Can't delete SecretBinding, because the following Shoots are still referencing it: %v", associatedShoots)
secretBindingLogger.Infof(message)
c.recorder.Event(secretBinding, corev1.EventTypeNormal, v1beta1constants.EventResourceReferenced, message)
return errors.New("SecretBinding still has references")
}
if err := controllerutils.EnsureFinalizer(ctx, c.k8sGardenClient.Client(), secretBinding, gardencorev1beta1.GardenerName); err != nil {
secretBindingLogger.Errorf("Could not add finalizer to SecretBinding: %s", err.Error())
return err
}
// Add the Gardener finalizer to the referenced SecretBinding secret to protect it from deletion as long as
// the SecretBinding resource does exist.
secret, err := c.secretLister.Secrets(secretBinding.SecretRef.Namespace).Get(secretBinding.SecretRef.Name)
if err != nil {
secretBindingLogger.Error(err.Error())
return err
}
if err := controllerutils.EnsureFinalizer(ctx, c.k8sGardenClient.Client(), secret.DeepCopy(), gardencorev1beta1.ExternalGardenerName); err != nil {
secretBindingLogger.Errorf("Could not add finalizer to Secret referenced in SecretBinding: %s", err.Error())
return err
}
// TODO: This code can be removed in a future version.
if controllerutils.HasFinalizer(secret, gardencorev1beta1.ExternalGardenerNameDeprecated) {
if err := controllerutils.RemoveFinalizer(ctx, c.k8sGardenClient.Client(), secret.DeepCopy(), gardencorev1beta1.ExternalGardenerNameDeprecated); err != nil {
secretBindingLogger.Errorf("Could not remove deprecated finalizer from Secret referenced in SecretBinding: %s", err.Error())
return err
}
}
return nil
}
// We may only release a secret if there is no other secretbinding that references it (maybe in a different namespace).
func (c *defaultControl) mayReleaseSecret(secretBindingNamespace, secretBindingName, secretNamespace, secretName string) (bool, error) {
secretBindingList, err := c.secretBindingLister.List(labels.Everything())
if err != nil {
return false, err
}
for _, secretBinding := range secretBindingList {
if secretBinding.Namespace == secretBindingNamespace && secretBinding.Name == secretBindingName {
continue
}
if secretBinding.SecretRef.Namespace == secretNamespace && secretBinding.SecretRef.Name == secretName {
return false, nil
}
}
return true, nil
}