feat: Add local-path-provisioner CSI (#693)

jimmidyson · web-flow · commit 9b1badac6eeb · 2024-05-31T16:46:27.000+01:00
This enables easy testing with Docker clusters as well, but this should
not be used in production.
diff --git a/api/v1alpha1/addon_types.go b/api/v1alpha1/addon_types.go
@@ -19,8 +19,9 @@ const (
 	CNIProviderCalico = "Calico"
 	CNIProviderCilium = "Cilium"
 
-	CSIProviderAWSEBS  = "aws-ebs"
-	CSIProviderNutanix = "nutanix"
+	CSIProviderAWSEBS    = "aws-ebs"
+	CSIProviderNutanix   = "nutanix"
+	CSIProviderLocalPath = "local-path"
 
 	VirtualIPProviderKubeVIP = "KubeVIP"
 
@@ -45,8 +46,9 @@ const (
 type StorageProvisioner string
 
 const (
-	AWSEBSProvisioner  StorageProvisioner = "ebs.csi.aws.com"
-	NutanixProvisioner StorageProvisioner = "csi.nutanix.com"
+	AWSEBSProvisioner    StorageProvisioner = "ebs.csi.aws.com"
+	NutanixProvisioner   StorageProvisioner = "csi.nutanix.com"
+	LocalPathProvisioner StorageProvisioner = "rancher.io/local-path"
 )
 
 // FIXME: Remove the CCM providers from the API. Users do not provider this
@@ -110,7 +112,7 @@ type ClusterAutoscaler struct {
 type DefaultStorage struct {
 	// Name of the CSI Provider for the default storage class.
 	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:Enum=aws-ebs;nutanix
+	// +kubebuilder:validation:Enum=aws-ebs;nutanix;local-path
 	ProviderName string `json:"providerName"`
 
 	// Name of storage class config in any of the provider objects.
@@ -131,7 +133,7 @@ type CSI struct {
 type CSIProvider struct {
 	// Name of the CSI Provider.
 	// +kubebuilder:validation:Required
-	// +kubebuilder:validation:Enum=aws-ebs;nutanix
+	// +kubebuilder:validation:Enum=aws-ebs;nutanix;local-path
 	Name string `json:"name"`
 
 	// StorageClassConfig is a list of storage class configurations for this CSI provider.
diff --git a/api/v1alpha1/crds/caren.nutanix.com_awsclusterconfigs.yaml b/api/v1alpha1/crds/caren.nutanix.com_awsclusterconfigs.yaml
@@ -113,6 +113,7 @@ spec:
                             enum:
                             - aws-ebs
                             - nutanix
+                            - local-path
                             type: string
                           storageClassConfigName:
                             description: Name of storage class config in any of the
@@ -151,6 +152,7 @@ spec:
                               enum:
                               - aws-ebs
                               - nutanix
+                              - local-path
                               type: string
                             storageClassConfig:
                               description: StorageClassConfig is a list of storage
diff --git a/api/v1alpha1/crds/caren.nutanix.com_dockerclusterconfigs.yaml b/api/v1alpha1/crds/caren.nutanix.com_dockerclusterconfigs.yaml
@@ -114,6 +114,7 @@ spec:
                             enum:
                             - aws-ebs
                             - nutanix
+                            - local-path
                             type: string
                           storageClassConfigName:
                             description: Name of storage class config in any of the
@@ -152,6 +153,7 @@ spec:
                               enum:
                               - aws-ebs
                               - nutanix
+                              - local-path
                               type: string
                             storageClassConfig:
                               description: StorageClassConfig is a list of storage
diff --git a/api/v1alpha1/crds/caren.nutanix.com_genericclusterconfigs.yaml b/api/v1alpha1/crds/caren.nutanix.com_genericclusterconfigs.yaml
@@ -122,6 +122,7 @@ spec:
                             enum:
                             - aws-ebs
                             - nutanix
+                            - local-path
                             type: string
                           storageClassConfigName:
                             description: Name of storage class config in any of the
@@ -160,6 +161,7 @@ spec:
                               enum:
                               - aws-ebs
                               - nutanix
+                              - local-path
                               type: string
                             storageClassConfig:
                               description: StorageClassConfig is a list of storage
diff --git a/api/v1alpha1/crds/caren.nutanix.com_nutanixclusterconfigs.yaml b/api/v1alpha1/crds/caren.nutanix.com_nutanixclusterconfigs.yaml
@@ -114,6 +114,7 @@ spec:
                             enum:
                             - aws-ebs
                             - nutanix
+                            - local-path
                             type: string
                           storageClassConfigName:
                             description: Name of storage class config in any of the
@@ -152,6 +153,7 @@ spec:
                               enum:
                               - aws-ebs
                               - nutanix
+                              - local-path
                               type: string
                             storageClassConfig:
                               description: StorageClassConfig is a list of storage
diff --git a/charts/cluster-api-runtime-extensions-nutanix/templates/helm-config.yaml b/charts/cluster-api-runtime-extensions-nutanix/templates/helm-config.yaml
@@ -15,6 +15,10 @@ data:
     ChartName: cluster-autoscaler
     ChartVersion: 9.37.0
     RepositoryURL: https://kubernetes.github.io/autoscaler
+  local-path-provisioner-csi: |
+    ChartName: local-path-provisioner
+    ChartVersion: v0.0.29
+    RepositoryURL: https://charts.containeroo.ch
   metallb: |
     ChartName: metallb
     ChartVersion: v0.14.5
diff --git a/examples/capi-quick-start/docker-cluster-calico-crs.yaml b/examples/capi-quick-start/docker-cluster-calico-crs.yaml
@@ -27,6 +27,15 @@ spec:
           cni:
             provider: Calico
             strategy: ClusterResourceSet
+          csi:
+            defaultStorage:
+              providerName: local-path
+              storageClassConfigName: local-path
+            providers:
+            - name: local-path
+              storageClassConfig:
+              - name: local-path
+              strategy: HelmAddon
           nfd:
             strategy: ClusterResourceSet
         encryptionAtRest:
diff --git a/examples/capi-quick-start/docker-cluster-calico-helm-addon.yaml b/examples/capi-quick-start/docker-cluster-calico-helm-addon.yaml
@@ -27,6 +27,15 @@ spec:
           cni:
             provider: Calico
             strategy: HelmAddon
+          csi:
+            defaultStorage:
+              providerName: local-path
+              storageClassConfigName: local-path
+            providers:
+            - name: local-path
+              storageClassConfig:
+              - name: local-path
+              strategy: HelmAddon
           nfd:
             strategy: HelmAddon
         encryptionAtRest:
diff --git a/examples/capi-quick-start/docker-cluster-cilium-crs.yaml b/examples/capi-quick-start/docker-cluster-cilium-crs.yaml
@@ -27,6 +27,15 @@ spec:
           cni:
             provider: Cilium
             strategy: ClusterResourceSet
+          csi:
+            defaultStorage:
+              providerName: local-path
+              storageClassConfigName: local-path
+            providers:
+            - name: local-path
+              storageClassConfig:
+              - name: local-path
+              strategy: HelmAddon
           nfd:
             strategy: ClusterResourceSet
         encryptionAtRest:
diff --git a/examples/capi-quick-start/docker-cluster-cilium-helm-addon.yaml b/examples/capi-quick-start/docker-cluster-cilium-helm-addon.yaml
@@ -27,6 +27,15 @@ spec:
           cni:
             provider: Cilium
             strategy: HelmAddon
+          csi:
+            defaultStorage:
+              providerName: local-path
+              storageClassConfigName: local-path
+            providers:
+            - name: local-path
+              storageClassConfig:
+              - name: local-path
+              strategy: HelmAddon
           nfd:
             strategy: HelmAddon
         encryptionAtRest:
diff --git a/hack/addons/kustomize/local-path-provisioner-csi/kustomization.yaml.tmpl b/hack/addons/kustomize/local-path-provisioner-csi/kustomization.yaml.tmpl
@@ -0,0 +1,19 @@
+# Copyright 2023 Nutanix. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+apiVersion: kustomize.config.k8s.io/v1beta1
+kind: Kustomization
+
+metadata:
+  name: local-path-provisioner
+
+namespace: kube-system
+
+helmCharts:
+- name: local-path-provisioner
+  repo: https://charts.containeroo.ch
+  releaseName: local-path-provisioner
+  version: ${LOCAL_PATH_CSI_CHART_VERSION}
+  includeCRDs: true
+  skipTests: true
+  namespace: kube-system
diff --git a/hack/examples/bases/docker/cluster/kustomization.yaml.tmpl b/hack/examples/bases/docker/cluster/kustomization.yaml.tmpl
@@ -35,6 +35,9 @@ patches:
 - target:
     kind: Cluster
   path: ../../../patches/cluster-autoscaler.yaml
+- target:
+    kind: Cluster
+  path: ../../../patches/docker/csi.yaml
 - target:
     kind: Cluster
   path: ../../../patches/encryption.yaml
diff --git a/hack/examples/patches/docker/csi.yaml b/hack/examples/patches/docker/csi.yaml
@@ -0,0 +1,14 @@
+# Copyright 2024 Nutanix. All rights reserved.
+# SPDX-License-Identifier: Apache-2.0
+
+- op: "add"
+  path: "/spec/topology/variables/0/value/addons/csi"
+  value:
+    defaultStorage:
+      providerName: local-path
+      storageClassConfigName: local-path
+    providers:
+      - name: local-path
+        storageClassConfig:
+        - name: local-path
+        strategy: HelmAddon
diff --git a/make/addons.mk b/make/addons.mk
@@ -9,6 +9,7 @@ export AWS_CSI_SNAPSHOT_CONTROLLER_VERSION := v6.3.3
 export AWS_EBS_CSI_CHART_VERSION := v2.28.1
 export NUTANIX_STORAGE_CSI_CHART_VERSION := v3.0.0-beta.1912
 export NUTANIX_SNAPSHOT_CSI_CHART_VERSION := v6.3.2
+export LOCAL_PATH_CSI_CHART_VERSION := v0.0.29
 # a map of AWS CCM versions
 export AWS_CCM_VERSION_127 := v1.27.1
 export AWS_CCM_CHART_VERSION_127 := 0.0.8
diff --git a/pkg/handlers/generic/lifecycle/config/cm.go b/pkg/handlers/generic/lifecycle/config/cm.go
@@ -17,14 +17,15 @@ import (
 type Component string
 
 const (
-	Autoscaler         Component = "cluster-autoscaler"
-	Tigera             Component = "tigera-operator"
-	Cilium             Component = "cilium"
-	NFD                Component = "nfd"
-	NutanixStorageCSI  Component = "nutanix-storage-csi"
-	NutanixSnapshotCSI Component = "nutanix-snapshot-csi"
-	NutanixCCM         Component = "nutanix-ccm"
-	MetalLB            Component = "metallb"
+	Autoscaler              Component = "cluster-autoscaler"
+	Tigera                  Component = "tigera-operator"
+	Cilium                  Component = "cilium"
+	NFD                     Component = "nfd"
+	NutanixStorageCSI       Component = "nutanix-storage-csi"
+	NutanixSnapshotCSI      Component = "nutanix-snapshot-csi"
+	NutanixCCM              Component = "nutanix-ccm"
+	MetalLB                 Component = "metallb"
+	LocalPathProvisionerCSI Component = "local-path-provisioner-csi"
 )
 
 type HelmChartGetter struct {
diff --git a/pkg/handlers/generic/lifecycle/csi/handler.go b/pkg/handlers/generic/lifecycle/csi/handler.go
@@ -79,7 +79,7 @@ func (c *CSIHandler) AfterControlPlaneInitialized(
 		c.variablePath...)
 	if err != nil {
 		if variables.IsNotFoundError(err) {
-			log.Info("Skipping CSI handler, the cluster does not define the CSI variable")
+			log.V(5).Info("Skipping CSI handler, the cluster does not define the CSI variable")
 			return
 		}
 		msg := "failed to read the CSI variable from the cluster"
diff --git a/pkg/handlers/generic/lifecycle/csi/localpath/handler.go b/pkg/handlers/generic/lifecycle/csi/localpath/handler.go
diff --git a/pkg/handlers/generic/lifecycle/handlers.go b/pkg/handlers/generic/lifecycle/handlers.go
