Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info
Edge Microgateway v. 3.3.x
Apigee Edge Microgateway est un processeur de messages sécurisé basé sur HTTP pour les API. Son rôle principal est de traiter de manière sécurisée les requêtes et les réponses à destination et en provenance des services backend, tout en transmettant de manière asynchrone des données d'exécution d'API précieuses à Apigee Edge, où elles sont consommées par le système Edge Analytics. Edge Microgateway est facile à installer et à déployer. Vous pouvez mettre en service une instance en quelques minutes.
En règle générale, Edge Microgateway est installé dans un réseau approuvé à proximité des services cibles de backend. Il offre une sécurité de niveau entreprise et certaines fonctionnalités clés des plug-ins, telles que l'arrêt des pics, les quotas et les analyses, mais pas toutes les fonctionnalités ni l'empreinte d'Apigee Edge. Si vous le souhaitez, vous pouvez installer Edge Microgateway dans le même centre de données ou même sur la même machine que vos services backend.
Vous pouvez exécuter Edge Microgateway en tant que processus autonome ou dans un conteneur Docker. Consultez Utiliser Docker avec Edge Microgateway. Vous pouvez également utiliser Edge Microgateway pour fournir une gestion des API Apigee pour les services exécutés dans un cluster Kubernetes. Que vous migriez des services et des API existants vers la pile Kubernetes ou que vous créiez des services et des API, la micropasserelle Edge vous aide à bénéficier d'une expérience de gestion des API claire, qui inclut la sécurité, la gestion du trafic, l'analyse, la publication, etc. Consultez Intégrer Edge Microgateway à Kubernetes.
Cas d'utilisation types
Voici des cas d'utilisation types d'une solution de gestion des API Cloud hybride telle qu'Edge Microgateway:
- Réduire la latence du trafic des API pour les services exécutés à proximité Par exemple, si vos consommateurs et producteurs d'API se trouvent à proximité, vous ne souhaitez pas nécessairement que les API passent par une passerelle centrale.
- Limitation du trafic des API dans les limites approuvées par l'entreprise à des fins de sécurité ou de conformité ;
- Poursuite du traitement des messages en cas de perte temporaire de la connexion Internet.
- Fournissez une gestion des API Apigee pour les services exécutés dans un cluster Kubernetes. Consultez Intégrer Edge Microgateway à Kubernetes.
Pour en savoir plus, consultez cet article de la communauté Apigee.
Principaux avantages et fonctionnalités
| Fonctionnalité | Avantages |
|---|---|
| Sécurité | La micro passerelle Edge authentifie les requêtes à l'aide d'un jeton d'accès signé ou d'une clé API délivrés par Apigee Edge à chaque application cliente. |
| Déploiement rapide | Contrairement à un déploiement complet d'Apigee Edge, vous pouvez déployer et exécuter une instance d'Edge Microgateway en quelques minutes. |
| Proximité du réseau | Vous pouvez installer et gérer Edge Microgateway sur la même machine, le même sous-réseau ou le même centre de données que les API cibles du backend avec lesquelles Edge Microgateway interagit. |
| Analyse | Edge Microgateway envoie de manière asynchrone les données d'exécution des API à Apigee Edge, où elles sont traitées par le système Edge Analytics. Vous pouvez utiliser la suite complète de métriques, de tableaux de bord et d'API Edge Analytics. |
| Latence réduite | Toutes les communications avec Apigee Edge sont asynchrones et ne se font pas dans le cadre du traitement des requêtes API de clients. Cela permet à Edge Microgateway de collecter des données d'API et de les envoyer à Apigee Edge sans affecter la latence. |
| Aisance dans la collaboration | Edge Microgateway utilise et interagit avec les fonctionnalités Apigee Edge que les administrateurs Edge comprennent déjà bien, telles que les proxys, les produits et les applications de développeur. |
| Configuration | Aucune programmation n'est requise pour configurer et gérer Edge Microgateway. Tout est géré via la configuration. |
| Commodité | Vous pouvez intégrer Edge Microgateway à votre infrastructure et à vos processus de surveillance et de gestion des applications existants. Notez que la surveillance des API Apigee n'est pas compatible avec Edge Microgateway. |
| Journalisation | Les fichiers journaux détaillent tous les événements normaux et exceptionnels rencontrés lors du traitement de l'API par Edge Microgateway. |
| CLI | Une interface de ligne de commande vous permet de démarrer, d'arrêter et de redémarrer la micro-passerelle Edge, d'extraire des statistiques d'exploitation, d'afficher des fichiers journaux, de demander des jetons d'accès, etc. |
À savoir sur Edge Microgateway
Cette section explique le fonctionnement de la micro passerelle Edge, son architecture de base, sa configuration et son déploiement.
Pourquoi utiliser Edge Microgateway ?
En déplaçant le composant de gestion d'API à proximité des applications cibles backend, vous pouvez réduire la latence du réseau. Bien qu'il soit possible d'installer Apigee Edge sur site dans un cloud privé, un déploiement complet d'Apigee Edge est nécessairement vaste et complexe s'il doit faire appel à l'ensemble de ses fonctionnalités de traitement d'un gros volume de données, telles que la gestion des clés, la monétisation et analyses. Cela signifie que le déploiement d'Apigee Edge sur site dans chaque centre de données n'est pas toujours souhaitable.
Avec Edge Microgateway, vous obtenez une application relativement peu consommatrice de ressources qui s'exécute à proximité de vos applications backend. Vous pouvez également exploiter pleinement Apigee Edge pour les analyses, la sécurité et d'autres fonctionnalités.
Exemples de scénarios de déploiement
Cette section illustre plusieurs scénarios de déploiement possibles pour la micro passerelle Edge.
Même machine
La figure 1 montre le chemin de traitement des requêtes lorsque Edge Microgateway est déployé dans sa configuration la plus simple possible, où Edge Microgateway et les API cibles du backend sont installés sur la même machine. Une seule instance de micro passerelle Edge peut être utilisée pour gérer plusieurs applications cibles de backend.
Autre machine
Étant donné que toute la communication entre les clients, la micro passerelle Edge et les implémentations d'API backend est HTTP, vous pouvez installer la micro passerelle Edge Apigee sur une machine différente de celle de l'implémentation de l'API, comme illustré dans la figure 2.
Avec un équilibreur de charge
Edge Microgateway peut être mis en avant par un proxy inverse ou un équilibreur de charge standard pour la terminaison SSL et/ou l'équilibrage de charge, comme illustré dans la figure 3.
Déploiement d'un intranet
Utilisez Edge Microgateway pour protéger le trafic intranet tout en protégeant le trafic Internet avec Apigee Edge, comme illustré dans la figure 4. Imaginons qu'un point de terminaison d'API /orders soit mis en proxy via Apigee Edge Cloud et qu'il accède à la cible backend https://mycompany.com/orders. Cela est représenté par l'implémentation de l'API cible à gauche. Cette API peut ensuite appeler plusieurs points de terminaison d'API représentés par l'implémentation cible à droite. Par exemple, il peut appeler en interne /customers et /transactions. Consultez également
ce post de la communauté Apigee.
Dépendance vis-à-vis d'Apigee Edge
Edge Microgateway dépend d'Apigee Edge et interagit avec lui. Edge Microgateway doit communiquer avec Apigee Edge pour fonctionner correctement. Voici les principales façons dont Edge Microgateway interagit avec Edge:
- Au démarrage, Edge Microgateway obtient une liste de proxys spéciaux "compatibles avec Edge Microgateway" et une liste de tous les produits d'API de votre organisation Apigee Edge. Pour chaque requête client entrante, Edge Microgateway détermine si la requête correspond à l'un de ces proxys d'API, puis valide le jeton d'accès ou la clé API entrante en fonction des clés du produit d'API associé à ce proxy.
- Le système Apigee Edge Analytics stocke et traite les données d'API envoyées de manière asynchrone depuis la micro passerelle Edge.
- Apigee Edge fournit les identifiants utilisés pour signer les jetons d'accès ou les clés API requises par les clients effectuant des appels d'API via la micro passerelle Edge. Vous pouvez obtenir ces jetons à l'aide d'une commande CLI fournie avec Edge Microgateway.
Configuration unique
Vous devez d'abord configurer Edge Microgateway pour qu'il puisse communiquer avec votre organisation Apigee Edge. Au démarrage, Edge Microgateway lance une opération de démarrage avec Apigee Edge. Edge Microgateway récupère auprès d'Apigee Edge les informations dont il a besoin pour traiter les appels d'API lui-même, y compris la liste des proxys compatibles avec Edge Microgateway déployés sur Apigee Edge. Nous en parlerons plus en détail dans quelques instants.
Edge Microgateway n'a pas besoin d'être colocalisé avec Apigee Edge. Les offres de cloud public et privé d'Apigee Edge fonctionnent tout aussi bien.
À savoir sur les proxy compatibles avec Edge Microgateway
Les proxys compatibles avec Edge Microgateway fournissent à Edge Microgateway certaines informations qui lui permettent de traiter les requêtes d'API client. Les informations sur ces proxys sont téléchargées d'Apigee Edge vers Edge Microgateway au démarrage d'Edge Microgateway.
C'est à vous ou à votre équipe API de créer ces proxys sur Apigee Edge à l'aide de l'interface utilisateur de gestion Apigee Edge ou par d'autres moyens si vous le souhaitez. C'est facile à faire, et nous vous expliquons tout dans la section Configurer la micro-passerelle Edge.
Voici les caractéristiques des proxy compatibles avec Edge Microgateway:
- Ils fournissent à Edge Microgateway deux informations clés: un chemin de base et une URL cible.
- Ils doivent pointer vers des points de terminaison cibles HTTP. La cible du backend ne peut pas être une application Node.js référencée par un élément ScriptTarget dans la définition de TargetEndpoint. Pour en savoir plus, consultez la remarque précédente.
- Les noms de proxy doivent être précédés de
edgemicro_. Par exemple:edgemicro_weather. - Vous ne pouvez pas ajouter de règles ni de flux conditionnels à ces proxys. Si vous essayez, elles sont ignorées. Sinon, les proxys compatibles avec la micro passerelle Edge s'affichent dans l'interface utilisateur de gestion Edge de la même manière que tout autre proxy d'API sur Edge.
- Elles peuvent être regroupées dans des produits et associées à des applications de développeur.
- Les données sur le trafic s'affichent dans Edge Analytics.
- Ils ne peuvent pas être suivis à l'aide de l'outil de suivi Apigee Edge.
À propos d'Edge Microgateway et d'Apigee Edge Analytics
Lorsque le trafic d'API transite par Edge Microgateway, Edge Microgateway met en mémoire tampon et envoie de manière asynchrone les données d'exécution de l'API à Apigee Edge, où elles sont stockées et traitées par le système Edge Analytics. Cette communication asynchrone permet à la micro passerelle Edge de profiter des fonctionnalités d'analyse Edge, tout en conservant une empreinte relativement faible avec un coût de traitement ou un blocage minimal. La suite complète des tableaux de bord Edge Analytics et des fonctionnalités de création de rapports personnalisés est disponible pour vous et votre équipe afin d'analyser le trafic qui passe par Edge Microgateway.
Pour en savoir plus sur Edge Analytics, consultez Tableaux de bord Analytics.
À propos de la sécurité d'Edge Microgateway
Rôle d'Apigee Edge
Comme indiqué précédemment, Apigee Edge joue un rôle dans la sécurisation de toutes les requêtes client envoyées à Edge Microgateway. Les rôles principaux d'Apigee Edge sont les suivants:
- Fournir des identifiants client utilisés comme clés API ou pour générer des jetons d'accès valides utilisés par les clients pour effectuer des appels d'API sécurisés via la micro passerelle Edge.
- Fournir les identifiants dont Edge Microgateway a besoin pour envoyer des données d'exécution d'API au système Apigee Edge Analytics. Ces identifiants sont obtenus une seule fois par Edge Microgateway lors des étapes de configuration initiale.
- Fournir la plate-forme permettant de regrouper des ressources d'API dans des produits, d'enregistrer et de gérer des développeurs, et de créer et de gérer des applications de développeur.
Authentification de l'application cliente
Edge Microgateway est compatible avec l'authentification client via des jetons d'accès et des clés API. Les clés et les jetons de sécurité sont générés par Apigee Edge et validés par Edge Microgateway pour chaque appel d'API. Si le plug-in OAuth est activé, la micro passerelle Edge vérifie un jeton d'accès ou une clé API signés. Si le jeton ou la clé sont valides, l'appel d'API passe à la cible du backend. S'il n'est pas valide, une erreur est renvoyée.
Consultez Configurer et configurer la micro passerelle Edge pour connaître les étapes à suivre pour obtenir et utiliser des jetons d'accès et des clés API.
Authentification d'Edge Microgateway sur Apigee Edge
Les appels asynchrones effectués par Edge Microgateway pour mettre à jour les données analytiques sur Apigee Edge nécessitent une authentification. Cette authentification est fournie via une paire de clés publique/secrète transmise à la micro passerelle Edge via la CLI ou à l'aide de variables d'environnement. Vous obtenez et utilisez ces clés une fois lorsque vous installez et démarrez Edge Microgateway pour la première fois.
Plate-forme de gestion des produits API
Edge sert de plate-forme pour regrouper des ressources d'API dans des produits, enregistrer et gérer des développeurs, et créer et gérer des applications de développeur. Par exemple, tout comme vous pouvez créer et regrouper des entités telles que des produits et des applications de développement pour les proxys Apigee Edge standards, vous pouvez faire exactement la même chose pour les proxys Edge Microgateway. La sécurité au niveau de l'API est possible grâce à la génération de clés de sécurité publiques et privées pour chaque "bundle". Ce mécanisme est identique à la façon dont la sécurité des API fonctionne sur Apigee Edge.
Puis-je transférer mes implémentations de proxy Edge existantes vers Edge Microgateway ?
Vous ne pouvez pas migrer les proxys existants avec les règles ou les flux conditionnels associés vers la micro-passerelle Edge. Edge Microgateway vous oblige à créer des proxys "compatibles avec la microgateway". Ces proxys doivent être nommés avec un préfixe spécial, edgemicro_. Au démarrage, la micro passerelle Edge détecte ces proxys edgemicro_* et télécharge les informations de configuration pour chacun d'eux. Ces informations incluent leurs URL cibles et leurs chemins de ressources. À partir de ce moment-là, les proxys ne sont plus utilisés. Aucune règle ni aucun flux conditionnel de ces proxys ne s'exécutera jamais.
Une autre raison d'utiliser des proxys compatibles avec la micro-passerelle est qu'Edge Microgateway envoie de manière asynchrone des données d'analyse à Edge pour chaque proxy compatible avec la micro-passerelle. Vous pouvez ensuite afficher les données analytiques pour les proxys compatibles avec la micro passerelle, comme vous le feriez pour n'importe quel autre proxy dans l'interface utilisateur Analytics d'Edge.
L'article sur la configuration vous explique toutes les étapes à suivre pour commencer à proxyer les appels d'API via Edge Microgateway, y compris quelques étapes simples à suivre sur Apigee Edge pour configurer une configuration dont Edge Microgateway a besoin, y compris la création de proxys compatibles avec la micro passerelle. Consultez Configurer Edge Microgateway.
En savoir plus sur Edge Microgateway
Apigee fournit les ressources suivantes:
-
Documentation Edge Microgateway : les documents incluent un guide d'installation et un tutoriel de démarrage, ainsi que des informations de référence et de configuration complètes.
-
Vidéos : la série de vidéos de 4 minutes pour les développeurs d'Apigee comprend une suite d'épisodes sur Edge Microgateway.
-
La communauté Apigee est l'endroit idéal pour poser des questions et profiter des questions posées et des réponses données par d'autres utilisateurs.