BookStack sur Cloud Run — Guide de lab

Vue d'ensemble

Durée estimée : 45–90 minutes

BookStack est une plateforme de wiki et de documentation gratuite et open source qui organise les connaissances selon une hiérarchie simple étagères → livres → chapitres → pages. Elle est construite sur Laravel (PHP) et s'appuie sur MySQL. Ce lab vous fait parcourir le cycle de vie opérationnel complet du module BookStack 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 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 BookStack. 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 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 n'exige 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). Tout autre paramètre du Guide de configuration — y compris les paramètres de mise à l'échelle et de version des tâches du jour 2 — se modifie 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). Sur 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é]

Dans la plateforme RAD, ouvrez Solutions → Solution Catalog → RAD modules, puis ouvrez BookStack (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.
La plateforme provisionne le service Cloud Run, une base de données Cloud SQL (MySQL 8.0) avec ses secrets Secret Manager (l'APP_KEY de Laravel et le mot de passe de la base de données), un bucket Cloud Storage (gcs-<service>-data), un volume NFS monté sur /var/lib/bookstack pour les images et pièces jointes téléversées, met en miroir l'image préconstruite linuxserver/bookstack dans Artifact Registry, et exécute un job ponctuel d'initialisation de la base de données (db-init) qui crée la base de données, l'utilisateur de l'application et les droits. L'image LinuxServer de BookStack exécute ensuite php artisan migrate automatiquement au premier démarrage ; le schéma est donc créé au démarrage (il n'y a pas de job de migration distinct). Les premiers déploiements prennent environ 20 à 35 minutes (la création de Cloud SQL domine).

Une fois l'opération terminée, repérez les ressources avec des filtres indépendants des noms (afin 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~bookstack" --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]

Confirmez que le service est sain et connecté à sa base de données. BookStack expose un point de terminaison de santé JSON non authentifié qui indique l'état de l'application, de la base de données, du cache et des sessions :
```
curl -s "$SERVICE_URL/status"   # expect a JSON object with status fields
```
Ouvrez $SERVICE_URL dans un navigateur. BookStack est livré avec un administrateur par défaut pour le premier démarrage : admin@admin.com / password. Connectez-vous, puis modifiez immédiatement le mot de passe et l'adresse e-mail de l'administrateur sous Settings → Users. Une fois connecté, organisez votre contenu selon la hiérarchie de BookStack — les étagères contiennent des livres, les livres contiennent des chapitres, et les chapitres contiennent des pages.

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

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"

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 manuelle via gcloud (une modification manuelle serait annulée lors du prochain apply). BookStack utilise par défaut min_instance_count = 0 (réduction à zéro) et max_instance_count = 1. Comme BookStack stocke les fichiers téléversés sur un système de fichiers NFS et conserve les sessions par instance, ne dépassez pas une instance sans activer Redis (enable_redis = true) pour partager le cache et les sessions.
Mettez à jour la version de l'application en modifiant le paramètre de version dans la plateforme RAD et en l'appliquant via Update. BookStack utilise l'image préconstruite linuxserver/bookstack ; un changement de version récupère donc à nouveau l'étiquette d'image mise en miroir et déploie une nouvelle révision (aucun build personnalisé n'est exécuté). Figez une étiquette précise (par exemple version-v24.10) en production plutôt que la valeur par défaut latest.

Gérez les secrets et les sauvegardes :

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

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

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

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>".
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 CPU et de la mémoire. Le module provisionne également un test de disponibilité ; confirmez qu'il est au vert sous Monitoring → Uptime checks, et examinez 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 BookStack.

Révision non saine / le service ne répond pas : inspectez la dernière révision et ses journaux à la recherche d'erreurs de démarrage, et confirmez que les variables d'environnement et les secrets ont été résolus. La sonde de vivacité cible /status avec une fenêtre généreuse pour le premier démarrage (délai initial de 300 s) afin que le php artisan migrate automatique de l'image puisse se terminer avant que la sonde n'échoue.
```
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 : confirmez que l'instance Cloud SQL est RUNNABLE, que le secret DB_PASSWORD existe et que le job db-init s'est terminé avec succès. BookStack se connecte via l'adresse IP privée de Cloud SQL (TCP) à l'aide des variables d'environnement natives de Laravel DB_USERNAME / DB_PASSWORD / DB_DATABASE.

Échec du job d'initialisation : 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"

Erreurs de mise en miroir / de récupération d'image : confirmez que l'image linuxserver/bookstack a été mise en miroir dans Artifact Registry et que l'étiquette récupérée existe.
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 (y compris la règle essentielle de ne jamais faire de rotation de APP_KEY après le premier démarrage — cela rendrait indéchiffrables toutes les valeurs de la base de données chiffrées auparavant).

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). Cela supprime tout ce que le module a créé — le service Cloud Run, la base de données Cloud SQL, les secrets Secret Manager (y compris APP_KEY), 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 (MySQL 8.0), les secrets, le bucket `gcs-<service>-data`, le NFS, et exécute l'initialisation de la base
2 — Accéder et vérifier	Manuel	Le contrôle de santé réussit ; se connecter et modifier les identifiants administrateur par défaut
3 — Exploiter	Manuel	Inspecter les révisions, mettre à l'échelle, mettre à jour la version, gérer les secrets et les sauvegardes, accéder à la base
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, de base de données, de job d'initialisation, d'image et d'IAM
6 — Démanteler	Automatisé	Delete (Trash) supprime toutes les ressources du module

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

By Dr Shiyghan Emmanuel Navti · Google Cloud certified: ACE · PCA · PCD · PDE · PSE · CDL

Vue d'ensemble​

Objectifs​

Prérequis​

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

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

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

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

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

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

Récapitulatif​