Added variables & verbiage (#236)

* Added extra variables for downloads/media Added variables and descriptions for downloads/media PVCs. * Update values.yaml Extra verbiage * 💡 Tweak comment order * 💡 Fix comment indent * 📦 Rerun pre-commit hooks --------- Co-authored-by: Gabe Cook <[email protected]>
gabe565 · Jul 4, 2023 · 3062e2b · 3062e2b
1 parent ed82dc6
commit 3062e2b
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 5 deletions.
diff --git a/charts/qbittorrent/README.md b/charts/qbittorrent/README.md
@@ -115,7 +115,7 @@ Docker mod. In `values.yaml`:
 | image.repository | string | `"ghcr.io/linuxserver/qbittorrent"` | image repository |
 | image.tag | string | `"version-4.5.4-r0"` | image tag |
 | ingress.main | object | See [values.yaml](./values.yaml) | Enable and configure ingress settings for the chart under this key. |
-| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. |
+| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. Set `enabled` to `true' to create persistant volumes for each of these. |
 | service | object | See [values.yaml](./values.yaml) | Configures service settings for the chart. |
 
 ---

diff --git a/charts/qbittorrent/values.yaml b/charts/qbittorrent/values.yaml
@@ -49,17 +49,29 @@ ingress:
     #       - chart-example.local
 
 # -- Configure persistence settings for the chart under this key.
+# Set `enabled` to `true' to create persistant volumes for each of these.
 # @default -- See values.yaml
 persistence:
+  # Configuration files
   config:
     enabled: false
-    retain: true
+    # retain: true
     # storageClass: ""
     # accessMode: ReadWriteOnce
     # size: 1Gi
-  media:
-    enabled: false
-    # mountPath: /media
+
+  # Optional - Download location - Allows dedicated volume for storage of downloaded files.
   downloads:
     enabled: false
     # mountPath: /downloads
+    # storageClass: ""
+    # accessMode: ReadWriteOnce
+    # size: 10Gi
+
+  # Optional - Allows linking to an existing media library scraping location.
+  media:
+    enabled: false
+    # mountPath: /media
+    # storageClass: ""
+    # accessMode: ReadWriteOnce
+    # size: 10Gi