Monica sur GKE Autopilot — Guide de lab

📖 Guide de configuration

Vue d'ensemble

Durée estimée : 45–90 minutes

Monica est une application open source de gestion des relations personnelles (PRM) — un « CRM personnel » pour organiser la façon dont vous restez en contact avec vos amis, votre famille et vos contacts. Ce lab vous fait parcourir l'intégralité du cycle de vie opérationnel du module Monica on GKE Autopilot 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 GKE et de la plateforme Google Cloud, et non sur les fonctionnalités du produit Monica. 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 et accéder à la charge de travail en cours d'exécution.
• Effectuer les opérations du jour 2 — inspecter, mettre à l'échelle, mettre à jour, et gérer les secrets et le stockage.
• 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.

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 Monica (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. 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 déploie la charge de travail dans le cluster GKE Autopilot, provisionne 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 monica-uploads ainsi qu'un bucket data par défaut, et un volume NFS partagé entre les pods pour le répertoire storage/ de Laravel. Aucune image n'est construite — la charge de travail récupère l'image officielle préconstruite monica:<version> — et un job ponctuel d'initialisation de la base de données s'exécute. Les premiers déploiements prennent environ 15–25 minutes (la création de Cloud SQL en représente l'essentiel).

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

---

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

1. Vérifiez que la charge de travail s'exécute 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"

2. Vérifiez que le service est en bonne santé. La sonde de démarrage est une sonde TCP sur / (elle réussit dès qu'Apache se lie au port) ; la sonde de vivacité est une requête HTTP GET / :

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

   Prévoyez un délai généreux pour la première requête après la création du pod — le démarrage d'Apache ainsi que le php artisan migrate --force du point d'entrée s'exécutent tous deux avant que la page ne soit servie.

3. Ouvrez http://${EXTERNAL_IP} dans un navigateur. Monica n'a aucun identifiant par défaut — un visiteur non authentifié est redirigé vers la page d'inscription/de configuration. Inscrivez le premier compte (utilisez admin@techequity.cloud pour les déploiements RAD) ; il devient l'administrateur. Une fois l'IP externe ou un domaine personnalisé fixé, définissez APP_URL sur cette adresse via environment_variables et appliquez-le via Update afin que les liens absolus et les redirections soient correctement résolus.

---

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

1. Inspectez la charge de travail — le déploiement Kubernetes, les pods et les volumes persistants :

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

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 de la charge de travail, la mise à l'échelle est donc une modification de configuration, et non un kubectl scale manuel (une modification manuelle serait annulée lors de la prochaine application). GKE ne permet pas la mise à l'échelle à zéro ; min_instance_count vaut donc 1 par défaut ; un seul réplica convient à un CRM personnel.

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 ; un nouveau modèle de pod récupère le nouveau tag monica:<version>. Comme l'application s'appuie sur NFS, le déploiement progressif utilise la stratégie Recreate (l'ancien pod s'arrête avant que le nouveau ne démarre) afin d'éviter que deux pods se disputent le même volume/la même base de données pendant la bascule.

4. Gérez les secrets, le stockage et les jobs :

   kubectl get secrets -n "$NS"
   gcloud secrets list --project="$PROJECT" --filter="name~monica"
   kubectl get jobs -n "$NS"          # db-init job

   Ne renouvelez jamais le secret APP_KEY après le premier démarrage — il s'agit d'une clé de chiffrement Laravel, et la renouveler corrompt définitivement chaque champ chiffré de la base de données et invalide toutes les sessions.

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

6. Inspectez les fichiers téléversés (les photos/documents des contacts se trouvent sous le répertoire storage/ de Laravel, partagé entre les pods via NFS par défaut et répliqué dans le bucket monica-uploads) :

   gcloud storage ls gs://<uploads-bucket>/

---

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

1. 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>".

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

• Pod non Ready / CrashLoopBackOff : inspectez les événements et les journaux. La sonde de démarrage est une sonde TCP sur / (elle réussit dès qu'Apache se lie au port) ; la sonde de vivacité est une requête HTTP GET / avec un délai généreux pour la migration 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

• Erreurs de connexion à la base de données : vérifiez que l'instance Cloud SQL est RUNNABLE et que le job db-init s'est terminé. Monica atteint MySQL via le sidecar Cloud SQL Auth Proxy sur 127.0.0.1:3306 (enable_cloudsql_volume = true) ; un autre DB_HOST ne peut pas atteindre la base de données sur GKE.
• Échec du job d'initialisation : inspectez le job et les journaux de son pod :

  kubectl get jobs -n "$NS"
  kubectl logs -n "$NS" job/<job-name>

• Déploiement progressif bloqué lors d'une mise à jour : comme l'application s'appuie sur NFS, les mises à jour utilisent la stratégie Recreate — un déploiement progressif qui reste bloqué relève plus probablement d'un échec de sonde ou de migration sur le nouveau pod que d'un conflit d'accès au volume ; consultez kubectl describe deploy et les journaux du nouveau pod.
• 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 quotas, et vérifiez que le Service LoadBalancer dispose d'une IP attribuée.
• Erreurs de récupération d'image : vérifiez que le tag monica:<version> existe en amont et que le compte de service des nœuds peut le récupérer (ce module utilise l'image officielle préconstruite, et non un build personnalisé).

Consultez la section Configuration Pitfalls du Guide de configuration pour les pièges propres à chaque paramètre (notamment la règle essentielle de ne jamais renouveler APP_KEY après le premier démarrage, et l'immuabilité de application_database_name/application_database_user une fois définis).

---

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 secrets Secret Manager, les buckets GCS 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 secrets, les buckets de stockage, NFS, et exécute l'initialisation de la base
2 — Accéder et vérifier	Manuel	Se connecter au cluster ; la vérification d'état réussit ; créer le compte administrateur initial dans l'interface
3 — Exploiter	Manuel	Inspecter la charge de travail, mettre à l'échelle, mettre à jour la version (déploiement Recreate), gérer les secrets/le stockage, accéder à la base, inspecter les fichiers téléversés
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, de base de données, de job d'initialisation, de déploiement progressif et de récupération d'image
6 — Démanteler	Automatisé	Delete (Trash) supprime toutes les ressources du module