Merge pull request #782 from kubernetes-sigs/additional-options

k8s-ci-robot · web-flow · commit 48cef8d2d011 · 2025-04-16T07:21:08.000-07:00
✨ Add AdditionalArgs field to API for custom provider settings
diff --git a/api/v1alpha1/provider_conversion.go b/api/v1alpha1/provider_conversion.go
@@ -48,6 +48,10 @@ func (src *BootstrapProvider) ConvertTo(dstRaw conversion.Hub) error {
 	dst.Spec.AdditionalDeployments = restored.Spec.AdditionalDeployments
 	dst.Spec.FetchConfig.OCI = restored.Spec.FetchConfig.OCI
 
+	if restored.Spec.ProviderSpec.Manager != nil {
+		dst.Spec.ProviderSpec.Manager.AdditionalArgs = restored.Spec.ProviderSpec.Manager.AdditionalArgs
+	}
+
 	return nil
 }
 
@@ -111,6 +115,10 @@ func (src *ControlPlaneProvider) ConvertTo(dstRaw conversion.Hub) error {
 	dst.Spec.AdditionalDeployments = restored.Spec.AdditionalDeployments
 	dst.Spec.FetchConfig.OCI = restored.Spec.FetchConfig.OCI
 
+	if restored.Spec.ProviderSpec.Manager != nil {
+		dst.Spec.ProviderSpec.Manager.AdditionalArgs = restored.Spec.ProviderSpec.Manager.AdditionalArgs
+	}
+
 	return nil
 }
 
@@ -174,6 +182,10 @@ func (src *CoreProvider) ConvertTo(dstRaw conversion.Hub) error {
 	dst.Spec.AdditionalDeployments = restored.Spec.AdditionalDeployments
 	dst.Spec.FetchConfig.OCI = restored.Spec.FetchConfig.OCI
 
+	if restored.Spec.ProviderSpec.Manager != nil {
+		dst.Spec.ProviderSpec.Manager.AdditionalArgs = restored.Spec.ProviderSpec.Manager.AdditionalArgs
+	}
+
 	return nil
 }
 
@@ -237,6 +249,10 @@ func (src *InfrastructureProvider) ConvertTo(dstRaw conversion.Hub) error {
 	dst.Spec.AdditionalDeployments = restored.Spec.AdditionalDeployments
 	dst.Spec.FetchConfig.OCI = restored.Spec.FetchConfig.OCI
 
+	if restored.Spec.ProviderSpec.Manager != nil {
+		dst.Spec.ProviderSpec.Manager.AdditionalArgs = restored.Spec.ProviderSpec.Manager.AdditionalArgs
+	}
+
 	return nil
 }
 
diff --git a/api/v1alpha1/zz_generated.conversion.go b/api/v1alpha1/zz_generated.conversion.go
diff --git a/api/v1alpha2/conditions_consts.go b/api/v1alpha2/conditions_consts.go
@@ -47,6 +47,15 @@ const (
 	// ComponentsFetchErrorReason documents that an error occurred fetching the components.
 	ComponentsFetchErrorReason = "ComponentsFetchError"
 
+	// ComponentsCustomizationErrorReason documents that an error occurred customizing the components.
+	ComponentsCustomizationErrorReason = "ComponentsCustomizationError"
+
+	// ComponentsPatchErrorReason documents that an error occurred patching the components.
+	ComponentsPatchErrorReason = "ComponentsPatchError"
+
+	// ComponentsImageOverrideErrorReason documents that an error occurred overriding the components image.
+	ComponentsImageOverrideErrorReason = "ComponentsImageOverrideError"
+
 	// ComponentsUpgradeErrorReason documents that an error occurred while upgrading the components.
 	ComponentsUpgradeErrorReason = "ComponentsUpgradeError"
 
diff --git a/api/v1alpha2/provider_types.go b/api/v1alpha2/provider_types.go
@@ -150,6 +150,11 @@ type ManagerSpec struct {
 	// in as container args to the provider's controller manager.
 	// Controller Manager flag is --feature-gates.
 	FeatureGates map[string]bool `json:"featureGates,omitempty"`
+
+	// AdditionalArgs is a map of additional options that will be passed
+	// in as container args to the provider's controller manager.
+	// +optional
+	AdditionalArgs map[string]string `json:"additionalArgs,omitempty"`
 }
 
 // DeploymentSpec defines the properties that can be enabled on the Deployment for the provider.
diff --git a/api/v1alpha2/zz_generated.deepcopy.go b/api/v1alpha2/zz_generated.deepcopy.go
diff --git a/config/crd/bases/operator.cluster.x-k8s.io_addonproviders.yaml b/config/crd/bases/operator.cluster.x-k8s.io_addonproviders.yaml
@@ -1291,6 +1291,13 @@ spec:
                       description: Manager defines the properties that can be enabled
                         on the controller manager for the additional provider deployment.
                       properties:
+                        additionalArgs:
+                          additionalProperties:
+                            type: string
+                          description: |-
+                            AdditionalArgs is a map of additional options that will be passed
+                            in as container args to the provider's controller manager.
+                          type: object
                         cacheNamespace:
                           description: |-
                             CacheNamespace if specified restricts the manager's cache to watch objects in
@@ -2822,6 +2829,13 @@ spec:
                 description: Manager defines the properties that can be enabled on
                   the controller manager for the provider.
                 properties:
+                  additionalArgs:
+                    additionalProperties:
+                      type: string
+                    description: |-
+                      AdditionalArgs is a map of additional options that will be passed
+                      in as container args to the provider's controller manager.
+                    type: object
                   cacheNamespace:
                     description: |-
                       CacheNamespace if specified restricts the manager's cache to watch objects in
diff --git a/config/crd/bases/operator.cluster.x-k8s.io_bootstrapproviders.yaml b/config/crd/bases/operator.cluster.x-k8s.io_bootstrapproviders.yaml
@@ -2928,6 +2928,13 @@ spec:
                       description: Manager defines the properties that can be enabled
                         on the controller manager for the additional provider deployment.
                       properties:
+                        additionalArgs:
+                          additionalProperties:
+                            type: string
+                          description: |-
+                            AdditionalArgs is a map of additional options that will be passed
+                            in as container args to the provider's controller manager.
+                          type: object
                         cacheNamespace:
                           description: |-
                             CacheNamespace if specified restricts the manager's cache to watch objects in
@@ -4459,6 +4466,13 @@ spec:
                 description: Manager defines the properties that can be enabled on
                   the controller manager for the provider.
                 properties:
+                  additionalArgs:
+                    additionalProperties:
+                      type: string
+                    description: |-
+                      AdditionalArgs is a map of additional options that will be passed
+                      in as container args to the provider's controller manager.
+                    type: object
                   cacheNamespace:
                     description: |-
                       CacheNamespace if specified restricts the manager's cache to watch objects in
diff --git a/config/crd/bases/operator.cluster.x-k8s.io_controlplaneproviders.yaml b/config/crd/bases/operator.cluster.x-k8s.io_controlplaneproviders.yaml
@@ -2930,6 +2930,13 @@ spec:
                       description: Manager defines the properties that can be enabled
                         on the controller manager for the additional provider deployment.
                       properties:
+                        additionalArgs:
+                          additionalProperties:
+                            type: string
+                          description: |-
+                            AdditionalArgs is a map of additional options that will be passed
+                            in as container args to the provider's controller manager.
+                          type: object
                         cacheNamespace:
                           description: |-
                             CacheNamespace if specified restricts the manager's cache to watch objects in
@@ -4461,6 +4468,13 @@ spec:
                 description: Manager defines the properties that can be enabled on
                   the controller manager for the provider.
                 properties:
+                  additionalArgs:
+                    additionalProperties:
+                      type: string
+                    description: |-
+                      AdditionalArgs is a map of additional options that will be passed
+                      in as container args to the provider's controller manager.
+                    type: object
                   cacheNamespace:
                     description: |-
                       CacheNamespace if specified restricts the manager's cache to watch objects in
diff --git a/config/crd/bases/operator.cluster.x-k8s.io_coreproviders.yaml b/config/crd/bases/operator.cluster.x-k8s.io_coreproviders.yaml
@@ -2928,6 +2928,13 @@ spec:
                       description: Manager defines the properties that can be enabled
                         on the controller manager for the additional provider deployment.
                       properties:
+                        additionalArgs:
+                          additionalProperties:
+                            type: string
+                          description: |-
+                            AdditionalArgs is a map of additional options that will be passed
+                            in as container args to the provider's controller manager.
+                          type: object
                         cacheNamespace:
                           description: |-
                             CacheNamespace if specified restricts the manager's cache to watch objects in
@@ -4459,6 +4466,13 @@ spec:
                 description: Manager defines the properties that can be enabled on
                   the controller manager for the provider.
                 properties:
+                  additionalArgs:
+                    additionalProperties:
+                      type: string
+                    description: |-
+                      AdditionalArgs is a map of additional options that will be passed
+                      in as container args to the provider's controller manager.
+                    type: object
                   cacheNamespace:
                     description: |-
                       CacheNamespace if specified restricts the manager's cache to watch objects in
diff --git a/config/crd/bases/operator.cluster.x-k8s.io_infrastructureproviders.yaml b/config/crd/bases/operator.cluster.x-k8s.io_infrastructureproviders.yaml
@@ -2930,6 +2930,13 @@ spec:
                       description: Manager defines the properties that can be enabled
                         on the controller manager for the additional provider deployment.
                       properties:
+                        additionalArgs:
+                          additionalProperties:
+                            type: string
+                          description: |-
+                            AdditionalArgs is a map of additional options that will be passed
+                            in as container args to the provider's controller manager.
+                          type: object
                         cacheNamespace:
                           description: |-
                             CacheNamespace if specified restricts the manager's cache to watch objects in
@@ -4461,6 +4468,13 @@ spec:
                 description: Manager defines the properties that can be enabled on
                   the controller manager for the provider.
                 properties:
+                  additionalArgs:
+                    additionalProperties:
+                      type: string
+                    description: |-
+                      AdditionalArgs is a map of additional options that will be passed
+                      in as container args to the provider's controller manager.
+                    type: object
                   cacheNamespace:
                     description: |-
                       CacheNamespace if specified restricts the manager's cache to watch objects in
diff --git a/config/crd/bases/operator.cluster.x-k8s.io_ipamproviders.yaml b/config/crd/bases/operator.cluster.x-k8s.io_ipamproviders.yaml
@@ -1291,6 +1291,13 @@ spec:
                       description: Manager defines the properties that can be enabled
                         on the controller manager for the additional provider deployment.
                       properties:
+                        additionalArgs:
+                          additionalProperties:
+                            type: string
+                          description: |-
+                            AdditionalArgs is a map of additional options that will be passed
+                            in as container args to the provider's controller manager.
+                          type: object
                         cacheNamespace:
                           description: |-
                             CacheNamespace if specified restricts the manager's cache to watch objects in
@@ -2822,6 +2829,13 @@ spec:
                 description: Manager defines the properties that can be enabled on
                   the controller manager for the provider.
                 properties:
+                  additionalArgs:
+                    additionalProperties:
+                      type: string
+                    description: |-
+                      AdditionalArgs is a map of additional options that will be passed
+                      in as container args to the provider's controller manager.
+                    type: object
                   cacheNamespace:
                     description: |-
                       CacheNamespace if specified restricts the manager's cache to watch objects in
diff --git a/config/crd/bases/operator.cluster.x-k8s.io_runtimeextensionproviders.yaml b/config/crd/bases/operator.cluster.x-k8s.io_runtimeextensionproviders.yaml
@@ -1293,6 +1293,13 @@ spec:
                       description: Manager defines the properties that can be enabled
                         on the controller manager for the additional provider deployment.
                       properties:
+                        additionalArgs:
+                          additionalProperties:
+                            type: string
+                          description: |-
+                            AdditionalArgs is a map of additional options that will be passed
+                            in as container args to the provider's controller manager.
+                          type: object
                         cacheNamespace:
                           description: |-
                             CacheNamespace if specified restricts the manager's cache to watch objects in
@@ -2824,6 +2831,13 @@ spec:
                 description: Manager defines the properties that can be enabled on
                   the controller manager for the provider.
                 properties:
+                  additionalArgs:
+                    additionalProperties:
+                      type: string
+                    description: |-
+                      AdditionalArgs is a map of additional options that will be passed
+                      in as container args to the provider's controller manager.
+                    type: object
                   cacheNamespace:
                     description: |-
                       CacheNamespace if specified restricts the manager's cache to watch objects in
diff --git a/internal/controller/component_customizer.go b/internal/controller/component_customizer.go
@@ -137,7 +137,9 @@ func customizeDeployment(dSpec *operatorv1.DeploymentSpec, mSpec *operatorv1.Man
 			return fmt.Errorf("cannot find %q container in deployment %q", managerContainerName, d.Name)
 		}
 
-		customizeManagerContainer(mSpec, container)
+		if err := customizeManagerContainer(mSpec, container); err != nil {
+			return fmt.Errorf("failed to customize manager container: %w", err)
+		}
 	}
 
 	return nil
@@ -184,7 +186,7 @@ func findManagerContainer(dSpec *appsv1.DeploymentSpec) *corev1.Container {
 }
 
 // customizeManagerContainer customize manager container base on provider spec input.
-func customizeManagerContainer(mSpec *operatorv1.ManagerSpec, c *corev1.Container) {
+func customizeManagerContainer(mSpec *operatorv1.ManagerSpec, c *corev1.Container) error {
 	// ControllerManagerConfigurationSpec fields
 	if mSpec.Controller != nil {
 		// TODO can't find an arg for CacheSyncTimeout
@@ -266,6 +268,19 @@ func customizeManagerContainer(mSpec *operatorv1.ManagerSpec, c *corev1.Containe
 		sort.Strings(fgValue)
 		c.Args = setArgs(c.Args, "--feature-gates", strings.Join(fgValue, ","))
 	}
+
+	for k, v := range mSpec.AdditionalArgs {
+		// Make sure the key is not already in the args
+		for _, arg := range c.Args {
+			if strings.HasPrefix(arg, k+"=") {
+				return fmt.Errorf("arg %q already exists", k)
+			}
+		}
+
+		c.Args = setArgs(c.Args, k, v)
+	}
+
+	return nil
 }
 
 // customizeContainer customize provider container base on provider spec input.
diff --git a/internal/controller/component_customizer_test.go b/internal/controller/component_customizer_test.go
diff --git a/internal/controller/phases.go b/internal/controller/phases.go
diff --git a/test/e2e/resources/full-chart-install.yaml b/test/e2e/resources/full-chart-install.yaml
