cleanup and README

Signed-off-by: Jeff Billimek <jeff@billimek.com>
This commit is contained in:
Jeff Billimek 2018-11-04 21:18:39 -05:00
parent ece73db733
commit cc39a1e347
4 changed files with 29 additions and 44 deletions

View File

@ -2,7 +2,7 @@ apiVersion: v1
appVersion: 147 appVersion: 147
description: NZBGet is a Usenet downloader client description: NZBGet is a Usenet downloader client
name: nzbget name: nzbget
version: 0.1.0 version: 0.1.1
keywords: keywords:
- nzbget - nzbget
- usenet - usenet

View File

@ -1,12 +1,12 @@
# Deluge BitTorrent client # NZBGet Usenet client
This is a helm chart for [Deluge](https://deluge-torrent.org/) leveraging the [Linuxserver.io image](https://hub.docker.com/r/linuxserver/deluge/) This is a helm chart for [NZBGet](https://nzbget.net/) leveraging the [Linuxserver.io image](https://hub.docker.com/r/linuxserver/nzbget/)
## TL;DR; ## TL;DR;
```shell ```shell
$ helm repo add billimek https://billimek.github.io/helm-repo $ helm repo add billimek https://billimek.github.io/helm-repo
$ helm install billimek/deluge $ helm install billimek/nzbget
``` ```
## Installing the Chart ## Installing the Chart
@ -14,9 +14,14 @@ $ helm install billimek/deluge
To install the chart with the release name `my-release`: To install the chart with the release name `my-release`:
```console ```console
helm install --name my-release billimek/deluge helm install --name my-release billimek/nzbget
``` ```
The default login details (change ASAP) are:
* login:nzbget
* password:tegbzn6789
## Uninstalling the Chart ## Uninstalling the Chart
To uninstall/delete the `my-release` deployment: To uninstall/delete the `my-release` deployment:
@ -36,31 +41,15 @@ The following tables lists the configurable parameters of the Sentry chart and t
| `image.repository` | Image repository | `linuxserver/nzbget` | | `image.repository` | Image repository | `linuxserver/nzbget` |
| `image.tag` | Image tag. Possible values listed [here](https://hub.docker.com/r/linuxserver/nzbget/tags/).| `147`| | `image.tag` | Image tag. Possible values listed [here](https://hub.docker.com/r/linuxserver/nzbget/tags/).| `147`|
| `image.pullPolicy` | Image pull policy | `IfNotPresent` | | `image.pullPolicy` | Image pull policy | `IfNotPresent` |
| `timezone` | Timezone the deluge instance should run as, e.g. 'America/New_York' | `UTC` | | `timezone` | Timezone the nzbget 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 nzbget instance should run as | `1001` |
| `puid` | process userID the deluge instance should run as | `1001` | | `pgid` | process groupID the nzbget instance should run as | `1001` |
| `pgid` | process groupID the deluge instance should run as | `1001` | | `Service.type` | Kubernetes service type for the nzbget GUI | `ClusterIP` |
| `guiService.type` | Kubernetes service type for the Deluge GUI | `ClusterIP` | | `Service.port` | Kubernetes port where the nzbget GUI is exposed| `6789` |
| `guiService.port` | Kubernetes port where the Deluge GUI is exposed| `8112` | | `Service.annotations` | Service annotations for the nzbget GUI | `{}` |
| `guiService.annotations` | Service annotations for the Deluge GUI | `{}` | | `Service.labels` | Custom labels | `{}` |
| `guiService.labels` | Custom labels | `{}` | | `Service.loadBalancerIP` | Loadbalance IP for the nzbget GUI | `{}` |
| `guiService.loadBalancerIP` | Loadbalance IP for the Deluge GUI | `{}` | | `Service.loadBalancerSourceRanges` | List of IP CIDRs allowed access to load balancer (if supported) | None
| `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.enabled` | Enables Ingress | `false` |
| `ingress.annotations` | Ingress annotations | `{}` | | `ingress.annotations` | Ingress annotations | `{}` |
| `ingress.labels` | Custom labels | `{}` | `ingress.labels` | Custom labels | `{}`
@ -87,19 +76,13 @@ Specify each parameter using the `--set key=value[,key=value]` argument to `helm
```console ```console
helm install --name my-release \ helm install --name my-release \
--set timezone="America/New York" \ --set timezone="America/New York" \
billimek/deluge billimek/nzbget
``` ```
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example, Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
```console ```console
helm install --name my-release -f values.yaml stable/deluge helm install --name my-release -f values.yaml stable/nzbget
``` ```
Read through the [values.yaml](values.yaml) file. It has several commented out suggested values. 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

View File

@ -17,3 +17,5 @@
echo "Visit http://127.0.0.1:8080 to use your application" echo "Visit http://127.0.0.1:8080 to use your application"
kubectl port-forward $POD_NAME 8080:80 kubectl port-forward $POD_NAME 8080:80
{{- end }} {{- end }}
The default login to the GUI is login:nzbget, password:tegbzn6789

View File

@ -1,12 +1,12 @@
apiVersion: apps/v1beta2 apiVersion: apps/v1
kind: Deployment kind: Deployment
metadata: metadata:
name: {{ include "nzbget.fullname" . }} name: {{ include "nzbget.fullname" . }}
labels: labels:
app.kubernetes.io/name: {{ include "nzbget.name" . }} app: {{ template "nzbget.name" . }}
helm.sh/chart: {{ include "nzbget.chart" . }} chart: {{ template "nzbget.chart" . }}
app.kubernetes.io/instance: {{ .Release.Name }} release: {{ .Release.Name }}
app.kubernetes.io/managed-by: {{ .Release.Service }} heritage: {{ .Release.Service }}
spec: spec:
replicas: {{ .Values.replicaCount }} replicas: {{ .Values.replicaCount }}
selector: selector: