Gokapi sur Google Cloud Run
Gokapi est un serveur de partage de fichiers léger et auto-hébergé écrit en Go — une alternative auto-hébergée à WeTransfer. Les utilisateurs téléchargent des fichiers et génèrent des liens de téléchargement partageables avec des dates d'expiration, des limites de nombre de téléchargements et une protection par mot de passe facultatives, le tout soutenu par une base de données SQLite interne (aucune base de données externe requise). Ce module déploie Gokapi sur Cloud Run v2 au-dessus de la fondation App_CloudRun, qui provisionne et gère l'infrastructure Google Cloud partagée.
Ce guide se concentre sur les services cloud utilisés par Gokapi et sur la manière de les explorer et de les exploiter à partir de la console Google Cloud et de la ligne de commande. Pour les mécanismes communs à chaque application Cloud Run — identité de service, ingress et équilibrage de charge, mise à l'échelle et concurrence, CI/CD, Cloud Armor, IAP, Binary Authorization, VPC Service Controls, sauvegardes et cycle de vie du déploiement — reportez-vous au guide de la fondation App_CloudRun plutôt que de les répéter ici.
Ce que coûte Gokapi sur RAD, et comment cela se compare
L'exécution de Gokapi dans votre propre projet Google Cloud coûte environ 32,57 $ US/mois en frais Google Cloud, en plus d'un coût de module RAD unique de 40 crédits (36 crédits — 10 % de moins — dans un projet géré par RAD). Gokapi est un serveur de partage de fichiers léger et auto-hébergé écrit en Go. Si vous déployez dans un projet géré par RAD, vous pouvez tout mettre en pause gratuitement et le reprendre plus tard — voir « Mettre en pause gratuitement » ci-dessous.
Gokapi est également disponible sur GKE — voir le guide GKE si vous avez besoin d'une orchestration basée sur Kubernetes ; ce guide couvre l'option Cloud Run moins coûteuse.
Ce que vous payez sur RAD
| Votre propre projet | Projet géré par RAD | |
|---|---|---|
| Frais de module | 40 crédits (une seule fois) | 36 crédits (une seule fois, 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 : ils sont toujours facturés à la minute pour le temps de build | Idem |
| Coût d'exécution Google Cloud | ~32,57 $ US/mois, facturé à votre propre compte de facturation Google au prix catalogue | ~23 crédits/jour (~2,30 $ US/jour), mesuré à l'heure 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).
Coût d'exécution par défaut dans votre propre projet
| Ressource | $ US/mois (prix catalogue Google, us-central1) |
|---|---|
| Cloud Run, 1x vCPU / 1 GiB (chaud) | 13,14 $ US |
| Serveur de fichiers NFS/cache (petite VM) | 13,43 $ US |
| Cloud NAT et réseau | 5 $ US |
| Cloud Storage (modules complémentaires, sauvegardes) | 1 $ US |
| Total | 32,57 $ US |
Comment cela se compare
- Il n'existe pas de version officiellement hébergée/cloud de Gokapi à comparer, donc la comparaison honnête se fait avec une infrastructure auto-gérée, et non avec un SaaS concurrent.
- Un VPS nu dimensionné à environ 1 vCPU / 1 GiB — un Hetzner CPX22 (2 vCPU/4 Go, ~24 $ US/mois), un DigitalOcean 2 vCPU/4 Go Droplet (24 $ US/mois), ou le propre Compute Engine e2-standard-2 de GCP (2 vCPU/8 Go, ~49 $ US/mois) — est généralement moins cher que le prix affiché de RAD ; un VPS d'une ou deux tailles inférieures le serait encore plus.
- Ce que ce prix inférieur n'inclut pas, c'est le temps de l'administrateur : patcher le système d'exploitation, faire pivoter les sauvegardes de base de données, renouveler les certificats TLS et surveiller les temps d'arrêt. Les services Cloud SQL, Secret Manager et de surveillance gérés par RAD le font pour vous, ce qui est le véritable compromis, et non le prix affiché.
- RAD ne prétend pas être moins cher qu'un VPS nu en termes d'argent — ce n'est généralement pas le cas. L'intérêt de RAD est ce qui est géré pour vous.
Mettre en pause gratuitement : supprimer un projet géré par RAD, le restaurer lorsque vous en avez besoin
Si Gokapi est exécuté dans un projet géré par RAD, vous pouvez arrêter de le payer entièrement sans le détruire. La suppression de ce projet délie d'abord sa facturation, puis demande à Google de supprimer purement et simplement le projet — la suppression logicielle récupérable de 30 jours de Google. Contrairement à la suppression du module Gokapi seul, cela ne démantèle pas Cloud SQL, aucune VM ou 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à délié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, seront utilisables après sa restauration, de sorte que la restauration ne peut 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.
La restauration, dans les 30 jours et uniquement par le propriétaire du projet, demande à Google de restaurer 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 — il s'agit d'une vérification, pas d'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. Les frais de module de 36 crédits ne sont pas facturés à nouveau.
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 quoi Google le supprime définitivement — et la restauration est admise comme la création d'un nouveau projet, de sorte que votre solde de crédits achetés doit toujours dépasser le seuil du palier (100 crédits pour le palier sandbox que la plupart des utilisations d'étude/démo conviennent). Google affirme que la plupart des services sont à nouveau pleinement fonctionnels 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 logicielle 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é Gokapi 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
Si Gokapi se trouve dans votre propre projet (ou si plus de 30 jours se sont écoulés sur un projet géré par RAD), la façon d'arrêter de payer est de supprimer le déploiement et de le redéployer plus tard lorsque vous en aurez à nouveau besoin.
Un redéploiement coûte à nouveau les frais de module (les builds sont inclus) : 40 crédits (4,00 $ US) dans votre propre projet, ou 36 crédits sur un projet géré par RAD.
La suppression ne permet d'économiser de l'argent que si Gokapi reste inutilisé assez longtemps pour compenser le coût de redéploiement par rapport à son propre coût d'exécution : environ 5 jours ou plus d'inactivité dans votre propre projet (par rapport à sa facture Google Cloud d'environ 32,57 $ US/mois), ou environ 3 jours ou plus d'inactivité dans un projet géré par RAD (par rapport à ses ~23 crédits/jour).
Priorité aux données : les sauvegardes nocturnes vont dans un bucket à l'intérieur du déploiement et sont supprimées avec celui-ci, 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 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 cabinets 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 diminue, 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 remet 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 propres frais de RAD et les estimations de crédits quotidiens ; documentation de Google sur la suppression/restauration de projets pour les mécanismes de pause/restauration.
1. Vue d'ensemble
Gokapi s'exécute en tant que conteneur binaire Go unique sur Cloud Run v2, sans base de données externe. Le déploiement relie un petit ensemble ciblé de services Google Cloud :
| Capacité | Service Google Cloud | Notes |
|---|---|---|
| Calcul | Cloud Run v2 | Conteneur binaire Go sur le port 53842, 1000m CPU / 1Gi mémoire par défaut ; révision unique, min_instance_count = 1 / max_instance_count = 1 |
| Base de données | Aucune (SQLite, sur stockage monté) | Pas de Cloud SQL — database_type est fixé à NONE par Gokapi_Common ; Gokapi écrit sa propre base de données SQLite sous GOKAPI_CONFIG_DIR |
| Persistance des fichiers et de la base de données | Bucket Cloud Storage monté via GCS Fuse à /data | Le seul chemin de persistance disponible sur Cloud Run — il n'y a pas de concept de PVC/stockage par blocs ici, contrairement au PVC StatefulSet utilisé par Gokapi_GKE |
| Stockage d'objets | Cloud Storage | Le bucket suffixé storage est auto-provisionné et, sur Cloud Run, est toujours monté (pas inactif, contrairement à la variante GKE) |
| Secrets | Secret Manager | Seulement une clé API d'opérateur facultative (GOKAPI_API_KEY) ; pas de secret généré obligatoire |
| Ingress | URL Cloud Run / Équilibrage de charge Cloud | ingress_settings = "all" par défaut, donc le service est publiquement accessible dès le départ |
Valeurs par défaut judicieuses à connaître d'emblée :
- Pas de Cloud SQL, jamais.
database_typeest fixé en dur àNONEparGokapi_Common— les variables de base de données génériques de ce module (sql_instance_name,application_database_name,db_*_env_var_name, etc.) sont transmises à la fondation uniquement pour la compatibilité de la mise en miroir des variables et n'ont aucun effet. - SQLite + fichiers téléchargés persistent via un montage GCS Fuse, pas un
véritable volume de blocs. Cloud Run n'a pas d'équivalent PVC/StatefulSet,
donc
Gokapi_Commonmonte le bucketstorageauto-provisionné à/dataen utilisant GCS Fuse (enable_gcs_storage_volumepar défauttrueà l'intérieur deGokapi_Common, et cette variante Cloud Run n'expose aucune variable pour le désactiver — ce basculement n'existe que surGokapi_GKE, lié àstateful_pvc_enabled).GOKAPI_CONFIG_DIR = /data/config(configuration + la base de données SQLite) etGOKAPI_DATA_DIR = /data/data(fichiers téléchargés) vivent tous deux sur ce montage. GCS Fuse ne fournit pas de verrouillage de fichiers POSIX réel, ce qui est exactement la sémantique dont dépend une application basée sur SQLite — voir Section 6 pour le risque que cela comporte. - Le bucket GCS
storageest essentiel ici, pas décoratif. Contrairement àGokapi_GKE(où le bucket reste inutilisé derrière un PVC StatefulSet par défaut), sur Cloud Run ce bucket est la couche de persistance pour la base de données SQLite et chaque fichier téléchargé. - Instance unique par conception.
min_instance_count = 1,max_instance_count = 1. La base de données SQLite de Gokapi est à écrivain unique sans mécanisme de clustering/réplication, donc ne pas dépasser 1 instance. - Aucun mot de passe administrateur n'est auto-généré. Gokapi n'a pas de
secret obligatoire — le compte administrateur est créé de manière
interactive via l'assistant de configuration de première exécution de Gokapi
à
/setup(la sortiesetup_url). Tant qu'il n'est pas terminé, toutes les autres pages —/inclus — répondent "Le serveur est en mode maintenance, veuillez réessayer dans quelques minutes". - Clé API d'opérateur facultative, requise par défaut.
enable_api_key(par défauttruesurGokapi_CloudRun) génère un jeton aléatoire de 32 caractères, le stocke dans Secret Manager et l'injecte en tant queGOKAPI_API_KEYvia le mécanismemodule_secret_env_varsdu module. Il s'agit d'un jeton de commodité uniquement — les propres clés API de téléchargement/téléchargement de Gokapi sont normalement générées à partir de l'interface utilisateur d'administration après la configuration. Il est par défauttrueici (contrairement au propre défautGokapi_Commondefalse) en raison de la garde au moment de la planification ci-dessous. - Redis est désactivé de force.
main.tfcode en durenable_redis = falseà la fondation quelle que soit la valeur de la variable — Gokapi n'a aucune utilité pour Redis. - L'ingress public est activé par défaut, et il est contrôlé au moment de la
planification par la clé API.
ingress_settings = "all"correspond à l'objectif de Gokapi de générer des liens de téléchargement partageables accessibles depuis l'extérieur du VPC — mais cela signifie également que l'assistant de configuration de première exécution non authentifié est publiquement accessible jusqu'à ce qu'un compte administrateur soit réclamé. La gardevalidation.tfdevalidate_gokapi_configurationéchoue la planification chaque fois queingress_settings = "all"est combiné avecenable_api_key = false, de sorte que le couplage par défaut du module ("all"+enable_api_key = true) est la seule combinaison prête à l'emploi qui se planifie proprement ; changerenable_api_keyenfalsenécessite également de restreindreingress_settingsà"internal"(ou"internal-and-cloud-load-balancing"). - Construit comme une image personnalisée mince, épinglée contre le piège de
la balise
latest. L'image est un wrapperFROM f0rc3/gokapi:${GOKAPI_VERSION}d'une seule ligne afin que la fondation puisse la refléter dans Artifact Registry.GOKAPI_VERSION(un argument de build spécifique à l'application que l'injection génériqueAPP_VERSIONde la fondation ne touche pas) se résout en unv1.9.6épinglé lorsqueapplication_version = "latest".
2. Services Google Cloud et comment les explorer
Toutes les commandes supposent que PROJECT et REGION sont définis. Les noms
de services et de ressources sont signalés dans les Sorties du
déploiement.
A. Cloud Run — le service Gokapi
Gokapi s'exécute en tant que service/révision Cloud Run v2 unique. min_instance_count = 1
maintient une instance chaude en permanence (évitant les démarrages à froid et
préservant l'écrivain SQLite unique) ; max_instance_count = 1 ne doit pas être augmenté.
- Console : Cloud Run → sélectionnez le service pour les révisions, le trafic, les journaux et les métriques.
- CLI :
gcloud run services list --project "$PROJECT" --region "$REGION"
gcloud run services describe <service-name> --project "$PROJECT" --region "$REGION"
gcloud run revisions list --service <service-name> --project "$PROJECT" --region "$REGION"
Voir App_CloudRun pour la mise à l'échelle, la concurrence, l'environnement d'exécution et la répartition du trafic.
B. Stockage persistant — le montage GCS Fuse à /data
Il n'y a pas d'instance Cloud SQL ni de PVC. Au lieu de cela, le bucket Cloud
Storage storage auto-provisionné est monté dans le conteneur en tant que volume
GCS Fuse à /data, et GOKAPI_CONFIG_DIR=/data/config (base de données de métadonnées SQLite +
configuration de l'application) et GOKAPI_DATA_DIR=/data/data (fichiers téléchargés) vivent
sous ce montage unique. Ce montage est inconditionnel sur ce module — il n'y a
pas de variable ici pour le désactiver (comparez Gokapi_GKE, qui désactive le
volume GCS équivalent chaque fois que son PVC StatefulSet est activé).
- Console : Cloud Storage → Buckets, pour le contenu du bucket ; Cloud Run → service → Révisions → Volumes, pour confirmer le montage.
- CLI :
gcloud storage buckets list --project "$PROJECT" --filter="name~storage"
gcloud storage ls gs://<storage-bucket>/config gs://<storage-bucket>/data
Voir App_CloudRun pour la sémantique du montage GCS Fuse et sa mise en garde de performance déclarée pour les charges de travail de type base de données, et Section 6 ci-dessous pour savoir pourquoi cela est important spécifiquement pour la base de données SQLite de Gokapi.
C. Secret Manager — la clé API facultative
Gokapi ne crée aucun secret obligatoire. Le seul secret que ce module peut
créer est le jeton de commodité d'opérateur GOKAPI_API_KEY facultatif, contrôlé par
enable_api_key (par défaut false). Ce secret n'est pas affiché dans les
Sorties de ce module — recherchez-le directement par son nom.
- Console : Sécurité → Secret Manager.
- CLI :
gcloud secrets list --project "$PROJECT" --filter="name~api-key"
gcloud secrets versions access latest --secret=<api-key-secret-name> --project "$PROJECT"
Voir App_CloudRun pour les détails d'injection et de rotation des secrets.
D. Réseau et ingress
Le service est accessible à son URL run.app par défaut (ingress_settings = "all"),
correspondant à l'objectif de Gokapi de générer des liens de téléchargement
partageables en externe. Un équilibreur de charge HTTPS externe avec Cloud
Armor, un domaine personnalisé et Cloud CDN peuvent être superposés via les
variables du groupe 10.
- Console : Cloud Run (URL du service) ; Services réseau → Équilibrage de charge.
- CLI :
gcloud run services describe <service-name> --region "$REGION" --format='value(status.url)'
gcloud compute addresses list --project "$PROJECT"
Voir App_CloudRun.
E. Cloud Logging et Monitoring
Les journaux des conteneurs sont acheminés vers Cloud Logging ; les métriques Cloud Run sont acheminées vers Cloud Monitoring, avec des tests de disponibilité et des politiques d'alerte facultatifs (tous deux désactivés par défaut).
- Console : Logging → Explorateur de journaux ; Monitoring → Tableaux de bord / Alertes.
- CLI :
gcloud run services logs read <service-name> --project "$PROJECT" --region "$REGION" --limit 50
3. Comportement de l'application Gokapi
- Aucun job d'initialisation ne s'exécute par défaut.
Gokapi_Commonne fournit aucune entréeinitialization_jobspar défaut — Gokapi gère son propre stockage et n'a pas besoin de base de données pour démarrer. Seuls les jobs fournis par l'utilisateur (chargement ou migration de données personnalisées) apparaissent sous Cloud Run Jobs. - La configuration au premier démarrage est entièrement interactive. Il n'y
a pas de drapeau d'auto-installation ni de mot de passe administrateur
généré. La première personne à ouvrir
/setupsur l'URL publique du service (la sortiesetup_url) crée le compte administrateur via l'assistant de Gokapi — celui qui y arrive en premier./lui-même n'affiche que "Le serveur est en mode maintenance" jusque-là. - Où les données persistent physiquement.
GOKAPI_CONFIG_DIR=/data/config(la base de données de métadonnées SQLite et la configuration de l'application) etGOKAPI_DATA_DIR=/data/data(fichiers téléchargés) se trouvent toutes deux sur le montage GCS Fuse du bucketstorageà/data. Il n'y a pas de commutateur intégré pour déplacer cela vers NFS ou un backend différent ; cela nécessiterait de remplacer manuellementenvironment_variableset d'activerenable_nfs. - Écrivain unique, instance unique.
min_instance_count = 1/max_instance_count = 1par défaut. La base de données SQLite de Gokapi n'a pas de mécanisme de clustering/réplication, donc n'augmentez pasmax_instance_countau-dessus de 1. - Les sondes de santé atteignent la racine publique, aucune authentification
requise. Les sondes de démarrage et de vivacité sont toutes deux
HTTP GET
/(racine publique de Gokapi, 200, non authentifié — avant la configuration, c'est l'avis de maintenance, toujours 200) — démarrage :initial_delay=15s, timeout=5s, period=10s, failure_threshold=10; vivacité :initial_delay=30s, timeout=5s, period=30s, failure_threshold=3. - Le port du conteneur est fonctionnellement fixé à
53842, même si la variable est transmise. Contrairement àGokapi_GKE(où la variable équivalentecontainer_portest déclarée mais jamais transmise),gokapi.tfde cette variante Cloud Run fusionnecontainer_port = var.container_portdans la configuration par application qui atteint la fondation — donc la valeur est techniquement active ici. Cependant, le propre port d'écoute de Gokapi est séparément codé en dur commeGOKAPI_PORT = "53842"dansGokapi_Commondeenvironment_variables, donc changercontainer_portde53842acheminerait le trafic Cloud Run vers un port que le conteneur n'écoute pas réellement. Laissez-le par défaut. - Inspecter le service déployé et son état persistant :
gcloud run services describe <service-name> --region "$REGION" --project "$PROJECT" --format='value(status.url)'
gcloud run services logs read <service-name> --project "$PROJECT" --region "$REGION" --limit 50
gcloud storage ls gs://<storage-bucket>/config gs://<storage-bucket>/data
4. Variables de configuration
Les variables sont regroupées exactement comme elles apparaissent sur la plateforme de déploiement. Seuls les paramètres spécifiques ou notables pour Gokapi sont listés ; toutes les autres entrées sont héritées de App_CloudRun avec son comportement standard.
Groupe 1 — Projet et identité
| Variable | Valeur par défaut | Description |
|---|---|---|
project_id | (requis) | Projet Google Cloud cible. |
region | us-central1 | Région pour le service et les ressources régionales. |
Groupe 2 — Environnement de déploiement
| Variable | Valeur par défaut | Description |
|---|---|---|
tenant_id | demo | Suffixe court qui rend les noms de ressources uniques par environnement. |
support_users | [] | E-mails autorisés à accéder au projet et aux alertes de surveillance. |
resource_labels | {} | Étiquettes appliquées à toutes les ressources. |
Groupe 3 — Identité de l'application
| Variable | Valeur par défaut | Description |
|---|---|---|
application_name | gokapi | Nom de base des ressources. Ne pas modifier après le premier déploiement. |
application_display_name | Gokapi File Sharing | Nom lisible par l'homme affiché dans la console. |
description | Gokapi self-hosted file sharing | Description du service. |
application_version | latest | Balise d'image Gokapi ; se résout en un v1.9.6 épinglé lorsque latest via l'argument de build GOKAPI_VERSION spécifique à l'application. |
enable_api_key | true | Génère une clé API d'opérateur aléatoire dans Secret Manager, injectée en tant que GOKAPI_API_KEY. Un jeton de commodité uniquement — Gokapi génère ses propres clés API réelles à partir de l'interface utilisateur d'administration. Par défaut true car la garde au moment de la planification dans validation.tf rejette le défaut ingress_settings = "all" du module lorsque cela est false. |
Groupe 4 — Exécution et mise à l'échelle
| Variable | Valeur par défaut | Description |
|---|---|---|
deploy_application | true | Définir false pour provisionner uniquement l'infrastructure. |
cpu_limit | 1000m | CPU par instance. Gokapi est un binaire Go léger et a peu de besoins. |
memory_limit | 1Gi | Mémoire par instance. |
min_instance_count | 1 | Maintenu à 1 pour éviter les démarrages à froid et conserver un seul écrivain SQLite chaud. |
max_instance_count | 1 | Maintenir à 1 — la base de données SQLite de Gokapi est à écrivain unique sans mode distribué. |
container_port | 53842 | Transmis à la configuration par application du module (contrairement à Gokapi_GKE, où il est inerte) — mais doit correspondre à GOKAPI_PORT, qui est codé en dur 53842 dans Gokapi_Common. Ne pas modifier. |
execution_environment | gen2 | Gen2 requis pour le montage GCS Fuse. |
timeout_seconds | 300 | Durée maximale de la requête (0 à 3600 secondes). |
enable_cloudsql_volume | false | Doit rester false — Gokapi n'a pas de base de données Cloud SQL ; main.tf code cela en dur quelle que soit la valeur de la variable. |
enable_image_mirroring | true | Mettre en miroir l'image Gokapi dans Artifact Registry. |
container_protocol | http1 | HTTP/1.1 standard ; Gokapi n'a pas d'exigence gRPC/HTTP2. |
traffic_split | [] | Répartir le trafic entre les révisions pour les déploiements progressifs. |
max_revisions_to_retain | 7 | Déclaré pour la parité de convention ; non référencé par le déploiement de ce module. |
Groupe 5 — Contrôle d'accès et d'ingress
| Variable | Valeur par défaut | Description |
|---|---|---|
ingress_settings | all | Public par défaut, correspondant à l'objectif de Gokapi de générer des liens de téléchargement partageables. |
vpc_egress_setting | PRIVATE_RANGES_ONLY | Acheminer uniquement le trafic RFC 1918 via VPC. |
enable_iap | false | Exiger la connexion Google. Bloque les destinataires anonymes de suivre les liens de téléchargement partagés. |
iap_authorized_users / iap_authorized_groups | [] | Qui peut accéder via IAP. |
Groupe 6 — Variables d'environnement et secrets
| Variable | Valeur par défaut | Description |
|---|---|---|
environment_variables | {} | Paramètres non secrets supplémentaires. GOKAPI_CONFIG_DIR, GOKAPI_DATA_DIR et GOKAPI_PORT sont définis automatiquement — ne les remplacez pas. |
secret_environment_variables | {} | Mappage de la variable d'environnement → nom du secret Secret Manager. |
secret_propagation_delay | 30 | Secondes à attendre après la création du secret avant de continuer. |
secret_rotation_period | 2592000s | Fréquence de notification de rotation de Secret Manager. |
Groupe 7 — Sauvegarde et restauration
Les variables de job de sauvegarde/importation App_CloudRun standard (backup_schedule,
backup_retention_days, enable_backup_import, backup_source, backup_uri,
backup_format) sont déclarées et transmises, mais inertes pour Gokapi — le
mécanisme de sauvegarde et d'importation de la fondation ne fonctionne que
lorsque database_type n'est pas NONE, et celui de Gokapi est fixé à
NONE. Il n'y a pas de sauvegarde automatisée de la base de données
SQLite ou des fichiers téléchargés ; sauvegardez directement le bucket GCS
storage si nécessaire.
Groupe 8 — CI/CD et autorisation binaire
Intégration standard App_CloudRun Cloud Build / Cloud Deploy — voir
App_CloudRun. Entrées clés : enable_cicd_trigger,
github_repository_url, github_token, enable_cloud_deploy,
enable_binary_authorization.
Groupe 9 — Scripts SQL personnalisés (inertes) et découverte d'instances NFS
| Variable | Valeur par défaut | Description |
|---|---|---|
enable_custom_sql_scripts / custom_sql_scripts_bucket / custom_sql_scripts_path / custom_sql_scripts_use_root | désactivé / "" | Inerte — Gokapi n'a pas de base de données SQL sur laquelle exécuter des scripts. |
nfs_instance_name | "" | Nom d'une VM GCE NFS existante à utiliser au lieu de l'auto-découverte. Pertinent uniquement si vous redirigez manuellement le stockage de Gokapi vers NFS (voir Groupe 11). |
nfs_instance_base_name | app-nfs | Nom de base pour une VM GCE NFS intégrée, si elle est créée. |
nfs_volume_name | nfs-data-volume | Nom du volume Cloud Run pour le montage NFS. |
Groupe 10 — Équilibreur de charge, CDN et rétention d'images
| Variable | Valeur par défaut | Description |
|---|---|---|
enable_cloud_armor | false | Provisionner l'équilibreur de charge HTTPS global + WAF Cloud Armor. |
admin_ip_ranges | [] | Plages CIDR exemptées des règles WAF. |
application_domains | [] | Noms de domaine personnalisés pour l'équilibreur de charge HTTPS. |
enable_cdn | false | Activer Cloud CDN sur le backend de l'équilibreur de charge HTTPS. |
max_images_to_retain / delete_untagged_images / image_retention_days | 7 / true / 30 | Politique de nettoyage d'Artifact Registry. |
Groupe 11 — Stockage, système de fichiers et Redis
| Variable | Valeur par défaut | Description |
|---|---|---|
create_cloud_storage | true | Provisionne le bucket storage qui soutient /data. Laisser ceci false casserait le seul chemin de persistance de Gokapi. |
storage_buckets | [] | Buckets GCS supplémentaires au-delà du bucket storage auto-provisionné. |
enable_nfs | true | Doit rester true sur Cloud Run : la base de données SQLite de Gokapi atterrit sous /data, et GCS FUSE ne peut pas héberger une base de données SQLite. |
nfs_mount_path | /data | Chemin de montage à l'intérieur du conteneur si NFS est activé — distinct de /data. |
gcs_volumes | [] | Montages de volumes GCS Fuse supplémentaires ; le montage storage du bucket /data est toujours ajouté en plus de cette liste. |
manage_storage_kms_iam / enable_artifact_registry_cmek | false | Options CMEK. |
enable_redis | true (valeur par défaut de la variable) | Inerte — main.tf code en dur enable_redis = false à la fondation quelle que soit la valeur de cette variable. Gokapi n'a aucune utilité pour Redis. |
redis_host / redis_port / redis_auth | — | Déclaré uniquement pour la mise en miroir de la convention ; jamais transmis à la fondation. |
Groupe 12 — Backend de base de données
Toutes les variables du Groupe 12 (database_type, sql_instance_name,
application_database_name, application_database_user,
db_*_env_var_name, enable_postgres_extensions, enable_mysql_plugins, etc.)
sont déclarées uniquement pour la compatibilité de la mise en miroir de la
convention. database_type est fixé à NONE à l'intérieur de Gokapi_Common,
et aucune des variables de base de données sœurs n'est transmise à la fondation
par main.tf — Gokapi n'a pas de base de données SQL.
Groupe 13 — Jobs et tâches planifiées
| Variable | Valeur par défaut | Description |
|---|---|---|
initialization_jobs | [] | Aucun job par défaut n'est injecté ; utilisez ceci uniquement pour les jobs de chargement de données ou de migration personnalisés. |
cron_jobs | [] | Jobs Cloud Run récurrents ; Gokapi n'a pas de tâche de maintenance planifiée intégrée. |
backup_file | backup.sql | Inerte — voir Groupe 7 ; pas de base de données à restaurer. |
Groupe 14 — Observabilité et santé
| Variable | Valeur par défaut | Description |
|---|---|---|
startup_probe | HTTP / , délai de 15s, 10 tentatives | Sonde de démarrage — racine publique de Gokapi (son interface utilisateur, ou avant la première configuration, l'avis de maintenance), pas d'authentification. |
liveness_probe | HTTP / , délai de 30s, 3 tentatives | Sonde de vivacité. |
startup_probe_config | HTTP / (forme alternative) | Sonde structurée alternative. |
health_check_config | HTTP / (forme alternative) | Sonde de vivacité structurée alternative. |
uptime_check_config | { enabled=false, path="/" } | Test de disponibilité Cloud Monitoring ; désactivé par défaut. |
alert_policies | [] | Politiques d'alerte métrique. |
Groupe 15 — Réseau
| Variable | Valeur par défaut | Description |
|---|---|---|
network_name | "" | Déclaré pour la mise en miroir de la convention ; non transmis par main.tf — le réseau VPC est toujours auto-découvert. |
Groupe 23 — VPC Service Controls et journalisation d'audit
| Variable | Valeur par défaut | Description |
|---|---|---|
enable_vpc_sc | false | Appliquer un périmètre VPC-SC (nécessite organization_id). |
vpc_cidr_ranges / vpc_sc_dry_run | (défini) | CIDR de niveau d'accès / mode simulation. |
enable_audit_logging | false | Journaux d'audit Cloud détaillés. |
5. Sorties
Retournées lors d'un déploiement réussi — le moyen le plus rapide de localiser et d'explorer les ressources en cours d'exécution.
| Sortie | Description |
|---|---|
service_name | Nom du service Cloud Run. |
gokapi_url | L'URL du service Cloud Run (nommée gokapi_url, pas la générique service_url utilisée par d'autres modules). |
service_location | Région dans laquelle le service s'exécute. |
stage_services | URL de service spécifiques à l'étape (Cloud Deploy). |
load_balancer_ip / load_balancer_url | IP / URL de l'équilibreur de charge HTTPS externe (lorsqu'il est activé). |
storage_buckets | Buckets Cloud Storage créés — inclut le bucket storage monté à /data. |
network_name / network_exists / regions | Réseau VPC, présence, régions. |
container_image / container_registry | Image déployée et dépôt Artifact Registry. |
monitoring_enabled / monitoring_notification_channels / uptime_check_names | État de la surveillance, canaux, tests de disponibilité. |
initialization_jobs | Noms des jobs de configuration fournis par l'utilisateur (aucun par défaut). |
deployment_id / tenant_id / resource_prefix | Identifiants de nommage. |
project_id / project_number | Identifiants de projet. |
cicd_enabled / github_repository_url / github_repository_owner / github_repository_name / cicd_configuration | État et détails CI/CD. |
artifact_registry_repository / cloudbuild_trigger_name / cloudbuild_trigger_id | Registre et déclencheur de build. |
vpc_sc_enabled / vpc_sc_perimeter_name / vpc_sc_dry_run_mode | État VPC-SC. |
audit_logging_enabled / artifact_registry_cmek_enabled | Journalisation d'audit et état CMEK. |
Notez l'absence de toute sortie database_* (il n'y a pas de base de données) et
d'une sortie d'identifiant secret pour la clé API facultative — récupérez
celle-ci directement avec gcloud secrets list --filter="name~api-key" (voir Section 2C).
6. Pièges de configuration et valeurs par défaut judicieuses
Risque : Critique (perte de données / panne / sécurité) — Élevé (service dégradé) — Moyen (coût ou dégradation partielle) — Faible (mineur).
Validation héritée au moment du plan. Ce module transmet sa configuration au moteur de base App_CloudRun, qui valide les valeurs et les combinaisons au moment du plan — un réplica en lecture sans son primaire, IAP sans identités autorisées, un runtime
gen1avec des montages GCS Fuse, unredis_port/backup_retention_dayshors limites. Une configuration invalide fait échouer le plan avec une erreur claire et nommée avant la création de toute ressource, de sorte que la plupart des erreurs ci-dessous sont détectées en amont plutôt qu'à l'apply ou à l'exécution.
| Paramètre | Valeur judicieuse | Risque | Conséquence en cas d'erreur |
|---|---|---|---|
Montage GCS Fuse à /data (inconditionnel, pas de bascule sur ce module) | L'accepter pour une utilisation légère ; passer à Gokapi_GKE pour des charges de travail plus lourdes | Critique | GCS Fuse ne fournit pas de véritable verrouillage de fichiers POSIX, dont SQLite dépend pour un accès concurrent sûr. Il n'y a aucun moyen de faire passer ce module à un véritable volume de blocs — la bascule n'existe que sur le PVC StatefulSet de Gokapi_GKE. |
ingress_settings | all (par défaut) avec revendication d'administrateur rapide | Élevé | Étant donné que le compte administrateur est créé via un assistant de première exécution ouvert et non authentifié, une URL publique signifie que n'importe qui qui l'atteint en premier revendique le compte administrateur. Revendiquez-le immédiatement après le déploiement, ou définissez enable_iap = true jusqu'à ce que vous l'ayez fait. |
max_instance_count | 1 | Critique | La base de données SQLite de Gokapi est à écrivain unique sans clustering ; l'exécution de plus d'une instance risque de corrompre la base de données et d'entraîner des téléchargements incohérents. |
container_port | 53842 (laisser par défaut) | Élevé | GOKAPI_PORT est codé en dur à 53842 dans les variables d'environnement de Gokapi_Common indépendamment de cette variable ; changer container_port achemine le trafic Cloud Run vers un port que le conteneur n'écoute pas. |
create_cloud_storage | true | Critique | La définition de false supprime le seul bucket de persistance de Gokapi — la base de données SQLite et chaque téléchargement y résident. |
enable_api_key (secret auto-généré) | Laisser la valeur par défaut true pendant ingress_settings = "all" | Élevé | Une protection au moment du plan (validation.tf's validate_gokapi_configuration) fait échouer le plan si ingress_settings = "all" (la valeur par défaut du module) est combiné avec enable_api_key = false — l'accès public sans protection par clé API est rejeté d'emblée. Vous le rencontrerez immédiatement si vous basculez enable_api_key sur false sans également restreindre ingress_settings à "internal" ou "internal-and-cloud-load-balancing". Le jeton lui-même n'est qu'un secret de commodité — les véritables clés API de téléchargement/téléchargement de Gokapi sont générées à partir de l'interface utilisateur d'administration quelle que soit cette configuration — mais la protection n'est pas facultative. |
enable_nfs | false sauf si vous redirigez également GOKAPI_CONFIG_DIR/GOKAPI_DATA_DIR | Moyen | L'activation de NFS seule provisionne une VM Filestore/NFS inutilisée — les données de Gokapi résident toujours à /data sur GCS Fuse à moins que vous ne remplaciez manuellement les variables d'environnement pour utiliser le chemin de montage NFS à la place. |
enable_backup_import / backup_schedule / etc. | Laisser les valeurs par défaut | Faible | Ces variables sont inertes pour Gokapi (database_type = NONE) ; aucune sauvegarde automatisée de la base de données SQLite ou des téléchargements n'existe. Sauvegardez directement le bucket storage si vous en avez besoin. |
min_instance_count | 1 (par défaut) | Faible | Garder 1 instance chaude évite les démarrages à froid sur les liens de téléchargement partagés ; c'est peu coûteux pour un binaire Go léger. |
enable_cloud_armor | activer pour la production | Moyen | Une application de partage de fichiers accessible publiquement avec des surfaces d'administration/téléchargement non authentifiées bénéficie de la protection WAF. |
Pour le comportement de base référencé tout au long — identité de service, mise à l'échelle et
concurrence, ingress et équilibrage de charge, CI/CD, Cloud Armor, IAP, Binary
Authorization, VPC-SC, sauvegardes et mise en miroir d'images — voir
App_CloudRun. La configuration d'application spécifique à Gokapi
partagée avec la variante GKE (image, bucket de stockage, clé API facultative, sondes de santé)
se trouve dans le module Gokapi_Common (modules/Gokapi_Common), qui n'a
pas encore de documentation de plateforme autonome — voir ses main.tf/variables.tf/README.md pour
le câblage sous-jacent.
Guides associés
- Lab pratique : Gokapi sur Cloud Run — déployez-le étape par étape, avec les écrans de la console et les commandes à chaque étape.
- Gokapi sur GKE Autopilot — la même application sur Kubernetes, pour quand vous avez besoin de l'autre cible de déploiement.
- Gokapi Common — Configuration d'application partagée — la configuration partagée par les deux cibles de déploiement.
- Déployé aux côtés de Chibisafe sur Google Cloud Run, Cloudreve sur Google Cloud Run dans la solution Partage et transfert de fichiers.
Need RAD to do something it does not do yet? Request it on the roadmap, or vote on what is already there.