Edge Microgateway-FAQs

Sie sehen die Dokumentation zu Apigee Edge.
Zur Apigee X-Dokumentation weitere Informationen

Erste Schritte

Wie installiere ich Edge Microgateway?

Siehe Edge Microgateway installieren.

Wie führe ich Edge Microgateway aus?

Weitere Informationen finden Sie unter Edge Microgateway einrichten und konfigurieren.

Benötige ich eine Datenbank, um Microgateway auszuführen?

APIs, die über Edge Microgateway weitergeleitet werden, können mit einer Datenbank interagieren, die als Teil eines Zieldienstes ausgeführt wird. Edge Microgateway funktioniert jedoch unabhängig von einer Datenbank oder einem Back-End-Datenspeicher.

Vorgang

Welche Änderungen in Edge erfordern einen Neustart von Edge Microgateway?

Edge Microgateway fragt Änderungen automatisch ab, die in Apigee Edge vorgenommen wurden, z. B. Änderungen an Mikrogateway-fähigen Proxys, Produkten oder Entwickleranwendungen. Das standardmäßige Abfrageintervall beträgt 600 Sekunden. Sie können es jedoch mit der Konfigurationseinstellung config_change_poll_interval ändern. Siehe Edgemicro-Attribute.

Wenn Sie nicht auf das Abfrageintervall warten möchten, verwenden Sie den Befehl edgemicro reload, um die letzten Änderungen zu übernehmen. Weitere Informationen finden Sie unter Microgateway-Cluster neu laden.

Wie kann ich zwischen einem in Edge bereitgestellten Proxy und einem in Edge Microgateway erstellten Proxy unterscheiden?

Wenn Sie Edge Microgateway konfigurieren, wird eine Liste von Microgateway-fähigen Proxys, die in Apigee Edge bereitgestellt werden, in die lokale Konfiguration von Edge Microgateway heruntergeladen. Microgateway-fähige Proxys sind mit dem Präfix edgemicro_ benannt.

Welche Optionen habe ich für das Logging mit Edge Microgateway?

Edge Microgateway verfügt über ein integriertes Logging-Feature. Weitere Informationen finden Sie unter Logdateien verwalten.

Sie können auch ein benutzerdefiniertes Plug-in schreiben, um den Logging-Dienst eines Drittanbieters mit Edge Microgateway zu verwenden. Aufgrund der Funktionsweise von Edge Microgateway können Sie die Nachrichtenprotokollierungsrichtlinie von Apigee Edge nicht verwenden, um Nachrichten für Edge Microgateway zu protokollieren. Weitere Informationen finden Sie im Community-Artikel Logging-Plug-in für Microgateway.

Kann ich Schlüssel/Secret-Kombinationen zwischen Instanzen von Edge Microgateway wiederverwenden?

Wenn die Organisation und die Umgebung für die Microgateway-Instanzen identisch sind, können Sie das während der Konfiguration generierte Schlüssel/Secret-Paar wiederverwenden.

Wie konfiguriere ich Edge Microgateway für den Start in einer Produktionsumgebung?

Sie können die Umgebungsvariablen für Startbefehlsparameter wie EDGEMICRO_KEY, EDGEMICRO_SECRET, EDGEMICRO_ORG und EDGEMICRO_ENV festlegen. Mit diesen (und anderen) Variablen können Sie Edge Microgateway mit dem einzigen Befehl edgemicro start starten. Weitere Informationen finden Sie unter Umgebungsvariablen festlegen.

Kann ich benutzerdefinierte Attribute für Produkte oder Entwickleranwendungen mit Edge Microgateway verwenden?

Nein. Standardmäßig agiert Edge Microgateway nur bei Attributen, die sich auf einfaches Routing und Sicherheit beziehen. Zur Umgehung dieses Problems haben Sie jedoch folgende Möglichkeiten:

1. Fügen Sie dem edgemicro-auth-Proxy, den Edge Microgateway für Apigee Edge bereitstellt, benutzerdefinierte Attribute hinzu. Diese Attribute sind bei Verwendung der API-Schlüssel- oder OAuth-Tokensicherheit verfügbar.
2. Ändern Sie das OAuth-Plug-in so, dass es auf diese Attribute reagiert.

Gibt es eine Beschränkung für die Größe des Anfrageheaders?

Wenn Sie Node.js auf v8.14.0 oder eine höhere Version upgraden, wurde die maximale Headergröße für Anfragen von 80 KB auf 8 KB reduziert. Header, die 8 KB überschreiten, führen zum HTTP-431-Fehler.

Mit einer in Node.js v11.6.0 hinzugefügten Node.js-Konfigurationsoption können Sie die standardmäßige maximale Headergröße ändern. Mit dem Parameter --max-http-header-size können Sie die maximale Größe von HTTP-Headern in Byte angeben.

Wenn Sie die Standardkonfiguration ändern möchten, legen Sie den Wert der Umgebungsvariablen NODE_OPTIONS in der Befehlszeile so fest:

NODE_OPTIONS=--max-http-header-size=NUM_BYTES

Beispiel:

NODE_OPTIONS=--max-http-header-size=80000

Welche Verwaltungs-APIs verwendet Edge Microgateway?

Bereitstellung

Kann ich Edge Microgateway auf demselben Server bereitstellen, auf dem mein Zieldienst ausgeführt wird?

Ja. Edge Microgateway ist ein einfacher Prozess, der in der Nähe Ihres Zieldienstes ausgeführt werden kann, auch auf demselben Computer.

Kann ich ein vorhandenes Edge-Proxy-Bundle als Edge Microgateway-Bereitstellung bereitstellen?

Nein. Edge Microgateway-fähige Proxys haben bestimmte Anforderungen und unterstützen nicht alle Funktionen regulärer Edge-Proxys. Siehe Teil 2: Entitäten in Apigee Edge erstellen.

Kann ich Failover zwischen einer Bereitstellung eines Edge-Proxy-Bundles und einer Edge Microgateway-Bereitstellung für denselben API-Proxy aktivieren?

Nein. Edge Microgateway weiß nichts über Nicht-Microgateway-API-Proxy-Bereitstellungen in Apigee Edge.

Was ist das Bereitstellungsmodell für Hochverfügbarkeit für Edge Microgateway?

Eine gute Erläuterung zum Ausführen von Edge Microgateway mit NGINX als Load-Balancer finden Sie unter APIs mit Apigee Edge Microgateway und NGINX verwalten.

Welche Load-Balancer kann ich mit Edge Microgateway verwenden?

Edge Microgateway kann mit jedem Load-Balancer verwendet werden.

Ist die Anzahl der Edge Microgateway-Proxys, die ich bereitstellen kann, begrenzt?

Weitere Informationen finden Sie in den Limits für die Produktkonfiguration, die für reguläre Edge-Proxys angegeben sind. Die Anzahl der Microgateway-fähigen Proxys, die Sie in einer Apigee Edge-Organisation und -Umgebung bereitstellen und über Edge Microgateway aufrufen können, muss denselben Limits entsprechen.

Kann ich meine Edge Microgateway-Bereitstellung mit einer bestimmten Organisation und Umgebung verknüpfen?

Wenn Sie eine Instanz von Edge Microgateway konfigurieren, müssen Sie sie mit einer bestimmten Edge-Organisation und -Umgebung verknüpfen.

Kann ich meine Edge Microgateway-Bereitstellung einer bestimmten Region zuordnen (wenn ich ein multiregionaler Kunde bin)?

Edge Microgateway wählt automatisch die beste Region für die Interaktion mit Apigee Edge aus. Sie können Edge Microgateway-Instanzen in jeder Region bereitstellen, die Sie bedienen möchten.

Verwaltung

Muss ich ein Organisationsadministrator sein, um Edge Microgateway zu konfigurieren und bereitzustellen?

Ja. Sie benötigen Anmeldedaten des Organisationsadministrators, um Edge Microgateway zu konfigurieren und bereitzustellen.

Muss ich ein Organisationsadministrator sein, um Edge Microgateway auszuführen?

Nein. Edge Microgateway ist eine Node.js-Anwendung und kann von allen Nutzern mit der Berechtigung zum Ausführen solcher Anwendungen auf einem bestimmten Computer ausgeführt werden.

Können Nutzer in meiner Organisation Edge Microgateway verwenden?

Sie müssen kein Apigee Edge-Organisationsnutzer sein, um API-Aufrufe über Edge Microgateway durchzuführen. Sie benötigen jedoch Berechtigungen auf Organisationsebene, um Edge Microgateway-kompatible Proxys zu erstellen oder zu ändern, die in Edge bereitgestellt werden.

Leistung

Welche Leistungsaspekte gelten bei der Verwendung von Edge Microgateway?

Wenn Edge Microgateway zusammen mit der Zielanwendung ausgeführt wird, prüfen Sie, ob der Server genügend Kapazität hat.

Welche Best Practices gibt es für die skalierte Ausführung von Edge Microgateway?

Apigee empfiehlt, mehrere Instanzen von Edge Microgateway auf verschiedenen Servern auszuführen, die von Load-Balancern wie NGINX unterstützt werden. Weitere Informationen finden Sie in der Apigee-Community unter APIs mit Apigee Edge Microgateway und NGINX verwalten und Vertikale horizontale Skalierung.

Was ist der Edge Microgateway-TPS standardmäßig und welche Hardwareanforderungen sind für eine Microgateway-Instanz erforderlich?

Hardwareanforderungen und TPS-Messungen sind mit Edge Microgateway nur schwer zu messen. Dies hängt von Ihrer Einrichtung ab. Diese ist eine Kombination aus der Feinabstimmung von Edge Microgateway, der Plug-in-Nutzung, benutzerdefinierten Plug-ins und der Konfiguration anderer Dinge wie TLS. Apigee empfiehlt in der Regel, dass Sie sich eine Vorstellung von dieser Kombination von Elementen machen und Leistungstests mit Ihrer spezifischen Einrichtung durchführen.

Private Cloud-Bereitstellung

Funktioniert Edge Microgateway mit Edge for Private Cloud?

Ja. Weitere Informationen finden Sie in den Konfigurationsschritten für Apigee Private Cloud.

Plug‑ins

Wie wird das Kontingent mit Edge Microgateway erzwungen?

Sie können Ihrer Instanz von Edge Microgateway optional ein Kontingent-Plug-in hinzufügen. Weitere Informationen finden Sie unter Kontingent-Plug-in verwenden.

Wie wird Spike Arrest mit Edge Microgateway erzwungen?

Sie können Ihrer Instanz von Edge Microgateway optional ein Spike Arrest-Plug-in hinzufügen. Weitere Informationen finden Sie unter Spitzen-Arrest-Plug-in verwenden.

Gibt es andere Möglichkeiten, Plug-ins als Node.js für Edge Microgateway zu schreiben?

Nein. Plug-ins müssen auf Node.js geschrieben werden.

Was passiert, wenn Edge Microgateway keine Analysedaten in Edge hochladen kann?

Edge Microgateway hat einen speicherinternen Zwischenspeicher. Wenn sich der Puffer füllt, werden ältere Nutzlasten verworfen, damit der API-Traffic reibungslos fließen kann.

Kann ich Edge Microgateway Richtlinien hinzufügen?

Wenn Sie reguläre Apigee Edge-Richtlinien an Microgateway-kompatible Proxys in Apigee Edge anhängen, werden diese ignoriert. Edge Microgateway verwendet stattdessen Plug-ins, um ähnliche Funktionen wie Richtlinien in Edge bereitzustellen, z. B. Kontingent, Spike Arrest, API-Schlüsselsicherheit und OAuth2-Sicherheit. Sie können auch benutzerdefinierte Plug-ins schreiben. Weitere Informationen finden Sie unter Plug-ins verwenden und Benutzerdefinierte Plug-ins entwickeln.

In den folgenden Apigee-Community-Beiträgen und -Blogs werden weitere Plug-in-Anwendungsfälle behandelt:

• So überschreiben Sie die Standard-URL in Edge Microgateway
• Kontingent in Edge Microgateway einrichten
• Logger-Plug-in zu Edge Microgateway hinzufügen

Sicherheit

Wie schütze ich die Ressource /products?

Überblick

Wenn Sie Edge Microgateway konfigurieren, wird ein API-Proxy namens edgemicro-auth in Apigee Edge für Ihre Organisationsumgebung bereitgestellt. Dieser Proxy stellt einen /products-Endpunkt bereit, der eine Liste von API-Produkten zurückgibt. Wenn Sie Edge Microgateway am oder vor dem 5. Oktober 2018 installiert haben, empfiehlt Apigee, dass Sie Maßnahmen zum Schutz dieses Endpunkts ergreifen, da die Antwort die E-Mail-Adresse des Entwicklers enthält, der die API-Produkte in Ihrer Apigee-Organisation erstellt und geändert hat.

Sie können den Endpunkt schützen, indem Sie ein Upgrade von Edge Microgateway durchführen oder Gegenseitig TLS konfigurieren. Beide Optionen werden im Folgenden beschrieben.

Prüfen, ob der Endpunkt /products geschützt ist

Wenn Sie sich nicht sicher sind, ob der Endpunkt /products geschützt ist, rufen Sie den Abschnitt Prüfen, ob die Ressource /products geschützt ist auf und führen Sie die dortigen Schritte aus, bevor Sie fortfahren.

Option 1: Edge Microgateway upgraden

Wenn Sie Edge Microgateway am oder vor dem 5. Oktober 2018 installiert haben, empfiehlt Apigee ein Upgrade auf die neueste Version von Edge Microgateway. Führen Sie die Schritte unter Edge Microgateway upgraden, wenn Sie eine Internetverbindung haben aus.

Wenn Sie derzeit kein Upgrade ausführen können, fahren Sie mit Option 2 fort.

Option 2: Gegenseitiges TLS konfigurieren

Wenn Sie derzeit kein Upgrade von Edge Microgateway durchführen können, empfiehlt Apigee, dass Sie die Kommunikation zwischen Edge Microgateway und dem edgemicro-auth-Proxy mit gegenseitigem TLS (auch als Zwei-Wege-TLS bezeichnet) schützen.

1. Öffnen Sie die Datei $HOME/.edgemicro/org-env-config.yaml. Wenn Sie diese Datei nicht finden können, lesen Sie den Abschnitt Wo ist Edge Microgateway installiert?.
2. Fügen Sie der Datei org-env-config.yaml den folgenden tlsOptions-Block hinzu, um das gegenseitige TLS zwischen Edge Microgateway und Apigee Edge zu aktivieren:

   edge_config:
     bootstrap: >-
       https://domain/edgemicro/bootstrap/organization/org/environment/env
     jwt_public_key: 'https://domain/edgemicro-auth/publicKey'
     managementUri: 'https://api.enterprise.apigee.com'
     tlsOptions:
       agentOptions:
         requestCert: true
         cert: 'path/to/cert'
         key: 'path/to/key'
   

   Beispiel:

   tlsOptions:
     agentOptions:
       requestCert: true
       cert: '/Users/jdoe/twowayssl/ssl/client.key'
       key: '/Users/jdoe/twowayssl/ssl/ca.crt'

   Sie können auch die folgenden optionalen agentOptions-Parameter angeben:

   • ca: Gibt den Pfad zur Zertifizierungsstelle an.
   • pfx: Geben Sie hier an, wenn Sie anstelle von Zertifikat und Schlüssel eine P12-/PFX-Datei verwenden möchten.
   • passphrase: Die Passphrase für eine PFX-Datei.
   • ciphers: Gibt TLS-Chiffren an.
3. Achten Sie darauf, dass für den virtuellen Host, auf dem der edgemicro-auth-Proxy bereitgestellt wird, gegenseitiges TLS aktiviert ist. Weitere Informationen finden Sie in der Dokumentation zu Apigee Edge unter Virtuellen Host für Zwei-Wege-TLS definieren.

   Der folgende Screenshot zeigt, wie gegenseitiges TLS auf einem virtuellen Host in der Apigee Edge-Benutzeroberfläche aktiviert wird:

   
4. Sehen Sie sich den API-Proxy edgemicro-auth in der Edge-Benutzeroberfläche an und achten Sie darauf, dass in der Proxykonfiguration der richtige virtuelle Host angegeben ist. Wenn Sie beispielsweise einen TLS-fähigen virtuellen Host namens mutualtls erstellt haben, sollte die HTTPProxyConnection-Stanza des Proxys so aussehen:

   <HTTPProxyConnection>
       <BasePath>/edgemicro-auth</BasePath>
       <Properties/>
       <VirtualHost>mutualtls</VirtualHost>
   </HTTPProxyConnection>
   

curl -v https://your_domain/edgemicro-auth/products

{
  "error":"unauthorized",
  "error_description": "authentication failed"
}

curl: (35) error:1408F10B:SSL routines:ssl3_get_record:wrong version number

{
   "apiProduct":[
      {
         "apiResources":[
            "/",
            "/**"
         ],
         "approvalType":"auto",
         "attributes":[

         ],
         "createdAt":1537374680948,
         "createdBy":"jdoe@foo.com",
         "description":"",
         "displayName":"mock",
         "environments":[
            "test"
         ],
         "lastModifiedAt":1537374680948,
         "lastModifiedBy":"test@test.com",
         "name":"mock",
         "proxies":[
            "edgemicro-auth",
            "edgemicro_mock"
         ],
         "quota":"null",
         "quotaInterval":"null",
         "quotaTimeUnit":"null",
         "scopes":[
            ""
         ]
      }
   ]
}

curl -v http://your_domain/edgemicro-auth/products

Tests und Fehlerbehebung

Wie vermeide ich Fehler des Typs „Zu viele geöffnete Dateien“ während des Lasttests?

In einigen Fällen kann es im System zu einer Situation kommen, in der zu viele offene Dateiverbindungen vorhanden sind. Dies kann zum Absturz von Edge Micro führen. Das Standard-Logging erfordert zwei HTTP-Verbindungen für eingehende und ausgehende Transaktionen über das Microgateway.

Zu Test- und Benchmarking-Zwecken empfiehlt Apigee, den ulimit-Befehl Ihres Systems auf unbegrenzt zu setzen: ulimit -n unlimited. Weitere Informationen finden Sie in der Apigee-Community unter Edge Microgateway-Fehler während Lasttests.

Tipps für die schnelle Entwicklung und Fehlerbehebung

Wenn Sie Plug-ins für Edge Microgateway entwickeln, ist die Unterstützung für die schnelle Entwicklung möglicherweise eingeschränkt.

Hier ein paar Tipps:

• Zum Starten von Edge Microgateway können Sie die Umgebungsvariablen EDGEMICRO_KEY und EDGEMICRO_SECRET auf das Schlüssel/Secret-Paar festlegen, das für den Microgateway-Startbefehl erforderlich ist. Auf diese Weise können Sie Edge Microgateway starten, ohne den Schlüssel/das Secret in der Befehlszeile einzugeben. Weitere Informationen finden Sie in der Edge Microgateway-Dokumentation unter Umgebungsvariablen festlegen.
• Starten Sie Edge Microgateway im FEHLERBEHEBUNGsmodus, um zusätzliche Ausgabe im Befehlsterminal zu sehen: DEBUG=* edgemicro start -o [org] -e [env] -k [key] -s [secret]

Unternehmen und Lizenzierung

In welcher Beziehung stehen Apigee-127- und Edge Microgateway-Supportmodelle?

Apigee-127 ist ein Open-Source-Softwareprojekt, das im Open-Source-Modell unterstützt wird. Sie können also Probleme im GitHub-Projekt melden und eine Pull-Anfrage stellen, wenn Sie versuchen, ein Problem zu beheben. Apigee-127 erfordert und enthält keine Softwarelizenzvereinbarungen mit Apigee.

Edge Microgateway dagegen ist ein Enterprise-Produkt, das von Apigee für Apigee-Kunden unterstützt wird. Apigee-Kunden können mit dem Apigee Edge-Support von Google Cloud Supporttickets, Funktionsanfragen und Fehlerberichte erstellen.