Aller au contenu principal

AdGuardHome sur Cloud Run — Guide de lab

📖 Guide de configuration

⚠️ ESSENTIEL — ce module ne sert pas de DNS. La valeur principale d'AdGuard Home (le blocage DNS des publicités et des traceurs à l'échelle du réseau) exige que les clients l'interrogent sur le port 53 (TCP+UDP), ce que Cloud Run ne peut exposer dans aucune configuration. Ce lab déploie et vérifie uniquement la console d'administration web d'AdGuard Home — ne vous attendez pas à ce qu'il fonctionne comme un résolveur DNS opérationnel pour de vrais clients.

Vue d'ensemble​

Durée estimée : 45–60 minutes

AdGuard Home est un serveur DNS open source de blocage des publicités et des traceurs à l'échelle du réseau, doté d'une console d'administration web permettant de gérer les listes de filtres, les règles personnalisées et les paramètres propres à chaque client. Ce lab vous fait parcourir l'intégralité du cycle de vie opérationnel du module AdGuard Home on Cloud Run — déployer sa console d'administration web, la vérifier, l'exploiter au quotidien, l'observer, diagnostiquer les problèmes courants et la 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 filtrage DNS d'AdGuard Home (qui ne sont pas joignables dans cette forme de déploiement). 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 reprend 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 à la console d'administration en cours d'exécution et la vérifier (et comprendre ce qu'elle ne peut pas faire — servir un vrai DNS).
  • Effectuer les opérations du jour 2 — inspecter, mettre à l'échelle, mettre à jour et gérer le stockage.
  • 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ée : gcloud auth login et gcloud auth application-default login.
  • Le rôle IAM Project Owner (ou équivalent) sur le projet.
  • Vous utilisez 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 affichées en tant que propriétaire (Owner) du projet, puis Verify) et d'attribuer le rôle Owner au compte de service de déploiement RAD. Un projet que RAD crée pour vous ne nécessite ni l'un ni l'autre.
  • 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é.
  • 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 AdGuard Home (Cloud Run) depuis 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, deux buckets Cloud Storage (conf et work, montés via GCS Fuse) et construit l'image de conteneur personnalisée. Il n'y a ni base de données ni job d'initialisation ; ce déploiement est donc plus rapide que la plupart des modules de ce catalogue — généralement 5–10 minutes.

  3. Une fois terminé, repérez la ressource avec un filtre indépendant des noms (afin que la commande continue de fonctionner quel que soit le suffixe du déploiement) :

    SERVICE=$(gcloud run services list --project="$PROJECT" --region="$REGION" \
    --filter="metadata.name~adguardhome" --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 (web admin console ONLY — not a DNS resolver)"

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

  1. Vérifiez que le service répond :

    curl -s -o /dev/null -w '%{http_code}\n' "$SERVICE_URL/"   # expect 200
  2. Ouvrez $SERVICE_URL dans un navigateur. Lors de la première visite, AdGuard Home affiche son propre assistant de configuration (et non une connexion gérée par RAD) sur le port 3000 : choisissez le port de l'interface web d'administration (conservez 3000 — voir la note sur les pièges ci-dessous), définissez le nom d'utilisateur et le mot de passe administrateur, puis sélectionnez les serveurs DNS en amont. Terminez l'assistant pour accéder au tableau de bord.

  3. Vérifiez que la configuration a été conservée en actualisant la page — vous devriez arriver sur la page de connexion (et non de nouveau sur l'assistant de configuration), ce qui prouve que la configuration a été écrite sur le volume GCS persistant conf plutôt que perdue lors d'un démarrage à froid.

  4. N'oubliez pas : la fonction de serveur DNS de ce déploiement n'est pas joignable — seule la console d'administration web que vous venez de configurer l'est. Ne configurez pas de vrais appareils pour qu'ils utilisent l'IP ou le nom d'hôte de ce service comme serveur DNS.


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

  1. Inspectez le service et ses révisions :

    gcloud run services describe "$SERVICE" --project="$PROJECT" --region="$REGION"
    gcloud run revisions list --service="$SERVICE" --project="$PROJECT" --region="$REGION"
  2. Mettez à l'échelle en modifiant les paramètres de nombre minimal/maximal d'instances puis en cliquant sur Update sur la page de détails du déploiement — le module possède la spécification du service, la mise à l'échelle est donc une modification de configuration, et non une modification manuelle via gcloud (une modification manuelle serait annulée lors de la prochaine application).

  3. Mettez à jour le tag de 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.

  4. Inspectez le stockage :

    gcloud storage buckets list --project="$PROJECT" --filter="name~adguardhome"
    gcloud storage ls gs://<conf-bucket-name>/

Tâche 4 — 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

    Repérez la bannière de rappel sur la portée DNS affichée par le point d'entrée au début des journaux d'une nouvelle révision. 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, le nombre d'instances et l'utilisation du CPU / de la mémoire. Le module peut provisionner un test de disponibilité (uptime check) (lorsque uptime_check_config.enabled = true — la valeur par défaut est false) ; s'il est activé, vérifiez qu'il est au vert sous Monitoring → Uptime checks.


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

Des techniques durables pour les modes de défaillance que vous rencontrerez le plus probablement.

  • Révision en mauvaise santé / le service ne répond pas : inspectez la dernière révision et ses journaux à la recherche d'erreurs de démarrage.
    gcloud run revisions list --service="$SERVICE" --project="$PROJECT" --region="$REGION"
    gcloud run services logs read "$SERVICE" --project="$PROJECT" --region="$REGION" --limit=100
  • La révision ne devient plus Ready après que vous avez modifié le port de l'interface web dans l'assistant de configuration : c'est le piège connu n° 1 de ce module — la sonde de santé de la plateforme et l'URL publique sont fixées sur container_port (3000). Si vous avez remplacé le port de l'interface web d'AdGuard Home par une valeur autre que 3000 pendant la configuration, rétablissez-le (modifiez AdGuardHome.yaml dans le bucket conf, ou relancez la configuration) ou définissez container_port sur la même valeur.
  • La configuration n'est pas conservée entre les redémarrages : vérifiez que les buckets GCS conf et work existent et sont montés — vérifiez que gcs_volumes n'a pas été remplacé par une valeur qui les omet.
  • « Est-ce que cela bloque réellement les publicités sur mon réseau ? » Non — le serveur DNS de ce déploiement n'est pas joignable depuis l'extérieur du conteneur. C'est le comportement attendu ; voir la note ESSENTIEL en haut de ce guide.
  • Échec de la construction de l'image : consultez l'historique 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.

Consultez la section Configuration Pitfalls du Guide de configuration pour les pièges propres à chaque paramètre.


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

Sur la page Deployments, ouvrez le déploiement et cliquez sur l'icône Trash (Delete). Delete 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) — cela supprime le déploiement des enregistrements de RAD sans détruire les ressources cloud (RAD oublie simplement le déploiement). Delete supprime tout ce que le module a créé — le service Cloud Run, les buckets GCS (conf, work) et les images Artifact Registry. Les ressources appartenant à Services_GCP (le VPC, le registre) 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 Cloud Run, deux buckets GCS (conf, work) et construit l'image du conteneur
2 — Accéder et vérifierManuelLa vérification d'état réussit ; terminer l'assistant de configuration propre à AdGuard Home ; vérifier que la configuration est conservée
3 — ExploiterManuelInspecter les révisions, mettre à l'échelle, mettre à jour la version, inspecter le stockage
4 — ObserverManuelInterroger Cloud Logging ; consulter les métriques Cloud Monitoring et le test de disponibilité
5 — DépannerManuelDiagnostiquer les problèmes de révision, de non-concordance de port, de stockage et de build
6 — DémantelerAutomatiséDelete (Trash) supprime toutes les ressources du module

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