Hasura sur GKE Autopilot — Guide de lab

📖 Guide de configuration

Vue d'ensemble

Durée estimée : 45–90 minutes

Hasura est un moteur open source qui vous fournit instantanément une API GraphQL et REST en temps réel sur une base de données PostgreSQL, avec une autorisation basée sur les rôles et une console d'administration intégrée. Ce lab vous fait parcourir l'intégralité du cycle de vie opérationnel du module Hasura on GKE Autopilot sur Google Cloud : le déployer, y accéder et le vérifier, ouvrir la console et exécuter une requête GraphQL, l'exploiter au quotidien, l'observer, diagnostiquer les problèmes courants et le démanteler.

Le lab porte sur l'exploitation du module GKE et de la plateforme Google Cloud, et non sur le fonctionnement interne du produit Hasura. Pour la liste complète des services provisionnés et de chaque paramètre de configuration (organisés par groupe), consultez le Guide de configuration — ce lab ne reprend volontairement pas ce détail afin de rester exact dans le temps.

Objectifs

À la fin de ce lab, vous saurez :

• Déployer le module depuis la plateforme RAD et repérer les ressources qu'il provisionne.
• Vous connecter au cluster GKE et accéder à la charge de travail en cours d'exécution.
• Récupérer le secret d'administration, ouvrir la console, suivre (track) une table et exécuter une requête GraphQL.
• Effectuer les opérations du jour 2 — inspecter, mettre à l'échelle, mettre à jour, et gérer les secrets et le stockage.
• Observer la charge de travail avec Cloud Logging et Cloud Monitoring.
• Diagnostiquer et résoudre les problèmes de déploiement et d'exécution les plus courants.
• Démanteler proprement le déploiement.

Prérequis

• Services_GCP (fournit le VPC, le cluster GKE Autopilot, Cloud SQL, Artifact Registry et les comptes de service partagés dont dépend ce module). Vous n'avez pas besoin de le déployer vous-même au préalable — la plateforme détecte automatiquement s'il existe déjà dans le projet cible et, sinon, le provisionne avant ce module (voir la tâche 1).
• Un projet Google Cloud avec la facturation activée.
• gcloud CLI et kubectl installés ; gcloud auth login et gcloud auth application-default login effectués.
• Le rôle IAM Project Owner (ou équivalent) sur le projet.
• Vous utilisez votre propre projet ? Avant le premier déploiement dans celui-ci, la boîte de dialogue de confirmation du déploiement vous demande de prouver que vous le contrôlez (Get verification code, exécutez les commandes affichées en tant que propriétaire (Owner) du projet, puis Verify) et d'attribuer le rôle Owner au compte de service de déploiement RAD. Un projet que RAD crée pour vous ne nécessite ni l'un ni l'autre.
• Mode avancé pour les modifications ultérieures. Le formulaire de création ne demande que la première page de paramètres (et, dans un projet que RAD crée pour vous, guère plus que le nom du tenant et la région). Tous les autres paramètres du Guide de configuration — y compris les paramètres de mise à l'échelle et de version des tâches du jour 2 — se modifient ensuite avec Update sur la page du déploiement après avoir coché Enable advanced mode, ce qui exige un solde de crédits couvrant le coût de build estimé de la mise à jour (les mises à jour n'entraînent jamais de frais de module). Dans un environnement de lab, seul un administrateur peut utiliser le mode avancé.
• Accès à la plateforme RAD avec l'autorisation de déployer des modules dans le projet.

Définissez une fois ces variables shell ; chaque tâche ci-dessous les réutilise :

export PROJECT="<your-gcp-project-id>"
export REGION="us-central1"           # the region you deploy into

---

Tâche 1 — Déployer le module [Automatisé]

1. Ouvrez Solutions → Solution Catalog → RAD modules dans la barre de navigation supérieure de la plateforme RAD, ouvrez Hasura (GKE) depuis la liste Platform Modules pour commencer la configuration, choisissez Configuration Form sous How would you like to configure this deployment? (le formulaire s'ouvre sur le Conversational Assistant si vous détenez des crédits achetés ou si vous êtes partenaire ou administrateur), renseignez project_id et passez en revue les paramètres. Ne configurez que ce dont vous avez besoin — le Guide de configuration documente chaque paramètre par groupe, avec ses valeurs par défaut. Cliquez sur Deploy Module, vérifiez le coût estimé dans la boîte de dialogue Deployment Confirmation lorsqu'elle apparaît et cliquez sur Submit (si la boîte de dialogue ajoute ensuite une étape de confirmation, comme la vérification d'un projet que vous apportez, effectuez-la et cliquez sur Confirm), ce qui ouvre la page d'état du déploiement avec les journaux en temps réel.

2. La plateforme déploie la charge de travail dans le cluster GKE Autopilot, provisionne une base de données Cloud SQL (PostgreSQL 15) avec ses secrets Secret Manager (HASURA_GRAPHQL_ADMIN_SECRET et le mot de passe de la base de données), construit l'image du conteneur (une fine surcouche de hasura/graphql-engine) et exécute un job ponctuel d'initialisation de la base de données. Les premiers déploiements prennent environ 20–35 minutes (la création de Cloud SQL en représente l'essentiel).

3. Connectez-vous au cluster et repérez l'espace de noms avec des filtres indépendants des noms :

   CLUSTER=$(gcloud container clusters list --project="$PROJECT" --format="value(name)" --limit=1)
   gcloud container clusters get-credentials "$CLUSTER" --region="$REGION" --project="$PROJECT"
   
   NS=$(kubectl get ns -o name | grep hasura | head -1 | cut -d/ -f2)
   echo "Cluster: $CLUSTER   Namespace: $NS"
   kubectl get all -n "$NS"

---

Tâche 2 — Accéder et vérifier [Manuel]

1. Vérifiez que la charge de travail est en cours d'exécution et trouvez son adresse externe :

   kubectl get pods,svc -n "$NS"
   EXTERNAL_IP=$(kubectl get svc -n "$NS" \
     -o jsonpath='{.items[?(@.spec.type=="LoadBalancer")].status.loadBalancer.ingress[0].ip}')
   echo "External IP: $EXTERNAL_IP"

2. Vérifiez que le service est en bonne santé. Hasura expose un point de terminaison de santé public qui ne renvoie 200 que lorsque le moteur est démarré et connecté à PostgreSQL :

   curl -s -o /dev/null -w '%{http_code}\n' "http://${EXTERNAL_IP}/healthz"   # expect 200

3. Récupérez le secret d'administration dans Secret Manager — vous en avez besoin pour la console et pour chaque appel aux API GraphQL/de métadonnées :

   ADMIN_SECRET_NAME=$(gcloud secrets list --project="$PROJECT" \
     --filter="name~admin-secret" --format="value(name)" --limit=1)
   ADMIN=$(gcloud secrets versions access latest --secret="$ADMIN_SECRET_NAME" --project="$PROJECT")
   echo "Admin secret: $ADMIN"

4. Ouvrez http://${EXTERNAL_IP}/console dans un navigateur. Hasura vous demande le secret d'administration — collez la valeur obtenue à l'étape 3. La console s'ouvre sur l'onglet Data, connectée à votre base de données Cloud SQL (la source default).

---

Tâche 3 — Exemple guidé : suivre une table et exécuter une requête GraphQL [Manuel]

1. Créez une table. Dans la console, allez dans Data → default → public → Create Table. Nommez-la todos avec les colonnes id (Integer, auto-incrément, clé primaire) et title (Text). Cliquez sur Add Table. (Vous préférez le SQL ? Ouvrez Data → SQL, exécutez CREATE TABLE todos (id serial primary key, title text); et cochez Track this table.)

2. Suivez la table. Si vous l'avez créée via SQL, Hasura la liste sous Untracked tables — cliquez sur Track. C'est le suivi qui expose la table via l'API GraphQL ; il écrit une entrée dans le catalogue de métadonnées de Hasura (stocké dans Postgres, il survit donc aux redémarrages de pods et aux mises à jour progressives).

3. Insérez une ligne via l'API (en utilisant le secret d'administration comme en-tête x-hasura-admin-secret) :

   curl -s "http://${EXTERNAL_IP}/v1/graphql" \
     -H "x-hasura-admin-secret: $ADMIN" \
     -H 'Content-Type: application/json' \
     -d '{"query":"mutation { insert_todos_one(object: {title: \"Ship the docs\"}) { id title } }"}'

4. Exécutez une requête GraphQL pour la relire :

   curl -s "http://${EXTERNAL_IP}/v1/graphql" \
     -H "x-hasura-admin-secret: $ADMIN" \
     -H 'Content-Type: application/json' \
     -d '{"query":"query { todos { id title } }"}'
   # => {"data":{"todos":[{"id":1,"title":"Ship the docs"}]}}

   Vous pouvez aussi exécuter la même requête de manière interactive dans l'onglet API (GraphiQL) de la console — il envoie l'en-tête du secret d'administration pour vous.

---

Tâche 4 — Exploiter et maintenir en service (jour 2) [Manuel]

1. Inspectez la charge de travail — le Deployment, les pods et l'autoscaler horizontal :

   kubectl get deploy,pods,hpa,pdb -n "$NS"
   kubectl describe deploy -n "$NS"

2. Mettez à l'échelle en modifiant les paramètres de nombre minimal/maximal d'instances puis en cliquant sur Update sur la page de détails du déploiement — le module possède la spécification de la charge de travail, la mise à l'échelle est donc une modification de configuration, et non un kubectl scale manuel (une modification manuelle serait annulée lors de la prochaine application). Hasura se met à l'échelle horizontalement sans risque car tout l'état réside dans Postgres et session_affinity = "None" ; une mise à jour progressive remplace les pods sans perdre de requêtes.

3. Mettez à jour la version de l'application en modifiant le paramètre de version dans la plateforme RAD et en l'appliquant via Update ; une nouvelle image est construite et une mise à jour progressive remplace les pods. Les métadonnées de vos tables suivies sont conservées dans la base de données lors de la mise à niveau.

4. Gérez les secrets, le stockage et les jobs :

   kubectl get secrets -n "$NS"
   gcloud secrets list --project="$PROJECT" --filter="name~hasura"
   kubectl get jobs -n "$NS"          # DB-init and any scheduled jobs

5. Ouvrez une session de base de données pour l'inspection ou la maintenance :

   INSTANCE=$(gcloud sql instances list --project="$PROJECT" --format="value(name)" --limit=1)
   # Role and database are tenant-prefixed (e.g. hasurademo426161cf) — not the bare app name.
   DB_USER=$(gcloud sql users list --instance="$INSTANCE" --project="$PROJECT" \
     --format="value(name)" --filter="name~^hasura" --limit=1)
   DB_NAME=$(gcloud sql databases list --instance="$INSTANCE" --project="$PROJECT" \
     --format="value(name)" --filter="name~^hasura" --limit=1)
   gcloud sql connect "$INSTANCE" --user="$DB_USER" --database="$DB_NAME" --project="$PROJECT"

---

Tâche 5 — Observer : journalisation et surveillance [Manuel]

1. Journaux — depuis kubectl ou l'explorateur de journaux (Logs Explorer) :

   kubectl logs -n "$NS" deploy/"$(kubectl get deploy -n "$NS" -o jsonpath='{.items[0].metadata.name}')" --tail=50

   Filtre du Logs Explorer : resource.type="k8s_container" AND resource.labels.namespace_name="<namespace>".

2. Surveillance — ouvrez les tableaux de bord GKE / Kubernetes et examinez l'utilisation du CPU et de la mémoire des pods, le nombre de redémarrages et les métriques de requêtes. Le module peut provisionner un test de disponibilité (uptime check) (lorsqu'il est activé) ; consultez Monitoring → Uptime checks et Alerting → Policies.

---

Tâche 6 — Dépanner et déboguer [Manuel]

Des techniques durables pour les modes de défaillance que vous rencontrerez le plus probablement. Il s'agit de diagnostics au niveau de la plateforme, qui ne changent pas avec les versions de Hasura.

• Pod non Ready / CrashLoopBackOff : inspectez les événements et les journaux. La sonde de vivacité (liveness) cible /healthz ; un échec de connexion à PostgreSQL empêche le pod de devenir Ready.

  kubectl describe pod -n "$NS" <pod>          # Events section shows scheduling/probe/mount errors
  kubectl logs -n "$NS" <pod> --previous       # logs from the crashed container

• /console ou /v1/graphql renvoie 401 : le secret d'administration est manquant ou mal transmis. Récupérez-le à nouveau (tâche 2, étape 3) et envoyez-le en tant que x-hasura-admin-secret. Ne pointez jamais les sondes de santé vers ces chemins — utilisez /healthz.
• Erreurs de connexion à la base de données : vérifiez que l'instance Cloud SQL est RUNNABLE, que le secret du mot de passe de la base a bien été matérialisé dans l'espace de noms et que le job d'initialisation s'est terminé. Sur GKE, le sidecar Auth Proxy écoute sur 127.0.0.1 ; le DSN est un simple loopback (sans SSL).
• Échec du job d'initialisation : inspectez le job et les journaux de son pod :

  kubectl get jobs -n "$NS"
  kubectl logs -n "$NS" job/<job-name>

• Pod en attente (Pending) / pas d'IP externe : consultez les événements de kubectl describe pod pour repérer des problèmes de ressources ou de quota, et vérifiez que le Service LoadBalancer a une IP attribuée.
• Erreurs de récupération d'image : vérifiez que l'image existe dans Artifact Registry et que le compte de service des nœuds peut la récupérer.

Consultez la section Configuration Pitfalls du Guide de configuration pour les pièges propres à chaque paramètre (notamment garder les sondes sur /healthz et ne jamais exposer le secret d'administration).

---

Tâche 7 — Démanteler [Automatisé]

Sur la page Deployments, ouvrez le déploiement et cliquez sur l'icône Trash (Delete). Delete exécute terraform destroy et est irréversible (l'enregistrement du déploiement est conservé pour l'historique). Si un déploiement est bloqué et que la plateforme RAD ne peut plus le gérer (par exemple après des modifications manuelles en conflit avec l'état Terraform), utilisez plutôt Purge (depuis la même boîte de dialogue Delete) — cela supprime le déploiement des enregistrements de RAD sans détruire les ressources cloud (RAD oublie simplement le déploiement). Cela supprime tout ce que le module a créé — la charge de travail Kubernetes et l'espace de noms, la base de données Cloud SQL, les secrets Secret Manager et les images Artifact Registry. Les ressources appartenant à Services_GCP (le VPC, le cluster GKE, le Cloud SQL partagé, le registre) sont gérées séparément et ne sont pas supprimées ici.

---

Récapitulatif

Tâche	Type	Résultat
1 — Déployer	Automatisé	Le module déploie la charge de travail GKE, Cloud SQL (PostgreSQL 15), les secrets, et exécute l'initialisation de la base
2 — Accéder et vérifier	Manuel	Se connecter au cluster ; la vérification d'état réussit ; récupérer le secret d'administration ; ouvrir la console
3 — Exemple guidé	Manuel	Suivre une table et exécuter une insertion + une requête GraphQL de bout en bout
4 — Exploiter	Manuel	Inspecter la charge de travail, mettre à l'échelle, mettre à jour la version, gérer les secrets/le stockage, accéder à la base
5 — Observer	Manuel	Interroger Cloud Logging ; consulter les métriques Cloud Monitoring et le test de disponibilité
6 — Dépanner	Manuel	Diagnostiquer les problèmes de pod, d'authentification (401), de base de données, de job d'initialisation, de planification et de récupération d'image
7 — Démanteler	Automatisé	Delete (Trash) supprime toutes les ressources du module