diff --git a/nzbget/.helmignore b/nzbget/.helmignore new file mode 100644 index 00000000..f0c13194 --- /dev/null +++ b/nzbget/.helmignore @@ -0,0 +1,21 @@ +# 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 diff --git a/nzbget/Chart.yaml b/nzbget/Chart.yaml new file mode 100644 index 00000000..08161aa6 --- /dev/null +++ b/nzbget/Chart.yaml @@ -0,0 +1,16 @@ +apiVersion: v1 +appVersion: 147 +description: NZBGet is a Usenet downloader client +name: nzbget +version: 0.1.0 +keywords: + - nzbget + - usenet +home: https://nzbget.net/ +icon: https://avatars1.githubusercontent.com/u/3368377?s=400&v=4 +sources: + - https://hub.docker.com/r/linuxserver/nzbget/ + - https://github.com/billimek/billimek-charts/nzbget +maintainers: + - name: billimek + email: jeff@billimek.com diff --git a/nzbget/README.md b/nzbget/README.md new file mode 100644 index 00000000..875cae85 --- /dev/null +++ b/nzbget/README.md @@ -0,0 +1,105 @@ +# Deluge BitTorrent client + +This is a helm chart for [Deluge](https://deluge-torrent.org/) leveraging the [Linuxserver.io image](https://hub.docker.com/r/linuxserver/deluge/) + +## TL;DR; + +```shell +$ helm repo add billimek https://billimek.github.io/helm-repo +$ helm install billimek/deluge +``` + +## Installing the Chart + +To install the chart with the release name `my-release`: + +```console +helm install --name my-release billimek/deluge +``` + +## 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 + +The following tables lists the configurable parameters of the Sentry chart and their default values. + +| Parameter | Description | Default | +|----------------------------|-------------------------------------|---------------------------------------------------------| +| `image.repository` | Image repository | `linuxserver/nzbget` | +| `image.tag` | Image tag. Possible values listed [here](https://hub.docker.com/r/linuxserver/nzbget/tags/).| `147`| +| `image.pullPolicy` | Image pull policy | `IfNotPresent` | +| `timezone` | Timezone the deluge instance should run as, e.g. 'America/New_York' | `UTC` | +| `umask` | umask for file creation/manipulation - important for shared resources like the downloads persistant storage | `022` | +| `puid` | process userID the deluge instance should run as | `1001` | +| `pgid` | process groupID the deluge instance should run as | `1001` | +| `guiService.type` | Kubernetes service type for the Deluge GUI | `ClusterIP` | +| `guiService.port` | Kubernetes port where the Deluge GUI is exposed| `8112` | +| `guiService.annotations` | Service annotations for the Deluge GUI | `{}` | +| `guiService.labels` | Custom labels | `{}` | +| `guiService.loadBalancerIP` | Loadbalance IP for the Deluge GUI | `{}` | +| `guiService.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | None +| `guiService.externalTrafficPolicy` | Set the externalTrafficPolicy in the Service to either Cluster or Local | `Cluster` +| `daemonService.type` | Kubernetes service type for the deluge daemon service | `ClusterIP` | +| `daemonService.port` | Kubernetes port where the deluge daemon service is exposed | `58846` | +| `daemonService.annotations` | Service annotations for the deluge daemon service | `{}` | +| `daemonService.labels` | Custom labels | `{}` | +| `daemonService.loadBalancerIP` | Loadbalance IP for the deluge daemon service | `{}` | +| `daemonService.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | None +| `daemonService.externalTrafficPolicy` | Set the externalTrafficPolicy in the Service to either Cluster or Local | `Cluster` +| `btService.type` | Kubernetes service type for the deluge bittorrent endpoint | `NodePort` | +| `btService.port` | Kubernetes port where the deluge bittorrent endpoint is exposed | `51414` | +| `btService.annotations` | Service annotations for the deluge bittorrent endpoint | `{}` | +| `btService.labels` | Custom labels | `{}` | +| `btService.loadBalancerIP` | Loadbalance IP for the deluge bittorrent endpoint | `{}` | +| `btService.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | None +| `btService.externalTrafficPolicy` | Set the externalTrafficPolicy in the Service to either Cluster or Local | `Cluster` +| `ingress.enabled` | Enables Ingress | `false` | +| `ingress.annotations` | Ingress annotations | `{}` | +| `ingress.labels` | Custom labels | `{}` +| `ingress.path` | Ingress path | `/` | +| `ingress.hosts` | Ingress accepted hostnames | `chart-example.local` | +| `ingress.tls` | Ingress TLS configuration | `[]` | +| `persistence.config.enabled` | Use persistent volume to store configuration data | `true` | +| `persistence.config.size` | Size of persistent volume claim | `1Gi` | +| `persistence.config.existingClaim`| Use an existing PVC to persist data | `nil` | +| `persistence.config.storageClass` | Type of persistent volume claim | `-` | +| `persistence.config.accessMode` | Persistence access mode | `ReadWriteOnce` | +| `persistence.downloads.enabled` | Use persistent volume to store configuration data | `true` | +| `persistence.downloads.size` | Size of persistent volume claim | `10Gi` | +| `persistence.downloads.existingClaim`| Use an existing PVC to persist data | `nil` | +| `persistence.downloads.storageClass` | Type of persistent volume claim | `-` | +| `persistence.downloads.accessMode` | Persistence access mode | `ReadWriteOnce` | +| `resources` | CPU/Memory resource requests/limits | `{}` | +| `nodeSelector` | Node labels for pod assignment | `{}` | +| `tolerations` | Toleration labels for pod assignment | `[]` | +| `affinity` | Affinity settings for pod assignment | `{}` | + +Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, + +```console +helm install --name my-release \ + --set timezone="America/New York" \ + billimek/deluge +``` + +Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, + +```console +helm install --name my-release -f values.yaml stable/deluge +``` + +Read through the [values.yaml](values.yaml) file. It has several commented out suggested values. + +## Regarding the services + +* `guiService`: represents the main web UI and is what one would normally point the ingress to +* `daemonService`: This is used to interact with the deluge daemon server from a client other than the embeded UI +* `btService`: This used to listen for external connections from other bittorrent clients and is gernally only useful if exposed to clients outside of the kubernetes cluster \ No newline at end of file diff --git a/nzbget/templates/NOTES.txt b/nzbget/templates/NOTES.txt new file mode 100644 index 00000000..1ae6d348 --- /dev/null +++ b/nzbget/templates/NOTES.txt @@ -0,0 +1,19 @@ +1. Get the application URL by running these commands: +{{- if .Values.ingress.enabled }} +{{- range .Values.ingress.hosts }} + http{{ if $.Values.ingress.tls }}s{{ end }}://{{ . }}{{ $.Values.ingress.path }} +{{- end }} +{{- else if contains "NodePort" .Values.service.type }} + export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "nzbget.fullname" . }}) + export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}") + echo http://$NODE_IP:$NODE_PORT +{{- else if contains "LoadBalancer" .Values.service.type }} + NOTE: It may take a few minutes for the LoadBalancer IP to be available. + You can watch the status of by running 'kubectl get svc -w {{ include "nzbget.fullname" . }}' + export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "nzbget.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}') + echo http://$SERVICE_IP:{{ .Values.service.port }} +{{- else if contains "ClusterIP" .Values.service.type }} + export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "nzbget.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}") + echo "Visit http://127.0.0.1:8080 to use your application" + kubectl port-forward $POD_NAME 8080:80 +{{- end }} diff --git a/nzbget/templates/_helpers.tpl b/nzbget/templates/_helpers.tpl new file mode 100644 index 00000000..af189641 --- /dev/null +++ b/nzbget/templates/_helpers.tpl @@ -0,0 +1,32 @@ +{{/* vim: set filetype=mustache: */}} +{{/* +Expand the name of the chart. +*/}} +{{- define "nzbget.name" -}} +{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} +{{- end -}} + +{{/* +Create a default fully qualified app name. +We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). +If release name contains chart name it will be used as a full name. +*/}} +{{- define "nzbget.fullname" -}} +{{- if .Values.fullnameOverride -}} +{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- $name := default .Chart.Name .Values.nameOverride -}} +{{- if contains $name .Release.Name -}} +{{- .Release.Name | trunc 63 | trimSuffix "-" -}} +{{- else -}} +{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}} +{{- end -}} +{{- end -}} +{{- end -}} + +{{/* +Create chart name and version as used by the chart label. +*/}} +{{- define "nzbget.chart" -}} +{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} +{{- end -}} diff --git a/nzbget/templates/config-pvc.yaml b/nzbget/templates/config-pvc.yaml new file mode 100644 index 00000000..8e337965 --- /dev/null +++ b/nzbget/templates/config-pvc.yaml @@ -0,0 +1,25 @@ + +{{- if and .Values.persistence.config.enabled (not .Values.persistence.config.existingClaim) }} +kind: PersistentVolumeClaim +apiVersion: v1 +metadata: + name: {{ template "nzbget.fullname" . }}-config + labels: + app: {{ template "nzbget.fullname" . }} + chart: "{{ .Chart.Name }}-{{ .Chart.Version }}" + release: "{{ .Release.Name }}" + heritage: "{{ .Release.Service }}" +spec: + accessModes: + - {{ .Values.persistence.config.accessMode | quote }} + resources: + requests: + storage: {{ .Values.persistence.config.size | quote }} +{{- if .Values.persistence.config.storageClass }} +{{- if (eq "-" .Values.persistence.config.storageClass) }} + storageClassName: "" +{{- else }} + storageClassName: "{{ .Values.persistence.config.storageClass }}" +{{- end }} +{{- end }} +{{- end -}} \ No newline at end of file diff --git a/nzbget/templates/deployment.yaml b/nzbget/templates/deployment.yaml new file mode 100644 index 00000000..80d7ea50 --- /dev/null +++ b/nzbget/templates/deployment.yaml @@ -0,0 +1,79 @@ +apiVersion: apps/v1beta2 +kind: Deployment +metadata: + name: {{ include "nzbget.fullname" . }} + labels: + app.kubernetes.io/name: {{ include "nzbget.name" . }} + helm.sh/chart: {{ include "nzbget.chart" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} +spec: + replicas: {{ .Values.replicaCount }} + selector: + matchLabels: + app.kubernetes.io/name: {{ include "nzbget.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + template: + metadata: + labels: + app.kubernetes.io/name: {{ include "nzbget.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + spec: + containers: + - name: {{ .Chart.Name }} + image: "{{ .Values.image.repository }}:{{ .Values.image.tag }}" + imagePullPolicy: {{ .Values.image.pullPolicy }} + ports: + - name: http + containerPort: 6789 + protocol: TCP + livenessProbe: + httpGet: + port: http + readinessProbe: + httpGet: + port: http + env: + - name: TZ + value: "{{ .Values.timezone }}" + - name: PUID + value: "{{ .Values.puid }}" + - name: PGID + value: "{{ .Values.pgid }}" + volumeMounts: + - mountPath: /config + name: config + - mountPath: /downloads + name: downloads + {{- if .Values.persistence.downloads.subPath }} + subPath: {{ .Values.persistence.downloads.subPath }} + {{ end }} + resources: +{{ toYaml .Values.resources | indent 12 }} + volumes: + - name: config + {{- if .Values.persistence.config.enabled }} + persistentVolumeClaim: + claimName: {{ if .Values.persistence.config.existingClaim }}{{ .Values.persistence.config.existingClaim }}{{- else }}{{ template "nzbget.fullname" . }}-config{{- end }} + {{- else }} + emptyDir: {} + {{ end }} + - name: downloads + {{- if .Values.persistence.downloads.enabled }} + persistentVolumeClaim: + claimName: {{ if .Values.persistence.downloads.existingClaim }}{{ .Values.persistence.downloads.existingClaim }}{{- else }}{{ template "nzbget.fullname" . }}-downloads{{- end }} + {{- else }} + emptyDir: {} + {{ end }} + {{- with .Values.nodeSelector }} + nodeSelector: +{{ toYaml . | indent 8 }} + {{- end }} + {{- with .Values.affinity }} + affinity: +{{ toYaml . | indent 8 }} + {{- end }} + {{- with .Values.tolerations }} + tolerations: +{{ toYaml . | indent 8 }} + {{- end }} diff --git a/nzbget/templates/downloads-pvc.yaml b/nzbget/templates/downloads-pvc.yaml new file mode 100644 index 00000000..79e355ce --- /dev/null +++ b/nzbget/templates/downloads-pvc.yaml @@ -0,0 +1,25 @@ + +{{- if and .Values.persistence.downloads.enabled (not .Values.persistence.downloads.existingClaim) }} +kind: PersistentVolumeClaim +apiVersion: v1 +metadata: + name: {{ template "nzbget.fullname" . }}-downloads + labels: + app: {{ template "nzbget.fullname" . }} + chart: "{{ .Chart.Name }}-{{ .Chart.Version }}" + release: "{{ .Release.Name }}" + heritage: "{{ .Release.Service }}" +spec: + accessModes: + - {{ .Values.persistence.downloads.accessMode | quote }} + resources: + requests: + storage: {{ .Values.persistence.downloads.size | quote }} +{{- if .Values.persistence.downloads.storageClass }} +{{- if (eq "-" .Values.persistence.downloads.storageClass) }} + storageClassName: "" +{{- else }} + storageClassName: "{{ .Values.persistence.downloads.storageClass }}" +{{- end }} +{{- end }} +{{- end -}} \ No newline at end of file diff --git a/nzbget/templates/ingress.yaml b/nzbget/templates/ingress.yaml new file mode 100644 index 00000000..0383d9d5 --- /dev/null +++ b/nzbget/templates/ingress.yaml @@ -0,0 +1,38 @@ +{{- if .Values.ingress.enabled -}} +{{- $fullName := include "nzbget.fullname" . -}} +{{- $ingressPath := .Values.ingress.path -}} +apiVersion: extensions/v1beta1 +kind: Ingress +metadata: + name: {{ $fullName }} + labels: + app.kubernetes.io/name: {{ include "nzbget.name" . }} + helm.sh/chart: {{ include "nzbget.chart" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} +{{- with .Values.ingress.annotations }} + annotations: +{{ toYaml . | indent 4 }} +{{- end }} +spec: +{{- if .Values.ingress.tls }} + tls: + {{- range .Values.ingress.tls }} + - hosts: + {{- range .hosts }} + - {{ . | quote }} + {{- end }} + secretName: {{ .secretName }} + {{- end }} +{{- end }} + rules: + {{- range .Values.ingress.hosts }} + - host: {{ . | quote }} + http: + paths: + - path: {{ $ingressPath }} + backend: + serviceName: {{ $fullName }} + servicePort: http + {{- end }} +{{- end }} diff --git a/nzbget/templates/service.yaml b/nzbget/templates/service.yaml new file mode 100644 index 00000000..cfe565c2 --- /dev/null +++ b/nzbget/templates/service.yaml @@ -0,0 +1,19 @@ +apiVersion: v1 +kind: Service +metadata: + name: {{ include "nzbget.fullname" . }} + labels: + app.kubernetes.io/name: {{ include "nzbget.name" . }} + helm.sh/chart: {{ include "nzbget.chart" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} +spec: + type: {{ .Values.service.type }} + ports: + - port: {{ .Values.service.port }} + targetPort: http + protocol: TCP + name: http + selector: + app.kubernetes.io/name: {{ include "nzbget.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} diff --git a/nzbget/values.yaml b/nzbget/values.yaml new file mode 100644 index 00000000..e740d44c --- /dev/null +++ b/nzbget/values.yaml @@ -0,0 +1,105 @@ +# Default values for nzbget. +# This is a YAML-formatted file. +# Declare variables to be passed into your templates. + +replicaCount: 1 + +image: + repository: linuxserver/nzbget + tag: 147 + pullPolicy: IfNotPresent + +nameOverride: "" +fullnameOverride: "" + +timezone: UTC +puid: 1001 +pgid: 1001 + +service: + type: ClusterIP + port: 6789 + ## Specify the nodePort value for the LoadBalancer and NodePort service types. + ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport + ## + # nodePort: + ## Provide any additional annotations which may be required. This can be used to + ## set the LoadBalancer service type to internal only. + ## ref: https://kubernetes.io/docs/concepts/services-networking/service/#internal-load-balancer + ## + annotations: {} + labels: {} + ## Use loadBalancerIP to request a specific static IP, + ## otherwise leave blank + ## + loadBalancerIP: + # loadBalancerSourceRanges: [] + ## Set the externalTrafficPolicy in the Service to either Cluster or Local + # externalTrafficPolicy: Cluster + +ingress: + enabled: false + annotations: {} + # kubernetes.io/ingress.class: nginx + # kubernetes.io/tls-acme: "true" + path: / + hosts: + - chart-example.local + tls: [] + # - secretName: chart-example-tls + # hosts: + # - chart-example.local + +persistence: + config: + enabled: true + ## nzbget configuration data 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: "-" + ## + ## If you want to reuse an existing claim, you can pass the name of the PVC using + ## the existingClaim variable + # existingClaim: your-claim + accessMode: ReadWriteOnce + size: 1Gi + downloads: + enabled: true + ## nzbget torrents downloads volume configuration + ## 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: "-" + ## + ## If you want to reuse an existing claim, you can pass the name of the PVC using + ## the existingClaim variable + # existingClaim: your-claim + # subPath: some-subpath + accessMode: ReadWriteOnce + size: 10Gi + + +resources: {} + # We usually recommend not to specify default resources and to leave this as a conscious + # choice for the user. This also increases chances charts run on environments with little + # resources, such as Minikube. If you do want to specify resources, uncomment the following + # lines, adjust them as necessary, and remove the curly braces after 'resources:'. + # limits: + # cpu: 100m + # memory: 128Mi + # requests: + # cpu: 100m + # memory: 128Mi + +nodeSelector: {} + +tolerations: [] + +affinity: {}