Passbolt sur GKE Autopilot — Guide de lab

Vue d'ensemble

Durée estimée : 30–60 minutes

Passbolt (Community Edition) est un gestionnaire de mots de passe gratuit, open source et orienté équipe, doté d'un chiffrement basé sur GPG et du partage d'identifiants par utilisateur ou par groupe (AGPL-3.0). Ce lab vous fait parcourir l'intégralité du cycle de vie opérationnel du module Passbolt on GKE Autopilot sur Google Cloud : le déployer, y accéder et le vérifier (y compris le processus d'initialisation de l'administrateur, réellement différent, qu'utilise cette application), 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 les fonctionnalités du produit Passbolt. 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, récupérer l'URL de configuration administrateur à usage unique dans les journaux du pod, et terminer l'enregistrement via une extension de navigateur compatible avec Passbolt.
Effectuer les opérations du jour 2 — inspecter, mettre à l'échelle, mettre à jour, et gérer les volumes des paires de clés GPG/JWT.
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 exécuté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.
Une extension de navigateur compatible avec Passbolt installée (Chrome, Firefox ou Edge) — nécessaire pour terminer la configuration du compte administrateur à la tâche 2. Installez-la depuis passbolt.com/download avant de commencer.

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é]

Ouvrez Solutions → Solution Catalog → RAD modules dans la navigation supérieure de la plateforme RAD, ouvrez Passbolt (GKE) depuis 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. Renseignez admin_email, admin_first_name et admin_last_name avec vos vraies informations — elles initialisent l'unique compte administrateur. Ne configurez que ce dont vous avez besoin — le Guide de configuration documente chaque paramètre par groupe, avec ses valeurs par défaut. Si vous déployez à côté d'une instance Passbolt_CloudRun dans le même projet, définissez tenant_id = "gke" (et "cr" sur le déploiement Cloud Run) afin que les deux variantes n'entrent pas en collision sur des noms de ressources partagés. 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 déploie la charge de travail dans le cluster GKE Autopilot, provisionne une base de données Cloud SQL (MySQL 8.0) avec son secret de mot de passe Secret Manager, deux buckets dédiés montés via GCS Fuse (storage pour la paire de clés GPG du serveur, jwt pour la paire de clés JWT), et exécute la chaîne de jobs d'initialisation en 2 étapes (db-init → admin-bootstrap). Les premiers déploiements prennent généralement environ 15–25 minutes. Contrairement à la sémantique execute_on_apply de Cloud Run, sur GKE les pods des Jobs sont planifiés immédiatement, quel que soit ce paramètre ; le respect de l'ordre provient de depends_on_jobs = ["db-init"] sur admin-bootstrap, et non d'une attente de Terraform.

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 passbolt | head -1 | cut -d/ -f2)
echo "Cluster: $CLUSTER   Namespace: $NS"
kubectl get all -n "$NS"

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

La configuration du compte administrateur de Passbolt diffère réellement de presque toutes les autres applications de ce catalogue : il n'existe ni mot de passe administrateur côté serveur, ni assistant de configuration web à la première visite. Le job d'initialisation admin-bootstrap affiche une URL de configuration à usage unique dans les journaux de son pod, que vous ouvrez dans un navigateur doté d'une extension compatible avec Passbolt — l'extension génère alors localement votre paire de clés GPG et votre mot de passe maître, et les enregistre auprès du serveur via cette URL.

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"

Vérifiez que le service est en bonne santé. Passbolt expose un point de terminaison d'état public et non authentifié :
```
curl -s "http://${EXTERNAL_IP}/healthcheck/status.json"
# expect: {"header":{"status":"success",...},"body":"OK"}
```
Récupérez l'URL de configuration à usage unique dans les journaux du pod du job admin-bootstrap. Le job l'a affichée sur stdout lorsqu'il a exécuté cake passbolt register_user (exécutée sans l'option -q/quiet précisément pour que cette URL soit visible) :
```
kubectl get jobs -n "$NS"
kubectl logs -n "$NS" job/<admin-bootstrap-job-name> | grep '/setup/start/'
```
Vous devriez voir une ligne contenant une URL de la forme :
```
https://<your-service-host>/setup/start/<user-id>/<token>
```
Si rien ne correspond, le job est peut-être encore en cours (kubectl get jobs -n "$NS" affiche l'état d'achèvement), ou le pod a peut-être déjà été supprimé par le ramasse-miettes — vérifiez kubectl get pods -n "$NS" -a | grep admin-bootstrap et, s'il a disparu, réexécutez le job (la tâche 5 couvre ce cas).
Installez l'extension de navigateur Passbolt (Chrome, Firefox ou Edge) depuis passbolt.com/download si ce n'est pas déjà fait.
Ouvrez l'URL de configuration obtenue à l'étape 3 dans le navigateur où l'extension est installée. L'extension vous guide pour :
- Générer localement une nouvelle paire de clés GPG (il s'agit de votre clé personnelle, distincte de la paire de clés GPG du serveur générée à la tâche 1).
- Choisir un mot de passe maître (il ne quitte jamais votre navigateur en clair).
- Enregistrer votre clé publique auprès du serveur Passbolt.
Une fois la configuration terminée, vous êtes connecté en tant qu'utilisateur administrateur configuré dans admin_email/admin_first_name/admin_last_name. Vérifiez que vous voyez la liste de mots de passe vide — il n'y a encore rien à voir, mais une session fonctionnelle confirme que toute la chaîne (clé GPG du serveur, clé JWT, schéma, compte administrateur, votre clé GPG personnelle) fonctionne.

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

Inspectez la charge de travail :

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

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 de la charge de travail ; la mise à l'échelle est donc un changement de configuration, et non un kubectl scale manuel (une modification manuelle serait annulée lors du prochain apply).
Mettez à jour la version de l'application en modifiant application_version dans la plateforme RAD et en l'appliquant via Update ; une nouvelle image est construite, une mise à jour progressive remplace le pod, et les jobs d'initialisation db-init/admin-bootstrap sont réexécutées (toutes deux sont idempotentes — un schéma existant et le compte administrateur restent intacts).

Inspectez les volumes des paires de clés GPG/JWT (ne les supprimez pas et ne les videz pas — voir la tâche 5 pour les conséquences) :

gsutil ls -p "$PROJECT" | grep passbolt
gsutil ls gs://<storage-bucket-name>/   # expect serverkey.asc, serverkey_private.asc
gsutil ls gs://<jwt-bucket-name>/       # expect jwt.key, jwt.pem (or similar)

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

Gérez les utilisateurs, les groupes et les dossiers — opérations du jour 2 propres à Passbolt, effectuées dans l'interface web (ou via son API REST/CLI une fois que vous disposez d'une session) plutôt que via Terraform ; il s'agit de données applicatives Passbolt, et non d'infrastructure. Invitez d'autres membres de l'équipe depuis l'interface d'administration — chaque nouvel utilisateur suit le même processus de configuration par extension de navigateur qu'à la tâche 2.

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

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>".
Surveillance — ouvrez les tableaux de bord GKE / Kubernetes et examinez l'utilisation du CPU et de la mémoire des pods ainsi que le nombre de redémarrages. Le module peut provisionner un test de disponibilité (uptime check) (lorsqu'il est activé) ; consultez Monitoring → Uptime checks.

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 Passbolt.

Pod non Ready / CrashLoopBackOff : examinez les événements et les journaux. La sonde de démarrage au niveau du conteneur cible GET /healthcheck/status.json avec un seuil d'échec généreux pour absorber la latence du premier démarrage.
```
kubectl describe pod -n "$NS" <pod>          # Events section shows scheduling/probe/mount errors
kubectl logs -n "$NS" <pod> --previous       # logs from the crashed container
```
Le job admin-bootstrap échoue avec une Internal Error / 500 sur register_user : c'est précisément le mode de défaillance que le job est conçu pour éviter en reproduisant d'abord la séquence de génération des clés GPG et d'installation du schéma propre à l'éditeur — si elle échoue malgré tout, consultez les journaux de son pod pour identifier l'étape en échec :
```
kubectl get jobs -n "$NS"
kubectl logs -n "$NS" job/<admin-bootstrap-job-name>
```
Vérifiez d'abord que db-init s'est terminée avec succès (admin-bootstrap en dépend via depends_on_jobs) et que les volumes GCS Fuse storage/jwt sont réellement montés avec les options uid=33/gid=33 — une erreur EACCES dans les journaux pendant la génération des clés GPG désigne directement une option de montage manquante ou incorrecte.
L'URL de configuration n'apparaît jamais dans les journaux : vérifiez que admin-bootstrap s'est réellement terminé (et pas seulement qu'il a démarré). Si le pod du job a été supprimé par le ramasse-miettes ou si le job a échoué en cours de route, ses étapes GPG/JWT/schéma idempotentes peuvent être réexécutées sans risque — supprimez l'objet Job terminé ou en échec et laissez le prochain apply le recréer, ou déclenchez-le manuellement selon la sémantique des Jobs de votre cluster.
Erreurs de connexion à la base de données : vérifiez que l'instance Cloud SQL est RUNNABLE et que le sidecar cloud-sql-proxy est en bonne santé. Sur GKE, le pod se connecte en TCP sur la boucle locale (127.0.0.1), et non via un socket Unix — vérifiez la valeur DATASOURCES_DEFAULT_HOST injectée dans le pod si les connexions échouent.
Perte des volumes des paires de clés GPG/JWT : si le bucket GCS storage ou jwt est supprimé ou vidé, chaque identifiant que Passbolt a chiffré côté serveur et chaque session JWT émise deviennent irrécupérables — le serveur génère une toute nouvelle paire de clés au démarrage suivant, incapable de déchiffrer les données chiffrées avec l'ancienne. Il n'existe aucune récupération côté Terraform ; la gravité est la même que la perte de la clé maîtresse d'un gestionnaire de mots de passe. Traitez ces buckets avec au moins autant de soin que l'instance Cloud SQL.
Erreurs de récupération d'image : vérifiez que l'image existe dans Artifact Registry (ou qu'elle est accessible depuis Docker Hub, si la mise en miroir est désactivée) et que le compte de service des nœuds peut la récupérer.
Pod en attente / 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 dispose d'une IP attribuée.

Consultez la section Configuration Pitfalls du Guide de configuration pour les pièges propres à chaque paramètre, notamment les options de montage GCS Fuse uid=33/gid=33, indispensables à la génération des clés GPG sur GKE.

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). Delete supprime tout ce que le module a créé — la charge de travail Kubernetes et son espace de noms, la base de données Cloud SQL, les buckets GCS storage/jwt (et les paires de clés GPG/JWT qu'ils contiennent) 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 (MySQL 8.0), les buckets GCS GPG/JWT, et exécute la chaîne `db-init` → `admin-bootstrap`
2 — Accéder et vérifier	Manuel	Se connecter au cluster ; la vérification d'état réussit sur `/healthcheck/status.json` ; récupérer l'URL de configuration à usage unique dans les journaux du pod et terminer l'enregistrement via une extension de navigateur
3 — Exploiter	Manuel	Inspecter la charge de travail, mettre à l'échelle, mettre à jour la version, inspecter les volumes des paires de clés, accéder à la base, gérer les utilisateurs/groupes
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 pod, d'admin-bootstrap, de base de données, d'autorisations GCS Fuse et de perte des paires de clés
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​