NAS-122968 / 23.10 / add recyclarr to community train (#1359)

* add `recyclarr` to `community` train * add templates * add ui * fix keywords * bump
2026-04-05 03:39:20 +08:00 · 2023-07-17 16:08:38 +03:00
parent 5c95feb01f
commit c9395376e4
17 changed files with 449 additions and 0 deletions
--- a/library/ix-dev/community/recyclarr/Chart.lock
+++ b/library/ix-dev/community/recyclarr/Chart.lock
@@ -0,0 +1,6 @@
+dependencies:
+- name: common
+  repository: file://../../../common
+  version: 1.0.12
+digest: sha256:debd30721d09ae8293b1cbdd9d0115981d40b47908be3035fc3cf657c9d5eedb
+generated: "2023-07-15T23:16:08.316301013+03:00"
--- a/library/ix-dev/community/recyclarr/Chart.yaml
+++ b/library/ix-dev/community/recyclarr/Chart.yaml
@@ -0,0 +1,27 @@
+name: recyclarr
+description: Recyclarr synchronizes recommended settings from the TRaSH guides to your Sonarr/Radarr instances.
+annotations:
+  title: Recyclarr
+type: application
+version: 1.0.0
+apiVersion: v2
+appVersion: 5.1.1
+kubeVersion: '>=1.16.0-0'
+maintainers:
+  - name: truenas
+    url: https://www.truenas.com/
+    email: dev@ixsystems.com
+dependencies:
+  - name: common
+    repository: file://../../../common
+    version: 1.0.12
+home: https://recyclarr.dev
+icon: https://avatars.githubusercontent.com/u/105823709
+sources:
+  - https://recyclarr.dev
+  - https://github.com/truenas/charts/tree/master/community/recyclarr
+  - https://github.com/recyclarr/recyclarr/tree/recyclarr
+keywords:
+  - media
+  - sonarr
+  - radarr
--- a/library/ix-dev/community/recyclarr/README.md
+++ b/library/ix-dev/community/recyclarr/README.md
@@ -0,0 +1,8 @@
+# Recyclarr
+
+[Recyclarr](https://github.com/recyclarr/recyclarr) synchronizes recommended settings from the TRaSH guides to your Sonarr/Radarr instances.
+
+> When application is installed, a container will be launched with **root** privileges.
+> This is required in order to apply the correct permissions to the `Recyclarr` directories.
+> Afterward, the `Recyclarr` container will run as a **non**-root user (Default: `568`).
+> All mounted storage(s) will be `chown`ed only if the parent directory does not match the configured user.
--- a/library/ix-dev/community/recyclarr/app-readme.md
+++ b/library/ix-dev/community/recyclarr/app-readme.md
@@ -0,0 +1,8 @@
+# Recyclarr
+
+[Recyclarr](https://github.com/recyclarr/recyclarr) synchronizes recommended settings from the TRaSH guides to your Sonarr/Radarr instances.
+
+> When application is installed, a container will be launched with **root** privileges.
+> This is required in order to apply the correct permissions to the `Recyclarr` directories.
+> Afterward, the `Recyclarr` container will run as a **non**-root user (Default: `568`).
+> All mounted storage(s) will be `chown`ed only if the parent directory does not match the configured user.
--- a/library/ix-dev/community/recyclarr/charts/common-1.0.12.tgz
+++ b/library/ix-dev/community/recyclarr/charts/common-1.0.12.tgz
--- a/library/ix-dev/community/recyclarr/ci/basic-values.yaml
+++ b/library/ix-dev/community/recyclarr/ci/basic-values.yaml
@@ -0,0 +1,8 @@
+recyclarrRunAs:
+  user: 1000
+  group: 1000
+
+recyclarrStorage:
+  config:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/config
--- a/library/ix-dev/community/recyclarr/ci/extra-values.yaml
+++ b/library/ix-dev/community/recyclarr/ci/extra-values.yaml
@@ -0,0 +1,11 @@
+recyclarrStorage:
+  config:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/config
+  additionalStorages:
+  - type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/data1
+    mountPath: /data1
+  - type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/data2
+    mountPath: /data2
--- a/library/ix-dev/community/recyclarr/item.yaml
+++ b/library/ix-dev/community/recyclarr/item.yaml
@@ -0,0 +1,8 @@
+icon_url: https://avatars.githubusercontent.com/u/105823709
+categories:
+  - media
+screenshots: []
+tags:
+  - sync
+  - sonarr
+  - radarr
--- a/library/ix-dev/community/recyclarr/metadata.yaml
+++ b/library/ix-dev/community/recyclarr/metadata.yaml
@@ -0,0 +1,8 @@
+runAsContext:
+  - userName: recyclarr
+    groupName: recyclarr
+    gid: 568
+    uid: 568
+    description: Recyclarr can run as any non-root user.
+capabilities: []
+hostMounts: []
--- a/library/ix-dev/community/recyclarr/questions.yaml
+++ b/library/ix-dev/community/recyclarr/questions.yaml
@@ -0,0 +1,225 @@
+groups:
+  - name: Recyclarr Configuration
+    description: Configure Recyclarr
+  - name: User and Group Configuration
+    description: Configure User and Group for Recyclarr
+  - name: Storage Configuration
+    description: Configure Storage for Recyclarr
+  - name: Resources Configuration
+    description: Configure Resources for Recyclarr
+
+questions:
+  - variable: TZ
+    group: Recyclarr Configuration
+    label: Timezone
+    schema:
+      type: string
+      default: Etc/UTC
+      required: true
+      $ref:
+        - definitions/timezone
+
+  - variable: recyclarrConfig
+    label: ""
+    group: Recyclarr Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: createConfig
+          label: Create Default Config
+          description: |
+            Enable this if you want /config/recyclarr.yml to be created for
+            you automatically when the container starts. </br>
+            If the file already exists, it will not create the file again.
+          schema:
+            type: boolean
+            default: false
+        - variable: cronSchedule
+          label: Cron Schedule
+          description: |
+            The cron schedule to use for Recyclarr.
+          schema:
+            type: string
+            default: "@daily"
+            required: true
+        - variable: additionalEnvs
+          label: Additional Environment Variables
+          description: Configure additional environment variables for Recyclarr.
+          schema:
+            type: list
+            default: []
+            items:
+              - variable: env
+                label: Environment Variable
+                schema:
+                  type: dict
+                  attrs:
+                    - variable: name
+                      label: Name
+                      schema:
+                        type: string
+                        required: true
+                    - variable: value
+                      label: Value
+                      schema:
+                        type: string
+                        required: true
+
+  - variable: recyclarrRunAs
+    label: ""
+    group: User and Group Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: user
+          label: User ID
+          description: The user id that Recyclarr will run as.
+          schema:
+            type: int
+            min: 2
+            default: 568
+            required: true
+        - variable: group
+          label: Group ID
+          description: The group id that Recyclarr will run as.
+          schema:
+            type: int
+            min: 2
+            default: 568
+            required: true
+
+  - variable: recyclarrStorage
+    label: ""
+    group: Storage Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: config
+          label: Recyclarr Config Storage
+          description: The path to store Recyclarr Configuration.
+          schema:
+            type: dict
+            attrs:
+              - variable: type
+                label: Type
+                description: |
+                  ixVolume: Is dataset created automatically by the system.</br>
+                  Host Path: Is a path that already exists on the system.
+                schema:
+                  type: string
+                  required: true
+                  default: "ixVolume"
+                  enum:
+                    - value: "hostPath"
+                      description: Host Path (Path that already exists on the system)
+                    - value: "ixVolume"
+                      description: ixVolume (Dataset created automatically by the system)
+              - variable: datasetName
+                label: Dataset Name
+                schema:
+                  type: string
+                  show_if: [["type", "=", "ixVolume"]]
+                  required: true
+                  hidden: true
+                  immutable: true
+                  default: "config"
+                  $ref:
+                    - "normalize/ixVolume"
+              - variable: hostPath
+                label: Host Path
+                schema:
+                  type: hostpath
+                  show_if: [["type", "=", "hostPath"]]
+                  immutable: true
+                  required: true
+        - variable: additionalStorages
+          label: Additional Storage
+          description: Additional storage for Recyclarr.
+          schema:
+            type: list
+            default: []
+            items:
+              - variable: storageEntry
+                label: Storage Entry
+                schema:
+                  type: dict
+                  attrs:
+                    - variable: type
+                      label: Type
+                      description: |
+                        ixVolume: Is dataset created automatically by the system.</br>
+                        Host Path: Is a path that already exists on the system.
+                      schema:
+                        type: string
+                        required: true
+                        default: "ixVolume"
+                        enum:
+                          - value: "hostPath"
+                            description: Host Path (Path that already exists on the system)
+                          - value: "ixVolume"
+                            description: ixVolume (Dataset created automatically by the system)
+                    - variable: mountPath
+                      label: Mount Path
+                      description: The path inside the container to mount the storage.
+                      schema:
+                        type: path
+                        required: true
+                    - variable: hostPath
+                      label: Host Path
+                      description: The host path to use for storage.
+                      schema:
+                        type: hostpath
+                        show_if: [["type", "=", "hostPath"]]
+                        required: true
+                    - variable: datasetName
+                      label: Dataset Name
+                      description: The name of the dataset to use for storage.
+                      schema:
+                        type: string
+                        show_if: [["type", "=", "ixVolume"]]
+                        required: true
+                        immutable: true
+                        default: "storage_entry"
+                        $ref:
+                          - "normalize/ixVolume"
+
+  - variable: resources
+    group: Resources Configuration
+    label: ""
+    schema:
+      type: dict
+      attrs:
+        - variable: limits
+          label: Limits
+          schema:
+            type: dict
+            attrs:
+              - variable: cpu
+                label: CPU
+                description: CPU limit for Recyclarr.
+                schema:
+                  type: string
+                  max_length: 6
+                  valid_chars: '^(0\.[1-9]|[1-9][0-9]*)(\.[0-9]|m?)$'
+                  valid_chars_error: |
+                    Valid CPU limit formats are</br>
+                    - Plain Integer - eg. 1</br>
+                    - Float - eg. 0.5</br>
+                    - Milicpu - eg. 500m
+                  default: "4000m"
+                  required: true
+              - variable: memory
+                label: Memory
+                description: Memory limit for Recyclarr.
+                schema:
+                  type: string
+                  max_length: 12
+                  valid_chars: '^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$'
+                  valid_chars_error: |
+                    Valid Memory limit formats are</br>
+                    - Suffixed with E/P/T/G/M/K - eg. 1G</br>
+                    - Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>
+                    - Plain Integer in bytes - eg. 1024</br>
+                    - Exponent - eg. 134e6
+                  default: "8Gi"
+                  required: true
--- a/library/ix-dev/community/recyclarr/templates/NOTES.txt
+++ b/library/ix-dev/community/recyclarr/templates/NOTES.txt
@@ -0,0 +1 @@
+{{ include "ix.v1.common.lib.chart.notes" $ }}
--- a/library/ix-dev/community/recyclarr/templates/_persistence.tpl
+++ b/library/ix-dev/community/recyclarr/templates/_persistence.tpl
@@ -0,0 +1,34 @@
+{{- define "recyclarr.persistence" -}}
+persistence:
+  config:
+    enabled: true
+    type: {{ .Values.recyclarrStorage.config.type }}
+    datasetName: {{ .Values.recyclarrStorage.config.datasetName | default "" }}
+    hostPath: {{ .Values.recyclarrStorage.config.hostPath | default "" }}
+    targetSelector:
+      recyclarr:
+        recyclarr:
+          mountPath: /config
+        01-permissions:
+          mountPath: /mnt/directories/config
+  tmp:
+    enabled: true
+    type: emptyDir
+    targetSelector:
+      recyclarr:
+        recyclarr:
+          mountPath: /tmp
+  {{- range $idx, $storage := .Values.recyclarrStorage.additionalStorages }}
+  {{ printf "recyclarr-%v" (int $idx) }}:
+    enabled: true
+    type: {{ $storage.type }}
+    datasetName: {{ $storage.datasetName | default "" }}
+    hostPath: {{ $storage.hostPath | default "" }}
+    targetSelector:
+      recyclarr:
+        recyclarr:
+          mountPath: {{ $storage.mountPath }}
+        01-permissions:
+          mountPath: /mnt/directories{{ $storage.mountPath }}
+  {{- end }}
+{{- end -}}
--- a/library/ix-dev/community/recyclarr/templates/_recyclarr.tpl
+++ b/library/ix-dev/community/recyclarr/templates/_recyclarr.tpl
@@ -0,0 +1,42 @@
+{{- define "recyclarr.workload" -}}
+workload:
+  recyclarr:
+    enabled: true
+    primary: true
+    type: Deployment
+    podSpec:
+      hostNetwork: false
+      containers:
+        recyclarr:
+          enabled: true
+          primary: true
+          imageSelector: image
+          securityContext:
+            runAsUser: {{ .Values.recyclarrRunAs.user }}
+            runAsGroup: {{ .Values.recyclarrRunAs.group }}
+          env:
+            RECYCLARR_APP_DATA: /config
+            RECYCLARR_CREATE_CONFIG: {{ .Values.recyclarrConfig.createConfig }}
+            CRON_SCHEDULE: {{ .Values.recyclarrConfig.cronSchedule | quote}}
+          {{ with .Values.recyclarrConfig.additionalEnvs }}
+          envList:
+            {{ range $env := . }}
+            - name: {{ $env.name }}
+              value: {{ $env.value }}
+            {{ end }}
+          {{ end }}
+          probes:
+            # Nothing to probe
+            liveness:
+              enabled: false
+            readiness:
+              enabled: false
+            startup:
+              enabled: false
+      initContainers:
+      {{- include "ix.v1.common.app.permissions" (dict "containerName" "01-permissions"
+                                                        "UID" .Values.recyclarrRunAs.user
+                                                        "GID" .Values.recyclarrRunAs.group
+                                                        "mode" "check"
+                                                        "type" "init") | nindent 8 }}
+{{- end -}}
--- a/library/ix-dev/community/recyclarr/templates/common.yaml
+++ b/library/ix-dev/community/recyclarr/templates/common.yaml
@@ -0,0 +1,7 @@
+{{- include "ix.v1.common.loader.init" . -}}
+
+{{/* Merge the templates with Values */}}
+{{- $_ := mustMergeOverwrite .Values (include "recyclarr.workload" $ | fromYaml) -}}
+{{- $_ := mustMergeOverwrite .Values (include "recyclarr.persistence" $ | fromYaml) -}}
+
+{{- include "ix.v1.common.loader.apply" . -}}
--- a/library/ix-dev/community/recyclarr/upgrade_info.json
+++ b/library/ix-dev/community/recyclarr/upgrade_info.json
@@ -0,0 +1 @@
+{"filename": "values.yaml", "keys": ["image"]}
--- a/library/ix-dev/community/recyclarr/upgrade_strategy
+++ b/library/ix-dev/community/recyclarr/upgrade_strategy
@@ -0,0 +1,31 @@
+#!/usr/bin/python3
+import json
+import re
+import sys
+
+from catalog_update.upgrade_strategy import semantic_versioning
+
+
+RE_STABLE_VERSION = re.compile(r'\d+\.\d+\.\d+')
+
+
+def newer_mapping(image_tags):
+    key = list(image_tags.keys())[0]
+    tags = {t: t for t in image_tags[key] if RE_STABLE_VERSION.fullmatch(t)}
+    version = semantic_versioning(list(tags))
+    if not version:
+        return {}
+
+    return {
+        'tags': {key: tags[version]},
+        'app_version': version,
+    }
+
+
+if __name__ == '__main__':
+    try:
+        versions_json = json.loads(sys.stdin.read())
+    except ValueError:
+        raise ValueError('Invalid json specified')
+
+    print(json.dumps(newer_mapping(versions_json)))
--- a/library/ix-dev/community/recyclarr/values.yaml
+++ b/library/ix-dev/community/recyclarr/values.yaml
@@ -0,0 +1,24 @@
+image:
+  repository: recyclarr/recyclarr
+  pullPolicy: IfNotPresent
+  tag: 5.1.1
+
+resources:
+  limits:
+    cpu: 4000m
+    memory: 8Gi
+
+recyclarrConfig:
+  createConfig: true
+  cronSchedule: '@daily'
+  additionalEnvs: []
+
+recyclarrRunAs:
+  user: 568
+  group: 568
+
+recyclarrStorage:
+  config:
+    type: ixVolume
+    datasetName: config
+  additionalStorages: []
				`@@ -0,0 +1 @@`
				`{{ include "ix.v1.common.lib.chart.notes" $ }}`
				`@@ -0,0 +1 @@`
				`{"filename": "values.yaml", "keys": ["image"]}`