/
utils.go
354 lines (298 loc) · 11.9 KB
/
utils.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
// Copyright (c) 2019 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 controller
import (
"context"
"fmt"
"reflect"
"time"
controllererror "github.com/gardener/gardener/extensions/pkg/controller/error"
"github.com/gardener/gardener/extensions/pkg/util"
"github.com/gardener/gardener/pkg/api/extensions"
gardencorev1beta1 "github.com/gardener/gardener/pkg/apis/core/v1beta1"
v1beta1constants "github.com/gardener/gardener/pkg/apis/core/v1beta1/constants"
extensionsv1alpha1 "github.com/gardener/gardener/pkg/apis/extensions/v1alpha1"
kutil "github.com/gardener/gardener/pkg/utils/kubernetes"
resourcemanagerv1alpha1 "github.com/gardener/gardener-resource-manager/pkg/apis/resources/v1alpha1"
autoscalingv1 "k8s.io/api/autoscaling/v1"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
utilruntime "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/apimachinery/pkg/util/wait"
autoscalingv1beta2 "k8s.io/autoscaler/vertical-pod-autoscaler/pkg/apis/autoscaling.k8s.io/v1beta2"
"k8s.io/client-go/kubernetes/scheme"
"k8s.io/client-go/util/retry"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/manager"
"sigs.k8s.io/controller-runtime/pkg/manager/signals"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)
var (
localSchemeBuilder = runtime.NewSchemeBuilder(
scheme.AddToScheme,
extensionsv1alpha1.AddToScheme,
resourcemanagerv1alpha1.AddToScheme,
)
// AddToScheme adds the Kubernetes and extension scheme to the given scheme.
AddToScheme = localSchemeBuilder.AddToScheme
// ExtensionsScheme is the default scheme for extensions, consisting of all Kubernetes built-in
// schemes (client-go/kubernetes/scheme) and the extensions/v1alpha1 scheme.
ExtensionsScheme = runtime.NewScheme()
)
func init() {
utilruntime.Must(AddToScheme(ExtensionsScheme))
}
// ReconcileErr returns a reconcile.Result or an error, depending on whether the error is a
// RequeueAfterError or not.
func ReconcileErr(err error) (reconcile.Result, error) {
if requeueAfter, ok := err.(*controllererror.RequeueAfterError); ok {
return reconcile.Result{Requeue: true, RequeueAfter: requeueAfter.RequeueAfter}, nil
}
return reconcile.Result{}, err
}
// ReconcileErrCause returns the cause in case the error is an RequeueAfterError. Otherwise,
// it returns the input error.
func ReconcileErrCause(err error) error {
if requeueAfter, ok := err.(*controllererror.RequeueAfterError); ok {
return requeueAfter.Cause
}
return err
}
// ReconcileErrCauseOrErr returns the cause of the error or the error if the cause is nil.
func ReconcileErrCauseOrErr(err error) error {
if cause := ReconcileErrCause(err); cause != nil {
return cause
}
return err
}
// SetupSignalHandlerContext sets up a context from signals.SetupSignalHandler stop channel.
func SetupSignalHandlerContext() context.Context {
return util.ContextFromStopChannel(signals.SetupSignalHandler())
}
// AddToManagerBuilder aggregates various AddToManager functions.
type AddToManagerBuilder []func(manager.Manager) error
// NewAddToManagerBuilder creates a new AddToManagerBuilder and registers the given functions.
func NewAddToManagerBuilder(funcs ...func(manager.Manager) error) AddToManagerBuilder {
var builder AddToManagerBuilder
builder.Register(funcs...)
return builder
}
// Register registers the given functions in this builder.
func (a *AddToManagerBuilder) Register(funcs ...func(manager.Manager) error) {
*a = append(*a, funcs...)
}
// AddToManager traverses over all AddToManager-functions of this builder, sequentially applying
// them. It exits on the first error and returns it.
func (a *AddToManagerBuilder) AddToManager(m manager.Manager) error {
for _, f := range *a {
if err := f(m); err != nil {
return err
}
}
return nil
}
func finalizersAndAccessorOf(obj runtime.Object) (sets.String, metav1.Object, error) {
accessor, err := meta.Accessor(obj)
if err != nil {
return nil, nil, err
}
return sets.NewString(accessor.GetFinalizers()...), accessor, nil
}
// HasFinalizer checks if the given object has a finalizer with the given name.
func HasFinalizer(obj runtime.Object, finalizerName string) (bool, error) {
finalizers, _, err := finalizersAndAccessorOf(obj)
if err != nil {
return false, err
}
return finalizers.Has(finalizerName), nil
}
// EnsureFinalizer ensures that a finalizer of the given name is set on the given object.
// If the finalizer is not set, it adds it to the list of finalizers and updates the remote object.
func EnsureFinalizer(ctx context.Context, client client.Client, finalizerName string, obj runtime.Object) error {
finalizers, accessor, err := finalizersAndAccessorOf(obj)
if err != nil {
return err
}
if finalizers.Has(finalizerName) {
return nil
}
finalizers.Insert(finalizerName)
accessor.SetFinalizers(finalizers.UnsortedList())
return client.Update(ctx, obj)
}
// DeleteFinalizer ensures that the given finalizer is not present anymore in the given object.
// If it is set, it removes it and issues an update.
func DeleteFinalizer(ctx context.Context, client client.Client, finalizerName string, obj runtime.Object) error {
finalizers, accessor, err := finalizersAndAccessorOf(obj)
if err != nil {
return err
}
if !finalizers.Has(finalizerName) {
return nil
}
finalizers.Delete(finalizerName)
accessor.SetFinalizers(finalizers.UnsortedList())
return client.Update(ctx, obj)
}
// DeleteAllFinalizers removes all finalizers from the object and issues an update.
func DeleteAllFinalizers(ctx context.Context, client client.Client, obj runtime.Object) error {
return TryUpdate(ctx, retry.DefaultBackoff, client, obj, func() error {
accessor, err := meta.Accessor(obj)
if err != nil {
return err
}
accessor.SetFinalizers(nil)
return nil
})
}
// SecretReferenceToKey returns the key of the given SecretReference.
func SecretReferenceToKey(ref *corev1.SecretReference) client.ObjectKey {
return kutil.Key(ref.Namespace, ref.Name)
}
// GetSecretByReference returns the Secret object matching the given SecretReference.
func GetSecretByReference(ctx context.Context, c client.Client, ref *corev1.SecretReference) (*corev1.Secret, error) {
secret := &corev1.Secret{}
if err := c.Get(ctx, SecretReferenceToKey(ref), secret); err != nil {
return nil, err
}
return secret, nil
}
// TryUpdate tries to apply the given transformation function onto the given object, and to update it afterwards.
// It retries the update with an exponential backoff.
func TryUpdate(ctx context.Context, backoff wait.Backoff, c client.Client, obj runtime.Object, transform func() error) error {
return tryUpdate(ctx, backoff, c, obj, c.Update, transform)
}
// TryUpdateStatus tries to apply the given transformation function onto the given object, and to update its
// status afterwards. It retries the status update with an exponential backoff.
func TryUpdateStatus(ctx context.Context, backoff wait.Backoff, c client.Client, obj runtime.Object, transform func() error) error {
return tryUpdate(ctx, backoff, c, obj, c.Status().Update, transform)
}
func tryUpdate(ctx context.Context, backoff wait.Backoff, c client.Client, obj runtime.Object, updateFunc func(context.Context, runtime.Object, ...client.UpdateOption) error, transform func() error) error {
key, err := client.ObjectKeyFromObject(obj)
if err != nil {
return err
}
return exponentialBackoff(ctx, backoff, func() (bool, error) {
if err := c.Get(ctx, key, obj); err != nil {
return false, err
}
beforeTransform := obj.DeepCopyObject()
if err := transform(); err != nil {
return false, err
}
if reflect.DeepEqual(obj, beforeTransform) {
return true, nil
}
if err := updateFunc(ctx, obj); err != nil {
if apierrors.IsConflict(err) {
return false, nil
}
return false, err
}
return true, nil
})
}
func exponentialBackoff(ctx context.Context, backoff wait.Backoff, condition wait.ConditionFunc) error {
duration := backoff.Duration
for i := 0; i < backoff.Steps; i++ {
if ok, err := condition(); err != nil || ok {
return err
}
select {
case <-ctx.Done():
return ctx.Err()
default:
adjusted := duration
if backoff.Jitter > 0.0 {
adjusted = wait.Jitter(duration, backoff.Jitter)
}
time.Sleep(adjusted)
duration = time.Duration(float64(duration) * backoff.Factor)
}
i++
}
return wait.ErrWaitTimeout
}
// WatchBuilder holds various functions which add watch controls to the passed Controller.
type WatchBuilder []func(controller.Controller) error
// NewWatchBuilder creates a new WatchBuilder and registers the given functions.
func NewWatchBuilder(funcs ...func(controller.Controller) error) WatchBuilder {
var builder WatchBuilder
builder.Register(funcs...)
return builder
}
// Register adds a function which add watch controls to the passed Controller to the WatchBuilder.
func (w *WatchBuilder) Register(funcs ...func(controller.Controller) error) {
*w = append(*w, funcs...)
}
// AddToController adds the registered watches to the passed controller.
func (w *WatchBuilder) AddToController(ctrl controller.Controller) error {
for _, f := range *w {
if err := f(ctrl); err != nil {
return err
}
}
return nil
}
// UnsafeGuessKind makes an unsafe guess what is the kind of the given object.
//
// The argument to this method _has_ to be a pointer, otherwise it panics.
func UnsafeGuessKind(obj runtime.Object) string {
t := reflect.TypeOf(obj)
if t.Kind() != reflect.Ptr {
panic(fmt.Sprintf("kind of obj %T is not pointer", obj))
}
return t.Elem().Name()
}
// GetVerticalPodAutoscalerObject returns unstructured.Unstructured representing autoscalingv1beta2.VerticalPodAutoscaler
func GetVerticalPodAutoscalerObject() *unstructured.Unstructured {
obj := &unstructured.Unstructured{}
obj.SetAPIVersion(autoscalingv1beta2.SchemeGroupVersion.String())
obj.SetKind("VerticalPodAutoscaler")
return obj
}
// RemoveAnnotation removes an annotation key passed as annotation
func RemoveAnnotation(ctx context.Context, c client.Client, obj runtime.Object, annotation string) error {
accessor, err := meta.Accessor(obj)
if err != nil {
return err
}
withAnnotation := obj.DeepCopyObject()
annotations := accessor.GetAnnotations()
delete(annotations, annotation)
accessor.SetAnnotations(annotations)
return c.Patch(ctx, obj, client.MergeFrom(withAnnotation))
}
// IsMigrated checks if an extension object has been migrated
func IsMigrated(obj runtime.Object) bool {
acc, err := extensions.Accessor(obj)
if err != nil {
return false
}
lastOp := acc.GetExtensionStatus().GetLastOperation()
return lastOp != nil &&
lastOp.Type == gardencorev1beta1.LastOperationTypeMigrate &&
lastOp.State == gardencorev1beta1.LastOperationStateSucceeded
}
// GetObjectByReference gets an object by the given reference, in the given namespace.
// If the object kind doesn't match the given reference kind this will result in an error.
func GetObjectByReference(ctx context.Context, c client.Client, ref *autoscalingv1.CrossVersionObjectReference, namespace string, obj runtime.Object) error {
return c.Get(ctx, client.ObjectKey{Namespace: namespace, Name: v1beta1constants.ReferencedResourcesPrefix + ref.Name}, obj)
}