Aller au contenu principal

NocoDB sur Google Cloud Run

NocoDB sur Google Cloud Run

NocoDB est une alternative open source à Airtable qui transforme n'importe quelle base de données en tableur intelligent, avec une interface sans code, des API REST et GraphQL et des automatisations intégrées. Ce module déploie NocoDB sur Cloud Run v2 en s'appuyant sur le socle App_CloudRun, qui provisionne et gère l'infrastructure Google Cloud partagée.

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


1. Vue d'ensemble​

NocoDB s'exécute sous forme de conteneur Node.js sur Cloud Run v2. Le déploiement assemble un ensemble ciblé de services Google Cloud :

FonctionnalitéService Google CloudRemarques
CalculCloud Run v2Service Node.js, 1 vCPU / 1 GiB par défaut, mise à l'échelle automatique selon les requêtes
Base de donnéesCloud SQL for PostgreSQL 15database_type n'a aucun effet sur Cloud Run — Postgres 15 est toujours provisionné
Stockage d'objetsCloud StorageProvisionné, mais non relié au stockage des pièces jointes de NocoDB (voir ci-dessous)
Cache (facultatif)RedisDésactivé par défaut ; requis lorsque plusieurs instances s'exécutent
SecretsSecret ManagerSecret JWT généré automatiquement (NC_AUTH_JWT_SECRET) et mot de passe de la base de données
EntréeURL Cloud Run / Cloud Load BalancingURL run.app par défaut, équilibreur de charge HTTPS externe + domaine personnalisé en option

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

  • PostgreSQL 15 uniquement, sur Cloud Run. La variable database_type est définie mais jamais transmise à NocoDB_Common (qui code en dur POSTGRES_15) ; la définir n'a donc aucun effet ici — Postgres 15 est provisionné quelle que soit la valeur. MySQL 8.0 est pris en charge sur NocoDB_GKE, où la surcharge équivalente est reliée.
  • NocoDB se connecte en TCP via l'IP privée, et non via le socket de l'Auth Proxy. Le sidecar Cloud SQL Auth Proxy est désactivé par défaut (enable_cloudsql_volume = false), car le constructeur d'URL interne de NocoDB rejette les chemins de socket Unix. L'IP privée est utilisée directement.
  • NFS est désactivé par défaut. NocoDB ne dépend d'aucun système de fichiers partagé, mais il ne dispose pas non plus d'un backend de pièces jointes Cloud Storage fonctionnel prêt à l'emploi (voir §2C) — les pièces jointes utilisent le disque local/éphémère du conteneur, sauf configuration manuelle.
  • Redis est désactivé par défaut. Une instance unique fonctionne sans Redis ; activez-le avant de dépasser une instance.
  • cpu_always_allocated = false par défaut. Facturation à la requête : la logique d'automatisation en arrière-plan et de nouvelle tentative des webhooks de NocoDB ne se poursuit que tant qu'une instance traite une requête. Définissez true (avec min_instance_count ≥ 1) pour un traitement en arrière-plan ininterrompu.
  • Le secret JWT est généré automatiquement et stocké dans Secret Manager. N'effectuez pas sa rotation après le premier déploiement — toutes les sessions et tous les jetons d'API existants seraient immédiatement invalidés.
  • NocoDB gère lui-même ses migrations de base de données au premier démarrage. Aucun job d'initialisation externe n'est requis.
  • Les sondes de santé ciblent /api/v1/health, le point de terminaison de santé dédié exposé par NocoDB.

2. Services Google Cloud et comment les explorer​

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

A. Cloud Run — le service NocoDB​

NocoDB s'exécute en tant que service Cloud Run v2 qui se met à l'échelle automatiquement selon la charge de requêtes, entre le nombre minimal et le nombre maximal d'instances. Chaque déploiement crée une révision immuable ; le trafic peut être réparti entre les révisions pour des déploiements progressifs sûrs.

  • Console : Cloud Run → sélectionnez le service pour consulter les révisions, le trafic, les journaux et les métriques.
  • CLI :
    gcloud run services list --project "$PROJECT" --region "$REGION"
    gcloud run services describe <service-name> --project "$PROJECT" --region "$REGION"
    gcloud run revisions list --service <service-name> --project "$PROJECT" --region "$REGION"

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

B. Cloud SQL for PostgreSQL 15​

NocoDB stocke toutes les données applicatives (tables, vues, automatisations, données des lignes) dans une instance gérée Cloud SQL for PostgreSQL 15. Le service se connecte via une connexion TCP sur IP privée (pas d'IP publique, pas de socket Auth Proxy). Au premier déploiement, un job d'initialisation crée la base de données et l'utilisateur de l'application ; NocoDB exécute ensuite ses propres migrations de schéma au démarrage.

  • Console : SQL → sélectionnez l'instance pour consulter les connexions, les sauvegardes, les flags et les métriques.
  • CLI :
    gcloud sql instances list --project "$PROJECT"
    gcloud sql instances describe <instance-name> --project "$PROJECT"
    gcloud sql connect <instance-name> --user=<db-user> --project "$PROJECT"

Le nom de l'instance, la base de données, l'utilisateur et le secret du mot de passe figurent dans les Sorties. Consultez App_CloudRun pour le modèle de connexion, les sauvegardes et la rotation des mots de passe.

C. Cloud Storage — provisionné, non relié aux pièces jointes​

La variable storage_buckets provisionne un bucket GCS (par défaut name_suffix = "data") et une valeur GCS_BUCKET_NAME est injectée dans le service sous forme de variable d'environnement. Cependant, le script de point d'entrée de NocoDB_Common ne lit jamais GCS_BUCKET_NAME (ni aucune autre variable S3/GCS), et la valeur injectée ne correspond au nom d'aucun bucket réellement créé par le socle. NocoDB ne stocke donc pas automatiquement les pièces jointes dans Cloud Storage — les fichiers téléversés sont écrits sur le disque local/éphémère du conteneur et sont perdus lors d'un redémarrage ou d'un démarrage à froid. Pour conserver les pièces jointes dans GCS, configurez manuellement les paramètres de stockage compatible S3 propres à NocoDB (via son interface d'administration ou environment_variables) en les faisant pointer vers un bucket auquel le compte de service Cloud Run peut accéder.

  • Console : Cloud Storage → Buckets → sélectionnez le bucket provisionné.
  • CLI :
    gcloud storage buckets list --project "$PROJECT"
    gcloud storage ls gs://<bucket-name>/ # bucket name is in the Outputs

Consultez App_CloudRun pour GCS Fuse, CMEK et les options de buckets supplémentaires.

D. Cache Redis (facultatif)​

Redis soutient la couche de cache de NocoDB et, dans les déploiements à plusieurs instances, maintient la cohérence de l'état du cache et des sessions. Redis est désactivé par défaut ; un redis_host doit être fourni lorsqu'il est activé.

  • Console : Memorystore → Redis (si vous utilisez une instance gérée).
  • CLI :
    redis-cli -h <redis-host> ping
    redis-cli -h <redis-host> info keyspace

E. Secret Manager​

Le secret JWT de NocoDB (NC_AUTH_JWT_SECRET) et le mot de passe de la base de données sont stockés dans Secret Manager et injectés dans le service à l'exécution.

  • Console : Security → Secret Manager.
  • CLI :
    gcloud secrets list --project "$PROJECT"
    gcloud secrets versions access latest --secret=<secret-name> --project "$PROJECT"

Consultez App_CloudRun pour les détails d'injection et de rotation.

F. Réseau et entrée​

Le service est accessible par défaut à son URL run.app. Un équilibreur de charge HTTPS externe avec domaine personnalisé, Cloud CDN et Cloud Armor peut y être ajouté ; les paramètres d'entrée et la sortie VPC contrôlent la connectivité.

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

Consultez App_CloudRun.

G. Cloud Logging et Monitoring​

Les journaux des conteneurs sont envoyés à Cloud Logging ; les métriques de Cloud Run et de Cloud SQL sont envoyées à Cloud Monitoring, avec en option des tests de disponibilité sur /api/v1/health et des règles d'alerte.

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

3. Comportement de l'application NocoDB​

  • Configuration de la base de données au premier déploiement. Un job d'initialisation (db-init) crée la base de données et l'utilisateur NocoDB avant le démarrage du service. Il est idempotent.
  • Migrations autogérées. NocoDB exécute ses propres migrations de schéma de base de données au démarrage — il est inutile de configurer des jobs de migration externes.
  • Secret JWT. NC_AUTH_JWT_SECRET est généré automatiquement et stocké dans Secret Manager. N'effectuez pas sa rotation après le premier déploiement ; toutes les sessions et tous les jetons d'API existants sont immédiatement invalidés si le secret change.
  • Les téléversements GCS ne sont pas automatiques. Une variable d'environnement GCS_BUCKET_NAME est injectée, mais le script de point d'entrée ne la lit jamais et sa valeur ne correspond à aucun bucket créé par le socle. Les pièces jointes utilisent le disque local/éphémère du conteneur, sauf si l'opérateur configure manuellement les paramètres de stockage compatible S3 propres à NocoDB.
  • Variables d'environnement NC_DB_*. Le Dockerfile personnalisé de NocoDB_Common associe les variables de connexion standard DB_* (injectées par le socle) aux noms NC_DB_* attendus par NocoDB. Lorsque container_image_source = "prebuilt", cette correspondance n'est pas appliquée — configurez manuellement les variables NC_DB_* via environment_variables.
  • URL publique. L'URL du service Cloud Run est injectée sous la forme NC_PUBLIC_URL afin que NocoDB génère des URL absolues correctes dans les liens de partage, les notifications par e-mail et les rappels de webhooks. Contrôlée par service_url_env_var_name (par défaut "NC_PUBLIC_URL").
  • Chemin de santé. Les sondes de disponibilité (readiness) et de vivacité ciblent /api/v1/health, qui renvoie HTTP 200 lorsque NocoDB est prêt à accepter des requêtes.
  • Sessions multi-instances. Avec plus d'une instance et sans Redis, NocoDB ne peut pas partager l'état des sessions ni du cache ; les utilisateurs peuvent être déconnectés lorsque les requêtes sont acheminées vers une autre instance. Activez Redis et définissez redis_host avant de dépasser une instance.

4. Variables de configuration​

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

Groupe 1 — Projet et identité​

VariableValeur par défautDescription
project_id(obligatoire)Projet Google Cloud cible.
regionus-central1Région du service et des ressources régionales.

Groupe 2 — Environnement de déploiement​

VariableValeur par défautDescription
tenant_iddemoSuffixe court qui rend les noms de ressources uniques par environnement.
support_users[]Adresses e-mail auxquelles sont accordés l'accès au projet et les alertes de surveillance.
resource_labels{}Libellés appliqués à toutes les ressources.

Groupe 3 — Identité de l'application​

VariableValeur par défautDescription
application_namenocodbNom de base des ressources. Ne pas modifier après le premier déploiement.
application_display_nameNocoDBNom convivial affiché dans la console.
application_description(défini)Description du service.
application_versionlatestTag de version de l'image NocoDB ; épinglez une version précise en production.

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

VariableValeur par défautDescription
deploy_applicationtrueDéfinissez false pour provisionner uniquement l'infrastructure.
cpu_limit1000mCPU par instance.
memory_limit1GiMémoire par instance ; 1 GiB minimum pour éviter un OOM au démarrage.
min_instance_count0Nombre minimal d'instances ; 0 active la mise à l'échelle à zéro. Conservez ≥ 1 si les webhooks ne doivent pas être perdus.
max_instance_count3Nombre maximal d'instances.
container_port8080NocoDB écoute sur le port 8080.
execution_environmentgen2Gen2 recommandé pour un démarrage plus rapide et un réseau amélioré.
enable_cloudsql_volumefalseDésactivé — NocoDB se connecte en TCP via l'IP privée, et non via le socket de l'Auth Proxy.
cpu_always_allocatedfalseFacturation à la requête par défaut. Définissez true pour que les tâches d'automatisation en arrière-plan continuent entre les requêtes.
container_image_sourcecustomcustom construit l'image via Cloud Build avec la correspondance NC_DB_* ; prebuilt déploie une image existante.
traffic_split[]Répartition du trafic canary/blue-green entre les révisions.
max_revisions_to_retain7Nombre d'anciennes révisions à conserver.

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

VariableValeur par défautDescription
enable_iapfalseExiger une connexion Google. Recommandé pour les espaces de travail internes.
iap_authorized_users / iap_authorized_groups[]Personnes autorisées à accéder via IAP.
ingress_settingsallRéseaux autorisés à joindre le service.
vpc_egress_settingPRIVATE_RANGES_ONLYMode d'acheminement du trafic sortant à travers le VPC.

Groupe 6 — Variables d'environnement et secrets​

VariableValeur par défautDescription
environment_variables{}Paramètres supplémentaires non secrets.
secret_environment_variables{}Correspondance variable d'environnement → nom du secret Secret Manager.
secret_propagation_delay / secret_rotation_period(défini)Délai d'attente de réplication / cadence de rotation.

Groupe 7 — Sauvegarde et restauration​

VariableValeur par défautDescription
backup_schedule0 2 * * *Cron des sauvegardes automatiques (UTC).
backup_retention_days7Rétention ; augmentez-la pour la production/la conformité.
enable_backup_import / backup_source / backup_file / backup_formatoptions de restaurationRestaurer à partir d'une sauvegarde lors du déploiement.

Groupe 8 — CI/CD et Binary Authorization​

Intégration Cloud Build / Cloud Deploy standard d'App_CloudRun — 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​

enable_custom_sql_scripts, custom_sql_scripts_bucket, custom_sql_scripts_path, custom_sql_scripts_use_root — exécutent du SQL depuis un bucket GCS après le provisionnement. Voir App_CloudRun.

Groupe 10 — Équilibreur de charge, CDN et rétention des images​

VariableValeur par défautDescription
enable_cloud_armorfalseProvisionner un équilibreur de charge HTTPS global + le WAF Cloud Armor.
admin_ip_ranges[]Plages CIDR exemptées des règles WAF.
application_domains[]Noms d'hôte personnalisés pour l'équilibreur de charge externe.
enable_cdnfalseActiver Cloud CDN sur le backend de l'équilibreur de charge.
max_images_to_retain / delete_untagged_images / image_retention_days(défini)Règle de nettoyage d'Artifact Registry.

Groupe 11 — Stockage et système de fichiers​

VariableValeur par défautDescription
create_cloud_storagetrueProvisionner les buckets GCS définis dans storage_buckets. Non relié aux pièces jointes de NocoDB — voir §2C.
storage_buckets[{ name_suffix = "data" }]Buckets GCS à provisionner.
enable_nfsfalseNFS n'est pas requis pour NocoDB.
nfs_mount_path/mnt/nfsChemin de montage si NFS est activé.
gcs_volumes[]Montages GCS Fuse.
manage_storage_kms_iam / enable_artifact_registry_cmekfalseOptions CMEK.

Groupe 12 — Backend de base de données​

VariableValeur par défautDescription
database_typePOSTGRES_15Non transmis sur Cloud Run — NocoDB_Common code en dur POSTGRES_15 quelle que soit cette valeur ; utilisez NocoDB_GKE pour MYSQL_8_0.
application_database_namenocodbNom de la base de données. Immuable après le premier déploiement.
application_database_usernocodbUtilisateur de l'application. Immuable après le premier déploiement.
database_password_length32Longueur du mot de passe généré (16–64).
enable_auto_password_rotation / rotation_propagation_delay_secdésactivéRotation du mot de passe de la base de données.
db_host_env_var_nameNC_DB_HOSTNom de variable d'environnement supplémentaire pour l'hôte de la base de données.
db_port_env_var_nameNC_DB_PORTNom de variable d'environnement supplémentaire pour le port de la base de données.
db_name_env_var_nameNC_DB_NAMENom de variable d'environnement supplémentaire pour le nom de la base de données.
db_user_env_var_nameNC_DB_USERNom de variable d'environnement supplémentaire pour l'utilisateur de la base de données.
db_password_env_var_nameNC_DB_PASSWORDNom de variable d'environnement supplémentaire pour le mot de passe de la base de données.
service_url_env_var_nameNC_PUBLIC_URLNom de la variable d'environnement sous lequel l'URL publique du service est injectée.

Groupe 13 — Jobs et tâches planifiées​

VariableValeur par défautDescription
initialization_jobs[]Laissez vide pour utiliser le job db-init intégré.
cron_jobs[]Jobs récurrents déclenchés par Cloud Scheduler.

Groupe 14 — Observabilité et santé​

VariableValeur par défautDescription
startup_probe / startup_probe_config/api/v1/healthSonde de démarrage HTTP, délai initial de 30 s.
liveness_probe / health_check_config/api/v1/healthSonde de vivacité HTTP.
uptime_check_configdésactivéTest de disponibilité Cloud Monitoring facultatif sur /api/v1/health.
alert_policies[]Règles d'alerte sur les métriques.

Groupe 21 — Cache Redis​

VariableValeur par défautDescription
enable_redisfalseActiver Redis. Requis lorsque plus d'une instance s'exécute.
redis_hostnullPoint de terminaison Redis. Requis lorsque enable_redis = true.
redis_port6379Port Redis.
redis_auth""Mot de passe d'authentification Redis facultatif (sensible).

Groupe 22 — VPC Service Controls et journalisation d'audit​

VariableValeur par défautDescription
enable_vpc_scfalseAppliquer un périmètre VPC-SC (nécessite organization_id).
vpc_cidr_ranges / vpc_sc_dry_run(défini)Plages CIDR du niveau d'accès / mode simulation (dry-run).
enable_audit_loggingfalseJournaux Cloud Audit Logs détaillés.

5. Sorties​

Renvoyées lors d'un déploiement réussi — le moyen le plus rapide de localiser et d'explorer les ressources en cours d'exécution.

SortieDescription
service_nameNom du service Cloud Run.
service_urlURL run.app par défaut du service.
service_locationRégion dans laquelle le service s'exécute.
stage_servicesURL des services propres à chaque étape (Cloud Deploy).
load_balancer_ip / load_balancer_urlIP / URL de l'équilibreur de charge HTTPS externe (lorsqu'il est activé).
database_instance_nameNom de l'instance Cloud SQL.
database_name / database_userNom / utilisateur de la base de données de l'application.
database_password_secretSecret Secret Manager contenant le mot de passe de la base de données.
database_host / database_portPoint de terminaison (IP privée) / port de la base de données.
storage_bucketsBuckets Cloud Storage créés.
network_name / network_exists / regionsRéseau VPC, présence, régions.
container_image / container_registryImage déployée et dépôt Artifact Registry.
monitoring_enabled / monitoring_notification_channels / uptime_check_namesÉtat de la surveillance, canaux, tests de disponibilité.
initialization_jobsNoms des jobs de configuration.
deployment_id / tenant_id / resource_prefixIdentifiants de nommage.
project_id / project_numberIdentifiants du projet.
cicd_enabled / github_repository_url / github_repository_owner / github_repository_name / cicd_configurationÉtat et détails du CI/CD.
artifact_registry_repository / cloudbuild_trigger_name / cloudbuild_trigger_idRegistre et déclencheur de build.
vpc_sc_enabled / vpc_sc_perimeter_name / vpc_sc_dry_run_modeÉtat de VPC-SC.
audit_logging_enabled / artifact_registry_cmek_enabledÉtat des journaux d'audit et de CMEK.

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

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

ParamètreValeur judicieuseRisqueConséquence en cas d'erreur
NC_AUTH_JWT_SECRETgénéré automatiquement (immuable)CritiqueSa rotation après le premier déploiement invalide immédiatement toutes les sessions et tous les jetons d'API.
application_database_name / _userdéfinis une seule foisCritiqueImmuables après le premier déploiement ; les renommer recrée la base de données/l'utilisateur et détruit les données.
enable_backup_importfalse sauf en cas de restaurationCritiqueL'activer sans fichier de sauvegarde valide fait échouer le job d'import.
enable_cloudsql_volumefalse (par défaut)CritiqueDéfinir true n'aide pas NocoDB — son constructeur d'URL rejette les chemins de socket et toutes les connexions à la base de données échouent.
memory_limit1GiÉlevéLe processus Node.js de NocoDB est tué pour OOM en dessous de 512 Mi ; les charges de travail de production comportant de nombreuses automatisations nécessitent 2 Gi.
enable_redistrue lorsque >1 instanceÉlevéPlusieurs instances sans Redis provoquent l'invalidation des sessions lorsque les requêtes sont acheminées vers des instances différentes.
redis_hostexplicite lorsque Redis est activéÉlevéUn hôte manquant fait échouer toutes les connexions Redis au démarrage.
NC_PUBLIC_URL / service_url_env_var_nameNC_PUBLIC_URL (par défaut)ÉlevéNocoDB l'utilise pour construire les liens de partage, les URL de webhooks et les notifications par e-mail ; une valeur incorrecte casse toutes les références sortantes.
cpu_always_allocatedfalse (par défaut) ; true pour une automatisation intensiveMoyenAvec la facturation à la requête par défaut, les tâches d'automatisation en arrière-plan et de nouvelle tentative des webhooks de NocoDB sont suspendues entre les requêtes.
min_instance_count1Moyen0 provoque des démarrages à froid pendant lesquels les rappels de webhooks expirent et sont perdus.
max_instance_countmaintenir bas sans RedisMoyenDépasser 1 sans Redis provoque l'invalidation des sessions.
enable_iap / enable_cloud_armoractiver pour un usage interneMoyenSinon, NocoDB est publiquement accessible à son URL run.app.
application_versionépingler un tag précisMoyenlatest déclenche des mises à niveau non maîtrisées à chaque reconstruction du conteneur.
backup_retention_days7 (à augmenter en production)MoyenTrop court pour une rétention de conformité.

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

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