Skip to content

Commit 2baaee8

Browse files
sivcharisivchari
committed
migrate Requeue to RequeueAfter
Signed-off-by: sivchari <shibuuuu5@gmail.com>
1 parent da5cc32 commit 2baaee8

File tree

15 files changed

+51
-59
lines changed

15 files changed

+51
-59
lines changed

‎.golangci.yml

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -257,10 +257,6 @@ linters:
257257
- linters:
258258
- staticcheck
259259
text: 'SA1019: .*\.Deprecated\.V1Beta1.* is deprecated'
260-
# CR v0.21 deprecated Result.Requeue, will be fixed incrementally and tracked via https://github.com/kubernetes-sigs/cluster-api/issues/12272
261-
- linters:
262-
- staticcheck
263-
text: 'SA1019: .*(res|result|i|j)\.Requeue is deprecated: Use `RequeueAfter` instead'
264260
- linters:
265261
- revive
266262
text: 'exported: exported method .*\.(Reconcile|SetupWithManager|SetupWebhookWithManager) should have comment or be unexported'

‎bootstrap/kubeadm/internal/controllers/kubeadmconfig_controller_reconciler_test.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ package controllers
1818

1919
import (
2020
"testing"
21+
"time"
2122

2223
. "github.com/onsi/gomega"
2324
ctrl "sigs.k8s.io/controller-runtime"
@@ -58,7 +59,7 @@ func TestKubeadmConfigReconciler(t *testing.T) {
5859
},
5960
})
6061
g.Expect(err).To(Succeed())
61-
g.Expect(result.Requeue).To(BeFalse())
62+
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
6263
})
6364
})
6465
}

‎bootstrap/kubeadm/internal/controllers/kubeadmconfig_controller_test.go

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,6 @@ func TestKubeadmConfigReconciler_Reconcile_ReturnEarlyIfKubeadmConfigIsReady(t *
124124
}
125125
result, err := k.Reconcile(ctx, request)
126126
g.Expect(err).ToNot(HaveOccurred())
127-
g.Expect(result.Requeue).To(BeFalse())
128127
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
129128
}
130129

@@ -297,7 +296,6 @@ func TestKubeadmConfigReconciler_Reconcile_ReturnEarlyIfMachineHasDataSecretName
297296
actual := &bootstrapv1.KubeadmConfig{}
298297
g.Expect(myclient.Get(ctx, client.ObjectKey{Namespace: config.Namespace, Name: config.Name}, actual)).To(Succeed())
299298
g.Expect(err).ToNot(HaveOccurred())
300-
g.Expect(result.Requeue).To(BeFalse())
301299
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
302300
assertHasTrueCondition(g, myclient, request, bootstrapv1.KubeadmConfigDataSecretAvailableCondition)
303301
}
@@ -470,7 +468,6 @@ func TestKubeadmConfigReconciler_Reconcile_RequeueJoiningNodesIfControlPlaneNotI
470468

471469
result, err := k.Reconcile(ctx, tc.request)
472470
g.Expect(err).ToNot(HaveOccurred())
473-
g.Expect(result.Requeue).To(BeFalse())
474471
g.Expect(result.RequeueAfter).To(Equal(30 * time.Second))
475472
assertHasFalseCondition(g, myclient, tc.request, bootstrapv1.KubeadmConfigDataSecretAvailableCondition, bootstrapv1.KubeadmConfigDataSecretNotAvailableReason)
476473
})
@@ -523,7 +520,6 @@ func TestKubeadmConfigReconciler_Reconcile_GenerateCloudConfigData(t *testing.T)
523520

524521
result, err := k.Reconcile(ctx, request)
525522
g.Expect(err).ToNot(HaveOccurred())
526-
g.Expect(result.Requeue).To(BeFalse())
527523
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
528524

529525
cfg, err := getKubeadmConfig(myclient, "control-plane-init-cfg", metav1.NamespaceDefault)
@@ -627,7 +623,6 @@ func TestKubeadmConfigReconciler_Reconcile_RequeueIfControlPlaneIsMissingAPIEndp
627623
}
628624
result, err := k.Reconcile(ctx, request)
629625
g.Expect(err).ToNot(HaveOccurred())
630-
g.Expect(result.Requeue).To(BeFalse())
631626
g.Expect(result.RequeueAfter).To(Equal(10 * time.Second))
632627

633628
actualConfig := &bootstrapv1.KubeadmConfig{}
@@ -705,7 +700,6 @@ func TestReconcileIfJoinCertificatesAvailableConditioninNodesAndControlPlaneIsRe
705700
}
706701
result, err := k.Reconcile(ctx, request)
707702
g.Expect(err).ToNot(HaveOccurred())
708-
g.Expect(result.Requeue).To(BeFalse())
709703
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
710704

711705
cfg, err := getKubeadmConfig(myclient, rt.configName, metav1.NamespaceDefault)
@@ -783,7 +777,6 @@ func TestReconcileIfJoinNodePoolsAndControlPlaneIsReady(t *testing.T) {
783777
}
784778
result, err := k.Reconcile(ctx, request)
785779
g.Expect(err).ToNot(HaveOccurred())
786-
g.Expect(result.Requeue).To(BeFalse())
787780
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
788781

789782
cfg, err := getKubeadmConfig(myclient, rt.configName, metav1.NamespaceDefault)
@@ -991,7 +984,6 @@ func TestKubeadmConfigSecretCreatedStatusNotPatched(t *testing.T) {
991984
g.Expect(err).ToNot(HaveOccurred())
992985
result, err := k.Reconcile(ctx, request)
993986
g.Expect(err).ToNot(HaveOccurred())
994-
g.Expect(result.Requeue).To(BeFalse())
995987
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
996988

997989
cfg, err := getKubeadmConfig(myclient, "worker-join-cfg", metav1.NamespaceDefault)
@@ -1245,7 +1237,6 @@ func TestBootstrapTokenTTLExtension(t *testing.T) {
12451237
} {
12461238
result, err := k.Reconcile(ctx, req)
12471239
g.Expect(err).ToNot(HaveOccurred())
1248-
g.Expect(result.Requeue).To(BeFalse())
12491240
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
12501241
}
12511242

@@ -2096,7 +2087,6 @@ func TestKubeadmConfigReconciler_Reconcile_ExactlyOneControlPlaneMachineInitiali
20962087
}
20972088
result, err := k.Reconcile(ctx, request)
20982089
g.Expect(err).ToNot(HaveOccurred())
2099-
g.Expect(result.Requeue).To(BeFalse())
21002090
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
21012091

21022092
request = ctrl.Request{
@@ -2107,7 +2097,6 @@ func TestKubeadmConfigReconciler_Reconcile_ExactlyOneControlPlaneMachineInitiali
21072097
}
21082098
result, err = k.Reconcile(ctx, request)
21092099
g.Expect(err).ToNot(HaveOccurred())
2110-
g.Expect(result.Requeue).To(BeFalse())
21112100
g.Expect(result.RequeueAfter).To(Equal(30 * time.Second))
21122101
confList := &bootstrapv1.KubeadmConfigList{}
21132102
g.Expect(myclient.List(ctx, confList)).To(Succeed())
@@ -2164,7 +2153,6 @@ func TestKubeadmConfigReconciler_Reconcile_PatchWhenErrorOccurred(t *testing.T)
21642153

21652154
result, err := k.Reconcile(ctx, request)
21662155
g.Expect(err).To(HaveOccurred())
2167-
g.Expect(result.Requeue).To(BeFalse())
21682156
g.Expect(result.RequeueAfter).To(Equal(time.Duration(0)))
21692157

21702158
cfg, err := getKubeadmConfig(myclient, "control-plane-init-cfg", metav1.NamespaceDefault)

‎controlplane/kubeadm/internal/controllers/consts.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,10 @@ const (
3030
// dependentCertRequeueAfter is how long to wait before checking again to see if
3131
// dependent certificates have been created.
3232
dependentCertRequeueAfter = 30 * time.Second
33+
34+
// scaleRequeueAfter is how long to wait before scaling up/down again after a scale operation has been requested.
35+
scaleRequeueAfter = 15 * time.Second
36+
37+
// initializationRequeueAfter is how long to wait before checking again to see if the initialization has been completed.
38+
initializationRequeueAfter = 15 * time.Second
3339
)

‎controlplane/kubeadm/internal/controllers/controller.go

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -191,8 +191,7 @@ func (r *KubeadmControlPlaneReconciler) Reconcile(ctx context.Context, req ctrl.
191191
// Initialize the patch helper.
192192
patchHelper, err := patch.NewHelper(kcp, r.Client)
193193
if err != nil {
194-
log.Error(err, "Failed to configure the patch helper")
195-
return ctrl.Result{Requeue: true}, nil
194+
return ctrl.Result{}, errors.Wrap(err, "failed to configure the patch helper")
196195
}
197196

198197
if isPaused, requeue, err := paused.EnsurePausedCondition(ctx, r.Client, cluster, kcp); err != nil || isPaused || requeue {
@@ -503,8 +502,7 @@ func (r *KubeadmControlPlaneReconciler) reconcile(ctx context.Context, controlPl
503502
// Get the workload cluster client.
504503
workloadCluster, err := controlPlane.GetWorkloadCluster(ctx)
505504
if err != nil {
506-
log.V(2).Info("cannot get remote client to workload cluster, will requeue", "cause", err)
507-
return ctrl.Result{Requeue: true}, nil
505+
return ctrl.Result{}, errors.Wrapf(err, "cannot get remote client to workload cluster for KubeadmControlPlane %s/%s", controlPlane.KCP.Namespace, controlPlane.KCP.Name)
508506
}
509507

510508
// Update kube-proxy daemonset.

‎controlplane/kubeadm/internal/controllers/controller_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -479,7 +479,7 @@ func TestReconcileClusterNoEndpoints(t *testing.T) {
479479
result, err = r.Reconcile(ctx, ctrl.Request{NamespacedName: util.ObjectKey(kcp)})
480480
g.Expect(err).ToNot(HaveOccurred())
481481
// TODO: this should stop to re-queue as soon as we have a proper remote cluster cache in place.
482-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: false, RequeueAfter: 20 * time.Second}))
482+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: 20 * time.Second}))
483483
g.Expect(r.Client.Get(ctx, util.ObjectKey(kcp), kcp)).To(Succeed())
484484

485485
// Always expect that the Finalizer is set on the passed in resource

‎controlplane/kubeadm/internal/controllers/remediation.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,7 @@ func (r *KubeadmControlPlaneReconciler) reconcileUnhealthyMachines(ctx context.C
368368
controlplanev1.RemediationInProgressAnnotation: remediationInProgressValue,
369369
})
370370

371-
return ctrl.Result{Requeue: true}, nil
371+
return ctrl.Result{RequeueAfter: time.Second * 20}, nil
372372
}
373373

374374
// Gets the machine to be remediated, which is the "most broken" among the unhealthy machines, determined as the machine

‎controlplane/kubeadm/internal/controllers/scale.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ func (r *KubeadmControlPlaneReconciler) initializeControlPlane(ctx context.Conte
6868
newMachine.Spec.Bootstrap.ConfigRef.Kind, klog.KRef(newMachine.Spec.Bootstrap.ConfigRef.Namespace, newMachine.Spec.Bootstrap.ConfigRef.Name))
6969

7070
// Requeue the control plane, in case there are additional operations to perform
71-
return ctrl.Result{Requeue: true}, nil
71+
return ctrl.Result{RequeueAfter: initializationRequeueAfter}, nil
7272
}
7373

7474
func (r *KubeadmControlPlaneReconciler) scaleUpControlPlane(ctx context.Context, controlPlane *internal.ControlPlane) (ctrl.Result, error) {
@@ -107,7 +107,7 @@ func (r *KubeadmControlPlaneReconciler) scaleUpControlPlane(ctx context.Context,
107107
newMachine.Spec.Bootstrap.ConfigRef.Kind, klog.KRef(newMachine.Spec.Bootstrap.ConfigRef.Namespace, newMachine.Spec.Bootstrap.ConfigRef.Name))
108108

109109
// Requeue the control plane, in case there are other operations to perform
110-
return ctrl.Result{Requeue: true}, nil
110+
return ctrl.Result{RequeueAfter: scaleRequeueAfter}, nil
111111
}
112112

113113
func (r *KubeadmControlPlaneReconciler) scaleDownControlPlane(
@@ -163,7 +163,7 @@ func (r *KubeadmControlPlaneReconciler) scaleDownControlPlane(
163163
Info("Deleting Machine (scale down)", "Machine", klog.KObj(machineToDelete))
164164

165165
// Requeue the control plane, in case there are additional operations to perform
166-
return ctrl.Result{Requeue: true}, nil
166+
return ctrl.Result{RequeueAfter: scaleRequeueAfter}, nil
167167
}
168168

169169
// preflightChecks checks if the control plane is stable before proceeding with a scale up/scale down operation,

‎controlplane/kubeadm/internal/controllers/scale_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ func TestKubeadmControlPlaneReconciler_initializeControlPlane(t *testing.T) {
8080
}
8181

8282
result, err := r.initializeControlPlane(ctx, controlPlane)
83-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
83+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: initializationRequeueAfter}))
8484
g.Expect(err).ToNot(HaveOccurred())
8585

8686
machineList := &clusterv1.MachineList{}
@@ -162,7 +162,7 @@ func TestKubeadmControlPlaneReconciler_scaleUpControlPlane(t *testing.T) {
162162
}
163163

164164
result, err := r.scaleUpControlPlane(ctx, controlPlane)
165-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
165+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: scaleRequeueAfter}))
166166
g.Expect(err).ToNot(HaveOccurred())
167167

168168
controlPlaneMachines := clusterv1.MachineList{}
@@ -286,7 +286,7 @@ func TestKubeadmControlPlaneReconciler_scaleDownControlPlane_NoError(t *testing.
286286

287287
result, err := r.scaleDownControlPlane(context.Background(), controlPlane, controlPlane.Machines)
288288
g.Expect(err).ToNot(HaveOccurred())
289-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
289+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: scaleRequeueAfter}))
290290

291291
controlPlaneMachines := clusterv1.MachineList{}
292292
g.Expect(fakeClient.List(context.Background(), &controlPlaneMachines)).To(Succeed())
@@ -328,7 +328,7 @@ func TestKubeadmControlPlaneReconciler_scaleDownControlPlane_NoError(t *testing.
328328

329329
result, err := r.scaleDownControlPlane(context.Background(), controlPlane, controlPlane.Machines)
330330
g.Expect(err).ToNot(HaveOccurred())
331-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
331+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: scaleRequeueAfter}))
332332

333333
controlPlaneMachines := clusterv1.MachineList{}
334334
g.Expect(fakeClient.List(context.Background(), &controlPlaneMachines)).To(Succeed())

‎controlplane/kubeadm/internal/controllers/upgrade_test.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ func TestKubeadmControlPlaneReconciler_RolloutStrategy_ScaleUp(t *testing.T) {
106106
controlPlane.InjectTestManagementCluster(r.managementCluster)
107107

108108
result, err := r.initializeControlPlane(ctx, controlPlane)
109-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
109+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: initializationRequeueAfter}))
110110
g.Expect(err).ToNot(HaveOccurred())
111111

112112
// initial setup
@@ -128,7 +128,7 @@ func TestKubeadmControlPlaneReconciler_RolloutStrategy_ScaleUp(t *testing.T) {
128128
needingUpgrade := collections.FromMachineList(initialMachine)
129129
controlPlane.Machines = needingUpgrade
130130
result, err = r.upgradeControlPlane(ctx, controlPlane, needingUpgrade)
131-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
131+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: scaleRequeueAfter}))
132132
g.Expect(err).ToNot(HaveOccurred())
133133
bothMachines := &clusterv1.MachineList{}
134134
g.Eventually(func(g Gomega) {
@@ -171,7 +171,7 @@ func TestKubeadmControlPlaneReconciler_RolloutStrategy_ScaleUp(t *testing.T) {
171171
// run upgrade the second time, expect we scale down
172172
result, err = r.upgradeControlPlane(ctx, controlPlane, machinesRequireUpgrade)
173173
g.Expect(err).ToNot(HaveOccurred())
174-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
174+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: scaleRequeueAfter}))
175175
finalMachine := &clusterv1.MachineList{}
176176
g.Eventually(func(g Gomega) {
177177
g.Expect(env.List(ctx, finalMachine, client.InNamespace(cluster.Namespace))).To(Succeed())
@@ -262,7 +262,7 @@ func TestKubeadmControlPlaneReconciler_RolloutStrategy_ScaleDown(t *testing.T) {
262262
controlPlane.Machines = needingUpgrade
263263

264264
result, err = r.upgradeControlPlane(ctx, controlPlane, needingUpgrade)
265-
g.Expect(result).To(BeComparableTo(ctrl.Result{Requeue: true}))
265+
g.Expect(result).To(BeComparableTo(ctrl.Result{RequeueAfter: scaleRequeueAfter}))
266266
g.Expect(err).ToNot(HaveOccurred())
267267
remainingMachines := &clusterv1.MachineList{}
268268
g.Expect(fakeClient.List(ctx, remainingMachines, client.InNamespace(cluster.Namespace))).To(Succeed())

0 commit comments

Comments
 (0)