Edge Microgateway-FAQs

Sie sehen sich die Dokumentation zu Apigee Edge an.
Sehen Sie sich die Apigee X-Dokumentation an. info

Erste Schritte

Wie installiere ich Edge Microgateway?

Siehe Edge Microgateway installieren.

Wie führe ich Edge Microgateway aus?

Siehe „Edge Microgateway einrichten und konfigurieren“.

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

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

Vorgang

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

Edge Microgateway prüft automatisch, ob Änderungen an Apigee Edge vorgenommen wurden, z. B. an Microgateway-kompatiblen Proxys, Produkten oder Entwickler-Apps. Das Standard-Polling-Intervall beträgt 600 Sekunden. Sie können das Intervall jedoch mit der Konfigurationseinstellung config_change_poll_interval ändern. Siehe Edgemicro-Attribute.

Wenn Sie nicht auf das Polling-Intervall warten möchten, können Sie mit dem Befehl edgemicro reload die neuesten Änderungen abrufen. Siehe Microgateway-Cluster neu laden.

Wie unterscheidet ich zwischen einem Proxy, der auf Edge bereitgestellt wird, von einem Proxy auf Edge Microgateway?

Wenn Sie Edge Microgateway konfigurieren, wird eine Liste der Microgateway-kompatiblen Proxys, die in Apigee Edge bereitgestellt werden, in die lokale Konfiguration von Edge Microgateway heruntergeladen. Proxys, die Microgateway unterstützen, haben das Präfix edgemicro_.

Welche Optionen habe ich für die Protokollierung mit Edge Microgateway?

Edge Microgateway hat eine integrierte Logging-Funktion. Weitere Informationen finden Sie unter Logdateien verwalten.

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

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

Solange die Organisation und die Umgebung für die Microgateway-Instanzen identisch sind, können Sie das Schlüssel/Secret-Paar, das bei der Konfiguration generiert wird, 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 das Edge-Mikrogateway mit dem Befehl edgemicro start starten. Weitere Informationen finden Sie unter Umgebungsvariablen festlegen.

Kann ich benutzerdefinierte Produkt- oder Entwickler-App-Attribute mit Edge Microgateway verwenden?

Nein. Standardmäßig verarbeitet das Edge Microgateway nur Attribute, die sich auf das grundlegende Routing und die Sicherheit beziehen. Sie haben jedoch folgende Möglichkeit, das Problem zu umgehen:

1. Fügen Sie dem edgemicro-auth-Proxy, den Edge Microgateway in Apigee Edge bereitstellt, benutzerdefinierte Attribute hinzu. Diese Attribute sind verfügbar, wenn API-Schlüssel oder OAuth-Token-Sicherheit verwendet werden.
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 Anfrage-Headers?

Wenn Sie Node.js auf v8.14.0 oder höher aktualisieren, beachten Sie, dass die maximale zulässige Headergröße für Anfragen von 80 KB auf 8 KB reduziert wurde. Header, die 8 KB überschreiten, führen zu einem HTTP-431-Fehler.

Mit einer Node.js-Konfigurationsoption in Version 11.6.0 von Node.js können Sie die standardmäßige maximale Header-Größe ändern. Mit diesem Parameter, --max-http-header-size, können Sie die maximale Größe der HTTP-Header 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 werden von Edge Microgateway verwendet?

Bereitstellung

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

Ja. Edge Microgateway ist ein schlanker 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-kompatible Proxys haben spezielle Anforderungen und unterstützen nicht alle Funktionen regulärer Edge-Proxys. Siehe Teil 2: Entitäten in Apigee Edge erstellen

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

Nein. Edge Microgateway kennt keine API-Proxy-Bereitstellungen ohne Microgateway bei Apigee Edge.

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

Eine gute Beschreibung dazu, wie Sie Edge Microgateway mit NGINX als Load Balancer ausführen, 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?

Beachten Sie die Produktkonfigurationslimits für reguläre Edge-Proxys. Die Anzahl der Microgateway-kompatiblen Proxys, die Sie in einer Apigee Edge-Organisation und -Umgebung bereitstellen und über das Edge Microgateway aufrufen können, muss diesenselben Einschränkungen 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 mit einer bestimmten Region verknüpfen (wenn ich ein Kunde mit mehreren Regionen 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 Organisationsadministrator sein, um Edge Microgateway zu konfigurieren und bereitzustellen?

Ja. Sie benötigen Anmeldedaten für den Organisationsadministrator, um Edge Microgateway zu konfigurieren und bereitzustellen.

Muss ich Administrator der Organisation sein, um Edge Microgateway ausführen zu können?

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

Können Nutzer in meiner Organisation das Edge Microgateway verwenden?

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

Leistung

Welche Leistungsüberlegungen gelten für die Verwendung von Edge Microgateway?

Wenn Sie Edge Microgateway zusammen mit der Zielanwendung ausführen, muss der Server über ausreichende Kapazität verfügen.

Was sind Best Practices für die Ausführung von Edge Microgateway in großem Umfang?

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

Was sind die standardmäßigen TPS für Edge Microgateway und welche Hardwareanforderungen gelten für eine Microgateway-Instanz?

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

Private Cloud-Bereitstellung

Funktioniert Edge Microgateway mit Edge für Private Cloud?

Ja. Weitere Informationen finden Sie unter Konfigurationsschritte für Apigee Private Cloud.

Plug-ins

Wie wird das Kontingent mit Edge Microgateway erzwungen?

Sie können Ihrer Instanz des Edge Microgateway optional ein Kontingents-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 ein Spike Arrest-Plug-in hinzufügen. Weitere Informationen finden Sie unter Spike Arrest-Plug-in verwenden.

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

Nein. Plug-ins müssen in Node.js geschrieben sein.

Was passiert, wenn Edge Microgateway keine Analytics-Daten in Edge hochladen kann?

Edge Microgateway hat einen In-Memory-Puffer. Wenn der Puffer voll ist, werden ältere Nutzlasten gelöscht, damit der API-Traffic reibungslos ablaufen 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 sie ignoriert. Stattdessen verwendet Edge Microgateway Plug-ins, um Funktionen bereitzustellen, die denen von Richtlinien in Edge ähneln, z. B. Kontingente, 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 Beiträgen und Blogs der Apigee-Community werden weitere Anwendungsfälle für Plugins beschrieben:

• Standard-URL in Edge Microgateway überschreiben
• Kontingent in Edge Microgateway verwenden
• Edge Microgateway ein Protokollierungs-Plug-in hinzufügen

Sicherheit

Wie schütze ich die /products-Ressource?

Übersicht

Wenn Sie das Edge Microgateway konfigurieren, wird ein API-Proxy namens edgemicro-auth in Ihrer Organisation:Umgebung in Apigee Edge 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, diesen Endpunkt zu schützen, 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 Edge Microgateway aktualisieren oder Mutual TLS konfigurieren. Beide Optionen werden unten beschrieben.

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

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

Option 1: Edge Microgateway aktualisieren

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

Wenn Sie das Upgrade derzeit nicht durchführen können, fahren Sie mit Option 2 fort.

Option 2: Gegenseitige TLS-Authentifizierung konfigurieren

Wenn Sie das Edge Microgateway derzeit nicht aktualisieren können, empfiehlt Apigee, die Kommunikation zwischen dem Edge Microgateway und dem edgemicro-auth-Proxy mit gegenseitiger TLS (auch bidirektionale TLS genannt) zu schützen.

1. Öffnen Sie die Datei $HOME/.edgemicro/org-env-config.yaml. Wenn Sie diese Datei nicht finden, lesen Sie den Hilfeartikel 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'

   Außerdem kannst du die folgenden optionalen agentOptions-Parameter angeben:

   • ca: Gibt den Pfad zur Zertifizierungsstelle an.
   • pfx: Geben Sie diesen Parameter 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. Prüfen Sie, ob für den virtuellen Host, auf dem der edgemicro-auth-Proxy bereitgestellt wird, die gegenseitige TLS-Authentifizierung aktiviert ist. Weitere Informationen finden Sie in der Apigee Edge-Dokumentation unter Virtuellen Host für bidirektionales TLS definieren.

   Im folgenden Screenshot wird gezeigt, wie Sie in der Apigee Edge-Benutzeroberfläche die gegenseitige TLS-Verschlüsselung auf einem virtuellen Host aktivieren:

   
4. Sehen Sie sich den edgemicro-auth API-Proxy in der Edge-Benutzeroberfläche an und prüfen Sie, ob 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-Strophe 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“ bei Lasttests?

In einigen Fällen kann es vorkommen, dass zu viele Dateiverbindungen geöffnet sind, was zu einem Absturz von Edge Micro führen kann. Das Standard-Logging erfordert zwei HTTP-Verbindungen für eingehende und ausgehende Transaktionen über Microgateway.

Für Test- und Benchmarking-Zwecke empfiehlt Apigee, den ulimit-Befehl Ihres Systems auf unbegrenzt zu setzen: ulimit -n unlimited. Siehe auch Edge Microgateway-Fehler während Lasttests in der Apigee-Community.

Tipps für eine 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 einige Tipps:

• Zum Starten von Edge Microgateway können Sie die Umgebungsvariablen EDGEMICRO_KEY und EDGEMICRO_SECRET auf das Schlüssel/Secret-Paar festlegen, das vom Microgateway-Startbefehl benötigt wird. So 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 das Edge-Microgateway im DEBUG-Modus, um zusätzliche Ausgabe im Befehlsterminal zu sehen: DEBUG=* edgemicro start -o [org] -e [env] -k [key] -s [secret]

Unternehmen und Lizenzierung

Welche Beziehung besteht zwischen den Supportmodellen für Apigee-127 und Edge Microgateway?

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 einen Pull-Request stellen, wenn Sie etwas beheben möchten. Für Apigee-127 sind keine Softwarelizenzvereinbarungen mit Apigee erforderlich und es sind auch keine enthalten.

Edge Microgateway ist dagegen ein Enterprise-Produkt, das von Apigee für Apigee-Kunden unterstützt wird. Das bedeutet, dass Apigee-Kunden über den Apigee Edge-Support von Google Cloud Supporttickets, Feature-Anfragen und Fehlerberichte erstellen können.