NAS-122677 / 23.10 / Add readarr to community train (#1300)

* Add `readarr` to `community` train

* update common

library/ix-dev/community/readarr/Chart.lock

@@ -0,0 +1,6 @@
+dependencies:
+- name: common
+  repository: file://../../../common
+  version: 1.0.9
+digest: sha256:c3eb00f142d5d1cdbff7843940c150a00bd916520363e6ee9f459ce61fa92b40
+generated: "2023-06-28T15:39:05.334080122+03:00"

library/ix-dev/community/readarr/Chart.yaml

@@ -0,0 +1,27 @@
+name: readarr
+description: Readarr is an ebook and audiobook collection manager for Usenet and BitTorrent users.
+annotations:
+  title: Readarr
+type: application
+version: 1.0.0
+apiVersion: v2
+appVersion: '0.1.9.1905'
+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.9
+home: https://github.com/Readarr/Readarr
+icon: https://raw.githubusercontent.com/Readarr/Readarr/develop/Logo/256.png
+sources:
+  - https://github.com/onedr0p/containers/tree/main/apps/readarr
+  - https://github.com/truenas/charts/tree/master/library/ix-dev/community/readarr
+  - https://github.com/Readarr/Readarr
+keywords:
+  - media
+  - ebook
+  - audiobook

library/ix-dev/community/readarr/README.md

@@ -0,0 +1,8 @@
+# Readarr
+
+[Readarr](https://github.com/Readarr/Readarr) is an ebook and audiobook collection manager for Usenet and BitTorrent users.
+
+> When application is installed, a container will be launched with **root** privileges.
+> This is required in order to apply the correct permissions to the `Readarr` directories.
+> Afterward, the `Readarr` 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.

library/ix-dev/community/readarr/app-readme.md

@@ -0,0 +1,8 @@
+# Readarr
+
+[Readarr](https://github.com/Readarr/Readarr) is an ebook and audiobook collection manager for Usenet and BitTorrent users.
+
+> When application is installed, a container will be launched with **root** privileges.
+> This is required in order to apply the correct permissions to the `Readarr` directories.
+> Afterward, the `Readarr` 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.

library/ix-dev/community/readarr/ci/basic-values.yaml

@@ -0,0 +1,11 @@
+readarrNetwork:
+  webPort: 31000
+
+readarrRunAs:
+  user: 1000
+  group: 1000
+
+readarrStorage:
+  config:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/config

library/ix-dev/community/readarr/ci/extra-values.yaml

@@ -0,0 +1,21 @@
+readarrConfig:
+  additionalEnvs:
+    - name: READARR__API_KEY
+      value: some-long-api-key
+    - name: READARR__LOG_LEVEL
+      value: error
+
+readarrNetwork:
+  webPort: 31000
+
+readarrStorage:
+  config:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/config
+  additionalStorages:
+  - type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/pop_music
+    mountPath: /pop_music
+  - type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/country_music
+    mountPath: /country_music

library/ix-dev/community/readarr/ci/hostNet-values.yaml

@@ -0,0 +1,8 @@
+readarrNetwork:
+  webPort: 30000
+  hostNetwork: true
+
+readarrStorage:
+  config:
+    type: hostPath
+    hostPath: /mnt/{{ .Release.Namespace }}/config

library/ix-dev/community/readarr/item.yaml

@@ -0,0 +1,10 @@
+icon_url: https://raw.githubusercontent.com/Readarr/Readarr/develop/Logo/256.png
+categories:
+  - media
+screenshots:
+  - https://readarr.com/img/features/manualsearch.png
+  - https://readarr.com/img/features/calibre.png
+  - https://readarr.com/img/features/calendar.png
+tags:
+  - ebook
+  - audiobook

library/ix-dev/community/readarr/metadata.yaml

@@ -0,0 +1,8 @@
+runAsContext:
+  - userName: readarr
+    groupName: readarr
+    gid: 568
+    uid: 568
+    description: Readarr can run as any non-root user.
+capabilities: []
+hostMounts: []

library/ix-dev/community/readarr/questions.yaml

@@ -0,0 +1,225 @@
+groups:
+  - name: Readarr Configuration
+    description: Configure Readarr
+  - name: User and Group Configuration
+    description: Configure User and Group for Readarr
+  - name: Network Configuration
+    description: Configure Network for Readarr
+  - name: Storage Configuration
+    description: Configure Storage for Readarr
+  - name: Resources Configuration
+    description: Configure Resources for Readarr
+
+portals:
+  web_portal:
+    protocols:
+      - "$kubernetes-resource_configmap_portal_protocol"
+    host:
+      - "$kubernetes-resource_configmap_portal_host"
+    ports:
+      - "$kubernetes-resource_configmap_portal_port"
+    path: "$kubernetes-resource_configmap_portal_path"
+
+questions:
+  - variable: readarrConfig
+    label: ""
+    group: Readarr Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: instanceName
+          label: Instance Name
+          description: The name of the Readarr instance.
+          schema:
+            type: string
+            default: "Readarr"
+            required: true
+        - variable: additionalEnvs
+          label: Additional Environment Variables
+          description: Configure additional environment variables for Readarr.
+          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: readarrRunAs
+    label: ""
+    group: User and Group Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: user
+          label: User ID
+          description: The user id that Readarr will run as.
+          schema:
+            type: int
+            min: 2
+            default: 568
+            required: true
+        - variable: group
+          label: Group ID
+          description: The group id that Readarr will run as.
+          schema:
+            type: int
+            min: 2
+            default: 568
+            required: true
+
+  - variable: readarrNetwork
+    label: ""
+    group: Network Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: webPort
+          label: Web Port
+          description: The port for the Readarr Web UI.
+          schema:
+            type: int
+            default: 30045
+            min: 9000
+            max: 65535
+            required: true
+        - variable: hostNetwork
+          label: Host Network
+          description: |
+            Bind to the host network. It's recommended to keep this disabled.</br>
+          schema:
+            type: boolean
+            default: false
+
+  - variable: readarrStorage
+    label: ""
+    group: Storage Configuration
+    schema:
+      type: dict
+      attrs:
+        - variable: config
+          label: Readarr Config Storage
+          description: The path to store Readarr 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 Readarr.
+          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 Readarr.
+                schema:
+                  type: string
+                  default: "4000m"
+                  required: true
+              - variable: memory
+                label: Memory
+                description: Memory limit for Readarr.
+                schema:
+                  type: string
+                  default: "8Gi"
+                  required: true

library/ix-dev/community/readarr/templates/NOTES.txt

@@ -0,0 +1 @@
+{{ include "ix.v1.common.lib.chart.notes" $ }}

library/ix-dev/community/readarr/templates/_persistence.tpl

@@ -0,0 +1,34 @@
+{{- define "readarr.persistence" -}}
+persistence:
+  config:
+    enabled: true
+    type: {{ .Values.readarrStorage.config.type }}
+    datasetName: {{ .Values.readarrStorage.config.datasetName | default "" }}
+    hostPath: {{ .Values.readarrStorage.config.hostPath | default "" }}
+    targetSelector:
+      readarr:
+        readarr:
+          mountPath: /config
+        01-permissions:
+          mountPath: /mnt/directories/config
+  tmp:
+    enabled: true
+    type: emptyDir
+    targetSelector:
+      readarr:
+        readarr:
+          mountPath: /tmp
+  {{- range $idx, $storage := .Values.readarrStorage.additionalStorages }}
+  {{ printf "readarr-%v" (int $idx) }}:
+    enabled: true
+    type: {{ $storage.type }}
+    datasetName: {{ $storage.datasetName | default "" }}
+    hostPath: {{ $storage.hostPath | default "" }}
+    targetSelector:
+      readarr:
+        readarr:
+          mountPath: {{ $storage.mountPath }}
+        01-permissions:
+          mountPath: /mnt/directories{{ $storage.mountPath }}
+  {{- end }}
+{{- end -}}

library/ix-dev/community/readarr/templates/_portal.tpl

@@ -0,0 +1,12 @@
+{{- define "readarr.portal" -}}
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: portal
+data:
+  path: "/"
+  port: {{ .Values.readarrNetwork.webPort | quote }}
+  protocol: http
+  host: $node_ip
+{{- end -}}

library/ix-dev/community/readarr/templates/_readarr.tpl

@@ -0,0 +1,49 @@
+{{- define "readarr.workload" -}}
+workload:
+  readarr:
+    enabled: true
+    primary: true
+    type: Deployment
+    podSpec:
+      hostNetwork: {{ .Values.readarrNetwork.hostNetwork }}
+      containers:
+        readarr:
+          enabled: true
+          primary: true
+          imageSelector: image
+          securityContext:
+            runAsUser: {{ .Values.readarrRunAs.user }}
+            runAsGroup: {{ .Values.readarrRunAs.group }}
+          env:
+            READARR__PORT: {{ .Values.readarrNetwork.webPort }}
+            READARR__INSTANCE_NAME: {{ .Values.readarrConfig.instanceName }}
+          {{ with .Values.readarrConfig.additionalEnvs }}
+          envList:
+            {{ range $env := . }}
+            - name: {{ $env.name }}
+              value: {{ $env.value }}
+            {{ end }}
+          {{ end }}
+          probes:
+            liveness:
+              enabled: true
+              type: http
+              port: "{{ .Values.readarrNetwork.webPort }}"
+              path: /ping
+            readiness:
+              enabled: true
+              type: http
+              port: "{{ .Values.readarrNetwork.webPort }}"
+              path: /ping
+            startup:
+              enabled: true
+              type: http
+              port: "{{ .Values.readarrNetwork.webPort }}"
+              path: /ping
+      initContainers:
+      {{- include "ix.v1.common.app.permissions" (dict "containerName" "01-permissions"
+                                                        "UID" .Values.readarrRunAs.user
+                                                        "GID" .Values.readarrRunAs.group
+                                                        "mode" "check"
+                                                        "type" "init") | nindent 8 }}
+{{- end -}}

library/ix-dev/community/readarr/templates/_service.tpl

@@ -0,0 +1,15 @@
+{{- define "readarr.service" -}}
+service:
+  readarr:
+    enabled: true
+    primary: true
+    type: NodePort
+    targetSelector: readarr
+    ports:
+      webui:
+        enabled: true
+        primary: true
+        port: {{ .Values.readarrNetwork.webPort }}
+        nodePort: {{ .Values.readarrNetwork.webPort }}
+        targetSelector: readarr
+{{- end -}}

library/ix-dev/community/readarr/templates/common.yaml

@@ -0,0 +1,11 @@
+{{- include "ix.v1.common.loader.init" . -}}
+
+{{/* Merge the templates with Values */}}
+{{- $_ := mustMergeOverwrite .Values (include "readarr.workload" $ | fromYaml) -}}
+{{- $_ := mustMergeOverwrite .Values (include "readarr.service" $ | fromYaml) -}}
+{{- $_ := mustMergeOverwrite .Values (include "readarr.persistence" $ | fromYaml) -}}
+
+{{/* Create the configmap for portal manually*/}}
+{{- include "readarr.portal" $ -}}
+
+{{- include "ix.v1.common.loader.apply" . -}}

library/ix-dev/community/readarr/upgrade_info.json

@@ -0,0 +1 @@
+{"filename": "values.yaml", "keys": ["image"]}

library/ix-dev/community/readarr/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+\.\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)))

library/ix-dev/community/readarr/values.yaml

@@ -0,0 +1,24 @@
+image:
+  repository: ghcr.io/onedr0p/readarr-develop
+  pullPolicy: IfNotPresent
+  tag: '0.1.9.1905'
+
+resources:
+  limits:
+    cpu: 4000m
+    memory: 8Gi
+
+readarrConfig:
+  instanceName: Readarr
+  additionalEnvs: []
+readarrNetwork:
+  webPort: 30045
+  hostNetwork: false
+readarrRunAs:
+  user: 568
+  group: 568
+readarrStorage:
+  config:
+    type: ixVolume
+    datasetName: config
+  additionalStorages: []