Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix the jellyfin chart to avoid errors when using the extra Load balancer #103

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Fix the jellyfin chart to avoid errors when using the extra Load balancer #103

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
11519f1
feat(charts): Add Transmission VPN
umbertix Feb 26, 2024
2ae7df5
fix(jellifyn): Fix the jellyfin chart to avoid errors when using the …
umbertix Apr 2, 2024
acfb05d
Merge pull request #4 from umbertix/add-vpn-for-torrent-client
umbertix Apr 2, 2024
c5da950
Merge branch 'master' into hotfix/jellyfin-load-balancer-annotations
umbertix Apr 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 54 additions & 28 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -280,34 +280,35 @@ letting some customization to fit the resource inside your cluster.

### Transmission

| Config path | Meaning | Default |
| ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| transmission.enabled | Flag if you want to enable Transmission | true |
| transmission.container.port.utp | The port in use by the container | 9091 |
| transmission.container.nodeSelector | Node Selector for the Transmission pods | {} |
| transmission.container.port.peer | The port in use by the container for peer connection | 51413 |
| transmission.container.image | The image used by the container | docker.io/linuxserver/transmission |
| transmission.container.tag | The tag used by the container | null |
| transmission.service.utp.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) for Transmission itself | ClusterIP |
| transmission.service.utp.port | The port assigned to the service for Transmission itself | 9091 |
| transmission.service.utp.nodePort | In case of service.type NodePort, the nodePort to use for Transmission itself | "" |
| transmission.service.utp.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false |
| transmission.service.peer.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) for peer port | ClusterIP |
| transmission.service.peer.port | The port assigned to the service for peer port | 51413 |
| transmission.service.peer.nodePort | In case of service.type NodePort, the nodePort to use for peer port | "" |
| transmission.service.peer.nodePortUDP | In case of service.type NodePort, the nodePort to use for peer port UDP service | "" |
| transmission.service.peer.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false |
| transmission.service.extraLBService.annotations | Instead of using extraLBService as a bool, you can use it as a map to define annotations on the loadbalancer | null |
| transmission.ingress.enabled | If true, creates the ingress resource for the application | true |
| transmission.ingress.annotations | Additional field for annotations, if needed | {} |
| transmission.ingress.path | The path where the application is exposed | /transmission |
| transmission.ingress.tls.enabled | If true, tls is enabled | false |
| transmission.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" |
| transmission.config.auth.enabled | Enables authentication for Transmission | false |
| transmission.config.auth.username | Username for Transmission | "" |
| transmission.config.auth.password | Password for Transmission | "" |
| transmission.resources | Limits and Requests for the container | {} |
| transmission.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} |
| Config path | Meaning | Default |
| ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------- |
| transmission.enabled | Flag if you want to enable Transmission | true |
| transmission.container.port.utp | The port in use by the container | 9091 |
| transmission.container.nodeSelector | Node Selector for the Transmission pods | {} |
| transmission.container.port.peer | The port in use by the container for peer connection | 51413 |
| transmission.container.image | The image used by the container | docker.io/linuxserver/transmission |
| transmission.container.tag | The tag used by the container | null |
| transmission.service.utp.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) for Transmission itself | ClusterIP |
| transmission.service.utp.port | The port assigned to the service for Transmission itself | 9091 |
| transmission.service.utp.nodePort | In case of service.type NodePort, the nodePort to use for Transmission itself | "" |
| transmission.service.utp.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false |
| transmission.service.peer.type | The kind of Service (ClusterIP/NodePort/LoadBalancer) for peer port | ClusterIP |
| transmission.service.peer.port | The port assigned to the service for peer port | 51413 |
| transmission.service.peer.nodePort | In case of service.type NodePort, the nodePort to use for peer port | "" |
| transmission.service.peer.nodePortUDP | In case of service.type NodePort, the nodePort to use for peer port UDP service | "" |
| transmission.service.peer.extraLBService | If true, creates an additional LoadBalancer service with '-lb' suffix (requires a cloud provider or metalLB) | false |
| transmission.service.extraLBService.annotations | Instead of using extraLBService as a bool, you can use it as a map to define annotations on the loadbalancer | null |
| transmission.ingress.enabled | If true, creates the ingress resource for the application | true |
| transmission.ingress.annotations | Additional field for annotations, if needed | {} |
| transmission.ingress.path | The path where the application is exposed | /transmission |
| transmission.ingress.tls.enabled | If true, tls is enabled | false |
| transmission.ingress.tls.secretName | Name of the secret holding certificates for the secure ingress | "" |
| transmission.config.auth.enabled | Enables authentication for Transmission | false |
| transmission.config.auth.username | Username for Transmission | "" |
| transmission.config.auth.password | Password for Transmission | "" |
| transmission.resources | Limits and Requests for the container | {} |
| transmission.volume | If set, Plex will create a PVC for it's config volume, else it will be put on general.storage.subPaths.config | {} |
| transmission.vpn.enabled | If set, a [gluetun](https://github.com/qdm12/gluetun-wiki) sidecar will be provisioned to route the traffic through a VPN. This requires a 3rd party VPN account | {} |

### Sabnzbd

Expand Down Expand Up @@ -376,9 +377,34 @@ plex:
service.beta.kubernetes.io/aws-load-balancer-additional-resource-tags:
```

### Setting up the VPN

If you have enabled the VPN for transmission you will need to fullfill the rest of parameters related to it, currently only [Mullvad](https://mullvad.net) VPN is supported.

The following shows an example of the current settings for mullvard.

```yaml
vpn:
enabled: true
provider: mullvad
type: openvpn
user: "XXXXXX"
city: zurich
```

## About the project

This project is intended as an exercise, and absolutely for fun.
This is not intended to promote piracy.

Also feel free to contribute and extend it!

### Uninstalling the helm chart

To fully remove all the resources created you should uninstall the helm deployment.

```bash
helm uninstall k8s-mediaserver
```

This will not delete the Custom Resources like the operator.
4 changes: 2 additions & 2 deletions helm-charts/k8s-mediaserver/Chart.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
appVersion: 0.10.0
appVersion: 0.10.2
description: A Helm chart for Kubernetes mediaserver
name: k8s-mediaserver
type: application
version: 0.10.0
version: 0.10.2
4 changes: 3 additions & 1 deletion helm-charts/k8s-mediaserver/templates/jellyfin-resources.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,8 +107,10 @@ apiVersion: v1
kind: Service
metadata:
name: jellyfin-lb
{{- with .Values.jackett.service.extraLBAnnotations }}
annotations:
{{- include .Values.jellyfin.service.extraLBService.annotations . | nindent 4 }}
{{- . | toYaml | nindent 4 }}
{{- end }}
labels:
{{- include "k8s-mediaserver.labels" . | nindent 4 }}
spec:
Expand Down
22 changes: 22 additions & 0 deletions helm-charts/k8s-mediaserver/templates/transmission-resources.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,28 @@ spec:
resources:
{{- toYaml . | nindent 12 }}
{{- end }}
{{- if .Values.transmission.vpn.enabled }}
- name: gluetun
image: ghcr.io/qdm12/gluetun # Optionally you can use the "qmcgaw/gluetun" image as well as specify what version of Gluetun you desire
imagePullPolicy: Always
securityContext:
capabilities:
add: ["NET_ADMIN"]
env:
{{- if eq .Values.transmission.vpn.provider `mullvad` }}
# https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/mullvad.md
- name: TZ
value: "Europe/London"
- name: VPN_SERVICE_PROVIDER
value: "{{ .Values.transmission.vpn.provider }}"
- name: VPN_TYPE
value: "{{ .Values.transmission.vpn.type }}"
- name: OPENVPN_USER
value: {{ .Values.transmission.vpn.user | quote }}
- name: SERVER_CITIES
value: {{ .Values.transmission.vpn.city }}
{{ end }}
{{- end }}
volumes:
{{ if not .Values.general.storage.customVolume }}
- name: mediaserver-volume
Expand Down
3 changes: 3 additions & 0 deletions helm-charts/k8s-mediaserver/values.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,8 @@ transmission:
password: ""
resources: {}
volume: {}
vpn:
enabled: false
# name: pvc-transmission-config
# storageClassName: longhorn
# annotations: {}
Expand Down Expand Up @@ -294,6 +296,7 @@ jellyfin:
nodePort:
# Defines an additional LB service, requires cloud provider service or MetalLB
extraLBService: false
extraLBAnnotations: {}
ingress:
enabled: true
annotations: {}
Expand Down
3 changes: 3 additions & 0 deletions k8s-mediaserver.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ spec:
general:
ingress_host: k8s-mediaserver.k8s.test
plex_ingress_host: k8s-plex.k8s.test
jellyfin_ingress_host: k8s-jellyfin.k8s.test
image_tag: latest
podDistribution: cluster # can be "spread" or "cluster"
#UID to run the process with
Expand Down Expand Up @@ -170,6 +171,8 @@ spec:
password: ""
resources: {}
volume: {}
vpn:
enabled: false
# name: pvc-transmission-config
# storageClassName: longhorn
# annotations: {}
Expand Down
Loading