Add configurable CRDPattern field for manager.

api/v1alpha1/provider_conversion.go

@@ -46,6 +46,9 @@ func (src *BootstrapProvider) ConvertTo(dstRaw conversion.Hub) error {
  }
 
  dst.Spec.ManifestPatches = restored.Spec.ManifestPatches
+ if restored.Spec.Manager != nil {
+ dst.Spec.Manager.CRDPattern = restored.Spec.Manager.CRDPattern
+ }
 
  return nil
 }
@@ -107,6 +110,9 @@ func (src *ControlPlaneProvider) ConvertTo(dstRaw conversion.Hub) error {
  }
 
  dst.Spec.ManifestPatches = restored.Spec.ManifestPatches
+ if restored.Spec.Manager != nil {
+ dst.Spec.Manager.CRDPattern = restored.Spec.Manager.CRDPattern
+ }
 
  return nil
 }
@@ -168,6 +174,9 @@ func (src *CoreProvider) ConvertTo(dstRaw conversion.Hub) error {
  }
 
  dst.Spec.ManifestPatches = restored.Spec.ManifestPatches
+ if restored.Spec.Manager != nil {
+ dst.Spec.Manager.CRDPattern = restored.Spec.Manager.CRDPattern
+ }
 
  return nil
 }
@@ -229,6 +238,9 @@ func (src *InfrastructureProvider) ConvertTo(dstRaw conversion.Hub) error {
  }
 
  dst.Spec.ManifestPatches = restored.Spec.ManifestPatches
+ if restored.Spec.Manager != nil {
+ dst.Spec.Manager.CRDPattern = restored.Spec.Manager.CRDPattern
+ }
 
  return nil
 }

api/v1alpha2/provider_types.go

@@ -123,6 +123,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"`
+
+ // CRDPattern is a regular expression that matches the CRDs that the provider
+ // is expected to manage.
+ // +optional
+ CRDPattern *string `json:"crdPattern,omitempty"`
 }
 
 // DeploymentSpec defines the properties that can be enabled on the Deployment for the provider.

config/crd/bases/operator.cluster.x-k8s.io_addonproviders.yaml

@@ -1369,6 +1369,11 @@ spec:
  description: RecoverPanic indicates if panics should be recovered.
  type: boolean
  type: object
+ crdPattern:
+ description: |-
+ CRDPattern is a regular expression that matches the CRDs that the provider
+ is expected to manage.
+ type: string
  featureGates:
  additionalProperties:
  type: boolean

config/crd/bases/operator.cluster.x-k8s.io_bootstrapproviders.yaml

@@ -2954,6 +2954,11 @@ spec:
  description: RecoverPanic indicates if panics should be recovered.
  type: boolean
  type: object
+ crdPattern:
+ description: |-
+ CRDPattern is a regular expression that matches the CRDs that the provider
+ is expected to manage.
+ type: string
  featureGates:
  additionalProperties:
  type: boolean

config/crd/bases/operator.cluster.x-k8s.io_controlplaneproviders.yaml

@@ -2956,6 +2956,11 @@ spec:
  description: RecoverPanic indicates if panics should be recovered.
  type: boolean
  type: object
+ crdPattern:
+ description: |-
+ CRDPattern is a regular expression that matches the CRDs that the provider
+ is expected to manage.
+ type: string
  featureGates:
  additionalProperties:
  type: boolean

config/crd/bases/operator.cluster.x-k8s.io_coreproviders.yaml

@@ -2954,6 +2954,11 @@ spec:
  description: RecoverPanic indicates if panics should be recovered.
  type: boolean
  type: object
+ crdPattern:
+ description: |-
+ CRDPattern is a regular expression that matches the CRDs that the provider
+ is expected to manage.
+ type: string
  featureGates:
  additionalProperties:
  type: boolean

config/crd/bases/operator.cluster.x-k8s.io_infrastructureproviders.yaml

@@ -2956,6 +2956,11 @@ spec:
  description: RecoverPanic indicates if panics should be recovered.
  type: boolean
  type: object
+ crdPattern:
+ description: |-
+ CRDPattern is a regular expression that matches the CRDs that the provider
+ is expected to manage.
+ type: string
  featureGates:
  additionalProperties:
  type: boolean

config/crd/bases/operator.cluster.x-k8s.io_ipamproviders.yaml

@@ -1369,6 +1369,11 @@ spec:
  description: RecoverPanic indicates if panics should be recovered.
  type: boolean
  type: object
+ crdPattern:
+ description: |-
+ CRDPattern is a regular expression that matches the CRDs that the provider
+ is expected to manage.
+ type: string
  featureGates:
  additionalProperties:
  type: boolean

config/crd/bases/operator.cluster.x-k8s.io_runtimeextensionproviders.yaml

@@ -1371,6 +1371,11 @@ spec:
  description: RecoverPanic indicates if panics should be recovered.
  type: boolean
  type: object
+ crdPattern:
+ description: |-
+ CRDPattern is a regular expression that matches the CRDs that the provider
+ is expected to manage.
+ type: string
  featureGates:
  additionalProperties:
  type: boolean

hack/charts/cluster-api-operator/templates/infra.yaml

@@ -56,6 +56,9 @@ spec:
  {{- end }}
 {{- end }}
 {{- end }}
+{{- if $.Values.manager.crdPattern }}
+ crdPattern: {{ $.Values.manager.crdPattern }}
+{{- end }}
 {{- end }}
 {{- if $.Values.configSecret.name }}
  configSecret:

internal/controller/component_customizer.go

@@ -73,26 +73,34 @@ func customizeObjectsFn(provider operatorv1.GenericProvider) func(objs []unstruc
  }))
  }
 
+ //nolint:nestif
  if o.GetKind() == deploymentKind {
+ d := &appsv1.Deployment{}
+ if err := scheme.Scheme.Convert(&o, d, nil); err != nil {
+ return nil, err
+ }
+
  // We need to skip the deployment customization if there are several deployments available
  // and the deployment name doesn't follow "ca*-controller-manager" pattern.
  // Currently it is applicable only for CAPZ manifests, which contain 2 deployments:
  // capz-controller-manager and azureserviceoperator-controller-manager
  // This is a temporary fix until CAPI provides a contract to distinguish provider deployments.
  // TODO: replace this check and just compare labels when CAPI provides the contract for that.
  if isMultipleDeployments && !isProviderManagerDeploymentName(o.GetName()) {
- results = append(results, o)
-
- continue
- }
-
- d := &appsv1.Deployment{}
- if err := scheme.Scheme.Convert(&o, d, nil); err != nil {
- return nil, err
- }
-
- if err := customizeDeployment(provider.GetSpec(), d); err != nil {
- return nil, err
+ // If the deployment is azureserviceoperator-controller-manager, customize the deployment
+ // to support configurable CRD Pattern. This is to enable installing additional ASO CRDs.
+ if strings.HasPrefix(o.GetName(), "azureserviceoperator") {
+ if err := customizeASODeployment(provider.GetSpec(), d); err != nil {
+ return nil, err
+ }
+ } else {
+ results = append(results, o)
+ continue
+ }
+ } else {
+ if err := customizeDeployment(provider.GetSpec(), d); err != nil {
+ return nil, err
+ }
  }
 
  if err := scheme.Scheme.Convert(d, &o, nil); err != nil {
@@ -127,6 +135,21 @@ func customizeDeployment(pSpec operatorv1.ProviderSpec, d *appsv1.Deployment) er
  return nil
 }
 
+// customizeASODeployment customize ASO provider deployment base on provider spec input.
+func customizeASODeployment(pSpec operatorv1.ProviderSpec, d *appsv1.Deployment) error {
+ // Run the customizeManagerContainer after, so it overrides anything in the deploymentSpec.
+ if pSpec.Manager != nil {
+ container := findManagerContainer(&d.Spec)
+ if container == nil {
+ return fmt.Errorf("cannot find %q container in deployment %q", managerContainerName, d.Name)
+ }
+
+ customizeASOManagerContainer(pSpec.Manager, container)
+ }
+
+ return nil
+}
+
 func customizeDeploymentSpec(pSpec operatorv1.ProviderSpec, d *appsv1.Deployment) {
  dSpec := pSpec.Deployment
 
@@ -253,6 +276,13 @@ func customizeManagerContainer(mSpec *operatorv1.ManagerSpec, c *corev1.Containe
  }
 }
 
+// customizeManagerContainer customize ASO manager container base on provider spec input.
+func customizeASOManagerContainer(mSpec *operatorv1.ManagerSpec, c *corev1.Container) {
+ if mSpec.CRDPattern != nil {
+ c.Args = setArgs(c.Args, "--crd-pattern", *mSpec.CRDPattern)
+ }
+}
+
 // customizeContainer customize provider container base on provider spec input.
 func customizeContainer(cSpec operatorv1.ContainerSpec, d *appsv1.Deployment) {
  for j, c := range d.Spec.Template.Spec.Containers {

internal/controller/component_customizer_test.go

@@ -575,6 +575,7 @@ func TestCustomizeMultipleDeployment(t *testing.T) {
  tests := []struct {
  name string
  nonManagerDeploymentName string
+ shouldCustomize bool
  }{
  {
  name: "name without suffix and prefix",
@@ -588,6 +589,11 @@ func TestCustomizeMultipleDeployment(t *testing.T) {
  name: "name with suffix",
  nonManagerDeploymentName: "non-manager-controller-manager",
  },
+ {
+ name: "name with azureserviceoperator controller-manager",
+ nonManagerDeploymentName: "azureserviceoperator-controller-manager",
+ shouldCustomize: true,
+ },
  {
  name: "empty name",
  nonManagerDeploymentName: "",
@@ -603,6 +609,17 @@ func TestCustomizeMultipleDeployment(t *testing.T) {
  },
  Spec: appsv1.DeploymentSpec{
  Replicas: ptr.To(int32(3)),
+ Template: corev1.PodTemplateSpec{
+ Spec: corev1.PodSpec{
+ Containers: []corev1.Container{
+ {
+ Name: "manager",
+ Image: "registry.k8s.io/a-manager:1.6.2",
+ Args: []string{},
+ },
+ },
+ },
+ },
  },
  }
 
@@ -629,6 +646,9 @@ func TestCustomizeMultipleDeployment(t *testing.T) {
  Deployment: &operatorv1.DeploymentSpec{
  Replicas: ptr.To(10),
  },
+ Manager: &operatorv1.ManagerSpec{
+ CRDPattern: ptr.To(".*"),
+ },
  },
  },
  }
@@ -657,8 +677,18 @@ func TestCustomizeMultipleDeployment(t *testing.T) {
  t.Errorf("expected 10 replicas, got %d", *managerDepl.Spec.Replicas)
  }
 
+ if tc.shouldCustomize {
+ // non-manager container should have been customized
+ container := findManagerContainer(&nonManagerDepl.Spec)
+ if container == nil {
+ t.Error("expected container to be found")
+ } else if container.Args != nil && container.Args[0] != "--crd-pattern=.*" {
+ t.Errorf("expected --crd-pattern=.*, got %s", container.Args[0])
+ }
+ }
+
  // non-manager deployment should not have been customized
- if *nonManagerDepl.Spec.Replicas != 3 {
+ if nonManagerDepl.Spec.Replicas != nil && *nonManagerDepl.Spec.Replicas != 3 && !tc.shouldCustomize {
  t.Errorf("expected 3 replicas, got %d", *nonManagerDepl.Spec.Replicas)
  }
  })