Fix Jellyfin Autodiscovery (#9287)

**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->
⚒️ Fixes  # <!--(issue)-->

**⚙️ Type of change**

- [ ] ⚙️ Feature/App addition
- [X] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code

**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->
Tested with Helm install, both with autodiscovery disabled and enabled.
Autodiscovery response tested with `socat` like this:
```
$ socat - udp-datagram:255.255.255.255:7359,broadcast <<< 'who is jellyfinserver?'
{"Address":"https://jelly.mydomain.com","Id":"c57b66d1d9c246ae89ca745644f55477","Name":"jellyfin-558f6656cb-bmrxb","EndpointAddress":null}
```

**📃 Notes:**
<!-- Please enter any other relevant information here -->
* Closes #9044 
* I originally tried using
[udp-broadcast-relay-redux](https://github.com/onedr0p/containers/pkgs/container/udp-broadcast-relay-redux)
as suggested in the issue but then switched to using a lightweight
alpine container with `socat` in it, which I run as a proxy. This is for
3 reasons:
- I could not make the `udp-broadcast-relay-redux` relay back the
Jellyfin server response. As far as I can tell it does not offer such
functionality.
- `udp-broadcast-relay-redux` requires you to specify the names of the
listening and outgoing NICs which proved challenging, especially with
`hostNetworking` enabled.
- `udp-broadcast-relay-redux` cannot listen on more than one NIC (in
contrast to `socat` which listens on all NICs by default)
* ~~The changes in the `questions.yaml` are my best guess (i.e. not
tested).~~ Manually copied the changes onto a `questions.yaml` file from
the current catalog. UI renders as expected, but I haven't tried to
install the app (only copied the `questions.yaml`)



**✔️ Checklist:**

- [X] ⚖️ My code follows the style guidelines of this project
- [X] 👀 I have performed a self-review of my own code
- [X] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made corresponding changes to the documentation
- [X] ⚠️ My changes generate no new warnings
- [X] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [X] ⬆️ I increased versions for any altered app according to semantic
versioning

** App addition**

If this PR is an app addition please make sure you have done the
following.

- [ ] 🪞 I have opened a PR on
[truecharts/containers](https://github.com/truecharts/containers) adding
the container to TrueCharts mirror repo.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`

---

_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._

---------

Signed-off-by: sdimovv <36302090+sdimovv@users.noreply.github.com>
Signed-off-by: Kjeld Schouten <kjeld@schouten-lebbing.nl>
Co-authored-by: Kjeld Schouten <kjeld@schouten-lebbing.nl>
This commit is contained in:
sdimovv
2023-06-08 10:28:42 +01:00
committed by GitHub
parent f7f1ee8d12
commit 2eac6ee23d
4 changed files with 78 additions and 11 deletions

View File

@@ -22,7 +22,7 @@ sources:
- https://github.com/truecharts/charts/tree/master/charts/stable/jellyfin
- https://github.com/jellyfin/jellyfin
type: application
version: 14.0.22
version: 14.1.0
annotations:
truecharts.org/catagories: |
- media

View File

@@ -12,19 +12,18 @@ questions:
# Include{containerMain}
- variable: env
- variable: autodiscovery
group: "App Configuration"
label: "Image Environment"
label: "Autodiscovery"
schema:
additional_attrs: true
type: dict
attrs:
- variable: JELLYFIN_PublishedServerUrl
description: "Published Server URL"
label: "The Server URL to publish in UDP Auto Discovery response."
schema:
type: string
default: ""
- variable: enabled
label: "Enable Autodiscovery on LAN"
schema:
type: boolean
default: false
# Include{containerBasic}
# Include{containerAdvanced}

View File

@@ -1 +1,8 @@
{{ include "tc.v1.common.loader.all" . }}
{{- include "tc.v1.common.loader.init" . }}
{{- if .Values.autodiscovery.enabled -}}
{{/* Add proxy workload */}}
{{- $_ := set .Values.workload.broadcastproxy "enabled" true -}}
{{- end -}}
{{- include "tc.v1.common.loader.apply" . -}}

View File

@@ -2,12 +2,24 @@ image:
repository: tccr.io/truecharts/jellyfin
pullPolicy: IfNotPresent
tag: v10.8.10@sha256:d2c377ee7ea463110a1dda7eb1b231424ad05245aaf95744e76164bd2e593377
broadcastProxyImage:
repository: tccr.io/truecharts/socat
pullPolicy: IfNotPresent
tag: v1.7.4.4
service:
main:
ports:
main:
port: 8096
targetPort: 8096
autodiscovery:
enabled: true
ports:
autodiscovery:
enabled: true
protocol: udp
port: 7359
targetPort: 7359
persistence:
config:
enabled: true
@@ -32,4 +44,53 @@ workload:
containers:
main:
env:
JELLYFIN_PublishedServerUrl: "https://jelly.mydomain.com"
JELLYFIN_PublishedServerUrl: "{{ $.Values.chartContext.APPURL }}"
broadcastproxy:
enabled: false
type: DaemonSet
podSpec:
hostNetwork: true
# Proxy doesn't seem to respect the TERM signal, so by default
# this ends up just hanging until the default grace period ends.
# This is unnecesary since this workload only proxies autodiscovery
# messages.
terminationGracePeriodSeconds: 3
containers:
broadcastproxy:
enabled: true
primary: true
imageSelector: broadcastProxyImage
securityContext:
readOnlyRootFilesystem: true
command: ["/bin/sh"]
# Quite a lot going on here:
# - Resolve Jellyfin's autodiscovery service IP from its FQDN via getent hosts
# - Export the IP to `$TARGET_IP`
# - Check `$TARGET_IP` is not empty (so we can crash if it is - will help to detect templating errors)
# - Touch `/tmp/healty` to use with the readiness, liveness and startup probes
# - Start socat in proxy mode
# - On exit remove `/tmp/healthy`
args: ["-c", "export TARGET_IP=$(getent hosts '{{ printf \"%v-autodiscovery\" (include \"tc.v1.common.lib.chart.names.fullname\" $) }}' | awk '{ print $1 }') && [[ ! -z $TARGET_IP ]] && touch /tmp/healthy && socat UDP-LISTEN:7359,fork,reuseaddr,rcvbuf=8096 UDP4-SENDTO:${TARGET_IP}:7359,rcvbuf=8096 ; rm -rf /tmp/healthy"]
probes:
readiness:
enabled: true
type: exec
command:
- cat
- /tmp/healthy
liveness:
enabled: true
type: exec
command:
- cat
- /tmp/healthy
startup:
enabled: true
type: exec
command:
- cat
- /tmp/healthy
# -- enable Jellyfin autodiscovery on LAN
autodiscovery:
enabled: false