Listmonk sur Google Cloud Run
Ce document fournit une référence complète pour le module modules/Listmonk_CloudRun. Il couvre l'architecture, la gestion des identités et des accès (IAM), les variables de configuration, les comportements spécifiques à Listmonk et les modèles opérationnels pour le déploiement de Listmonk sur Google Cloud Run (v2).
Coût de Listmonk sur RAD et comparaison
Listmonk sur le module Cloud Run de RAD coûte environ 68 $ US par mois dans un projet Google Cloud que vous possédez, plus des frais de module uniques de 75 crédits (7,50 $ US). Listmonk lui-même est gratuit et open source (AGPL), sans limite d'abonnés, il s'agit donc du coût d'infrastructure de votre propre gestionnaire de listes de diffusion plutôt que de frais SaaS par abonné. Si vous n'en avez besoin qu'occasionnellement — une campagne saisonnière, un envoi de newsletter ponctuel — un projet géré par RAD peut être supprimé et restauré dans les 30 jours sans frais supplémentaires, de sorte que ces 68 $ US deviennent quelques dollars par mois. Voir Mettez-le en pause gratuitement, ci-dessous.
Ce que vous payez sur RAD
| Dans un projet Google Cloud que vous possédez | Dans un projet géré par RAD pour vous | |
|---|---|---|
| Frais de module, une fois par déploiement | 75 crédits (7,50 $ US au prix de la recharge) | 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 sont l'exception : le temps de build leur est toujours facturé à la minute | Identique |
| Coût d'exécution Google Cloud | Facturé par Google à votre propre compte de facturation, environ 68 $ US par mois pour la configuration par défaut (tableau ci-dessous) | Mesuré à l'heure en crédits ; RAD publie 61 crédits par jour, soit environ 1 830 par mois (environ 183 $ US au prix de la recharge) |
| Qui possède quoi | Vous possédez le projet et sa facturation ; RAD le déploie et le met à jour | RAD possède le projet, avec des garde-fous, des quotas et des alertes budgétaires ; vous avez accès à la console, et un solde minimum acheté est conservé en réserve |
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 ponctuelle, et moins avec un abonnement mensuel. Dans un projet géré par RAD, la base de données, le serveur de fichiers et le réseau sont partagés par toutes les applications du projet, de sorte qu'une deuxième application n'ajoute pas une deuxième base de données.
Coût d'exécution par défaut dans votre propre projet (us-central1, prix catalogue Google) :
| Ressource (module par défaut) | 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,00 $ US |
| Cloud Storage (modules complémentaires, sauvegardes) | 1,00 $ US |
| Total | environ 68 $ US |
Comparaison
- Il n'existe pas de SaaS Listmonk hébergé officiel — Zerodha l'a conçu pour l'auto-hébergement, et il n'y a pas de prix fournisseur à comparer. La comparaison commerciale la plus proche est un SaaS d'e-mail par abonné (Mailchimp, SendGrid Marketing), un modèle de tarification entièrement différent, nous n'en citons donc pas ici.
- Dimensionné à son défaut de 1 vCPU/0,5 GiB, une classe de VPS plus petite/moins chère que la comparaison habituelle (bien en dessous d'un Hetzner CPX22 ou DO 2 vCPU/4 Go à 24 $/mois) peut exécuter Listmonk et Postgres ensemble — moins les sauvegardes gérées par RAD, Secret Manager et la surveillance liée à la délivrabilité.
- La proposition de valeur de Listmonk (des millions d'abonnés sur un seul binaire Go, pas de frais par abonné) reste valable dans tous les cas ; RAD supprime principalement le travail opérationnel.
- Voir le guide GKE pour un déploiement qui reste disponible en continu.
Mettez-le en pause gratuitement : supprimez un projet géré par RAD, restaurez-le lorsque vous en avez besoin
Si Listmonk s'exécute dans un projet géré par RAD pour vous, vous avez une deuxième option qui va bien au-delà de la mise à l'échelle à zéro : supprimez l'ensemble du projet et restaurez-le dans les 30 jours pour presque rien. Cela convient bien mieux à Listmonk dont vous n'avez besoin qu'occasionnellement — un projet de cours, une démo, une évaluation de courte durée — que de le faire fonctionner en continu.
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. La restauration ne peut donc pas être considérée comme un moyen 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.
- Comment ça marche. La suppression d'un projet géré par RAD délie d'abord sa facturation, puis demande à Google de supprimer le projet. Google ne supprime pas le projet immédiatement : il le conserve, récupérable, pendant 30 jours. Comme la facturation est déjà déliée, rien n'est facturé pendant cette période d'attente. Contrairement à la suppression d'un seul module, cela ne supprime pas Cloud SQL ou le calcul propre à Listmonk un par un — l'ensemble du projet, et tout ce qu'il contient, s'arrête simplement.
- La restauration est une vérification, pas une reconstruction. Dans les 30 jours, le propriétaire du projet peut le restaurer. RAD demande à Google de récupérer le projet et de rattacher son compte de facturation, puis vous demande d'exécuter Update 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 plus jamais les frais de module. 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 que cela nécessite. Vous devez être propriétaire du projet (pas un projet que vous apportez et dont RAD ne gère que la facturation), et vous le restaurez vous-même dans les 30 jours — après cela, Google le supprime définitivement. La restauration est admise comme la création d'un nouveau projet : votre solde de crédits achetés doit toujours dépasser le seuil du palier (100 crédits pour le palier sandbox qui convient à la plupart des utilisations d'étude et de démonstration). Google indique que la plupart des services sont à nouveau pleinement fonctionnels dans les 36 heures suivant une restauration.
- Un véritable manque : le bucket de sauvegarde ne survit pas. Les sauvegardes nocturnes de Listmonk sont écrites dans un bucket à l'intérieur du projet, et ce bucket n'est pas protégé par la suppression logicielle de Cloud Storage, 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é Listmonk et que vous souhaitez conserver ce travail, copiez une sauvegarde (vers Google Drive ou un bucket en dehors du projet) avant de supprimer, comme pour le flux de travail de redéploiement ci-dessous. Pour une installation par défaut sans rien d'irremplaçable, cela n'a pas d'importance.
Ne payez que pendant que vous l'utilisez, l'autre méthode : supprimer et redéployer
Cloud Run se met déjà à l'échelle à zéro entre les requêtes. L'option ci-dessus ne s'applique qu'à un projet géré par RAD ; dans votre propre projet, ou une fois la fenêtre de 30 jours passée, la façon d'arrêter de payer est de supprimer le déploiement et de le redéployer lorsque vous en avez besoin.
- Ce que coûte un redéploiement. Les frais de module à nouveau (les builds sont inclus) : 75 crédits (7,50 $ US), car RAD recrée le projet et les services partagés avant Listmonk. La suppression ne permet d'économiser de l'argent que si Listmonk resterait inutilisé pendant environ quatre jours ou plus, à la fois dans votre propre projet (environ 2,26 $ US par jour) et dans un projet géré par RAD (61 crédits par jour).
- Supprimez tout ce que Listmonk utilise. La majeure partie du coût d'exécution est généralement la base de données. Elle ne s'arrête que si rien d'autre dans le projet ne l'utilise, donc la suppression de Listmonk alors que quelque chose d'autre partage le projet n'économise que la partie calcul propre à Listmonk.
- Conservez d'abord vos données. Les sauvegardes nocturnes vont dans un bucket à l'intérieur du déploiement et sont supprimées avec lui, alors copiez la dernière sauvegarde avant de supprimer si vous voulez la conserver.
Sessions de lab et environnements gérés
- Sessions de lab, pour la formation. Un formateur anime une session Listmonk pour une classe. Chaque participant dispose de Listmonk 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 à l'avance, soit chaque participant paie la sienne. Tout est supprimé à la fin de la session, et les crédits non utilisés sont reversés au formateur.
- Environnements gérés, pour les cabinets de conseil. Un partenaire exécute Listmonk 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 interrompue et les données sont conservées, de sorte que personne ne reçoit de frais inattendus. À la fin de l'engagement, 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 Google Cloud de l'API Cloud Billing Catalog ; frais RAD et estimation quotidienne de 26 crédits de radmodules.dev/pricing ; Supprimer et restaurer des projets pour la fenêtre de récupération de 30 jours et ce qu'elle dit sur les objets Cloud Storage sans suppression logicielle. Les prix changent ; vérifiez chaque source avant de vous fier à un chiffre.
1. Vue d'ensemble du module
Listmonk est un gestionnaire de newsletters et de listes de diffusion auto-hébergé, performant, écrit en Go. Listmonk 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 à Listmonk, l'initialisation de la base de données et la configuration de stockage via Listmonk Common.
Capacités clés :
- Calcul : Cloud Run v2 (Gen2), conteneur binaire Go, 1 vCPU / 512 Mio par défaut. Mise à l'échelle à zéro par défaut (
min_instance_count = 0) avecmax_instance_count = 1;cpu_always_allocated = truemaintient le CPU alloué sur une instance réveillée afin que l'expéditeur de campagne asynchrone puisse terminer avant de se réduire. - Persistance des données : Cloud SQL PostgreSQL 15. Volume GCS Fuse optionnel pour les téléchargements de médias à
/listmonk/uploads. NFS optionnel pour un stockage partagé supplémentaire. - Sécurité : Hérite de Cloud Armor WAF, IAP, Binary Authorization et VPC Service Controls de
App CloudRun. Le mot de passe administrateur est auto-généré et stocké dans Secret Manager. - Mise en cache : Redis désactivé par défaut (
enable_redis = false). Listmonk est un binaire Go sans état et ne nécessite pas Redis pour un fonctionnement normal. - CI/CD : Pipeline d'images personnalisées Cloud Build par défaut ; livraison progressive Cloud Deploy optionnelle.
- Fiabilité : La sonde de démarrage est une vérification de port TCP (délai initial de 30 secondes, 30 tentatives) —
/api/healthnécessite une authentification de session et 403s une sonde HTTP, donc Cloud Run vérifie que le conteneur écoute à la place. La sonde de vivacité est désactivée par défaut (Cloud Run n'a pas de sonde de vivacité TCP, et/api/healthrenvoie également 403). Listmonk exécute automatiquement les migrations de schéma PostgreSQL au premier démarrage.
Identité du projet et de l'application
| Variable | Groupe | Type | Valeur par défaut | Description |
|---|---|---|---|---|
project_id | 1 | string | — | ID du projet GCP. Obligatoire. |
tenant_id | 2 | string | 'demo' | Suffixe court 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 | 'listmonk' | Nom de ressource de base. Ne pas modifier après le déploiement initial. |
display_name | 3 | string | 'Listmonk' | Nom lisible par l'homme affiché dans la console GCP. |
description | 3 | string | 'Listmonk is a high-performance, self-hosted newsletter and mailing list manager' | Description du service Cloud Run. |
application_version | 3 | string | 'latest' | Tag de version de l'image Listmonk. Incrémenter pour déployer une nouvelle version. |
Architecture de l'enveloppe : Listmonk CloudRun appelle Listmonk Common pour construire un objet application_config contenant des variables d'environnement spécifiques à Listmonk, la configuration de la sonde et la définition du job db-init. module_storage_buckets contient tout bucket de téléchargement provisionné par Listmonk Common. scripts_dir est résolu au répertoire Listmonk_Common/scripts au moment de l'apply.
Note PostgreSQL : Listmonk nécessite PostgreSQL 15. database_type = "POSTGRES_15" est la valeur par défaut et Listmonk ne démarrera pas avec un autre moteur de base de données.
2. IAM et contrôle d'accès
Listmonk_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 des mots de passe sont identiques à ceux de App_CloudRun.
Secrets d'application : Listmonk Common génère automatiquement un secret au niveau de l'application :
LISTMONK_ADMIN_PASSWORD— le mot de passe de l'utilisateur administrateur de Listmonk, stocké dans Secret Manager et injecté à l'exécution (le nom de style de configurationLISTMONK_app__admin_password, avec double underscore, a été supprimé —__n'est pas une clé de Secret k8s valide).
Le mot de passe de la base de données est stocké dans un secret séparé (database_password_secret) provisionné automatiquement par App CloudRun. Aucune de ces valeurs n'est écrite dans l'état Terraform.
Nom de la variable d'environnement du mot de passe de la base de données : Listmonk lit directement LISTMONK_db__password. La variable db_password_env_var_name est prédéfinie à cette valeur afin que App CloudRun injecte le secret sous le nom correct.
Délai de propagation IAM de 120 secondes : Hérité de App CloudRun — le service Listmonk n'est pas déployé tant que le délai n'est pas écoulé, ce qui évite les échecs de lecture de secrets au premier démarrage de la révision.
Interface d'administration : L'interface utilisateur complète de Listmonk, y compris la gestion des abonnés, les campagnes, les modèles et les paramètres, est disponible à la racine /. Le nom d'utilisateur administrateur et le mot de passe auto-généré sont les seules informations d'identification requises.
3. Configuration du service principal
A. Calcul (Cloud Run)
Listmonk est un binaire Go compilé. Il est économe en mémoire et démarre rapidement par rapport aux applications en langage interprété. L'allocation de ressources par défaut (1 vCPU / 512 Mio) est suffisante pour des listes de taille modérée et des charges de travail de campagne.
Mise à l'échelle à zéro par défaut (min_instance_count = 0) — l'ancienne valeur par défaut min = 1 n'existait que pour maintenir le cache utilisateur API en mémoire par instance. Cette raison a disparu : l'entrée Listmonk_Common met à jour (UPSERT) un utilisateur API déterministe, basé sur un secret, dans la base de données à chaque démarrage, de sorte qu'une instance démarrée à froid recharge toujours une accréditation valide. cpu_always_allocated = true (par défaut) garantit qu'une instance réveillée maintient le CPU alloué suffisamment longtemps pour que l'expéditeur de campagne asynchrone puisse terminer avant de se réduire. N'augmentez min_instance_count à 1 que si Listmonk doit rester actif pour une utilisation administrative interactive intensive.
Le Startup CPU Boost est toujours activé (codé en dur dans App CloudRun).
Image de conteneur : container_image_source par défaut à 'custom', ce qui signifie que Cloud Build compile une image personnalisée à l'aide du Dockerfile de Listmonk_Common. Définissez container_image_source = 'prebuilt' et fournissez un URI container_image pour ignorer le build et déployer directement.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
deploy_application | 4 | true | Définissez false pour un déploiement uniquement d'infrastructure (SQL, stockage, secrets). |
cpu_limit | 4 | '1000m' | CPU par instance. 1 vCPU est suffisant pour le binaire Go de Listmonk. |
memory_limit | 4 | '512Mi' | Mémoire par instance. Augmentez à 1–2 Gi pour les grandes listes d'abonnés ou le traitement intensif des campagnes. |
min_instance_count | 4 | 0 | Instances minimales en cours d'exécution. Mise à l'échelle à zéro ; l'utilisateur API auto-réparateur amorcé par la base de données rend les démarrages à froid sûrs. |
max_instance_count | 4 | 1 | Instances maximales en cours d'exécution. Maintenu à 1 — Listmonk n'a pas de coordination pour les processeurs de campagne concurrents. |
cpu_always_allocated | 4 | true | Maintient le CPU alloué pendant toute la durée de vie d'une instance en cours d'exécution afin que l'expéditeur de campagne asynchrone en cours de processus puisse terminer après le retour de la requête HTTP déclenchante. |
container_port | 4 | 9000 | Port HTTP natif de Listmonk. Ne modifiez que si votre Dockerfile personnalisé se lie à un port différent. |
execution_environment | 4 | 'gen2' | Gen2 requis pour les montages GCS Fuse. |
timeout_seconds | 4 | 300 | Durée maximale de la requête. Les points de terminaison de l'API Listmonk répondent généralement en quelques secondes. |
enable_cloudsql_volume | 4 | true | Injecte le sidecar Cloud SQL Auth Proxy pour les connexions de socket Unix à PostgreSQL. |
container_protocol | 4 | 'http1' | 'http1' ou 'h2c'. |
enable_image_mirroring | 4 | true | Met en miroir l'image Listmonk dans Artifact Registry. |
traffic_split | 4 | [] | Allocation de trafic canary/blue-green basée sur un pourcentage. |
max_revisions_to_retain | 4 | 7 | Nombre maximal de révisions Cloud Run à conserver. Définissez 0 pour désactiver. |
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 | Listmonk CloudRun | Raison |
|---|---|---|---|
container_port | 8080 | 9000 | Port natif de Listmonk. |
cpu_always_allocated | false | true | L'expéditeur de campagne en cours de processus s'exécute après le retour de la requête HTTP déclenchante ; la facturation basée sur les requêtes le ralentirait en milieu de lot. |
enable_image_mirroring | false | true | Listmonk met en miroir son image de base vers Artifact Registry par défaut pour éviter les limites de débit de Docker Hub. |
B. Base de données (Cloud SQL — PostgreSQL 15)
Listmonk nécessite PostgreSQL 15. database_type = "POSTGRES_15" est la valeur par défaut et ne doit pas être modifiée. Listmonk gère sa propre création de schéma et ses migrations au premier démarrage — le job Cloud Run db-init ne crée que la base de données et l'utilisateur ; l'application peuple le schéma.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
database_type | 12 | 'POSTGRES_15' | Moteur Cloud SQL. Listmonk nécessite PostgreSQL. Ne pas modifier. |
db_name | 12 | 'listmonk' | Nom de la base de données PostgreSQL. Ne pas modifier après le déploiement initial. |
db_user | 12 | 'listmonk' | Utilisateur de l'application PostgreSQL. Mot de passe auto-généré et stocké dans Secret Manager. |
db_password_env_var_name | 12 | 'LISTMONK_db__password' | Nom de la variable d'environnement sous laquelle le mot de passe de la base de données est injecté. Prédéfini pour Listmonk ; ne pas modifier. |
database_password_length | 12 | 32 | Longueur du mot de passe auto-généré. Plage : 16–64. |
enable_auto_password_rotation | 12 | false | Rotation automatisée du mot de passe sans interruption. |
rotation_propagation_delay_sec | 12 | 90 | Secondes à attendre après la rotation avant de redémarrer le service. |
sql_instance_nameetsql_instance_base_namene sont pas exposés ; la découverte/provisionnement en ligne de Cloud SQL est gérée de manière transparente parApp CloudRun.
C. Stockage (GCS Fuse et NFS)
NFS est désactivé par défaut (enable_nfs = false). Listmonk est un binaire Go sans état et ne nécessite pas de stockage de système de fichiers partagé. Plusieurs instances Cloud Run partagent une seule base de données PostgreSQL ; les données des abonnés et le contenu des campagnes sont stockés dans la base de données.
Volume de téléchargement GCS Fuse : Pour un stockage persistant des téléchargements de médias/fichiers, montez un bucket GCS à /listmonk/uploads en utilisant gcs_volumes. Listmonk Common définit LISTMONK_upload__provider=filesystem et LISTMONK_upload__filesystem__upload_path=/listmonk/uploads — le bucket GCS monté à ce chemin satisfait ces paramètres. Sans volume persistant, les pièces jointes téléchargées sont éphémères et perdues lors du redémarrage de la révision.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
gcs_volumes | 11 | [] | Buckets GCS à monter via GCS Fuse (nécessite gen2). Chaque entrée : name, bucket_name, mount_path, readonly, mount_options. Montez le bucket de téléchargements à /listmonk/uploads. |
enable_nfs | 11 | false | Provisionne un volume NFS partagé. Non requis pour les déploiements Listmonk standard. |
nfs_mount_path | 11 | '/mnt/nfs' | Chemin du conteneur où le partage NFS est monté. Pertinent uniquement lorsque enable_nfs = true. |
create_cloud_storage | 11 | true | Définissez false pour ignorer la création du bucket GCS définie dans storage_buckets. |
storage_buckets | 11 | [] | Buckets GCS supplémentaires à provisionner. |
manage_storage_kms_iam | 11 | false | Crée un trousseau de clés/clé CMEK KMS 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 d'images CMEK au repos. |
D. Réseau
Cloud Run utilise Direct VPC Egress pour atteindre l'IP interne de Cloud SQL. Comme enable_cloudsql_volume = true est la valeur par défaut, le sidecar Auth Proxy gère la connexion Cloud SQL via un socket Unix, et la connexion à la base de données ne nécessite pas de routage VPC.
Listmonk se connecte à des fournisseurs SMTP/Mailgun/SES/Postmark externes pour la livraison des campagnes. Assurez-vous que vpc_egress_setting = 'PRIVATE_RANGES_ONLY' (par défaut) est activé afin que l'accès public direct soit disponible pour les ports SMTP 587/465/25.
| 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 à passer par l'équilibreur de charge HTTPS. |
vpc_egress_setting | 5 | 'PRIVATE_RANGES_ONLY' | 'PRIVATE_RANGES_ONLY' ne route que le trafic RFC 1918 via le VPC. Définissez 'ALL_TRAFFIC' uniquement si tout le trafic sortant (y compris SMTP) doit transiter par le VPC. |
E. Initialisation et amorçage
Un job Cloud Run db-init est automatiquement provisionné par Listmonk Common lorsque initialization_jobs est laissé comme liste vide par défaut ([]). Il utilise l'image postgres:15-alpine et exécute Listmonk_Common/scripts/db-init.sh, qui effectue les opérations idempotentes suivantes :
- Se connecte à Cloud SQL PostgreSQL via le socket Unix Auth Proxy.
- Crée l'utilisateur de base de données
listmonkavec le mot de passe de Secret Manager. - Crée la base de données
listmonksi elle n'existe pas. - Accorde à l'utilisateur
listmonktous les privilèges sur la base de données.
Listmonk lui-même exécute --install au premier démarrage pour peupler le schéma et créer l'utilisateur administrateur en utilisant LISTMONK_ADMIN_USER (codé en dur à "admin" dans main.tf) et LISTMONK_ADMIN_PASSWORD de l'environnement — les anciens noms de style de configuration LISTMONK_app__admin_username/LISTMONK_app__admin_password, avec double underscore, ont été supprimés (dépréciés en v6 ; __ n'est pas une clé de Secret k8s valide).
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
initialization_jobs | 13 | [] | Jobs Cloud Run ponctuels. Laissez vide pour que Listmonk 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. Chaque entrée : name, schedule (cron UTC), image, command, args, env_vars, secret_env_vars, cpu_limit, memory_limit, timeout_seconds, max_retries, task_count, parallelism, mount_nfs, mount_gcs_volumes, script_path, paused. |
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) est provisionné devant Cloud Run.
Pour les déploiements Listmonk en production qui traitent les données des abonnés et envoient des campagnes, Cloud Armor est fortement recommandé pour protéger contre le bourrage d'identifiants sur la connexion administrateur et l'abus d'API.
| 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, IPs 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 Google Identity est requise avant que les requêtes n'atteignent Listmonk. Recommandé pour les déploiements de newsletters internes où l'accès doit être restreint aux comptes Google organisationnels.
| 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'. |
C. Autorisation binaire
Lorsque enable_binary_authorization = true, Cloud Run garantit 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. |
vpc_sc_dry_run | 22 | true | Enregistre les violations VPC-SC sans les bloquer. Définissez false pour les appliquer. |
enable_audit_logging | 22 | false | Active les journaux d'audit Cloud détaillés (DATA_READ, DATA_WRITE, ADMIN_READ). |
E. Intégration de Secret Manager
Les secrets d'application Listmonk sont stockés dans Secret Manager et injectés nativement par Cloud Run au démarrage de la révision — le texte en clair n'est jamais écrit dans l'état Terraform.
Listmonk Common génère automatiquement le secret du mot de passe administrateur, injecté dans le conteneur sous le nom LISTMONK_ADMIN_PASSWORD. Le mot de passe de la base de données (LISTMONK_db__password) est provisionné automatiquement par App CloudRun. Des secrets supplémentaires peuvent être ajoutés via secret_environment_variables.
| 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 procèdent. |
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 Listmonk à passer par l'équilibreur de charge, empêchant l'accès direct à l'URL *.run.app.
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 Listmonk : Listmonk sert un mélange de points de terminaison d'API et de ressources statiques. Le CDN est le plus bénéfique pour les ressources d'interface utilisateur statiques (HTML, JS, CSS). Les réponses de l'API Listmonk (/api/*) ne sont pas cachables et doivent être exclues de la mise en cache CDN via les en-têtes Cache-Control ou les règles de modèle d'URL.
| 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, ['newsletters.example.com']) |
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 Listmonk 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 (repo, étendues admin:repo_hook). Requis lors de la première application. 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
Listmonk est un binaire Go sans état — plusieurs instances Cloud Run peuvent servir des requêtes simultanément sans problèmes d'état de session partagé. La valeur par défaut min_instance_count = 0 se met à l'échelle à zéro entre les envois ; l'utilisateur API auto-réparateur amorcé par la base de données signifie qu'une instance démarrée à froid est immédiatement utilisable. max_instance_count est par défaut 1 car Listmonk n'a pas de coordination pour les processeurs de campagne concurrents — augmentez-le uniquement si la charge de lecture interactive/API l'exige.
B. Répartition du trafic
La répartition du trafic est prise en charge. La conception sans état de Listmonk rend les déploiements canary sûrs — toutes les requêtes partagent le même backend PostgreSQL quelle que soit l'instance qui les gère.
| 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. Une valeur vide envoie 100 % à la dernière révision. |
C. Sondes de santé et surveillance de la disponibilité
Listmonk expose un endpoint /api/health dédié, mais à partir de Listmonk v6.1.0, ce endpoint est derrière une authentification de session et renvoie 403 {"message":"invalid session"} à un appelant non authentifié — donc une sonde HTTP contre lui ne passe jamais. La sonde de démarrage est donc par défaut une vérification d'écoute de port TCP (confirme que le serveur est lié au port du conteneur), et la sonde de vivacité est par défaut désactivée (Cloud Run n'a pas de sonde de vivacité TCP, et la forme HTTP renverrait 403 de la même manière). La sonde de démarrage TCP conditionne la disponibilité, et Cloud Run redémarre le conteneur s'il se termine.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
startup_probe | 14 | { enabled=true, type="TCP", path="/api/health", initial_delay_seconds=30, timeout_seconds=5, period_seconds=10, failure_threshold=30 } | Sonde de disponibilité au démarrage (TCP). Le conteneur ne reçoit pas de trafic tant que cela n'a pas réussi. |
liveness_probe | 14 | { enabled=false, type="HTTP", path="/api/health", initial_delay_seconds=30, timeout_seconds=5, period_seconds=30, failure_threshold=3 } | Sonde de vivacité. Désactivée par défaut ; la sonde de démarrage TCP couvre la disponibilité. |
uptime_check_config | 14 | { enabled=false, path="/api/health" } | Test de disponibilité Cloud Monitoring. Désactivé par défaut — activez-le et les alertes notifient support_users si inaccessible. |
alert_policies | 14 | [] | Règles d'alerte métrique Cloud Monitoring. |
Comportement de la sonde de démarrage : Le failure_threshold=30 combiné avec period_seconds=10 donne à Listmonk jusqu'à 300 secondes (plus le délai initial de 30 secondes) pour terminer l'installation du schéma au premier démarrage. C'est généreux — l'installation du schéma Listmonk se termine généralement en moins de 30 secondes sur une nouvelle instance PostgreSQL.
D. Rotation automatique des mots de passe
Lorsque enable_auto_password_rotation = true, un pipeline de rotation de mot de passe sans interruption de service 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 PostgreSQL de Cloud SQL, écrit une nouvelle version du secret.
- Après
rotation_propagation_delay_secsecondes, le job redémarre le service Listmonk.
Listmonk rétablit sa connexion à la base de données au redémarrage et lit le mot de passe mis à jour depuis Secret Manager.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
enable_auto_password_rotation | 12 | false | Active la rotation automatique des mots de passe. |
rotation_propagation_delay_sec | 12 | 90 | Secondes à attendre après l'écriture du nouveau secret avant de redémarrer le service. |
8. Intégrations
A. Envoi de courriels (SMTP / API)
Listmonk se connecte à des fournisseurs de messagerie externes pour l'envoi de campagnes et de messages transactionnels. Configurez le fournisseur de messagerie via l'interface d'administration de Listmonk dans Settings → SMTP après le déploiement. Les fournisseurs courants incluent Mailgun, Amazon SES, Postmark et SendGrid.
Listmonk prend en charge les intégrations SMTP et API natives (Mailgun, SES, Postmark, Sparkpost). Pour l'envoi à grand volume, les intégrations API sont préférées à SMTP.
Approche de configuration : Les identifiants du fournisseur de messagerie ne sont pas définis via des variables de module. Après le déploiement, naviguez vers l'interface d'administration de Listmonk et configurez :
- Settings → SMTP pour l'envoi basé sur SMTP.
- Settings → Sending settings pour la limitation de débit (messages par minute), la concurrence et les paramètres de nouvelle tentative.
Pour conserver ces paramètres lors des redéploiements, exportez les paramètres de Listmonk sous forme de dump SQL et importez-les lors de la restauration.
B. Importation et récupération de sauvegardes
Lorsque enable_backup_import = true, un job Cloud Run dédié restaure une sauvegarde de base de données PostgreSQL existante dans l'instance Cloud SQL provisionnée. Cela s'exécute après le job db-init et avant le déploiement du service Listmonk.
| 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_uri | 7 | "" | URI GCS complet (par exemple, 'gs://my-bucket/listmonk-backup.sql') ou ID de fichier Google Drive. |
backup_format | 7 | 'sql' | Format du fichier de sauvegarde. Options : sql, tar, gz, tgz, tar.gz, zip. |
C. Observabilité et alertes
Un test de disponibilité Cloud Monitoring peut interroger le endpoint /api/health depuis plusieurs emplacements mondiaux ; il est désactivé par défaut. Des règles d'alerte personnalisées peuvent surveiller les métriques Cloud Run et notifier support_users.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
uptime_check_config | 14 | { enabled=false, path="/api/health" } | Test de disponibilité : enabled, path, check_interval, timeout. Désactivé par défaut. |
alert_policies | 14 | [] | Règles 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 règles d'alerte. |
9. Exploration avec la console GCP
Après un déploiement réussi, utilisez la console GCP pour vérifier et explorer le déploiement Listmonk.
Service Cloud Run
Naviguez vers Cloud Run dans la console et sélectionnez le service listmonk (nommé app<listmonk><tenant><id>). Principales zones à examiner :
- Onglet Révisions : Affiche toutes les révisions de conteneurs déployées, les pourcentages d'allocation de trafic et les digests d'images de conteneurs. La révision active doit afficher le tag
latestou une version spécifique. - Onglet Journaux : Diffuse les journaux des conteneurs Cloud Run en temps réel. Filtrez par
severity=ERRORpour faire apparaître les problèmes de démarrage de Listmonk ou de connexion à la base de données. Au premier démarrage, recherchez les lignes de journal d'installation du schéma de Listmonk (Running install...,Admin user created). - Onglet Métriques : Affiche le nombre de requêtes, la latence des requêtes (P50/P95/P99), le nombre d'instances et la latence de démarrage des conteneurs. Un pic du nombre d'instances lors d'un envoi de campagne important est attendu.
- Onglet YAML : Affiche la spécification complète du service Cloud Run, y compris les noms des variables d'environnement (pas les valeurs), les montages de volumes, la configuration des sondes de santé et les limites de ressources.
Secret Manager
Naviguez vers Secret Manager et filtrez par le nom du déploiement. Deux secrets sont pertinents :
app<listmonk><tenant><id>-admin-passwordou similaire — le secret qui soutient la variable d'environnement de conteneurLISTMONK_ADMIN_PASSWORD. Cliquez sur View secret versions pour confirmer qu'une version existe. Ne cliquez pas sur View secret value en production.app<listmonk><tenant><id>-db-password— le secret du mot de passe PostgreSQL. Utilisé à la fois par le service Cloud Run et le jobdb-init.
Sélectionnez l'un ou l'autre secret et examinez l'onglet Replication pour confirmer que le secret est répliqué dans la région de déploiement.
Cloud SQL
Naviguez vers SQL et ouvrez l'instance Cloud SQL Listmonk. Principales zones :
- Vue d'ensemble : Confirme le moteur PostgreSQL 15, le niveau de l'instance et la taille du stockage.
- Onglet Bases de données : La base de données
listmonkdoit être listée. Après le premier déploiement, les tables de schéma de Listmonk seront présentes. - Onglet Utilisateurs : L'utilisateur d'application
listmonkdoit être listé. - Onglet Connexions : Examinez les réseaux autorisés et confirmez que seul le proxy d'authentification Cloud SQL (via le SA Cloud Run) a accès. Aucune IP publique ne devrait être requise.
- Onglet Sauvegardes : Confirme le calendrier de sauvegarde automatisé et liste les fichiers de sauvegarde récents.
- Onglet Opérations : Affiche les opérations récentes, y compris l'historique de connexion du job
db-init.
Cloud Build
Naviguez vers Cloud Build → Historique pour examiner les exécutions de build récentes. Le déploiement initial déclenche un build pour empaqueter l'image conteneur Listmonk. Chaque entrée de build affiche le tag de l'image, la durée du build et tous les journaux au niveau des étapes. Cliquez sur un build pour voir les étapes du Dockerfile et le docker push final vers Artifact Registry.
Artifact Registry
Naviguez vers Artifact Registry et ouvrez le dépôt listmonk. Le dépôt liste tous les tags d'image poussés avec leurs digests, horodatages de poussée et tailles. Confirmez que la dernière image est présente.
Cloud Monitoring
Naviguez vers Monitoring → Tests de disponibilité et trouvez le test de disponibilité Listmonk. Le test interroge /api/health depuis plusieurs emplacements mondiaux. Un statut vert confirme que le service est accessible et sain depuis le réseau mondial de GCP.
Naviguez vers Monitoring → Alertes pour voir toutes les règles d'alerte actives créées par le module. support_users sont automatiquement ajoutés comme destinataires des canaux de notification.
10. Exploration avec gcloud
Les commandes gcloud suivantes offrent une visibilité opérationnelle sur le déploiement Listmonk Cloud Run. Remplacez PROJECT_ID, REGION et SERVICE_NAME par vos valeurs de déploiement. Le nom du service suit le modèle app<listmonk><tenant><id> — récupérez-le depuis la sortie Terraform service_name.
Récupérer l'URL et la configuration du service :
# Get the Cloud Run service URL
gcloud run services describe SERVICE_NAME \
--region=REGION \
--project=PROJECT_ID \
--format="value(status.url)"
# Describe the full service configuration
gcloud run services describe SERVICE_NAME \
--region=REGION \
--project=PROJECT_ID \
--format=yaml
Vérifier la santé et les révisions du service :
# List all revisions and their traffic allocations
gcloud run revisions list \
--service=SERVICE_NAME \
--region=REGION \
--project=PROJECT_ID \
--format="table(metadata.name,status.conditions[0].status,spec.containers[0].image,status.observedGeneration)"
# Check revision traffic split
gcloud run services describe SERVICE_NAME \
--region=REGION \
--project=PROJECT_ID \
--format="value(spec.traffic[].percent,spec.traffic[].revisionName)"
Diffuser et filtrer les journaux :
# Tail live logs from the Listmonk service
gcloud logging read \
"resource.type=cloud_run_revision AND resource.labels.service_name=SERVICE_NAME" \
--project=PROJECT_ID \
--limit=50 \
--freshness=10m \
--format="table(timestamp,severity,textPayload)"
# Filter for errors only
gcloud logging read \
"resource.type=cloud_run_revision AND resource.labels.service_name=SERVICE_NAME AND severity>=ERROR" \
--project=PROJECT_ID \
--limit=20
# View db-init job logs
gcloud logging read \
"resource.type=cloud_run_job AND resource.labels.job_name~db-init" \
--project=PROJECT_ID \
--limit=30 \
--format="table(timestamp,severity,textPayload)"
Inspecter les secrets :
# List all Secret Manager secrets in the project (filter by deployment)
gcloud secrets list \
--project=PROJECT_ID \
--filter="name~listmonk" \
--format="table(name,replication.automatic,createTime)"
# Check secret versions for the admin password
gcloud secrets versions list LISTMONK_ADMIN_PASSWORD_SECRET_NAME \
--project=PROJECT_ID \
--format="table(name,state,createTime)"
# Access the admin password (use with caution — only in break-glass scenarios)
gcloud secrets versions access latest \
--secret=LISTMONK_ADMIN_PASSWORD_SECRET_NAME \
--project=PROJECT_ID
Inspection Cloud SQL :
# List Cloud SQL instances
gcloud sql instances list \
--project=PROJECT_ID \
--format="table(name,databaseVersion,settings.tier,region,state)"
# Describe the Listmonk instance
gcloud sql instances describe SQL_INSTANCE_NAME \
--project=PROJECT_ID \
--format="yaml(databaseVersion,settings.tier,settings.ipConfiguration,state)"
# List databases on the instance
gcloud sql databases list \
--instance=SQL_INSTANCE_NAME \
--project=PROJECT_ID
# List users on the instance
gcloud sql users list \
--instance=SQL_INSTANCE_NAME \
--project=PROJECT_ID
Jobs Cloud Run (db-init) :
# List all Cloud Run Jobs in the region
gcloud run jobs list \
--region=REGION \
--project=PROJECT_ID \
--format="table(metadata.name,status.conditions[0].status,metadata.creationTimestamp)"
# Describe the db-init job
gcloud run jobs describe JOB_NAME \
--region=REGION \
--project=PROJECT_ID
# Manually execute the db-init job (e.g., after a database recreation)
gcloud run jobs execute JOB_NAME \
--region=REGION \
--project=PROJECT_ID \
--wait
Disponibilité et surveillance :
# List uptime checks
gcloud monitoring uptime list-configs \
--project=PROJECT_ID \
--format="table(displayName,httpCheck.path,period,checkerType)"
# List Cloud Monitoring alert policies
gcloud alpha monitoring policies list \
--project=PROJECT_ID \
--format="table(displayName,enabled,conditions[0].displayName)"
Artifact Registry :
# List images in the Listmonk repository
gcloud artifacts docker images list REGION-docker.pkg.dev/PROJECT_ID/listmonk \
--project=PROJECT_ID \
--format="table(image,tags,createTime)" \
--include-tags
# List all tags for the Listmonk image
gcloud artifacts docker tags list REGION-docker.pkg.dev/PROJECT_ID/listmonk/listmonk \
--project=PROJECT_ID
11. Comportements gérés par la plateforme
Les comportements suivants sont appliqués automatiquement par Listmonk CloudRun, quelles que soient les valeurs des variables.
| Comportement | Détail |
|---|---|
| PostgreSQL 15 requis | Valeur par défaut database_type = "POSTGRES_15". Listmonk ne prend pas en charge MySQL ou d'autres moteurs. |
| Mot de passe administrateur auto-généré | Généré par Listmonk Common et injecté dans le conteneur sous le nom LISTMONK_ADMIN_PASSWORD (un seul underscore ; le nom de style de configuration déprécié LISTMONK_app__admin_password a été supprimé). Stocké dans Secret Manager, jamais dans l'état. |
| Variable d'environnement du mot de passe DB pré-définie | db_password_env_var_name = "LISTMONK_db__password" est pré-configuré de sorte que App CloudRun injecte le mot de passe de la base de données sous le nom correct pour la configuration de Listmonk. |
| Chemin de téléchargement GCS Fuse | LISTMONK_upload__provider=filesystem et LISTMONK_upload__filesystem__upload_path=/listmonk/uploads sont injectés automatiquement. Montez un bucket GCS à /listmonk/uploads via gcs_volumes pour les téléchargements persistants. |
| Job db-init par défaut | Fourni par Listmonk Common lorsque initialization_jobs = []. La base de données et l'utilisateur PostgreSQL sont créés automatiquement. |
| Mise en miroir d'images activée | enable_image_mirroring = true par défaut. L'image de base Listmonk est mise en miroir dans Artifact Registry avant le déploiement. |
| Redis désactivé par défaut | enable_redis = false. Listmonk ne nécessite pas Redis pour un fonctionnement standard. |
| Répertoire des scripts | scripts_dir est résolu en Listmonk_Common/scripts au moment de l'apply. |
12. Référence des variables
Toutes les variables configurables par l'utilisateur exposées par Listmonk CloudRun, triées par groupe d'interface utilisateur puis par ordre.
| Variable | Groupe | Valeur par défaut | Description |
|---|---|---|---|
project_id | 1 | — | ID du projet GCP. Requis. |
region | 1 | 'us-central1' | Région GCP pour toutes les ressources. |
tenant_id | 2 | 'demo' | Court suffixe 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 | 'listmonk' | Nom de ressource de base. Ne pas modifier après le déploiement initial. |
display_name | 3 | 'Listmonk' | Nom lisible par l'homme. |
description | 3 | (Description Listmonk) | Description du service. |
application_version | 3 | 'latest' | Tag de l'image conteneur Listmonk. |
admin_username | 3 | 'listmonk' | Déclaré mais actuellement inutilisé par main.tf — le nom d'utilisateur administrateur amorcé est codé en dur à "admin" via LISTMONK_ADMIN_USER, quelle que soit la valeur de cette variable. |
deploy_application | 4 | true | Définissez false pour un déploiement uniquement d'infrastructure. |
cpu_limit | 4 | '1000m' | CPU par instance. |
memory_limit | 4 | '512Mi' | Mémoire par instance. |
min_instance_count | 4 | 0 | Nombre minimal d'instances en cours d'exécution. Mise à l'échelle à zéro par défaut. |
max_instance_count | 4 | 1 | Nombre maximal d'instances en cours d'exécution. |
cpu_always_allocated | 4 | true | Maintient le CPU alloué sur une instance en cours d'exécution afin que l'expéditeur de campagne asynchrone puisse terminer après le retour de la requête de déclenchement. |
execution_environment | 4 | 'gen2' | Gen2 requis pour les montages GCS Fuse. |
timeout_seconds | 4 | 300 | Durée maximale de la requête en secondes. |
enable_cloudsql_volume | 4 | true | Sidecar Auth Proxy pour les connexions de socket Unix à PostgreSQL. |
cloudsql_volume_mount_path | 4 | '/cloudsql' | Chemin du conteneur pour le socket Unix Auth Proxy. |
container_port | 4 | 9000 | Port HTTP natif de Listmonk. |
container_protocol | 4 | 'http1' | 'http1' ou 'h2c'. |
enable_image_mirroring | 4 | true | Met en miroir l'image Listmonk dans Artifact Registry. |
traffic_split | 4 | [] | Allocation de trafic Canary/blue-green. |
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 clair. |
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' (URI complet) ou 'gdrive' (ID de fichier). |
backup_uri | 7 | "" | URI GCS complet ou ID de fichier Google Drive. |
backup_format | 7 | 'sql' | Format de sauvegarde. Options : sql, tar, gz, tgz, tar.gz, zip. |
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. Requis lors du premier apply. 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 lors du déploiement. |
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. |
nfs_instance_name | 9 | "" | Nom d'une VM NFS GCE existante. Laissez vide pour la découverte automatique. |
nfs_instance_base_name | 9 | 'app-nfs' | Nom de base pour la VM NFS intégrée. L'ID de déploiement est ajouté. |
enable_cloud_armor | 10 | false | Provisionne un équilibreur de charge HTTPS global + Cloud Armor WAF. |
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 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 | Définissez false pour ignorer la création du bucket GCS. |
storage_buckets | 11 | [] | Buckets GCS supplémentaires à provisionner. |
enable_nfs | 11 | false | Provisionne un stockage partagé NFS. Non requis pour les déploiements Listmonk standard. |
nfs_mount_path | 11 | '/mnt/nfs' | Chemin du conteneur où NFS est monté. |
gcs_volumes | 11 | [] | Buckets GCS à monter via GCS Fuse. Montez le bucket de téléchargements à /listmonk/uploads. |
manage_storage_kms_iam | 11 | false | Crée une clé 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. |
database_type | 12 | 'POSTGRES_15' | Moteur Cloud SQL. Ne pas modifier — Listmonk nécessite PostgreSQL. |
db_name | 12 | 'listmonk' | Nom de la base de données PostgreSQL. Ne pas modifier après le déploiement initial. |
db_user | 12 | 'listmonk' | Utilisateur de l'application PostgreSQL. |
db_password_env_var_name | 12 | 'LISTMONK_db__password' | Nom de la variable d'environnement pour l'injection du mot de passe de la base de données. Ne pas modifier. |
database_password_length | 12 | 32 | Longueur du mot de passe auto-généré. Plage : 16–64. |
enable_auto_password_rotation | 12 | false | Rotation automatisée des mots de passe sans interruption de service. |
rotation_propagation_delay_sec | 12 | 90 | Secondes à attendre après la rotation avant de redémarrer le service. |
initialization_jobs | 13 | [] | Jobs Cloud Run ponctuels. Laissez vide pour le job db-init par défaut. |
cron_jobs | 13 | [] | Jobs Cloud Run planifiés récurrents. |
startup_probe | 14 | { enabled=true, type="TCP", path="/api/health", initial_delay_seconds=30, failure_threshold=30, ... } | Sonde de démarrage. TCP — /api/health nécessite une authentification de session. |
liveness_probe | 14 | { enabled=false, type="HTTP", path="/api/health", initial_delay_seconds=30, failure_threshold=3, ... } | Sonde de vivacité. Désactivée par défaut. |
uptime_check_config | 14 | { enabled=false, path="/api/health" } | Test de disponibilité Cloud Monitoring. Désactivé par défaut. |
alert_policies | 14 | [] | Règles d'alerte métrique Cloud Monitoring. |
enable_redis | 21 | false | Intégration Redis. Non requise pour Listmonk. |
redis_host | 21 | "" | Nom d'hôte/IP Redis. |
redis_port | 21 | '6379' | Port TCP Redis (chaîne). |
redis_auth | 21 | "" | Mot de passe AUTH Redis. Sensible. |
enable_vpc_sc | 22 | false | Enregistre les appels API dans le périmètre VPC-SC du projet. |
vpc_cidr_ranges | 22 | [] | Plages CIDR de sous-réseau VPC pour le niveau d'accès réseau VPC-SC. |
vpc_sc_dry_run | 22 | true | Enregistre les violations VPC-SC sans bloquer. Définissez false pour appliquer. |
organization_id | 22 | "" | ID d'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. |
13. 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 d'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 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. |
14. Pièges de configuration et valeurs par défaut judicieuses
Niveaux de risque : Critique (perte de données, panne totale, 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 | (requis) | Critique | Pas de valeur par défaut — le déploiement échoue immédiatement. |
database_type | "POSTGRES_15" | Critique | Listmonk prend exclusivement en charge PostgreSQL. Changer pour MySQL ou SQL Server entraîne l'échec de Listmonk au démarrage. |
db_name | "listmonk" | Critique | Immuable après le premier déploiement — la modification entraîne la recréation de la base de données par Terraform, détruisant tous les abonnés, campagnes et paramètres. |
db_user | "listmonk" | Critique | Immuable après le premier déploiement — la modification recrée l'utilisateur Cloud SQL et invalide tous les identifiants stockés. |
db_password_env_var_name | "LISTMONK_db__password" | Critique | Listmonk lit ce nom de variable d'environnement exact pour son mot de passe de base de données. Le modifier entraîne l'échec de la connexion de Listmonk à PostgreSQL au démarrage. |
min_instance_count | 0 | Faible | La mise à l'échelle à zéro est la valeur par défaut et est sûre : l'utilisateur API auto-réparateur amorcé par la base de données signifie qu'une instance démarrée à froid recharge toujours un identifiant valide, et cpu_always_allocated = true maintient l'expéditeur de campagne asynchrone de l'instance réveillée en cours d'exécution jusqu'à la fin. Augmentez à 1 uniquement pour une utilisation administrative interactive intensive où les démarrages à froid sont indésirables. |
memory_limit | "512Mi" | Moyen | Suffisant pour les petites listes. Les listes avec des millions d'abonnés ou un traitement de campagne concurrent peuvent épuiser 512 Mio sous charge. Augmentez à 1–2 Gio pour les déploiements de production avec un grand nombre d'abonnés. |
enable_cloudsql_volume | true | Critique | Listmonk se connecte à PostgreSQL via le socket Unix du proxy d'authentification par défaut. La désactivation du volume sans fournir de chemin de connexion TCP entraîne l'échec de toutes les opérations de base de données. |
gcs_volumes | [] | Moyen | Sans un volume GCS Fuse à /listmonk/uploads, les téléchargements de fichiers multimédias sont stockés de manière éphémère sur le système de fichiers du conteneur et perdus lorsque la révision est remplacée. Configurez pour tout déploiement qui accepte les pièces jointes ou les téléchargements de médias. |
ingress_settings | "all" | Moyen | "all" expose l'interface d'administration de Listmonk à l'internet public. Pour les déploiements de newsletters internes, envisagez enable_iap = true ou ingress_settings = "internal". |
enable_cloud_armor | false | Moyen | Sans Cloud Armor, l'API Listmonk et l'interface d'administration sont exposées sans protection WAF. Les listes d'abonnés à grande échelle sont des cibles précieuses pour le scraping. Recommandé pour tout déploiement de production. |
backup_retention_days | 7 | Moyen | Sept jours sont insuffisants pour les bases de données d'abonnés de production. La perte de données d'abonnés, d'historique de campagne et d'enregistrements de désabonnement est un risque de conformité sérieux. Augmentez à plus de 30 jours pour tout déploiement de production. |
enable_backup_import | false | Critique | Nécessite que backup_uri soit un chemin GCS ou Drive valide et accessible. L'activation avec un backup_uri vide entraîne l'échec du job Cloud Run de restauration lors de l'apply. |
vpc_egress_setting | "PRIVATE_RANGES_ONLY" | Moyen | Listmonk doit atteindre des fournisseurs SMTP/API externes pour l'envoi de campagnes. PRIVATE_RANGES_ONLY permet une sortie publique directe. Changer pour "ALL_TRAFFIC" avec un pare-feu VPC restrictif bloquera les connexions SMTP/API sortantes et empêchera silencieusement la livraison des campagnes. |
secret_propagation_delay | 30 | Faible | Occasionnellement insuffisant dans les configurations multi-régions. Augmentez à 60–90 s si les secrets ne sont pas trouvés lors de l'apply. |
15. 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.
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 : Listmonk sur Cloud Run — déployez-le étape par étape, avec les écrans de console et les commandes à chaque étape.
- Module Listmonk 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 Listmonk — la configuration partagée par les deux cibles de déploiement.
- Déployé aux côtés de Twenty CRM sur Google Cloud Run, Cal.com sur Google Cloud Run, Chatwoot sur Google Cloud Run, Metabase sur Google Cloud Run dans la solution CRM & Opérations de vente.
Need RAD to do something it does not do yet? Request it on the roadmap, or vote on what is already there.