-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
util.go
808 lines (718 loc) · 26.9 KB
/
util.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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
/*
Copyright 2017 The Kubernetes Authors.
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 util
import (
"context"
"encoding/json"
"fmt"
"math"
"math/rand"
"regexp"
"strconv"
"strings"
"time"
"github.com/blang/semver"
"github.com/gobuffalo/flect"
"github.com/pkg/errors"
corev1 "k8s.io/api/core/v1"
v1 "k8s.io/api/core/v1"
apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
apierrors "k8s.io/apimachinery/pkg/api/errors"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/apimachinery/pkg/version"
"k8s.io/client-go/metadata"
"k8s.io/client-go/rest"
"k8s.io/klog/klogr"
clusterv1 "sigs.k8s.io/cluster-api/api/v1alpha3"
"sigs.k8s.io/cluster-api/util/annotations"
"sigs.k8s.io/cluster-api/util/container"
"sigs.k8s.io/cluster-api/util/predicates"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/cache"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/client/apiutil"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
"sigs.k8s.io/controller-runtime/pkg/source"
)
const (
// CharSet defines the alphanumeric set for random string generation
CharSet = "0123456789abcdefghijklmnopqrstuvwxyz"
// MachineListFormatDeprecationMessage notifies the user that the old
// MachineList format is no longer supported
MachineListFormatDeprecationMessage = "Your MachineList items must include Kind and APIVersion"
)
var (
rnd = rand.New(rand.NewSource(time.Now().UnixNano()))
ErrNoCluster = fmt.Errorf("no %q label present", clusterv1.ClusterLabelName)
ErrUnstructuredFieldNotFound = fmt.Errorf("field not found")
kubeSemver = regexp.MustCompile(`^v?(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)([-0-9a-zA-Z_\.+]*)?$`)
)
// ParseMajorMinorPatch returns a semver.Version from the string provided
// by looking only at major.minor.patch and stripping everything else out.
func ParseMajorMinorPatch(version string) (semver.Version, error) {
groups := kubeSemver.FindStringSubmatch(version)
if len(groups) < 4 {
return semver.Version{}, errors.Errorf("failed to parse major.minor.patch from %q", version)
}
major, err := strconv.ParseUint(groups[1], 10, 64)
if err != nil {
return semver.Version{}, errors.Wrapf(err, "failed to parse major version from %q", version)
}
minor, err := strconv.ParseUint(groups[2], 10, 64)
if err != nil {
return semver.Version{}, errors.Wrapf(err, "failed to parse minor version from %q", version)
}
patch, err := strconv.ParseUint(groups[3], 10, 64)
if err != nil {
return semver.Version{}, errors.Wrapf(err, "failed to parse patch version from %q", version)
}
return semver.Version{
Major: major,
Minor: minor,
Patch: patch,
}, nil
}
// RandomString returns a random alphanumeric string.
func RandomString(n int) string {
result := make([]byte, n)
for i := range result {
result[i] = CharSet[rnd.Intn(len(CharSet))]
}
return string(result)
}
// Ordinalize takes an int and returns the ordinalized version of it.
// Eg. 1 --> 1st, 103 --> 103rd
func Ordinalize(n int) string {
m := map[int]string{
0: "th",
1: "st",
2: "nd",
3: "rd",
4: "th",
5: "th",
6: "th",
7: "th",
8: "th",
9: "th",
}
an := int(math.Abs(float64(n)))
if an < 10 {
return fmt.Sprintf("%d%s", n, m[an])
}
return fmt.Sprintf("%d%s", n, m[an%10])
}
// ModifyImageRepository takes an imageName (e.g., repository/image:tag), and returns an image name with updated repository
// Deprecated: Please use the functions in util/container
func ModifyImageRepository(imageName, repositoryName string) (string, error) {
return container.ModifyImageRepository(imageName, repositoryName)
}
// ModifyImageTag takes an imageName (e.g., repository/image:tag), and returns an image name with updated tag
// Deprecated: Please use the functions in util/container
func ModifyImageTag(imageName, tagName string) (string, error) {
return container.ModifyImageTag(imageName, tagName)
}
// ImageTagIsValid ensures that a given image tag is compliant with the OCI spec
// Deprecated: Please use the functions in util/container
func ImageTagIsValid(tagName string) bool {
return container.ImageTagIsValid(tagName)
}
// GetMachinesForCluster returns a list of machines associated with the cluster.
func GetMachinesForCluster(ctx context.Context, c client.Client, cluster *clusterv1.Cluster) (*clusterv1.MachineList, error) {
var machines clusterv1.MachineList
if err := c.List(
ctx,
&machines,
client.InNamespace(cluster.Namespace),
client.MatchingLabels{
clusterv1.ClusterLabelName: cluster.Name,
},
); err != nil {
return nil, err
}
return &machines, nil
}
// SemverToOCIImageTag is a helper function that replaces all
// non-allowed symbols in tag strings with underscores.
// Image tag can only contain lowercase and uppercase letters, digits,
// underscores, periods and dashes.
// Current usage is for CI images where all of symbols except '+' are valid,
// but function is for generic usage where input can't be always pre-validated.
// Taken from k8s.io/cmd/kubeadm/app/util
// Deprecated: Please use the functions in util/container
func SemverToOCIImageTag(version string) string {
return container.SemverToOCIImageTag(version)
}
// GetControlPlaneMachines returns a slice containing control plane machines.
func GetControlPlaneMachines(machines []*clusterv1.Machine) (res []*clusterv1.Machine) {
for _, machine := range machines {
if IsControlPlaneMachine(machine) {
res = append(res, machine)
}
}
return
}
// GetControlPlaneMachinesFromList returns a slice containing control plane machines.
func GetControlPlaneMachinesFromList(machineList *clusterv1.MachineList) (res []*clusterv1.Machine) {
for i := 0; i < len(machineList.Items); i++ {
machine := machineList.Items[i]
if IsControlPlaneMachine(&machine) {
res = append(res, &machine)
}
}
return
}
// IsExternalManagedControlPlane returns a bool indicating whether the control plane referenced
// in the passed Unstructured resource is an externally managed control plane such as AKS, EKS, GKE, etc.
func IsExternalManagedControlPlane(controlPlane *unstructured.Unstructured) bool {
managed, found, err := unstructured.NestedBool(controlPlane.Object, "status", "externalManagedControlPlane")
if err != nil || !found {
return false
}
return managed
}
// GetMachineIfExists gets a machine from the API server if it exists.
func GetMachineIfExists(c client.Client, namespace, name string) (*clusterv1.Machine, error) {
if c == nil {
// Being called before k8s is setup as part of control plane VM creation
return nil, nil
}
// Machines are identified by name
machine := &clusterv1.Machine{}
err := c.Get(context.Background(), client.ObjectKey{Namespace: namespace, Name: name}, machine)
if err != nil {
if apierrors.IsNotFound(err) {
return nil, nil
}
return nil, err
}
return machine, nil
}
// IsControlPlaneMachine checks machine is a control plane node.
func IsControlPlaneMachine(machine *clusterv1.Machine) bool {
_, ok := machine.ObjectMeta.Labels[clusterv1.MachineControlPlaneLabelName]
return ok
}
// IsNodeReady returns true if a node is ready.
func IsNodeReady(node *v1.Node) bool {
for _, condition := range node.Status.Conditions {
if condition.Type == v1.NodeReady {
return condition.Status == v1.ConditionTrue
}
}
return false
}
// GetClusterFromMetadata returns the Cluster object (if present) using the object metadata.
func GetClusterFromMetadata(ctx context.Context, c client.Client, obj metav1.ObjectMeta) (*clusterv1.Cluster, error) {
if obj.Labels[clusterv1.ClusterLabelName] == "" {
return nil, errors.WithStack(ErrNoCluster)
}
return GetClusterByName(ctx, c, obj.Namespace, obj.Labels[clusterv1.ClusterLabelName])
}
// GetOwnerCluster returns the Cluster object owning the current resource.
func GetOwnerCluster(ctx context.Context, c client.Client, obj metav1.ObjectMeta) (*clusterv1.Cluster, error) {
for _, ref := range obj.OwnerReferences {
if ref.Kind != "Cluster" {
continue
}
gv, err := schema.ParseGroupVersion(ref.APIVersion)
if err != nil {
return nil, errors.WithStack(err)
}
if gv.Group == clusterv1.GroupVersion.Group {
return GetClusterByName(ctx, c, obj.Namespace, ref.Name)
}
}
return nil, nil
}
// GetClusterByName finds and return a Cluster object using the specified params.
func GetClusterByName(ctx context.Context, c client.Client, namespace, name string) (*clusterv1.Cluster, error) {
cluster := &clusterv1.Cluster{}
key := client.ObjectKey{
Namespace: namespace,
Name: name,
}
if err := c.Get(ctx, key, cluster); err != nil {
return nil, err
}
return cluster, nil
}
// ObjectKey returns client.ObjectKey for the object.
func ObjectKey(object metav1.Object) client.ObjectKey {
return client.ObjectKey{
Namespace: object.GetNamespace(),
Name: object.GetName(),
}
}
// ClusterToInfrastructureMapFunc returns a handler.ToRequestsFunc that watches for
// Cluster events and returns reconciliation requests for an infrastructure provider object.
func ClusterToInfrastructureMapFunc(gvk schema.GroupVersionKind) handler.ToRequestsFunc {
return func(o handler.MapObject) []reconcile.Request {
c, ok := o.Object.(*clusterv1.Cluster)
if !ok {
return nil
}
// Return early if the InfrastructureRef is nil.
if c.Spec.InfrastructureRef == nil {
return nil
}
gk := gvk.GroupKind()
// Return early if the GroupKind doesn't match what we expect.
infraGK := c.Spec.InfrastructureRef.GroupVersionKind().GroupKind()
if gk != infraGK {
return nil
}
return []reconcile.Request{
{
NamespacedName: client.ObjectKey{
Namespace: c.Namespace,
Name: c.Spec.InfrastructureRef.Name,
},
},
}
}
}
// GetOwnerMachine returns the Machine object owning the current resource.
func GetOwnerMachine(ctx context.Context, c client.Client, obj metav1.ObjectMeta) (*clusterv1.Machine, error) {
for _, ref := range obj.OwnerReferences {
gv, err := schema.ParseGroupVersion(ref.APIVersion)
if err != nil {
return nil, err
}
if ref.Kind == "Machine" && gv.Group == clusterv1.GroupVersion.Group {
return GetMachineByName(ctx, c, obj.Namespace, ref.Name)
}
}
return nil, nil
}
// GetMachineByName finds and return a Machine object using the specified params.
func GetMachineByName(ctx context.Context, c client.Client, namespace, name string) (*clusterv1.Machine, error) {
m := &clusterv1.Machine{}
key := client.ObjectKey{Name: name, Namespace: namespace}
if err := c.Get(ctx, key, m); err != nil {
return nil, err
}
return m, nil
}
// MachineToInfrastructureMapFunc returns a handler.ToRequestsFunc that watches for
// Machine events and returns reconciliation requests for an infrastructure provider object.
func MachineToInfrastructureMapFunc(gvk schema.GroupVersionKind) handler.ToRequestsFunc {
return func(o handler.MapObject) []reconcile.Request {
m, ok := o.Object.(*clusterv1.Machine)
if !ok {
return nil
}
gk := gvk.GroupKind()
// Return early if the GroupKind doesn't match what we expect.
infraGK := m.Spec.InfrastructureRef.GroupVersionKind().GroupKind()
if gk != infraGK {
return nil
}
return []reconcile.Request{
{
NamespacedName: client.ObjectKey{
Namespace: m.Namespace,
Name: m.Spec.InfrastructureRef.Name,
},
},
}
}
}
// HasOwnerRef returns true if the OwnerReference is already in the slice.
func HasOwnerRef(ownerReferences []metav1.OwnerReference, ref metav1.OwnerReference) bool {
return indexOwnerRef(ownerReferences, ref) > -1
}
// EnsureOwnerRef makes sure the slice contains the OwnerReference.
func EnsureOwnerRef(ownerReferences []metav1.OwnerReference, ref metav1.OwnerReference) []metav1.OwnerReference {
idx := indexOwnerRef(ownerReferences, ref)
if idx == -1 {
return append(ownerReferences, ref)
}
ownerReferences[idx] = ref
return ownerReferences
}
// ReplaceOwnerRef re-parents an object from one OwnerReference to another
// It compares strictly based on UID to avoid reparenting across an intentional deletion: if an object is deleted
// and re-created with the same name and namespace, the only way to tell there was an in-progress deletion
// is by comparing the UIDs.
func ReplaceOwnerRef(ownerReferences []metav1.OwnerReference, source metav1.Object, target metav1.OwnerReference) []metav1.OwnerReference {
fi := -1
for index, r := range ownerReferences {
if r.UID == source.GetUID() {
fi = index
ownerReferences[index] = target
break
}
}
if fi < 0 {
ownerReferences = append(ownerReferences, target)
}
return ownerReferences
}
// RemoveOwnerRef returns the slice of owner references after removing the supplied owner ref
func RemoveOwnerRef(ownerReferences []metav1.OwnerReference, inputRef metav1.OwnerReference) []metav1.OwnerReference {
if index := indexOwnerRef(ownerReferences, inputRef); index != -1 {
return append(ownerReferences[:index], ownerReferences[index+1:]...)
}
return ownerReferences
}
// indexOwnerRef returns the index of the owner reference in the slice if found, or -1.
func indexOwnerRef(ownerReferences []metav1.OwnerReference, ref metav1.OwnerReference) int {
for index, r := range ownerReferences {
if referSameObject(r, ref) {
return index
}
}
return -1
}
// PointsTo returns true if any of the owner references point to the given target
// Deprecated: Use IsOwnedByObject to cover differences in API version or backup/restore that changed UIDs.
func PointsTo(refs []metav1.OwnerReference, target *metav1.ObjectMeta) bool {
for _, ref := range refs {
if ref.UID == target.UID {
return true
}
}
return false
}
// IsOwnedByObject returns true if any of the owner references point to the given target.
func IsOwnedByObject(obj metav1.Object, target controllerutil.Object) bool {
for _, ref := range obj.GetOwnerReferences() {
ref := ref
if refersTo(&ref, target) {
return true
}
}
return false
}
// IsControlledBy differs from metav1.IsControlledBy in that it checks the group (but not version), kind, and name vs uid.
func IsControlledBy(obj metav1.Object, owner controllerutil.Object) bool {
controllerRef := metav1.GetControllerOfNoCopy(obj)
if controllerRef == nil {
return false
}
return refersTo(controllerRef, owner)
}
// Returns true if a and b point to the same object.
func referSameObject(a, b metav1.OwnerReference) bool {
aGV, err := schema.ParseGroupVersion(a.APIVersion)
if err != nil {
return false
}
bGV, err := schema.ParseGroupVersion(b.APIVersion)
if err != nil {
return false
}
return aGV.Group == bGV.Group && a.Kind == b.Kind && a.Name == b.Name
}
// Returns true if ref refers to obj.
func refersTo(ref *metav1.OwnerReference, obj controllerutil.Object) bool {
refGv, err := schema.ParseGroupVersion(ref.APIVersion)
if err != nil {
return false
}
gvk := obj.GetObjectKind().GroupVersionKind()
return refGv.Group == gvk.Group && ref.Kind == gvk.Kind && ref.Name == obj.GetName()
}
// UnstructuredUnmarshalField is a wrapper around json and unstructured objects to decode and copy a specific field
// value into an object.
func UnstructuredUnmarshalField(obj *unstructured.Unstructured, v interface{}, fields ...string) error {
value, found, err := unstructured.NestedFieldNoCopy(obj.Object, fields...)
if err != nil {
return errors.Wrapf(err, "failed to retrieve field %q from %q", strings.Join(fields, "."), obj.GroupVersionKind())
}
if !found || value == nil {
return ErrUnstructuredFieldNotFound
}
valueBytes, err := json.Marshal(value)
if err != nil {
return errors.Wrapf(err, "failed to json-encode field %q value from %q", strings.Join(fields, "."), obj.GroupVersionKind())
}
if err := json.Unmarshal(valueBytes, v); err != nil {
return errors.Wrapf(err, "failed to json-decode field %q value from %q", strings.Join(fields, "."), obj.GroupVersionKind())
}
return nil
}
// HasOwner checks if any of the references in the passed list match the given group from apiVersion and one of the given kinds.
func HasOwner(refList []metav1.OwnerReference, apiVersion string, kinds []string) bool {
gv, err := schema.ParseGroupVersion(apiVersion)
if err != nil {
return false
}
kMap := make(map[string]bool)
for _, kind := range kinds {
kMap[kind] = true
}
for _, mr := range refList {
mrGroupVersion, err := schema.ParseGroupVersion(mr.APIVersion)
if err != nil {
return false
}
if mrGroupVersion.Group == gv.Group && kMap[mr.Kind] {
return true
}
}
return false
}
var (
// IsPaused returns true if the Cluster is paused or the object has the `paused` annotation.
// Deprecated: use util/annotations/IsPaused instead
IsPaused = annotations.IsPaused
// HasPausedAnnotation returns true if the object has the `paused` annotation.
// Deprecated: use util/annotations/HasPausedAnnotation instead
HasPausedAnnotation = annotations.HasPausedAnnotation
)
// GetCRDWithContract retrieves a list of CustomResourceDefinitions from using controller-runtime Client,
// filtering with the `contract` label passed in.
// Returns the first CRD in the list that matches the GroupVersionKind, otherwise returns an error.
func GetCRDWithContract(ctx context.Context, c client.Client, gvk schema.GroupVersionKind, contract string) (*apiextensionsv1.CustomResourceDefinition, error) {
crdList := &apiextensionsv1.CustomResourceDefinitionList{}
for {
if err := c.List(ctx, crdList, client.Continue(crdList.Continue), client.HasLabels{contract}); err != nil {
return nil, errors.Wrapf(err, "failed to list CustomResourceDefinitions for %v", gvk)
}
for i := range crdList.Items {
crd := crdList.Items[i]
if crd.Spec.Group == gvk.Group &&
crd.Spec.Names.Kind == gvk.Kind {
return &crd, nil
}
}
if crdList.Continue == "" {
break
}
}
return nil, errors.Errorf("failed to find a CustomResourceDefinition for %v with contract %q", gvk, contract)
}
// GetCRDMetadataFromGVK retrieves a CustomResourceDefinition metadata from the API server using client-go's metadata only client.
//
// This function is greatly more efficient than GetCRDWithContract and should be preferred in most cases.
func GetCRDMetadataFromGVK(ctx context.Context, restConfig *rest.Config, gvk schema.GroupVersionKind) (*metav1.PartialObjectMetadata, error) {
// Make sure a rest config is available.
if restConfig == nil {
return nil, errors.Errorf("cannot create a metadata client without a rest config")
}
// Create a metadata-only client.
metadataClient, err := metadata.NewForConfig(restConfig)
if err != nil {
return nil, errors.Wrapf(err, "failed to create metadata only client")
}
// Get the partial metadata CRD.
generatedName := fmt.Sprintf("%s.%s", flect.Pluralize(strings.ToLower(gvk.Kind)), gvk.Group)
return metadataClient.Resource(apiextensionsv1.SchemeGroupVersion.WithResource("customresourcedefinitions")).Get(generatedName, metav1.GetOptions{})
}
// KubeAwareAPIVersions is a sortable slice of kube-like version strings.
//
// Kube-like version strings are starting with a v, followed by a major version,
// optional "alpha" or "beta" strings followed by a minor version (e.g. v1, v2beta1).
// Versions will be sorted based on GA/alpha/beta first and then major and minor
// versions. e.g. v2, v1, v1beta2, v1beta1, v1alpha1.
type KubeAwareAPIVersions []string
func (k KubeAwareAPIVersions) Len() int { return len(k) }
func (k KubeAwareAPIVersions) Swap(i, j int) { k[i], k[j] = k[j], k[i] }
func (k KubeAwareAPIVersions) Less(i, j int) bool {
return version.CompareKubeAwareVersionStrings(k[i], k[j]) < 0
}
// MachinesByCreationTimestamp sorts a list of Machine by creation timestamp, using their names as a tie breaker.
type MachinesByCreationTimestamp []*clusterv1.Machine
func (o MachinesByCreationTimestamp) Len() int { return len(o) }
func (o MachinesByCreationTimestamp) Swap(i, j int) { o[i], o[j] = o[j], o[i] }
func (o MachinesByCreationTimestamp) Less(i, j int) bool {
if o[i].CreationTimestamp.Equal(&o[j].CreationTimestamp) {
return o[i].Name < o[j].Name
}
return o[i].CreationTimestamp.Before(&o[j].CreationTimestamp)
}
// WatchOnClusterPaused adds a conditional watch to the controlled given as input
// that sends watch notifications on any create or delete, and only updates
// that toggle Cluster.Spec.Cluster.
// Deprecated: Instead add the Watch directly and use predicates.ClusterUnpaused or
// predicates.ClusterUnpausedAndInfrastructureReady depending on your use case.
func WatchOnClusterPaused(c controller.Controller, mapFunc handler.Mapper) error {
log := klogr.New().WithName("WatchOnClusterPaused")
return c.Watch(
&source.Kind{Type: &clusterv1.Cluster{}},
&handler.EnqueueRequestsFromMapFunc{
ToRequests: mapFunc,
},
predicates.ClusterUnpaused(log),
)
}
// ClusterToObjectsMapper returns a mapper function that gets a cluster and lists all objects for the object passed in
// and returns a list of requests.
// NB: The objects are required to have `clusterv1.ClusterLabelName` applied.
func ClusterToObjectsMapper(c client.Client, ro runtime.Object, scheme *runtime.Scheme) (handler.Mapper, error) {
if _, ok := ro.(metav1.ListInterface); !ok {
return nil, errors.Errorf("expected a metav1.ListInterface, got %T instead", ro)
}
gvk, err := apiutil.GVKForObject(ro, scheme)
if err != nil {
return nil, err
}
return handler.ToRequestsFunc(func(o handler.MapObject) []ctrl.Request {
cluster, ok := o.Object.(*clusterv1.Cluster)
if !ok {
return nil
}
list := &unstructured.UnstructuredList{}
list.SetGroupVersionKind(gvk)
if err := c.List(context.Background(), list, client.MatchingLabels{clusterv1.ClusterLabelName: cluster.Name}); err != nil {
return nil
}
results := []ctrl.Request{}
for _, obj := range list.Items {
results = append(results, ctrl.Request{
NamespacedName: client.ObjectKey{Namespace: obj.GetNamespace(), Name: obj.GetName()},
})
}
return results
}), nil
}
// ObjectReferenceToUnstructured converts an object reference to an unstructured object.
func ObjectReferenceToUnstructured(in corev1.ObjectReference) *unstructured.Unstructured {
out := &unstructured.Unstructured{}
out.SetKind(in.Kind)
out.SetAPIVersion(in.APIVersion)
out.SetNamespace(in.Namespace)
out.SetName(in.Name)
return out
}
// IsSupportedVersionSkew will return true if a and b are no more than one minor version off from each other.
func IsSupportedVersionSkew(a, b semver.Version) bool {
if a.Major != b.Major {
return false
}
if a.Minor > b.Minor {
return a.Minor-b.Minor == 1
}
return b.Minor-a.Minor <= 1
}
// ManagerDelegatingClientFunc is a manager.NewClientFunc to be used when creating
// a new controller runtime manager.
//
// A delegating client reads from the cache and writes directly to the server.
// This avoids getting unstructured objects directly from the server
//
// See issue: https://github.com/kubernetes-sigs/cluster-api/issues/1663
func ManagerDelegatingClientFunc(cache cache.Cache, config *rest.Config, options client.Options) (client.Client, error) {
c, err := client.New(config, options)
if err != nil {
return nil, err
}
return &client.DelegatingClient{
Reader: cache,
Writer: c,
StatusClient: c,
}, nil
}
// DelegatingClientFuncWithUncached returns a manager.NewClientFunc to be used when creating
// a new controller runtime manager.
//
// A delegating client reads from the cache and writes directly to the server.
// This avoids getting unstructured objects directly from the server.
//
// In addition, this function builds a custom reader that used the input list of objects
// to determine which GVK should always query the live server, instead of going through a cache.
func DelegatingClientFuncWithUncached(uncachedObjects ...runtime.Object) func(cache cache.Cache, config *rest.Config, options client.Options) (client.Client, error) {
return func(cache cache.Cache, config *rest.Config, options client.Options) (client.Client, error) {
uncachedGVKs := make(map[schema.GroupVersionKind]struct{}, len(uncachedObjects))
for _, obj := range uncachedObjects {
gvk, err := apiutil.GVKForObject(obj, options.Scheme)
if err != nil {
return nil, errors.Wrapf(err, "failed to retrieve GVK for uncached object")
}
uncachedGVKs[gvk] = struct{}{}
}
// Create a live client.
c, err := client.New(config, options)
if err != nil {
return nil, err
}
return &client.DelegatingClient{
// The custom delegatingReader is defined in this package and is a custom client.Reader
// that routes the uncached GVK to the API Server using the live client created above.
//
// It also maintains the client.DelegatingReader behavior of bypassing the cache for
// unstructured objects and lists.
Reader: &delegatingReader{
liveReader: c,
cacheReader: cache,
uncachedGVKs: uncachedGVKs,
scheme: options.Scheme,
},
Writer: c,
StatusClient: c,
}, nil
}
}
type delegatingReader struct {
liveReader client.Reader
cacheReader client.Reader
uncachedGVKs map[schema.GroupVersionKind]struct{}
scheme *runtime.Scheme
}
func (d *delegatingReader) shouldBypassCache(obj runtime.Object) (bool, error) {
if _, isUnstructured := obj.(*unstructured.Unstructured); isUnstructured {
return true, nil
}
if _, isUnstructuredList := obj.(*unstructured.UnstructuredList); isUnstructuredList {
return true, nil
}
gvk, err := apiutil.GVKForObject(obj, d.scheme)
if err != nil {
return false, err
}
_, isUncached := d.uncachedGVKs[gvk]
return isUncached, nil
}
// Get retrieves an obj for a given object key from the Kubernetes Cluster.
func (d *delegatingReader) Get(ctx context.Context, key client.ObjectKey, obj runtime.Object) error {
if isUncached, err := d.shouldBypassCache(obj); err != nil {
return err
} else if isUncached {
return d.liveReader.Get(ctx, key, obj)
}
return d.cacheReader.Get(ctx, key, obj)
}
// List retrieves list of objects for a given namespace and list options.
func (d *delegatingReader) List(ctx context.Context, list runtime.Object, opts ...client.ListOption) error {
if isUncached, err := d.shouldBypassCache(list); err != nil {
return err
} else if isUncached {
return d.liveReader.List(ctx, list, opts...)
}
return d.cacheReader.List(ctx, list, opts...)
}
// LowestNonZeroResult compares two reconciliation results
// and returns the one with lowest requeue time.
func LowestNonZeroResult(i, j ctrl.Result) ctrl.Result {
switch {
case i.IsZero():
return j
case j.IsZero():
return i
case i.Requeue:
return i
case j.Requeue:
return j
case i.RequeueAfter < j.RequeueAfter:
return i
default:
return j
}
}