Add Additional Options to CAPIO API

Fedosin · Fedosin · commit ca7639bf1e93 · 2025-04-14T17:36:44.000+02:00
Currently operator's API only allows to set common, most
popular provider options. But sometimes it is necessary to specify
non-standard options that the operator is not aware about.

To do this we add a new API field called "AdditionalOptions" of type
map[string]string. Every key there will be attached to provider's
starting command.
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/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
@@ -85,6 +85,7 @@ func TestCustomizeDeployment(t *testing.T) {
 		inputDeploymentSpec    *operatorv1.DeploymentSpec
 		inputManagerSpec       *operatorv1.ManagerSpec
 		expectedDeploymentSpec func(*appsv1.DeploymentSpec) (*appsv1.DeploymentSpec, bool)
+		expectedError          bool
 	}{
 		{
 			name:                "empty",
@@ -492,6 +493,10 @@ func TestCustomizeDeployment(t *testing.T) {
 						RetryPeriod:       metav1.Duration{Duration: sevenHours},
 					},
 				},
+				AdditionalArgs: map[string]string{
+					"--test-option":    "test-value",
+					"--another-option": "another-value",
+				},
 			},
 			expectedDeploymentSpec: func(inputDS *appsv1.DeploymentSpec) (*appsv1.DeploymentSpec, bool) {
 				expectedDS := &appsv1.DeploymentSpec{
@@ -526,6 +531,8 @@ func TestCustomizeDeployment(t *testing.T) {
 										"--profiler-address=localhost:1234",
 										"--v=5",
 										"--feature-gates=ANOTHER=false,TEST=true",
+										"--test-option=test-value",
+										"--another-option=another-value",
 									},
 									LivenessProbe: &corev1.Probe{
 										ProbeHandler: corev1.ProbeHandler{
@@ -552,12 +559,50 @@ func TestCustomizeDeployment(t *testing.T) {
 				return expectedDS, reflect.DeepEqual(inputDS.Template.Spec.Containers[0], expectedDS.Template.Spec.Containers[0])
 			},
 		},
+		{
+			name: "additional arg already in args list with different value",
+			inputManagerSpec: &operatorv1.ManagerSpec{
+				ControllerManagerConfiguration: operatorv1.ControllerManagerConfiguration{
+					Webhook: operatorv1.ControllerWebhook{
+						Port:    ptr.To(3579),
+						CertDir: "/tmp/certs",
+					},
+				},
+				AdditionalArgs: map[string]string{
+					"--test-option":    "test-value",
+					"--webhook-port":   "0000",
+					"--another-option": "another-value",
+				},
+			},
+			expectedError: true,
+		},
+		{
+			name: "additional arg already in args list with same value",
+			inputManagerSpec: &operatorv1.ManagerSpec{
+				ControllerManagerConfiguration: operatorv1.ControllerManagerConfiguration{
+					Webhook: operatorv1.ControllerWebhook{
+						Port:    ptr.To(3579),
+						CertDir: "/tmp/certs",
+					},
+				},
+				AdditionalArgs: map[string]string{
+					"--test-option":    "test-value",
+					"--webhook-port":   "3579",
+					"--another-option": "another-value",
+				},
+			},
+			expectedError: true,
+		},
 	}
 
 	for _, tc := range tests {
 		t.Run(tc.name, func(t *testing.T) {
 			deployment := managerDepl.DeepCopy()
 			if err := customizeDeployment(tc.inputDeploymentSpec, tc.inputManagerSpec, deployment); err != nil {
+				if tc.expectedError {
+					return
+				}
+
 				t.Error(err)
 			}
 
diff --git a/test/e2e/resources/full-chart-install.yaml b/test/e2e/resources/full-chart-install.yaml
