diff --git a/community/autobrr/1.0.0/Chart.lock b/community/autobrr/1.0.0/Chart.lock new file mode 100644 index 0000000000..86a1989722 --- /dev/null +++ b/community/autobrr/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-06T14:22:53.168163066Z" diff --git a/community/autobrr/1.0.0/Chart.yaml b/community/autobrr/1.0.0/Chart.yaml new file mode 100644 index 0000000000..506f7b1d1b --- /dev/null +++ b/community/autobrr/1.0.0/Chart.yaml @@ -0,0 +1,27 @@ +name: autobrr +description: Autobrr is the modern download automation tool for torrents and usenet. +annotations: + title: Autobrr +type: application +version: 1.0.0 +apiVersion: v2 +appVersion: '1.27.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.10 +home: https://github.com/autobrr/autobrr +icon: https://github.com/autobrr/autobrr/raw/develop/.github/images/logo.png +sources: + - https://autobrr.com/installation/docker + - https://github.com/truenas/charts/tree/master/community/autobrr + - https://github.com/autobrr/autobrr +keywords: + - media + - torrent + - usenet diff --git a/community/autobrr/1.0.0/README.md b/community/autobrr/1.0.0/README.md new file mode 100644 index 0000000000..12ae0dee2d --- /dev/null +++ b/community/autobrr/1.0.0/README.md @@ -0,0 +1,8 @@ +# Autobrr + +[Autobrr](https://github.com/autobrr/autobrr) is the modern download automation tool for torrents and usenet. + +> When application is installed, a container will be launched with **root** privileges. +> This is required in order to apply the correct permissions to the `Autobrr` directories. +> Afterward, the `Autobrr` 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/autobrr/1.0.0/app-readme.md b/community/autobrr/1.0.0/app-readme.md new file mode 100644 index 0000000000..12ae0dee2d --- /dev/null +++ b/community/autobrr/1.0.0/app-readme.md @@ -0,0 +1,8 @@ +# Autobrr + +[Autobrr](https://github.com/autobrr/autobrr) is the modern download automation tool for torrents and usenet. + +> When application is installed, a container will be launched with **root** privileges. +> This is required in order to apply the correct permissions to the `Autobrr` directories. +> Afterward, the `Autobrr` 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/autobrr/1.0.0/charts/common-1.0.10.tgz b/community/autobrr/1.0.0/charts/common-1.0.10.tgz new file mode 100644 index 0000000000..3f13d72408 Binary files /dev/null and b/community/autobrr/1.0.0/charts/common-1.0.10.tgz differ diff --git a/community/autobrr/1.0.0/ci/basic-values.yaml b/community/autobrr/1.0.0/ci/basic-values.yaml new file mode 100644 index 0000000000..3350b9d216 --- /dev/null +++ b/community/autobrr/1.0.0/ci/basic-values.yaml @@ -0,0 +1,11 @@ +autobrrNetwork: + webPort: 31000 + +autobrrRunAs: + user: 1000 + group: 1000 + +autobrrStorage: + config: + type: hostPath + hostPath: /mnt/{{ .Release.Namespace }}/config diff --git a/community/autobrr/1.0.0/ci/extra-values.yaml b/community/autobrr/1.0.0/ci/extra-values.yaml new file mode 100644 index 0000000000..a2bf3cb39d --- /dev/null +++ b/community/autobrr/1.0.0/ci/extra-values.yaml @@ -0,0 +1,14 @@ +autobrrNetwork: + webPort: 31000 + +autobrrStorage: + 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/autobrr/1.0.0/ci/hostNet-values.yaml b/community/autobrr/1.0.0/ci/hostNet-values.yaml new file mode 100644 index 0000000000..7e941c7851 --- /dev/null +++ b/community/autobrr/1.0.0/ci/hostNet-values.yaml @@ -0,0 +1,8 @@ +autobrrNetwork: + webPort: 30000 + hostNetwork: true + +autobrrStorage: + config: + type: hostPath + hostPath: /mnt/{{ .Release.Namespace }}/config diff --git a/community/autobrr/1.0.0/ix_values.yaml b/community/autobrr/1.0.0/ix_values.yaml new file mode 100644 index 0000000000..9dc348bda3 --- /dev/null +++ b/community/autobrr/1.0.0/ix_values.yaml @@ -0,0 +1,26 @@ +image: + repository: ghcr.io/autobrr/autobrr + pullPolicy: IfNotPresent + tag: 'v1.27.1' + +resources: + limits: + cpu: 4000m + memory: 8Gi + +autobrrConfig: + additionalEnvs: [] + +autobrrNetwork: + webPort: 30051 + hostNetwork: false + +autobrrRunAs: + user: 568 + group: 568 + +autobrrStorage: + config: + type: ixVolume + datasetName: config + additionalStorages: [] diff --git a/community/autobrr/1.0.0/metadata.yaml b/community/autobrr/1.0.0/metadata.yaml new file mode 100644 index 0000000000..951ed73803 --- /dev/null +++ b/community/autobrr/1.0.0/metadata.yaml @@ -0,0 +1,8 @@ +runAsContext: + - userName: autobrr + groupName: autobrr + gid: 568 + uid: 568 + description: Autobrr can run as any non-root user. +capabilities: [] +hostMounts: [] diff --git a/community/autobrr/1.0.0/questions.yaml b/community/autobrr/1.0.0/questions.yaml new file mode 100644 index 0000000000..cd620c82ff --- /dev/null +++ b/community/autobrr/1.0.0/questions.yaml @@ -0,0 +1,243 @@ +groups: + - name: Autobrr Configuration + description: Configure Autobrr + - name: User and Group Configuration + description: Configure User and Group for Autobrr + - name: Network Configuration + description: Configure Network for Autobrr + - name: Storage Configuration + description: Configure Storage for Autobrr + - name: Resources Configuration + description: Configure Resources for Autobrr + +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: TZ + group: Autobrr Configuration + label: Timezone + schema: + type: string + default: Etc/UTC + required: true + $ref: + - definitions/timezone + + - variable: autobrrConfig + label: "" + group: Autobrr Configuration + schema: + type: dict + attrs: + - variable: additionalEnvs + label: Additional Environment Variables + description: Configure additional environment variables for Autobrr. + 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: autobrrRunAs + label: "" + group: User and Group Configuration + schema: + type: dict + attrs: + - variable: user + label: User ID + description: The user id that Autobrr will run as. + schema: + type: int + min: 2 + default: 568 + required: true + - variable: group + label: Group ID + description: The group id that Autobrr will run as. + schema: + type: int + min: 2 + default: 568 + required: true + + - variable: autobrrNetwork + label: "" + group: Network Configuration + schema: + type: dict + attrs: + - variable: webPort + label: Web Port + description: The port for the Autobrr Web UI. + schema: + type: int + default: 30051 + 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: autobrrStorage + label: "" + group: Storage Configuration + schema: + type: dict + attrs: + - variable: config + label: Autobrr Config Storage + description: The path to store Autobrr 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 Autobrr. + 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 Autobrr. + 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 Autobrr. + 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/autobrr/1.0.0/templates/NOTES.txt b/community/autobrr/1.0.0/templates/NOTES.txt new file mode 100644 index 0000000000..ba4e01146c --- /dev/null +++ b/community/autobrr/1.0.0/templates/NOTES.txt @@ -0,0 +1 @@ +{{ include "ix.v1.common.lib.chart.notes" $ }} diff --git a/community/autobrr/1.0.0/templates/_autobrr.tpl b/community/autobrr/1.0.0/templates/_autobrr.tpl new file mode 100644 index 0000000000..a597fb1238 --- /dev/null +++ b/community/autobrr/1.0.0/templates/_autobrr.tpl @@ -0,0 +1,49 @@ +{{- define "autobrr.workload" -}} +workload: + autobrr: + enabled: true + primary: true + type: Deployment + podSpec: + hostNetwork: {{ .Values.autobrrNetwork.hostNetwork }} + containers: + autobrr: + enabled: true + primary: true + imageSelector: image + securityContext: + runAsUser: {{ .Values.autobrrRunAs.user }} + runAsGroup: {{ .Values.autobrrRunAs.group }} + env: + AUTOBRR__PORT: {{ .Values.autobrrNetwork.webPort }} + AUTOBRR__HOST: "0.0.0.0" + {{ with .Values.autobrrConfig.additionalEnvs }} + envList: + {{ range $env := . }} + - name: {{ $env.name }} + value: {{ $env.value }} + {{ end }} + {{ end }} + probes: + liveness: + enabled: true + type: http + port: {{ .Values.autobrrNetwork.webPort }} + path: /api/healthz/liveness + readiness: + enabled: true + type: http + port: {{ .Values.autobrrNetwork.webPort }} + path: /api/healthz/readiness + startup: + enabled: true + type: http + port: {{ .Values.autobrrNetwork.webPort }} + path: /api/healthz/readiness + initContainers: + {{- include "ix.v1.common.app.permissions" (dict "containerName" "01-permissions" + "UID" .Values.autobrrRunAs.user + "GID" .Values.autobrrRunAs.group + "mode" "check" + "type" "init") | nindent 8 }} +{{- end -}} diff --git a/community/autobrr/1.0.0/templates/_persistence.tpl b/community/autobrr/1.0.0/templates/_persistence.tpl new file mode 100644 index 0000000000..b830deb3fb --- /dev/null +++ b/community/autobrr/1.0.0/templates/_persistence.tpl @@ -0,0 +1,34 @@ +{{- define "autobrr.persistence" -}} +persistence: + config: + enabled: true + type: {{ .Values.autobrrStorage.config.type }} + datasetName: {{ .Values.autobrrStorage.config.datasetName | default "" }} + hostPath: {{ .Values.autobrrStorage.config.hostPath | default "" }} + targetSelector: + autobrr: + autobrr: + mountPath: /config + 01-permissions: + mountPath: /mnt/directories/config + tmp: + enabled: true + type: emptyDir + targetSelector: + autobrr: + autobrr: + mountPath: /tmp + {{- range $idx, $storage := .Values.autobrrStorage.additionalStorages }} + {{ printf "autobrr-%v" (int $idx) }}: + enabled: true + type: {{ $storage.type }} + datasetName: {{ $storage.datasetName | default "" }} + hostPath: {{ $storage.hostPath | default "" }} + targetSelector: + autobrr: + autobrr: + mountPath: {{ $storage.mountPath }} + 01-permissions: + mountPath: /mnt/directories{{ $storage.mountPath }} + {{- end }} +{{- end -}} diff --git a/community/autobrr/1.0.0/templates/_portal.tpl b/community/autobrr/1.0.0/templates/_portal.tpl new file mode 100644 index 0000000000..f560c16347 --- /dev/null +++ b/community/autobrr/1.0.0/templates/_portal.tpl @@ -0,0 +1,12 @@ +{{- define "autobrr.portal" -}} +--- +apiVersion: v1 +kind: ConfigMap +metadata: + name: portal +data: + path: "/" + port: {{ .Values.autobrrNetwork.webPort | quote }} + protocol: http + host: $node_ip +{{- end -}} diff --git a/community/autobrr/1.0.0/templates/_service.tpl b/community/autobrr/1.0.0/templates/_service.tpl new file mode 100644 index 0000000000..30f9ffdcc2 --- /dev/null +++ b/community/autobrr/1.0.0/templates/_service.tpl @@ -0,0 +1,15 @@ +{{- define "autobrr.service" -}} +service: + autobrr: + enabled: true + primary: true + type: NodePort + targetSelector: autobrr + ports: + webui: + enabled: true + primary: true + port: {{ .Values.autobrrNetwork.webPort }} + nodePort: {{ .Values.autobrrNetwork.webPort }} + targetSelector: autobrr +{{- end -}} diff --git a/community/autobrr/1.0.0/templates/common.yaml b/community/autobrr/1.0.0/templates/common.yaml new file mode 100644 index 0000000000..8645630ba7 --- /dev/null +++ b/community/autobrr/1.0.0/templates/common.yaml @@ -0,0 +1,11 @@ +{{- include "ix.v1.common.loader.init" . -}} + +{{/* Merge the templates with Values */}} +{{- $_ := mustMergeOverwrite .Values (include "autobrr.workload" $ | fromYaml) -}} +{{- $_ := mustMergeOverwrite .Values (include "autobrr.service" $ | fromYaml) -}} +{{- $_ := mustMergeOverwrite .Values (include "autobrr.persistence" $ | fromYaml) -}} + +{{/* Create the configmap for portal manually*/}} +{{- include "autobrr.portal" $ -}} + +{{- include "ix.v1.common.loader.apply" . -}} diff --git a/community/autobrr/item.yaml b/community/autobrr/item.yaml new file mode 100644 index 0000000000..db4d47ce52 --- /dev/null +++ b/community/autobrr/item.yaml @@ -0,0 +1,8 @@ +icon_url: https://github.com/autobrr/autobrr/raw/develop/.github/images/logo.png +categories: + - media +screenshots: + - https://github.com/autobrr/autobrr/raw/develop/.github/images/autobrr-front.png +tags: + - torrent + - usenet