Aller au contenu

Configurer un reverse proxy

Un reverse proxy présente SmartAGT sous un nom public, par exemple https://smartagt.example.org, et relaie les requêtes vers le Frontend. Cette page décrit ce que SmartAGT attend du proxy ; sa mise en place relève de la documentation de votre proxy.

En cluster, le reverse proxy présente SmartAGT sous un nom public, par exemple https://smartagt.example.org, et répartit les requêtes entre les nœuds Frontend. Cette page décrit ce que SmartAGT attend du proxy. Sa mise en place relève de la documentation de votre proxy.

Le nom public est l'adresse que voient vos utilisateurs sur votre réseau privé. Un reverse proxy relaie les requêtes, sans remplacer ce réseau : Exposition réseau.

NavigateurPostes des utilisateurs
Reverse proxysmartagt.example.org
FrontendSmartAGT

Exigences

Exigence Attendu par SmartAGT
Liaison vers le Frontend HTTPS vers le port 9000, ou le port configuré, ouvert en entrée au seul proxy sur le pare-feu du serveur.
Adresse du client Transmise par X-Forwarded-For (ou X-Real-IP) et X-Forwarded-Proto.
Proxy déclaré Adresses du proxy dans trusted_proxies : sans elles, SmartAGT ignore les en-têtes transmis.
Réponses progressives Les réponses des assistants arrivent en flux : mise en tampon désactivée, délai de lecture d'au moins 300 s.
Taille des requêtes Adaptée aux documents déposés par les utilisateurs.
WebSocket Non utilisé.
Exigence Attendu par SmartAGT
Liaison vers le Frontend HTTPS vers le port 9000 de chaque nœud Frontend, ouvert en entrée au seul proxy, certificat du nœud vérifié par votre autorité.
Répartition Entre les nœuds Frontend, sans affinité de session : chaque nœud sert toute session.
Contrôle de santé Connexion TCP au port 9000 de chaque nœud.
Adresse du client Transmise par X-Forwarded-For (ou X-Real-IP) et X-Forwarded-Proto.
Proxy déclaré Adresses du proxy dans trusted_proxies, sur chaque nœud Frontend : sans elles, SmartAGT ignore les en-têtes transmis.
Réponses progressives Les réponses des assistants arrivent en flux : mise en tampon désactivée, délai de lecture d'au moins 300 s.
Taille des requêtes Adaptée aux documents déposés par les utilisateurs.
WebSocket Non utilisé.

Procédure

1. Déclarer le proxy dans SmartAGT

Dans le YAML du Frontend, ajoutez l'adresse du proxy et l'origine publique, puis redémarrez le service du Frontend : Exploitation.

Sur chaque nœud Frontend, ajoutez l'adresse du proxy et l'origine publique au YAML du Frontend, puis redémarrez son service, un nœud après l'autre : Exploitation.

smartagt:
  http:
    server:
      trusted_proxies: ["10.20.0.10/32"]                # adresse du proxy
    cors:
      allow_origins: ["https://smartagt.example.org"]   # nom public

L'origine correspond à l'adresse publique vue par le navigateur, sans le port interne du Frontend : CORS. Pour changer aussi le port interne, voir Changer les ports.

Résultat attendu : le Frontend redémarre sans erreur.

2. Configurer le proxy

Appliquez les exigences ci-dessus dans votre proxy. Exemple pour NGINX, à adapter :

server {
    listen 443 ssl;
    server_name smartagt.example.org;
    ssl_certificate     /etc/nginx/tls/public.crt;
    ssl_certificate_key /etc/nginx/tls/public.key;
    client_max_body_size 256m;

    location / {
        proxy_pass https://bff.internal.example.org:9000;
        proxy_ssl_verify on;
        proxy_ssl_trusted_certificate /etc/nginx/tls/ca.crt;
        proxy_ssl_server_name on;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_http_version 1.1;
        proxy_buffering off;
        proxy_read_timeout 300s;
    }
}

ca.crt désigne l'autorité de votre certificat ou, avec le certificat généré par SmartAGT, sa racine exportée.

Appliquez les exigences ci-dessus dans votre proxy. Exemple pour NGINX, à adapter :

upstream smartagt_frontend {
    server frontend-1.example.test:9000;
    server frontend-2.example.test:9000;
}

server {
    listen 443 ssl;
    server_name smartagt.example.org;
    ssl_certificate     /etc/nginx/tls/public.crt;
    ssl_certificate_key /etc/nginx/tls/public.key;
    client_max_body_size 256m;

    location / {
        proxy_pass https://smartagt_frontend;
        proxy_ssl_verify on;
        proxy_ssl_trusted_certificate /etc/nginx/tls/ca.crt;
        proxy_ssl_name frontend.example.test;
        proxy_ssl_server_name on;
        proxy_set_header Host $host;
        proxy_set_header X-Forwarded-For $remote_addr;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_http_version 1.1;
        proxy_buffering off;
        proxy_read_timeout 300s;
    }
}

Derrière un upstream, NGINX vérifie tous les nœuds sous un même nom, fixé par proxy_ssl_name : le certificat de chaque nœud Frontend porte ce nom commun.

Directives détaillées : module proxy de NGINX.

Résultat attendu :

  • la page de connexion s'affiche sur https://smartagt.example.org ;
  • une réponse de Smarty s'affiche progressivement.

Cas particuliers

Proxy sur le même serveur

Quand le proxy tourne sur le serveur SmartAGT, limitez les écoutes du Frontend et d'AI Gateway à la boucle locale : seules les requêtes passées par le proxy les atteignent. Indiquez 127.0.0.1 et non localhost : un proxy qui joindrait AI Gateway par ::1 serait refusé, car AI Gateway n'accepte que des clients IPv4.

Dans le YAML du Frontend :

smartagt:
  http:
    server:
      host: "127.0.0.1"
      trusted_proxies: ["127.0.0.1/32"]

Dans le YAML du Backend, si AI Gateway est activée :

smartagt:
  gateway:
    server:
      host: "127.0.0.1"
      trusted_proxies: ["127.0.0.1/32"]

Redémarrez les services concernés : Exploitation. Dans le proxy, visez https://127.0.0.1:9000 en gardant la vérification du certificat. Le certificat généré par SmartAGT couvre localhost et 127.0.0.1 : avec NGINX, proxy_ssl_trusted_certificate désigne sa racine exportée et proxy_ssl_name localhost. Avec vos propres certificats, utilisez votre autorité et un nom présent dans le certificat.

Les ports 8010 et 8011 ne passent jamais par le proxy.

Résultat attendu : ss -ltnp montre les ports 9000 et 8001 sur 127.0.0.1 seulement, et la page de connexion s'affiche par le nom public.

API Publique ou AI Gateway derrière le proxy

Chaque écoute déclare ses propres proxies, dans le YAML du Backend, puis le service concerné redémarre :

Écoute Port amont Clé du YAML Backend
API Publique 8000 smartagt.http.public.trusted_proxies
AI Gateway 8001 smartagt.gateway.server.trusted_proxies

Utilisez un nom public distinct par écoute. AI Gateway n'accepte que des adresses clientes IPv4 et refuse tout appel relayé par un proxy non déclaré : Activer AI Gateway.

Plusieurs nœuds API : le lien interne

Le lien interne 8010, entre le Frontend et l'API, est en TLS mutuel : un proxy HTTP qui termine le TLS le rompt. Entre plusieurs nœuds API, utilisez un load balancer en simple passage TCP (L4), puis déclarez son nom dans smartagt.http.internal.url. Avec NGINX, un bloc stream au premier niveau de nginx.conf :

stream {
    upstream smartagt_internal {
        server api1.internal.example.org:8010;
        server api2.internal.example.org:8010;
    }
    server {
        listen 8010;
        proxy_pass smartagt_internal;
    }
}

Réservez ce port aux serveurs du Frontend.