Merge pull request #79 from srl-labs/feat/implement-clab-dir-persistence

Feat/implement clab dir persistence

apis/topology/v1alpha1/common.go

@@ -53,11 +53,15 @@ type Persistence struct {
 	// a mounted PVC.
 	Enabled bool `json:"enabled"`
 	// ClaimSize is the size of the PVC for this topology -- if not provided this defaults to 5Gi.
-	// If provided, the string value must be a valid kubernetes storage requests style string.
+	// If provided, the string value must be a valid kubernetes storage requests style string. Note
+	// the claim size *cannot be made smaller* once created, but it *can* be expanded. If you need
+	// to make the claim smaller you must delete the topology (or the node from the topology) and
+	// re-add it.
 	// +optional
 	ClaimSize string `json:"claimSize"`
 	// StorageClassName is the storage class to set in the PVC -- if not provided this will be left
-	// empty which will end up using your default storage class.
+	// empty which will end up using your default storage class. Note that currently we assume you
+	// have (as default) or provide a dynamically provisionable storage class, hence no selector.
 	// +optional
 	StorageClassName string `json:"storageClassName"`
 }

assets/crd/topology.clabernetes_containerlabs.yaml

@@ -182,6 +182,10 @@ spec:
                     description: ClaimSize is the size of the PVC for this topology
                       -- if not provided this defaults to 5Gi. If provided, the string
                       value must be a valid kubernetes storage requests style string.
+                      Note the claim size *cannot be made smaller* once created, but
+                      it *can* be expanded. If you need to make the claim smaller
+                      you must delete the topology (or the node from the topology)
+                      and re-add it.
                     type: string
                   enabled:
                     description: Enabled indicates if persistence of hte containerlab
@@ -190,7 +194,9 @@ spec:
                   storageClassName:
                     description: StorageClassName is the storage class to set in the
                       PVC -- if not provided this will be left empty which will end
-                      up using your default storage class.
+                      up using your default storage class. Note that currently we
+                      assume you have (as default) or provide a dynamically provisionable
+                      storage class, hence no selector.
                     type: string
                 required:
                 - enabled

assets/crd/topology.clabernetes_knes.yaml

@@ -178,6 +178,10 @@ spec:
                     description: ClaimSize is the size of the PVC for this topology
                       -- if not provided this defaults to 5Gi. If provided, the string
                       value must be a valid kubernetes storage requests style string.
+                      Note the claim size *cannot be made smaller* once created, but
+                      it *can* be expanded. If you need to make the claim smaller
+                      you must delete the topology (or the node from the topology)
+                      and re-add it.
                     type: string
                   enabled:
                     description: Enabled indicates if persistence of hte containerlab
@@ -186,7 +190,9 @@ spec:
                   storageClassName:
                     description: StorageClassName is the storage class to set in the
                       PVC -- if not provided this will be left empty which will end
-                      up using your default storage class.
+                      up using your default storage class. Note that currently we
+                      assume you have (as default) or provide a dynamically provisionable
+                      storage class, hence no selector.
                     type: string
                 required:
                 - enabled

charts/clabernetes/crds/topology.clabernetes_containerlabs.yaml

@@ -182,6 +182,10 @@ spec:
                     description: ClaimSize is the size of the PVC for this topology
                       -- if not provided this defaults to 5Gi. If provided, the string
                       value must be a valid kubernetes storage requests style string.
+                      Note the claim size *cannot be made smaller* once created, but
+                      it *can* be expanded. If you need to make the claim smaller
+                      you must delete the topology (or the node from the topology)
+                      and re-add it.
                     type: string
                   enabled:
                     description: Enabled indicates if persistence of hte containerlab
@@ -190,7 +194,9 @@ spec:
                   storageClassName:
                     description: StorageClassName is the storage class to set in the
                       PVC -- if not provided this will be left empty which will end
-                      up using your default storage class.
+                      up using your default storage class. Note that currently we
+                      assume you have (as default) or provide a dynamically provisionable
+                      storage class, hence no selector.
                     type: string
                 required:
                 - enabled

charts/clabernetes/crds/topology.clabernetes_knes.yaml

@@ -178,6 +178,10 @@ spec:
                     description: ClaimSize is the size of the PVC for this topology
                       -- if not provided this defaults to 5Gi. If provided, the string
                       value must be a valid kubernetes storage requests style string.
+                      Note the claim size *cannot be made smaller* once created, but
+                      it *can* be expanded. If you need to make the claim smaller
+                      you must delete the topology (or the node from the topology)
+                      and re-add it.
                     type: string
                   enabled:
                     description: Enabled indicates if persistence of hte containerlab
@@ -186,7 +190,9 @@ spec:
                   storageClassName:
                     description: StorageClassName is the storage class to set in the
                       PVC -- if not provided this will be left empty which will end
-                      up using your default storage class.
+                      up using your default storage class. Note that currently we
+                      assume you have (as default) or provide a dynamically provisionable
+                      storage class, hence no selector.
                     type: string
                 required:
                 - enabled

charts/clabernetes/templates/clusterrole.yaml

@@ -45,6 +45,7 @@ rules:
       - configmaps
       - services
       - pods
+      - persistentvolumeclaims
     verbs:
       - get
       - list

charts/clabernetes/tests/clicker/test-fixtures/golden/clusterrole.yaml

@@ -44,6 +44,7 @@ rules:
       - configmaps
       - services
       - pods
+      - persistentvolumeclaims
     verbs:
       - get
       - list

charts/clabernetes/tests/default_vaules/test-fixtures/golden/clusterrole.yaml

@@ -39,6 +39,7 @@ rules:
       - configmaps
       - services
       - pods
+      - persistentvolumeclaims
     verbs:
       - get
       - list

constants/kubernetes.go

@@ -7,6 +7,9 @@ const (
 	// KubernetesService is a const to use for "service".
 	KubernetesService = "service"
 
+	// KubernetesPVC is a const to use for "persistentvolumeclaim".
+	KubernetesPVC = "persistentvolumeclaim"
+
 	// KubernetesDeployment is a const to use for "deployment".
 	KubernetesDeployment = "deployment"
 

controllers/topology/containerlab/reconcile.go

@@ -85,6 +85,18 @@ func (c *Controller) Reconcile(
 		reconcileData,
 	)
 	if err != nil {
+		// error already logged
+		return ctrlruntime.Result{}, err
+	}
+
+	err = c.TopologyReconciler.ReconcilePersistentVolumeClaim(
+		ctx,
+		containerlab,
+		reconcileData,
+	)
+	if err != nil {
+		c.BaseController.Log.Criticalf("failed reconciling clabernetes pvcs, error: %s", err)
+
 		return ctrlruntime.Result{}, err
 	}
 

controllers/topology/kne/reconcile.go

@@ -86,6 +86,17 @@ func (c *Controller) Reconcile(
 		return ctrlruntime.Result{}, err
 	}
 
+	err = c.TopologyReconciler.ReconcilePersistentVolumeClaim(
+		ctx,
+		kne,
+		reconcileData,
+	)
+	if err != nil {
+		c.BaseController.Log.Criticalf("failed reconciling clabernetes pvcs, error: %s", err)
+
+		return ctrlruntime.Result{}, err
+	}
+
 	err = c.TopologyReconciler.ReconcileDeployments(
 		ctx,
 		kne,

controllers/topology/reconciler/deployment.go

@@ -646,6 +646,41 @@ func (r *DeploymentReconciler) renderDeploymentDevices(
 	)
 }
 
+func (r *DeploymentReconciler) renderDeploymentPersistence(
+	deployment *k8sappsv1.Deployment,
+	nodeName,
+	owningTopologyName string,
+	owningTopologyCommonSpec *clabernetesapistopologyv1alpha1.TopologyCommonSpec,
+) {
+	if !owningTopologyCommonSpec.Persistence.Enabled {
+		return
+	}
+
+	volumeName := "containerlab-directory-persistence"
+
+	deployment.Spec.Template.Spec.Volumes = append(
+		deployment.Spec.Template.Spec.Volumes,
+		k8scorev1.Volume{
+			Name: volumeName,
+			VolumeSource: k8scorev1.VolumeSource{
+				PersistentVolumeClaim: &k8scorev1.PersistentVolumeClaimVolumeSource{
+					ClaimName: fmt.Sprintf("%s-%s", owningTopologyName, nodeName),
+					ReadOnly:  false,
+				},
+			},
+		},
+	)
+
+	deployment.Spec.Template.Spec.Containers[0].VolumeMounts = append(
+		deployment.Spec.Template.Spec.Containers[0].VolumeMounts,
+		k8scorev1.VolumeMount{
+			Name:      volumeName,
+			ReadOnly:  false,
+			MountPath: fmt.Sprintf("/clabernetes/clab-clabernetes-%s", nodeName),
+		},
+	)
+}
+
 // Render accepts the owning topology a mapping of clabernetes sub-topology configs and a node name
 // and renders the final deployment for this node.
 func (r *DeploymentReconciler) Render(
@@ -707,6 +742,13 @@ func (r *DeploymentReconciler) Render(
 		&owningTopologyCommonSpec,
 	)
 
+	r.renderDeploymentPersistence(
+		deployment,
+		nodeName,
+		owningTopologyName,
+		&owningTopologyCommonSpec,
+	)
+
 	return deployment
 }