Keep pipecd server data even when developer shut down pipecd or kind on local computer (#6192)

* Keep local storage data by mounting to local volumes

Signed-off-by: Dan <dangduylinh.bk@gmail.com>

* add make command for remove the local volumes

Signed-off-by: Dan <dangduylinh.bk@gmail.com>

* using docker volume instead of self-creating mount folder

Signed-off-by: Dan <dangduylinh.bk@gmail.com>

* remove unneeded .pipecd-data

Signed-off-by: Dan <dangduylinh.bk@gmail.com>

---------

Signed-off-by: Dan <dangduylinh.bk@gmail.com>

Author: linhdangduy

Makefile

@@ -302,6 +302,10 @@ down/local-registry:
 .PHONY: down/local-cluster
 down/local-cluster: down/kind-cluster down/local-registry
 
+.PHONY: delete/local-volumes
+delete/local-volumes:
+	docker volume rm pipecd-data
+
 # Other commands
 
 .PHONY: setup-envtest

hack/create-kind-cluster.sh

@@ -36,11 +36,24 @@ CLUSTER=$1
 REG_NAME='kind-registry'
 REG_PORT='5001'
 
+# Create docker volume for pipecd data unless it already exists
+echo "Creating pipecd-data volume..."
+if ! docker volume ls | grep -q pipecd-data; then
+  docker volume create pipecd-data
+fi
+# Get the mount point of the pipecd-data volume
+VOLUME_MOUNT_POINT=$(docker volume inspect pipecd-data --format '{{ .Mountpoint }}')
+
 # Create a cluster with the local registry enabled in containerd
 REG_CONFIG_DIR="/etc/containerd/certs.d"
 cat <<EOF | kind create cluster --name ${CLUSTER} --config=-
 kind: Cluster
 apiVersion: kind.x-k8s.io/v1alpha4
+nodes:
+- role: control-plane
+  extraMounts:
+  - hostPath: ${VOLUME_MOUNT_POINT}
+    containerPath: /tmp/pipecd-data
 containerdConfigPatches:
 - |-
   [plugins."io.containerd.grpc.v1.cri".registry]

manifests/pipecd/templates/deployment.yaml

@@ -227,10 +227,22 @@ spec:
             - name: redis
               containerPort: 6379
               protocol: TCP
+{{- if .Values.localStorageVolumes.enabled }}
+          volumeMounts:
+            - name: redis-data
+              mountPath: /data
+{{- end }}
 {{- if .Values.cache.resources }}
           resources:
             {{- toYaml .Values.cache.resources | nindent 12 }}
 {{- end }}
+{{- if .Values.localStorageVolumes.enabled }}
+      volumes:
+        - name: redis-data
+          hostPath:
+            path: /tmp/pipecd-data/redis
+            type: DirectoryOrCreate
+{{- end }}
 
 ---
 # Single ops pod.
@@ -367,10 +379,22 @@ spec:
             - name: mysql
               containerPort: {{ .Values.mysql.port }}
               protocol: TCP
+{{- if .Values.localStorageVolumes.enabled }}
+          volumeMounts:
+            - name: mysql-data
+              mountPath: /var/lib/mysql
+{{- end }}
 {{- if .Values.mysql.resources }}
           resources:
             {{- toYaml .Values.mysql.resources | nindent 12 }}
 {{- end }}
+{{- if .Values.localStorageVolumes.enabled }}
+      volumes:
+        - name: mysql-data
+          hostPath:
+            path: /tmp/pipecd-data/mysql
+            type: DirectoryOrCreate
+{{- end }}
 
 ---
 # MinIO File Store
@@ -417,8 +441,21 @@ spec:
             - name: minio
               containerPort: {{ .Values.minio.port }}
               protocol: TCP
+{{- if .Values.localStorageVolumes.enabled }}
+          volumeMounts:
+            - name: minio-data
+              mountPath: /data
+{{- end }}
 {{- if .Values.minio.resources }}
           resources:
             {{- toYaml .Values.minio.resources | nindent 12 }}
 {{- end }}
+{{- if .Values.localStorageVolumes.enabled }}
+      volumes:
+        - name: minio-data
+          hostPath:
+            path: /tmp/pipecd-data/minio
+            type: DirectoryOrCreate
+{{- end }}
+
 {{- end }}

manifests/pipecd/values.yaml

@@ -149,6 +149,10 @@ cors:
 quickstart:
   enabled: false
 
+# Local development storage volumes
+localStorageVolumes:
+  enabled: false
+
 monitoring:
   # If true, prometheus and grafana sub-charts will be installed
   enabled: false

quickstart/control-plane-values.yaml

@@ -1,6 +1,9 @@
 quickstart:
   enabled: true
 
+localStorageVolumes:
+  enabled: true
+
 config:
   data: |
     apiVersion: "pipecd.dev/v1beta1"