Edge Microgateway einrichten und konfigurieren

<ph type="x-smartling-placeholder"></ph> Sie sehen die Dokumentation zu Apigee Edge.
Gehen Sie zur Apigee X-Dokumentation. Weitere Informationen

Edge Microgateway Version 2.4.x

Übersicht

Diese Anleitung führt Sie durch die Schritte zum Einrichten einer Edge Microgateway-Instanz und laufen.

Nachdem Sie diese Schritte ausgeführt haben, haben Sie ein vollständig konfiguriertes, funktionierendes Edge Microgateway. eine Installation, die API-Anfragen verarbeiten kann. Sie testen die Einrichtung, indem Sie sichere API-Aufrufe ausführen über Edge Microgateway zu einem Back-End-Ziel. Außerdem lernen Sie, wie Sie einen Spike Arrest hinzufügen, auf das Microgateway.

Dieser Leitfaden ist in folgende Teile gegliedert:

Voraussetzung: Edge Microgateway installieren

Folgen Sie der Anleitung unter Edge installieren Microgateway Wenn Sie die Installation abgeschlossen haben, können Sie die Schritte in dieser .

Wenn Sie die Installation abgeschlossen haben, fahren Sie mit dem nächsten Abschnitt Teil 1: Edge Microgateway konfigurieren fort.

Teil 1: Edge konfigurieren Mikrogateway

In diesem Teil konfigurieren Sie Edge Microgateway über einen Befehlszeilenbefehl. um mit Apigee Edge zu kommunizieren. Wenn Sie Apigee Edge Cloud verwenden, folgen Sie die Konfigurationsschritte für Apigee Edge Cloud. Wenn Sie auf Apigee Private Cloud: Folgen Sie den Schritten für Apigee Edge Private Cloud

Konfigurationsschritte für Apigee Edge Cloud

Führen Sie die folgenden Schritte aus, um Edge Microgateway mit Apigee Edge Cloud zu verwenden:

  1. Initialisieren Sie Edge Microgateway, falls Sie dies noch nicht getan haben (Sie müssen dies nur tun, einmalig Schritt):
    edgemicro init
  2. Optional: Drucken Sie Hilfe für den Befehl edgemicroconfigure:
    edgemicro configure -h
  3. Führen Sie den folgenden Befehl aus, um Edge Microgateway zu konfigurieren:
    edgemicro configure -o [org] -e [env] -u [username]

    Wobei:

    • org ist der Name Ihrer Edge-Organisation (Sie müssen ein Organisationsadministrator).
    • env ist eine Umgebung in Ihrer Organisation, z. B. „test“ oder prod).
    • username ist die mit Ihrem Apigee-Konto.

Beispiel

edgemicro configure -o docs -e test -u jdoe@example.com

Ausgabe

./edgemicro configure -o docs -e test -u jdoe@apigee.com
password:
current nodejs version is v6.1.0
current edgemicro version is 2.2.3-beta
password:
file doesn't exist, setting up
Give me a minute or two... this can take a while...
App edgemicro-auth deployed.
creating vault
adding private_key
adding public_key
configuring host edgemicroservices-us-east-1.apigee.net for region us-east-1

saving configuration information to: /Home/.edgemicro/wwitman-test-config.yaml

vault info:
 -----BEGIN CERTIFICATE-----
MIICpDCCAYwCCQCaDpaTttaDANBgkqhkiG9w0BAQsFADAUMRIwEAYDVQQDEwls
b2NhbGhvc3QwHhcNMTYxAxMjA0NzIyWhcNMTYxMTAyMjA0NzIyWjAUMRIwEAYD
VQQDEwlsb2NhbGhvcwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDA
YbtbsFe50GgBrI8QTih5yzxxxvCfdubGrLWmovwwCCFthno3u8lS54ekOL9jQu
JTJsocJfNhZxvnXifDsCk5Muwx87Z/D0BYLw9ZhM8TMyA2MCkXgC6RfKT69IdJ
jT3X+3D0s+apr3lACsDhgOfaeQfeHAm1SSwH/VemaJqdImGkQMtM8uscMDwG6k
vBbCSNS+hh6ZH1m3tAkcKXqvj/E1hbrHNTWr+uiYFRByUzeo1I607daQD4Lxid
il4Ng3hr3LC1gEzvobWgVyhQ2ovYB57T886H7dGghTnOUxLm2y/TwmQya+44SL
JSsDwauArMF38cRKZZ7VAgMBAAEwDQYJKoZIhvcNAQELBQADEBAHwwu+gOn8Tq
jKOYBTXtOX11HPMTxmyvZ/I57R4roE7Z/lXg/DXwbiFpFG2uamXNKq7yTDJH2i
iiqdERZOGfv7TJMjRlxEnfVHoCV7UKguKq4zeeAEU2x55yFwpWNrarx0kMXRwI
v3WgGfo2bimFQrCjDCNIkDKmYYt4SXIF5zUJmBWPCaK9aJoQb7ARXQO9s2zoOI
XZ5bCUDbehQZ+6LyqC0hgDXiIZYy7R0j93yCbQgoHaHUMEprJEEjE24SHdsWBO
nxGZxB20JLq5AHTm8lbZp7XtvbU0jVpxyrBo2/olFnmpvBVOq9eIp042IVD7nT
J4rPejdK6C4=
-----END CERTIFICATE-----

The following credentials are required to start edge micro
  key: e88ec9d5da17cd88ca338d532b7c7a8c4f43ddd3da139d95955ab345af30352d
  secret: d7f64854eb6889d06b809dd7c161dba5eeba4a2657277fd819921bf992221a8f

edgemicro configuration complete!

Konfigurationsschritte für die Apigee Private Cloud

Führen Sie die folgenden Schritte aus, um Edge Microgateway mit Apigee Private Cloud zu verwenden:

  1. Hilfeinformationen für edgemicro private drucken konfigurieren. Sie können Hilfe auf diese Weise für jede Edge Microgateway-Befehlszeile ausgeben Befehl oder Befehlsoption. 
    edgemicro private configure -h
  2. Führen Sie folgenden Befehl aus: Sie erfordert Standardinformationen zu Ihrem Apigee Edge Private Cloud-Konto: Organisationsname, Umgebungsname, Nutzername (E-Mail-Adresse), Passwort, die IP-Adresse des Verwaltungsservers und des Routers. Sie müssen ein Edge-Organisationsadministrator sein, um diese Funktion zu verwenden Befehl: 
    edgemicro private configure -o [org] -e [env] -u [username] -r [runtime_url] -m [mgmt_url] -v [virtual_host]

    Wobei:

    • org ist der Name Ihrer Edge-Organisation (Sie müssen ein Organisationsadministrator).
    • env ist eine Umgebung in Ihrer Organisation, z. B. „test“ oder prod).
    • runtime_url ist die Laufzeit-URL für Ihre private Cloud-Instanz.
    • mgmt_url ist die URL des Verwaltungsservers für Ihre private Cloud-Instanz.
    • username ist die mit Ihrem Apigee-Konto.
    • virtual_host ist eine durch Kommas getrennte Liste von virtuellen Hosts Namen. Die Standardwerte sind default,secure

Beispiel

edgemicro private configure -o docs -e test -u jdoe@example.com -r http://192.162.52.106:9001 -m http://192.162.52.106:8080 -v default

Wenn Sie den virtuellen Host-Alias myorg-test.mycompany.com haben, verwenden Sie einen Befehl wie diesen:

edgemicro private configure -o docs -e test -u jdoe@example.com -r myorg-test.mycompany.com -m http://192.162.52.106:8080 -v default

Ausgabe

delete cache config
checking for previously deployed proxies
configuring edgemicro internal proxy
deploying edgemicro internal proxy
deploying  edgemicro-auth  app
copy auth app into tmp dir
copy config into tmp deer
Give me a minute or two... this can take a while...
App edgemicro-auth added to your org. Now adding resources.

checking org for existing vault creating vault adding private_key adding public_key
configuring host http://192.168.52.106:9001 for region dc-1

saving configuration information to: /Users/ApigeeCorporation/.edgemicro/jdoe-test-config.yaml 
vault info: 
-----BEGIN CERTIFICATE----- 
MIICpDCCAYwCCQDpIvWlpaZJGDANBgkqhkiG9w0BAQFADAUMRIwEAYDVQQDEwls 
b2NhbGhvc3QwHhcNMTYwNDA3MTcxNTM5WhcNMTYwND4MTcxNTM5WjAUMRIwEAYD 
VQQDEwlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEBAUAA4IBDwAwggEKAoIBAQD3 
OAQ+kf5FH0S0yuj05ITqUODuUJspBPberRMbqOZYHcFswhB0Yvg6JKWxKWBDP9o 
Xl96dtgH7xPFRqIU0zI452jkMQ1fPz2mSaGwik245yfBku7olooXKRKTRKOUoXa 
q3Hld/RPxGSsWtiyyYtKex7tuFdq0Knm1EhowdTRGIgjNvudeYMka/XPRXuykhd 
xIDxWj4rdX+4GPx9qT2eTQC5nOAC7XHVL7ys4KqsAiv28vw10u400KstFFS8Qho 
7FaE0bOKLolKKadKyA60ha1XIw/uSTD6ZQFWQ+XM3OaRbXePWXnSZioSxXcZT7L 
hMUKbsRXw/TCvRB51LgNAgMBAAEwDQYJKoZIhvcNAQELBQADgEBAOuR1OmE/W6j 
gRAarJB5EQuTEpI/9Zpg5c5RAGjzLhkazsycn7pal+IymUjCV7D0oIxTVuTM8ZZ 
57kR5hF/C1ZypDN9i+KGP2ovX8WOCCXYtIQECgZPB/L/7/k7BDuKN4vFBvWUe3X 
s2oyjnVWy+ASqsW8gHfj8ekhe22bP240Oqkbyg9SZP9ol1tvJX6+M0thYwcTwAd 
ft929Icey/MOTQC0jB2qm0gnIx/7KInFXfS5KoFRJoGrWDeckr3RdBo2LhnPaeZ 
1gPYIqphZ3HfisF5KlBXoR8oT/Ilym/nq5COlv+3L4tMIk18F7BQZB60SRazifz 
pFkIxepyr/0= 
-----END CERTIFICATE----- 

The following credentials are required to start edge micro 
   key: a3f8f3dfe39158fc3c50b274f0af2234246e0d5f6ea4dd09389b645147151ba3 
   secret: 3e9904802fb3c0e8ca408128a11119cf13546d54dac30ace944c097a726a1263

edgemicro configuration complete!

Installation überprüfen

Führen Sie den folgenden Befehl aus, um die Installation zu überprüfen. Wenn keine Fehler gemeldet werden, ist alles eingerichtet. sodass Sie das Edge Microgateway erfolgreich starten können. 

edgemicro verify -o [org] -e [env] -k [key] -s [secret]

Wobei:

  • org ist der Name Ihrer Edge-Organisation (Sie müssen eine Organisation sein) Administrator).
  • env ist eine Umgebung in Ihrer Organisation, z. B. „test“ oder prod).
  • key ist der Schlüssel, der zuvor vom „configure“ zurückgegeben wurde. .
  • secret ist der Schlüssel, der zuvor vom „configure“ zurückgegeben wurde. .

Beispiel

edgemicro verify -o docs -e test -k 93b01fd21d86331459ae52f664ae9aeb13eb94767ce40a4f621d172cdfb7e8e6 -s c8c755be97cf56c21f8b0556d7132afbd03625bbd85dc34ebfefae4f23fbcb3c

Informationen zur Konfiguration

Die gesamte bisherige Konfiguration ermöglicht es Edge Microgateway, sich selbst mit Apigee zu starten Edge Nach dem erfolgreichen Bootstrapping ruft Edge Microgateway eine Nutzlast Konfigurationsinformationen von Apigee Edge.

Wofür werden diese Konfigurationsinformationen verwendet? Wie wir im nächsten Teil erfahren werden, Edge Microgateways muss beim Start eine Liste spezieller Edge- Microgateway-fähige API-Proxys von Apigee Edge Im nächsten Teil dieser Anleitung einen Microgateway-fähigen Proxy zu erstellen. Edge Microgateway beschränkt Clients auf den Aufruf nur der APIs vor diesen Microgateway-fähigen API-Proxys und Clients sind (standardmäßig) erforderlich, stellen Sie für jeden Aufruf ein gültiges Sicherheitstoken bereit. Weitere Informationen zu diesen Proxys finden Sie unter "Was „Welche was Sie über Edge Microgateway-Proxys wissen müssen“.

Als Edge-Organisationsadministrator möchten Sie sicher wissen, dass Edge Microgateway-fähige Proxys vom die zu Edge-Produkten hinzugefügt wurden, genau wie alle anderen Proxys. Durch die Nutzung von Produkten und können Sie clientseitige Sicherheitstokens generieren, um den Zugriff auf APIs zu steuern, die über Edge Microgateway. Auch hier sind die beteiligten Muster identisch mit der Arbeit mit API-Proxys, und Entwickler-Apps auf Apigee Edge. Wenn du dich über Produkte informieren möchtest, beginne mit Was ist ein API-Produkt? in Edge Dokumentation.

Als Nächstes sehen wir uns an, wie Sie Edge Microgateway-kompatible Proxys erstellen, und danach Edge Microgateway starten und die Einrichtung testen.

Teil 2: Entitäten erstellen auf Apigee Edge

In diesem Teil erstellen Sie die folgenden Entitäten in Edge:

  • Ein microgateway-aware Proxy – Dies ist eine spezielle Proxy, den Edge Microgateway beim Start erkennen kann. Proxys, die Mikrogateways nutzen, haben ein Namenskonvention, die Sie einhalten müssen: Der Name muss mit edgemicro_. Für Beispiel: edgemicro_hello oder edgemicro_userinfo. Beim Start von Edge Microgateway ruft es von Edge eine Liste mit Microgateway-fähigen Proxys von dieselbe Edge-Organisation und -Umgebung, die Sie beim Start von Edge angegeben haben Microgateway.

    Für jeden Microgateway-fähigen Proxy ruft Edge Microgatway die Ziel-URL des Proxys ab und und ihren Basispfad. Microgateway-fähige Proxys bieten auch eine bequeme Möglichkeit, Analysen zu verknüpfen Daten, die von Edge Microgateway mit einem Proxy auf der Edge-Plattform generiert wurden. Als Microgateway API-Aufrufe verarbeitet, überträgt es Analysedaten asynchron an Edge. Nun werden Analytics-Daten angezeigt. in der Edge Analytics-Benutzeroberfläche unter den Microgateway-fähigen Proxynamen, wie es auch bei anderen Proxy.
  • Eine Produkt-, Entwickler- und Entwickler-App: Edge Microgateway verwendet , um die Sicherheit von OAuth2-Zugriffstokens oder API-Schlüsseln zu aktivieren. Beim Start von Edge Microgateway werden alle Produktkonfigurationen von Ihrem Apigee heruntergeladen Edge-Organisation. Es verwendet diese Informationen, um API-Aufrufe zu überprüfen, die über Edge Microgateway getätigt werden mit API-Schlüsseln oder OAuth2-Zugriffstokens.

Weitere Informationen: Siehe auch Was was Sie über Edge Microgateway-kompatible Proxys wissen müssen“.

1. Erstellen einen Edge Microgateway-fähigen API-Proxy in Edge

  1. Melden Sie sich in Ihrer Organisation in Apigee Edge an.
  2. Klicken Sie auf ZUR KLASSISCH WECHSELN, um die klassische Edge-Benutzeroberfläche aufzurufen.
  3. Wählen Sie APIs > API-Proxys aus.
  4. Klicken Sie auf der Seite API-Proxys auf + API-Proxy.
  5. Wählen Sie im Assistenten zum Erstellen eines Proxys die Option Reverse proxy (am häufigsten) aus.
  6. Klicken Sie auf Weiter.
  7. Konfigurieren Sie die Konfiguration auf der Seite „Details“ des Assistenten wie folgt. Assistenten ausfüllen Genau wie hier gezeigt:
    • Proxy-Name: edgemicro_hello
    • Proxy-Basispfad: /hello
    • Vorhandene API: http://mocktarget.apigee.net/
  8. Klicken Sie auf Weiter.
  9. Wählen Sie auf der Seite „Sicherheit“ des Assistenten Pass through (none) aus.
  10. Klicken Sie auf Weiter.
  11. Übernehmen Sie auf der Seite Virtual Hosts (Virtuelle Hosts) des Assistenten die Standardeinstellungen.
  12. Klicken Sie auf Weiter.
  13. Überprüfen Sie auf der Build-Seite des Assistenten Ihre Proxy-Einstellungen. Achten Sie darauf, die Test-Umgebung ausgewählt ist.
  14. Klicken Sie auf Build and Deploy (Erstellen und bereitstellen).

2. Produkt erstellen

Erstellen Sie ein Produkt, das zwei Proxys enthält:

  • Ihr Microgateway-kompatibler Proxy: edgemicro_hello
  • Der von Edge installierte Authentifizierungs-Proxy Microgateway: edgemicro-auth.
  1. Gehen Sie in der Edge-Benutzeroberfläche (klassische Version) zu Veröffentlichen > Produkte:
  2. Klicken Sie auf der Seite „Produkte“ auf + Produkt. Geben Sie die Produktdetails ein wie folgt aussehen: <ph type="x-smartling-placeholder">
      </ph>
    • Name:EdgeMicroTestProduct
    • Anzeigename:EdgeMicroTestProduct
    • Umgebung:test und prod
    • Zugriff: Öffentlich
    • Schlüsselgenehmigungstyp:Automatisch
    • Ressourcen: <ph type="x-smartling-placeholder">
        </ph>
      • API-Proxy: Wählen Sie edgemicro_hello aus.
      • Version: 1
      • Ressourcenpfad: /**
  3. Klicken Sie auf Ressource importieren.
  4. Klicken Sie unter „Ressourcen“ auf + API-Proxy.
  5. Wählen Sie edgemicro-auth aus.
  6. Klicken Sie auf Speichern.

3. Optional: Erstellen Sie ein Testentwickler

Für diese Anleitung können Sie einen beliebigen Entwickler für den nächsten Schritt verwenden. für die Erstellung einer Entwickler-App. Wenn Sie möchten, können Sie jetzt einen Testentwickler erstellen:

  1. Klicken Sie auf Veröffentlichen > Entwickler:
  2. Klicken Sie auf der Seite „Produkte“ auf + Entwickler.
  3. Füllen Sie das Dialogfeld aus, um einen Testentwickler zu erstellen.

4. Entwickler-App erstellen

Sie verwenden die Clientanmeldedaten dieser Anwendung, um sichere API-Aufrufe über Edge Microgateway:

  1. Klicken Sie auf Veröffentlichen > Entwickler-Apps.
  2. Klicken Sie auf der Seite „Entwickler-Apps“ auf + Entwickler-App.
  3. Füllen Sie die Developer App-Seite wie folgt aus: <ph type="x-smartling-placeholder">
      </ph>
    1. Name:EdgeMicroTestApp
    2. Anzeigename:EdgeMicroTestApp
    3. Entwickler:Wenn Sie einen Testentwickler erstellt haben, wählen Sie ihn aus. Oder Sie Sie können für diese Anleitung einen beliebigen Entwickler verwenden.
    4. Anmeldedaten: <ph type="x-smartling-placeholder">
        </ph>
      1. Wählen Sie „Ablaufdatum“: Nie aus.
      2. Klicken Sie auf + Produkt und Wählen Sie EdgeMicroTestProduct aus (das Produkt, das Sie gerade erstellt)
  4. Klicken Sie auf Speichern.
  5. Sie befinden sich jetzt wieder auf der Seite mit der Liste der Entwickler-Apps.
  6. Wählen Sie die App aus, die Sie gerade erstellt haben: EdgeMicroTestApp.
  7. Klicken Sie neben dem Feld Nutzerauf Key und Consumer-Secret.

Teil 3: Edge Microgateway betreiben

Nachdem Sie nun ein konfiguriertes Edge Microgateway und mindestens ein Edge Microgateway-fähiges Gateway haben, Proxy auf Edge, ist es an der Zeit, Edge Microgateway zu starten. Ein Edge Microgateway-HTTP-Server wird ausgeführt auf Ihrem lokalen Computer ausführen und Sie führen API-Aufrufe direkt an diesen Server.

1. Edge Microgateway starten

Edge mit dem Befehl edgemicro start starten Microgateway.

  1. Achten Sie darauf, dass Sie die Schlüssel haben, die bei der Ausführung zurückgegeben wurden. den Befehl edgemicroconfigure. Diese Ausgabe sah in etwa so aus: dies: 
    You need key and secret while starting edgemicro instance

key: da4778e7c240a5d4585fc559eaba5083328828ac9f3a7f583e8b73e
secret: 3aad7439708b4aeb38ee08e87189921ad00e6fc1ba8a8ae9f929ee2
  2. Optional: Drucken Sie Hilfeinformationen zum Befehl edgemicro start.
    edgemicro start -h
  3. Führen Sie den folgenden Befehl aus, um Edge Microgateway zu starten: 
    edgemicro start -o [org] -e [env] -k [key] -s [secret]

    Wobei:

    • org ist der Name Ihrer Edge-Organisation (Sie müssen ein Organisationsadministrator).
    • env ist eine Umgebung in Ihrer Organisation, z. B. „test“ oder prod).
    • key ist der Schlüssel, der zuvor vom „configure“ zurückgegeben wurde. .
    • secret ist der zuvor vom config-Befehl ausführen.

    Beispiel

    edgemicro start -o docs -e test -k 701e70e718ce6dc1880616b3c39177d64a88754d615c7a4e1f78b6181d000723 -s 05c14356e42d136b83dd135cf8a18531ff52d7299134677e30ef4e34ab0cc824

    Ausgabe

    Mit dem Startbefehl werden viele Konfigurationsinformationen von Apigee Edge abgerufen, zum Terminal-Fenster scrollt). In der Ausgabe sehen Sie eine Liste Proxys und Produkte, die gefunden wurden. Am Ende der Ausgabe sollten Sie etwas sehen, wie hier:

    ...

PROCESS PID : 9757
installed plugin from analytics
installed plugin from oauth
eb725020-a2b0-11e6-8a52-6de156e3a6e2 edge micro listening on port 8000
installed plugin from analytics
installed plugin from oauth
installed plugin from analytics
installed plugin from oauth
installed plugin from analytics
installed plugin from oauth
eb77ce60-a2b0-11e6-8a88-b96278c0c198 edge micro listening on port 8000
eb78b8c0-a2b0-11e6-bf36-717b986c91fe edge micro listening on port 8000
eb77f570-a2b0-11e6-883e-472b9104351e edge micro listening on port 8000

Was ist passiert?

Suchen Sie das Terminal, auf dem Sie den Befehl edgemicro config ausgeführt haben. Wenn Sie durch die Standardausgabe nach oben scrollen, sehen Sie, dass der Befehl eine Nutzlast von Edge Microgateway-Konfigurationsinformationen von Apigee Edge Zu diesen Informationen gehören:

  • Der öffentliche Schlüssel, den wir zuvor erstellt und in einer verschlüsselten Key Value Map (KVM) gespeichert haben.
  • Eine JSON-Darstellung aller Edge Microgateway-fähigen Proxys, die im Organisation/Umgebung. Dies sind alles Proxys, die mit dem edgemicro_ voranstellen.
  • Eine JSON-Darstellung aller API-Produkte, die in der Organisation/Umgebung.

Mit diesen Informationen weiß Edge Microgateway, welche Proxys und Proxy-Pfade es ausführen darf . Die Produktinformationen werden verwendet, um die Sicherheit zu gewährleisten (genau wie bei jeder anderen API). auf Apigee Edge, wo Entwickler-App-Schlüssel eine Verknüpfung mit Produkten haben). Wir gehen die Schritte zum Sichern von Edge Microgateway.

2. Edge Microgateway testen

Wenn Edge Microgateway ausgeführt wird, können Sie den Proxy aufrufen. Die Konfiguration für Der Proxy edgemicro_hello wurde von Edge heruntergeladen, als du die Anwendung gestartet hast. Edge Microgateway. Denken Sie daran, dass der Proxy-Basispfad /hello ist.

Um Edge Microgateway zu testen, beginnen wir mit dem Basispfad und fügen eine Ressource hinzu Pfad /echo. Beachten Sie, dass alles nach dem Basispfad (einschließlich Abfrage -Parameter) wird einfach an das Back-End-Ziel weitergegeben:

curl -i http://localhost:8000/hello/echo
{"error":"missing_authorization","error_description":"Missing Authorization header"}

Der Fehler tritt auf, weil Sie mit der Anfrage keinen gültigen API-Schlüssel oder kein Zugriffstoken gesendet haben. Von Standardmäßig erfordert Edge Microgateway bei jedem API-Aufruf entweder einen API-Schlüssel oder ein Zugriffstoken. In Im nächsten Schritt der Anleitung werden wir diese API ordnungsgemäß sichern und Ihnen zeigen, wie Sie ein gültiges Zugriffs-Token verwenden und der Anfrage hinzufügen.

4. Edge Microgateway beenden

  1. Führen Sie in einem separaten Terminalfenster cd in denselben Verzeichnis, in dem Sie Edge Microgateway gestartet haben.
  2. Geben Sie den Befehl „stop“ ein:
    edgemicro stop

Teil 4: Secure Edge Mikrogateway

Sie können API-Aufrufe über Edge Microgateway mit einem API-Schlüssel oder einem Zugriff sichern Token.

Sichere API-Aufrufe mit ein OAuth2-Zugriffstoken

So authentifizieren Sie API-Aufrufe mit einem OAuth2-Zugriffstoken:

1. Erforderliche Schlüssel abrufen

  1. Navigieren Sie in der Edge-Benutzeroberfläche wie beschrieben zu der Entwickler-App, die Sie zuvor erstellt haben. in Teil 2: Entitäten in Apigee Edge erstellen. Der Name der App lautete EdgeMicroTestApp.
  2. Zeigen Sie auf der Seite der Developer App den Consumer Key und das Consumer Secret an und kopieren Sie . Diese Werte sind erforderlich, um im nächsten Schritt Schritt.

2. Zugriffstoken abrufen

Es gibt zwei Möglichkeiten, ein Zugriffstoken zu erhalten. Wir zeigen Ihnen beide Methoden.

Zugriffstoken über die Befehlszeile abrufen

Die erste Methode ist praktisch und folgt dem von uns verwendeten Muster. in diesem Tutorial an. Die zweite Methode ist im Allgemeinen nützlicher für Client-App-Entwickler, die Tokens anfordern müssen. Der tatsächliche Tokenendpunkt wird in Den Proxy edgemicro-auth, der bei der Konfiguration von Edge bereitgestellt wurde Microgateway.

  1. Optional: Hilfe zum Befehl token get anzeigen: 
    edgemicro token get -h
  2. Generieren Sie das Token und ersetzen Sie dabei Ihre Werte für Consumer Key und Consumer Secret aus der Entwickler-App, die Sie in Apigee Edge erstellt haben, Parameter -i und -s: 
    edgemicro token get -o [org] -e [env] -i [consumer_key] -s [consumer_secret]

    Wobei:

    • org ist der Name Ihrer Edge-Organisation (Sie müssen ein Organisationsadministrator).
    • env ist eine Umgebung in Ihrer Organisation, z. B. „test“ oder prod).
    • consumer_id ist die Verbraucher-ID in der Entwickler-App die Sie zuvor erstellt haben.
    • consumer_secret ist das Consumer-Secret im Entwickler-App, die Sie zuvor erstellt haben.

    Beispiel

    edgemicro token get -o docs -e test -i G0IAeU864EtBo99NvUbn6Z4CBwVcS2 -s uzHTbwNWvoSmOy

    Ausgabe (Beispiel)

    current nodejs version is v4.4.4
{ token: 'eyJ0eXAiOiJKV1QiLCJhbGciSUzI1NiJ9.eyJhcHBsaWNhdGl
vbl9uYW1lIjoiNWNiMGY0tOWMzOC00YmJjLWIzNzEtZGMxZTQzOGYxZGMxI
iwiY2xpZW50X2lkIjoiNVVdBWEdvSU9lbzYwYWV3OTRQN0c1TUFaRTNhSnA
iLCJzY29wZXMiOltdLCJhcGlfcHJvjdF9saXN0IjpbIkVkZ2VNaWNyb1Rlc
3RQcm9kdWN0IlmlhdCI6MTQ3ODIwODMzMiwiZXhwIjoxNDc4MjEwMTMxfQ.
v3Q8Rs0W9FO_XpERwIAMMXhjGamRmmmWgrAy1wJv0-99oajx5ASI5qjNubM
nCF14xxwlVXHcz1VfedA8Nx7Ih145zhWWuPKL9muzhXXnVBRFeBMeeLqJk4
QQ7Bhst7xH_68nJSTE20Egu95DHOCUemfrepDFH0VggY4BmzvwLkBNfz_te
E_YqwKZbpGOLMdKK1vMk0fk0x19SieIMS_aJYeOAklrzUhnFxWJFrsAWsax
NLx_BbQcZzYfK1JSDUrhRNVBuPHMnGjNA_oHw2J4qa6Hsp62PfchG-DIW_t
-0BFnYf3rYXmqyNORqFrOMdl4VxqQ' }

Optional: Token mit der API abrufen

Wenn Sie es gewohnt sind, Edge-Proxys mit curl oder einem anderen HTTP-Client aufzurufen, dass Sie den Tokenendpunkt direkt aufrufen können, den Befehl edgemicro token. Hier ist ein curl-Beispiel. Nur ersetzen Ihre Organisations- und Umgebungsnamen in die URL ein und übergeben Sie den durch einen Doppelpunkt getrennten Verbraucherschlüssel:Consumer Secret-Werte in einem Basisauthentifizierungs-Header:

curl -i -X POST "http://[org]-[env].apigee.net/edgemicro-auth/token" -d '{ "client_id": "your consumer key", "client_secret": "your consumer secret", "grant_type": "client_credentials" }' -H "Content-Type: application/json"

Wobei:

  • org ist der Name Ihrer Edge-Organisation (Sie müssen eine Organisation sein) Administrator).
  • env ist eine Umgebung in Ihrer Organisation, z. B. „test“ oder prod).
  • client_id ist die Verbraucher-ID in der Entwickler-App, die du die zuvor erstellt wurden.
  • client_secret ist das Consumer-Secret im Entwickler Zuvor erstellte App.

Ausgabe (Beispiel)

Unabhängig davon, ob Sie den CLI-Befehl edgemicro token oder wird der Endpunkt mit curl aufgerufen und gibt ein signiertes Zugriffstoken zurück, mit dem Client Anrufe. Etwa so:

MIICpDCCAYwCCQDpIvWlpaZJGDANBgkqhkiG9w0BAQFADAUMRIwEAYDVQQDEwls 
b2NhbGhvc3QwHhcNMTYwNDA3MTcxNTM5WhcNMTYwND4MTcxNTM5WjAUMRIwEAYD 
VQQDEwlsb2NhbGhvc3QwggEiMA0GCSqGSIb3DQEBAUAA4IBDwAwggEKAoIBAQD3 
OAQ+kf5FH0S0yuj05ITqUODuUJspBPberRMbqOZYHcFswhB0Yvg6JKWxKWBDP9o 
Xl96dtgH7xPFRqIU0zI452jkMQ1fPz2mSaGwik245yfBku7olooXKRKTRKOUoXa 
q3Hld/RPxGSsWtiyyYtKex7tuFdq0Knm1EhowdTRGIgjNvudeYMka/XPRXuykhd 
xIDxWj4rdX+4GPx9qT2eTQC5nOAC7XHVL7ys4KqsAiv28vw10u400KstFFS8Qho 
7FaE0bOKLolKKadKyA60ha1XIw/uSTD6ZQFWQ+XM3OaRbXePWXnSZioSxXcZT7L 
hMUKbsRXw/TCvRB51LgNAgMBAAEwDQYJKoZIhvcNAQELBQADgEBAOuR1OmE/W6j 
gRAarJB5EQuTEpI/9Zpg5c5RAGjzLhkazsycn7pal+IymUjCV7D0oIxTVuTM8ZZ 
57kR5hF/C1ZypDN9i+KGP2ovX8WOCCXYtIQECgZPB/L/7/k7BDuKN4vFBvWUe3X 
s2oyjnVWy+ASqsW8gHfj8ekhe22bP240Oqkbyg9SZP9ol1tvJX6+M0thYwcTwAd 
ft929Icey/MOTQC0jB2qm0gnIx/7KInFXfS5KoFRJoGrWDeckr3RdBo2LhnPaeZ 
1gPYIqphZ3HfisF5KlBXoR8oT/Ilym/nq5COlv+3L4tMIk18F7BQZB60SRazifz 
pFkIxepyr/0=

3. Konfiguration in Edge Microgateway prüfen

  1. Öffnen Sie die Datei. ~/.edgemicro/org-env-config.yaml. Siehe auch Wo Edge Microgateway installiert ist.
  2. Achten Sie darauf, dass diese Eigenschaften des OAuth-Plug-ins auf false festgelegt sind. Sie sind ist standardmäßig auf "false" gesetzt. Sie sollten aber überprüfen, ob folgende Voraussetzungen erfüllt sind: 
    oauth:
   allowNoAuthorization: false
   allowInvalidAuthorization: false
  3. Achten Sie außerdem darauf, dass das OAuth-Plug-in in der Datei org-env-config.yaml wird dem plugins:sequence-Element hinzugefügt: 
    plugins:
   dir: ../plugins
   sequence:
   - oauth
  4. Änderungen an der Datei aktualisieren in den Ordner die eine Edge Microgateway-Instanz ausführt. Dieser Befehl konfiguriert Edge Microgateway mit ohne Ausfallzeiten: 
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    Wobei:

    • org ist der Name Ihrer Edge-Organisation (Sie müssen ein Organisationsadministrator).
    • env ist eine Umgebung in Ihrer Organisation, z. B. „test“ oder prod).
    • key ist der Schlüssel, der zuvor vom „configure“ zurückgegeben wurde. .
    • secret ist der zuvor vom config-Befehl ausführen.

    Beispiel

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d

4. API sicher aufrufen

Mit einem Zugriffstoken können Sie jetzt den API-Aufruf sicher ausführen. Beispiel:

  curl -i -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhcHBsaWNhdGlvbl
9uYW1lIjoiYmU2YmZjYjAtMWQ0Ni00Y2IxLWFiNGQtZTMxNzRlNTAyMDZkIiwiY2xpZW50X2lkIjoiOGxTTTVIRHdyM
VhIT1ZwbmhURExhYW9FVG5STVpwWk0iLCJzY29wZXMiOltdLCJhcGlfcHJvZHVjdF9saXN0IjpbIk1pY3JvZ2F0ZXdh
eVRlQcm9kdWN0Il0sImCI6MTQzNTM0NzY5MiwiZXhwIjoxNDM1MzQ5NDkxfQ.PN30Y6uK1W1f2ONPEsBDB_BT31c6
IsjWGfwpz-p6Vak8r767tAT4mQAjuBpQYv7_IU4DxSrnxXQ_q536QYCP4p4YKfBvyqbnW0Rb2CsPFziy_n8HIczsWO
s0p4czcK63SjONaUpxV9DbfGVJ_-WrSdqrqJB5syorD2YYJPSfrCcgKm-LpJc6HCylElFDW8dHuwApaWcGRSV3l5Wx
4A8Rr-WhTIxDTX7TxkrfI4THgXAo37p3au3_7DPB_Gla5dWTzV4j93xLbXPUbwTHzpaUCFzmPnVuYM44FW5KgvBrV0
64RgPmIFUxSqBWGQU7Z1w2qFmWuaDljrMDoLEreI2g" http://localhost:8000/hello/echo

Die API gibt Header und andere Informationen vom simulierten Server zurück.

API sichern mit einem API-Schlüssel

Wenn Sie einen API-Schlüssel für die Autorisierung verwenden möchten, gehen Sie so vor:

1. API-Schlüssel abrufen

  1. Navigieren Sie in der Edge-Benutzeroberfläche wie beschrieben zu der Entwickler-App, die Sie zuvor erstellt haben. in Teil 2: Entitäten in Apigee Edge erstellen. Der Name der App lautete EdgeMicroTestApp.
  2. Zeigen Sie auf der Seite der Entwickler-App den Consumer-Key an und kopieren Sie ihn. Dieser Wert ist den API-Schlüssel. Sie verwenden diesen Schlüssel für authentifizierte API-Aufrufe.

2. Konfiguration in Edge Microgateway prüfen

  1. Öffnen Sie die Datei. ~/.edgemicro/org-env-config.yaml. Siehe auch Wo Edge Microgateway installiert ist.
  2. Achten Sie darauf, dass diese Eigenschaften des OAuth-Plug-ins auf false festgelegt sind. Sie sind ist standardmäßig auf "false" gesetzt. Sie sollten aber überprüfen, ob folgende Voraussetzungen erfüllt sind: 
    oauth:
   allowNoAuthorization: false
   allowInvalidAuthorization: false
  3. Achten Sie außerdem darauf, dass das OAuth-Plug-in in der Datei org-env-config.yaml wird dem plugins:sequence-Element hinzugefügt: 
    plugins:
   dir: ../plugins
   sequence:
   - oauth
  4. Änderungen an der Datei aktualisieren in den Ordner die eine Edge Microgateway-Instanz ausführt. Dieser Befehl konfiguriert Edge Microgateway mit ohne Ausfallzeiten: 
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    Wobei:

    • org ist der Name Ihrer Edge-Organisation (Sie müssen ein Organisationsadministrator).
    • env ist eine Umgebung in Ihrer Organisation, z. B. „test“ oder prod).
    • key ist der Schlüssel, der zuvor vom „configure“ zurückgegeben wurde. .
    • secret ist der zuvor vom config-Befehl ausführen.

    Beispiel

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d

3. API mit einem API-Schlüssel sicher aufrufen

Rufen Sie die API mit dem Header x-api-key wie folgt auf: Consumer Key ist der API-Schlüssel, den Sie aus der Entwickler-App kopiert haben. Standardmäßig erwartet Edge Microgateway, um den Schlüssel in einem Header namens x-api-key zu übergeben:

curl -i http://localhost:8000/hello/echo -H "x-api-key: [apikey]"

Wobei:

  • apikey ist der Consumer Key-Wert, der von EdgeMicroTestApp.

Beispiel:


curl -i http://localhost:8000/hello/echo -H 'x-api-key: XsU1R4zGXz2ERxa0ilYQ5szwuljr5bB'

Sie haben jetzt ein voll funktionsfähiges und sicheres Edge Microgateway. Im nächsten Teil der schauen wir uns Plug-ins an, die Edge Microgateway Funktionalität hinzufügen.

Teil 5: Spike Arrest hinzufügen Plug-in

In diesem Teil fügen wir Ihrer Edge-Instanz eine Ratenbegrenzungsfunktion namens Spike Arrest hinzu. Microgateway.

Was sind Plug-ins?

Ein Plug-in ist ein Node.js-Modul, das Edge Microgateway um Funktionen ergänzt. Plug-in-Module einem einheitlichen Muster folgen und an einem Edge Microgateway bekannten Speicherort gespeichert werden. um sie automatisch zu erkennen und zu laden. Weitere Informationen zu Plug-ins finden Sie in der Plug-ins verwenden

Spike Arrest hinzufügen Plug-in

Spike Arrest schützt vor Traffic-Spitzen. Er drosselt die Anzahl der von eine Edge Microgateway-Instanz.

In Edge Microgateway ist Spike Arrest als Plug-in-Modul implementiert. Zur Aktivierung müssen Sie um es der Konfigurationsdatei von Edge Microgateway hinzuzufügen.

  1. Öffnen Sie die Datei. ~/.edgemicro/org-env-config.yaml. Siehe auch Wo Edge Microgateway installiert ist.
  2. Fügen Sie das folgende Element hinzu. Sie können es an einer beliebigen Stelle in der Datei hinzufügen. 
       spikearrest:
      timeUnit: minute   
      allow: 10   
      buffersize: 0
  3. spikearrest hinzufügen zu edgemicro:sequence-Element wie unten gezeigt. Die Sequenz Konfigurationseigenschaft teilt Edge Microgateway mit, in welcher Reihenfolge die Plug-in-Module ausgeführt haben. 
    edgemicro:
  home: ../gateway
  port: 8000
  max_connections: -1
  max_connections_hard: -1
  logging:
    level: info
    dir: /var/tmp
    stats_log_interval: 60
  plugins:
    dir: ../plugins
  sequence:
    - spikearrest
    - oauth
  4. Speichern Sie die Konfigurationsdatei.
  5. Edge Microgateway aktualisieren mit den Befehl reload. Sie müssen diesen Befehl über die in dem Sie Edge Microgateway gestartet haben. 
    edgemicro reload -o [org] -e [env] -k [key] -s [secret]

    Wobei:

    • org ist der Name Ihrer Edge-Organisation (Sie müssen ein Organisationsadministrator).
    • env ist eine Umgebung in Ihrer Organisation, z. B. „test“ oder prod).
    • key ist der Schlüssel, der zuvor vom „configure“ zurückgegeben wurde. .
    • secret ist der zuvor vom config-Befehl ausführen.

    Beispiel

    edgemicro reload -o docs -e test -k 701e70ee718ce6dc188016b3c39177d64a88754d615c74e1f78b6181d
  6. Versuchen Sie, die API mehrmals schnell hintereinander aufzurufen. Nach dem zweiten Anruf Microgateway gibt folgenden Fehler zurück: 
    {"message":"SpikeArrest engaged","status":503}

Der Grund dafür ist, dass Spike Arrest die Anzahl der Anrufe, die über den Zeitraum angegebene Zeiteinheit. In diesem Fall können Sie also zehn Anrufe pro Minute oder einen alle sechs Anrufe tätigen. Sekunden.

Weitere Informationen findest du im Artikel Wie funktioniert ein Spike Arrest? im Artikel Plug-ins verwenden.

Zusatzaufgabe: Kontingent-Plug-in

Nach demselben Muster wie bei der Konfiguration von Spike Arrest können Sie weitere Plug-ins wie das Kontingent-Plug-in. Wie bei Spike Arrest ist das Kontingent-Plug-in in jedem Edge Microgateway enthalten. Installation. Ein Kontingent gibt die Anzahl der Anfragenachrichten an, die eine App senden darf in einem bestimmten Zeitintervall (Minuten oder Stunden) an eine API senden.

Informationen zur Funktionsweise von Kontingenten finden Sie unter Kontingent-Plug-in verwenden. im Artikel Plug-ins verwenden.

Teil 6: Ansehen Analysen in Apigee Edge

Wir haben jetzt eine voll funktionsfähige Edge Microgateway-Instanz. Mal sehen, wie es funktioniert. Standardmäßig wird das Modul des Analyse-Plug-ins zu Edge Micro hinzugefügt. Dieses Modul verschiebt von Edge Micro bis Apigee Edge, wo sie vom Edge Analytics-System verwendet werden. Sehen wir uns das genauer an:

  1. Melden Sie sich in Ihrer Organisation in Apigee Edge an.
  2. Wählen Sie Analytics > Proxy-Leistung.
  3. Wählen Sie im Proxy-Leistungs-Dashboard den Parameter edgemicro_hello Proxy.
  4. Die Grafik zeigt Ihnen Informationen über die Traffic-Muster des Proxys, wie z. B. den gesamten Traffic, durchschnittliche Reaktionszeit, durchschnittliche Zielantwortzeit und mehr.

Weitere Informationen zu Edge Analytics-Dashboards finden Sie auf der Startseite der Analytics-Dashboards in der Edge-Dokumentation Weitere Informationen zu Plug-ins finden Sie unter Plug-ins verwenden.