Cyclos sur Cloud Run — Guide de lab

📖 Guide de configuration

Vue d’ensemble

Durée estimée : 45–90 minutes

Cyclos est une plateforme bancaire et de paiement utilisée par les institutions de microfinance, les coopératives de crédit et les réseaux de monnaies complémentaires. Ce lab vous fait parcourir le cycle de vie opérationnel complet du module Cyclos 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 Cyclos. 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 la durée.

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, mettre à jour, et gérer les secrets et les sauvegardes.
• 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, 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 authentifié : gcloud auth login et gcloud auth application-default login.
• Le rôle IAM Project Owner (ou équivalent) sur le projet.
• Vous apportez 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 qu’elle affiche en tant qu’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 n’exige 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é.
• Un 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 navigation supérieure de la plateforme RAD, ouvrez Cyclos (Cloud Run) dans la liste Platform Modules pour démarrer 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 alors 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 provisionne le service Cloud Run, une base de données Cloud SQL (PostgreSQL 15) avec ses secrets Secret Manager et un bucket GCS de stockage de fichiers, construit l’image de conteneur et exécute un job ponctuel d’initialisation de la base de données (il installe les six extensions PostgreSQL requises et crée la base de données et l’utilisateur de l’application). Les premiers déploiements prennent environ 20–35 minutes (la création de Cloud SQL en représente l’essentiel). Cyclos initialise ensuite son schéma au premier démarrage, ce qui ajoute encore 2–5 minutes avant que le service soit pleinement prêt.

3. Une fois l’opération terminée, découvrez les ressources à l’aide de filtres indépendants des noms (pour que les commandes continuent de fonctionner quel que soit le suffixe du déploiement) :

   SERVICE=$(gcloud run services list --project="$PROJECT" --region="$REGION" \
     --filter="metadata.name~cyclos" --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 est sain et entièrement initialisé (le point de terminaison /api ne renvoie HTTP 200 qu’une fois le contexte Spring de Cyclos et le schéma de base de données prêts) :

   curl -s -o /dev/null -w "%{http_code}" "$SERVICE_URL/api"   # expect 200

2. Ouvrez l’interface web de Cyclos à l’adresse ${SERVICE_URL}/cyclos dans un navigateur. Connectez-vous avec les identifiants administrateur par défaut de Cyclos (admin / 1234) et changez le mot de passe dès la fin de l’assistant de configuration.

   Le mot de passe de la base de données et le secret du superutilisateur PostgreSQL sont disponibles dans Secret Manager pour les opérations d’infrastructure (ce ne sont pas les identifiants administrateur de Cyclos) :

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

---

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 saine) :

   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 et 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 gcloud manuelle (une modification manuelle serait annulée lors du prochain apply). Remarque : Cyclos Community Edition fonctionne par défaut sur une seule instance ; dépasser une instance nécessite de configurer le clustering Hazelcast.

3. Mettez à jour la version de l’application en modifiant le paramètre de version via Update sur la page de détails du déploiement ; une nouvelle image est construite et une nouvelle révision est déployée.

4. Gérez les secrets et les sauvegardes :

   gcloud secrets list --project="$PROJECT" --filter="name~cyclos"
   gcloud run jobs list --project="$PROJECT" --region="$REGION"   # 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. cyclosdemo426161cf) — not the bare app name.
   DB_USER=$(gcloud sql users list --instance="$INSTANCE" --project="$PROJECT" \
     --format="value(name)" --filter="name~^cyclos" --limit=1)
   DB_NAME=$(gcloud sql databases list --instance="$INSTANCE" --project="$PROJECT" \
     --format="value(name)" --filter="name~^cyclos" --limit=1)
   gcloud sql connect "$INSTANCE" --user="$DB_USER" --database="$DB_NAME" --project="$PROJECT"

---

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 (P50/P95/P99), le nombre d’instances (comportement de mise à l’échelle) et l’utilisation du processeur / de la mémoire. Le module provisionne aussi un test de disponibilité (uptime check, lorsqu’il est activé) ; 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 d’une version de Cyclos à l’autre.

• Révision non saine / le service ne répond pas : examinez la dernière révision et ses journaux à la recherche d’erreurs de démarrage, et vérifiez que les variables d’environnement et les secrets ont été résolus.

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

• Démarrage lent ou échecs de sonde : Cyclos initialise son schéma PostgreSQL au premier démarrage (2–5 minutes). La sonde de démarrage utilise TCP, elle réussit donc dès que Tomcat écoute, ce qui évite un interblocage lors des mises à jour progressives ; la sonde de vivacité sur /api détecte ensuite un contexte Spring non initialisé. Si la révision est arrêtée avant la fin de l’initialisation du schéma, vérifiez le failure_threshold de la sonde de démarrage dans le Guide de configuration.
• 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 de données existe et que le job db-init s’est terminé avec succès.

  gcloud run jobs executions list --job="${SERVICE}-db-init" \
    --project="$PROJECT" --region="$REGION"

• Échec de la construction de l’image : consultez l’historique Cloud Build pour lire le journal du build en échec.
• 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.

---

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

Sur la page Deployments, ouvrez le déploiement et cliquez sur l’icône Trash (Delete). La suppression 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) — elle retire le déploiement des enregistrements de RAD sans détruire les ressources cloud (RAD oublie simplement le déploiement). La suppression retire tout ce que le module a créé — le service Cloud Run, la base de données Cloud SQL, les secrets Secret Manager, les buckets GCS et les images Artifact Registry. Les ressources appartenant à Services_GCP (le VPC, 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 provisionne Cloud Run, Cloud SQL (PostgreSQL 15), GCS et les secrets, puis exécute l’initialisation de la base de données
2 — Accéder et vérifier	Manuel	Le contrôle d’état réussit sur /api ; connexion à Cyclos sur /cyclos
3 — Exploiter	Manuel	Inspecter les révisions, mettre à l’échelle, mettre à jour la version, gérer les secrets/sauvegardes, accéder à la base de données
4 — Observer	Manuel	Interroger Cloud Logging ; examiner les métriques Cloud Monitoring et le test de disponibilité
5 — Dépanner	Manuel	Diagnostiquer les problèmes de révision, d’initialisation du schéma, de base de données, de build et d’IAM
6 — Démanteler	Automatisé	La suppression (Trash) retire toutes les ressources du module