Zitadel sur Cloud Run — Guide de lab

📖 Guide de configuration

Vue d'ensemble

Durée estimée : 45–90 minutes

Zitadel est une plateforme open source et cloud-native de gestion des identités et des accès (IAM), qui fournit OpenID Connect, OAuth 2.0, SAML ainsi que la gestion des utilisateurs et des organisations. Ce lab vous fait parcourir le cycle de vie opérationnel complet du module Zitadel 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 supprimer.

Le lab porte sur l'exploitation du module Cloud Run et de la plateforme Google Cloud, et non sur la configuration IAM propre à Zitadel (organisations, projets, applications OIDC/SAML). 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 la durée.

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, le vérifier et vous connecter avec le compte administrateur créé d'office.
• 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, Cloud SQL, 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 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 n'exige 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). Tout autre paramètre du Guide de configuration — y compris les paramètres de mise à l'échelle et de version des tâches du jour 2 — se modifie 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). Sur 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 Zitadel (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), définissez 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, une base de données Cloud SQL for PostgreSQL 15 avec ses secrets Secret Manager (ZITADEL_MASTERKEY et le mot de passe administrateur initial, plus le mot de passe de la base de données), un bucket Cloud Storage, construit l'image de conteneur et exécute un job ponctuel d'initialisation de la base de données (db-init) qui crée la base de données et le rôle de l'application — Zitadel crée ensuite son propre schéma au premier démarrage via zitadel start-from-init. Le premier déploiement prend environ 20 à 35 minutes (la création de Cloud SQL en représente l'essentiel), et le premier démarrage lui-même peut prendre 7 à 8 minutes supplémentaires pour la mise en place du schéma et les migrations avant que la sonde de santé ne réussisse.

3. Une fois terminé, 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~zitadel" --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. Confirmez que le service est sain. Zitadel expose un point de terminaison de santé sans authentification :

   curl -s -o /dev/null -w '%{http_code}\n' "$SERVICE_URL/debug/healthz"   # expect 200

2. Récupérez dans Secret Manager le mot de passe administrateur initial créé d'office :

   gcloud secrets versions access latest \
     --secret="secret-<resource_prefix>-zitadel-admin-password" --project="$PROJECT"

   (Trouvez le nom exact du secret avec gcloud secrets list --project="$PROJECT" --filter="name~zitadel" si vous ne connaissez pas déjà le préfixe des ressources.)

3. Ouvrez $SERVICE_URL dans un navigateur et connectez-vous à la Console avec le nom d'utilisateur zitadel-admin et le mot de passe de l'étape précédente. Zitadel crée ce compte avec PASSWORDCHANGEREQUIRED = false, si bien que vous pouvez vous connecter immédiatement. Une fois connecté, créez un véritable administrateur, puis désactivez ou restreignez le compte zitadel-admin créé d'office et configurez vos organisations, projets et applications OIDC/SAML.

4. Si vous déployez derrière un domaine personnalisé (application_domains / l'équilibreur de charge), définissez ZITADEL_EXTERNALDOMAIN dans environment_variables sur cet hôte et appliquez via Update — sinon l'émetteur OIDC et les redirections de la Console pointeront vers l'hôte run.app par défaut et les connexions échoueront.

---

Tâche 3 — 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 est saine) :

   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 gère la spécification du service, si bien que la mise à l'échelle est une modification de configuration, et non une modification manuelle avec gcloud (une modification manuelle serait annulée au prochain apply). Zitadel est maintenu à chaud par défaut (min_instance_count = 1, cpu_always_allocated = true) afin que les points de terminaison de jetons n'aient aucune latence de démarrage à froid ; il est sans risque d'augmenter max_instance_count, puisque tout l'état réside dans PostgreSQL.

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. Zitadel applique ses propres migrations de schéma de manière idempotente au démarrage — il n'y a pas d'étape de migration distincte à exécuter.

4. Gérez les secrets et les sauvegardes :

   gcloud secrets list --project="$PROJECT" --filter="name~zitadel"
   gcloud run jobs list --project="$PROJECT" --region="$REGION"   # db-init job

   Ne faites pas de rotation de ZITADEL_MASTERKEY après le premier démarrage — elle chiffre toutes les données au repos, et sa rotation rend les données précédemment chiffrées (secrets clients, éléments de clés) définitivement illisibles.

5. Ouvrez une session sur la base de données pour l'inspecter ou en assurer la maintenance :

   INSTANCE=$(gcloud sql instances list --project="$PROJECT" --format="value(name)" --limit=1)
   # Role and database are tenant-prefixed (e.g. zitadeldemo426161cf) — not the bare app name.
   DB_USER=$(gcloud sql users list --instance="$INSTANCE" --project="$PROJECT" \
     --format="value(name)" --filter="name~^zitadel" --limit=1)
   gcloud sql connect "$INSTANCE" --user="$DB_USER" --project="$PROJECT"

---

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

1. Journaux — depuis la CLI ou l'explorateur de journaux (Logs Explorer). Les lignes de journal [cloud-entrypoint] indiquent le mode SSL de la base de données et le domaine externe résolus — utile pour diagnostiquer les échecs de connexion :

   gcloud run services logs read "$SERVICE" --project="$PROJECT" --region="$REGION" --limit=50
   gcloud run services logs read "$SERVICE" --project="$PROJECT" --region="$REGION" --limit=50 \
     | grep cloud-entrypoint

   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 (comportement de mise à l'échelle) et l'utilisation du CPU et de la mémoire. Le module provisionne aussi un test de disponibilité (uptime check) ; vérifiez qu'il est au vert sous Monitoring → Uptime checks, et examinez Alerting → Policies.

---

Tâche 5 — 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 Zitadel.

• Révision non saine / le service ne répond pas : inspectez la dernière révision et ses journaux à la recherche d'erreurs de démarrage, et vérifiez que les variables d'environnement et les secrets ont bien été résolus. La sonde de démarrage cible /debug/healthz et accorde environ 7 à 8 minutes au premier démarrage pour la mise en place du schéma et les migrations.

  gcloud run revisions list --service="$SERVICE" --project="$PROJECT" --region="$REGION"
  gcloud run services logs read "$SERVICE" --project="$PROJECT" --region="$REGION" --limit=100

• La connexion / l'échange de jetons échoue après le déploiement : l'émetteur OIDC et les redirections de la Console sont construits à partir de ZITADEL_EXTERNALDOMAIN. Si vous êtes derrière un domaine personnalisé ou un équilibreur de charge et que vous ne l'avez pas défini en conséquence, chaque connexion et chaque échange de jetons échoueront — définissez-le dans environment_variables et redéployez.
• Erreurs de connexion à la base de données : vérifiez que l'instance Cloud SQL est RUNNABLE, que le secret du mot de passe de la base existe et que le job d'initialisation s'est terminé avec succès.
• Échec du job d'initialisation : listez les exécutions et lisez les journaux de celle qui a échoué. Notez que ce job ne crée que la base de données et le rôle — il ne crée pas le schéma propre à Zitadel (celui-ci est créé dans le conteneur au démarrage) :

  gcloud run jobs executions list --job="${SERVICE}-db-init" \
    --project="$PROJECT" --region="$REGION"

• Échec du build de l'image : consultez l'historique de Cloud Build pour lire 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 & Sensible Defaults du Guide de configuration pour les pièges propres à chaque paramètre (y compris la règle essentielle de ne jamais faire de rotation de ZITADEL_MASTERKEY après le premier démarrage, et l'exigence obligatoire de PostgreSQL).

---

Tâche 6 — 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). Cela supprime tout ce que le module a créé — le service Cloud Run, la base de données Cloud SQL, les secrets Secret Manager, les buckets GCS et les images Artifact Registry. Les ressources appartenant à Services_GCP (le VPC, le Cloud SQL partagé, le registre) sont gérées séparément et ne sont pas supprimées ici.

---

Récapitulatif

Tâche	Type	Résultat
1 — Déployer	Automatisé	Le module provisionne Cloud Run, Cloud SQL (PostgreSQL 15), les secrets et un bucket de stockage, et exécute l'initialisation de la base
2 — Accéder et vérifier	Manuel	Le contrôle de santé réussit ; se connecter à la Console avec le compte zitadel-admin créé d'office
3 — Exploiter	Manuel	Inspecter les révisions, mettre à l'échelle, mettre à jour la version, gérer les secrets/sauvegardes, accéder à la base
4 — Observer	Manuel	Interroger Cloud Logging (y compris les lignes [cloud-entrypoint]) ; examiner les métriques Cloud Monitoring et le test de disponibilité
5 — Dépanner	Manuel	Diagnostiquer les problèmes de révision, de domaine externe, de base de données, de job d'initialisation et de build
6 — Démanteler	Automatisé	Delete (Trash) supprime toutes les ressources du module