Merge pull request #1964 from shoce/hostPath

feat: add persistence.hostPath to Helm chart

chart/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: versitygw
 description: A Helm chart for deploying the Versity S3 Gateway on Kubernetes
 type: application
-version: 0.3.0
+version: 0.3.1
 sources:
   - https://github.com/versity/versitygw
 icon: https://raw.githubusercontent.com/versity/versitygw/main/webui/web/assets/images/Versity-logo-blue-horizontal.png

chart/README.md

@@ -84,12 +84,16 @@ The `gateway.backend.type` value selects the storage backend. Use `gateway.backe
 | **Admin API** | `admin.enabled=true` — exposes a separate management API on `admin.port` (default `7071`) |
 | **WebUI** | `webui.enabled=true` — browser-based management UI on `webui.port` (default `8080`); set `webui.apiGateways` and `webui.adminGateways` to your externally reachable endpoints |
 | **IAM** | `iam.enabled=true` — flat-file identity and access management stored alongside backend data |
-| **Persistence** | `persistence.enabled=true` — provisions a PVC for backend data and IAM storage; defaults to `10Gi` |
+| **Persistence** | `persistence.enabled=true` — provisions a PVC for backend data and IAM storage; defaults to `10Gi`, or uses a hostPath volume specified by `persistence.hostPath` |
 | **NetworkPolicy** | `networkPolicy.enabled=true` — restricts ingress to selected pods/namespaces; allows all egress |
 
 ## Scaling and Persistence
 
-By default, this chart enables persistence via a `PersistentVolumeClaim` (PVC) to ensure data consistency and prevent data loss.
+By default, this chart enables persistence via a `PersistentVolumeClaim` (PVC) to ensure data consistency and prevent data loss. 
+
+Alternatively, you may use [hostPath volume](https://kubernetes.io/docs/concepts/storage/volumes/#hostpath) by setting the `persistence.hostPath` value.
+As a general rule, this setup should only be used if all nodes in the cluster have access to the same data (e.g. NFS share is mounted on all nodes) or for single-node use cases.
+Special care must be taken particularly when using multiple replicas with such a setup, since Versity does not perform internal data replication ("clustering").
 
 ### Horizontal Scaling (replicas > 1)
 

chart/templates/deployment.yaml

@@ -4,8 +4,14 @@
     {{- fail "Multiple replicas with POSIX backend or Internal IAM require persistence.enabled=true to prevent data loss and inconsistency across pods. If using a stateless backend (e.g. S3, Azure) and external IAM, set persistence.enabled=false." }}
   {{- end }}
 {{- end }}
-{{- if and .Values.persistence.enabled (not .Values.persistence.create) (not .Values.persistence.claimName) }}
-  {{- fail "persistence.claimName is required when persistence.create is false" }}
+{{- if and .Values.persistence.enabled (not .Values.persistence.create) (not .Values.persistence.claimName) (not .Values.persistence.hostPath) }}
+  {{- fail "persistence.claimName or persistence.hostPath is required when persistence.create is false" }}
+{{- end }}
+{{- if and .Values.persistence.claimName .Values.persistence.hostPath }}
+  {{- fail "only persistence.claimName or persistence.hostPath can be set" }}
+{{- end }}
+{{- if and .Values.persistence.create .Values.persistence.hostPath }}
+  {{- fail "persistence.create must be false for persistence.hostPath can be set" }}
 {{- end }}
 apiVersion: apps/v1
 kind: Deployment
@@ -195,8 +201,14 @@ spec:
       volumes:
         - name: data
           {{- if .Values.persistence.enabled }}
+          {{- if .Values.persistence.hostPath }}
+          hostPath:
+            path: {{ .Values.persistence.hostPath }}
+            type: DirectoryOrCreate
+          {{- else }}
           persistentVolumeClaim:
             claimName: {{ include "versitygw.pvcName" . }}
+          {{- end }}
           {{- else }}
           emptyDir: {}
           {{- end }}

chart/values.yaml

@@ -288,6 +288,8 @@ persistence:
   claimName: ""
   size: 10Gi
   storageClassName: ""
+  # If set then use a hostPath volume, needs `persistence.create=false`
+  hostPath: ""
   # Access mode for the PVC. Use ReadWriteMany for multi-replica deployments.
   accessMode: ReadWriteOnce