Edge Microgateway-FAQs

Sie lesen gerade die Dokumentation zu Apigee Edge.
Apigee X-Dokumentation aufrufen. info

Erste Schritte

Wie installiere ich Edge Microgateway?

Weitere Informationen finden Sie unter 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 Backend-Datenspeicher.

Vorgang

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

Edge Microgateway fragt automatisch nach Änderungen ab, die in 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 es jedoch mit der Konfigurationseinstellung config_change_poll_interval ändern. Weitere Informationen finden Sie unter edgemicro-Attribute.

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

Wie unterscheide ich zwischen einem Proxy, der in Edge bereitgestellt wird, und einem Proxy in 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 für Microgateway optimiert sind, haben das Präfix edgemicro_.

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

Edge Microgateway verfügt über eine integrierte Logging-Funktion. Weitere Informationen finden Sie unter Logdateien verwalten.

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

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

Solange Organisation und Umgebung für die Microgateway-Instanzen identisch sind, können Sie das Schlüssel-/Geheimnispaar wiederverwenden, das bei der Konfiguration generiert wird.

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 einzelnen Befehl edgemicro start starten. Siehe auch Umgebungsvariablen festlegen.

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

Nein. Standardmäßig reagiert Edge Microgateway nur auf Attribute, die sich auf grundlegendes Routing und Sicherheit beziehen. Als Problemumgehung haben Sie jedoch folgende Möglichkeit:

1. Fügen Sie dem edgemicro-auth-Proxy, den Edge Microgateway in Apigee Edge bereitstellt, benutzerdefinierte Attribute hinzu. Diese Attribute sind verfügbar, wenn Sie die Sicherheit mit API-Schlüssel oder OAuth-Token verwenden.
2. Ändern Sie das OAuth-Plug-in so, dass es auf diese Attribute reagiert.

Gibt es eine Beschränkung für die Größe von Anfrageheadern?

Wenn Sie ein Upgrade von Node.js auf v8.14.0 oder eine höhere Version durchführen, beachten Sie, dass die maximal 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 in Node.js v11.6.0 hinzugefügten Node.js-Konfigurationsoption können Sie die standardmäßige maximale Headergröße ändern. Mit diesem 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 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. Für Proxys, die Edge Microgateway unterstützen, gelten bestimmte Anforderungen. Außerdem werden nicht alle Funktionen regulärer Edge-Proxys unterstützt. Siehe Teil 2: Entitäten in Apigee Edge erstellen.

Kann ich für denselben API-Proxy ein Failover zwischen der Bereitstellung eines Edge-Proxy-Sets und der Bereitstellung von Edge Microgateway aktivieren?

Nein. Edge Microgateway kennt keine API-Proxy-Bereitstellungen, die nicht für Microgateway auf Apigee Edge bestimmt sind.

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

Eine gute Beschreibung der Ausführung von Edge Microgateway mit NGINX als Load-Balancer finden Sie unter Managing APIs with Apigee Edge Microgateway and NGINX.

Welche Load-Balancer kann ich mit Edge Microgateway verwenden?

Edge Microgateway kann mit jedem Load Balancer verwendet werden.

Gibt es eine Begrenzung für die Anzahl der Edge Microgateway-Proxys, die ich bereitstellen kann?

Beachten Sie die für reguläre Edge-Proxys angegebenen Grenzwerte für die Produktkonfiguration. Die Anzahl der Microgateway-kompatiblen Proxys, die Sie in einer Apigee Edge-Organisation und -Umgebung bereitstellen und über Edge Microgateway aufrufen können, muss denselben Beschränkungen entsprechen.

Kann ich meine Edge Microgateway-Bereitstellung einer bestimmten Organisation und Umgebung zuordnen?

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

Kann ich mein Edge Microgateway-Deployment 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 Organisationsadministrator sein, um Edge Microgateway zu konfigurieren und bereitzustellen?

Ja. Sie benötigen Anmeldedaten als Admin der Organisation, 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 jedem ausgeführt werden, der die Berechtigung hat, solche Anwendungen auf einem bestimmten Computer auszuführen.

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

Sie müssen kein Apigee Edge-Organisationsnutzer 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 in Edge bereitgestellt werden.

Leistung

Welche Leistungsaspekte sind bei der Verwendung von Edge Microgateway zu berücksichtigen?

Wenn Edge Microgateway auf demselben Server wie die Zielanwendung ausgeführt wird, muss der Server über ausreichend Kapazität verfügen.

Was sind die Best Practices für die Ausführung von Edge Microgateway im großen Maßstab?

Apigee empfiehlt, mehrere Instanzen von Edge Microgateway auf verschiedenen Servern auszuführen, die von Load Balancern wie NGINX bereitgestellt werden. Weitere Informationen finden Sie in der Apigee Community unter Managing APIs with Apigee Edge Microgateway and NGINX und Vertical horizontal scaling.

Wie hoch ist der standardmäßige TPS für Edge Microgateway und welche Hardwareanforderungen gelten für eine Microgateway-Instanz?

Hardwareanforderungen und TPS-Messungen sind mit Edge Microgateway schwer zu ermitteln. Das hängt von Ihrer Einrichtung ab, die eine Kombination aus der Optimierung von Edge Microgateway, der Verwendung von Plug-ins, benutzerdefinierten Plug-ins und der Konfiguration anderer Dinge wie TLS ist. Apigee empfiehlt in der Regel, sich ein Bild von dieser Kombination von Elementen zu machen und Leistungstests mit Ihrer spezifischen Konfiguration durchzuführen.

Bereitstellung in der privaten Cloud

Funktioniert Edge Microgateway mit Edge for 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 Edge Microgateway-Instanz 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 Edge Microgateway-Instanz optional ein Spike-Arrest-Plug-in hinzufügen. Weitere Informationen finden Sie unter Spike-Arrest-Plug-in verwenden.

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

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

Was passiert, wenn Edge Microgateway keine Analysedaten 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 fließen kann.

Kann ich Edge Microgateway Richtlinien hinzufügen?

Wenn Sie reguläre Apigee Edge-Richtlinien an microgateway-aware-Proxys in Apigee Edge anhängen, werden sie ignoriert. Stattdessen verwendet Edge Microgateway Plug-ins, um Funktionen bereitzustellen, die Richtlinien in Edge ähneln, z. B. Kontingent, Spike Arrest, API-Schlüsselsicherheit und OAuth2-Sicherheit. Sie können auch benutzerdefinierte Plugins 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 Anwendungsfälle für das Plug-in beschrieben:

• Standard-URL in Edge Microgateway überschreiben
• Kontingent in Edge Microgateway verwenden
• Logger-Plug‑in zu Edge Microgateway hinzufügen

Sicherheit

Wie schütze ich die /products-Ressource?

Übersicht

Wenn Sie 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 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 Edge Microgateway aktualisieren oder gegenseitiges 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, lesen Sie den Abschnitt Prüfen, ob die /products-Ressource geschützt ist und führen Sie die dort beschriebenen Schritte aus, bevor Sie fortfahren.

Option 1: Edge Microgateway aktualisieren

Wenn Sie Edge Microgateway vor dem 5. Oktober 2018 installiert haben, empfiehlt Apigee, ein Upgrade auf die neueste Version von Edge Microgateway durchzuführen. Folgen Sie der Anleitung unter Edge Microgateway aktualisieren, wenn Sie eine Internetverbindung haben.

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

Option 2: Gegenseitiges TLS konfigurieren

Wenn Sie Edge Microgateway derzeit nicht aktualisieren können, empfiehlt Apigee, die Kommunikation zwischen Edge Microgateway und dem edgemicro-auth-Proxy mit gegenseitigem TLS (auch als bidirektionales TLS bezeichnet) zu 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 gegenseitiges 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 einfügen:

   • ca: Gibt den Pfad zur Zertifizierungsstelle an.
   • pfx: Geben Sie diesen Parameter an, wenn Sie anstelle von „cert“ und „key“ 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, gegenseitiges TLS aktiviert ist. Weitere Informationen finden Sie in der Apigee Edge-Dokumentation unter Virtuellen Host für bidirektionales TLS definieren.

   Der folgende Screenshot zeigt, wie Sie gegenseitiges TLS für einen virtuellen Host in der Apigee Edge-UI aktivieren:

   
4. Sehen Sie sich den edgemicro-auth-API-Proxy in der Edge-Benutzeroberfläche an und prüfen Sie, ob der richtige virtuelle Host in der Proxykonfiguration angegeben ist. Wenn Sie beispielsweise einen TLS-fähigen virtuellen Host namens mutualtls erstellt haben, sollte der HTTPProxyConnection-Abschnitt 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

Testen und Fehler beheben

Wie kann ich Fehler vom Typ „Zu viele Dateien geöffnet“ bei Lasttests vermeiden?

In einigen Fällen kann es vorkommen, dass Ihr System zu viele offene Dateiverbindungen hat, was zum Absturz von Edge Micro führen kann. Für die Standardprotokollierung sind zwei HTTP-Verbindungen für eingehende und ausgehende Transaktionen über das Microgateway erforderlich.

Für Tests und Benchmarking empfiehlt Apigee, den ulimit-Befehl Ihres Systems auf „unlimited“ zu setzen: ulimit -n unlimited. Weitere Informationen finden Sie in der Apigee-Community unter Edge Microgateway error during load testing.

Tipps für 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 sind 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 für den Microgateway-Startbefehl erforderlich ist. So können Sie Edge Microgateway starten, ohne den Schlüssel/das Secret in der Befehlszeile eingeben zu müssen. Weitere Informationen finden Sie in der Edge Microgateway-Dokumentation unter Umgebungsvariablen festlegen.
• Starten Sie Edge Microgateway im DEBUG-Modus, um zusätzliche Ausgaben im Befehlsterminal zu sehen: DEBUG=* edgemicro start -o [org] -e [env] -k [key] -s [secret]

Unternehmen und Lizenzierung

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

Apigee-127 ist ein Open-Source-Softwareprojekt, das im Open-Source-Modell unterstützt wird. Das heißt, Sie können Probleme im GitHub-Projekt melden und eine Pull-Anfrage stellen, wenn Sie versuchen, etwas zu beheben. Für Apigee-127 sind keine Softwarelizenzvereinbarungen mit Apigee erforderlich und sie sind auch nicht enthalten.

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