RAGFlow sur GKE Autopilot — Guide de lab

📖 Guide de configuration

Vue d'ensemble

Durée estimée : 45–90 minutes

RAGFlow est une plateforme open source d'intelligence documentaire et de génération augmentée par récupération (RAG, Retrieval-Augmented Generation). Elle ingère des PDF, des documents Word, des pages HTML et d'autres formats, les découpe en fragments et en calcule les embeddings, stocke les vecteurs dans Elasticsearch, et expose une API REST et une interface web pour la gestion des bases de connaissances et la recherche d'entreprise. Ce lab vous fait parcourir tout le cycle de vie opérationnel du module RAGFlow 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 supprimer.

Le lab porte sur l'exploitation du module GKE et de la plateforme Google Cloud, et non sur les fonctionnalités de RAGFlow. 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).
• Elasticsearch_GKE déployé et sa sortie elasticsearch_endpoint disponible — il s'agit d'un prérequis de déploiement strict ; le plan est rejeté si elasticsearch_hosts est vide lorsque deploy_application = true.
• 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 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 requiert 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). 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é]

1. Dans la plateforme RAD, ouvrez Solutions → Solution Catalog → RAD modules, puis ouvrez RAGFlow (GKE) 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 êtes partenaire ou administrateur), définissez project_id et elasticsearch_hosts (la sortie elasticsearch_endpoint de votre déploiement Elasticsearch_GKE), puis passez en revue les autres 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, un partage Filestore (NFS) pour le stockage partagé des documents, un bucket Cloud Storage pour les artefacts documentaires, construit l'image de conteneur et exécute un job ponctuel d'initialisation de la base de données. Un premier déploiement prend environ 20 à 35 minutes (la création de Cloud SQL domine).

3. Connectez-vous au cluster et identifiez 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 ragflow | 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 repérez 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"
   curl -s "http://${EXTERNAL_IP}/v1/health"   # expect HTTP 200 with {"code":0}

   RAGFlow charge les modèles d'embedding au premier démarrage ; si le contrôle de santé ne répond pas immédiatement, patientez quelques minutes que le démarrage se termine.

2. Ouvrez http://${EXTERNAL_IP} dans un navigateur. Lors de la première visite, RAGFlow présente une page d'inscription — créez un compte administrateur avec l'adresse e-mail et le mot de passe de votre choix, puis connectez-vous. Aucun identifiant administrateur pré-provisionné n'existe dans Secret Manager ; le secret du mot de passe de la base de données sert uniquement au backend MySQL.

---

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

1. Inspectez la charge de travail — déploiement, pods et (s'ils sont activés) l'autoscaler horizontal et les volumes persistants :

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

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 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). Notez que min_instance_count est plafonné à 1 ; la mise à l'échelle jusqu'à zéro n'est pas prise en charge car RAGFlow charge les modèles d'embedding au démarrage.

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 mise à jour progressive remplace les pods.

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

   kubectl get secrets -n "$NS"
   gcloud secrets list --project="$PROJECT" --filter="name~ragflow"
   gcloud storage buckets list --project="$PROJECT"
   kubectl get jobs -n "$NS"          # 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. ragflowdemo426161cf) — not the bare app name.
   DB_USER=$(gcloud sql users list --instance="$INSTANCE" --project="$PROJECT" \
     --format="value(name)" --filter="name~^ragflow" --limit=1)
   gcloud sql connect "$INSTANCE" --user="$DB_USER" --project="$PROJECT"

---

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 CPU et mémoire des pods, le nombre de redémarrages et les métriques de requêtes. Le module provisionne également 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. Ce sont des diagnostics au niveau de la plateforme, qui ne changent pas avec les versions de RAGFlow.

• Pod non prêt / CrashLoopBackOff : inspectez les événements et les journaux :

  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, que le secret du mot de passe de la base de données a été matérialisé dans l'espace de noms et que le job d'initialisation s'est terminé. RAGFlow requiert MySQL 8.0 — vérifiez database_type = MYSQL_8_0.
• É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>

• Documents non traités (bloqués dans la file d'attente) : vérifiez que Redis est joignable — sans Redis, les workers documentaires de RAGFlow ne démarrent jamais. Sur GKE, un redis_host vide se rabat sur l'IP du serveur NFS ; vérifiez que l'instance NFS est saine.
• Erreurs Elasticsearch / échec de l'indexation : vérifiez que elasticsearch_hosts pointe vers le bon point de terminaison Elasticsearch et que l'état de santé du cluster est au vert.
• Pod en attente / aucune IP externe : consultez les événements de kubectl describe pod à la recherche de problèmes de ressources ou de quota, et vérifiez que le Service LoadBalancer a reçu une IP.
• Erreurs de récupération d'image : vérifiez que l'image existe dans Artifact Registry et que le compte de service des nœuds peut la récupérer.

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éé — la charge de travail Kubernetes et son espace de noms, la base de données Cloud SQL (MySQL), les secrets Secret Manager, le bucket Cloud Storage, l'instance Filestore (NFS), l'IP statique 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. Le déploiement Elasticsearch_GKE doit également être supprimé séparément.

---

Récapitulatif

Tâche	Type	Résultat
1 — Déployer	Automatisé	Le module déploie la charge de travail GKE, Cloud SQL (MySQL), NFS, le stockage, les secrets, et exécute l'initialisation de la base de données
2 — Accéder et vérifier	Manuel	Se connecter au cluster ; le contrôle de santé réussit ; créer le compte administrateur et se connecter
3 — Exploiter	Manuel	Inspecter la charge de travail, mettre à l'échelle, mettre à jour la version, gérer les secrets, le stockage et les jobs, 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 pod, de base de données, de job d'initialisation, de Redis/Elasticsearch, de planification et de récupération d'image
6 — Démanteler	Automatisé	Delete (Trash) supprime toutes les ressources du module