Add documentation for actual budget volume configuration

community-charts · Feb 2, 2025 · 610fc7e · 610fc7e
1 parent 89c6d99
commit 610fc7e
Show file tree

Hide file tree

Showing 4 changed files with 66 additions and 3 deletions.
diff --git a/charts/actualbudget/Chart.lock b/charts/actualbudget/Chart.lock
@@ -0,0 +1,3 @@
+dependencies: []
+digest: sha256:643d5437104296e21d906ecb15b2c96ad278f20cfc4af53b12bb6069bd853726
+generated: "2025-02-02T10:05:49.625961+01:00"
diff --git a/charts/actualbudget/Chart.yaml b/charts/actualbudget/Chart.yaml
@@ -16,7 +16,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 1.1.5
+version: 1.1.6
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
@@ -52,7 +52,7 @@ annotations:
       url: https://github.com/actualbudget/actual
   artifacthub.io/containsSecurityUpdates: "false"
   artifacthub.io/changes: |
-    - Update actualbudget/actual-server image version to 25.1.0
+    - Update documentation
   artifacthub.io/images: |
     - name: actualbudget
       image: actualbudget/actual-server:25.1.0

diff --git a/charts/actualbudget/README.md b/charts/actualbudget/README.md
@@ -4,7 +4,7 @@
 
 A local-first personal finance app
 
-![Version: 1.1.5](https://img.shields.io/badge/Version-1.1.5-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 25.1.0](https://img.shields.io/badge/AppVersion-25.1.0-informational?style=flat-square)
+![Version: 1.1.6](https://img.shields.io/badge/Version-1.1.6-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 25.1.0](https://img.shields.io/badge/AppVersion-25.1.0-informational?style=flat-square)
 
 ## Get Helm Repository Info
 
@@ -27,6 +27,36 @@ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documen
 
 > **Tip**: Search all available chart versions using `helm search repo community-charts -l`. Please don't forget to run `helm repo update` before the command.
 
+## Full Example
+
+This configuration mounts a PersistentVolumeClaim (`actualbudget-volume`) to `/data`, where server files (`/data/server-files`) and user files (`/data/user-files`) are stored. The `/data` folder persists across pod restarts, ensuring data retention.
+
+```yaml
+strategy:
+  type: Recreate
+
+files:
+  server: /data/server-files
+  user: /data/user-files
+
+ingress:
+  enabled: true
+  hosts:
+    - host: actualbudget.local
+      paths:
+        - path: /
+          pathType: ImplementationSpecific
+
+volumes:
+  - name: data
+    persistentVolumeClaim:
+      claimName: actualbudget-volume
+
+volumeMounts:
+  - name: data
+    mountPath: "/data"
+```
+
 ## Requirements
 
 Kubernetes: `>=1.16.0-0`

diff --git a/charts/actualbudget/README.md.gotmpl b/charts/actualbudget/README.md.gotmpl
@@ -27,6 +27,36 @@ _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documen
 
 > **Tip**: Search all available chart versions using `helm search repo community-charts -l`. Please don't forget to run `helm repo update` before the command.
 
+## Full Example
+
+This configuration mounts a PersistentVolumeClaim (`actualbudget-volume`) to `/data`, where server files (`/data/server-files`) and user files (`/data/user-files`) are stored. The `/data` folder persists across pod restarts, ensuring data retention.
+
+```yaml
+strategy:
+  type: Recreate
+
+files:
+  server: /data/server-files
+  user: /data/user-files
+
+ingress:
+  enabled: true
+  hosts:
+    - host: actualbudget.local
+      paths:
+        - path: /
+          pathType: ImplementationSpecific
+
+volumes:
+  - name: data
+    persistentVolumeClaim:
+      claimName: actualbudget-volume
+
+volumeMounts:
+  - name: data
+    mountPath: "/data"
+```
+
 {{ template "chart.requirementsSection" . }}
 
 ## Uninstall Helm Chart