Hoppscotch sur Cloud Run — Guide de lab

📖 Guide de configuration

Vue d'ensemble

Durée estimée : 20–40 minutes

Hoppscotch est une plateforme open source de développement d'API, dans l'esprit de Postman, permettant de concevoir, d'envoyer et d'inspecter des requêtes HTTP, GraphQL et WebSocket depuis le navigateur. Ce lab vous fait parcourir l'intégralité du cycle de vie opérationnel du module Hoppscotch on Cloud Run sur Google Cloud : le déployer, y accéder et le vérifier, l'exploiter au quotidien, l'observer, diagnostiquer les problèmes courants et le démanteler.

Le lab porte sur l'exploitation du module Cloud Run et de la plateforme Google Cloud, et non sur les fonctionnalités du produit Hoppscotch. 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.
• Accéder au service en cours d'exécution et le vérifier.
• Effectuer les opérations du jour 2 — inspecter, mettre à l'échelle et mettre à jour le déploiement.
• Observer le service 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, 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 authentifiée : gcloud auth login et gcloud auth application-default login.
• 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. Dans la plateforme RAD, ouvrez Solutions → Solution Catalog → RAD modules, puis ouvrez Hoppscotch (Cloud Run) depuis la liste Platform Modules, 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 construit avec Cloud Build une image de conteneur personnalisée minimale (FROM hoppscotch/hoppscotch-frontend), le réplica dans Artifact Registry et provisionne un service Cloud Run à l'écoute sur le port 3000. Hoppscotch est volontairement sans état — aucune instance Cloud SQL, aucun secret Secret Manager et aucun bucket Cloud Storage ne sont créés. Sans base de données à provisionner, un premier déploiement se termine généralement en quelques minutes une fois le build de l'image achevé.

3. Une fois terminé, repérez la ressource avec un filtre indépendant des noms (afin que la commande continue de fonctionner quel que soit le suffixe du déploiement) :

   SERVICE=$(gcloud run services list --project="$PROJECT" --region="$REGION" \
     --filter="metadata.name~hoppscotch" --format="value(metadata.name)" --limit=1)
   SERVICE_URL=$(gcloud run services describe "$SERVICE" \
     --project="$PROJECT" --region="$REGION" --format="value(status.url)")
   echo "Service: $SERVICE"
   echo "URL:     $SERVICE_URL"

---

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

1. Vérifiez que le service répond. Hoppscotch n'a aucun backend qui devrait être joignable — le chemin racine renvoie l'interface de l'application dès que Caddy se lie au port 3000 :

   curl -sS -o /dev/null -w '%{http_code}\n' "$SERVICE_URL/"   # expect 200

2. Ouvrez $SERVICE_URL dans un navigateur. Contrairement à la plupart des modules, Hoppscotch n'a aucun compte administrateur à créer au premier lancement — le frontend auto-hébergé ne dispose d'aucune connexion ni gestion des utilisateurs qui lui soit propre. Vous pouvez commencer à construire des requêtes immédiatement. Les collections, environnements et l'historique sont conservés dans le stockage local du navigateur sur la machine de chaque utilisateur, et non sur le serveur.

---

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

1. Inspectez le service et ses révisions (chaque déploiement crée une révision immuable ; le trafic bascule vers la plus récente qui est en bonne santé) :

   gcloud run services describe "$SERVICE" --project="$PROJECT" --region="$REGION"
   gcloud run revisions list --service="$SERVICE" --project="$PROJECT" --region="$REGION"

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 du service, la mise à l'échelle est donc une modification de configuration, et non une modification manuelle via gcloud (une modification manuelle serait annulée lors de la prochaine application). Comme Hoppscotch ne conserve ni file d'attente partagée ni base de données, la mise à l'échelle n'est pas contrainte — augmentez librement max_instance_count comme plafond de coût/débit. La valeur par défaut min_instance_count = 0 ramène le service à zéro entre les requêtes ; la première requête après une période d'inactivité subit un bref démarrage à froid, peu coûteux pour une SPA statique.

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 nouvelle révision est déployée. HOPPSCOTCH_VERSION (et non le générique APP_VERSION) épingle le tag amont hoppscotch-frontend ; ainsi, application_version = "latest" se résout au moment du build en un tag épinglé et éprouvé, plutôt qu'en la chaîne littérale latest.

4. Vérifiez les secrets — Hoppscotch n'en provisionne aucun par conception ; vérifiez que rien d'inattendu n'apparaît :

   gcloud secrets list --project="$PROJECT" --filter="name~hoppscotch"

---

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

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

   gcloud run services logs read "$SERVICE" --project="$PROJECT" --region="$REGION" --limit=50

   Filtre du Logs Explorer : resource.type="cloud_run_revision" AND resource.labels.service_name="<service>".

2. Surveillance — ouvrez le tableau de bord Cloud Run du service et examinez le nombre de requêtes, la latence des requêtes, le nombre d'instances (comportement de mise à l'échelle) et l'utilisation du CPU / de la mémoire. Le module peut provisionner un test de disponibilité (uptime check) sur / ; vérifiez qu'il est au vert sous Monitoring → Uptime checks, et consultez Alerting → Policies.

---

Tâche 5 — 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 Hoppscotch.

• Révision en mauvaise santé / le service ne répond pas : inspectez la dernière révision et ses journaux. Les sondes de démarrage et de vivacité ciblent la racine /, qui renvoie HTTP 200 quelques secondes après que Caddy s'est lié au port 3000 — une sonde en échec signifie presque toujours que le tag d'image est invalide, et non qu'un backend est injoignable (il n'y a pas de backend).

  gcloud run revisions list --service="$SERVICE" --project="$PROJECT" --region="$REGION"
  gcloud run services logs read "$SERVICE" --project="$PROJECT" --region="$REGION" --limit=100

• Échec de la construction de l'image : consultez l'historique Cloud Build pour le journal du build en échec — un tag application_version invalide se manifeste le plus souvent par MANIFEST_UNKNOWN.

  gcloud builds list --project="$PROJECT" --region="$REGION" --limit=5

• Mauvais port de conteneur : le frontend ne sert que sur le port 3000 ; vérifiez container_port = 3000 si la sonde de démarrage ne réussit jamais.
• Erreurs 403 / d'autorisation : vérifiez les rôles IAM du compte de service d'exécution.

Consultez la section Configuration Pitfalls du Guide de configuration pour les pièges propres à chaque paramètre (notamment pourquoi container_image_source doit rester custom et pourquoi database_type/enable_cloudsql_volume doivent rester désactivés).

---

Tâche 6 — 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éé — le service Cloud Run et son image Artifact Registry (Hoppscotch ne provisionne ni base de données, ni secrets, ni buckets de stockage ; il n'y a donc rien d'autre à nettoyer). Les ressources appartenant à Services_GCP (le VPC, le registre partagé) 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 construit l'image personnalisée et provisionne le service Cloud Run — sans base de données, secrets ni bucket de stockage
2 — Accéder et vérifier	Manuel	La vérification d'état réussit ; ouvrir l'URL et utiliser Hoppscotch immédiatement (aucun compte administrateur)
3 — Exploiter	Manuel	Inspecter les révisions, mettre à l'échelle (sans contrainte), mettre à jour la version, confirmer l'absence de secrets
4 — Observer	Manuel	Interroger Cloud Logging ; consulter les métriques Cloud Monitoring et le test de disponibilité
5 — Dépanner	Manuel	Diagnostiquer les problèmes de révision, de build, de port et d'IAM
6 — Démanteler	Automatisé	Delete (Trash) supprime le service Cloud Run et l'image