Aller au contenu principal

Hasura sur Google Cloud Run

Hasura sur Google Cloud Run

Hasura est un moteur open source sous licence Apache 2.0 qui vous fournit instantanément une API GraphQL (et REST) en temps réel au-dessus d'une base de données PostgreSQL, avec une autorisation fine basée sur les rôles, des déclencheurs d'événements et une console d'administration intégrée. Ce module déploie le Hasura GraphQL Engine (hasura/graphql-engine) 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 Hasura 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​

Hasura s'exécute sous forme d'un unique conteneur Haskell sur Cloud Run v2. Le déploiement assemble un ensemble restreint de services Google Cloud :

FonctionnalitéService Google CloudRemarques
CalculCloud Run v2Service Haskell, 1 vCPU / 512 MiB par défaut, autoscaling serverless ; mise à l'échelle jusqu'à zéro prise en charge
Base de donnéesCloud SQL for PostgreSQL 15Obligatoire — le catalogue de métadonnées de Hasura et sa source de données par défaut résident tous deux dans Postgres
Stockage d'objetsAucunHasura est sans état ; aucun bucket n'est provisionné
SecretsSecret ManagerHASURA_GRAPHQL_ADMIN_SECRET généré automatiquement ; 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 et domaine personnalisé en option

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

  • PostgreSQL 15 est obligatoire. Le moteur de base de données est fixé par la couche applicative partagée ; Hasura conserve son propre catalogue de métadonnées dans Postgres, aucun autre moteur n'est donc pris en charge.
  • Le secret administrateur protège tout ce qui est sensible. HASURA_GRAPHQL_ADMIN_SECRET est généré automatiquement et stocké dans Secret Manager. Il protège l'interface /console ainsi que les API /v1/graphql et /v1/metadata. /healthz reste public pour les sondes de santé.
  • Deux URL de connexion sont assemblées dans le conteneur. Le point d'entrée de l'image personnalisée construit HASURA_GRAPHQL_DATABASE_URL (source de données par défaut) et HASURA_GRAPHQL_METADATA_DATABASE_URL (stockage des métadonnées de Hasura) à partir des variables DB_* injectées à l'exécution — Cloud Run n'interpole pas $(VAR) dans les valeurs d'environnement, cela ne peut donc pas être fait au moment du plan.
  • La mise à l'échelle jusqu'à zéro est activée par défaut (min_instance_count = 0, cpu_always_allocated = false). Comme tout l'état est externe, dans Postgres, une instance démarrée à froid répond correctement ; les démarrages à froid ajoutent quelques secondes de latence à la première requête après une période d'inactivité. Définissez min_instance_count = 1 pour les API sensibles à la latence.
  • Entrée publique par défaut. ingress_settings = "all" afin que les clients et la console puissent atteindre le service. Activer IAP protège l'ensemble du service — API comprise — derrière une identité Google.
  • La console est livrée activée. HASURA_GRAPHQL_ENABLE_CONSOLE = "true" sert la console d'administration sur /console. Désactivez-la en production si vous gérez les métadonnées uniquement via le CI (CLI hasura / migrations).
  • Ni stockage, ni Redis, ni NFS. storage_buckets = [], enable_redis = false, enable_nfs = false — tout réside dans PostgreSQL.

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 indiqués dans les Sorties du déploiement.

A. Cloud Run — le service Hasura​

Hasura s'exécute sous forme d'un service Cloud Run v2 qui s'adapte automatiquement à la charge des 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 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​

Hasura stocke son catalogue de métadonnées (tables suivies, relations, permissions, déclencheurs d'événements) et vos données applicatives dans une instance gérée Cloud SQL for PostgreSQL 15. Le service s'y connecte de manière privée via le Cloud SQL Auth Proxy sur un socket Unix ; aucune IP publique n'est exposée. Au premier déploiement, un job d'initialisation crée la base de données et l'utilisateur de l'application ; Hasura installe son schéma de métadonnées au premier démarrage.

  • Console : SQL → sélectionnez l'instance pour 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> --database=<db-name> --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. Secret Manager​

Un secret cryptographique est généré automatiquement et stocké dans Secret Manager : HASURA_GRAPHQL_ADMIN_SECRET (accorde un accès complet aux API GraphQL/métadonnées et à la console). Le mot de passe de la base de données est géré séparément par le socle.

  • Console : Security → Secret Manager.
  • CLI :
    gcloud secrets list --project "$PROJECT"
    # The admin secret — use it as the x-hasura-admin-secret header:
    gcloud secrets versions access latest --secret=<admin-secret-name> --project "$PROJECT"

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

D. Réseau et entrée​

Le service est joignable par défaut à son URL run.app. Un équilibreur de charge HTTPS externe avec domaine personnalisé, Cloud CDN et Cloud Armor peut 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.

E. Cloud Logging et Monitoring​

Les journaux des conteneurs sont envoyés à Cloud Logging ; les métriques Cloud Run et Cloud SQL à Cloud Monitoring, avec en option un test de disponibilité (ciblant /healthz) 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 Hasura​

  • Initialisation de la base de données au premier déploiement. Un job d'initialisation exécute create-db-and-user.sh avec postgres:15-alpine. Il se connecte via le Cloud SQL Auth Proxy et crée de manière idempotente la base de données et l'utilisateur de l'application, puis accorde les privilèges. Le job peut être réexécuté sans risque.
  • Catalogue de métadonnées au démarrage. Hasura installe et migre son propre schéma de catalogue de métadonnées dans Postgres au démarrage ; la mise à niveau de la version de l'image applique donc les modifications du catalogue sans étape de migration distincte. Les métadonnées de vos tables suivies persistent dans la base de données d'une révision à l'autre.
  • Deux URL de connexion, assemblées dans le conteneur. Le point d'entrée construit à la fois HASURA_GRAPHQL_DATABASE_URL et HASURA_GRAPHQL_METADATA_DATABASE_URL à partir des variables DB_* injectées, en encodant le mot de passe pour l'URL et en distinguant selon DB_HOST (répertoire de socket → forme socket libpq ; loopback → simple ; IP privée → sslmode=require).
  • Le secret administrateur est la frontière de sécurité. Envoyez-le dans l'en-tête x-hasura-admin-secret. Pour le récupérer :
    gcloud secrets versions access latest --secret=<admin-secret-name> --project "$PROJECT"
    # Then, e.g.:
    curl -s "$SERVICE_URL/v1/graphql" \
    -H "x-hasura-admin-secret: <secret>" \
    -H 'Content-Type: application/json' \
    -d '{"query":"{ __schema { queryType { name } } }"}'
  • Chemin de santé. Les sondes de démarrage et de disponibilité ciblent /healthz — le point de terminaison public, sans authentification, qui renvoie 200 dès que le moteur est démarré et connecté à Postgres. Ne redirigez pas les sondes vers /v1/graphql ou /console (les deux renvoient 401 sans le secret administrateur).
  • Accès à la console. Ouvrez $SERVICE_URL/console dans un navigateur et collez le secret administrateur lorsqu'il vous est demandé pour suivre des tables, définir des permissions et exécuter des requêtes GraphQL.
  • Inspecter l'exécution des jobs :
    gcloud run jobs list --project "$PROJECT" --region "$REGION"
    gcloud run jobs executions list --job <job-name> --project "$PROJECT" --region "$REGION"

4. Variables de configuration​

Les variables sont regroupées exactement comme elles apparaissent sur la plateforme de déploiement. Seuls les paramètres propres à Hasura ou notables pour lui sont listés ; toutes les autres entrées sont héritées d'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_iddemoCourt suffixe 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_namehasuraNom de base des ressources. Ne pas modifier après le premier déploiement.
application_display_nameHasuraNom lisible affiché dans la console.
application_descriptionHasura GraphQL Engine on Cloud RunDescription du service.
application_versionv2.36.0Tag de l'image Hasura ; latest est remplacé par un tag v2.x épinglé au moment du build.
application_database_namehasuraNom de la base de données PostgreSQL. Immuable après le premier déploiement.
application_database_userhasuraUtilisateur de la base de données de l'application. Mot de passe généré automatiquement dans Secret Manager.

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

VariableValeur par défautDescription
deploy_applicationtrueDéfinissez false pour ne provisionner que l'infrastructure.
container_image_sourcecustomcustom construit une image d'encapsulation qui assemble les DSN ; prebuilt exige une configuration manuelle des URL.
cpu_limit1000mCPU par instance ; 1 vCPU convient à la plupart des charges de travail.
memory_limit512MiMémoire par instance ; à augmenter pour une forte concurrence de requêtes.
min_instance_count00 active la mise à l'échelle jusqu'à zéro (sans risque — tout l'état est dans Postgres).
max_instance_count3Limite supérieure de l'autoscaling ; Hasura se met à l'échelle horizontalement.
container_port8080Hasura écoute sur HASURA_GRAPHQL_SERVER_PORT = 8080.
cpu_always_allocatedfalseFacturation à la requête — Hasura n'effectue aucun travail en arrière-plan entre les requêtes.
execution_environmentgen2Gen2 recommandé.
timeout_seconds300Durée maximale d'une requête (à augmenter pour les abonnements/flux longs).
enable_cloudsql_volumetrueSocket du Cloud SQL Auth Proxy pour la connexion Postgres.
enable_image_mirroringtrueMet en miroir l'image Hasura dans Artifact Registry.
traffic_split[]Répartit le trafic entre les révisions pour des déploiements progressifs.
max_revisions_to_retain7Nombre d'anciennes révisions à conserver.

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

VariableValeur par défautDescription
ingress_settingsallall permet aux clients externes et à la console d'atteindre le service.
vpc_egress_settingPRIVATE_RANGES_ONLYN'achemine via le VPC que le trafic RFC 1918.
enable_iapfalseExige une connexion Google devant l'ensemble du service (API comprise).
iap_authorized_users / iap_authorized_groups[]Qui peut accéder via IAP.

Groupe 6 — Variables d'environnement et secrets​

VariableValeur par défautDescription
environment_variables{}Paramètres HASURA_GRAPHQL_* supplémentaires (p. ex. HASURA_GRAPHQL_DEV_MODE, HASURA_GRAPHQL_CORS_DOMAIN). Ne définissez pas ici les deux valeurs *_DATABASE_URL ni le secret administrateur — ils sont gérés automatiquement.
secret_environment_variables{}Map variable d'environnement → nom du secret Secret Manager.
secret_propagation_delay30Secondes d'attente après la création d'un secret avant de poursuivre.
secret_rotation_period2592000sFréquence des notifications de rotation de Secret Manager.

Groupe 7 — Sauvegarde et restauration​

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

Groupe 8 — CI/CD et Binary Authorization​

Intégration standard Cloud Build / Cloud Deploy d'App_CloudRun — voir App_CloudRun. Entrées principales : 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_armorfalseProvisionne un équilibreur de charge HTTPS global + le WAF Cloud Armor.
admin_ip_ranges[]Plages CIDR exemptées des règles du WAF.
application_domains[]Noms de domaine personnalisés pour l'équilibreur de charge HTTPS.
enable_cdnfalseActive Cloud CDN sur le backend de l'équilibreur de charge HTTPS.
max_images_to_retain / delete_untagged_images / image_retention_days(définies)Règle de nettoyage d'Artifact Registry.

Groupe 11 — Stockage et système de fichiers​

VariableValeur par défautDescription
create_cloud_storagetrueCrée les buckets GCS définis dans storage_buckets.
storage_buckets[]Vide — Hasura n'a besoin d'aucun stockage de fichiers.
enable_nfsfalseNon requis pour Hasura.
gcs_volumes[]Montages de volumes GCS Fuse (nécessite gen2).
manage_storage_kms_iam / enable_artifact_registry_cmekfalseOptions CMEK.

Groupe 12 — Backend de base de données​

VariableValeur par défautDescription
database_typePOSTGRES_15Fixe — Hasura nécessite PostgreSQL.
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.
enable_postgres_extensions / postgres_extensionsdésactivé / []Extensions Postgres facultatives.

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[]Cloud Scheduler + Cloud Run Jobs récurrents.
additional_services[]Services Cloud Run supplémentaires déployés aux côtés de Hasura.

Groupe 14 — Observabilité et santé​

VariableValeur par défautDescription
startup_probeHTTP /healthzSonde de démarrage au niveau de l'application.
liveness_probeHTTP /healthzSonde de vivacité au niveau de l'application.
startup_probe_configHTTP /healthzSonde de démarrage Cloud Run (au niveau du socle).
health_check_configHTTP /healthzSonde de vivacité Cloud Run (au niveau du socle).
uptime_check_config{ enabled=false, path="/healthz" }Test de disponibilité Cloud Monitoring. Désactivé par défaut ; à activer pour la surveillance en production.
alert_policies[]Règles d'alerte sur les métriques.

Groupe 16 — Redis​

VariableValeur par défautDescription
enable_redisfalseHasura ne nécessite pas Redis.
redis_host""Utilisé uniquement lorsque enable_redis = true.
redis_port6379Port Redis.

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

VariableValeur par défautDescription
enable_vpc_scfalseApplique un périmètre VPC-SC (nécessite organization_id pour les projets imbriqués dans un dossier).
vpc_cidr_ranges / vpc_sc_dry_run(définies)CIDR du niveau d'accès / mode simulation (dry-run).
enable_audit_loggingfalseCloud Audit Logs détaillés.

5. Sorties​

Renvoyées à l'issue 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 s'exécute le service.
stage_servicesURL des services par étape (Cloud Deploy).
load_balancer_ip / load_balancer_urlIP / URL de l'équilibreur de charge HTTPS externe (si 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 / port de la base de données.
storage_bucketsBuckets Cloud Storage créés (vide pour Hasura).
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 d'initialisation.
deployment_id / tenant_id / resource_prefixIdentifiants de nommage.
project_id / project_numberIdentifiants du projet.
cicd_enabled / github_repository_url / 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).

Validation au moment du plan héritée. Ce module fait passer sa configuration par le moteur du socle App_CloudRun, qui valide les valeurs et leurs combinaisons au moment du plan — un réplica en lecture sans son instance principale, IAP sans identité autorisée, un environnement d'exécution gen1 avec des montages NFS/GCS, un database_type qui ne correspond pas à une extension activée, un redis_port/backup_retention_days hors limites. Une configuration non valide fait échouer le plan avec une erreur claire et nommée avant la création de toute ressource ; la plupart des erreurs ci-dessous sont donc détectées en amont plutôt qu'à l'application ou à l'exécution.

ParamètreValeur judicieuseRisqueConséquence en cas d'erreur
HASURA_GRAPHQL_ADMIN_SECRET (généré automatiquement)À conserver dans Secret Manager ; rotation délibéréeCritiqueC'est la seule protection des API GraphQL/métadonnées et de la console — l'exposer accorde un accès complet en lecture/écriture à toutes les tables suivies.
application_database_name / application_database_userÀ définir une seule foisCritiqueImmuables après le premier déploiement ; les renommer recrée la base de données/l'utilisateur et rend orphelins le catalogue de métadonnées et toutes les données.
enable_backup_importfalse sauf en cas de restaurationCritiqueL'activer sans backup_file valide fait échouer le job d'import.
Chemin de startup_probe / liveness_probe/healthzÉlevéFaire pointer une sonde vers /v1/graphql ou /console renvoie 401 — la révision ne devient jamais Ready alors que le moteur a démarré.
HASURA_GRAPHQL_ENABLE_CONSOLEfalse en productionÉlevéLaisser la console activée en production élargit la surface d'attaque ; gérez plutôt les métadonnées via la CLI hasura/les migrations.
ingress_settings + enable_iapall ; IAP uniquement si l'API peut être protégée par identitéÉlevéIAP bloque toutes les requêtes non authentifiées, y compris les clients d'API programmatiques qui s'authentifient avec l'en-tête admin/JWT et non avec une identité Google.
container_image_sourcecustomÉlevéprebuilt ignore le point d'entrée qui assemble les deux valeurs *_DATABASE_URL — le moteur démarre sans base de données et chaque requête échoue.
memory_limit512Mi+MoyenDes métadonnées très volumineuses ou une forte concurrence de requêtes peuvent provoquer un OOM en dessous de 512 MiB ; l'environnement gen2 impose de toute façon un minimum de 512 MiB de mémoire.
min_instance_count0 (ou 1 pour la latence)MoyenLa mise à l'échelle jusqu'à zéro ajoute quelques secondes de latence de démarrage à froid à la première requête après une période d'inactivité ; définissez 1 pour les API sensibles à la latence.
backup_retention_days7 (à augmenter en production)MoyenTrop court pour une rétention conforme aux exigences réglementaires.
enable_cloud_armorà activer en productionMoyenL'API et la console sont accessibles publiquement sans protection WAF.

Pour le comportement du socle mentionné 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 à Hasura partagée avec la variante GKE est décrite dans Hasura_Common.

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