Chroma sur Cloud Run — Guide de lab

📖 Guide de configuration

Vue d'ensemble

Durée estimée : 45–90 minutes

Chroma est une base de données vectorielle open source conçue pour l'IA, dédiée aux embeddings et à la recherche par similarité. Elle alimente les pipelines RAG, la recherche sémantique et les workflows LangChain/LlamaIndex. Ce lab vous fait parcourir tout le cycle de vie opérationnel du module Chroma 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 de Chroma. 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.
• 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 le stockage.
• 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, 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 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. Ouvrez Solutions → Solution Catalog → RAD modules dans la navigation supérieure de la plateforme RAD, ouvrez Chroma (Cloud Run) 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 ê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 provisionne le service Cloud Run et un bucket Cloud Storage (monté via GCS FUSE sur /data comme backend de persistance de Chroma), construit l'image de conteneur et crée éventuellement un jeton d'authentification dans Secret Manager. Chroma ne requiert ni base de données ni job d'initialisation. Un premier déploiement prend environ 10 à 15 minutes (le build de l'image domine).

3. Une fois terminé, identifiez les ressources avec des filtres indépendants des noms :

   SERVICE=$(gcloud run services list --project="$PROJECT" --region="$REGION" \
     --filter="metadata.name~chroma" --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]

1. Vérifiez que le service est en bonne santé. Chroma expose un unique point de terminaison de santé :

   curl -s "$SERVICE_URL/api/v2/heartbeat"   # expect {"nanosecond heartbeat": <timestamp>}

   Remarque : l'URL du service est interne par défaut (ingress_settings = "internal"). Exécutez cette commande depuis une machine située dans le VPC, ou passez à ingress_settings = "all" avec enable_auth_token = true avant le déploiement.

2. Si enable_auth_token = true a été défini au moment du déploiement, récupérez le jeton d'authentification dans Secret Manager avant tout autre appel d'API :

   AUTH_SECRET=$(gcloud secrets list --project="$PROJECT" \
     --filter="name~chroma AND name~auth-token" --format="value(name)" --limit=1)
   gcloud secrets versions access latest --secret="$AUTH_SECRET" --project="$PROJECT"

   Transmettez le jeton sous la forme Authorization: Bearer <token> dans chaque requête d'API.

---

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

1. Inspectez le service et ses révisions (chaque déploiement crée une révision immuable ; le trafic bascule vers la plus récente en bonne santé) :

   gcloud run services describe "$SERVICE" --project="$PROJECT" --region="$REGION"
   gcloud run revisions list --service="$SERVICE" --project="$PROJECT" --region="$REGION"

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 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 de la prochaine application). Conservez max_instance_count = 1 : plusieurs instances partageant le même chemin GCS FUSE n'ont aucun verrou d'écriture distribué et corrompraient les collections.

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 nouvelle révision est déployée.

4. Gérez les secrets et le stockage :

   gcloud secrets list --project="$PROJECT" --filter="name~chroma"
   DATA_BUCKET=$(gcloud storage buckets list --project="$PROJECT" \
     --filter="name~chroma" --format="value(name)" --limit=1)
   gcloud storage ls "gs://${DATA_BUCKET}/"   # inspect Chroma's on-disk layout

5. Listez les éventuels jobs de sauvegarde planifiés :

   gcloud run jobs list --project="$PROJECT" --region="$REGION"

---

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

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

2. 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 CPU / mémoire. Le module provisionne également un test de disponibilité (uptime check) ciblant /api/v2/heartbeat ; vérifiez qu'il est au vert sous Monitoring → Uptime checks, et consultez 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 Chroma.

• Révision en mauvaise santé / le service ne répond pas : inspectez la dernière révision et ses journaux à la recherche d'erreurs de démarrage. Chroma charge les index HNSW depuis le bucket GCS au démarrage — laissez à la sonde /api/v2/heartbeat le temps de réussir.

  gcloud run revisions list --service="$SERVICE" --project="$PROJECT" --region="$REGION"
  gcloud run services logs read "$SERVICE" --project="$PROJECT" --region="$REGION" --limit=100

• Erreurs de montage GCS FUSE : vérifiez que le bucket GCS existe, que le compte de service dispose de storage.objectAdmin sur le bucket et que execution_environment = "gen2" est défini (GCS FUSE requiert Gen2).
• Erreurs de jeton d'authentification (401) : vérifiez que enable_auth_token = true a été défini, que le secret existe et que l'en-tête Authorization: Bearer <token> figure dans chaque requête.
• Échec du build de l'image : consultez l'historique de Cloud Build pour le journal du build en échec.
• 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.

---

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éé — le service Cloud Run, le bucket de données GCS et toutes les collections stockées, les secrets Secret Manager et les images Artifact Registry. Les ressources appartenant à Services_GCP (le VPC, le registre partagé) 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, le bucket de données GCS et un jeton d'authentification facultatif
2 — Accéder et vérifier	Manuel	Le contrôle heartbeat réussit ; jeton d'authentification récupéré s'il est activé
3 — Exploiter	Manuel	Inspecter les révisions, mettre à l'échelle, mettre à jour la version, gérer les secrets et le stockage
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 montage GCS FUSE, de jeton d'authentification, de build et d'IAM
6 — Démanteler	Automatisé	Delete (Trash) supprime toutes les ressources du module