Enable configurable media source paths in Shoebox.

Introduced a toggle (`config.mediaSourcePaths.enabled`) to enable or disable media source paths and updated relevant templates and manifests for conditional rendering. Improved PVC and StatefulSet configurations to handle media sources dynamically, enhancing flexibility in defining storage options.

Author: devclef

.github/workflows/helm-release.yml

@@ -58,7 +58,7 @@ jobs:
           wait: 120s
 
       - name: Run chart-testing (install)
-        run: ct install --target-branch ${{ github.event.repository.default_branch }} --charts charts/shoebox --helm-extra-set-args "--set persistence.data.enabled=false --set persistence.thumbnails.enabled=false --set persistence.exports.enabled=false --set persistence.media.enabled=false"
+        run: ct install --target-branch ${{ github.event.repository.default_branch }} --charts charts/shoebox --helm-extra-set-args "--set persistence.data.enabled=false --set persistence.thumbnails.enabled=false --set persistence.exports.enabled=false --set config.mediaSourcePaths.enabled=false"
 
   release:
     needs: lint-test
@@ -92,4 +92,3 @@ jobs:
           pages_branch: main
         env:
           CR_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
-

charts/shoebox/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 name: shoebox
 description: A Helm chart for the Shoebox application - a digital shoebox for your videos
 type: application
-version: 0.0.15
+version: 0.0.16
 appVersion: "main"
 keywords:
   - video

charts/shoebox/README.md

@@ -64,7 +64,8 @@ The following table lists the configurable parameters of the Shoebox chart and t
 | `config.serverHost` | Host to bind the server | `0.0.0.0` |
 | `config.serverPort` | Port to bind the server | `3000` |
 | `config.databaseUrl` | Database URL (SQLite) | `sqlite:/app/data/videos.db` |
-| `config.mediaSourcePaths` | Paths to scan for videos (supports named sections, see docs) | `/mnt/videos` |
+| `config.mediaSourcePaths.enabled` | Enable media source paths | `true` |
+| `config.mediaSourcePaths.sources` | List of media source paths to scan for videos | See values.yaml |
 | `config.thumbnailPath` | Path to store thumbnails | `/app/thumbnails` |
 | `config.exportBasePath` | Path for exported files | `/app/exports` |
 | `config.rustLog` | Rust log level | `info` |
@@ -79,9 +80,9 @@ The following table lists the configurable parameters of the Shoebox chart and t
 | `persistence.thumbnails.size` | Size of thumbnails PVC | `5Gi` |
 | `persistence.exports.enabled` | Enable persistence for exports | `true` |
 | `persistence.exports.size` | Size of exports PVC | `10Gi` |
-| `persistence.media.enabled` | Enable persistence for media | `true` |
-| `persistence.media.existingClaim` | Use existing PVC for media | `""` |
-| `persistence.media.size` | Size of media PVC | `100Gi` |
+| `config.mediaSourcePaths.enabled` | Enable media source paths | `true` |
+| `config.mediaSourcePaths.sources[].pathExistingClaim` | Use existing PVC for media source path | `""` |
+| `config.mediaSourcePaths.sources[].originalExistingClaim` | Use existing PVC for original media source path | `""` |
 
 ### PostgreSQL Configuration
 
@@ -124,7 +125,7 @@ helm install shoebox . \
   --set persistence.data.enabled=false \
   --set persistence.thumbnails.enabled=false \
   --set persistence.exports.enabled=false \
-  --set persistence.media.enabled=false
+  --set config.mediaSourcePaths.enabled=false
 ```
 
 ## Upgrading

charts/shoebox/templates/_helpers.tpl

@@ -65,6 +65,7 @@ Create the name of the service account to use
 Convert structured mediaSourcePaths to string format
 */}}
 {{- define "shoebox.mediaSourcePathsString" -}}
+{{- if .Values.config.mediaSourcePaths.enabled -}}
 {{- $paths := list -}}
 {{- range .Values.config.mediaSourcePaths.sources -}}
   {{- $path := printf "%s:%s" .name .path -}}
@@ -77,4 +78,7 @@ Convert structured mediaSourcePaths to string format
   {{- $paths = append $paths $path -}}
 {{- end -}}
 {{- join "," $paths -}}
+{{- else -}}
+{{- "" -}}
+{{- end -}}
 {{- end }}

charts/shoebox/templates/pvc.yaml

@@ -52,6 +52,7 @@ spec:
   {{- end }}
 ---
 {{- end }}
+{{- if .Values.config.mediaSourcePaths.enabled }}
 {{- range .Values.config.mediaSourcePaths.sources }}
 {{- if not .pathExistingClaim }}
 ---
@@ -72,7 +73,9 @@ spec:
   {{- end }}
 {{- end }}
 {{- end }}
+{{- end }}
 
+{{- if .Values.config.mediaSourcePaths.enabled }}
 {{- range .Values.config.mediaSourcePaths.sources }}
 {{- if and .originalPath (not .originalExistingClaim) }}
 ---
@@ -93,3 +96,4 @@ spec:
   {{- end }}
 {{- end }}
 {{- end }}
+{{- end }}

charts/shoebox/templates/statefulset.yaml

@@ -85,6 +85,7 @@ spec:
               readOnly: true
               {{- end }}
             {{- end }}
+            {{- if .Values.config.mediaSourcePaths.enabled }}
             {{- range .Values.config.mediaSourcePaths.sources }}
             - name: media-{{ .name | lower }}
               mountPath: {{ .path }}
@@ -101,6 +102,7 @@ spec:
               {{- end }}
             {{- end }}
             {{- end }}
+            {{- end }}
       {{- with .Values.nodeSelector }}
       nodeSelector:
         {{- toYaml . | nindent 8 }}
@@ -141,6 +143,7 @@ spec:
             claimName: {{ include "shoebox.fullname" . }}-exports
             {{- end }}
         {{- end }}
+        {{- if .Values.config.mediaSourcePaths.enabled }}
         {{- range .Values.config.mediaSourcePaths.sources }}
         - name: media-{{ .name | lower }}
           persistentVolumeClaim:
@@ -161,3 +164,4 @@ spec:
             {{- end }}
         {{- end }}
         {{- end }}
+        {{- end }}

charts/shoebox/values.yaml

@@ -95,6 +95,8 @@ config:
   # Media source paths configuration
   # You can configure multiple media sources with different settings
   mediaSourcePaths:
+    # Set to false to disable all media source paths
+    enabled: true
     sources:
       - name: bmpcc
         path: /mnt/videos