Merge pull request #14 from fonzdm/docs/values-description

Add the (Automated) Chart Documentation

.github/workflows/helm-docs.yaml

@@ -0,0 +1,30 @@
+name: 'Helm Chart Doc Generator'
+
+on:
+  push:
+    branches:
+      - 'dev'
+      - 'main'
+  pull_request:
+    branches:
+      - 'dev'
+      - 'main'
+
+jobs:
+  helm-docs:
+    runs-on: ubuntu-latest
+    steps:
+
+    - name: Checkout to current commit
+      uses: actions/checkout@v4
+      with:
+        ref: ${{ github.head_ref }}
+        fetch-depth: 0
+
+    - name: Run helm-docs and push to the same branch
+      uses: losisin/helm-docs-github-action@v1
+      with:
+        git-push: true
+        git-push-user-name: "Servarr Bot 🤖"
+        git-push-user-email: "[email protected]"
+        chart-search-root: ./servarr

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: https://github.com/norwoodj/helm-docs
+    rev: ""
+    hooks:
+      - id: helm-docs-container
+        args:
+          # Use root folder as the main repo dir is the chart itself
+          - --chart-search-root=servarr
+          - --template-files=README.md.gotmpl

README.md

@@ -45,26 +45,23 @@ $ helm install <release-name> <servarr-chart> \
 
 ### Values
 
-| **Parameter** | **Optional** | **Description** | **Default Value** | **Example Value** |
-|---------------|--------------|-----------------|-------------------|-------------------|
-| `global.apikey` | Required | Define a common API key that will be used to automate the entire integration. | `None` | `6d9df216-cac6-4f4a-9b25-5462026ce7be` |
-| `global.storageClassName` | Required | Cluster storage class to be used for the volume creation. | `None` | `longhorn` |
-
-<!-- Table init with some values just to give the idea on how it will be. A lot of values (almost all of them) are missing and MUST be filled in the table. -->
+Please read [Helm Chart README.md](./servarr/README.md) for details on how to configure the values needed for this chart.
 
 ## Contributing
 
 Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
 
-## Versioning
+## Contributors
 
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases on this repository](https://github.com/fonzdm/servarr/releases). 
+<a href="https://github.com/fonzdm/servarr/graphs/contributors">
+  <img src="https://contrib.rocks/image?repo=fonzdm/servarr" />
+</a>
 
-## Authors
+See the full list of [contributors](https://github.com/fonzdm/servarr/contributors) who participated in this project.
 
-* **Alfonso De Masi** - *Chart idea and main development* - [fonzdm](https://github.com/fonzdm)
+## Versioning
 
-See also the list of [contributors](https://github.com/fonzdm/servarr/contributors) who participated in this project.
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases on this repository](https://github.com/fonzdm/servarr/releases). 
 
 ###### Keep in mind that each dependency has its own author and their contributors. Please, reach them out on their repositories.
 

servarr/.helmignore

@@ -23,3 +23,6 @@
 .vscode/
 
 my-values.yaml
+docs/*
+.pre-commit-config.yaml
+README.md.gotmpl

servarr/README.md

@@ -0,0 +1,116 @@
+# servarr
+
+
+
+![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.0.0](https://img.shields.io/badge/AppVersion-1.0.0-informational?style=flat-square) 
+
+Servarr complete Helm Chart for Kubernetes
+
+**Homepage:** <https://github.com/fonzdm/servarr>
+
+## Maintainers
+
+| Name | Email | Url |
+| ---- | ------ | --- |
+| Alfonso De Masi | <[email protected]> |  |
+
+## Source Code
+
+* <https://github.com/fonzdm/servarr>
+
+## Requirements
+
+| Repository | Name | Version |
+|------------|------|---------|
+| https://charts.truecharts.org | flaresolverr | 13.4.1 |
+| https://charts.truecharts.org | jellyfin | 18.7.7 |
+| https://charts.truecharts.org | jellyseerr | 9.5.2 |
+| https://charts.truecharts.org | prowlarr | 16.2.1 |
+| https://charts.truecharts.org | qbittorrent | 19.4.1 |
+| https://charts.truecharts.org | radarr | 21.2.1 |
+| https://charts.truecharts.org | sonarr | 21.2.1 |
+
+---
+
+> [!IMPORTANT]  
+> Please consider that this chart is a collection of several public helm charts.
+> These are included as sub-charts of the Servarr chart and, due to some Helm limitation, some configuration are only possible via values file.
+> For this reason, the servarr default [values.yaml](#./values.yaml) included in the chart is quite huge and it used to model the configuration of the subcharts.
+> But don't you worry! I provided some handy values, using [yaml anchors](https://medium.com/@kinghuang/docker-compose-anchors-aliases-extensions-a1e4105d70bd), to defined top-level fields.
+> Follow the table below and forget everything else. 
+
+> [!CAUTION] 
+> Please, do not remove Anchors when you see them (the strage syntax with the `&`)
+
+---
+
+## Values
+
+### Jellyfin
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| dash.mail | string | No default value | Insert Jellyfin login mail (will be used also for Jellyseerr integration) |
+| dash.password | string | No default value | Insert Jellyfin password (will be used also for Jellyseerr) |
+| dash.username | string | No default value | Insert the Jellyfin username (will be used also for Jellyseerr) |
+
+### Global
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| global.apikey | string | No default value is configured for security reasons | Insert your Prowlarr, Sonarr, Radarr API key here (one to rule them all!). Do not remove the `&apikey` anchor! |
+| global.certManagerClusterIssuer | string | No default value, leave empty if not required | Insert your cert manager cluster issuer, e.g.: letsencrypt-cloudflare. Do not remove the `&issuer` anchor! |
+| global.storageClassName | string | `"network-block"` | Insert your storage class here, e.g.: &storageClassName network-block. Do not remove the `&storageClassName` anchor! |
+
+### Prowlarr
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| indexers | list | The body of the 1337x index is provided as default | The indexers list. Each element of the list is the yaml-formatted body of the [Prowlarr API request](https://prowlarr.com/docs/api/#/Indexer/post_api_v1_indexer) to add that index. |
+
+### Issuer
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| issuer | object | See the sub fields | For tracking purpose, not used - replaced with pre-existing cluster issuer |
+| issuer.cloudFlareKey | string | `nil` | Insert your CloudFlare key |
+| issuer.email | string | `nil` | Insert your email address |
+
+### Metrics
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| metrics.enabled | bool | `false` | Anchor to set wether to deploy the export sidecar pods or not. Requires the Prometheus stack. Do not remove the `&metricsEnabled` anchor! |
+
+### Jellyseerr
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| notifications.telegram.bot_apitoken | string | No default value | Insert your Telegram Bot API token |
+| notifications.telegram.chat_id | string | No default value | Insert the Telegram Chat id, check @get_id_bot for this |
+| notifications.telegram.enabled | bool | `true` | Enable the Telegram notifications |
+
+### Torrent
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| torrent.password | string | No default value | password of the qBitTorrent admin user |
+| torrent.username | string | No default value | username of the qBitTorrent admin user |
+
+### Storage
+
+| Key | Type | Default | Description |
+|-----|------|---------|-------------|
+| volumes.downloads | object | See the sub fields | configuration of the volume used for torrent downloads |
+| volumes.downloads.name | string | `"downloads-volume"` | Name of the download pvc. Do not remove the `&downloads-volume` anchor! |
+| volumes.downloads.size | string | `"100Gi"` | Size of the downloads volume, in Kubernets format |
+| volumes.media | object | See the sub fields | configuration of the volume used for media storage (i.e.: where movies and tv shows file will be permanently stored) |
+| volumes.media.name | string | `"media-volume"` | Name of the media pvc. Do not remove the `&media-volume` anchor! |
+| volumes.media.size | string | `"250Gi"` | Size of the media volume, in Kubernets format |
+| volumes.torrentConfig | object | See the sub fields | configuration of the volume used for qBitTorrent internal configuration |
+| volumes.torrentConfig.name | string | `"torrent-config"` | Name of the torrent configuration pvc. Do not remove the `&torrentConfig` anchor! |
+| volumes.torrentConfig.size | string | `"250Mi"` | Size of the torrent configuration volume, in Kubernets format |
+
+
+----------------------------------------------
+Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)

servarr/README.md.gotmpl

@@ -0,0 +1,32 @@
+{{ template "chart.header" . }}
+{{ template "chart.deprecationWarning" . }}
+
+{{ template "chart.badgesSection" . }}
+
+{{ template "chart.description" . }}
+
+{{ template "chart.homepageLine" . }}
+
+{{ template "chart.maintainersSection" . }}
+
+{{ template "chart.sourcesSection" . }}
+
+{{ template "chart.requirementsSection" . }}
+
+---
+
+> [!IMPORTANT]  
+> Please consider that this chart is a collection of several public helm charts.
+> These are included as sub-charts of the Servarr chart and, due to some Helm limitation, some configuration are only possible via values file.
+> For this reason, the servarr default [values.yaml](#./values.yaml) included in the chart is quite huge and it used to model the configuration of the subcharts.
+> But don't you worry! I provided some handy values, using [yaml anchors](https://medium.com/@kinghuang/docker-compose-anchors-aliases-extensions-a1e4105d70bd), to defined top-level fields.
+> Follow the table below and forget everything else. 
+
+> [!CAUTION] 
+> Please, do not remove Anchors when you see them (the strage syntax with the `&`)
+
+---
+
+{{ template "chart.valuesSection" . }}
+
+{{ template "helm-docs.versionFooter" . }}