fix: Remove providerName from defaultStorage config

This commit removes the `providerName` from `defaultStorage`
configuration, just requiring that the `defaultStorageClassConfigName` exists
for one of the configured providers. This commit also adds validation to
ensure that the storage class configs have unique names across
providers, current behaviour could have led to conflicts if the storage
class name was used in multiple provider configurations.

When adding the `local-path` CSI provisioner for Docker clusters, I
found that the `providerName` in default storage class config was
redundant and led to unnecessary duplication of values. Removing this
unnecessary field reduces the duplication from:

```
defaultStorage:
  providerName: local-path
  storageClassConfigName: local-path
providers:
  - name: local-path
    storageClassConfig:
      - name: local-path
    strategy: HelmAddon
```

To:

```
defaultStorageClassConfigName: local-path
providers:
  - name: local-path
    storageClassConfig:
      - name: local-path
    strategy: HelmAddon
```

While this may seem like only a small change, a single line removed, it
is always good to keep APIs as terse as possible while still retaining
strict behaviour. I think this commit achieves that.

Author: jimmidyson

api/v1alpha1/addon_types.go

@@ -109,25 +109,15 @@ type ClusterAutoscaler struct {
 	Strategy AddonStrategy `json:"strategy"`
 }
 
-type DefaultStorage struct {
-	// Name of the CSI Provider for the default storage class.
-	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:Enum=aws-ebs;nutanix;local-path
-	ProviderName string `json:"providerName"`
-
-	// Name of storage class config in any of the provider objects.
-	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:MinLength=1
-	StorageClassConfigName string `json:"storageClassConfigName"`
-}
-
 type CSI struct {
 	// +kubebuilder:validation:MinItems=1
 	// +kubebuilder:validation:Required
 	Providers []CSIProvider `json:"providers"`
 
+	// Name of the default storage class config in any of the provider objects.
 	// +kubebuilder:validation:Required
-	DefaultStorage DefaultStorage `json:"defaultStorage"`
+	// +kubebuilder:validation:MinLength=1
+	DefaultStorageClassConfigName string `json:"defaultStorageClassConfigName"`
 }
 
 type CSIProvider struct {

api/v1alpha1/crds/caren.nutanix.com_awsclusterconfigs.yaml

@@ -100,21 +100,10 @@ spec:
                       type: object
                     csi:
                       properties:
-                        defaultStorage:
-                          properties:
-                            providerName:
-                              description: Name of the CSI Provider for the default storage class.
-                              enum:
-                                - aws-ebs
-                              type: string
-                            storageClassConfigName:
-                              description: Name of storage class config in any of the provider objects.
-                              minLength: 1
-                              type: string
-                          required:
-                            - providerName
-                            - storageClassConfigName
-                          type: object
+                        defaultStorageClassConfigName:
+                          description: Name of the default storage class config in any of the provider objects.
+                          minLength: 1
+                          type: string
                         providers:
                           items:
                             properties:
@@ -190,7 +179,7 @@ spec:
                           minItems: 1
                           type: array
                       required:
-                        - defaultStorage
+                        - defaultStorageClassConfigName
                         - providers
                       type: object
                     nfd:

api/v1alpha1/crds/caren.nutanix.com_dockerclusterconfigs.yaml

@@ -100,21 +100,10 @@ spec:
                       type: object
                     csi:
                       properties:
-                        defaultStorage:
-                          properties:
-                            providerName:
-                              description: Name of the CSI Provider for the default storage class.
-                              enum:
-                                - local-path
-                              type: string
-                            storageClassConfigName:
-                              description: Name of storage class config in any of the provider objects.
-                              minLength: 1
-                              type: string
-                          required:
-                            - providerName
-                            - storageClassConfigName
-                          type: object
+                        defaultStorageClassConfigName:
+                          description: Name of the default storage class config in any of the provider objects.
+                          minLength: 1
+                          type: string
                         providers:
                           items:
                             properties:
@@ -190,7 +179,7 @@ spec:
                           minItems: 1
                           type: array
                       required:
-                        - defaultStorage
+                        - defaultStorageClassConfigName
                         - providers
                       type: object
                     nfd:

api/v1alpha1/crds/caren.nutanix.com_genericclusterconfigs.yaml

@@ -114,25 +114,11 @@ spec:
                     type: object
                   csi:
                     properties:
-                      defaultStorage:
-                        properties:
-                          providerName:
-                            description: Name of the CSI Provider for the default
-                              storage class.
-                            enum:
-                            - aws-ebs
-                            - nutanix
-                            - local-path
-                            type: string
-                          storageClassConfigName:
-                            description: Name of storage class config in any of the
-                              provider objects.
-                            minLength: 1
-                            type: string
-                        required:
-                        - providerName
-                        - storageClassConfigName
-                        type: object
+                      defaultStorageClassConfigName:
+                        description: Name of the default storage class config in any
+                          of the provider objects.
+                        minLength: 1
+                        type: string
                       providers:
                         items:
                           properties:
@@ -219,7 +205,7 @@ spec:
                         minItems: 1
                         type: array
                     required:
-                    - defaultStorage
+                    - defaultStorageClassConfigName
                     - providers
                     type: object
                   nfd:

api/v1alpha1/crds/caren.nutanix.com_nutanixclusterconfigs.yaml

@@ -100,21 +100,10 @@ spec:
                       type: object
                     csi:
                       properties:
-                        defaultStorage:
-                          properties:
-                            providerName:
-                              description: Name of the CSI Provider for the default storage class.
-                              enum:
-                                - nutanix
-                              type: string
-                            storageClassConfigName:
-                              description: Name of storage class config in any of the provider objects.
-                              minLength: 1
-                              type: string
-                          required:
-                            - providerName
-                            - storageClassConfigName
-                          type: object
+                        defaultStorageClassConfigName:
+                          description: Name of the default storage class config in any of the provider objects.
+                          minLength: 1
+                          type: string
                         providers:
                           items:
                             properties:
@@ -190,7 +179,7 @@ spec:
                           minItems: 1
                           type: array
                       required:
-                        - defaultStorage
+                        - defaultStorageClassConfigName
                         - providers
                       type: object
                     nfd:

api/v1alpha1/zz_generated.deepcopy.go

@@ -28,9 +28,7 @@ spec:
             provider: Calico
             strategy: ClusterResourceSet
           csi:
-            defaultStorage:
-              providerName: aws-ebs
-              storageClassConfigName: aws-ebs
+            defaultStorageClassConfigName: aws-ebs
             providers:
             - name: aws-ebs
               storageClassConfig:

examples/capi-quick-start/aws-cluster-calico-crs.yaml

@@ -28,9 +28,7 @@ spec:
             provider: Calico
             strategy: HelmAddon
           csi:
-            defaultStorage:
-              providerName: aws-ebs
-              storageClassConfigName: aws-ebs
+            defaultStorageClassConfigName: aws-ebs
             providers:
             - name: aws-ebs
               storageClassConfig:

examples/capi-quick-start/aws-cluster-calico-helm-addon.yaml

@@ -28,9 +28,7 @@ spec:
             provider: Cilium
             strategy: ClusterResourceSet
           csi:
-            defaultStorage:
-              providerName: aws-ebs
-              storageClassConfigName: aws-ebs
+            defaultStorageClassConfigName: aws-ebs
             providers:
             - name: aws-ebs
               storageClassConfig:

examples/capi-quick-start/aws-cluster-cilium-crs.yaml

@@ -28,9 +28,7 @@ spec:
             provider: Cilium
             strategy: HelmAddon
           csi:
-            defaultStorage:
-              providerName: aws-ebs
-              storageClassConfigName: aws-ebs
+            defaultStorageClassConfigName: aws-ebs
             providers:
             - name: aws-ebs
               storageClassConfig:

examples/capi-quick-start/aws-cluster-cilium-helm-addon.yaml

@@ -28,9 +28,7 @@ spec:
             provider: Calico
             strategy: ClusterResourceSet
           csi:
-            defaultStorage:
-              providerName: local-path
-              storageClassConfigName: local-path
+            defaultStorageClassConfigName: local-path
             providers:
             - name: local-path
               storageClassConfig:

examples/capi-quick-start/docker-cluster-calico-crs.yaml

@@ -28,9 +28,7 @@ spec:
             provider: Calico
             strategy: HelmAddon
           csi:
-            defaultStorage:
-              providerName: local-path
-              storageClassConfigName: local-path
+            defaultStorageClassConfigName: local-path
             providers:
             - name: local-path
               storageClassConfig:

examples/capi-quick-start/docker-cluster-calico-helm-addon.yaml

@@ -28,9 +28,7 @@ spec:
             provider: Cilium
             strategy: ClusterResourceSet
           csi:
-            defaultStorage:
-              providerName: local-path
-              storageClassConfigName: local-path
+            defaultStorageClassConfigName: local-path
             providers:
             - name: local-path
               storageClassConfig:

examples/capi-quick-start/docker-cluster-cilium-crs.yaml

@@ -28,9 +28,7 @@ spec:
             provider: Cilium
             strategy: HelmAddon
           csi:
-            defaultStorage:
-              providerName: local-path
-              storageClassConfigName: local-path
+            defaultStorageClassConfigName: local-path
             providers:
             - name: local-path
               storageClassConfig:

examples/capi-quick-start/docker-cluster-cilium-helm-addon.yaml

@@ -73,9 +73,7 @@ spec:
             provider: Calico
             strategy: ClusterResourceSet
           csi:
-            defaultStorage:
-              providerName: nutanix
-              storageClassConfigName: nutanix-volume
+            defaultStorageClassConfigName: nutanix-volume
             providers:
             - credentials:
                 secretRef:

examples/capi-quick-start/nutanix-cluster-calico-crs.yaml

@@ -73,9 +73,7 @@ spec:
             provider: Calico
             strategy: HelmAddon
           csi:
-            defaultStorage:
-              providerName: nutanix
-              storageClassConfigName: nutanix-volume
+            defaultStorageClassConfigName: nutanix-volume
             providers:
             - credentials:
                 secretRef:

examples/capi-quick-start/nutanix-cluster-calico-helm-addon.yaml

@@ -73,9 +73,7 @@ spec:
             provider: Cilium
             strategy: ClusterResourceSet
           csi:
-            defaultStorage:
-              providerName: nutanix
-              storageClassConfigName: nutanix-volume
+            defaultStorageClassConfigName: nutanix-volume
             providers:
             - credentials:
                 secretRef:

examples/capi-quick-start/nutanix-cluster-cilium-crs.yaml

@@ -73,9 +73,7 @@ spec:
             provider: Cilium
             strategy: HelmAddon
           csi:
-            defaultStorage:
-              providerName: nutanix
-              storageClassConfigName: nutanix-volume
+            defaultStorageClassConfigName: nutanix-volume
             providers:
             - credentials:
                 secretRef:

examples/capi-quick-start/nutanix-cluster-cilium-helm-addon.yaml

@@ -4,9 +4,7 @@
 - op: "add"
   path: "/spec/topology/variables/0/value/addons/csi"
   value:
-    defaultStorage:
-      providerName: aws-ebs
-      storageClassConfigName: aws-ebs
+    defaultStorageClassConfigName: aws-ebs
     providers:
       - name: aws-ebs
         storageClassConfig:

hack/examples/patches/aws/csi.yaml

@@ -4,9 +4,7 @@
 - op: "add"
   path: "/spec/topology/variables/0/value/addons/csi"
   value:
-    defaultStorage:
-      providerName: local-path
-      storageClassConfigName: local-path
+    defaultStorageClassConfigName: local-path
     providers:
       - name: local-path
         storageClassConfig:

hack/examples/patches/docker/csi.yaml

@@ -4,9 +4,7 @@
 - op: "add"
   path: "/spec/topology/variables/0/value/addons/csi"
   value:
-    defaultStorage:
-      providerName: nutanix
-      storageClassConfigName: nutanix-volume
+    defaultStorageClassConfigName: nutanix-volume
     providers:
       - name: nutanix
         storageClassConfig:

hack/examples/patches/nutanix/csi.yaml

@@ -24,13 +24,6 @@ export KUBE_VIP_VERSION := v0.8.0
 
 export METALLB_CHART_VERSION := v0.14.5
 
-# Below are the lists of CSI Providers allowed for a specific infrastructure.
-# - When we support a new infrastructure, we need to a create a new list using the same convention.
-# - When we support a new CSI Provider, we need to add it to one or more of these lists
-CSI_PROVIDERS_aws := ["aws-ebs"]
-CSI_PROVIDERS_nutanix := ["nutanix"]
-CSI_PROVIDERS_docker := ["local-path"]
-
 .PHONY: addons.sync
 addons.sync: $(addprefix update-addon.,calico cilium nfd cluster-autoscaler aws-ebs-csi aws-ccm.127 aws-ccm.128 aws-ccm.129 kube-vip)
 
@@ -64,7 +57,8 @@ update-addon.kube-vip: ; $(info $(M) updating kube-vip manifests)
 
 .PHONY: generate-helm-configmap
 generate-helm-configmap:
-	go run hack/tools/helm-cm/main.go -kustomize-directory="./hack/addons/kustomize" -output-file="./charts/cluster-api-runtime-extensions-nutanix/templates/helm-config.yaml"
+	go run hack/tools/helm-cm/main.go -kustomize-directory="./hack/addons/kustomize" \
+	  -output-file="./charts/cluster-api-runtime-extensions-nutanix/templates/helm-config.yaml"
 	./hack/addons/add-warning-helm-configmap.sh
 
 # Set only the supported CSI providers for each provider.