/
actuator.go
373 lines (321 loc) · 14.3 KB
/
actuator.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
// 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 genericactuator
import (
"context"
"fmt"
"strings"
"time"
machinev1alpha1 "github.com/gardener/machine-controller-manager/pkg/apis/machine/v1alpha1"
"github.com/go-logr/logr"
"github.com/pkg/errors"
corev1 "k8s.io/api/core/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/rest"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/runtime/inject"
extensionscontroller "github.com/gardener/gardener/extensions/pkg/controller"
"github.com/gardener/gardener/extensions/pkg/controller/worker"
workerhelper "github.com/gardener/gardener/extensions/pkg/controller/worker/helper"
v1beta1constants "github.com/gardener/gardener/pkg/apis/core/v1beta1/constants"
extensionsv1alpha1 "github.com/gardener/gardener/pkg/apis/extensions/v1alpha1"
gardenerkubernetes "github.com/gardener/gardener/pkg/client/kubernetes"
"github.com/gardener/gardener/pkg/controllerutils"
"github.com/gardener/gardener/pkg/utils/chart"
"github.com/gardener/gardener/pkg/utils/imagevector"
kutil "github.com/gardener/gardener/pkg/utils/kubernetes"
)
// GardenPurposeMachineClass is a constant for the 'machineclass' value in a label.
const GardenPurposeMachineClass = "machineclass"
type genericActuator struct {
logger logr.Logger
delegateFactory DelegateFactory
mcmName string
mcmSeedChart chart.Interface
mcmShootChart chart.Interface
imageVector imagevector.ImageVector
client client.Client
clientset kubernetes.Interface
reader client.Reader
scheme *runtime.Scheme
gardenerClientset gardenerkubernetes.Interface
chartApplier gardenerkubernetes.ChartApplier
chartRendererFactory extensionscontroller.ChartRendererFactory
}
// NewActuator creates a new Actuator that reconciles
// Worker resources of Gardener's `extensions.gardener.cloud` API group.
// It provides a default implementation that allows easier integration of providers.
func NewActuator(logger logr.Logger, delegateFactory DelegateFactory, mcmName string, mcmSeedChart, mcmShootChart chart.Interface, imageVector imagevector.ImageVector, chartRendererFactory extensionscontroller.ChartRendererFactory) worker.Actuator {
return &genericActuator{
logger: logger.WithName("worker-actuator"),
delegateFactory: delegateFactory,
mcmName: mcmName,
mcmSeedChart: mcmSeedChart,
mcmShootChart: mcmShootChart,
imageVector: imageVector,
chartRendererFactory: chartRendererFactory,
}
}
func (a *genericActuator) InjectFunc(f inject.Func) error {
return f(a.delegateFactory)
}
func (a *genericActuator) InjectClient(client client.Client) error {
a.client = client
return nil
}
func (a *genericActuator) InjectAPIReader(reader client.Reader) error {
a.reader = reader
return nil
}
func (a *genericActuator) InjectScheme(scheme *runtime.Scheme) error {
a.scheme = scheme
return nil
}
func (a *genericActuator) InjectConfig(config *rest.Config) error {
var err error
a.clientset, err = kubernetes.NewForConfig(config)
if err != nil {
return errors.Wrap(err, "could not create Kubernetes client")
}
a.gardenerClientset, err = gardenerkubernetes.NewWithConfig(gardenerkubernetes.WithRESTConfig(config))
if err != nil {
return errors.Wrap(err, "could not create Gardener client")
}
a.chartApplier = a.gardenerClientset.ChartApplier()
return nil
}
func (a *genericActuator) cleanupMachineDeployments(ctx context.Context, logger logr.Logger, existingMachineDeployments *machinev1alpha1.MachineDeploymentList, wantedMachineDeployments worker.MachineDeployments) error {
logger.Info("Cleaning up machine deployments")
for _, existingMachineDeployment := range existingMachineDeployments.Items {
if !wantedMachineDeployments.HasDeployment(existingMachineDeployment.Name) {
if err := a.client.Delete(ctx, &existingMachineDeployment); err != nil {
return err
}
}
}
return nil
}
func (a *genericActuator) listMachineClassNames(ctx context.Context, namespace string, machineClassList client.ObjectList) (sets.String, error) {
if err := a.client.List(ctx, machineClassList, client.InNamespace(namespace)); err != nil {
return nil, err
}
classNames := sets.NewString()
if err := meta.EachListItem(machineClassList, func(machineClass runtime.Object) error {
accessor, err := meta.Accessor(machineClass)
if err != nil {
return err
}
classNames.Insert(accessor.GetName())
return nil
}); err != nil {
return nil, err
}
return classNames, nil
}
func (a *genericActuator) cleanupMachineClasses(ctx context.Context, logger logr.Logger, namespace string, machineClassList client.ObjectList, wantedMachineDeployments worker.MachineDeployments) error {
logger.Info("Cleaning up machine classes")
if err := a.client.List(ctx, machineClassList, client.InNamespace(namespace)); err != nil {
return err
}
return meta.EachListItem(machineClassList, func(obj runtime.Object) error {
machineClass := obj.(client.Object)
if !wantedMachineDeployments.HasClass(machineClass.GetName()) {
logger.Info("Deleting machine class", "machineClass", machineClass)
if err := a.client.Delete(ctx, machineClass); err != nil {
return err
}
}
return nil
})
}
func getMachineClassSecretLabels() map[string]string {
return map[string]string{v1beta1constants.GardenerPurpose: GardenPurposeMachineClass}
}
func (a *genericActuator) listMachineClassSecrets(ctx context.Context, namespace string) (*corev1.SecretList, error) {
secretList := &corev1.SecretList{}
if err := a.client.List(ctx, secretList, client.InNamespace(namespace), client.MatchingLabels(getMachineClassSecretLabels())); err != nil {
return nil, err
}
return secretList, nil
}
// cleanupMachineClassSecrets deletes all unused machine class secrets (i.e., those which are not part
// of the provided list <usedSecrets>.
func (a *genericActuator) cleanupMachineClassSecrets(ctx context.Context, logger logr.Logger, namespace string, wantedMachineDeployments worker.MachineDeployments) error {
logger.Info("Cleaning up machine class secrets")
secretList, err := a.listMachineClassSecrets(ctx, namespace)
if err != nil {
return err
}
// Cleanup all secrets which were used for machine classes that do not exist anymore.
for _, secret := range secretList.Items {
if !wantedMachineDeployments.HasSecret(secret.Name) {
if err := a.client.Delete(ctx, &secret); err != nil {
return err
}
}
}
return nil
}
// updateCloudCredentialsInAllMachineClassSecrets updates the cloud credentials
// for all existing machine class secrets.
func (a *genericActuator) updateCloudCredentialsInAllMachineClassSecrets(ctx context.Context, logger logr.Logger, cloudCredentials map[string][]byte, namespace string) error {
logger.Info("Updating cloud credentials for existing machine class secrets")
secretList, err := a.listMachineClassSecrets(ctx, namespace)
if err != nil {
return errors.Wrapf(err, "failed to list machine class secrets in namespace %s", namespace)
}
for _, secret := range secretList.Items {
secretCopy := secret.DeepCopy()
for key, value := range cloudCredentials {
secretCopy.Data[key] = value
}
if err := a.client.Patch(ctx, secretCopy, client.MergeFrom(&secret)); err != nil {
return errors.Wrapf(err, "failed to patch secret %s/%s with cloud credentials", namespace, secret.Name)
}
}
return nil
}
// shallowDeleteMachineClassSecrets deletes all unused machine class secrets (i.e., those which are not part
// of the provided list <usedSecrets>) without waiting for MCM to do this.
func (a *genericActuator) shallowDeleteMachineClassSecrets(ctx context.Context, logger logr.Logger, namespace string, wantedMachineDeployments worker.MachineDeployments) error {
logger.Info("Shallow deleting machine class secrets")
secretList, err := a.listMachineClassSecrets(ctx, namespace)
if err != nil {
return err
}
// Delete the finalizers to all secrets which were used for machine classes that do not exist anymore.
for _, secret := range secretList.Items {
if !wantedMachineDeployments.HasSecret(secret.Name) {
if err := extensionscontroller.DeleteAllFinalizers(ctx, a.client, &secret); err != nil {
return errors.Wrapf(err, "Error removing finalizer from MachineClassSecret: %s/%s", secret.Namespace, secret.Name)
}
if err := a.client.Delete(ctx, &secret); err != nil {
return err
}
}
}
return nil
}
// removeFinalizerFromWorkerSecretRef removes the MCM finalizers from the secret that is referenced by the worker
func (a *genericActuator) removeFinalizerFromWorkerSecretRef(ctx context.Context, logger logr.Logger, worker *extensionsv1alpha1.Worker) error {
logger.Info("Removing MCM finalizers from worker`s secret")
secret, err := kutil.GetSecretByReference(ctx, a.client, &worker.Spec.SecretRef)
if err != nil {
if apierrors.IsNotFound(err) {
return nil
}
return err
}
finalizersToRemove := []string{}
if controllerutil.ContainsFinalizer(secret, mcmFinalizer) {
finalizersToRemove = append(finalizersToRemove, mcmFinalizer)
}
if controllerutil.ContainsFinalizer(secret, mcmProviderFinalizer) {
finalizersToRemove = append(finalizersToRemove, mcmProviderFinalizer)
}
if len(finalizersToRemove) == 0 {
return nil
}
return controllerutils.PatchRemoveFinalizers(ctx, a.client, secret, finalizersToRemove...)
}
// cleanupMachineSets deletes MachineSets having number of desired and actual replicas equaling 0
func (a *genericActuator) cleanupMachineSets(ctx context.Context, logger logr.Logger, namespace string) error {
logger.Info("Cleaning up machine sets")
machineSetList := &machinev1alpha1.MachineSetList{}
if err := a.client.List(ctx, machineSetList, client.InNamespace(namespace)); err != nil {
return err
}
for _, machineSet := range machineSetList.Items {
if machineSet.Spec.Replicas == 0 && machineSet.Status.Replicas == 0 {
logger.Info("Deleting MachineSet as the number of desired and actual replicas is 0", "machineSet", &machineSet)
if err := a.client.Delete(ctx, machineSet.DeepCopy()); client.IgnoreNotFound(err) != nil {
return err
}
}
}
return nil
}
func (a *genericActuator) shallowDeleteAllObjects(ctx context.Context, logger logr.Logger, namespace string, objectList client.ObjectList) error {
var objectKind interface{} = strings.TrimSuffix(fmt.Sprintf("%T", objectList), "List")
if gvk, err := apiutil.GVKForObject(objectList, a.scheme); err == nil {
objectKind = gvk
}
logger.Info("Shallow deleting all objects of kind", "kind", objectKind)
if err := a.client.List(ctx, objectList, client.InNamespace(namespace)); err != nil {
return err
}
return meta.EachListItem(objectList, func(obj runtime.Object) error {
object := obj.(client.Object)
if err := extensionscontroller.DeleteAllFinalizers(ctx, a.client, object); err != nil {
return err
}
if err := a.client.Delete(ctx, object); client.IgnoreNotFound(err) != nil {
return err
}
return nil
})
}
// IsMachineControllerStuck determines if the machine controller pod is stuck.
func (a *genericActuator) IsMachineControllerStuck(ctx context.Context, worker *extensionsv1alpha1.Worker) (bool, *string, error) {
machineDeployments := &machinev1alpha1.MachineDeploymentList{}
if err := a.client.List(ctx, machineDeployments, client.InNamespace(worker.Namespace)); err != nil {
return false, nil, err
}
machineSets := &machinev1alpha1.MachineSetList{}
if err := a.client.List(ctx, machineSets, client.InNamespace(worker.Namespace)); err != nil {
return false, nil, err
}
isStuck, msg := isMachineControllerStuck(machineSets.Items, machineDeployments.Items)
return isStuck, msg, nil
}
const (
// stuckMCMThreshold defines that the machine deployment set has to be created more than
// this duration ago to be considered for the check whether a machine controller manager pod is stuck
stuckMCMThreshold = 2 * time.Minute
// mcmFinalizer is the finalizer used by the machine controller manager
// not imported from the MCM to reduce dependencies
mcmFinalizer = "machine.sapcloud.io/machine-controller-manager"
// mcmProviderFinalizer is the finalizer used by the out-of-tree machine controller provider
// not imported from the out-of-tree MCM provider to reduce dependencies
mcmProviderFinalizer = "machine.sapcloud.io/machine-controller"
)
// isMachineControllerStuck determines if the machine controller pod is stuck.
// A pod is assumed to be stuck if
// - a machine deployment exists that does not have a machine set with the correct machine class
// - the machine set does not have a status that indicates (attempted) machine creation
func isMachineControllerStuck(machineSets []machinev1alpha1.MachineSet, machineDeployments []machinev1alpha1.MachineDeployment) (bool, *string) {
// map the owner reference to the existing machine sets
ownerReferenceToMachineSet := workerhelper.BuildOwnerToMachineSetsMap(machineSets)
for _, machineDeployment := range machineDeployments {
if !controllerutil.ContainsFinalizer(&machineDeployment, mcmFinalizer) {
continue
}
// do not consider machine deployments that have just recently been created
if time.Now().UTC().Sub(machineDeployment.ObjectMeta.CreationTimestamp.UTC()) < stuckMCMThreshold {
continue
}
machineSet := workerhelper.GetMachineSetWithMachineClass(machineDeployment.Name, machineDeployment.Spec.Template.Spec.Class.Name, ownerReferenceToMachineSet)
if machineSet == nil {
msg := fmt.Sprintf("missing machine set for machine deployment (%s/%s)", machineDeployment.Namespace, machineDeployment.Name)
return true, &msg
}
}
return false, nil
}