Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu
Apigee X. info
Edge Microgateway, Version 3.2.x
Apigee Edge Microgateway ist ein sicherer, HTTP-basierter Nachrichtenprozessor für APIs. Seine Hauptaufgabe besteht darin, Anfragen und Antworten an und von Back-End-Diensten sicher zu verarbeiten und gleichzeitig wertvolle API-Ausführungsdaten asynchron an Apigee Edge zu senden, wo sie vom Edge Analytics System verwendet werden. Edge Microgateway ist einfach zu installieren und bereitzustellen. Sie können innerhalb weniger Minuten eine Instanz einrichten und ausführen.
In der Regel wird Edge Microgateway in einem vertrauenswürdigen Netzwerk in der Nähe von Back-End-Zieldiensten installiert. Es bietet Sicherheit auf Unternehmensniveau und einige wichtige Plug-in-Funktionen wie Spike Arrest, Kontingente und Analysen, aber nicht die volle Leistungsfähigkeit oder den vollen Funktionsumfang von Apigee Edge. Sie können Edge Microgateway im selben Rechenzentrum oder sogar auf demselben Computer wie Ihre Back-End-Dienste installieren.
Sie können Edge Microgateway als eigenständigen Prozess oder in einem Docker-Container ausführen. Weitere Informationen finden Sie unter Docker mit Edge Microgateway verwenden. Sie können Edge Microgateway auch verwenden, um die Apigee API-Verwaltung für Dienste bereitzustellen, die in einem Kubernetes-Cluster ausgeführt werden. Unabhängig davon, ob Sie vorhandene Dienste und APIs zum Kubernetes-Stack migrieren oder neue Dienste und APIs erstellen, bietet Edge Microgateway eine übersichtliche API-Verwaltung, die Sicherheit, Traffic-Verwaltung, Analysen, Veröffentlichung und mehr umfasst. Weitere Informationen finden Sie unter Edge Microgateway in Kubernetes einbinden.
Typische Anwendungsfälle
Typische Anwendungsfälle für eine hybride Cloud-API-Verwaltungslösung wie Edge Microgateway sind:
- Reduzierte Latenz des API-Traffics für Dienste, die in naher Nähe ausgeführt werden. Wenn sich Ihre API-Nutzer und -Anbieter beispielsweise in unmittelbarer Nähe befinden, müssen APIs nicht unbedingt über ein zentrales Gateway laufen.
- API-Traffic aus Sicherheits- oder Compliance Gründen innerhalb der vom Unternehmen genehmigten Grenzen halten.
- Nachrichten weiterverarbeiten, wenn die Internetverbindung vorübergehend unterbrochen ist.
- Apigee API-Verwaltung für Dienste bereitstellen, die in einem Kubernetes-Cluster ausgeführt werden. Weitere Informationen finden Sie unter Edge Microgateway in Kubernetes einbinden.
Weitere Anwendungsfälle finden Sie in diesem Artikel der Apigee-Community.
Wichtige Funktionen und Vorteile
| Funktion | Vorteile |
|---|---|
| Sicherheit | Edge Microgateway authentifiziert Anfragen mit einem signierten Zugriffstoken oder API-Schlüssel, der jeder Clientanwendung von Apigee Edge zugewiesen wird. |
| Schnelle Bereitstellung | Im Gegensatz zu einer vollständigen Bereitstellung von Apigee Edge können Sie eine Instanz von Edge Microgateway innerhalb weniger Minuten bereitstellen und ausführen. |
| Netzwerk-Nähe | Sie können Edge Microgateway auf demselben Computer, Subnetz oder Rechenzentrum wie die Back-End-Ziel-APIs installieren und verwalten, mit denen Edge Microgateway interagiert. |
| Analytics | Edge Microgateway liefert API-Ausführungsdaten asynchron an Apigee Edge, wo sie vom Edge Analytics-System verarbeitet werden. Sie können die gesamte Suite von Edge Analytics-Messwerten, -Dashboards und -APIs verwenden. |
| Verringerte Latenz | Die gesamte Kommunikation mit Apigee Edge erfolgt asynchron und wird nicht im Rahmen der Verarbeitung von Client-API-Anfragen ausgeführt. So kann Edge Microgateway API-Daten erfassen und an Apigee Edge senden, ohne die Latenz zu beeinträchtigen. |
| Vertrautheit | Edge Microgateway verwendet und interagiert mit Apigee Edge Funktionen, die Edge-Administratoren bereits gut kennen, z. B. Proxys, Produkte und Entwickler-Apps. |
| Konfiguration | Für die Einrichtung und Verwaltung von Edge Microgateway ist keine Programmierung erforderlich. Alles wird über die Konfiguration abgewickelt. |
| Praktisch | Sie können Edge Microgateway in Ihre vorhandene Infrastruktur und Prozesse für die Anwendungsüberwachung und ‑verwaltung einbinden. Beachten Sie, dass Apigee API Monitoring für Edge Microgateway nicht unterstützt wird. |
| Logging | In den Logdateien werden alle normalen und außergewöhnlichen Ereignisse aufgeführt, die bei der API-Verarbeitung durch Edge Microgateway auftreten. |
| CLI | Über eine Befehlszeilenschnittstelle können Sie Edge Microgateway starten, beenden und neu starten, Betriebsstatistiken extrahieren, Logdateien ansehen, Zugriffstokens anfordern und vieles mehr. |
Wissenswertes zu Edge Microgateway
In diesem Abschnitt wird beschrieben, wie Edge Microgateway funktioniert, seine grundlegende Architektur, Konfiguration und Bereitstellung.
Warum Edge Microgateway verwenden?
Wenn Sie die API-Verwaltungskomponente in die Nähe von Back-End-Zielanwendungen verschieben, kann die Netzwerklatenz verringert werden. Wenn Sie Apigee Edge lokal in einer privaten Cloud installieren können, ist eine vollständige Bereitstellung von Apigee Edge notwendigerweise groß und komplex, um den vollen Satz an Features und datenintensive Features wie Schlüsselverwaltung, Monetarisierung und Analysen zu unterstützen. Dies bedeutet, dass die Bereitstellung von Apigee Edge vor Ort in jedem Rechenzentrum nicht immer wünschenswert ist.
Mit Edge Microgateway erhalten Sie eine relativ kleine Anwendung, die in der Nähe Ihrer Back-End-Anwendungen ausgeführt wird. Außerdem können Sie Apigee Edge in vollem Umfang für Analysen, Sicherheit und andere Funktionen nutzen.
Beispiele für Bereitstellung szenarien
In diesem Abschnitt werden mehrere mögliche Bereitstellungsszenarien für Edge Microgateway veranschaulicht.
Gleicher Computer
Abbildung 1 zeigt den Pfad der Anfragenverarbeitung, wenn Edge Microgateway in der einfachsten möglichen Konfiguration bereitgestellt wird, bei der Edge Microgateway und die Back-End-Ziel-APIs auf demselben Computer installiert sind. Eine einzelne Edge Microgateway-Instanz kann für mehrere Back-End-Zielanwendungen verwendet werden.
Anderer Computer
Da die gesamte Kommunikation zwischen Clients, Edge Microgateway und Back-End-API Implementierungen über HTTP erfolgt, können Sie Apigee Edge Microgateway auf einem anderen Computer als die API-Implementierung installieren, wie in Abbildung 2 dargestellt.
Mit Load-Balancer
Edge Microgateway selbst kann von einem Standard-Reverse-Proxy oder Load-Balancer für die SSL-Terminierung und/oder das Load-Balancing verwendet werden, wie in Abbildung 3 dargestellt.
Intranet-Bereitstellung
Verwenden Sie Edge Microgateway, um den Intranet-Traffic zu schützen, und
Apigee Edge, um den Internet-Traffic zu schützen, wie in Abbildung 4 dargestellt. Angenommen, ein API-Endpunkt /orders wird
über die Apigee Edge Cloud weitergeleitet und erreicht das Back-End-Ziel
https://mycompany.com/orders. Dies wird durch die Ziel-API-Implementierung
auf der linken Seite dargestellt. Diese API kann dann mehrere API-Endpunkte aufrufen, die durch die Ziel
Implementierung auf der rechten Seite dargestellt werden. Beispielsweise kann sie intern /customers und
/transactions aufrufen. Weitere Informationen finden Sie in
diesem Beitrag in der Apigee-Community.
Abhängigkeit von Apigee Edge
Edge Microgateway ist von Apigee Edge abhängig und interagiert damit. Edge Microgateway muss mit Apigee Edge kommunizieren, um ordnungsgemäß zu funktionieren. Die wichtigsten Möglichkeiten, wie Edge Microgateway mit Edge interagiert, sind:
- Beim Start ruft Edge Microgateway eine Liste spezieller „Edge Microgateway-fähiger“ Proxys und eine Liste aller API-Produkte aus Ihrer Apigee Edge-Organisation ab. Für jede eingehende Clientanfrage ermittelt Edge Microgateway, ob die Anfrage mit einem dieser API-Proxys übereinstimmt, und validiert dann das eingehende Zugriffstoken oder den API-Schlüssel anhand der Schlüssel im API-Produkt, das mit diesem Proxy verknüpft ist.
- Das Apigee Edge Analytics-System speichert und verarbeitet API-Daten, die asynchron von Edge Microgateway gesendet werden.
- Apigee Edge stellt Anmeldedaten bereit, die zum Signieren von Zugriffstokens oder zum Bereitstellen von API-Schlüsseln verwendet werden, die von Clients benötigt werden, die API-Aufrufe über Edge Microgateway ausführen. Sie können diese Tokens mit einem Befehlszeilenbefehl abrufen, der mit Edge Microgateway bereitgestellt wird.
Einmalige Konfiguration
Sie müssen Edge Microgateway zuerst konfigurieren, damit es mit Ihrer Apigee Edge Organisation kommunizieren kann. Beim Start initiiert Edge Microgateway einen Bootstrapping-Vorgang mit Apigee Edge. Edge Microgateway ruft von Apigee Edge die Informationen ab, die zum Verarbeiten von API Aufrufen erforderlich sind, einschließlich der Liste der Edge Microgateway-fähigen Proxys, die in Apigee Edge bereitgestellt werden. Wir werden gleich noch genauer auf diese Proxys eingehen.
Edge Microgateway muss nicht mit Apigee Edge zusammen installiert werden. Die öffentlichen und privaten Cloud-Angebote von Apigee Edge funktionieren gleichermaßen gut.
Wissenswertes zu Edge Microgateway-fähigen Proxys
Edge Microgateway-fähige Proxys stellen Edge Microgateway bestimmte Informationen zur Verfügung, mit denen Client-API-Anfragen verarbeitet werden können. Informationen zu diesen Proxys werden beim Start von Edge Microgateway von Apigee Edge zu Edge Microgateway heruntergeladen.
Sie oder Ihr API-Team können diese Proxys in Apigee Edge über die Apigee Edge Verwaltungs-UI oder auf andere Weise erstellen. Das ist ganz einfach. Die Details werden unter Edge Microgateway einrichten und konfigurieren beschrieben.
Die Merkmale von Edge Microgateway-fähigen Proxys sind:
- Sie stellen Edge Microgateway zwei wichtige Informationen zur Verfügung: einen Basispfad und eine Ziel-URL.
- Sie müssen auf HTTP-Zielendpunkte verweisen. Das Back-End-Ziel darf keine Node.js-Anwendung sein, auf die in der TargetEndpoint-Definition mit einem ScriptTarget-Element verwiesen wird. Weitere Informationen finden Sie im vorherigen Hinweis.
- Die Proxy-Namen müssen das Präfix
edgemicro_haben. Beispiel: Beispiel:edgemicro_weather. - Sie können diesen Proxys keine Richtlinien oder bedingten Abläufe hinzufügen. Wenn Sie das versuchen, werden sie ignoriert. Andernfalls werden Edge Microgateway-fähige Proxys in der Edge-Verwaltungs-UI genauso wie andere API-Proxys in Edge angezeigt.
- Sie können in Produkte gebündelt und mit Entwickler-Apps verknüpft werden.
- Verkehrsdaten werden in Edge Analytics angezeigt.
- Sie können nicht mit dem Apigee Edge-Trace-Tool getracet werden.
Edge Microgateway und Apigee Edge Analytics
Wenn API-Traffic über Edge Microgateway läuft, puffert Edge Microgateway API-Ausführungsdaten und sendet sie asynchron an Apigee Edge, wo die Daten vom Edge Analytics-System gespeichert und verarbeitet werden. Durch diese asynchrone Kommunikation kann Edge Microgateway die Edge Analytics-Funktionen nutzen und gleichzeitig einen relativ geringen Platzbedarf mit minimalem Verarbeitungs aufwand oder Blockierungen beibehalten. Die gesamte Suite von Edge Analytics-Dashboards und benutzerdefinierten Berichtsfunktionen steht Ihnen und Ihrem Team zur Verfügung, um den Traffic zu analysieren, der über Edge Microgateway läuft.
Weitere Informationen zu Edge Analytics finden Sie unter Analyse-Dashboards.
Sicherheit von Edge Microgateway
Die Rolle von Apigee Edge
Wie bereits erwähnt, spielt Apigee Edge eine Rolle bei der Sicherung aller Clientanfragen an Edge Microgateway. Die wichtigsten Rollen von Apigee Edge sind:
- Bereitstellung von Clientanmeldedaten, die als API-Schlüssel verwendet werden oder zum Generieren gültiger Zugriffstokens dienen, die von Clients verwendet werden, um sichere API-Aufrufe über Edge Microgateway auszuführen.
- Bereitstellung von Anmeldedaten, die Edge Microgateway benötigt, um API-Ausführungsdaten an das Apigee Edge Analytics-System zu senden. Diese Anmeldedaten werden von Edge Microgateway einmal während der Ersteinrichtung abgerufen.
- Bereitstellung der Plattform zum Bündeln von API-Ressourcen in Produkte, zum Registrieren und Verwalten Entwicklern sowie zum Erstellen und Verwalten von Entwickler-Apps.
Authentifizierung von Clientanwendungen
Edge Microgateway unterstützt die Clientauthentifizierung über Zugriffstokens und API Schlüssel. Sicherheitsschlüssel und ‑tokens werden von Apigee Edge generiert und von Edge Microgateway für jeden API-Aufruf validiert. Wenn das OAuth-Plug-in aktiviert ist, prüft Edge Microgateway ein signiertes Zugriffstoken oder einen API-Schlüssel. Wenn es gültig ist, wird der API-Aufruf an das Back-End-Ziel weitergeleitet. Andernfalls wird ein Fehler zurückgegeben.
Unter Setting up und configuring Edge Microgateway finden Sie die Schritte, die zum Abrufen und Verwenden von Zugriffstokens und API-Schlüsseln erforderlich sind.
Authentifizierung von Edge Microgateway in Apigee Edge
Die asynchronen Aufrufe, die Edge Microgateway zum Aktualisieren von Analysedaten in Apigee Edge erfordern eine Authentifizierung. Diese Authentifizierung erfolgt über ein öffentliches/geheimes Schlüsselpaar, das an Edge Microgateway über die Befehlszeile oder Umgebungsvariablen übergeben wird. Sie rufen diese Schlüssel einmal ab und verwenden sie, wenn Sie Edge Microgateway zum ersten Mal installieren und starten.
Plattform für die API-Produktverwaltung
Edge dient als Plattform zum Bündeln von API-Ressourcen in Produkte, zum Registrieren und Verwalten von Entwicklern sowie zum Erstellen und Verwalten von Entwickler-Apps. So wie Sie beispielsweise Entitäten wie Produkte und Entwickler-Apps für reguläre Apigee Edge-Proxys erstellen und bündeln können , können Sie genau dasselbe für Edge Microgateway-Proxys tun. Die Sicherheit auf API-Ebene wird durch das Generieren öffentlicher und privater Sicherheitsschlüssel für jedes "Bundle" ermöglicht. Dieser Mechanismus ist identisch mit der Funktionsweise der API-Sicherheit in Apigee Edge.
Kann ich meine vorhandenen Edge-Proxy-Implementierungen zu Edge Microgateway migrieren?
Vorhandene Proxys mit zugehörigen Richtlinien oder bedingten Abläufen können nicht zu Edge Microgateway migriert werden. Für Edge Microgateway müssen Sie neue „Microgateway-fähige“ Proxys erstellen. Diese Proxys müssen mit einem speziellen Präfix benannt werden: edgemicro_. Beim Start erkennt Edge Microgateway diese edgemicro_*-Proxys und lädt Konfigurationsinformationen für jeden von ihnen herunter. Diese Informationen umfassen die Ziel-URLs und Ressourcenpfade. Ab diesem Zeitpunkt werden die Proxys nicht mehr verwendet. Alle Richtlinien oder bedingten Abläufe in diesen Proxys werden nie ausgeführt.
Ein weiterer Grund für Microgateway-fähige Proxys ist, dass Edge Microgateway Analysedaten für jeden Microgateway-fähigen Proxy asynchron an Edge sendet. Sie können die Analysedaten für Microgateway-fähige Proxys genauso wie für jeden anderen Proxy in der Edge Analytics-UI ansehen.
Im Einrichtungsthema werden alle Schritte beschrieben, die Sie ausführen müssen, um API-Aufrufe über Edge Microgateway weiterzuleiten. Dazu gehören einige einfache Schritte, die Sie in Apigee Edge ausführen müssen, um eine Konfiguration einzurichten, die Edge Microgateway benötigt, einschließlich der Erstellung von Microgateway-fähigen Proxys. Weitere Informationen finden Sie unter Edge Microgateway einrichten und konfigurieren.
Weitere Informationen zu Edge Microgateway
Apigee bietet folgende Ressourcen:
-
Edge Microgateway Dokumentation: Die Dokumentation enthält eine Installationsanleitung und eine Anleitung für die ersten Schritte sowie vollständige Referenz und Konfigurationsinformationen.
-
Videos: Die Videoreihe „Apigee Four Minute Videos for Developers“ enthält eine Reihe von Folgen zu Edge Microgateway.
-
In der Apigee-Community können Sie ein großartiger Ort sein, um Fragen zu stellen und von Fragen zu profitieren, die von anderen gestellt und beantwortet wurden.