- Un compte sur DockerHub
- Cluster Kubernetes en version 1.21+, et 1.34+ pour les ressources au niveau pod (activées par défaut, voir Ressources au niveau pod) — sinon
podLevelResources: false - Installer helm 3.10+
- Installer Nginx Ingress Controller
- Configurer des volumes persistants pour la persistence des données - Indispensable en production
PostgreSQL est installé par defaut pour cette partie
| Composants | Coog | Celery | Cron | Libroconv |
|---|---|---|---|---|
| Coog | ✔️ | ✔️ | ||
| Celery | ✔️ | ✔️ | ||
| Cron | ✔️ | ✔️ | ||
| Libroconv | ✔️ | ✔️ | ✔️ |
La valeur mongodb.isManaged doit être à true pour installer MongoDB par le chart, laisser à false si vous avez un serveur MongoDB externe.
| Composants | API | API-identity-manager | Gateway | API-referential | B2B | Web |
|---|---|---|---|---|---|---|
| API | ✔️ | ✔️ | ||||
| API-identity-manager | ✔️ | ✔️ | ||||
| Gateway | ✔️ | ✔️ | ||||
| API-referential | ✔️ | ✔️ | ✔️ | |||
| B2B | ✔️ | ✔️ | ✔️ | |||
| Web | ✔️ | ✔️ | ✔️ | ✔️ |
La valeur mongodb.isManaged doit être à true pour installer MongoDB par le chart, laisser à false si vous avez un serveur MongoDB externe.
| Composants | API | API-identity-manager | Gateway | API-B2C | Customer-backend | Customer-frontend | B2C |
|---|---|---|---|---|---|---|---|
| API | ✔️ | ✔️ | |||||
| API-identity-manager | ✔️ | ✔️ | |||||
| Gateway | ✔️ | ✔️ | |||||
| API-B2C | ✔️ | ✔️ | ✔️ | ✔️ | ✔️ | ||
| Customer-backend | ✔️ | ✔️ | ✔️ | ✔️ | |||
| Customer-frontend | ✔️ | ✔️ | ✔️ | ||||
| B2C | ✔️ | ✔️ | ✔️ |
Dans votre fichier de configuration des valeurs (exemple : client_values.yml) :
imageCredentials:
registry: docker.io
username: user-1234
password: password-1234
email: my-email@my-company.comhelm repo add coopengo https://gitlab.com/api/v4/projects/35933718/packages/helm/stable
helm upgrade -i coog coopengo/coog --namespace=coog-client -f client_values.ymlDans votre fichier de configuration des valeurs (exemple : client_values.yml) :
Les EFS doivent être crée manuellement à l'avance.
Volume principal pour coog:
backCore:
persistentVolume:
enabled: true
storageClass: "efs-sc"
size: 10Gi
customPersistentVolume:
mountOptions:
- "tls"
persistentVolumeReclaimPolicy: "Retain"
csi:
driver: "efs.csi.aws.com"
volumeHandle: "fs-123456789"Si composants Front activés :
mongodb:
persistence:
storageClass: "efs-sc"
size: 10Gi
customPersistentVolume:
mountOptions:
- "tls"
persistentVolumeReclaimPolicy: "Retain"
csi:
driver: "efs.csi.aws.com"
volumeHandle: "fs-987654321"Option opt-out : activée par défaut. Les resources de chaque composant sont posées sur le pod (spec.template.spec.resources du Deployment / DaemonSet), plus aucune sur ses conteneurs. Les conteneurs du pod partagent cette enveloppe.
Valeur du pod, pour chaque ressource (cpu, mémoire, requests et limits séparément) : le max des valeurs des conteneurs du pod.
| Composant | Valeurs prises en compte |
|---|---|
| coog | backCore.coog.resources, backCore.coog.initContainers.resources |
| celery | backCore.celery.worker.resources, backCore.celery.databaseMaintenance.resources |
| customerBackend, customerFrontend | resources, initContainers.resources |
| autres composants | resources |
tous, si istio.enabled |
istio.proxy.resources (sidecar istio-proxy) |
- Prérequis : Kubernetes 1.34+ (feature gate
PodLevelResources, beta et activée par défaut, encore beta en 1.36), nœuds en cgroup v2. - Istio : istiod injecte
istio-proxyavec ses propres ressources (global.proxy.resourcesdes values istiod), et l'API refuse un pod dont les requests sont inférieures à celles du sidecar.istio.proxy.resourcesdoit donc reprendre les values istiod de la plateforme (défaut : 50m/128Mi en requests, 100m/256Mi en limits). - Seules
cpuetmemorysont acceptées : toute autre ressource fait échouer le rendu. - Une requête absente prend la valeur de la limite. Si un conteneur n'a pas de limite pour une ressource, le pod n'en a pas non plus.
- Les sous-charts Bitnami (postgresql, rabbitmq, mongodb) ne changent pas : ressources au niveau conteneur.
Les pods sont recréés. Un pod à plusieurs conteneurs reçoit le max de leurs valeurs, partagé par tous : pour celery, max(worker, maintenance, sidecar) pour les trois conteneurs. Vérifier que les valeurs celery des tenants couvrent ce partage avant le passage.
podLevelResources: falseLe rendu est alors identique à celui des versions précédentes du chart.
Le chart supporte deux modes de déploiement RabbitMQ via le toggle rabbitmq.mode :
| Mode | Déploiement | Sources des resources RabbitMQ (vhost/user/permissions) |
|---|---|---|
legacy (défaut) |
Subchart Bitnami rabbitmq v12.4.2 déployé dans le namespace tenant |
Externes (Terraform cyrilgdn/rabbitmq ou autre outillage) |
operator |
Aucun broker déployé par le chart — connexion à un RabbitmqCluster externe géré par le RabbitMQ Cluster Operator |
CRDs Vhost, User, Permission posées par le chart, réconciliées par le Messaging Topology Operator |
Le mode operator cible un RabbitmqCluster déployé hors-bande et accessible via DNS interne <cluster>.<namespace>.svc.cluster.local.
- Un
RabbitmqClusteropérationnel sur le cluster (Cluster Operator + Topology Operator + CRDsrabbitmq.cominstallés). - L'annotation
rabbitmq.com/topology-allowed-namespacesposée sur leRabbitmqClusterCR (pas sur le namespace) avec une valeur incluant le namespace tenant ou*. Le Topology Operator ne lit cette annotation que sur le CR. - Le namespace tenant a Istio activé en mode compatible (
STRICTouPERMISSIVE) si le namespace du cluster RabbitMQ enforce mTLS — sinon l'auth AMQP côté broker rejette les pods tenant.
rabbitmq:
mode: operator
isManaged: false # OBLIGATOIRE en mode operator (désactive le subchart Bitnami)
operator:
cluster:
name: rabbitmq-production # défaut
namespace: rabbitmq-system # défaut
vhost: "<nom-du-vhost>" # nom du vhost à créer sur le cluster
user:
tags:
- management
permissions:
configure: ".*"
write: ".*"
read: ".*"
queueLimit: # défaut : actif, 100 000 messages par file
enabled: true
maxLength: 100000
auth:
username: "<user-tenant>"
password: "<password-random>"Le chart pose une Policy queue-limit sur le vhost du tenant : chaque file garde au plus maxLength messages prêts (max-length), et au-delà le broker refuse les nouveaux messages de ce vhost seulement (overflow: reject-publish). Coog passe alors les publications refusées en enqueue_failed et les republie plus tard (cron resend_failed_tasks_to_enqueue), au lieu qu'une file qui s'emballe remplisse la mémoire du broker partagé jusqu'à son alarme, qui bloque les publications de tous les tenants (PINTE-30188).
- Choisir
maxLengthau-dessus du plus gros run légitime du tenant : un run publie un message par job, dans la file de son batch. - Une seule
Policys'applique à une file (la plus prioritaire) : une autrePolicyposée sur le vhost avec une priorité supérieure à 0 remplacerait ce plafond. - Mise en service : actif par défaut en mode operator : à la mise à jour du chart, chaque tenant reçoit la
Policy. Avant, vérifier qu'aucune file légitime n'approchemaxLength(pic des 30 derniers jours par file :max_over_time(max by (vhost, queue) (rabbitmq_detailed_queue_messages_ready{...})[30d:5m])), et ajustermaxLengthdans les values d'un tenant dont un run légitime dépasse le plafond. Vérifier ensuite que laPolicyestReady(kubectl -n <tenant> get policies.rabbitmq.com) et posée sur le broker (rabbitmqctl list_policies -p <vhost>). - Retour arrière :
enabled: falsepuishelm upgrade: laPolicyest supprimée et le Topology Operator retire la policy du broker. Les messages déjà en file ne sont pas touchés.
Le password est posé dans un Secret K8s <release>-rabbitmq-credentials du namespace tenant et importé par le User CRD via importCredentialsSecret — le Topology Operator l'applique au user créé sur rabbitmq-production.
- Côté values : ajouter
mode: operator,isManaged: false, etoperator.vhost: "<même-valeur-que-rabbitmq.vhost>".
Pendant ~10-30s entre la création des CRDs et leur réconciliation par le Topology Operator, les pods qui rolling-restart peuvent voir des ACCESS_REFUSED transitoires. Les clients AMQP retentent automatiquement.
rabbitmq.vhostlegacy ignoré en mode operator : le helpercoog.rabbitmq.vhostn'utilise querabbitmq.operator.vhosten mode operator. Si tu metsrabbitmq.vhost: "foo"mais oubliesrabbitmq.operator.vhost, le chart utilise le défaut/<release-name>au lieu defoo— vhost créé sous un nom inattendu, queues à recréer côté apps.isManaged: true+mode: operator: combinaison invalide. Un guard fail-fast dans_helpers.tplrejette le rendu — corriger en passantisManaged: false.- Annotation
topology-allowed-namespacesmal posée : si elle est uniquement sur le namespacerabbitmq-system(ancien comportement) au lieu duRabbitmqClusterCR, les CRDs Topology restent enReady: Falseavecresource is not allowed to reference defined cluster reference. rabbitmq.auth.passwordest bootstrap-only avec un Topology Operator < 1.20 —helm upgradene rotate PAS le password : voir la section ci-dessous (à partir de 1.20,helm upgradesuffit).
Le Secret d'entrée <release>-rabbitmq-credentials porte le label rabbitmq.com/topology-operator: "true", que l'opérateur ≥ 1.20 exige sur tout Secret référencé (sans lui, le webhook refuse le User). L'opérateur surveille ces Secrets et applique lui-même un changement de password côté broker, sans annotation ni script :
helm upgrade <release> coopengo/coog \
--namespace <ns> --reuse-values \
--set rabbitmq.auth.password='<nouveau-password>'Les Deployments coog, celery et cron redémarrent d'eux-mêmes (annotation checksum/secret-backcore) avec la nouvelle URL AMQP. Pendant les quelques secondes où l'opérateur applique le password, une connexion peut être refusée : les clients Celery retentent.
Prérequis : le label doit être posé (cette version du chart redéployée) avant que le chart saas n'installe le Topology Operator 1.20 sur l'env (voir le README de saas-plateform).
Le Topology Operator lit spec.importCredentialsSecret du User CRD uniquement à la création initiale, c'est-à-dire tant que status.credentials.name est vide. Une fois ce statut renseigné (premier reconcile), le Secret auto-généré <user-cr>-user-credentials devient la source de vérité et le Secret d'entrée que rend le chart (<release>-rabbitmq-credentials) n'est plus jamais relu.
Conséquence : modifier rabbitmq.auth.password dans les values puis helm upgrade met bien à jour le Secret d'entrée côté Kubernetes, mais n'a aucun effet côté broker ni sur le Secret de sortie consommé par les apps. Le broker continue d'accepter l'ancien password.
C'est documenté upstream et assumé par les mainteneurs :
« The Operator does not monitor either the provided secret object or the generated secret object, and updating either secret object won't update the credentials. As a workaround, add a label or annotation to
users.rabbitmq.comobject to trigger the Operator to reconcile. » — doc officielle « Using the Topology Operator »
Voir aussi l'issue #571 (fermée par une simple MAJ de doc, pas de fix code).
-
Mettre à jour le password côté values +
helm upgrade:helm upgrade <release> coopengo/coog \ --namespace <ns> --reuse-values \ --set rabbitmq.auth.password='<nouveau-password>'
Cela met à jour le Secret d'entrée
<release>-rabbitmq-credentials(étape nécessaire mais insuffisante seule). -
Lancer le helper fourni par le chart :
./coog/scripts/rotate-rabbitmq-user.sh \ --release <release> --namespace <ns>
Le script :
- lit le nouveau password depuis le Secret d'entrée (pas d'argument shell, pas de leak via
ps), - patch le Secret de sortie
<release>-coog-rabbitmq-user-user-credentials, - annote le
UserCR avec un timestamp pour déclencher un reconcile, - valide via
rabbitmqctl authenticate_usercôté broker, - liste les
Deployments qui consomment le Secret de sortie et qui sont àkubectl rollout restartmanuellement.
- lit le nouveau password depuis le Secret d'entrée (pas d'argument shell, pas de leak via
-
Rollout des consommateurs identifiés :
kubectl -n <ns> rollout restart deploy/<name>
rabbitmq:
mode: legacy
isManaged: true
# retirer le bloc rabbitmq.operator