[founderyvtt] Update to commons 3.0.0 (#948)

* [founderyvtt] Update to commons 3.0.0

* Added inline docs

* bump commons dep

* Update charts/stable/founderyvtt/values.yaml

Co-authored-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs <me@bjw-s.dev>

* Commons bump and doc update

Co-authored-by: Bᴇʀɴᴅ Sᴄʜᴏʀɢᴇʀs <me@bjw-s.dev>

charts/stable/founderyvtt/Chart.yaml

@@ -2,7 +2,7 @@ apiVersion: v2
 appVersion: 0.8.3
 description: An easy-to-deploy Dockerized Foundry Virtual Tabletop server
 name: foundryvtt
-version: 0.8.3
+version: 2.0.0
 kubeVersion: ">=1.16.0-0"
 keywords:
 - foundryvtt
@@ -16,4 +16,4 @@ maintainers:
 dependencies:
 - name: common
   repository: https://library-charts.k8s-at-home.com
-  version: 2.5.0
+  version: 3.0.2

charts/stable/founderyvtt/README.md

@@ -1,6 +1,6 @@
 # foundryvtt
 
-![Version: 0.8.3](https://img.shields.io/badge/Version-0.8.3-informational?style=flat-square) ![AppVersion: 0.8.3](https://img.shields.io/badge/AppVersion-0.8.3-informational?style=flat-square)
+![Version: 2.0.0](https://img.shields.io/badge/Version-2.0.0-informational?style=flat-square) ![AppVersion: 0.8.3](https://img.shields.io/badge/AppVersion-0.8.3-informational?style=flat-square)
 
 An easy-to-deploy Dockerized Foundry Virtual Tabletop server
 
@@ -18,7 +18,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.0.2 |
 
 ## TL;DR
 
@@ -75,15 +75,13 @@ N/A
 
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
-| env | object | `{}` |  |
+| env | object | See below | environment variables. See [image docs](https://github.com/felddy/foundryvtt-docker#environment-variables) for more details. |
-| image.pullPolicy | string | `"IfNotPresent"` |  |
+| image.pullPolicy | string | `"IfNotPresent"` | image pull policy |
-| image.repository | string | `"felddy/foundryvtt"` |  |
+| image.repository | string | `"felddy/foundryvtt"` | image repository |
-| image.tag | string | `"0.8.3"` |  |
+| image.tag | string | `"0.8.3"` | image tag |
-| ingress.enabled | bool | `false` |  |
+| ingress.main | object | See values.yaml | Enable and configure ingress settings for the chart under this key. |
-| persistence.data.emptyDir.enabled | bool | `false` |  |
+| persistence | object | See values.yaml | Configure persistence settings for the chart under this key. Founderyvtt is hardcoded to use /data for its persistance for config |
-| persistence.data.enabled | bool | `false` |  |
+| service | object | See values.yaml | Configures service settings for the chart. Normally this does not need to be modified. |
-| persistence.data.mountPath | string | `"/data"` |  |
-| service.port.port | int | `30000` |  |
 | strategy.type | string | `"Recreate"` |  |
 
 ## Changelog
@@ -92,6 +90,21 @@ 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).
 
+### [2.0.0]
+
+#### Added
+
+- Initial version
+
+#### Changed
+
+- **BREAKING**: Upgraded the common library dependency to version 3.0.1. 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.0.1/charts/stable/common/) for the up-to-date values.
+
+#### Removed
+
+- N/A
+
 ### [1.0.0]
 
 #### Added

charts/stable/founderyvtt/README_CHANGELOG.md.gotmpl

@@ -9,6 +9,21 @@ 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).
 
+### [2.0.0]
+
+#### Added
+
+- Initial version
+
+#### Changed
+
+- **BREAKING**: Upgraded the common library dependency to version 3.0.1. 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.0.1/charts/stable/common/) for the up-to-date values.
+
+#### Removed
+
+- N/A
+
 ### [1.0.0]
 
 #### Added

charts/stable/founderyvtt/values.yaml

@@ -6,28 +6,39 @@
 #
 
 image:
+  # -- image repository
   repository: felddy/foundryvtt
+  # -- image pull policy
   pullPolicy: IfNotPresent
+  # -- image tag
   tag: 0.8.3
 
 strategy:
   type: Recreate
 
-# See more environment variables in the foundryvtt documentation
+# -- environment variables. See [image docs](https://github.com/felddy/foundryvtt-docker#environment-variables) for more details.
-# https://github.com/felddy/foundryvtt-docker#environment-variables
+# @default -- See below
-
 env: {}
-  # TZ:
+  # TZ
 
+
+# -- Configures service settings for the chart. Normally this does not need to be modified.
+# @default -- See values.yaml
 service:
-  port:
+  main:
+    ports:
+      http:
         port: 30000
 
 ingress:
+  # -- 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.
-# Founderyvtt is hardcoded to use /data for its persistance for config and
+# @default -- See values.yaml
+# Founderyvtt is hardcoded to use /data for its persistance for config
 persistence:
   data:
     enabled: false