/
k8s_utils.go
501 lines (440 loc) · 19.3 KB
/
k8s_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
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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
// Copyright (c) 2020 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 framework
import (
"context"
"errors"
"fmt"
"io"
"os"
"time"
gardencorev1beta1 "github.com/gardener/gardener/pkg/apis/core/v1beta1"
"github.com/gardener/gardener/pkg/client/kubernetes"
"github.com/gardener/gardener/pkg/utils"
kutil "github.com/gardener/gardener/pkg/utils/kubernetes"
"github.com/gardener/gardener/pkg/utils/kubernetes/health"
"github.com/gardener/gardener/pkg/utils/retry"
"github.com/sirupsen/logrus"
appsv1 "k8s.io/api/apps/v1"
corev1 "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/client-go/rest"
"k8s.io/utils/pointer"
"sigs.k8s.io/controller-runtime/pkg/client"
)
// WaitUntilDaemonSetIsRunning waits until the daemon set with <daemonSetName> is running
func (f *CommonFramework) WaitUntilDaemonSetIsRunning(ctx context.Context, k8sClient client.Client, daemonSetName, daemonSetNamespace string) error {
return retry.Until(ctx, defaultPollInterval, func(ctx context.Context) (done bool, err error) {
daemonSet := &appsv1.DaemonSet{}
if err := k8sClient.Get(ctx, client.ObjectKey{Namespace: daemonSetNamespace, Name: daemonSetName}, daemonSet); err != nil {
return retry.MinorError(err)
}
if err := health.CheckDaemonSet(daemonSet); err != nil {
f.Logger.Infof("Waiting for %q to be ready!", daemonSetName)
return retry.MinorError(fmt.Errorf("daemon set %q is not healthy: %v", daemonSetName, err))
}
f.Logger.Infof("Daemon set %q is now ready!", daemonSetName)
return retry.Ok()
})
}
// WaitUntilStatefulSetIsRunning waits until the stateful set with <statefulSetName> is running
func (f *CommonFramework) WaitUntilStatefulSetIsRunning(ctx context.Context, statefulSetName, statefulSetNamespace string, c kubernetes.Interface) error {
return retry.Until(ctx, defaultPollInterval, func(ctx context.Context) (done bool, err error) {
statefulSet := &appsv1.StatefulSet{}
if err := c.Client().Get(ctx, client.ObjectKey{Namespace: statefulSetNamespace, Name: statefulSetName}, statefulSet); err != nil {
return retry.MinorError(err)
}
if err := health.CheckStatefulSet(statefulSet); err != nil {
f.Logger.Infof("Waiting for %q to be ready!", statefulSetName)
return retry.MinorError(fmt.Errorf("stateful set %q is not healthy: %v", statefulSetName, err))
}
f.Logger.Infof("%s is now ready!!", statefulSetName)
return retry.Ok()
})
}
// WaitUntilDeploymentIsReady waits until the given deployment is ready
func (f *CommonFramework) WaitUntilDeploymentIsReady(ctx context.Context, name string, namespace string, k8sClient kubernetes.Interface) error {
return retry.Until(ctx, defaultPollInterval, func(ctx context.Context) (done bool, err error) {
deployment := &appsv1.Deployment{}
if err := k8sClient.Client().Get(ctx, client.ObjectKey{Namespace: namespace, Name: name}, deployment); err != nil {
if apierrors.IsNotFound(err) {
f.Logger.Infof("Waiting for deployment '%s/%s' to be ready!", namespace, name)
return retry.MinorError(fmt.Errorf("deployment %q in namespace %q does not exist", name, namespace))
}
return retry.SevereError(err)
}
err = health.CheckDeployment(deployment)
if err != nil {
f.Logger.Infof("Waiting for deployment '%s/%s' to be ready!", namespace, name)
return retry.MinorError(fmt.Errorf("deployment %q in namespace %q is not healthy", name, namespace))
}
return retry.Ok()
})
}
// WaitUntilDeploymentsWithLabelsIsReady wait until pod with labels <podLabels> is running
func (f *CommonFramework) WaitUntilDeploymentsWithLabelsIsReady(ctx context.Context, deploymentLabels labels.Selector, namespace string, k8sClient kubernetes.Interface) error {
return retry.Until(ctx, defaultPollInterval, func(ctx context.Context) (done bool, err error) {
deployments := &appsv1.DeploymentList{}
if err := k8sClient.Client().List(ctx, deployments, client.MatchingLabelsSelector{Selector: deploymentLabels}, client.InNamespace(namespace)); err != nil {
if apierrors.IsNotFound(err) {
f.Logger.Infof("Waiting for deployments with labels: %v to be ready!!", deploymentLabels.String())
return retry.MinorError(fmt.Errorf("no deployments with labels '%s' exist", deploymentLabels.String()))
}
return retry.SevereError(err)
}
for _, deployment := range deployments.Items {
err = health.CheckDeployment(&deployment)
if err != nil {
f.Logger.Infof("Waiting for deployments with labels: %v to be ready!", deploymentLabels)
return retry.MinorError(fmt.Errorf("deployment %q is not healthy: %v", deployment.Name, err))
}
}
return retry.Ok()
})
}
// WaitUntilNamespaceIsDeleted waits until a namespace has been deleted
func (f *CommonFramework) WaitUntilNamespaceIsDeleted(ctx context.Context, k8sClient kubernetes.Interface, ns string) error {
return retry.Until(ctx, defaultPollInterval, func(ctx context.Context) (bool, error) {
if err := k8sClient.Client().Get(ctx, client.ObjectKey{Name: ns}, &corev1.Namespace{}); err != nil {
if apierrors.IsNotFound(err) {
return retry.Ok()
}
return retry.MinorError(err)
}
return retry.MinorError(fmt.Errorf("Namespace %q is not deleted yet", ns))
})
}
// WaitForNNodesToBeHealthy waits for exactly <n> Nodes to be healthy within a given timeout
func WaitForNNodesToBeHealthy(ctx context.Context, k8sClient kubernetes.Interface, n int, timeout time.Duration) error {
return WaitForNNodesToBeHealthyInWorkerPool(ctx, k8sClient, n, nil, timeout)
}
// WaitForNNodesToBeHealthyInWorkerPool waits for exactly <n> Nodes in a given worker pool to be healthy within a given timeout
func WaitForNNodesToBeHealthyInWorkerPool(ctx context.Context, k8sClient kubernetes.Interface, n int, workerGroup *string, timeout time.Duration) error {
return retry.UntilTimeout(ctx, defaultPollInterval, timeout, func(ctx context.Context) (done bool, err error) {
nodeList, err := GetAllNodesInWorkerPool(ctx, k8sClient, workerGroup)
if err != nil {
return retry.SevereError(err)
}
nodeCount := len(nodeList.Items)
if nodeCount != n {
return retry.MinorError(fmt.Errorf("waiting for %d nodes to be ready: only %d nodes registered in the cluster", n, nodeCount))
}
for _, node := range nodeList.Items {
if err := health.CheckNode(&node); err != nil {
return retry.MinorError(fmt.Errorf("waiting for %d nodes to be ready: node %q is not healthy: %v", n, node.Name, err))
}
}
return retry.Ok()
})
}
// GetAllNodes fetches all nodes
func GetAllNodes(ctx context.Context, c kubernetes.Interface) (*corev1.NodeList, error) {
return GetAllNodesInWorkerPool(ctx, c, nil)
}
// GetAllNodesInWorkerPool fetches all nodes of a specific worker group
func GetAllNodesInWorkerPool(ctx context.Context, c kubernetes.Interface, workerGroup *string) (*corev1.NodeList, error) {
nodeList := &corev1.NodeList{}
selectorOption := &client.MatchingLabelsSelector{}
if workerGroup != nil && len(*workerGroup) > 0 {
selectorOption.Selector = labels.SelectorFromSet(labels.Set{"worker.gardener.cloud/pool": *workerGroup})
}
err := c.Client().List(ctx, nodeList, selectorOption)
return nodeList, err
}
// GetPodsByLabels fetches all pods with the desired set of labels <labelsMap>
func GetPodsByLabels(ctx context.Context, labelsSelector labels.Selector, c kubernetes.Interface, namespace string) (*corev1.PodList, error) {
podList := &corev1.PodList{}
err := c.Client().List(ctx, podList,
client.InNamespace(namespace),
client.MatchingLabelsSelector{Selector: labelsSelector})
if err != nil {
return nil, err
}
return podList, nil
}
// GetFirstRunningPodWithLabels fetches the first running pod with the desired set of labels <labelsMap>
func GetFirstRunningPodWithLabels(ctx context.Context, labelsMap labels.Selector, namespace string, client kubernetes.Interface) (*corev1.Pod, error) {
var (
podList *corev1.PodList
err error
)
podList, err = GetPodsByLabels(ctx, labelsMap, client, namespace)
if err != nil {
return nil, err
}
if len(podList.Items) == 0 {
return nil, ErrNoRunningPodsFound
}
for _, pod := range podList.Items {
if health.IsPodReady(&pod) {
return &pod, nil
}
}
return nil, ErrNoRunningPodsFound
}
// PodExecByLabel executes a command inside pods filtered by label
func PodExecByLabel(ctx context.Context, podLabels labels.Selector, podContainer, command, namespace string, client kubernetes.Interface) (io.Reader, error) {
pod, err := GetFirstRunningPodWithLabels(ctx, podLabels, namespace, client)
if err != nil {
return nil, err
}
return NewPodExecutor(client).Execute(ctx, pod.Namespace, pod.Name, podContainer, command)
}
// DeleteAndWaitForResource deletes a kubernetes resource and waits for its deletion
func DeleteAndWaitForResource(ctx context.Context, k8sClient kubernetes.Interface, resource client.Object, timeout time.Duration) error {
if err := kutil.DeleteObject(ctx, k8sClient.Client(), resource); err != nil {
return err
}
return retry.UntilTimeout(ctx, 5*time.Second, timeout, func(ctx context.Context) (done bool, err error) {
newResource := resource.DeepCopyObject().(client.Object)
if err := k8sClient.Client().Get(ctx, client.ObjectKeyFromObject(resource), newResource); err != nil {
if apierrors.IsNotFound(err) {
return retry.Ok()
}
return retry.MinorError(err)
}
return retry.MinorError(errors.New("Object still exists"))
})
}
// ScaleDeployment scales a deployment and waits until it is scaled
func ScaleDeployment(ctx context.Context, client client.Client, desiredReplicas *int32, name, namespace string) (*int32, error) {
if desiredReplicas == nil {
return nil, nil
}
replicas, err := GetDeploymentReplicas(ctx, client, namespace, name)
if apierrors.IsNotFound(err) {
return nil, nil
}
if err != nil {
return nil, fmt.Errorf("failed to retrieve the replica count of deployment %q: '%w'", name, err)
}
if replicas == nil || *replicas == *desiredReplicas {
return replicas, nil
}
// scale the deployment
if err := kubernetes.ScaleDeployment(ctx, client, kutil.Key(namespace, name), *desiredReplicas); err != nil {
return nil, fmt.Errorf("failed to scale the replica count of deployment %q: '%w'", name, err)
}
// wait until scaled
if err := WaitUntilDeploymentScaled(ctx, client, namespace, name, *desiredReplicas); err != nil {
return nil, fmt.Errorf("failed to wait until deployment %q is scaled: '%w'", name, err)
}
return replicas, nil
}
// WaitUntilDeploymentScaled waits until the deployment has the desired replica count in the status
func WaitUntilDeploymentScaled(ctx context.Context, client client.Client, namespace, name string, desiredReplicas int32) error {
return retry.Until(ctx, 5*time.Second, func(ctx context.Context) (done bool, err error) {
deployment := &appsv1.Deployment{}
if err := client.Get(ctx, kutil.Key(namespace, name), deployment); err != nil {
return retry.SevereError(err)
}
if deployment.Spec.Replicas == nil || *deployment.Spec.Replicas != desiredReplicas {
return retry.SevereError(fmt.Errorf("waiting for deployment scale failed. spec.replicas does not match the desired replicas"))
}
if deployment.Status.Replicas == desiredReplicas && deployment.Status.AvailableReplicas == desiredReplicas {
return retry.Ok()
}
return retry.MinorError(fmt.Errorf("deployment currently has '%d' replicas. Desired: %d", deployment.Status.AvailableReplicas, desiredReplicas))
})
}
// GetDeploymentReplicas gets the spec.Replicas count from a deployment
func GetDeploymentReplicas(ctx context.Context, client client.Client, namespace, name string) (*int32, error) {
deployment := &appsv1.Deployment{}
if err := client.Get(ctx, kutil.Key(namespace, name), deployment); err != nil {
return nil, err
}
replicas := deployment.Spec.Replicas
return replicas, nil
}
// ShootReconciliationSuccessful checks if a shoot is successfully reconciled. In case it is not, it also returns a descriptive message stating the reason.
func ShootReconciliationSuccessful(shoot *gardencorev1beta1.Shoot) (bool, string) {
if shoot.Generation != shoot.Status.ObservedGeneration {
return false, "shoot generation did not equal observed generation"
}
if len(shoot.Status.Conditions) == 0 && shoot.Status.LastOperation == nil {
return false, "no conditions and last operation present yet"
}
for _, condition := range shoot.Status.Conditions {
if condition.Status != gardencorev1beta1.ConditionTrue {
hibernation := shoot.Spec.Hibernation
if condition.Type == gardencorev1beta1.SeedGardenletReady && hibernation != nil && hibernation.Enabled != nil && *hibernation.Enabled {
continue
}
return false, fmt.Sprintf("condition type %s is not true yet, had message %s with reason %s", condition.Type, condition.Message, condition.Reason)
}
}
if shoot.Status.LastOperation != nil {
if shoot.Status.LastOperation.Type == gardencorev1beta1.LastOperationTypeCreate ||
shoot.Status.LastOperation.Type == gardencorev1beta1.LastOperationTypeReconcile ||
shoot.Status.LastOperation.Type == gardencorev1beta1.LastOperationTypeRestore {
if shoot.Status.LastOperation.State != gardencorev1beta1.LastOperationStateSucceeded {
return false, "last operation type was create, reconcile or restore but state was not succeeded"
}
} else if shoot.Status.LastOperation.Type == gardencorev1beta1.LastOperationTypeMigrate {
return false, "last operation type was migrate, the migration process is not finished yet"
}
}
return true, ""
}
// DownloadKubeconfig downloads the shoot Kubeconfig
func DownloadKubeconfig(ctx context.Context, client kubernetes.Interface, namespace, name, downloadPath string) error {
kubeconfig, err := GetObjectFromSecret(ctx, client, namespace, name, KubeconfigSecretKeyName)
if err != nil {
return err
}
if downloadPath != "" {
err = os.WriteFile(downloadPath, []byte(kubeconfig), 0755)
if err != nil {
return err
}
}
return nil
}
// PatchSecret patches the Secret.
func PatchSecret(ctx context.Context, c client.Client, secret *corev1.Secret) error {
existingSecret := &corev1.Secret{}
if err := c.Get(ctx, client.ObjectKey{Namespace: secret.Namespace, Name: secret.Name}, existingSecret); err != nil {
return err
}
patch := client.MergeFrom(existingSecret.DeepCopy())
existingSecret.Data = secret.Data
return c.Patch(ctx, existingSecret, patch)
}
// GetObjectFromSecret returns object from secret
func GetObjectFromSecret(ctx context.Context, k8sClient kubernetes.Interface, namespace, secretName, objectKey string) (string, error) {
secret := &corev1.Secret{}
err := k8sClient.Client().Get(ctx, client.ObjectKey{Namespace: namespace, Name: secretName}, secret)
if err != nil {
return "", err
}
if _, ok := secret.Data[objectKey]; ok {
return string(secret.Data[objectKey]), nil
}
return "", fmt.Errorf("secret %s/%s did not contain object key %q", namespace, secretName, objectKey)
}
// NewClientFromServiceAccount returns a kubernetes client for a service account.
func NewClientFromServiceAccount(ctx context.Context, k8sClient kubernetes.Interface, account *corev1.ServiceAccount) (kubernetes.Interface, error) {
secret := &corev1.Secret{}
err := k8sClient.Client().Get(ctx, client.ObjectKey{Namespace: account.Namespace, Name: account.Secrets[0].Name}, secret)
if err != nil {
return nil, err
}
serviceAccountConfig := &rest.Config{
Host: k8sClient.RESTConfig().Host,
TLSClientConfig: rest.TLSClientConfig{
Insecure: false,
CAData: k8sClient.RESTConfig().CAData,
},
BearerToken: string(secret.Data["token"]),
}
return kubernetes.NewWithConfig(
kubernetes.WithRESTConfig(serviceAccountConfig),
kubernetes.WithClientOptions(client.Options{Scheme: kubernetes.GardenScheme}),
kubernetes.WithDisabledCachedClient(),
)
}
// WaitUntilPodIsRunning waits until the pod with <podName> is running
func WaitUntilPodIsRunning(ctx context.Context, log *logrus.Logger, podName, podNamespace string, c kubernetes.Interface) error {
return retry.Until(ctx, defaultPollInterval, func(ctx context.Context) (done bool, err error) {
pod := &corev1.Pod{}
if err := c.Client().Get(ctx, client.ObjectKey{Namespace: podNamespace, Name: podName}, pod); err != nil {
return retry.SevereError(err)
}
if !health.IsPodReady(pod) {
log.Infof("Waiting for %s to be ready!!", podName)
return retry.MinorError(fmt.Errorf(`pod "%s/%s" is not ready: %v`, podNamespace, podName, err))
}
return retry.Ok()
})
}
// WaitUntilPodIsRunningWithLabels waits until the pod with <podLabels> is running
func (f *CommonFramework) WaitUntilPodIsRunningWithLabels(ctx context.Context, labels labels.Selector, podNamespace string, c kubernetes.Interface) error {
return retry.Until(ctx, defaultPollInterval, func(ctx context.Context) (done bool, err error) {
pod, err := GetFirstRunningPodWithLabels(ctx, labels, podNamespace, c)
if err != nil {
return retry.SevereError(err)
}
if !health.IsPodReady(pod) {
f.Logger.Infof("Waiting for %s to be ready!!", pod.GetName())
return retry.MinorError(fmt.Errorf(`pod "%s/%s" is not ready: %v`, pod.GetNamespace(), pod.GetName(), err))
}
return retry.Ok()
})
}
// DeployRootPod deploys a pod with root permissions for testing purposes.
func DeployRootPod(ctx context.Context, c client.Client, namespace string, nodename *string) (*corev1.Pod, error) {
podPriority := int32(0)
allowedCharacters := "0123456789abcdefghijklmnopqrstuvwxyz"
id, err := utils.GenerateRandomStringFromCharset(3, allowedCharacters)
if err != nil {
return nil, err
}
rootPod := corev1.Pod{
ObjectMeta: metav1.ObjectMeta{
Name: fmt.Sprintf("rootpod-%s", id),
Namespace: namespace,
Annotations: map[string]string{
"kubernetes.io/psp": "gardener.privileged",
},
},
Spec: corev1.PodSpec{
Containers: []corev1.Container{
{
Name: "root-container",
Image: "eu.gcr.io/gardener-project/3rd/busybox:1.29.2",
Command: []string{
"sleep",
"10000000",
},
Resources: corev1.ResourceRequirements{},
TerminationMessagePath: "/dev/termination-log",
TerminationMessagePolicy: corev1.TerminationMessageReadFile,
ImagePullPolicy: corev1.PullIfNotPresent,
SecurityContext: &corev1.SecurityContext{
Privileged: pointer.Bool(true),
},
Stdin: true,
VolumeMounts: []corev1.VolumeMount{
{
Name: "root-volume",
MountPath: "/hostroot",
},
},
},
},
HostNetwork: true,
HostPID: true,
Priority: &podPriority,
Volumes: []corev1.Volume{
{
Name: "root-volume",
VolumeSource: corev1.VolumeSource{
HostPath: &corev1.HostPathVolumeSource{
Path: "/",
},
},
},
},
},
}
if nodename != nil {
rootPod.Spec.NodeName = *nodename
}
if err := c.Create(ctx, &rootPod); err != nil {
return nil, err
}
return &rootPod, nil
}