Aller au contenu principal

Configuration des routes

Dirigez le trafic vers les bons conteneurs avec des règles de routage flexibles.

Vue d'ensemble​

Les routes définissent comment les requêtes entrantes sont dirigées vers vos conteneurs. SailOps supporte plusieurs types de routes pour différents protocoles et cas d'utilisation.

Référence technique

L'interface affiche « route HTTP », « route TCP », « route gRPC » et « route TLS ». Sur l'API, ce sont les valeurs Gateway API inchangées HTTPRoute, TCPRoute, GRPCRoute et TLSRoute, celles qu'utilisent les tableaux ci-dessous.

Types de routes​

Route HTTP​

Pour le trafic web standard et les APIs REST :

  • Support HTTP/1.1 et HTTP/2
  • Routage basé sur le chemin
  • Correspondance par hostname
  • Support WebSocket
ParamètreValeur
TypeHTTPRoute
Hostnamesapi.example.com
Path/api
Backendapi-service:8080

Route TCP​

Pour le trafic TCP brut :

  • Connexions base de données
  • Protocoles personnalisés
  • Transfert TCP direct
ParamètreValeur
TypeTCPRoute
Backenddatabase:5432

Route gRPC​

Pour les services gRPC :

  • Support du protocole gRPC
  • Routage par service et méthode
  • Health checks gRPC
ParamètreValeur
TypeGRPCRoute
Hostnamesgrpc.example.com
Backendgrpc-service:9090

Route TLS​

Pour le passthrough TLS :

  • Routage basé sur le SNI TLS
  • Chiffrement de bout en bout (pas de terminaison TLS à la gateway)
  • Passthrough direct vers les services backend
ParamètreValeur
TypeTLSRoute
Hostnamessecure.example.com
Backendtls-service:443

Créer une route​

Étape par étape​

  1. Allez dans votre gateway
  2. Cliquez sur l'onglet Routes
  3. Cliquez sur Create Route
  4. Sélectionnez le type de route
  5. Configurez :
ChampDescriptionExemple
NomIdentifiant uniqueapi-route
TypeHTTPRoute, TCPRoute, GRPCRoute ou TLSRouteHTTPRoute
HostnamesNoms de domaine pour la routeapi.example.com
BackendService et portapi-service:8080
  1. Cliquez sur Create
Validation des backends

Les services backend sont validés par rapport au catalogue d'endpoints du projet lors de la création et de la mise à jour pour tous les types de routes. Seuls les endpoints déclarés sont acceptés — sélectionner un service inconnu, un port non exposé par l'endpoint, ou un type de route non supporté produira une erreur de validation.

Sélecteur de service backend​

Le sélecteur de backend affiche tous les endpoints applicatifs déclarés dans votre projet. Chaque entrée montre le nom de la ressource, son type (container, PostgreSQL, MariaDB, Valkey, NATS, Kafka, Keycloak, Supabase, OpenSearch, service personnalisé ou website), et le rôle de l'endpoint. Les ressources avec plusieurs endpoints — par exemple PostgreSQL lecture-écriture, lecture seule et réplicas, ou MariaDB primaire et lecture — apparaissent comme des entrées distinctes sous le même nom de ressource.

Les endpoints en cours de provisionnement, appartenant à un service dont les policies d'accès empêchent l'exposition personnalisée, ou ne supportant pas le type de route actuel sont affichés mais désactivés, avec une raison indiquée sous l'entrée.

Vous pouvez saisir du texte dans le champ de recherche pour filtrer par nom, type ou endpoint. Les résultats sont triés par ordre alphabétique.

Si une route référence déjà un backend qui n'apparaît plus dans le catalogue, le sélecteur conserve la référence existante en lecture seule jusqu'à ce que vous choisissiez explicitement un remplacement.

Configuration des routes HTTP​

Correspondance de chemin​

Les routes HTTP supportent différents types de correspondance :

TypeDescriptionExemple
ExactCorrespond exactement au chemin/api correspond uniquement à /api
PathPrefixCorrespond aux préfixes de chemin/api correspond à /api, /api/users
RegularExpressionCorrespondance par expression régulière/api/v[0-9]+ correspond à /api/v1, /api/v2

Exemples de préfixes​

Chemin routeCorrespond àNe correspond pas
/Tout-
/api/api, /api/users, /api/v1/data/application
/api//api/, /api/users/api (sans slash final)

Hostnames multiples​

Une seule route peut gérer plusieurs hostnames (jusqu'à 16 par route). Les hostnames doivent être en minuscules, peuvent contenir des tirets et des points, et peuvent optionnellement commencer par un préfixe wildcard (*.) :

ParamètreValeur
Nommulti-domain-route
Hostnamesexample.com, www.example.com, app.example.com
Backendfrontend:3000

Backends multiples​

Routez le trafic vers plusieurs conteneurs pour l'équilibrage de charge :

ParamètreValeur
Nomload-balanced-api
Hostnamesapi.example.com

Backends :

ServicePort
api-18080
api-28080
api-38080

Statut des routes​

Statut DNS​

Chaque hostname de route affiche son statut de configuration DNS :

StatutDescription
DNS (vert)Le domaine pointe correctement vers la gateway
DNS (rouge)Le domaine ne pointe pas vers la gateway
DNS (gris)La vérification du statut n'est pas encore terminée

Statut du certificat TLS​

Pour les routes HTTPS dont la gateway termine TLS :

StatutDescription
Cert (vert)Le certificat est valide et actif
Cert (rouge)Problème de certificat ou en cours de provisionnement
Cert (gris)La vérification du statut du certificat n'est pas encore terminée

Une route TLS utilise le mode passthrough : SailOps ne provisionne pas et n'affiche pas le certificat du backend. Le backend doit présenter et renouveler un certificat valide pour chaque hostname SNI configuré.

Gestion des routes​

Détails de la liste des routes​

Chaque route dans la liste affiche des informations résumées en un coup d'œil :

  • Backends — les services vers lesquels la route dirige le trafic, avec le port cible
  • Paths — pour les routes HTTP, le premier chemin correspondant et un compteur de chemins supplémentaires (survolez pour voir la liste complète)
  • Timeouts — le timeout de requête (ou le timeout de requête backend lorsqu'aucun timeout de requête n'est défini), avec un compteur lorsque plusieurs règles définissent des valeurs différentes
  • Policies attachées — les types de policies directement attachées à la route (access control, traffic & limits), à l'exclusion des policies par défaut appliquées par sélecteur
  • Statut DNS / TLS — badges DNS et certificat par hostname
  • Création — date de création relative

Filtrer les routes​

Utilisez les boutons de filtre pour voir les routes par type :

  • All Routes - Voir toutes les routes configurées
  • HTTP routes - Routes HTTP uniquement
  • TCP routes - Routes TCP uniquement
  • gRPC routes - Routes gRPC uniquement
  • TLS routes - Routes TLS uniquement

Rechercher des routes​

Recherchez par :

  • Nom de route
  • Hostname
  • Nom du service backend

Trier les routes​

Triez les routes par :

  • Nom (A-Z ou Z-A)
  • Date de création (plus récent ou plus ancien)

Modifier une route​

  1. Trouvez la route dans la liste
  2. Cliquez sur l'icône de modification
  3. Modifiez la configuration
  4. Cliquez sur Save

Les changements prennent effet en quelques secondes.

Supprimer une route​

  1. Trouvez la route dans la liste
  2. Cliquez sur l'icône de suppression
  3. Confirmez la suppression
attention

Supprimer une route arrête immédiatement le trafic pour cette configuration de route.

Patterns courants​

Versioning d'API​

NomTypeHostnamePathBackend
api-v2HTTPRouteapi.example.com/v2api-v2:8080
api-v1HTTPRouteapi.example.com/v1api-v1:8080

Architecture microservices​

NomTypeHostnamePathBackend
users-apiHTTPRouteapi.example.com/usersuser-service:8080
orders-apiHTTPRouteapi.example.com/ordersorder-service:8080
payments-apiHTTPRouteapi.example.com/paymentspayment-service:8080

Frontend + API​

NomTypeHostnamePathBackend
api-routeHTTPRouteapp.example.com/apiapi:8080
frontend-routeHTTPRouteapp.example.com/frontend:3000

Services gRPC​

NomTypeHostnameBackend
grpc-usersGRPCRoutegrpc.example.comuser-grpc:9090
grpc-ordersGRPCRoutegrpc.example.comorder-grpc:9090

Priorité des routes​

Priorité automatique​

Les routes sont automatiquement ordonnées par spécificité :

  1. Les chemins plus longs correspondent en premier
  2. Les correspondances exactes avant les préfixes
  3. Les règles plus spécifiques avant les générales

Exemple d'ordre de priorité​

Avec ces routes :

  1. /api/v2/users (plus spécifique)
  2. /api/v2
  3. /api
  4. / (moins spécifique)

Une requête vers /api/v2/users/123 correspond à la route #1.

Dépannage​

Route non correspondante​

  1. Vérifiez l'orthographe et le format du chemin
  2. Vérifiez que le hostname correspond au listener
  3. Vérifiez l'ordre de priorité des routes
  4. Testez avec curl pour plus de détails :
curl -v https://api.example.com/your-path

Trafic vers le mauvais backend​

  1. Revoyez l'ordre et la spécificité des routes
  2. Vérifiez les conflits de préfixes de chemin
  3. Vérifiez la configuration du hostname

502 Bad Gateway​

La gateway ne peut pas atteindre le conteneur :

  • Le conteneur a peut-être crashé
  • Discordance de port entre la route et le conteneur
  • Le conteneur n'est pas encore prêt

504 Gateway Timeout​

Sans timeout de requête configuré sur la route, Envoy termine les requêtes après 15 s. Une réponse streaming interrompue après ses en-têtes conserve son statut 2xx et ajoute seulement un timeout. Configurer un timeout de requête adapté, ou 0s pour désactiver cette limite sur les routes de streaming.

Sujets connexes​