release leader election lease on manager cancellation

Signed-off-by: Joe Lanford <joe.lanford@gmail.com>

Author: joelanford

catalogd/cmd/catalogd/main.go

@@ -227,12 +227,13 @@ func main() {
 
 	// Create manager
 	mgr, err := ctrl.NewManager(cfg, ctrl.Options{
-		Scheme:                 scheme,
-		Metrics:                metricsServerOptions,
-		PprofBindAddress:       pprofAddr,
-		HealthProbeBindAddress: probeAddr,
-		LeaderElection:         enableLeaderElection,
-		LeaderElectionID:       "catalogd-operator-lock",
+		Scheme:                        scheme,
+		Metrics:                       metricsServerOptions,
+		PprofBindAddress:              pprofAddr,
+		HealthProbeBindAddress:        probeAddr,
+		LeaderElection:                enableLeaderElection,
+		LeaderElectionID:              "catalogd-operator-lock",
+		LeaderElectionReleaseOnCancel: true,
 		// Recommended Leader Election values
 		// https://github.com/openshift/enhancements/blob/61581dcd985130357d6e4b0e72b87ee35394bf6e/CONVENTIONS.md#handling-kube-apiserver-disruption
 		LeaseDuration: ptr.To(137 * time.Second),

catalogd/test/upgrade/unpack_test.go

@@ -54,17 +54,6 @@ var _ = Describe("ClusterCatalog Unpacking", func() {
 				managerPod = managerPods.Items[0]
 			}).Should(Succeed())
 
-			By("Waiting for acquired leader election")
-			// Average case is under 1 minute but in the worst case: (previous leader crashed)
-			// we could have LeaseDuration (137s) + RetryPeriod (26s) +/- 163s
-			leaderCtx, leaderCancel := context.WithTimeout(ctx, 3*time.Minute)
-			defer leaderCancel()
-
-			leaderSubstrings := []string{"successfully acquired lease"}
-			leaderElected, err := watchPodLogsForSubstring(leaderCtx, &managerPod, "manager", leaderSubstrings...)
-			Expect(err).To(Succeed())
-			Expect(leaderElected).To(BeTrue())
-
 			By("Reading logs to make sure that ClusterCatalog was reconciled by catalogdv1")
 			logCtx, cancel := context.WithTimeout(ctx, time.Minute)
 			defer cancel()

cmd/operator-controller/main.go

@@ -228,11 +228,12 @@ func main() {
 	}
 
 	mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{
-		Scheme:                 scheme.Scheme,
-		Metrics:                metricsServerOptions,
-		HealthProbeBindAddress: probeAddr,
-		LeaderElection:         enableLeaderElection,
-		LeaderElectionID:       "9c4404e7.operatorframework.io",
+		Scheme:                        scheme.Scheme,
+		Metrics:                       metricsServerOptions,
+		HealthProbeBindAddress:        probeAddr,
+		LeaderElection:                enableLeaderElection,
+		LeaderElectionID:              "9c4404e7.operatorframework.io",
+		LeaderElectionReleaseOnCancel: true,
 		// Recommended Leader Election values
 		// https://github.com/openshift/enhancements/blob/61581dcd985130357d6e4b0e72b87ee35394bf6e/CONVENTIONS.md#handling-kube-apiserver-disruption
 		LeaseDuration: ptr.To(137 * time.Second),

test/upgrade-e2e/post_upgrade_test.go

@@ -40,17 +40,6 @@ func TestClusterExtensionAfterOLMUpgrade(t *testing.T) {
 	t.Log("Wait for operator-controller deployment to be ready")
 	managerPod := waitForDeployment(t, ctx, "operator-controller-controller-manager")
 
-	t.Log("Wait for acquired leader election")
-	// Average case is under 1 minute but in the worst case: (previous leader crashed)
-	// we could have LeaseDuration (137s) + RetryPeriod (26s) +/- 163s
-	leaderCtx, leaderCancel := context.WithTimeout(ctx, 3*time.Minute)
-	defer leaderCancel()
-
-	leaderSubstrings := []string{"successfully acquired lease"}
-	leaderElected, err := watchPodLogsForSubstring(leaderCtx, managerPod, "manager", leaderSubstrings...)
-	require.NoError(t, err)
-	require.True(t, leaderElected)
-
 	t.Log("Reading logs to make sure that ClusterExtension was reconciled by operator-controller before we update it")
 	// Make sure that after we upgrade OLM itself we can still reconcile old objects without any changes
 	logCtx, cancel := context.WithTimeout(ctx, time.Minute)