From aa45228a8d19b6bde50aae87b65d0001f474f129 Mon Sep 17 00:00:00 2001 From: Mark McWhirter <8041254+mcmarkj@users.noreply.github.com> Date: Mon, 28 Dec 2020 20:14:30 +0000 Subject: [PATCH] [Readarr] New Readarr chart (#438) * V1 of Readarr * Feedback from PR * Additional message around early-dev project --- charts/readarr/.helmignore | 24 ++++++++++++ charts/readarr/Chart.yaml | 23 ++++++++++++ charts/readarr/README.md | 55 ++++++++++++++++++++++++++++ charts/readarr/templates/NOTES.txt | 1 + charts/readarr/templates/common.yaml | 1 + charts/readarr/values.yaml | 40 ++++++++++++++++++++ 6 files changed, 144 insertions(+) create mode 100644 charts/readarr/.helmignore create mode 100644 charts/readarr/Chart.yaml create mode 100644 charts/readarr/README.md create mode 100644 charts/readarr/templates/NOTES.txt create mode 100644 charts/readarr/templates/common.yaml create mode 100644 charts/readarr/values.yaml diff --git a/charts/readarr/.helmignore b/charts/readarr/.helmignore new file mode 100644 index 00000000..bb3b20ac --- /dev/null +++ b/charts/readarr/.helmignore @@ -0,0 +1,24 @@ +# Patterns to ignore when building packages. +# This supports shell glob matching, relative path matching, and +# negation (prefixed with !). Only one pattern per line. +.DS_Store +# Common VCS dirs +.git/ +.gitignore +.bzr/ +.bzrignore +.hg/ +.hgignore +.svn/ +# Common backup files +*.swp +*.bak +*.tmp +*~ +# Various IDEs +.project +.idea/ +*.tmproj +# OWNERS file for Kubernetes +OWNERS +.vscode/ diff --git a/charts/readarr/Chart.yaml b/charts/readarr/Chart.yaml new file mode 100644 index 00000000..164e88e6 --- /dev/null +++ b/charts/readarr/Chart.yaml @@ -0,0 +1,23 @@ +apiVersion: v2 +appVersion: 0.1.0.351 +description: A fork of Radarr to work with Books & AudioBooks +name: readarr +version: 1.0.0 +keywords: + - readarr + - torrent + - usenet + - AudioBooks + - ebooks +home: https://github.com/k8s-at-home/charts/tree/master/charts/readarr +icon: https://readarr.com/img/logo.png +sources: + - https://github.com/Readarr/Readarr + - https://readarr.com +maintainers: + - name: mcmarkj + email: mark@markmcw.uk +dependencies: + - name: common + repository: https://k8s-at-home.com/charts/ + version: 2.1.1 diff --git a/charts/readarr/README.md b/charts/readarr/README.md new file mode 100644 index 00000000..92baec90 --- /dev/null +++ b/charts/readarr/README.md @@ -0,0 +1,55 @@ +# Readarr + +This is a helm chart for [Readarr](https://github.com/Readarr/Readarr). + +**Readarr is still in early development, and this chart will install a nightly build of Readarr. +[See the project readme for more information](https://github.com/Readarr/Readarr#readarr-is-in-early-stages-of-development-alphabeta-binary-builds-are-not-yet-available-use-of-any-test-builds-isnt-recommend-and-may-have-detrimental-effects-on-your-library). Take back-up's if you decide to use this on an existing library as the project is considered unstable** + +**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/k8s-at-home/charts/issues/new/choose)** + +## TL;DR; + +```shell +$ helm repo add k8s-at-home https://k8s-at-home.com/charts/ +$ helm install k8s-at-home/readarr +``` + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```console +helm install --name my-release k8s-at-home/readarr +``` + +## Uninstalling the Chart + +To uninstall/delete the `my-release` deployment: + +```console +helm delete my-release --purge +``` + +The command removes all the Kubernetes components associated with the chart and deletes the release. + +## Configuration +Read through the charts [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/readarr/values.yaml) +file. It has several commented out suggested values. +Additionally you can take a look at the common library [values.yaml](https://github.com/k8s-at-home/charts/blob/master/charts/common/values.yaml) for more (advanced) configuration options. + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, +```console +helm install readarr \ + --set env.TZ="America/New_York" \ + k8s-at-home/readarr +``` +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the +chart. For example, +```console +helm install readarr k8s-at-home/readarr --values values.yaml +``` + +```yaml +image: + tag: ... +``` diff --git a/charts/readarr/templates/NOTES.txt b/charts/readarr/templates/NOTES.txt new file mode 100644 index 00000000..90f7b653 --- /dev/null +++ b/charts/readarr/templates/NOTES.txt @@ -0,0 +1 @@ +{{- include "common.notes.defaultNotes" . -}} diff --git a/charts/readarr/templates/common.yaml b/charts/readarr/templates/common.yaml new file mode 100644 index 00000000..a6613c2c --- /dev/null +++ b/charts/readarr/templates/common.yaml @@ -0,0 +1 @@ +{{ include "common.all" . }} diff --git a/charts/readarr/values.yaml b/charts/readarr/values.yaml new file mode 100644 index 00000000..de16c937 --- /dev/null +++ b/charts/readarr/values.yaml @@ -0,0 +1,40 @@ +# Default values for Radarr. + +image: + repository: hotio/readarr + pullPolicy: IfNotPresent + tag: nightly + +strategy: + type: Recreate + +service: + port: + port: 8787 + +env: {} + # TZ: UTC + # PUID: 1001 + # PGID: 1001 + +persistence: + config: + enabled: false + emptyDir: false + + media: + enabled: false + emptyDir: false + mountPath: /media + ## Persistent Volume Storage Class + ## If defined, storageClassName: + ## 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: 1Gi + ## Do not delete the pvc upon helm uninstall + # skipuninstall: false + # existingClaim: ""