Aller au contenu principal

Jellyfin sur Cloud Run — Guide de lab

📖 Guide de configuration

Vue d'ensemble​

Durée estimée : 45–90 minutes

Jellyfin est un serveur multimédia gratuit, open source et auto-hébergé qui permet de diffuser vos propres films, séries, musique, photos et chaînes de télévision en direct sur n'importe quel appareil. Il est écrit en .NET et a commencé comme un fork d'Emby. Ce lab vous fait parcourir tout le cycle de vie opérationnel du module Jellyfin on Cloud Run sur Google Cloud : le déployer, y accéder et le vérifier, l'exploiter au quotidien, l'observer, diagnostiquer les problèmes courants et le démanteler.

Le lab porte sur l'exploitation du module Cloud Run et de la plateforme Google Cloud, et non sur les fonctionnalités de Jellyfin. Pour la liste complète des services provisionnés et de chaque paramètre de configuration (organisés par groupe), consultez le Guide de configuration — ce lab ne duplique volontairement pas ce détail afin de rester exact dans le temps.

Objectifs​

À la fin de ce lab, vous saurez :

  • Déployer le module depuis la plateforme RAD et repérer les ressources qu'il provisionne.
  • Accéder au service en cours d'exécution et le vérifier.
  • Terminer l'assistant de premier démarrage de Jellyfin et ajouter une médiathèque.
  • Effectuer les opérations du jour 2 — inspecter, mettre à l'échelle, mettre à jour, et gérer les secrets et les sauvegardes.
  • Observer le service avec Cloud Logging et Cloud Monitoring.
  • Diagnostiquer et résoudre les problèmes de déploiement et d'exécution les plus courants.
  • Démanteler proprement le déploiement.

Prérequis​

  • Services_GCP (fournit le VPC, Artifact Registry et les comptes de service partagés dont dépend ce module). Vous n'avez pas besoin de le déployer vous-même au préalable — la plateforme détecte automatiquement s'il existe déjà dans le projet cible et, sinon, le provisionne avant ce module (voir la tâche 1).
  • Un projet Google Cloud avec la facturation activée.
  • gcloud CLI authentifié : gcloud auth login et gcloud auth application-default login.
  • Le rôle IAM Project Owner (ou équivalent) sur le projet.
  • Vous apportez votre propre projet ? Avant le premier déploiement dans celui-ci, la boîte de dialogue de confirmation du déploiement vous demande de prouver que vous le contrôlez (Get verification code, exécutez les commandes qu'elle affiche en tant que Owner du projet, puis Verify) et d'accorder le rôle Owner au compte de service de déploiement RAD. Un projet que RAD crée pour vous ne requiert ni l'un ni l'autre.
  • Le mode avancé pour les modifications ultérieures. Le formulaire de création ne demande que la première page de paramètres (et, dans un projet que RAD crée pour vous, guère plus que le nom du tenant et la région). Tous les autres paramètres du Guide de configuration — y compris les paramètres de mise à l'échelle et de version des tâches du jour 2 — se modifient ensuite avec Update sur la page du déploiement après avoir coché Enable advanced mode, ce qui exige un solde de crédits couvrant le coût de build estimé de la mise à jour (les mises à jour n'entraînent jamais de frais de module). Dans un environnement de lab, seul un administrateur peut utiliser le mode avancé.
  • Un accès à la plateforme RAD avec l'autorisation de déployer des modules dans le projet.

Définissez une fois ces variables shell ; chaque tâche ci-dessous les réutilise :

export PROJECT="<your-gcp-project-id>"
export REGION="us-central1" # the region you deploy into

Tâche 1 — Déployer le module [Automatisé]​

  1. Dans la plateforme RAD, ouvrez Solutions → Solution Catalog → RAD modules, puis ouvrez Jellyfin (Cloud Run) dans la liste Platform Modules, choisissez Configuration Form sous How would you like to configure this deployment? (le formulaire s'ouvre sur le Conversational Assistant si vous détenez des crédits achetés ou si vous êtes partenaire ou administrateur), renseignez project_id et passez en revue les paramètres. Ne configurez que ce dont vous avez besoin — le Guide de configuration documente chaque paramètre par groupe, avec ses valeurs par défaut. Cliquez sur Deploy Module, vérifiez le coût estimé dans la boîte de dialogue Deployment Confirmation lorsqu'elle apparaît et cliquez sur Submit (si la boîte de dialogue ajoute ensuite une étape de confirmation, comme la vérification d'un projet que vous apportez, effectuez-la et cliquez sur Confirm), ce qui ouvre la page d'état du déploiement avec les journaux en temps réel.

  2. La plateforme provisionne le service Cloud Run, un bucket Cloud Storage monté sur /config via GCS FUSE (enable_gcs_storage_volume = true) pour conserver la configuration de Jellyfin, ses bases SQLite internes, les métadonnées, les plugins et le cache de transcodage, et construit l'image de conteneur (jellyfin/jellyfin, épinglée en 10.10.3 lorsque application_version = "latest"). Jellyfin n'a besoin d'aucune base de données externe — il utilise un stockage SQLite intégré sous /config ; il n'y a donc ni instance Cloud SQL ni job d'initialisation de base de données. Les premiers déploiements prennent environ 8 à 15 minutes (le build de l'image représente l'essentiel du temps).

  3. Une fois l'opération terminée, repérez les ressources avec des filtres indépendants des noms (afin que les commandes continuent de fonctionner quel que soit le suffixe du déploiement) :

    SERVICE=$(gcloud run services list --project="$PROJECT" --region="$REGION" \
    --filter="metadata.name~jellyfin" --format="value(metadata.name)" --limit=1)
    SERVICE_URL=$(gcloud run services describe "$SERVICE" \
    --project="$PROJECT" --region="$REGION" --format="value(status.url)")
    echo "Service: $SERVICE"
    echo "URL: $SERVICE_URL"

Tâche 2 — Accéder et vérifier [Manuel]​

  1. Vérifiez que le service est sain. Jellyfin expose un point de terminaison de santé non authentifié qui renvoie Healthy (200) une fois le serveur entièrement démarré :

    curl -s "$SERVICE_URL/health"   # expect: Healthy
  2. Ouvrez $SERVICE_URL dans un navigateur. Jellyfin sert son interface web sur /web (et sur /) via le port 8096 du conteneur. Lors de la première visite, vous arrivez directement dans l'assistant de configuration — il n'existe aucun identifiant par défaut ; le compte administrateur est créé pendant l'assistant (tâche 3).


Tâche 3 — Exemple guidé : terminer l'assistant et ajouter une médiathèque [Manuel]​

C'est le flux de travail central de Jellyfin. Vous allez terminer la configuration initiale, créer l'administrateur initial, ajouter une médiathèque reposant sur le volume persistant /config, puis vérifier que vous pouvez la parcourir.

  1. Terminez l'assistant de configuration. Avec $SERVICE_URL ouvert dans le navigateur :

    • Preferred display language — choisissez votre langue et cliquez sur Next.
    • Create your admin account — saisissez un nom d'utilisateur et un mot de passe robuste. Ce compte devient le propriétaire de Jellyfin ; c'est le seul administrateur tant que vous n'en ajoutez pas d'autres. Aucun identifiant pré-provisionné n'existe dans Secret Manager.
    • Setup Media Libraries — vous pouvez passer cette étape ici et ajouter une médiathèque à l'étape suivante depuis le Dashboard, ou ajouter votre première médiathèque directement.
    • Preferred metadata language / country — définissez la langue que Jellyfin utilise lorsqu'il récupère les illustrations, les descriptions et les autres métadonnées, puis Next.
    • Remote access — laissez Allow remote connections to this server activé (Cloud Run expose déjà le service en HTTPS) ; vous pouvez laisser le mappage automatique des ports désactivé. Cliquez sur Next, puis sur Finish. Jellyfin redémarre sur l'écran de connexion — connectez-vous avec le compte administrateur que vous venez de créer.
  2. Ajoutez une médiathèque. Depuis l'interface web, allez dans le menu utilisateur → Dashboard → Libraries → Add Media Library :

    • Content type — choisissez ce que contient le dossier, par exemple Movies, Shows, Music ou Photos.
    • Display name — donnez un nom à la médiathèque (par exemple Movies).
    • Folders — cliquez sur + et indiquez à Jellyfin un chemin situé sous le volume persistant, par exemple /config/media/movies. Tout ce qui se trouve sous /config repose sur le bucket GCS-FUSE et survit aux redémarrages et aux redéploiements ; un chemin hors de /config réside sur le disque éphémère du conteneur et est perdu lorsque l'instance est recyclée. Créez d'abord le dossier et déposez-y un fichier d'exemple s'il n'existe pas (voir la remarque ci-dessous sur la façon de placer des médias sur le volume).
    • Acceptez les valeurs par défaut de téléchargement des métadonnées et cliquez sur Ok, puis de nouveau sur Ok pour enregistrer la médiathèque.
  3. Analysez et récupérez les métadonnées. Jellyfin analyse automatiquement la nouvelle médiathèque ; vous pouvez forcer une analyse depuis Dashboard → Libraries → Scan All Libraries (ou le menu à trois points de la médiathèque → Scan Library). Il associe chaque fichier aux fournisseurs en ligne et télécharge titres, illustrations et descriptions dans la langue de métadonnées que vous avez choisie.

  4. Parcourez et vérifiez la lecture. Revenez à l'écran d'accueil de Jellyfin — votre nouvelle médiathèque apparaît avec ses affiches. Ouvrez-la, sélectionnez un élément et appuyez sur Play. Pour une démonstration fluide, privilégiez des médias que le client peut lire directement (direct-play : un codec/conteneur que le navigateur prend en charge nativement) : le transcodage à la volée est gourmand en CPU et il n'y a pas de GPU sur Cloud Run, si bien que le transcodage d'un fichier volumineux peut saccader avec le vCPU unique par défaut.

Placer des médias sur le volume /config : comme /config est un bucket GCS monté via FUSE, le moyen le plus simple d'y ajouter du contenu est de copier les fichiers directement dans le bucket. Trouvez le bucket et téléversez dans le chemin de médiathèque que vous avez indiqué ci-dessus :

BUCKET=$(gcloud storage buckets list --project="$PROJECT" \
--filter="name~jellyfin" --format="value(name)" | head -1)
gcloud storage cp ./my-movie.mp4 "gs://${BUCKET}/media/movies/"

GCS FUSE convient bien à un usage léger ou de démonstration ; pour une vraie médiathèque volumineuse ou un streaming intensif, la variante GKE avec un PVC en mode bloc est mieux adaptée (voir le lab Jellyfin sur GKE).


Tâche 4 — Exploiter et maintenir en service (jour 2) [Manuel]​

  1. Inspectez le service et ses révisions (chaque déploiement crée une révision immuable ; le trafic bascule vers la plus récente qui soit saine) :

    gcloud run services describe "$SERVICE" --project="$PROJECT" --region="$REGION"
    gcloud run revisions list --service="$SERVICE" --project="$PROJECT" --region="$REGION"
  2. Mise à l'échelle — conservez une instance unique. Jellyfin est une application à serveur unique avec état : ses bases SQLite et son cache de transcodage résident sur un seul volume /config et ne sont pas conçus pour des écritures concurrentes. Le module utilise par défaut min_instance_count = 1 et max_instance_count = 1 précisément pour cette raison — conservez max_instance_count = 1. Si la lecture a besoin de plus de marge, augmentez la taille verticalement (relevez cpu_limit au-delà de la valeur par défaut 1000m et memory_limit au-delà de 1Gi pour le transcodage en direct), et non horizontalement. Appliquez les modifications en éditant les paramètres et en cliquant sur Update — le module possède la spécification du service, donc une modification manuelle via gcloud serait annulée lors de la prochaine application.

  3. Mettez à jour la version de l'application en modifiant le paramètre de version dans la plateforme RAD et en l'appliquant via Update ; une nouvelle image est construite et une nouvelle révision est déployée. Comme l'état réside sur /config, la nouvelle révision retrouve vos médiathèques et vos paramètres.

  4. Gérez les secrets et les sauvegardes :

    gcloud secrets list --project="$PROJECT" --filter="name~jellyfin"
    BUCKET=$(gcloud storage buckets list --project="$PROJECT" \
    --filter="name~jellyfin" --format="value(name)" | head -1)
    gcloud storage ls "gs://${BUCKET}/"

    L'état qui compte est le volume /config — les bases SQLite ainsi que les métadonnées, les plugins et les paramètres utilisateur. Sauvegardez-le en copiant le bucket (gcloud storage cp -r "gs://${BUCKET}" gs://<backup-bucket>). Si vous avez activé la clé d'API facultative (enable_api_key = true), sa valeur de 32 caractères est stockée dans Secret Manager sous le nom secret-<prefix>-<app>-api-key ; notez que les clés d'API applicatives propres à Jellyfin se créent séparément dans Dashboard → API Keys.


Tâche 5 — Observer : journalisation et surveillance [Manuel]​

  1. Journaux — depuis la CLI ou l'explorateur de journaux (Logs Explorer) :

    gcloud run services logs read "$SERVICE" --project="$PROJECT" --region="$REGION" --limit=50

    Filtre du Logs Explorer : resource.type="cloud_run_revision" AND resource.labels.service_name="<service>".

  2. Surveillance — ouvrez le tableau de bord Cloud Run du service et examinez le nombre de requêtes, la latence des requêtes (P50/P95/P99), le nombre d'instances et l'utilisation CPU / mémoire. Surveillez le CPU pendant la lecture — une saturation prolongée signifie généralement qu'un client déclenche un transcodage et que vous devriez relever cpu_limit ou orienter les clients vers la lecture directe. Le module provisionne également un test de disponibilité (uptime check) ; vérifiez qu'il est au vert sous Monitoring → Uptime checks, et consultez Alerting → Policies.


Tâche 6 — Dépanner et déboguer [Manuel]​

Des techniques durables pour les modes de défaillance que vous rencontrerez le plus probablement. Il s'agit de diagnostics au niveau de la plateforme, qui ne changent pas avec les versions de Jellyfin.

  • Révision non saine / le service ne répond pas : examinez la dernière révision et ses journaux pour repérer les erreurs de démarrage, et vérifiez que le volume /config est monté. La sonde de démarrage cible /health, qui ne renvoie Healthy qu'une fois que le serveur a terminé l'initialisation de son stockage SQLite.
    gcloud run revisions list --service="$SERVICE" --project="$PROJECT" --region="$REGION"
    gcloud run services logs read "$SERVICE" --project="$PROJECT" --region="$REGION" --limit=100
  • Médiathèques ou paramètres disparus après un redéploiement : vérifiez que le chemin de médias que vous avez indiqué se trouve sous /config (le montage GCS-FUSE persistant). Un chemin hors de /config est éphémère et est perdu à chaque recyclage d'instance.
  • La lecture saccade ou expire : il s'agit presque toujours d'un transcodage sous une limite de 1 vCPU. Privilégiez les médias en lecture directe, ou relevez cpu_limit/memory_limit. Notez que GCS FUSE ajoute de la latence en lecture, ce qui aggrave le transcodage d'un fichier volumineux.
  • Des médias n'apparaissent pas dans une médiathèque : relancez Scan Library et vérifiez que le fichier se trouve bien dans le chemin du bucket (gcloud storage ls).
  • Échec du build de l'image : consultez l'historique de Cloud Build pour le journal du build en échec.
  • Erreurs 403 / d'autorisation : vérifiez les rôles IAM du compte de service d'exécution, y compris la lecture/écriture sur le bucket GCS-FUSE.

Consultez la section Configuration Pitfalls du Guide de configuration pour les pièges propres à chaque paramètre (notamment conserver max_instance_count = 1 et dimensionner le CPU pour le transcodage).


Tâche 7 — Démanteler [Automatisé]​

Sur la page Deployments, ouvrez le déploiement et cliquez sur l'icône Trash (Delete). La suppression exécute terraform destroy et est irréversible (l'enregistrement du déploiement est conservé pour l'historique). Si un déploiement est bloqué et que la plateforme RAD ne peut plus le gérer (par exemple après des modifications manuelles en conflit avec l'état Terraform), utilisez plutôt Purge (depuis la même boîte de dialogue Delete) — cette action retire le déploiement des enregistrements de RAD sans détruire les ressources cloud (RAD oublie le déploiement). La suppression retire tout ce que le module a créé — le service Cloud Run, le bucket GCS /config (y compris vos bases SQLite, les métadonnées et tous les médias que vous y avez copiés), les secrets Secret Manager et les images d'Artifact Registry. Si vous souhaitez conserver votre médiathèque, sauvegardez d'abord le bucket (tâche 4). Les ressources appartenant à Services_GCP (le VPC, le registre, les comptes de service partagés) sont gérées séparément et ne sont pas supprimées ici.


Récapitulatif​

TâcheTypeRésultat
1 — DéployerAutomatiséLe module provisionne le service Cloud Run, un bucket GCS-FUSE /config et construit l'image (pas de base de données externe)
2 — Accéder et vérifierManuel/health renvoie Healthy ; l'assistant de configuration se charge à l'URL du service
3 — Exemple guidéManuelTerminer l'assistant, créer l'administrateur, ajouter une médiathèque sur /config, l'analyser et la parcourir
4 — ExploiterManuelInspecter les révisions, conserver une instance unique, dimensionner le CPU, mettre à jour la version, sauvegarder /config
5 — ObserverManuelInterroger Cloud Logging ; examiner les métriques Cloud Monitoring et le test de disponibilité
6 — DépannerManuelDiagnostiquer les problèmes de révision, de persistance, de transcodage, d'analyse, de build et d'IAM
7 — DémantelerAutomatiséLa suppression (Trash) retire toutes les ressources du module, y compris le bucket /config

Need RAD to do something it does not do yet? Request it on the roadmap, or vote on what is already there.