Focalboard sur Cloud Run — Guide de lab

📖 Guide de configuration

Vue d’ensemble

Durée estimée : 45–90 minutes

Focalboard est un serveur de tableaux Kanban et de projets, auto-hébergé et open source, issu du projet Mattermost : un backend Go qui sert une interface React compilée pour gérer des tâches, des tableaux et des workflows. Ce lab vous fait parcourir l’intégralité du cycle de vie opérationnel du module Focalboard 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, puis le supprimer.

Le lab porte sur l’exploitation du module Cloud Run et de la plateforme Google Cloud, et non sur les fonctionnalités du produit Focalboard. 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 le bucket des pièces jointes.
• 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 ce projet, 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.
• Le 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. Dans la plateforme RAD, ouvrez Solutions → Solution Catalog → RAD modules, puis ouvrez Focalboard (Cloud Run) dans 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), définissez 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 provisionne le service Cloud Run, une base de données Cloud SQL (PostgreSQL 15) avec ses secrets Secret Manager (FOCALBOARD_ADMIN_PASSWORD et le mot de passe de la base de données), un bucket Cloud Storage dédié aux pièces jointes des tableaux, met en miroir l’image mattermost/focalboard dans Artifact Registry et exécute un job ponctuel d’initialisation de la base de données qui crée le rôle applicatif et la base. Les premiers déploiements prennent environ 20–35 minutes (la création de Cloud SQL représente l’essentiel du temps).

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

   SERVICE=$(gcloud run services list --project="$PROJECT" --region="$REGION" \
     --filter="metadata.name~focalboard" --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. Confirmez que le service est sain et connecté à sa base de données. Focalboard ne dispose pas d’API de santé dédiée : les sondes de démarrage, de vivacité (liveness) et de disponibilité (readiness) ciblent toutes la racine de l’interface web, qui ne renvoie 200 qu’une fois que le serveur Go a ouvert son port et terminé ses propres migrations de schéma :

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

2. Ouvrez $SERVICE_URL dans un navigateur. Focalboard fonctionne en authMode = native sans identifiant administrateur préinitialisé dans Secret Manager : inscrivez le premier compte via l’interface (nom, adresse e-mail, mot de passe) ; il devient automatiquement le propriétaire de l’espace de travail. Les tableaux partagés publics sont activés par défaut : une fois créés, les tableaux peuvent donc être partagés via des liens publics.

---

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 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 et en cliquant sur Update sur la page de détails du déploiement : le module est propriétaire 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 l’application suivante). Contrairement aux applications qui ont besoin de Redis pour coordonner plusieurs instances, Focalboard conserve tout l’état des tableaux dans PostgreSQL et n’utilise ni cache ni file d’attente : vous pouvez donc augmenter max_instance_count sans autre prérequis.

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 (l’image de base est mise en miroir depuis mattermost/focalboard) et une nouvelle révision est déployée. Focalboard applique ses propres migrations de schéma à chaque démarrage en tant qu’utilisateur de base de données de l’application ; la mise à niveau de la version applique donc automatiquement les modifications de schéma, sans étape de migration distincte.

4. Gérez les secrets et les jobs :

   gcloud secrets list --project="$PROJECT" --filter="name~focalboard"
   gcloud run jobs list --project="$PROJECT" --region="$REGION"   # db-init job

5. Inspectez le bucket des pièces jointes — les fichiers téléversés (et non les données des tableaux) y sont stockés :

   gcloud storage buckets list --project="$PROJECT" --filter="name~focalboard"
   gcloud storage ls gs://<attachment-bucket>/

6. 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. focalboarddemo426161cf) — not the bare app name.
   DB_USER=$(gcloud sql users list --instance="$INSTANCE" --project="$PROJECT" \
     --format="value(name)" --filter="name~^focalboard" --limit=1)
   gcloud sql connect "$INSTANCE" --user="$DB_USER" --project="$PROJECT"

---

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

1. Journaux — depuis la CLI ou l’explorateur de journaux (Logs Explorer). Le point d’entrée affiche au démarrage l’hôte, le nom, l’utilisateur et le sslmode de la base tels qu’ils ont été résolus, ce qui est utile pour confirmer le câblage de la connexion :

   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 test de disponibilité du module (uptime_check_config) est désactivé par défaut : activez-le et vérifiez qu’il passe au vert sous Monitoring → Uptime checks si vous avez besoin d’une surveillance synthétique de la disponibilité.

---

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

Des techniques durables pour les modes de défaillance que vous êtes le plus susceptible de rencontrer. Ce sont des diagnostics au niveau de la plateforme, qui ne changent pas d’une version de Focalboard à l’autre.

• Révision en mauvaise santé / le service ne répond pas : examinez la dernière révision et ses journaux pour repérer des erreurs de démarrage, et vérifiez que les variables d’environnement et les secrets ont été résolus. La sonde de démarrage cible / et accorde jusqu’à ~7–8 minutes au premier démarrage (délai initial de 60s, période de 15s, 30 tentatives).

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

• 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 existe et que le job db-init s’est terminé avec succès. Le point d’entrée de Focalboard régénère /opt/focalboard/config.json à partir des variables DB_* injectées par Foundation à chaque démarrage (il n’existe pas de surcharge par variable d’environnement) et, sur Cloud Run, il privilégie DB_IP plutôt que le socket Cloud SQL, avec sslmode=require.
• Échec du job db-init : listez les exécutions et lisez les journaux de celle qui a échoué :

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

• Les téléversements de pièces jointes échouent mais la modification des tableaux fonctionne : le montage gcsfuse sur /data (enable_gcs_storage_volume) est absent ou mal configuré ; le contenu des tableaux lui-même réside dans PostgreSQL et n’est pas affecté, seuls les téléversements de fichiers le sont.
• Échec du build de l’image : consultez l’historique Cloud Build pour lire le journal de l’étape de mise en miroir/de 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 (pièges de configuration) du Guide de configuration pour les pièges propres à chaque paramètre (notamment la raison pour laquelle application_database_name/application_database_user sont de fait immuables après le premier déploiement, et pourquoi database_type doit rester POSTGRES_15).

---

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) : cette action retire le déploiement des enregistrements de RAD sans détruire les ressources cloud (RAD oublie 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, le bucket GCS des pièces jointes 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), les secrets, le bucket des pièces jointes, et exécute l’initialisation de la base
2 — Accéder et vérifier	Manuel	Le contrôle de santé (/) réussit ; inscription du premier compte dans l’interface pour en devenir propriétaire
3 — Exploiter	Manuel	Inspecter les révisions, mettre à l’échelle, mettre à jour la version, gérer les secrets/jobs, inspecter les pièces jointes, accéder à la base
4 — Observer	Manuel	Interroger Cloud Logging ; examiner les métriques Cloud Monitoring et le test de disponibilité (facultatif)
5 — Dépanner	Manuel	Diagnostiquer les problèmes de révision, de base de données, de job d’initialisation, de téléversement, de build et d’IAM
6 — Démanteler	Automatisé	Delete (Trash) supprime toutes les ressources du module