Aller au contenu principal

Excalidraw sur Google Cloud Run

Excalidraw sur Google Cloud Run

Excalidraw est un tableau blanc virtuel open source (MIT) permettant d'esquisser des diagrammes au style dessiné à la main, des maquettes filaires et des dessins collaboratifs rapides. La distribution auto-hébergée est une application monopage statique servie par nginx — il n'y a ni backend, ni base de données, ni comptes utilisateurs, et les dessins sont stockés dans le navigateur même du visiteur. Ce module déploie ce frontend statique sur Cloud Run v2 au-dessus du socle App_CloudRun, qui provisionne et gère l'infrastructure Google Cloud partagée.

Ce guide se concentre sur les services cloud qu'utilise Excalidraw et sur la manière de les explorer et de les exploiter depuis la console Google Cloud et la ligne de commande. Pour les mécanismes communs à toute application Cloud Run — identité du service, entrée et équilibrage de charge, mise à l'échelle et concurrence, CI/CD, Cloud Armor, IAP, Binary Authorization, VPC Service Controls et cycle de vie du déploiement — reportez-vous au guide du socle App_CloudRun plutôt que de les répéter ici.

1. Vue d'ensemble​

Excalidraw s'exécute comme un unique conteneur nginx sans état sur Cloud Run v2. L'application n'ayant pas de backend, le déploiement n'assemble qu'un ensemble minimal de services Google Cloud :

FonctionnalitéService Google CloudRemarques
CalculCloud Run v2Conteneur nginx statique sur le port 80, 1 vCPU / 512 MiB par défaut, autoscaling serverless ; mise à zéro activée
Image de conteneurArtifact RegistryFine surcouche personnalisée FROM excalidraw/excalidraw, mise en miroir dans le registre du projet
Base de donnéesAucuneExcalidraw n'a pas de backend — aucune instance Cloud SQL n'est créée
Stockage objetAucunAucun bucket GCS n'est provisionné ; les dessins résident dans le navigateur
Cache et file d'attenteAucunPas de Redis, pas de file de messages
SecretsAucunPas de clés de chiffrement, de secrets JWT ni de mots de passe de base de données — Secret Manager n'est pas utilisé
EntréeURL Cloud Run / Cloud Load BalancingURL run.app par défaut ; équilibreur de charge HTTPS externe et domaine personnalisé facultatifs

Valeurs par défaut judicieuses à connaître d'emblée :

  • Entièrement sans état — aucune donnée n'est stockée côté serveur. Les dessins persistent dans le stockage local de chaque navigateur et sont exportés/importés sous forme de fichiers .excalidraw. Les redéploiements, la mise à zéro et les changements de révision ne font perdre aucune donnée serveur, puisqu'il n'y en a pas.
  • La mise à zéro est forcée. Le wrapper épingle min_instance_count = 0 ; aucun travail en arrière-plan ne justifie de garder une instance active, si bien que les déploiements inactifs ne coûtent rien. Les démarrages à froid sont rapides (nginx servant un bundle statique) — généralement moins d'une seconde.
  • Facturation à la requête par défaut. cpu_always_allocated = false : le CPU n'est facturé que pendant le traitement d'une requête, ce qui convient à un serveur de fichiers statiques sans travail en arrière-plan dans le processus.
  • Port 80 fixe. L'écouteur nginx est intégré à l'image ; container_port vaut 80 par défaut et ne doit pas être modifié.
  • Pas de Cloud SQL, de Secret Manager, de Redis ni de GCS. Les fonctionnalités correspondantes du socle sont inertes pour cette application — les activer provisionne une infrastructure inutilisée.
  • Entrée publique par défaut. ingress_settings = "all" afin que le tableau blanc soit joignable depuis un navigateur. Placez IAP ou Cloud Armor devant si vous devez restreindre l'accès.
  • Entrées résiduelles homeserver_url / homeserver_name. Héritées du modèle Element et injectées sous la forme HOMESERVER_URL / HOMESERVER_NAME ; la SPA statique Excalidraw les ignore. Laissez-les à leurs valeurs par défaut.

2. Services Google Cloud et comment les explorer​

Toutes les commandes supposent que PROJECT et REGION sont définis. Les noms des services et des ressources figurent dans les sorties du déploiement.

A. Cloud Run — le service Excalidraw​

Excalidraw s'exécute comme un service Cloud Run v2 qui s'adapte automatiquement à la charge des requêtes entre le nombre minimal (0) et le nombre maximal d'instances. Chaque déploiement crée une révision immuable ; le trafic peut être réparti entre les révisions pour des déploiements progressifs sûrs.

  • Console : Cloud Run → sélectionnez le service pour consulter les révisions, le trafic, les journaux et les métriques.
  • CLI : 
    gcloud run services list --project "$PROJECT" --region "$REGION" \
      --filter="metadata.name~excalidraw"
    gcloud run services describe <service-name> --project "$PROJECT" --region "$REGION"
    gcloud run revisions list --service <service-name> --project "$PROJECT" --region "$REGION"
    # Confirm the listening port and image on the running revision:
    gcloud run services describe <service-name> --region "$REGION" \
      --format='value(spec.template.spec.containers[0].ports[0].containerPort, spec.template.spec.containers[0].image)'

Consultez App_CloudRun pour la mise à l'échelle, la concurrence, l'environnement d'exécution et la répartition du trafic.

B. Artifact Registry — l'image de conteneur​

L'image Excalidraw est une fine surcouche personnalisée FROM excalidraw/excalidraw que Cloud Build produit et pousse dans l'Artifact Registry du projet (enable_image_mirroring = true). Aucun pull depuis Docker Hub n'est nécessaire à l'exécution.

  • Console : Artifact Registry → Repositories.
  • CLI : 
    gcloud artifacts repositories list --project "$PROJECT" --location "$REGION"
    gcloud artifacts docker images list <repo-path> --include-tags
    # Cloud Build history for the image build:
    gcloud builds list --project "$PROJECT" --region "$REGION" --limit 5

C. Base de données, Secret Manager, Cloud Storage, Redis — non utilisés​

Excalidraw ne provisionne aucun de ces services. Il n'y a ni instance Cloud SQL, ni secret Secret Manager, ni bucket GCS, ni Redis pour ce déploiement. Les commandes suivantes renverront des résultats vides pour l'application — c'est le comportement attendu :

gcloud sql instances list --project "$PROJECT" --filter="name~excalidraw"   # (none)
gcloud secrets list --project "$PROJECT" --filter="name~excalidraw"          # (none)
gcloud storage buckets list --project "$PROJECT" --filter="name~excalidraw"  # (none)

Si vous avez besoin d'une collaboration multi-utilisateur en temps réel (un canevas partagé en direct), Excalidraw requiert un serveur WebSocket excalidraw-room distinct, que ce module ne déploie pas.

D. Réseau et entrée​

Le service est joignable par défaut à son URL run.app. Un équilibreur de charge HTTPS externe avec domaine personnalisé, Cloud CDN et Cloud Armor peut être ajouté par-dessus ; les paramètres d'entrée et la sortie VPC contrôlent la connectivité. La charge utile étant constituée d'éléments statiques, Cloud CDN est particulièrement adapté pour réduire la latence et les coûts.

  • Console : Cloud Run (URL du service) ; Network services → Load balancing.
  • CLI : 
    gcloud run services describe <service-name> --region "$REGION" --format='value(status.url)'
    gcloud compute addresses list --project "$PROJECT"

Consultez App_CloudRun.

E. Cloud Logging et Monitoring​

Les journaux des conteneurs (accès et erreurs nginx) sont envoyés à Cloud Logging ; les métriques Cloud Run sont envoyées à Cloud Monitoring, avec des tests de disponibilité et des règles d'alerte facultatifs. Un test de disponibilité public sur le chemin racine constitue un signal de santé naturel pour le frontend statique.

  • Console : Logging → Logs Explorer ; Monitoring → Dashboards / Alerting.
  • CLI : 
    gcloud run services logs read <service-name> --project "$PROJECT" --region "$REGION" --limit 50

3. Comportement de l'application Excalidraw​

  • Aucune configuration au premier déploiement. Il n'y a ni base de données, ni job d'initialisation, ni migrations. Le service est prêt dès que nginx commence à servir le bundle statique — généralement en une ou deux secondes après l'activation de la révision.
  • Pas de comptes, pas de connexion, pas de persistance serveur. Le frontend auto-hébergé n'a pas d'authentification et ne stocke rien côté serveur. Les dessins de chaque utilisateur résident dans le stockage local de son propre navigateur ; effacer les données du navigateur fait perdre les dessins locaux. Utilisez Export (.excalidraw, PNG ou SVG) pour enregistrer ou partager votre travail.
  • La collaboration en temps réel n'est pas incluse. La fonctionnalité de collaboration en direct par « lien partageable » dépend d'un service WebSocket excalidraw-room distinct que ce module ne déploie pas. L'édition mono-utilisateur fonctionne immédiatement.
  • Chemin de santé. Les sondes de démarrage et de vivacité ciblent la racine /, à laquelle nginx répond immédiatement par 200. Vérifiez depuis un navigateur ou : 
    SERVICE_URL=$(gcloud run services describe <service-name> \
      --region "$REGION" --project "$PROJECT" --format='value(status.url)')
    curl -sI "$SERVICE_URL/" | head -1          # expect: HTTP/2 200
  • Les mises à niveau de version sont un rebuild suivi d'un redéploiement. Augmenter application_version reconstruit l'image à partir d'un nouveau tag excalidraw/excalidraw et déploie une nouvelle révision ; en l'absence d'état, les mises à niveau et les retours arrière sont triviaux et non destructifs.
  • Variables d'environnement résiduelles. HOMESERVER_URL / HOMESERVER_NAME sont injectées (héritage d'Element) mais ignorées par la SPA statique. Les définir n'a aucun effet.

4. Variables de configuration​

Les variables sont regroupées exactement comme elles apparaissent sur la plateforme de déploiement. Seuls les paramètres propres à Excalidraw ou notables pour elle sont listés ; toutes les autres entrées sont héritées de App_CloudRun avec leur comportement standard.

Groupe 3 — Identité de l'application​

VariableValeur par défautDescription
application_nameexcalidrawNom de base des ressources. Ne le modifiez pas après le premier déploiement.
application_versionlatestTag de l'image Excalidraw. Contrairement à certains modules voisins, latest ne se résout pas en un tag épinglé éprouvé — la variable locale pinned_excalidraw_version d'Excalidraw_Common vaut elle-même "latest", si bien que le build suit le tag glissant excalidraw/excalidraw:latest de Docker Hub. Épinglez une version précise (p. ex. v1.11.86) en production.
homeserver_url / homeserver_name""Héritage résiduel d'Element — ignoré par la SPA Excalidraw. Laissez vide.

Toutes les autres entrées suivent le comportement standard d'App_CloudRun.

Groupe 4 — Exécution et mise à l'échelle​

VariableValeur par défautDescription
deploy_applicationtrueDéfinissez false pour ne provisionner que l'infrastructure.
container_image_sourcecustomConservez custom — la fine surcouche met en miroir l'image statique dans Artifact Registry.
cpu_limit1000mCPU par instance ; un serveur de fichiers statiques en a peu besoin.
memory_limit512MiMémoire par instance. Gen2 impose un plancher de 512 MiB ; le bundle statique en utilise bien moins.
cpu_always_allocatedfalseFacturation à la requête — adaptée à un serveur statique sans travail en arrière-plan.
container_port80Port d'écoute nginx ; intégré à l'image — ne le modifiez pas.
min_instance_count0Forcé à 0 par le wrapper — mise à zéro, aucune instance active n'est nécessaire.
max_instance_count3Plafond de coût et de concurrence.
enable_image_mirroringtrueMet en miroir l'image Excalidraw dans Artifact Registry.

Toutes les autres entrées suivent le comportement standard d'App_CloudRun.

Groupe 6 — Variables d'environnement et secrets​

VariableValeur par défautDescription
environment_variables{}Variables d'environnement supplémentaires en texte clair. La SPA statique n'en lit aucune à l'exécution ; les surcharges sont rarement utiles.
secret_environment_variables{}Inutilisé — Excalidraw n'a besoin d'aucun secret.

Toutes les autres entrées suivent le comportement standard d'App_CloudRun.

Groupe 5 — Contrôle d'accès et d'entrée​

VariableValeur par défautDescription
ingress_settingsallAccès public afin que le tableau blanc soit joignable depuis un navigateur.
enable_iapfalsePlace une connexion Google devant Excalidraw pour restreindre l'accès.

Toutes les autres entrées suivent le comportement standard d'App_CloudRun.

Groupes 10 à 21 — Stockage, base de données, Redis​

Ces groupes sont inertes pour Excalidraw : il n'y a pas de base de données (database_type = NONE), pas de bucket GCS et pas de Redis. Laisser enable_nfs, enable_redis, create_cloud_storage et les entrées de base de données à leurs valeurs par défaut ne provisionne aucune infrastructure inutilisée. Toutes les autres entrées suivent le comportement standard d'App_CloudRun.

5. Sorties​

Renvoyées lors d'un déploiement réussi — le moyen le plus rapide de localiser et d'explorer les ressources en cours d'exécution. Les sorties de stockage, de base de données et de secrets sont présentes par souci de cohérence d'interface avec les autres modules, mais se résolvent ici en valeurs vides.

SortieDescription
service_nameNom du service Cloud Run.
service_urlURL run.app par défaut du service.
service_locationRégion dans laquelle s'exécute le service.
stage_servicesDétails des services par étape (Cloud Deploy).
load_balancer_ip / load_balancer_urlIP / URL de l'équilibreur de charge HTTPS externe (lorsqu'il est activé).
storage_bucketsBuckets Cloud Storage créés — vide pour Excalidraw.
network_name / network_exists / regionsRéseau VPC, présence, régions disponibles.
container_image / container_registryImage déployée et dépôt Artifact Registry.
monitoring_enabled / monitoring_notification_channels / uptime_check_namesÉtat de la surveillance, canaux, tests de disponibilité.
initialization_jobsNoms des jobs de configuration — vide pour Excalidraw.
deployment_id / tenant_id / resource_prefixIdentifiants de nommage.
project_id / project_numberIdentifiants du projet.
cicd_enabled / github_repository_url / github_repository_owner / github_repository_name / cicd_configurationÉtat et détails de la CI/CD.
artifact_registry_repository / cloudbuild_trigger_name / cloudbuild_trigger_idRegistre et déclencheur de build.
vpc_sc_enabled / vpc_sc_perimeter_name / vpc_sc_dry_run_modeÉtat de VPC-SC.
audit_logging_enabled / artifact_registry_cmek_enabledÉtat de la journalisation d'audit et de CMEK.

6. Pièges de configuration et valeurs par défaut judicieuses​

Risque : Critique (perte de données / panne / sécurité) — Élevé (service dégradé) — Moyen (coût ou dégradation partielle) — Faible (mineur).

Validation héritée au moment du plan. Ce module fait passer sa configuration par le moteur du socle App_CloudRun, qui valide les valeurs et leurs combinaisons au moment du plan — un port hors plage, un environnement d'exécution gen1 avec des montages NFS/GCS, IAP sans identité autorisée. Une configuration invalide fait échouer le plan avec une erreur claire et nommée avant la création de toute ressource.

ParamètreValeur judicieuseRisqueConséquence en cas d'erreur
container_port80ÉlevéLe nginx de l'image n'écoute que sur 80 ; un port différent empêche la sonde de démarrage de réussir et la révision ne sert jamais de trafic.
container_image_sourcecustomÉlevéPasser à prebuilt sans image mise en miroir fait pointer le service vers un chemin Artifact Registry jamais construit (Image not found).
memory_limit512MiMoyenGen2 refuse < 512Mi à l'application ; le bundle statique n'a pas besoin de plus.
ingress_settingsallMoyeninternal rend le tableau blanc injoignable depuis un navigateur situé hors du VPC.
application_versionépingler en productionMoyenlatest est glissant — un nouveau tag amont peut modifier l'interface ou le comportement au prochain rebuild. Épinglez une version.
enable_redis / entrées de base de donnéeslaisser par défautFaibleLes activer provisionne Redis/Cloud SQL qu'Excalidraw n'utilise jamais — un coût inutile, sans bénéfice.
homeserver_url / homeserver_namelaisser videFaibleEntrées résiduelles d'Element ; les définir n'a aucun effet sur la SPA Excalidraw.
min_instance_count0FaibleLa mise à zéro est idéale ici ; forcer > 0 n'ajoute qu'un coût d'inactivité, sans aucun état à garder actif.

Pour le comportement du socle évoqué tout au long de ce guide — identité du service, mise à l'échelle et concurrence, entrée et équilibrage de charge, CI/CD, Cloud CDN, Cloud Armor, IAP, Binary Authorization, VPC-SC et mise en miroir d'images — consultez App_CloudRun. La configuration applicative propre à Excalidraw, partagée avec la variante GKE, est décrite dans Excalidraw_Common.

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

By · Google Cloud certified: ACE · PCA · PCD · PDE · PSE · CDL

Dernière mise à jour le