Aller au contenu principal

AnythingLLM sur GKE Autopilot — Guide de lab

📖 Guide de configuration

Vue d'ensemble​

Durée estimée : 45–90 minutes

AnythingLLM est un espace de travail d'IA privé et une plateforme de génération augmentée par récupération (RAG) qui permet aux équipes de dialoguer avec leurs documents, de se connecter à n'importe quel fournisseur de LLM (OpenAI, Anthropic, Ollama et d'autres) et de créer des assistants de connaissances fondés sur l'IA — sans envoyer de données à des services tiers. Ce lab vous accompagne tout au long du cycle de vie opérationnel du module AnythingLLM sur 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 AnythingLLM. Pour la liste complète des services provisionnés et de chaque paramètre de configuration (organisé 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.
  • 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 effectués.
  • 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 qu'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 ne comportent 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. Ouvrez Solutions → Solution Catalog → RAD modules dans la navigation supérieure de la plateforme RAD, ouvrez AnythingLLM (GKE) dans 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), 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 déploie la charge de travail dans le cluster GKE Autopilot, provisionne une base de données Cloud SQL (PostgreSQL 15) avec ses secrets Secret Manager, un bucket GCS dédié aux documents, construit l'image du conteneur et exécute un job ponctuel d'initialisation de la base de données. Les premiers déploiements prennent environ 20–35 minutes (la création de Cloud SQL représente l'essentiel de la durée).

  3. Connectez-vous au cluster et repérez l'espace de noms à l'aide de 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 anythingllm | 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 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"
    curl -s "http://${EXTERNAL_IP}/api/ping" # expect {"online":true}

    Le Service Kubernetes écoute sur service_port (80 par défaut, et non le port natif 3001 du conteneur) — AnythingLLM_GKE ne remplace pas cette valeur par défaut, de sorte que le LoadBalancer est joignable à l'adresse simple, sans suffixe de port.

  2. Ouvrez http://${EXTERNAL_IP} dans un navigateur. Lors du premier accès, AnythingLLM présente un assistant de configuration dans lequel vous créez le compte administrateur (nom d'utilisateur et mot de passe). La documentation d'AnythingLLM couvre la configuration des espaces de travail et des fournisseurs de LLM.


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

  1. Inspectez la charge de travail — pods, HPA et (si activés) volumes persistants :

    kubectl get deploy,statefulset,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 gère 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 du prochain apply).

  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~anythingllm"
    gcloud storage buckets list --project="$PROJECT" --filter="name~anythingllm-docs"
    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. anythingllmdemo426161cf) — not the bare app name.
    DB_USER=$(gcloud sql users list --instance="$INSTANCE" --project="$PROJECT" \
    --format="value(name)" --filter="name~^anythingllm" --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 du CPU et de la 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) ciblant /api/ping (lorsqu'il est activé) ; examinez 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 êtes le plus susceptible de rencontrer. Il s'agit de diagnostics au niveau de la plateforme, qui ne changent pas d'une version d'AnythingLLM à l'autre.

  • Pod non Ready / CrashLoopBackOff : inspectez les événements et les journaux. AnythingLLM charge les modèles d'embedding au premier démarrage — la sonde de démarrage accorde jusqu'à 5 minutes ; laissez passer ce délai avant de poser un diagnostic.
    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 a bien été matérialisé dans l'espace de noms, que enable_cloudsql_volume vaut true et que le job d'initialisation s'est terminé.
  • É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>
  • OOM / pod évincé : le pipeline d'embedding d'AnythingLLM nécessite au moins 4 GiB de RAM ; vérifiez que container_resources.memory_limit n'est pas inférieur à ce seuil.
  • Pod en attente (Pending) / pas d'IP externe : consultez les événements de kubectl describe pod à la recherche de 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 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) — cette action retire le déploiement des enregistrements de RAD sans détruire les ressources cloud (elle fait oublier le déploiement à RAD). La suppression retire tout ce que le module a créé — la charge de travail Kubernetes et l'espace de noms, la base de données Cloud SQL, les secrets Secret Manager, le bucket GCS de documents, les PVC 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âcheTypeRésultat
1 — DéployerAutomatiséLe module déploie la charge de travail GKE, Cloud SQL (PostgreSQL 15), un bucket GCS, des secrets, et exécute l'initialisation de la base
2 — Accéder et vérifierManuelConnexion au cluster ; le contrôle de santé réussit sur /api/ping ; compte administrateur créé via l'assistant de configuration
3 — ExploiterManuelInspecter la charge de travail, mettre à l'échelle, mettre à jour la version, gérer secrets/stockage/jobs, accès à la base
4 — ObserverManuelInterroger Cloud Logging ; examiner les métriques Cloud Monitoring et le test de disponibilité
5 — DépannerManuelDiagnostiquer les problèmes de pod, de base de données, de job d'initialisation, d'OOM, de planification et de récupération d'image
6 — DémantelerAutomatisé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.