diff --git a/community/prowlarr/1.0.0/Chart.lock b/community/prowlarr/1.0.0/Chart.lock new file mode 100644 index 0000000000..d13883cc2b --- /dev/null +++ b/community/prowlarr/1.0.0/Chart.lock @@ -0,0 +1,6 @@ +dependencies: +- name: common + repository: file://../../../common + version: 1.0.10 +digest: sha256:06709bd6d9a8dbb721eec437a52f8c24aeecefbbc57e6f8617e53b29570d5512 +generated: "2023-07-05T19:27:20.84148686+03:00" diff --git a/community/prowlarr/1.0.0/Chart.yaml b/community/prowlarr/1.0.0/Chart.yaml new file mode 100644 index 0000000000..0470ceb311 --- /dev/null +++ b/community/prowlarr/1.0.0/Chart.yaml @@ -0,0 +1,25 @@ +name: prowlarr +description: Prowlarr is an indexer manager/proxy to integrate with your various PVR apps. +annotations: + title: Prowlarr +type: application +version: 1.0.0 +apiVersion: v2 +appVersion: '1.1.3.2982' +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.10 +home: https://prowlarr.com/ +icon: https://avatars.githubusercontent.com/u/73049443 +sources: + - https://github.com/onedr0p/containers/tree/main/apps/prowlarr + - https://github.com/truenas/charts/tree/master/community/prowlarr + - https://github.com/Prowlarr/Prowlarr +keywords: + - indexer diff --git a/community/prowlarr/1.0.0/README.md b/community/prowlarr/1.0.0/README.md new file mode 100644 index 0000000000..752ed81226 --- /dev/null +++ b/community/prowlarr/1.0.0/README.md @@ -0,0 +1,8 @@ +# Prowlarr + +[Prowlarr](https://github.com/Prowlarr/Prowlarr) is a music 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 `Prowlarr` directories. +> Afterward, the `Prowlarr` 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. diff --git a/community/prowlarr/1.0.0/app-readme.md b/community/prowlarr/1.0.0/app-readme.md new file mode 100644 index 0000000000..752ed81226 --- /dev/null +++ b/community/prowlarr/1.0.0/app-readme.md @@ -0,0 +1,8 @@ +# Prowlarr + +[Prowlarr](https://github.com/Prowlarr/Prowlarr) is a music 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 `Prowlarr` directories. +> Afterward, the `Prowlarr` 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. diff --git a/community/prowlarr/1.0.0/charts/common-1.0.10.tgz b/community/prowlarr/1.0.0/charts/common-1.0.10.tgz new file mode 100644 index 0000000000..5a06c22cc9 Binary files /dev/null and b/community/prowlarr/1.0.0/charts/common-1.0.10.tgz differ diff --git a/community/prowlarr/1.0.0/ci/basic-values.yaml b/community/prowlarr/1.0.0/ci/basic-values.yaml new file mode 100644 index 0000000000..56614f03df --- /dev/null +++ b/community/prowlarr/1.0.0/ci/basic-values.yaml @@ -0,0 +1,11 @@ +prowlarrNetwork: + webPort: 31000 + +prowlarrRunAs: + user: 1000 + group: 1000 + +prowlarrStorage: + config: + type: hostPath + hostPath: /mnt/{{ .Release.Namespace }}/config diff --git a/community/prowlarr/1.0.0/ci/extra-values.yaml b/community/prowlarr/1.0.0/ci/extra-values.yaml new file mode 100644 index 0000000000..bcada66290 --- /dev/null +++ b/community/prowlarr/1.0.0/ci/extra-values.yaml @@ -0,0 +1,21 @@ +prowlarrConfig: + additionalEnvs: + - name: PROWLARR__API_KEY + value: some-long-api-key + - name: PROWLARR__LOG_LEVEL + value: error + +prowlarrNetwork: + webPort: 31000 + +prowlarrStorage: + 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 diff --git a/community/prowlarr/1.0.0/ci/hostNet-values.yaml b/community/prowlarr/1.0.0/ci/hostNet-values.yaml new file mode 100644 index 0000000000..86d02a1a37 --- /dev/null +++ b/community/prowlarr/1.0.0/ci/hostNet-values.yaml @@ -0,0 +1,8 @@ +prowlarrNetwork: + webPort: 30000 + hostNetwork: true + +prowlarrStorage: + config: + type: hostPath + hostPath: /mnt/{{ .Release.Namespace }}/config diff --git a/community/prowlarr/1.0.0/ix_values.yaml b/community/prowlarr/1.0.0/ix_values.yaml new file mode 100644 index 0000000000..4569eee324 --- /dev/null +++ b/community/prowlarr/1.0.0/ix_values.yaml @@ -0,0 +1,27 @@ +image: + repository: ghcr.io/onedr0p/prowlarr-develop + pullPolicy: IfNotPresent + tag: '1.7.0.3623' + +resources: + limits: + cpu: 4000m + memory: 8Gi + +prowlarrConfig: + instanceName: Prowlarr + additionalEnvs: [] + +prowlarrNetwork: + webPort: 30050 + hostNetwork: false + +prowlarrRunAs: + user: 568 + group: 568 + +prowlarrStorage: + config: + type: ixVolume + datasetName: config + additionalStorages: [] diff --git a/community/prowlarr/1.0.0/metadata.yaml b/community/prowlarr/1.0.0/metadata.yaml new file mode 100644 index 0000000000..354e41b335 --- /dev/null +++ b/community/prowlarr/1.0.0/metadata.yaml @@ -0,0 +1,8 @@ +runAsContext: + - userName: prowlarr + groupName: prowlarr + gid: 568 + uid: 568 + description: Prowlarr can run as any non-root user. +capabilities: [] +hostMounts: [] diff --git a/community/prowlarr/1.0.0/questions.yaml b/community/prowlarr/1.0.0/questions.yaml new file mode 100644 index 0000000000..ce4abb251a --- /dev/null +++ b/community/prowlarr/1.0.0/questions.yaml @@ -0,0 +1,240 @@ +groups: + - name: Prowlarr Configuration + description: Configure Prowlarr + - name: User and Group Configuration + description: Configure User and Group for Prowlarr + - name: Network Configuration + description: Configure Network for Prowlarr + - name: Storage Configuration + description: Configure Storage for Prowlarr + - name: Resources Configuration + description: Configure Resources for Prowlarr + +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: prowlarrConfig + label: "" + group: Prowlarr Configuration + schema: + type: dict + attrs: + - variable: instanceName + label: Instance Name + description: The name of the Prowlarr instance. + schema: + type: string + default: "Prowlarr" + required: true + - variable: additionalEnvs + label: Additional Environment Variables + description: Configure additional environment variables for Prowlarr. + 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: prowlarrRunAs + label: "" + group: User and Group Configuration + schema: + type: dict + attrs: + - variable: user + label: User ID + description: The user id that Prowlarr will run as. + schema: + type: int + min: 2 + default: 568 + required: true + - variable: group + label: Group ID + description: The group id that Prowlarr will run as. + schema: + type: int + min: 2 + default: 568 + required: true + + - variable: prowlarrNetwork + label: "" + group: Network Configuration + schema: + type: dict + attrs: + - variable: webPort + label: Web Port + description: The port for the Prowlarr Web UI. + schema: + type: int + default: 30050 + min: 9000 + max: 65535 + required: true + - variable: hostNetwork + label: Host Network + description: | + Bind to the host network. It's recommended to keep this disabled.
+ schema: + type: boolean + default: false + + - variable: prowlarrStorage + label: "" + group: Storage Configuration + schema: + type: dict + attrs: + - variable: config + label: Prowlarr Config Storage + description: The path to store Prowlarr Configuration. + schema: + type: dict + attrs: + - variable: type + label: Type + description: | + ixVolume: Is dataset created automatically by the system.
+ 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 Prowlarr. + 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.
+ 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 Prowlarr. + 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
+ - Plain Integer - eg. 1
+ - Float - eg. 0.5
+ - Milicpu - eg. 500m + default: "4000m" + required: true + - variable: memory + label: Memory + description: Memory limit for Prowlarr. + 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
+ - Suffixed with E/P/T/G/M/K - eg. 1G
+ - Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi
+ - Plain Integer in bytes - eg. 1024
+ - Exponent - eg. 134e6 + default: "8Gi" + required: true diff --git a/community/prowlarr/1.0.0/templates/NOTES.txt b/community/prowlarr/1.0.0/templates/NOTES.txt new file mode 100644 index 0000000000..ba4e01146c --- /dev/null +++ b/community/prowlarr/1.0.0/templates/NOTES.txt @@ -0,0 +1 @@ +{{ include "ix.v1.common.lib.chart.notes" $ }} diff --git a/community/prowlarr/1.0.0/templates/_persistence.tpl b/community/prowlarr/1.0.0/templates/_persistence.tpl new file mode 100644 index 0000000000..d4ed2b96a0 --- /dev/null +++ b/community/prowlarr/1.0.0/templates/_persistence.tpl @@ -0,0 +1,34 @@ +{{- define "prowlarr.persistence" -}} +persistence: + config: + enabled: true + type: {{ .Values.prowlarrStorage.config.type }} + datasetName: {{ .Values.prowlarrStorage.config.datasetName | default "" }} + hostPath: {{ .Values.prowlarrStorage.config.hostPath | default "" }} + targetSelector: + prowlarr: + prowlarr: + mountPath: /config + 01-permissions: + mountPath: /mnt/directories/config + tmp: + enabled: true + type: emptyDir + targetSelector: + prowlarr: + prowlarr: + mountPath: /tmp + {{- range $idx, $storage := .Values.prowlarrStorage.additionalStorages }} + {{ printf "prowlarr-%v" (int $idx) }}: + enabled: true + type: {{ $storage.type }} + datasetName: {{ $storage.datasetName | default "" }} + hostPath: {{ $storage.hostPath | default "" }} + targetSelector: + prowlarr: + prowlarr: + mountPath: {{ $storage.mountPath }} + 01-permissions: + mountPath: /mnt/directories{{ $storage.mountPath }} + {{- end }} +{{- end -}} diff --git a/community/prowlarr/1.0.0/templates/_portal.tpl b/community/prowlarr/1.0.0/templates/_portal.tpl new file mode 100644 index 0000000000..824862aeaf --- /dev/null +++ b/community/prowlarr/1.0.0/templates/_portal.tpl @@ -0,0 +1,12 @@ +{{- define "prowlarr.portal" -}} +--- +apiVersion: v1 +kind: ConfigMap +metadata: + name: portal +data: + path: "/" + port: {{ .Values.prowlarrNetwork.webPort | quote }} + protocol: http + host: $node_ip +{{- end -}} diff --git a/community/prowlarr/1.0.0/templates/_prowlarr.tpl b/community/prowlarr/1.0.0/templates/_prowlarr.tpl new file mode 100644 index 0000000000..237ef53be8 --- /dev/null +++ b/community/prowlarr/1.0.0/templates/_prowlarr.tpl @@ -0,0 +1,49 @@ +{{- define "prowlarr.workload" -}} +workload: + prowlarr: + enabled: true + primary: true + type: Deployment + podSpec: + hostNetwork: {{ .Values.prowlarrNetwork.hostNetwork }} + containers: + prowlarr: + enabled: true + primary: true + imageSelector: image + securityContext: + runAsUser: {{ .Values.prowlarrRunAs.user }} + runAsGroup: {{ .Values.prowlarrRunAs.group }} + env: + PROWLARR__PORT: {{ .Values.prowlarrNetwork.webPort }} + PROWLARR__INSTANCE_NAME: {{ .Values.prowlarrConfig.instanceName }} + {{ with .Values.prowlarrConfig.additionalEnvs }} + envList: + {{ range $env := . }} + - name: {{ $env.name }} + value: {{ $env.value }} + {{ end }} + {{ end }} + probes: + liveness: + enabled: true + type: http + port: "{{ .Values.prowlarrNetwork.webPort }}" + path: /ping + readiness: + enabled: true + type: http + port: "{{ .Values.prowlarrNetwork.webPort }}" + path: /ping + startup: + enabled: true + type: http + port: "{{ .Values.prowlarrNetwork.webPort }}" + path: /ping + initContainers: + {{- include "ix.v1.common.app.permissions" (dict "containerName" "01-permissions" + "UID" .Values.prowlarrRunAs.user + "GID" .Values.prowlarrRunAs.group + "mode" "check" + "type" "init") | nindent 8 }} +{{- end -}} diff --git a/community/prowlarr/1.0.0/templates/_service.tpl b/community/prowlarr/1.0.0/templates/_service.tpl new file mode 100644 index 0000000000..01db2b7466 --- /dev/null +++ b/community/prowlarr/1.0.0/templates/_service.tpl @@ -0,0 +1,15 @@ +{{- define "prowlarr.service" -}} +service: + prowlarr: + enabled: true + primary: true + type: NodePort + targetSelector: prowlarr + ports: + webui: + enabled: true + primary: true + port: {{ .Values.prowlarrNetwork.webPort }} + nodePort: {{ .Values.prowlarrNetwork.webPort }} + targetSelector: prowlarr +{{- end -}} diff --git a/community/prowlarr/1.0.0/templates/common.yaml b/community/prowlarr/1.0.0/templates/common.yaml new file mode 100644 index 0000000000..97c8831665 --- /dev/null +++ b/community/prowlarr/1.0.0/templates/common.yaml @@ -0,0 +1,11 @@ +{{- include "ix.v1.common.loader.init" . -}} + +{{/* Merge the templates with Values */}} +{{- $_ := mustMergeOverwrite .Values (include "prowlarr.workload" $ | fromYaml) -}} +{{- $_ := mustMergeOverwrite .Values (include "prowlarr.persistence" $ | fromYaml) -}} +{{- $_ := mustMergeOverwrite .Values (include "prowlarr.service" $ | fromYaml) -}} + +{{/* Create the configmap for portal manually*/}} +{{- include "prowlarr.portal" $ -}} + +{{- include "ix.v1.common.loader.apply" . -}} diff --git a/community/prowlarr/item.yaml b/community/prowlarr/item.yaml new file mode 100644 index 0000000000..10485235f6 --- /dev/null +++ b/community/prowlarr/item.yaml @@ -0,0 +1,6 @@ +icon_url: https://avatars.githubusercontent.com/u/73049443 +categories: + - media +screenshots: [] +tags: + - indexer