Umami sur Google Cloud Run
Ce document fournit une référence complète pour le module Terraform modules/Umami_CloudRun. Il couvre l'architecture, la gestion des identités et des accès (IAM), les variables de configuration, les comportements spécifiques à Umami et les modèles opérationnels pour le déploiement d'Umami sur Google Cloud Run (v2).
Coût d'Umami sur RAD et comparaison
L'exécution d'Umami sur Cloud Run dans votre propre projet Google Cloud coûte environ 67,80 $ US/mois en frais Google Cloud, en plus d'un frais de module RAD unique de 75 crédits (7,50 $ US) facturé une seule fois au moment du déploiement. Umami est une plateforme d'analyse web axée sur la confidentialité, sans cookies — une alternative auto-hébergée à Google Analytics — et sa base de données Postgres représente la majeure partie de ce coût d'exécution. Dans un projet géré par RAD, les frais de module tombent à 67,5 crédits (10 % de moins) — voir Mettre en pause gratuitement ci-dessous — ou consultez le guide GKE si vous préférez l'exécuter sur Kubernetes.
Ce que vous payez sur RAD
| Votre propre projet | Projet géré par RAD | |
|---|---|---|
| Frais de module (unique) | 75 crédits | 67,5 crédits (10 % de moins) |
| Builds | Inclus dans le prix : pas de frais de build pour la création, 5 mises à jour par mois (mois calendaire UTC) gratuites, puis 2 crédits chacune, et rien pour la suppression ou pour un build échoué, dans la limite de 10 builds échoués par jour (UTC). Les sessions de lab et les projets clients font exception : ils sont toujours facturés à la minute pour le temps de build | Identique |
| Coût d'exécution Google Cloud | 67,80 $ US/mois, facturé par Google au prix catalogue | ~61 crédits/jour (environ 1 830/mois, 183 $ US au prix de la recharge), mesuré au prix catalogue plus la marge de RAD |
Votre premier déploiement réussi sur RAD est exempt de frais de module, quel que soit le montant : une fois par compte, pour un module que vous déployez et payez vous-même (dans une solution, les frais d'une application : la première à réussir ; jamais une session de lab ou un projet client).
10 crédits coûtent 1 $ US pour une recharge unique, et moins avec un plan mensuel.
Coût d'exécution par défaut dans votre propre projet
| Ressource (par défaut du module) | Par mois |
|---|---|
| Cloud Run, 1x vCPU / 0,5 GiB (scaleToZero) | 10,78 $ US |
| Cloud SQL pour PostgreSQL, 1 vCPU / 3,75 Go, zonal, 10 Go SSD | 51,02 $ US |
| Cloud NAT et réseau | 5 $ US |
| Cloud Storage (modules complémentaires, sauvegardes) | 1 $ US |
| Total | 67,80 $ US |
Comparaison
- Umami Cloud, la version hébergée d'Umami, propose un niveau Hobby gratuit (jusqu'à 100 000 événements/mois, un site web), puis Pro à 20 $/mois (1 million d'événements, jusqu'à 20 sites web) et Business à 200 $/mois (10 millions d'événements, sites web illimités), avec Enterprise sur devis — vérifié sur la page de tarification d'Umami, le 8 octobre 2026. Le coût du projet propre à RAD se situe entre Pro et Business en prix affiché, mais n'est pas mesuré par événement : les pics de trafic ne déclenchent pas de mise à niveau.
- Une comparaison avec un VPS autogéré, dimensionné aux valeurs par défaut légères d'Umami (1 vCPU / 0,5 GiB) : un Hetzner CPX11 ou un Droplet DigitalOcean 1 vCPU/2 Go coûte environ 6 à 12 $/mois — moins cher en termes monétaires, plus votre propre temps pour les sauvegardes et les correctifs Postgres, que Cloud SQL géré et Secret Manager de RAD couvrent pour vous.
- Étant donné que les plans hébergés d'Umami sont mesurés en fonction des événements de pages vues et que celui de RAD ne l'est pas, le choix le moins cher dépend entièrement du volume de trafic — RAD est plus adapté une fois qu'un site dépasse le niveau Hobby d'Umami Cloud et continue de croître.
Mettre en pause gratuitement : supprimer un projet géré par RAD, le restaurer quand vous en avez besoin
C'est l'avantage principal d'un projet géré par RAD, et il ne coûte rien lorsqu'il est en pause. La suppression d'un projet géré par RAD dissocie d'abord sa facturation, puis demande à Google de supprimer complètement le projet — la suppression logique récupérable de 30 jours de Google. Contrairement à la suppression d'un module, cela ne détruit pas Cloud SQL, aucune VM, ni la ressource de calcul une par une : l'ensemble du projet s'arrête simplement, et rien n'est facturé pendant qu'il attend, car la facturation est déjà dissociée.
Une restauration n'est pas garantie — conservez vos propres sauvegardes. Les conditions de Google Cloud ne garantissent pas qu'un projet restauré, ou les ressources qu'il contient, sera utilisable après sa restauration. Par conséquent, la restauration ne peut pas être considérée comme un moyen fiable de récupérer un projet supprimé. Avant de supprimer, assurez-vous d'avoir effectué des sauvegardes appropriées des données et de la configuration de l'application et de les avoir stockées en dehors du projet. Si une restauration échoue, ou si le projet restauré ne fonctionne pas, la solution de repli consiste à redéployer l'application (voir la section suivante) et à restaurer sa configuration et ses données à partir de ces sauvegardes.
La restauration, dans les 30 jours et uniquement par le propriétaire du projet, demande à Google de récupérer le projet et de rattacher son compte de facturation, puis vous demande d'exécuter une mise à jour sur chaque déploiement pour confirmer que tout est revenu. Comme rien n'a été détruit individuellement, cette mise à jour trouve les mêmes ressources déjà présentes — c'est une vérification, pas une reconstruction, et une mise à jour ne facture jamais les frais de module à nouveau. Les mises à jour sont incluses dans le prix (5 par mois pour chaque déploiement), donc une restauration ne coûte normalement aucun crédit.
Ce qu'il faut : vous devez être propriétaire du projet (pas un projet dont RAD gère uniquement la facturation), vous devez le restaurer vous-même dans les 30 jours — après cela, Google le supprime définitivement — et la restauration est admise comme la création d'un nouveau projet, donc votre solde de crédits achetés doit toujours dépasser le seuil du niveau (100 crédits pour le niveau sandbox que la plupart des utilisations d'étude/démo conviennent). Google affirme que la plupart des services sont entièrement fonctionnels à nouveau dans les 36 heures suivant une restauration.
Un véritable manque : les sauvegardes nocturnes sont écrites dans un bucket à l'intérieur du projet, et ce bucket a la suppression logique de Cloud Storage explicitement désactivée, il est donc très probable qu'il disparaisse dès que vous supprimez le projet — même si le projet lui-même est récupérable pendant 30 jours. Si vous avez personnalisé Umami et que vous souhaitez conserver ce travail, copiez une sauvegarde (vers Google Drive, ou un bucket en dehors du projet) avant de supprimer. Pour une installation par défaut sans rien d'irremplaçable, cela n'a pas d'importance.
Payer uniquement pendant l'utilisation, l'autre méthode : supprimer et redéployer
Dans votre propre projet, ou une fois que 30 jours se sont écoulés sur un projet géré par RAD, il n'y a pas de pause gratuite — la suppression supprime les ressources définitivement, et la remise en service d'Umami signifie un redéploiement à partir de zéro. Cela coûte environ 78 à 81 crédits dans votre propre projet, ou environ 70,5 à 73,5 crédits dans un projet géré par RAD.
La suppression ne permet d'économiser de l'argent que si Umami reste inutilisé suffisamment longtemps pour compenser ce coût de redéploiement par rapport à son propre coût d'exécution — environ 4 jours ou plus dans votre propre projet (environ 2,26 $ US par jour), ou environ 2 jours ou plus dans un projet géré par RAD (61 crédits par jour).
Conservez d'abord les données : les sauvegardes nocturnes sont stockées dans un bucket au sein du déploiement et sont supprimées avec celui-ci. Copiez donc la dernière sauvegarde avant de supprimer si vous souhaitez la conserver.
Sessions de lab et environnements gérés
Sessions de lab, pour la formation : un formateur anime une session pour une classe. Chaque participant obtient l'application dans son propre projet Google Cloud pendant 15 minutes à 24 heures, dans la limite d'une allocation définie par le formateur. Le formateur peut aussi créer un seul environnement partagé pour toute la classe, et chacun utilise alors la même application et ses données. Soit le formateur finance toutes les places, soit chaque participant paie la sienne. Tout est supprimé à la fin de la session et les crédits inutilisés sont reversés au formateur.
Environnements gérés, pour les sociétés de conseil : un partenaire exécute l'application pour un client à partir d'un portefeuille cloisonné qu'il finance, et règle directement avec le client. Si le portefeuille est faible, la facturation est suspendue et les données sont conservées, de sorte que personne ne reçoit de frais inattendus. À la fin, le partenaire transfère le projet et les déploiements deviennent la propriété du client.
Les crédits peuvent être achetés dans plus de 20 devises, y compris XAF, XOF, NGN, GHS, KES et ZAR, par carte, virement bancaire ou argent mobile.
Sources (8 octobre 2026) : Prix catalogue de l'API Google Cloud Billing Catalog ; radmodules.dev/pricing pour les frais propres à RAD et les estimations de crédits quotidiens ; documentation de Google sur la suppression/restauration de projets pour les affirmations de pause/restauration ; tarification Umami.
1. Vue d'ensemble du module
Umami est une plateforme d'analyse web open-source, légère et axée sur la confidentialité — une alternative auto-hébergée à Google Analytics. Elle collecte les données de trafic et d'événements de sites web sans cookies ni données personnelles, ce qui la rend conforme aux réglementations GDPR, CCPA et PECR dès sa sortie de l'emballage. Umami CloudRun est un module enveloppe construit sur App CloudRun. Il utilise App CloudRun pour toutes les provisions d'infrastructure GCP et injecte la configuration d'application spécifique à Umami, l'initialisation de la base de données et la gestion des secrets via Umami Common.
Capacités clés :
- Calcul : Cloud Run v2 (Gen2), conteneur Next.js, 1 vCPU / 512 Mio par défaut. Mise à l'échelle à zéro (
min_instance_count = 0) prise en charge ;max_instance_countpar défaut à 3. - Persistance des données : Cloud SQL PostgreSQL 15. Umami est un service d'analyse sans état — toutes les données résident dans PostgreSQL. Aucun stockage GCS n'est provisionné par défaut.
- Sécurité :
APP_SECRETauto-généré parUmami Commonet stocké dans Secret Manager. Hérite de Cloud Armor WAF, IAP, Binary Authorization et VPC Service Controls deApp CloudRun. - Confidentialité : Aucun cookie utilisé par défaut, aucune donnée personnelle stockée, entièrement conforme GDPR/CCPA/PECR.
- Point de terminaison de santé : Umami expose
/api/heartbeatcomme son point de terminaison de santé. Les sondes de démarrage et de vivacité ciblent ce chemin. - CI/CD : Pipeline d'images Cloud Build personnalisé par défaut ; livraison progressive Cloud Deploy en option.
- Suivi : Après le déploiement, intégrez
<script async src="https://<your-url>/script.js" data-website-id="..."></script>dans les sites web suivis.
Identité du projet et de l'application
| Variable | Groupe | Type | Valeur par défaut | Description |
|---|---|---|---|---|
project_id | 1 | string | — | ID du projet GCP. Obligatoire. |
region | 1 | string | 'us-central1' | Région GCP pour toutes les ressources. |
tenant_id | 2 | string | 'demo' | Court suffixe ajouté à tous les noms de ressources. |
support_users | 2 | list(string) | [] | Destinataires des e-mails pour les alertes de surveillance. |
resource_labels | 2 | map(string) | {} | Étiquettes appliquées à toutes les ressources provisionnées. |
application_name | 3 | string | 'umami' | Nom de ressource de base. Ne pas modifier après le déploiement initial. |
application_display_name | 3 | string | 'Umami' | Nom lisible par l'homme affiché dans la console GCP. |
application_description | 3 | string | 'Umami Analytics on Cloud Run' | Description du service Cloud Run. |
application_version | 3 | string | 'postgresql-latest' | Tag de version de l'image Umami. Utilisez un tag préfixé postgresql- (par exemple, postgresql-latest, postgresql-v2.11.3). |
Architecture de l'enveloppe : Umami CloudRun appelle Umami Common pour construire un objet application_config contenant les variables d'environnement spécifiques à Umami, la configuration des sondes et la définition du job db-init. module_secret_env_vars transporte APP_SECRET de Umami Common. Le DATABASE_URL est construit à l'exécution à partir des variables de plateforme DB_* injectées par App CloudRun. scripts_dir est résolu en abspath("${module.umami_app.path}/scripts") au moment de l'apply.
Note PostgreSQL : Umami nécessite PostgreSQL 15. database_type = "POSTGRES_15" est la valeur par défaut et ne doit pas être modifiée.
Identifiants d'administrateur par défaut : Lors du premier déploiement, connectez-vous avec le nom d'utilisateur admin et le mot de passe umami. Changez-les immédiatement après la première connexion.
2. IAM et contrôle d'accès
Umami_CloudRun délègue toutes les provisions IAM à App_CloudRun. Les ensembles de rôles du compte de service Cloud Run, du compte de service Cloud Build, de l'agent de service IAP et de la rotation de mot de passe sont identiques à ceux de App_CloudRun.
Secret d'application auto-généré : Umami Common génère APP_SECRET au moment de l'apply en utilisant random_password (32 caractères, pas de caractères spéciaux). Il est écrit dans Secret Manager et injecté dans le conteneur Cloud Run en tant que variable d'environnement APP_SECRET. Le texte en clair n'est jamais stocké dans l'état Terraform après l'apply initial.
Identité d'initialisation de la base de données : Le job Cloud Run db-init s'exécute sous le compte de service Cloud Run. Il se connecte à Cloud SQL PostgreSQL via l'intégration native de socket Cloud SQL de Cloud Run (run.googleapis.com/cloudsql-instances, puisque enable_cloudsql_volume = true par défaut), en utilisant DB_HOST (le chemin du socket sous /cloudsql), DB_USER et DB_PASSWORD (depuis Secret Manager). Cloud Run n'a pas de sidecar Auth Proxy — ce mécanisme n'existe que sur GKE.
Délai de propagation des secrets de 30 secondes : Umami Common insère une attente de propagation après la création des secrets. La variable secret_propagation_delay (30 secondes par défaut) contrôle le temps que les ressources dépendantes attendent après la création du secret avant de continuer.
Pour les tableaux de rôles complets et les détails sur IAP, la rotation de mot de passe et l'accès public, consultez App_CloudRun.
3. Configuration du service principal
A. Calcul (Cloud Run)
Umami est une application Next.js légère avec des exigences de ressources modestes. Umami CloudRun expose cpu_limit et memory_limit comme des variables de haut niveau dédiées.
La mise à l'échelle à zéro est prise en charge (min_instance_count = 0 par défaut). Les démarrages à froid d'Umami sont rapides — l'application est légère et n'a pas d'opérations de démarrage lentes.
Le Startup CPU Boost est toujours activé (codé en dur dans App CloudRun).
Image de conteneur : container_image_source est par défaut 'custom', ce qui signifie que Cloud Build construit une image wrapper qui mappe les variables d'environnement DB_* de la plateforme à DATABASE_URL d'Umami. Définissez container_image_source = 'prebuilt' et configurez DATABASE_URL manuellement pour déployer directement l'image officielle ghcr.io/umami-software/umami.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
deploy_application | 4 | true | Définissez false pour un déploiement uniquement d'infrastructure (SQL, secrets). |
container_image_source | 4 | 'custom' | 'custom' construit via Cloud Build (mappe DB_* à DATABASE_URL). 'prebuilt' déploie une URI d'image existante. |
container_image | 4 | 'ghcr.io/umami-software/umami' | Image de base. Remplacez pour utiliser une image personnalisée ou une copie en miroir. |
cpu_limit | 4 | '1000m' | CPU par instance. 1 vCPU est suffisant pour la plupart des déploiements Umami. |
memory_limit | 4 | '512Mi' | Mémoire par instance. Augmentez à 1 Gio pour les sites à fort trafic. |
min_instance_count | 4 | 0 | Instances minimales. Définissez à 1 pour éviter les démarrages à froid. |
max_instance_count | 4 | 3 | Instances maximales. Umami s'adapte horizontalement — tout l'état est dans PostgreSQL. |
container_port | 4 | 3000 | Port HTTP natif d'Umami. |
execution_environment | 4 | 'gen2' | Gen2 recommandé pour les performances. |
timeout_seconds | 4 | 300 | Durée maximale de la requête. |
enable_cloudsql_volume | 4 | true | Par défaut true — Umami se connecte via l'intégration native de socket Unix Cloud SQL de Cloud Run (pas de sidecar Auth Proxy sur Cloud Run — voir Section 3.D). |
cpu_always_allocated | 4 | false | Facturation basée sur les requêtes — le CPU est facturé uniquement pendant le traitement d'une requête. Définissez true pour allouer le CPU en permanence (facturation basée sur l'instance). |
traffic_split | 4 | [] | Allocation de trafic canary/bleu-vert basée sur un pourcentage. |
service_annotations | 4 | {} | Annotations Cloud Run avancées. |
service_labels | 4 | {} | Étiquettes appliquées au service Cloud Run. |
Différences par rapport aux valeurs par défaut de App CloudRun :
| Variable | App CloudRun | Umami CloudRun | Raison |
|---|---|---|---|
container_port | 8080 | 3000 | Port Next.js natif d'Umami. |
cpu_limit | '1000m' | '1000m' | Idem — Umami est léger. |
memory_limit | '512Mi' | '512Mi' | Idem — Umami a des besoins en mémoire modestes. |
max_instance_count | 1 | 3 | Umami s'adapte horizontalement en toute sécurité — tout l'état est dans PostgreSQL. |
B. Base de données (Cloud SQL — PostgreSQL 15)
Umami nécessite PostgreSQL 15. Le module provisionne une instance Cloud SQL PostgreSQL 15 et crée une base de données et un utilisateur dédiés pour Umami.
Construction de DATABASE_URL : Le point d'entrée personnalisé (en mode image custom) construit DATABASE_URL à partir des variables DB_HOST, DB_USER, DB_PASSWORD, DB_NAME et DB_PORT injectées par la plateforme. Cela évite de devoir passer une chaîne de connexion en texte clair.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
database_type | 12 | 'POSTGRES_15' | Moteur Cloud SQL. Doit être POSTGRES_15 pour Umami. |
application_database_name | 12 | 'umami' | Nom de la base de données PostgreSQL. Ne pas modifier après le déploiement initial. |
application_database_user | 12 | 'umami' | Utilisateur de l'application PostgreSQL. Mot de passe auto-généré et stocké dans Secret Manager. |
database_password_length | 12 | 32 | Longueur du mot de passe auto-généré. Plage : 16–64. |
enable_auto_password_rotation | 12 | false | Rotation automatique du mot de passe sans interruption. |
rotation_propagation_delay_sec | 12 | 90 | Secondes à attendre après la rotation avant de redémarrer le service. |
enable_postgres_extensions | 12 | false | Active l'installation d'extensions PostgreSQL après le provisionnement. |
postgres_extensions | 12 | [] | Extensions PostgreSQL à installer (par exemple, ['uuid-ossp']). |
C. Stockage (GCS)
Pas de stockage par défaut. Umami est un service d'analyse sans état — toutes les données résident dans PostgreSQL. storage_buckets est par défaut une liste vide. Provisionnez des buckets supplémentaires uniquement si nécessaire pour des cas d'utilisation personnalisés (par exemple, exportations de sauvegarde).
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
create_cloud_storage | 11 | true | Contrôle si le module provisionne les buckets GCS définis dans storage_buckets. |
storage_buckets | 11 | [] | Buckets GCS à provisionner. Vide par défaut — Umami ne nécessite pas de stockage de fichiers. |
enable_nfs | 11 | false | Provisionne une instance NFS Cloud Filestore. Non requis pour Umami. |
nfs_mount_path | 11 | '/mnt/nfs' | Chemin du conteneur où NFS est monté. Utilisé uniquement lorsque enable_nfs = true. |
gcs_volumes | 11 | [] | Buckets GCS à monter via GCS Fuse (nécessite gen2). |
manage_storage_kms_iam | 11 | false | Crée un trousseau de clés KMS CMEK et active CMEK sur tous les buckets de stockage. |
enable_artifact_registry_cmek | 11 | false | Crée une clé KMS Artifact Registry pour le chiffrement des images au repos. |
D. Réseau
Cloud Run utilise Direct VPC Egress pour atteindre l'IP interne de Cloud SQL. Étant donné que enable_cloudsql_volume = true est la valeur par défaut, l'intégration native Cloud SQL de Cloud Run (annotation run.googleapis.com/cloudsql-instances) monte un socket Unix à /cloudsql/<proj:region:inst> et injecte DB_HOST comme répertoire de ce socket. Il n'y a pas de sidecar Auth Proxy et pas de listener TCP 127.0.0.1:5432 sur Cloud Run — ce mécanisme n'existe que sur GKE, où un véritable sidecar cloud-sql-proxy écoute sur le bouclage. Le point d'entrée Umami_Common (scripts/umami-entrypoint.sh, partagé avec Umami_GKE) résout un chemin de socket DB_HOST en 127.0.0.1 avant d'assembler DATABASE_URL — un mappage qui n'est valide que sur GKE. Sur Cloud Run, cela donne ECONNREFUSED 127.0.0.1:5432 et un échec de la sonde de démarrage. Voir le tableau des pièges de configuration ci-dessous.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
ingress_settings | 5 | 'all' | 'all' — internet public ; 'internal' — VPC uniquement ; 'internal-and-cloud-load-balancing' — force le trafic via l'équilibreur de charge HTTPS. |
vpc_egress_setting | 5 | 'PRIVATE_RANGES_ONLY' | 'PRIVATE_RANGES_ONLY' achemine uniquement le trafic RFC 1918 via VPC. 'ALL_TRAFFIC' achemine toutes les sorties via VPC. |
E. Initialisation et amorçage
Un job Cloud Run db-init est automatiquement provisionné par Umami Common lorsque initialization_jobs est laissé comme liste vide par défaut ([]). Il utilise une image client PostgreSQL et exécute Umami_Common/scripts/db-init.sh, qui effectue les opérations idempotentes suivantes :
- Se connecte à Cloud SQL PostgreSQL via l'intégration native de socket Unix Cloud SQL de Cloud Run (pas de sidecar Auth Proxy sur Cloud Run — voir Section 3.D).
- Crée l'utilisateur de base de données
umamiavec le mot de passe de Secret Manager. - Crée la base de données
umamisi elle n'existe pas. - Accorde à l'utilisateur
umamitous les privilèges sur la base de données.
Umami exécute lui-même ses propres migrations de base de données basées sur Prisma lors du premier démarrage — le job db-init ne fait que pré-créer la base de données et l'utilisateur afin que les migrations d'Umami puissent s'exécuter avec succès.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
initialization_jobs | 13 | [] | Jobs Cloud Run ponctuels. Laissez vide pour que Umami Common fournisse le job db-init par défaut. Une liste non vide le remplace entièrement. |
cron_jobs | 13 | [] | Jobs récurrents déclenchés par Cloud Scheduler. |
additional_services | 13 | [] | Services Cloud Run supplémentaires déployés en parallèle de l'application principale. |
4. Sécurité avancée
A. Cloud Armor WAF
Lorsque enable_cloud_armor = true, un équilibreur de charge HTTPS global avec une politique Cloud Armor WAF (OWASP Top 10, DDoS adaptatif, limitation de débit à 500 requêtes/min) est provisionné devant Cloud Run.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
enable_cloud_armor | 10 | false | Provisionne un équilibreur de charge HTTPS global + Cloud Armor WAF. Requis pour les domaines personnalisés, le CDN et la protection DDoS. |
admin_ip_ranges | 10 | [] | Plages CIDR exemptées des règles WAF (par exemple, VPN de bureau, adresses IP de sortie CI/CD). |
B. Proxy conscient de l'identité (IAP)
Lorsque enable_iap = true, l'intégration IAP native de Cloud Run est activée directement sur le service. L'authentification d'identité Google est requise avant que les requêtes n'atteignent Umami. Utile pour restreindre l'accès aux analyses aux seuls membres de l'équipe interne.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
enable_iap | 5 | false | Active IAP nativement sur le service Cloud Run. |
iap_authorized_users | 5 | [] | Utilisateurs/comptes de service ayant accès. Format : 'user:email' ou 'serviceAccount:sa@...'. |
iap_authorized_groups | 5 | [] | Groupes Google ayant accès. Format : 'group:name@example.com'. |
Note : IAP protège le tableau de bord Umami. Le script de suivi (/script.js) et le point de terminaison d'événement (/api/send) doivent rester accessibles au public pour que les sites web suivis puissent rapporter des données. Si vous appliquez IAP, assurez-vous que les chemins de suivi sont exemptés ou utilisez une configuration d'entrée distincte.
C. Autorisation binaire
Lorsque enable_binary_authorization = true, Cloud Run impose que les images déployées portent une attestation cryptographique valide.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
enable_binary_authorization | 8 | false | Applique l'attestation d'image. Nécessite une politique d'autorisation binaire et un attestateur préconfigurés dans le projet. |
D. Contrôles de service VPC
Lorsque enable_vpc_sc = true, tous les appels d'API GCP de ce module sont liés à un périmètre VPC-SC existant.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
enable_vpc_sc | 22 | false | Enregistre les appels d'API du module dans le périmètre VPC-SC du projet. Un périmètre doit déjà exister avant l'activation. |
E. Intégration de Secret Manager
Le APP_SECRET d'Umami est stocké dans Secret Manager et injecté nativement par Cloud Run au démarrage de la révision — le texte en clair n'est jamais écrit dans l'état Terraform.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
secret_environment_variables | 6 | {} | Mappage nom de variable d'environnement → ID de secret Secret Manager. Résolu à l'exécution ; jamais stocké dans l'état. |
secret_rotation_period | 6 | '2592000s' | Fréquence à laquelle Secret Manager émet des notifications de rotation. Par défaut : 30 jours. |
secret_propagation_delay | 6 | 30 | Secondes à attendre après la création du secret avant que les ressources dépendantes ne continuent. |
5. Trafic et entrée
A. Équilibreur de charge HTTPS
Lorsque enable_cloud_armor = true, un équilibreur de charge HTTPS global soutenu par un NEG sans serveur est provisionné. Le trafic circule : Internet → Cloud Armor → Équilibreur de charge HTTPS global → NEG sans serveur → Cloud Run.
La définition de ingress_settings = 'internal-and-cloud-load-balancing' force tout le trafic Umami à passer par l'équilibreur de charge, empêchant l'accès direct à l'URL *.run.app.
Voir App_CloudRun pour les détails complets de l'architecture.
B. Cloud CDN
Lorsque enable_cdn = true (nécessite enable_cloud_armor = true), Cloud CDN est attaché au backend de l'équilibreur de charge HTTPS.
Considération Umami : Le tableau de bord d'Umami est une application Next.js dynamique. Cloud CDN est utile pour mettre en cache les ressources statiques d'Umami (bundles JavaScript, CSS) mais ne doit pas mettre en cache les réponses API (/api/*) qui contiennent des données d'analyse en direct. Assurez-vous que les en-têtes Cache-Control appropriés sont définis.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
enable_cdn | 10 | false | Active Cloud CDN sur le backend de l'équilibreur de charge HTTPS. N'est efficace que lorsque enable_cloud_armor = true. |
max_images_to_retain | 10 | 7 | Nombre maximal d'images de conteneurs récentes à conserver dans Artifact Registry. Définissez 0 pour désactiver. |
delete_untagged_images | 10 | true | Supprime automatiquement les images non taguées (pendantes) d'Artifact Registry. |
image_retention_days | 10 | 30 | Jours après lesquels les images sont éligibles à la suppression. Définissez 0 pour désactiver la suppression basée sur l'âge. |
C. Domaines personnalisés
Les domaines personnalisés sont attachés à l'équilibreur de charge HTTPS global via application_domains. Les certificats SSL gérés par Google sont provisionnés automatiquement. Le DNS doit pointer vers l'IP de l'équilibreur de charge après l'apply.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
application_domains | 10 | [] | Noms de domaine personnalisés pour l'équilibreur de charge HTTPS. Certificats SSL gérés par Google provisionnés par domaine. (par exemple, ['analytics.example.com']) |
Après le premier apply, récupérez l'IP de l'équilibreur de charge et créez un enregistrement A. Le provisionnement du certificat SSL prend 10 à 30 minutes après la propagation DNS.
6. CI/CD et livraison
A. Déclencheurs Cloud Build
Lorsque enable_cicd_trigger = true, une connexion GitHub Cloud Build et un déclencheur de push sont provisionnés. Le déclencheur construit et déploie une image Umami personnalisée lorsque du code est poussé vers la branche configurée.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
enable_cicd_trigger | 8 | false | Provisionne un déclencheur GitHub Cloud Build. Nécessite github_repository_url et des identifiants. |
github_repository_url | 8 | "" | URL HTTPS complète du dépôt GitHub. |
github_token | 8 | "" | PAT GitHub (scopes repo, admin:repo_hook). Requis lors du premier apply. Sensible. |
github_app_installation_id | 8 | "" | ID d'installation de l'application GitHub (préféré pour les dépôts d'organisation). |
cicd_trigger_config | 8 | { branch_pattern = "^main$" } | Configuration avancée du déclencheur : branch_pattern, included_files, ignored_files, trigger_name, substitutions. |
B. Pipeline Cloud Deploy
Lorsque enable_cloud_deploy = true (nécessite enable_cicd_trigger = true), le pipeline CI/CD est mis à niveau vers un pipeline de livraison Cloud Deploy géré avec des étapes de promotion séquentielles.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
enable_cloud_deploy | 8 | false | Provisionne un pipeline Cloud Deploy. Nécessite enable_cicd_trigger = true. |
cloud_deploy_stages | 8 | [dev, staging, prod(approval)] | Étapes de promotion ordonnées. Chaque : name, target_name, service_name, require_approval, auto_promote. |
7. Fiabilité et planification
A. Mise à l'échelle et concurrence
min_instance_count = 0 (mise à l'échelle à zéro) par défaut. Les démarrages à froid d'Umami sont rapides — l'application Next.js démarre en quelques secondes sans opérations lourdes au premier démarrage. max_instance_count = 3 par défaut. Umami s'adapte horizontalement en toute sécurité car tout l'état est dans PostgreSQL.
B. Répartition du trafic
La répartition du trafic est prise en charge. Umami stocke toutes les données d'analyse dans PostgreSQL (partagées entre toutes les instances), ce qui rend les déploiements canary sûrs — toute révision peut servir des requêtes et écrire dans la même base de données.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
traffic_split | 4 | [] | Allocation de trafic basée sur un pourcentage entre les révisions nommées. Toutes les entrées doivent totaliser 100. Vide envoie 100 % à la dernière révision. |
C. Sondes de santé et surveillance de la disponibilité
Umami expose /api/heartbeat comme son point de terminaison de santé dédié. Les sondes de démarrage et de vivacité ciblent toutes deux ce chemin.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
startup_probe | 14 | { path="/api/heartbeat", initial_delay_seconds=30, timeout_seconds=10, period_seconds=10, failure_threshold=30 } | Sonde de disponibilité au démarrage. Le conteneur ne reçoit pas de trafic tant que celle-ci n'a pas réussi. |
liveness_probe | 14 | { path="/api/heartbeat", initial_delay_seconds=30, timeout_seconds=10, period_seconds=30, failure_threshold=3 } | Sonde de vivacité. Le conteneur est redémarré après failure_threshold échecs consécutifs. |
startup_probe_config | 14 | { enabled=true, path="/api/heartbeat", initial_delay_seconds=30 } | Sonde de démarrage Cloud Run (passée directement à App CloudRun). |
health_check_config | 14 | { enabled=true, path="/api/heartbeat" } | Sonde de vivacité Cloud Run (passée directement à App CloudRun). |
uptime_check_config | 14 | { enabled=false, path="/api/heartbeat" } | Test de disponibilité Cloud Monitoring (désactivé par défaut). Lorsqu'il est activé, les alertes notifient support_users si inaccessible. |
alert_policies | 14 | [] | Politiques d'alerte métrique Cloud Monitoring. |
D. Rotation automatique du mot de passe
Lorsque enable_auto_password_rotation = true, un pipeline de rotation de mot de passe sans interruption est provisionné :
- Secret Manager émet une notification de rotation à chaque intervalle
secret_rotation_period. - Eventarc déclenche un job de rotation Cloud Run.
- Le job génère un nouveau mot de passe, met à jour l'utilisateur Cloud SQL PostgreSQL, écrit une nouvelle version du secret.
- Après
rotation_propagation_delay_secsecondes, le job redémarre le service Umami.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
enable_auto_password_rotation | 12 | false | Active la rotation automatique du mot de passe. |
rotation_propagation_delay_sec | 12 | 90 | Secondes à attendre après l'écriture du nouveau secret avant de redémarrer le service. |
secret_rotation_period | 6 | '2592000s' | Fréquence de rotation. Par défaut : 30 jours. |
8. Intégrations
A. Cache Redis
Redis est désactivé par défaut (enable_redis = false). Umami ne nécessite pas Redis — tout l'état est stocké dans PostgreSQL. Activez-le uniquement si vous intégrez une couche de cache externe pour des cas d'utilisation personnalisés.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
enable_redis | 16 | false | Active Redis en injectant les variables d'environnement REDIS_HOST et REDIS_PORT. Umami ne nécessite pas Redis. |
redis_host | 16 | "" | Nom d'hôte ou adresse IP du serveur Redis. Utilisé uniquement lorsque enable_redis = true. |
redis_port | 16 | '6379' | Port TCP du serveur Redis (chaîne). |
B. Importation et récupération de sauvegarde
Lorsque enable_backup_import = true, un job Cloud Run dédié restaure une sauvegarde de base de données existante dans l'instance Cloud SQL PostgreSQL provisionnée.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
backup_schedule | 7 | '0 2 * * *' | Expression Cron (UTC) pour les sauvegardes quotidiennes automatisées. |
backup_retention_days | 7 | 7 | Jours de rétention des fichiers de sauvegarde dans GCS. |
enable_backup_import | 7 | false | Déclenche une restauration unique lors de l'apply. Définissez false après une importation réussie. |
backup_source | 7 | 'gcs' | 'gcs' (URI GCS complet) ou 'gdrive' (ID de fichier Drive). |
backup_file | 7 | 'backup.sql' | Nom du fichier de sauvegarde à importer. |
backup_format | 7 | 'sql' | Format du fichier de sauvegarde. Options : sql, tar, gz, tgz, tar.gz, zip, auto. |
C. Observabilité et alertes
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
uptime_check_config | 14 | { enabled=false, path="/api/heartbeat" } | Configuration du test de disponibilité : enabled, path, check_interval, timeout. Désactivé par défaut. |
alert_policies | 14 | [] | Politiques d'alerte métrique. Chacune : name, metric_type, comparison, threshold_value, duration_seconds, aggregation_period. |
support_users | 2 | [] | Adresses e-mail notifiées par les déclencheurs de test de disponibilité et de politique d'alerte. |
D. Exploration avec la console GCP
Après un déploiement réussi, explorez l'installation Umami dans la console GCP :
Service Cloud Run :
Accédez à Cloud Run dans la console GCP. Recherchez le service nommé app<application_name><tenant_id><deployment_id> (par exemple, appumamidemoxyz). Cliquez sur le service pour afficher :
- L'URL du service — utilisez-la pour accéder au tableau de bord Umami.
- L'onglet Revisions (Révisions) — liste toutes les révisions déployées avec les pourcentages de trafic.
- L'onglet Logs (Journaux) — diffuse les journaux du conteneur, y compris le démarrage d'Umami et les journaux de requêtes.
- L'onglet Metrics (Métriques) — affiche le nombre de requêtes, la latence, le nombre d'instances et l'utilisation du CPU/de la mémoire.
- L'onglet Configuration — affiche l'image de conteneur actuelle, les variables d'environnement (non sensibles) et les limites de ressources.
Instance Cloud SQL :
Accédez à SQL dans la console GCP. Recherchez l'instance nommée app-sql-<deployment_id>. Cliquez sur l'instance pour afficher :
- Overview (Vue d'ensemble) — nom de la connexion, région, version de PostgreSQL, utilisation du stockage.
- Databases (Bases de données) — la base de données
umami. - Users (Utilisateurs) — l'utilisateur d'application
umami. - Connections (Connexions) — connexions actives depuis le service Cloud Run via Auth Proxy.
- Backups (Sauvegardes) — calendrier de sauvegarde automatisé et points de restauration.
Secret Manager :
Accédez à Security → Secret Manager (Sécurité → Secret Manager). Recherchez les secrets nommés secret-<tenant_resource_prefix>-<application_name>-app-secret (ou similaire). Cliquez sur un secret pour afficher :
- Les versions du secret et les horodatages de création.
- Les entrées du journal d'accès montrant quand Cloud Run a lu le secret.
- La politique de réplication.
Artifact Registry : Accédez à Artifact Registry. Recherchez le dépôt pour ce déploiement. Cliquez pour afficher les images Umami mises en miroir, leurs tags, leurs tailles et l'état de la politique de rétention.
Tests de disponibilité Cloud Monitoring :
Si uptime_check_config.enabled = true a été défini, accédez à Monitoring → Uptime checks (Surveillance → Tests de disponibilité) et recherchez le test pour ce déploiement Umami ciblant /api/heartbeat. Affichez les résultats du test, le temps de réponse et l'historique des échecs dans les régions GCP.
E. Exploration avec gcloud
Utilisez ces commandes gcloud pour inspecter le déploiement Umami depuis la ligne de commande. Remplacez PROJECT_ID, REGION et DEPLOYMENT_ID par vos valeurs.
# List Cloud Run services in the project
gcloud run services list \
--project=PROJECT_ID \
--region=REGION \
--format="table(name,status.url,status.conditions[0].type)"
# Describe the Umami Cloud Run service
gcloud run services describe SERVICE_NAME \
--project=PROJECT_ID \
--region=REGION \
--format="yaml(status.url,spec.template.spec.containers[0].resources)"
# View the latest revision
gcloud run revisions list \
--project=PROJECT_ID \
--region=REGION \
--service=SERVICE_NAME \
--format="table(name,status.conditions[0].type,spec.containerConcurrency,metadata.creationTimestamp)"
# Tail Cloud Run logs
gcloud run services logs tail SERVICE_NAME \
--project=PROJECT_ID \
--region=REGION
# Check Cloud SQL instance status
gcloud sql instances describe INSTANCE_NAME \
--project=PROJECT_ID \
--format="table(name,state,databaseVersion,settings.tier)"
# List databases in the Cloud SQL instance
gcloud sql databases list \
--instance=INSTANCE_NAME \
--project=PROJECT_ID
# List Cloud SQL users
gcloud sql users list \
--instance=INSTANCE_NAME \
--project=PROJECT_ID
# List Secret Manager secrets for this deployment
gcloud secrets list \
--project=PROJECT_ID \
--filter="name~umami" \
--format="table(name,createTime,replication.auto)"
# Describe the APP_SECRET secret
gcloud secrets describe SECRET_NAME \
--project=PROJECT_ID
# View uptime check results (Cloud Monitoring)
gcloud monitoring uptime list-configs \
--project=PROJECT_ID \
--format="table(displayName,httpCheck.path,period,timeout)"
# List Artifact Registry images for Umami
gcloud artifacts docker images list \
REGION-docker.pkg.dev/PROJECT_ID/REPOSITORY_NAME \
--project=PROJECT_ID \
--format="table(image,tags,createTime)"
# Check Cloud Run IAM policy
gcloud run services get-iam-policy SERVICE_NAME \
--project=PROJECT_ID \
--region=REGION
# View Cloud Build triggers for this deployment
gcloud builds triggers list \
--project=PROJECT_ID \
--filter="name~umami" \
--format="table(name,createTime,github.push.branch)"
9. Comportements gérés par la plateforme
Les comportements suivants sont appliqués automatiquement par Umami CloudRun, quelles que soient les valeurs des variables. Ils ne peuvent pas être annulés via tfvars.
| Comportement | Implémentation | Détail |
|---|---|---|
| PostgreSQL 15 requis | Valeur par défaut de database_type = "POSTGRES_15" | Umami nécessite PostgreSQL. MySQL et les autres moteurs ne sont pas pris en charge. |
| DATABASE_URL construit à l'exécution | Point d'entrée personnalisé dans l'image Umami Common | Le mode d'image custom construit un wrapper qui assemble DATABASE_URL à partir des variables DB_* injectées par la plateforme. L'utilisation du mode prebuilt nécessite une configuration manuelle de DATABASE_URL. |
| APP_SECRET généré automatiquement | random_password dans Umami Common | Secret alphanumérique de 32 caractères, stocké dans Secret Manager, injecté en tant que APP_SECRET. |
| Pas de buckets de stockage par défaut | Valeur par défaut de storage_buckets = [] | Umami est sans état — aucun bucket GCS n'est provisionné sauf configuration explicite. |
| Mise en miroir d'images activée par défaut | enable_image_mirroring = true | Met en miroir depuis GitHub Container Registry (ghcr.io) vers Artifact Registry pour éviter les limites de débit. |
| Job db-init par défaut | Fourni par Umami Common lorsque initialization_jobs = [] | La base de données et l'utilisateur PostgreSQL sont créés automatiquement avant qu'Umami n'exécute ses propres migrations. |
| Migrations Prisma au démarrage | Comportement du conteneur Umami | Umami exécute ses propres migrations de base de données Prisma à chaque démarrage. Le job db-init ne fait que pré-créer la base de données et l'utilisateur. |
| Pas de Redis requis | Valeur par défaut de enable_redis = false | Umami utilise uniquement PostgreSQL pour tout le stockage de données. Redis n'est pas requis. |
| Répertoire de scripts | scripts_dir = abspath("${module.umami_app.path}/scripts") | Les scripts d'initialisation proviennent de Umami Common, et non du répertoire de déploiement. |
L'infrastructure intégrée (lorsqu'aucune pile Services_GCP n'est présente) est identique à App_CloudRun §9 — App_CloudRun provisionne un VPC intégré, Cloud NAT, une instance Cloud SQL, des comptes de service et les API GCP selon les besoins. Voir App_CloudRun pour l'inventaire complet des ressources intégrées et les notes de suppression.
10. Référence des variables
Toutes les variables configurables par l'utilisateur exposées par Umami CloudRun, triées par groupe d'interface utilisateur puis par ordre.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
resource_creator_identity | 0 | (SA de la plateforme) | Compte de service utilisé par Terraform pour gérer les ressources. |
project_id | 1 | — | ID du projet GCP. Obligatoire. |
region | 1 | 'us-central1' | Région GCP pour toutes les ressources. |
tenant_id | 2 | 'demo' | Suffixe court ajouté à tous les noms de ressources. |
support_users | 2 | [] | Adresses e-mail pour les alertes de surveillance. |
resource_labels | 2 | {} | Libellés appliqués à toutes les ressources provisionnées. |
application_name | 3 | 'umami' | Nom de ressource de base. Ne pas modifier après le déploiement initial. |
application_display_name | 3 | 'Umami' | Nom lisible par l'homme affiché dans la console GCP. |
application_description | 3 | 'Umami Analytics on Cloud Run' | Description du service. |
application_version | 3 | 'postgresql-latest' | Tag de l'image du conteneur Umami. Utilisez des tags préfixés par postgresql-. |
deploy_application | 4 | true | Définissez false pour un déploiement uniquement d'infrastructure. |
container_image_source | 4 | 'custom' | 'custom' (Cloud Build) ou 'prebuilt' (image existante). |
container_image | 4 | 'ghcr.io/umami-software/umami' | URI de l'image du conteneur. |
container_build_config | 4 | { enabled=true } | Configuration Cloud Build pour les builds d'images personnalisées. |
enable_image_mirroring | 4 | true | Met en miroir l'image Umami dans Artifact Registry. |
cpu_limit | 4 | '1000m' | CPU par instance. |
memory_limit | 4 | '512Mi' | Mémoire par instance. |
min_instance_count | 4 | 0 | Instances minimales (0 = mise à l'échelle à zéro). |
max_instance_count | 4 | 3 | Instances maximales. |
container_port | 4 | 3000 | Port natif d'Umami. |
container_protocol | 4 | 'http1' | 'http1' ou 'h2c'. |
execution_environment | 4 | 'gen2' | Génération de l'environnement d'exécution Cloud Run. |
timeout_seconds | 4 | 300 | Durée maximale de la requête. |
cpu_always_allocated | 4 | false | Facturation basée sur les requêtes par défaut. Définissez true pour allouer le CPU en permanence. |
enable_cloudsql_volume | 4 | true | Monte l'instance Cloud SQL via l'intégration native du socket Cloud Run (pas de sidecar Auth Proxy sur Cloud Run). |
cloudsql_volume_mount_path | 4 | '/cloudsql' | Chemin du conteneur pour le socket Unix Cloud SQL. |
traffic_split | 4 | [] | Allocation de trafic Canary/bleu-vert. |
max_revisions_to_retain | 4 | 7 | Nombre maximal de révisions Cloud Run à conserver. |
service_annotations | 4 | {} | Annotations Cloud Run avancées. |
service_labels | 4 | {} | Libellés appliqués au service Cloud Run. |
ingress_settings | 5 | 'all' | 'all', 'internal' ou 'internal-and-cloud-load-balancing'. |
vpc_egress_setting | 5 | 'PRIVATE_RANGES_ONLY' | 'PRIVATE_RANGES_ONLY' ou 'ALL_TRAFFIC'. |
enable_iap | 5 | false | Active IAP nativement sur le service Cloud Run. |
iap_authorized_users | 5 | [] | Utilisateurs/SA auxquels l'accès IAP est accordé. |
iap_authorized_groups | 5 | [] | Groupes Google auxquels l'accès IAP est accordé. |
environment_variables | 6 | {} | Variables d'environnement en texte brut (par exemple, { DISABLE_TELEMETRY = "1" }). |
secret_environment_variables | 6 | {} | Références Secret Manager. |
secret_propagation_delay | 6 | 30 | Secondes à attendre après la création du secret. |
secret_rotation_period | 6 | '2592000s' | Fréquence de notification de rotation de Secret Manager. |
backup_schedule | 7 | '0 2 * * *' | Expression Cron (UTC) pour les sauvegardes automatisées. |
backup_retention_days | 7 | 7 | Jours de rétention des fichiers de sauvegarde dans GCS. |
enable_backup_import | 7 | false | Déclenche une restauration unique lors de l'apply. |
backup_source | 7 | 'gcs' | 'gcs' ou 'gdrive'. |
backup_file | 7 | 'backup.sql' | Nom du fichier de sauvegarde à importer. |
backup_format | 7 | 'sql' | Format de sauvegarde : sql, tar, gz, tgz, tar.gz, zip, auto. |
enable_cicd_trigger | 8 | false | Provisionne un déclencheur GitHub Cloud Build. |
github_repository_url | 8 | "" | URL HTTPS complète du dépôt GitHub. |
github_token | 8 | "" | PAT GitHub. Sensible. |
github_app_installation_id | 8 | "" | ID d'installation de l'application GitHub. |
cicd_trigger_config | 8 | { branch_pattern = "^main$" } | Configuration avancée du déclencheur Cloud Build. |
enable_cloud_deploy | 8 | false | Provisionne un pipeline de livraison progressive Cloud Deploy. |
cloud_deploy_stages | 8 | [dev, staging, prod(approval)] | Étapes de promotion Cloud Deploy ordonnées. |
enable_binary_authorization | 8 | false | Applique l'attestation d'image au déploiement. |
binauthz_evaluation_mode | 8 | 'ALWAYS_ALLOW' | Mode d'application de l'autorisation binaire. Non référencé dans ce module. |
enable_custom_sql_scripts | 9 | false | Exécute des scripts SQL depuis GCS après le provisionnement. |
custom_sql_scripts_bucket | 9 | "" | Bucket GCS contenant les scripts SQL. |
custom_sql_scripts_path | 9 | "" | Préfixe de chemin dans le bucket. |
custom_sql_scripts_use_root | 9 | false | Exécute les scripts en tant qu'utilisateur root de la base de données. |
enable_cloud_armor | 10 | false | Provisionne un équilibreur de charge HTTPS global + WAF Cloud Armor. |
admin_ip_ranges | 10 | [] | Plages CIDR exemptées des règles WAF. |
application_domains | 10 | [] | Domaines personnalisés avec certificats SSL gérés par Google. |
enable_cdn | 10 | false | Active Cloud CDN sur le backend de l'équilibreur de charge HTTPS. |
max_images_to_retain | 10 | 7 | Nombre maximal d'images de conteneurs à conserver dans Artifact Registry. |
delete_untagged_images | 10 | true | Supprime automatiquement les images non taguées d'Artifact Registry. |
image_retention_days | 10 | 30 | Jours après lesquels les images sont éligibles à la suppression. |
create_cloud_storage | 11 | true | Contrôle le provisionnement du bucket GCS. |
storage_buckets | 11 | [] | Buckets GCS à provisionner. Vide par défaut — Umami n'a pas besoin de stockage de fichiers. |
enable_nfs | 11 | false | Provisionne le stockage partagé NFS. Non requis pour Umami. |
nfs_mount_path | 11 | '/mnt/nfs' | Chemin de montage NFS du conteneur. |
gcs_volumes | 11 | [] | Buckets GCS à monter via GCS Fuse. |
manage_storage_kms_iam | 11 | false | Crée une clé KMS CMEK pour les buckets de stockage. |
enable_artifact_registry_cmek | 11 | false | Crée une clé KMS Artifact Registry pour le chiffrement des images au repos. |
database_type | 12 | 'POSTGRES_15' | Moteur Cloud SQL. Doit être POSTGRES_15 pour Umami. |
application_database_name | 12 | 'umami' | Nom de la base de données PostgreSQL. Ne pas modifier après le déploiement initial. |
application_database_user | 12 | 'umami' | Utilisateur de l'application PostgreSQL. |
database_password_length | 12 | 32 | Longueur du mot de passe généré automatiquement. Plage : 16–64. |
enable_auto_password_rotation | 12 | false | Rotation automatisée du mot de passe sans interruption de service. |
rotation_propagation_delay_sec | 12 | 90 | Secondes à attendre après la rotation avant de redémarrer le service. |
enable_postgres_extensions | 12 | false | Active l'installation des extensions PostgreSQL. |
postgres_extensions | 12 | [] | Extensions PostgreSQL à installer. |
initialization_jobs | 13 | [] | Jobs Cloud Run ponctuels. Laissez vide pour que Umami Common fournisse le job db-init par défaut. |
cron_jobs | 13 | [] | Jobs Cloud Run planifiés récurrents. |
additional_services | 13 | [] | Services Cloud Run supplémentaires déployés avec Umami. |
startup_probe | 14 | { path="/api/heartbeat", initial_delay_seconds=30, failure_threshold=30 } | Sonde de démarrage. |
liveness_probe | 14 | { path="/api/heartbeat", initial_delay_seconds=30, failure_threshold=3 } | Sonde de vivacité. |
startup_probe_config | 14 | { enabled=true, path="/api/heartbeat" } | Sonde de démarrage Cloud Run (passée directement à App CloudRun). |
health_check_config | 14 | { enabled=true, path="/api/heartbeat" } | Sonde de vivacité Cloud Run (passée directement à App CloudRun). |
uptime_check_config | 14 | { enabled=false, path="/api/heartbeat" } | Test de disponibilité Cloud Monitoring (désactivé par défaut). |
alert_policies | 14 | [] | Politiques d'alerte métrique Cloud Monitoring. |
enable_redis | 16 | false | Active l'injection de la variable d'environnement Redis. Non requis pour Umami. |
redis_host | 16 | "" | Nom d'hôte/IP Redis. Utilisé uniquement lorsque enable_redis = true. |
redis_port | 16 | '6379' | Port TCP Redis (chaîne). |
enable_vpc_sc | 22 | false | Enregistre les appels d'API dans le périmètre VPC-SC du projet. |
vpc_cidr_ranges | 22 | [] | Plages CIDR du sous-réseau VPC pour le niveau d'accès réseau VPC-SC. |
vpc_sc_dry_run | 22 | true | Journalise les violations VPC-SC sans les bloquer. |
organization_id | 22 | "" | ID de l'organisation GCP pour VPC-SC. Découvert automatiquement à partir du projet si vide. |
enable_audit_logging | 22 | false | Active les journaux d'audit Cloud détaillés. |
11. Sorties
| Sortie | Description |
|---|---|
service_name | Nom du service Cloud Run. |
service_url | URL publique du service Cloud Run. |
service_location | Région GCP où le service Cloud Run est déployé. |
project_id | ID du projet GCP. |
deployment_id | Suffixe de l'ID de déploiement utilisé dans les noms de ressources. |
database_instance_name | Nom de l'instance Cloud SQL PostgreSQL. |
database_name | Nom de la base de données de l'application. |
database_user | Nom de l'utilisateur de la base de données de l'application. |
database_password_secret | Nom du secret Secret Manager pour le mot de passe de la base de données. |
storage_buckets | Buckets de stockage GCS créés. |
container_image | Image de conteneur utilisée pour le déploiement. |
cicd_enabled | Indique si le pipeline CI/CD est activé. |
github_repository_url | URL du dépôt GitHub connecté pour le CI/CD. |
Pièges de configuration et valeurs par défaut judicieuses
Niveaux de risque : Critique (perte de données, panne complète, faille de sécurité) — Élevé (service indisponible ou dégradation significative) — Moyen (fonction dégradée ou coût accru) — Faible (impact mineur).
| Variable | Valeur par défaut judicieuse | Risque | Conséquence d'une valeur incorrecte |
|---|---|---|---|
project_id | (obligatoire) | Critique | Pas de valeur par défaut — le déploiement échoue immédiatement. |
database_type | "POSTGRES_15" | Critique | Umami ne prend en charge que PostgreSQL. La définition de MySQL ou d'un autre moteur rompra la construction de DATABASE_URL et entraînera l'échec d'Umami au démarrage avec une erreur de connexion à la base de données. |
application_database_name | "umami" | Critique | Immuable après le premier déploiement — la modification de cette valeur entraîne la recréation de la base de données par Terraform, détruisant toutes les données d'analyse collectées par Umami. |
application_database_user | "umami" | Critique | Immuable après le premier déploiement — la modification de cette valeur recrée l'utilisateur Cloud SQL, invalidant toutes les informations d'identification stockées et rompant la connexion de la base de données d'Umami. |
container_port | 3000 | Critique | Umami écoute sur le port 3000. La modification de cette valeur sans faire correspondre le port lié du conteneur entraîne l'échec des sondes de santé Cloud Run et le service est marqué comme non sain. |
container_image_source | "custom" | Élevé | Le mode custom construit une image wrapper qui assemble DATABASE_URL à partir des variables DB_*. L'utilisation de "prebuilt" avec l'image officielle d'Umami nécessite de fournir manuellement DATABASE_URL comme variable d'environnement — sans cela, Umami ne peut pas se connecter à PostgreSQL et plantera au démarrage. |
application_version | "postgresql-latest" | Moyen | Utilisez toujours un tag préfixé par postgresql- (par exemple, postgresql-latest, postgresql-v2.11.3). Les tags de version simples (par exemple, latest) ne sont pas publiés pour la variante PostgreSQL d'Umami et entraîneront une erreur de pull de conteneur. |
admin_password | (à modifier lors de la première connexion) | Critique | Les identifiants d'administrateur Umami par défaut sont admin / umami — largement connus. Le fait de ne pas les modifier lors de la première connexion expose votre tableau de bord d'analyse et toutes les données suivies à quiconque connaît l'URL. |
enable_iap | false | Moyen | Sans IAP, toute personne connaissant l'URL Cloud Run peut accéder à la page de connexion du tableau de bord Umami. L'authentification propre à Umami est la seule barrière. Activez IAP ou assurez-vous que ingress_settings = "internal" pour les déploiements privés. |
ingress_settings | "all" | Moyen | "all" expose Umami publiquement. Le point de terminaison du script de suivi doit être accessible publiquement pour que les sites web suivis puissent rapporter des données, mais le tableau de bord d'administration doit être restreint pour les déploiements sensibles. Envisagez d'utiliser IAP ou un domaine personnalisé avec un accès restreint pour les chemins d'administration. |
min_instance_count | 0 | Faible | La mise à l'échelle à zéro est sûre pour Umami — les démarrages à froid sont rapides (quelques secondes). Cependant, la première requête après un démarrage à froid subira une légère latence. Définissez sur 1 pour les tableaux de bord d'analyse sensibles au temps. |
memory_limit | "512Mi" | Moyen | 512 Mio est la valeur par défaut et est suffisante pour un trafic modéré. Les sites à fort trafic avec de nombreux utilisateurs de tableau de bord simultanés ou des requêtes complexes peuvent rencontrer des problèmes de mémoire insuffisante. Augmentez à 1Gi si vous observez une pression sur la mémoire dans Cloud Monitoring. |
enable_backup_import | false | Critique | Nécessite qu'un fichier de sauvegarde valide soit accessible à backup_file. L'activation avec un chemin invalide entraîne l'échec du job Cloud Run de restauration lors de l'apply. |
backup_retention_days | 7 | Moyen | Sept jours est le minimum pour l'analyse de production. La perte de l'historique d'analyse a un impact commercial direct. Augmentez à 30 jours et plus pour tout déploiement d'analyse à long terme. |
secret_propagation_delay | 30 | Faible | Parfois insuffisant dans les configurations multi-régions. Augmentez à 60-90 s si des erreurs de lecture de secret sont observées lors de l'apply. |
enable_cloudsql_volume | true | Critique | Sur Cloud Run, cela monte l'intégration du socket natif Cloud SQL — il n'y a pas de sidecar Auth Proxy et pas d'écouteur TCP 127.0.0.1:5432 (cela n'existe que sur GKE). Le point d'entrée partagé Umami_Common (umami-entrypoint.sh) résout inconditionnellement un chemin de socket DB_HOST en 127.0.0.1 avant de construire DATABASE_URL, ce qui n'est valide que sur GKE — sur Cloud Run, cela produit ECONNREFUSED 127.0.0.1:5432 dans les journaux de révision et la sonde de démarrage échoue. Si Umami ne démarre pas, vérifiez les DB_HOST/DB_IP injectés de la révision déployée (gcloud run revisions describe … --format=json) plutôt que de supposer que la substitution de boucle locale fonctionne. |
vpc_sc_dry_run | true | Moyen | Le mode simulation VPC-SC journalise les violations mais ne les bloque pas. Après avoir vérifié l'absence de faux positifs dans Cloud Logging, passez à false pour une application réelle. Le fait de laisser true en permanence n'offre aucun avantage en matière de sécurité. |
Destruction des ressources
Problème de suppression connu : libération d'adresse IPv4 sans serveur
Lors de la destruction d'un déploiement Cloud Run, vous pouvez rencontrer une erreur similaire à :
Error: Error waiting for Subnetwork to be deleted: The following serverless IPv4 address(es) on subnet ... are still in use.
Cause : GCP conserve les adresses IPv4 sans serveur sur le sous-réseau VPC de manière asynchrone après la suppression d'un service Cloud Run. Ces adresses sont libérées par GCP environ 20 à 30 minutes après la suppression du service Cloud Run. Terraform/OpenTofu ne peut pas terminer la suppression du sous-réseau ou du VPC tant qu'elles ne sont pas entièrement libérées.
Résolution : Attendez 20 à 30 minutes après la tentative de destruction initiale, puis relancez la commande de destruction :
tofu destroy
La deuxième exécution réussira une fois que GCP aura libéré les adresses réservées.
Guides associés
- Lab pratique : Umami sur Cloud Run — déployez-le étape par étape, avec les écrans de la console et les commandes à chaque étape.
- Module Umami GKE — Guide de configuration — la même application sur Kubernetes, lorsque vous avez besoin de l'autre cible de déploiement.
- Module de configuration partagée commune Umami — la configuration partagée par les deux cibles de déploiement.
- Déployé avec Directus sur Cloud Run dans la solution Plateforme de contenu sans tête.
Need RAD to do something it does not do yet? Request it on the roadmap, or vote on what is already there.