[transmission] Migrate to common v3 (#1028)

* [transmission] Migrate to common v3

Signed-off-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs <me@bjw-s.dev>
Co-authored-by: nιcнolaѕ wιlde <ncwilde43@gmail.com>

charts/stable/transmission/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: v3.00
 description: Transmission is a cross-platform BitTorrent client
 name: transmission
-version: 6.2.0
+version: 7.0.0
 kubeVersion: ">=1.16.0-0"
 keywords:
 - transmission
@@ -15,7 +15,9 @@ sources:
 maintainers:
 - name: ishioni
   email: helm@movishell.pl
+- name: bjw-s
+  email: me@bjw-s.dev
 dependencies:
 - name: common
   repository: https://library-charts.k8s-at-home.com
-  version: 2.5.0
+  version: 3.2.0

charts/stable/transmission/README.md

@@ -1,6 +1,6 @@
 # transmission
 
-![Version: 6.2.0](https://img.shields.io/badge/Version-6.2.0-informational?style=flat-square) ![AppVersion: v3.00](https://img.shields.io/badge/AppVersion-v3.00-informational?style=flat-square)
+![Version: 7.0.0](https://img.shields.io/badge/Version-7.0.0-informational?style=flat-square) ![AppVersion: v3.00](https://img.shields.io/badge/AppVersion-v3.00-informational?style=flat-square)
 
 Transmission is a cross-platform BitTorrent client
 
@@ -19,7 +19,7 @@ Kubernetes: `>=1.16.0-0`
 
 | Repository | Name | Version |
 |------------|------|---------|
-| https://library-charts.k8s-at-home.com | common | 2.5.0 |
+| https://library-charts.k8s-at-home.com | common | 3.2.0 |
 
 ## TL;DR
 
@@ -76,6 +76,7 @@ To view more environment variables [see here](https://github.com/k8s-at-home/con
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
+| env | object | See below | environment variables. See [image docs](https://github.com/k8s-at-home/container-images/tree/main/apps/transmission/settings.json.tmpl) for more details. |
 | env.TRANSMISSION_DOWNLOAD_DIR | string | `"/downloads/complete"` | Torrent download directory |
 | env.TRANSMISSION_INCOMPLETE_DIR | string | `"/downloads/incomplete"` | Incomplete download directory |
 | env.TRANSMISSION_INCOMPLETE_DIR_ENABLED | bool | `false` | Enable incomplete download directory |
@@ -83,25 +84,15 @@ To view more environment variables [see here](https://github.com/k8s-at-home/con
 | env.TRANSMISSION_WATCH_DIR | string | `"/watch"` | Watch directory |
 | env.TRANSMISSION_WATCH_DIR_ENABLED | bool | `false` | Enable watch directory |
 | env.TRANSMISSION_WEB_HOME | string | `"/web"` | Path in container where the Web UI is located |
-| env.TZ | string | `"UTC"` | Container timezone |
+| env.TZ | string | `"UTC"` | Set the container timezone |
-| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
-| image.repository | string | `"ghcr.io/k8s-at-home/transmission"` |  |
+| image.repository | string | `"ghcr.io/k8s-at-home/transmission"` | image repository |
-| image.tag | string | `"v3.00"` |  |
+| image.tag | string | `"v3.00"` | image tag |
-| ingress.enabled | bool | `false` |  |
+| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
-| persistence.config.emptyDir.enabled | bool | `false` |  |
+| initContainers | list | See values.yaml | Use an initContainer to download the Flood web ui Set UI with env `TRANSMISSION_WEB_HOME` set to `/config/flood-for-transmission/` |
-| persistence.config.enabled | bool | `false` |  |
+| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. |
-| persistence.config.mountPath | string | `"/config"` |  |
+| probes | object | See values.yaml | Configures the probes for the main Pod. |
-| persistence.downloads.emptyDir.enabled | bool | `false` |  |
+| service | object | See values.yaml | Configures service settings for the chart. |
-| persistence.downloads.enabled | bool | `false` |  |
-| persistence.downloads.mountPath | string | `"/downloads"` |  |
-| persistence.watch.emptyDir.enabled | bool | `false` |  |
-| persistence.watch.enabled | bool | `false` |  |
-| persistence.watch.mountPath | string | `"/watch"` |  |
-| probes.liveness.spec.timeoutSeconds | int | `30` |  |
-| probes.readiness.spec.timeoutSeconds | int | `30` |  |
-| service.port.name | string | `"http"` |  |
-| service.port.port | int | `9091` |  |
-| strategy.type | string | `"Recreate"` |  |
 
 ## Changelog
 
@@ -109,6 +100,13 @@ All notable changes to this application Helm chart will be documented in this fi
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### [7.0.0]
+
+#### Changed
+
+- **BREAKING**: Upgraded the common library dependency to version 3.2.0. This introduces several breaking changes (`service`, `ingress` and `persistence` keys have been refactored).
+  Be sure to check out the [library chart](https://github.com/k8s-at-home/library-charts/blob/common-3.2.0/charts/stable/common/) for the up-to-date values.
+
 ### [6.0.0]
 
 #### Changed

charts/stable/transmission/README_CHANGELOG.md.gotmpl

@@ -9,6 +9,13 @@ All notable changes to this application Helm chart will be documented in this fi
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+### [7.0.0]
+
+#### Changed
+
+- **BREAKING**: Upgraded the common library dependency to version 3.2.0. This introduces several breaking changes (`service`, `ingress` and `persistence` keys have been refactored).
+  Be sure to check out the [library chart](https://github.com/k8s-at-home/library-charts/blob/common-3.2.0/charts/stable/common/) for the up-to-date values.
+
 ### [6.0.0]
 
 #### Changed

charts/stable/transmission/ci/ct-values.yaml

@@ -14,5 +14,4 @@ initContainers:
 persistence:
   config:
     enabled: true
-    emptyDir:
+    type: emptyDir
-      enabled: true

charts/stable/transmission/values.yaml

@@ -5,9 +5,10 @@
 # https://github.com/k8s-at-home/library-charts/tree/main/charts/stable/common/values.yaml
 #
 
-# Use an initContainer to download the Flood web ui
+# -- Use an initContainer to download the Flood web ui
-# Set UI with env TRANSMISSION_WEB_HOME: /config/flood-for-transmission/
+# Set UI with env `TRANSMISSION_WEB_HOME` set to `/config/flood-for-transmission/`
-# initContainers:
+# @default -- See values.yaml
+initContainers: []
 #  - name: custom-webui
 #    image: curlimages/curl:7.76.1
 #    command:
@@ -22,17 +23,17 @@
 #      runAsGroup: 568
 
 image:
+  # -- image repository
   repository: ghcr.io/k8s-at-home/transmission
-  pullPolicy: IfNotPresent
+  # -- image tag
   tag: v3.00
+  # -- image pull policy
+  pullPolicy: IfNotPresent
 
-strategy:
+# -- environment variables. See [image docs](https://github.com/k8s-at-home/container-images/tree/main/apps/transmission/settings.json.tmpl) for more details.
-  type: Recreate
+# @default -- See below
-
-# To view more enviornment variables see here:
-# https://github.com/k8s-at-home/container-images/tree/main/apps/transmission/settings.json.tmpl
 env:
-  # -- Container timezone
+  # -- Set the container timezone
   TZ: UTC
   # -- Path in container where the Web UI is located
   TRANSMISSION_WEB_HOME: /web
@@ -49,33 +50,36 @@ env:
   # -- Watch directory
   TRANSMISSION_WATCH_DIR: /watch
 
-
+# -- Configures service settings for the chart.
+# @default -- See values.yaml
 service:
-  port:
+  main:
-    port: 9091
+    ports:
-    name: http
+      http:
-  # additionalServices:
+        port: 9091
-  # - enabled: true
+  utptcp:
-  #   nameSuffix: utptcp
+    enabled: false
-  #   type: ClusterIP
+    type: ClusterIP
-  #   annotations: {}
+    ports:
-  #   port:
+      utptcp:
-  #     port: 51413
+        enabled: true
-  #     name: utptcp
+        port: 51413
-  #     protocol: TCP
+        protocol: TCP
-  #     targetport: 51413
+        targetPort: 51413
-  # - enabled: true
+  utpudp:
-  #   nameSuffix: utpudp
+    enabled: false
-  #   type: ClusterIP
+    type: ClusterIP
-  #   annotations: {}
+    ports:
-  #   port:
+      utpudp:
-  #     port: 51413
+        enabled: true
-  #     name: utpudp
+        port: 51413
-  #     protocol: UDP
+        protocol: UDP
-  #     targetport: 51413
+        targetPort: 51413
 
-## transmission runs the gui and io on the same thread - heavy bandwith usage
+# -- Configures the probes for the main Pod.
-## may stall the UI and result in restarts.
+# @default -- See values.yaml
+## transmission runs the GUI and I/O on the same thread.
+## Heavy bandwith usage may stall the UI and result in restarts.
 probes:
   liveness:
     spec:
@@ -85,37 +89,22 @@ probes:
       timeoutSeconds: 30
 
 ingress:
-  enabled: false
+  # -- Enable and configure ingress settings for the chart under this key.
+  # @default -- See values.yaml
+  main:
+    enabled: false
 
+# -- Configure persistence settings for the chart under this key.
+# @default -- See values.yaml
 persistence:
-  ## Directory for storing active torrent files, resume list,
-  ## blocklists and DHT peers
   config:
     enabled: false
-    emptyDir:
-      enabled: false
     mountPath: /config
-    ## Persistent Volume Storage Class
-    ## If defined, storageClassName: <storageClass>
-    ## If set to "-", storageClassName: "", which disables dynamic provisioning
-    ## If undefined (the default) or set to null, no storageClassName spec is
-    ##   set, choosing the default provisioner.  (gp2 on AWS, standard on
-    ##   GKE, AWS & OpenStack)
-    # storageClass: "-"
-    # accessMode: ReadWriteOnce
-    # size: 100Mi
-    ## Do not delete the pvc upon helm uninstall
-    # skipuninstall: false
-    # existingClaim: ""
 
   downloads:
     enabled: false
-    emptyDir:
-      enabled: false
     mountPath: /downloads
 
   watch:
     enabled: false
-    emptyDir:
-      enabled: false
     mountPath: /watch