fix: preserve existing flags when applying metrics patch

Ensure that enabling the manager_metrics_patch.yaml in config/default/kustomization.yaml does not overwrite existing arguments in config/manager/manager.yaml. The patch now appends the --metrics-bind-address argument without replacing other arguments.

More info: kubernetes-sigs#3934

docs/book/src/cronjob-tutorial/testdata/project/config/default/manager_metrics_patch.yaml

@@ -10,4 +10,9 @@ spec:
       containers:
       - name: manager
         args:
-        - "--metrics-bind-address=0.0.0.0:8080"
+          # Ensure that the the patch has the args
+          # provided in the config/manager/manager.yaml
+          # More info: https://github.com/kubernetes-sigs/kubebuilder/issues/3934
+          - "--metrics-bind-address=0.0.0.0:8080"
+          - "--leader-elect"
+          - "--health-probe-bind-address=:8081"

docs/book/src/getting-started/testdata/project/config/default/manager_metrics_patch.yaml

@@ -10,4 +10,9 @@ spec:
       containers:
       - name: manager
         args:
-        - "--metrics-bind-address=0.0.0.0:8080"
+          # Ensure that the the patch has the args
+          # provided in the config/manager/manager.yaml
+          # More info: https://github.com/kubernetes-sigs/kubebuilder/issues/3934
+          - "--metrics-bind-address=0.0.0.0:8080"
+          - "--leader-elect"
+          - "--health-probe-bind-address=:8081"

pkg/plugins/common/kustomize/v2/scaffolds/internal/templates/config/kdefault/enable_matrics_patch.go

@@ -55,5 +55,10 @@ spec:
       containers:
       - name: manager
         args:
-        - "--metrics-bind-address=0.0.0.0:8080"
+          # Ensure that the the patch has the args
+          # provided in the config/manager/manager.yaml
+          # More info: https://github.com/kubernetes-sigs/kubebuilder/issues/3934
+          - "--metrics-bind-address=0.0.0.0:8080"
+          - "--leader-elect"
+          - "--health-probe-bind-address=:8081"
 `

test/e2e/v4/plugin_cluster_test.go

@@ -163,6 +163,18 @@ func Run(kbc *utils.TestContext, hasWebhook, isToUseInstaller, hasMetrics bool)
 	}()
 	EventuallyWithOffset(1, verifyControllerUp, time.Minute, time.Second).Should(Succeed())
 
+	By("Checking if all flags are applied to the manager pod")
+	podOutput, err := kbc.Kubectl.Get(
+		true,
+		"pod", controllerPodName,
+		"-o", "jsonpath={.spec.containers[0].args}",
+	)
+	ExpectWithOffset(1, err).NotTo(HaveOccurred())
+	ExpectWithOffset(1, podOutput).To(ContainSubstring("leader-elect"),
+		"Expected manager pod to have --leader-elect flag")
+	ExpectWithOffset(1, podOutput).To(ContainSubstring("health-probe-bind-address"),
+		"Expected manager pod to have --health-probe-bind-address flag")
+
 	By("validating the metrics endpoint")
 	_ = curlMetrics(kbc, hasMetrics)
 

testdata/project-v4-multigroup-with-deploy-image/config/default/manager_metrics_patch.yaml

@@ -10,4 +10,9 @@ spec:
       containers:
       - name: manager
         args:
-        - "--metrics-bind-address=0.0.0.0:8080"
+          # Ensure that the the patch has the args
+          # provided in the config/manager/manager.yaml
+          # More info: https://github.com/kubernetes-sigs/kubebuilder/issues/3934
+          - "--metrics-bind-address=0.0.0.0:8080"
+          - "--leader-elect"
+          - "--health-probe-bind-address=:8081"

testdata/project-v4-multigroup/config/default/manager_metrics_patch.yaml

@@ -10,4 +10,9 @@ spec:
       containers:
       - name: manager
         args:
-        - "--metrics-bind-address=0.0.0.0:8080"
+          # Ensure that the the patch has the args
+          # provided in the config/manager/manager.yaml
+          # More info: https://github.com/kubernetes-sigs/kubebuilder/issues/3934
+          - "--metrics-bind-address=0.0.0.0:8080"
+          - "--leader-elect"
+          - "--health-probe-bind-address=:8081"

testdata/project-v4-with-deploy-image/config/default/manager_metrics_patch.yaml

@@ -10,4 +10,9 @@ spec:
       containers:
       - name: manager
         args:
-        - "--metrics-bind-address=0.0.0.0:8080"
+          # Ensure that the the patch has the args
+          # provided in the config/manager/manager.yaml
+          # More info: https://github.com/kubernetes-sigs/kubebuilder/issues/3934
+          - "--metrics-bind-address=0.0.0.0:8080"
+          - "--leader-elect"
+          - "--health-probe-bind-address=:8081"

testdata/project-v4-with-grafana/config/default/manager_metrics_patch.yaml

@@ -10,4 +10,9 @@ spec:
       containers:
       - name: manager
         args:
-        - "--metrics-bind-address=0.0.0.0:8080"
+          # Ensure that the the patch has the args
+          # provided in the config/manager/manager.yaml
+          # More info: https://github.com/kubernetes-sigs/kubebuilder/issues/3934
+          - "--metrics-bind-address=0.0.0.0:8080"
+          - "--leader-elect"
+          - "--health-probe-bind-address=:8081"

testdata/project-v4/config/default/manager_metrics_patch.yaml

@@ -10,4 +10,9 @@ spec:
       containers:
       - name: manager
         args:
-        - "--metrics-bind-address=0.0.0.0:8080"
+          # Ensure that the the patch has the args
+          # provided in the config/manager/manager.yaml
+          # More info: https://github.com/kubernetes-sigs/kubebuilder/issues/3934
+          - "--metrics-bind-address=0.0.0.0:8080"
+          - "--leader-elect"
+          - "--health-probe-bind-address=:8081"