Charmarr aims to make self-hosting a media stack in Kubernetes easy. It provides charmed versions of *arr applications (radarr, sonarr, etc) and some friends. Charms are operational wrappers, that is they configure the underlying applications themselves. So deploying Radarr, Prowlarr, SABnzbd, Gluetun. Setting a required TRaSH profile Radarr and routing the traffic of SABnzbd and Prowlarr via Gluetun VPN tunnel can be done with a few intuitive commands. An example command snippet would be sth like

# deploy the apps into my cluster
juju deploy radarr-k8s
juju deploy prowlarr-k8s
juju deploy sabnzbd-k8s
juju deploy gluetun-k8s

# tune 4k TRaSH guide profiles in my Radarr
juju config radarr-k8s variant=4k

# Route Prowlarr and SABnzbd via Gluetun
juju integrate sabnzbd-k8s gluetun-k8s
juju integrate prowlarr-k8s gluetun-k8s

This can be extended to any cross-communicating tools like Overseerr (already part of charmarr), Plex (already part of charmarr), Huntarr (planned) etc.

This also enables the using OpenTofu to deploy the entire stack using a single command:

tofu init && tofu apply

okay, 2 cmds. This way your entire media stack can have a declarative deployment using a single 20-30 line .tf file instead of multiple manifests. This sets up all applications, handles storage, handles VPN routing (you just provide your VPN credentials and media paths), connects everything together, and it’s ready in about 10 minutes. You just need to log into Plex, connect Overseerr, and add your indexers.

“But K8s is overkill for a homelab and no one needs it”

Totally agree. This is intended to make managing the media stack in a Kubernetes substrate easier for the veterans and loosening up the entry point into Kubernetes for a self-hosted media server for this who are interested in K8s. That said, it will still have some learning curve if you’re completely new to K8s.

All the tools that are part of charmarr including charmarr itself (except for Plex, which I plan to switch with or add on top of Jellyfin eventually) are open source and free to use.

Is it stable?

It’s been running in my lab for more than a month without any issues. But, I wouldn’t call it stable yet especially if you enable all the fancy bells and whistles, but I’ve been running nightly tests deploying the stack using tofu and tearing it down and it’s been consistently successful. If you’re interested in experimenting or using it, its enough that you have a Ubuntu system (I also have an oneliner to setup the required infra to deploy charmarr).

Here’s the repo - https://github.com/charmarr/charmarr

PS: sorry about the ads on the docs site. It’s hosted by readthedocs and they include ads on the free version.

Developer @4di@lemmy.ml