Add an "ExternalHelmControllerName" option to operator and chart

Author: mallardduck

charts/prometheus-federator/templates/deployment.yaml

@@ -89,6 +89,11 @@ spec:
 {{- else }}
           - --helm-job-image={{ template "system_default_registry" . }}{{ .Values.helmProjectOperator.helmController.job.image.repository }}:{{ .Values.helmProjectOperator.helmController.job.image.tag }}
 {{- end }}
+{{- if and (not .Values.helmProjectOperator.helmController.enabled)  (.Values.helmController.deployment.enabled) }}
+          - --external-helm-controller-name="{{ include "prometheus-federator.name" .  }}-helm-controller"
+{{- else if and (not .Values.helmProjectOperator.helmController.enabled)  (not .Values.helmController.deployment.enabled) (hasKey .Values "externalHelmControllerName") }}
+          - --external-helm-controller-name={{ .Values.externalHelmControllerName | quote }}
+{{- end }}
 {{- if not .Values.helmProjectOperator.helmLocker.enabled }}
           - --disable-embedded-helm-locker
 {{- end }}

charts/prometheus-federator/values.yaml

@@ -264,9 +264,16 @@ namespaceRegistration:
 
 helmController:
   deployment:
-    enabled : false
-    replicas : 1
+    enabled: false
+    replicas: 1
     image:
       repository: rancher/helm-controller
       tag: v0.16.10
-      pullPolicy: IfNotPresent
+      pullPolicy: IfNotPresent
+
+## externalHelmControllerName defines a custom external helm controller name to set as the HelmChart CR manager
+## This should only be used when all are true:
+##   - `helmController.deployment.enabled` is false,
+##   - `helmProjectOperator.helmController.enabled` is false, AND
+##   - the external helm-controller you will use is not the default global `helm-controller`
+#externalHelmControllerName: "my-helm-controller"

internal/helm-project-operator/controllers/common/runtime.go

@@ -95,10 +95,13 @@ type RuntimeOptions struct {
 	// DisableEmbeddedHelmLocker determines whether to disable embedded Helm Locker controller in favor of external Helm Locker
 	DisableEmbeddedHelmLocker bool `usage:"Whether to disable embedded Helm Locker controller in favor of external Helm Locker" env:"DISABLE_EMBEDDED_HELM_LOCKER"`
 
-	// DisableEmbeddedHelmController determines whether to disable embedded Helm Controller controller in favor of external Helm Controller
+	// DisableEmbeddedHelmController determines whether to disable embedded Helm Controller in favor of an external Helm Controller
 	// This should be the default in most RKE2 clusters since the RKE2 server binary already embeds a Helm Controller instance that manages HelmCharts
 	DisableEmbeddedHelmController bool `usage:"Whether to disable embedded Helm Controller controller in favor of external Helm Controller (recommended for RKE2 clusters)" env:"DISABLE_EMBEDDED_HELM_CONTROLLER"`
 
+	// ExternalHelmControllerName determines the name of the external Helm Controller to declare as managing the HelmCharts that PromFed creates
+	ExternalHelmControllerName string `usage:"Set the external Helm Controller's name to manage which controller will own the HelmCharts created by this operator" default:"helm-controller" env:"EXTERNAL_HELM_CONTROLLER_NAME"`
+
 	// NamespaceRegistrationWorkers sets the number of workers to be run in the Namespace Controller
 	// Useful in large clusters or high-latency environments that reach the operator initialization timeout before all namespaces have been registered
 	NamespaceRegistrationWorkers int `usage:"Set the number of workers to be run in the Namespace Controller" default:"2" env:"NAMESPACE_REGISTRATION_WORKERS"`

internal/helm-project-operator/controllers/project/resources.go

@@ -34,9 +34,10 @@ func (h *handler) getHelmChart(projectID string, valuesContent string, projectHe
 		},
 	})
 	helmChart.SetLabels(common.GetHelmResourceLabels(projectID, projectHelmChart.Spec.HelmAPIVersion))
-	managedBy := "helm-controller"
-	if !h.opts.DisableEmbeddedHelmController {
-		managedBy = h.opts.ControllerName
+	managedBy := h.opts.ControllerName
+	if h.opts.DisableEmbeddedHelmController {
+		// ExternalHelmControllerName defaults to `helm-controller`, but can be customized
+		managedBy = h.opts.ExternalHelmControllerName
 	}
 	helmChart.SetAnnotations(map[string]string{
 		chart.ManagedBy: managedBy,