Proxys über die Befehlszeile bereitstellen

Sie lesen gerade die Dokumentation zu Apigee Edge.
Zur Dokumentation zu Apigee X. info

In diesem Thema wird erläutert, wie Sie einen Proxy über die Befehlszeile bereitstellen. Apigee Edge bietet zwei Optionen für die Bereitstellung über die Befehlszeile. Die erste besteht darin, ein in Python geschriebenes Apigee Edge-Bereitstellungstool zu verwenden. Die andere besteht darin, ein Shell-Skript zu konfigurieren und auszuführen.

Verwenden Sie die Bereitstellungstechniken über die Befehlszeile, wenn Sie direkt mit Proxy-Quelldateien auf Ihrem System arbeiten. Es gibt viele Gründe, warum Sie möglicherweise offline arbeiten. Vielleicht möchten Sie einen bevorzugten XML-Editor verwenden oder Richtlinien entwickeln, für die Java-Code erforderlich ist, und Sie arbeiten hauptsächlich in einer IDE. Mit den in diesem Abschnitt beschriebenen Techniken können Sie Ihre Quelldateien in die von Ihnen ausgewählte API-Dienste-Umgebung hochladen und dort bereitstellen.

Wenn Sie hauptsächlich in der Verwaltungsoberfläche arbeiten, lesen Sie Proxys in der Benutzeroberfläche bereitstellen.

Sie lesen gerade die Apigee Edge -Dokumentation.
Zur Apigee X -Dokumentation. info

Apigee Edge-Bereitstellungstool in Python ausführen

Das Apigee Edge-Bereitstellungstool in Python funktioniert mit der Edge Management API, um API Proxys zu importieren und bereitzustellen. Das Tool ist als Teil der API Platform Samples-Distribution auf GitHub verfügbar. Weitere Informationen finden Sie unter Beispiel-API-Proxys verwenden.

Mit dem Apigee Edge-Tool in Python können Sie Ihre API in einem einfachen Prozess importieren (hochladen) und bereitstellen.

Das Bereitstellungstool muss aus dem Basisverzeichnis in der API Platform Samples-Distribution ausgeführt werden. Das Basisverzeichnis ist das übergeordnete Verzeichnis des setup und tools Verzeichnisses.

Ersetzen Sie im folgenden Befehl den Proxy-Namen, Ihren Edge-Nutzernamen und Ihr Passwort, die Edge Organisation und -Umgebung sowie den Pfad zum Verzeichnis, das das Verzeichnis "apiproxy" des API-Proxys enthält:

python tools/deploy.py -n proxyname -u name:passW -o org -e env -d proxypath -p /

Beispiel:

python tools/deploy.py -n weatherapi -u me@myCo.com:foo -o myCo -e test -d weatherapi -p /

Mit diesem Befehl werden Ihre Dateien gezippt, in Ihre Organisation in Apigee Edge hochgeladen und in der angegebenen Umgebung bereitgestellt.

Das Bereitstellungstool ermittelt automatisch die aktuelle Überarbeitung Ihres API Proxys, macht die Bereitstellung der vorhandenen Überarbeitung rückgängig und stellt eine aktualisierte Überarbeitung des API Proxys bereit.

Bei Erfolg wird eine Ausgabe im folgenden Format angezeigt:

Writing ./<proxybasedir>/apiproxy/weatherapi.xml to apiproxy/weatherapi.xml
Writing ./<proxybasedir>/apiproxy/proxies/default.xml to apiproxy/proxies/default.xml
Writing ./<proxybasedir>/apiproxy/targets/default.xml to apiproxy/targets/default.xml
Imported new proxy version 1
Environment: test
  Revision: 1 BasePath = /
  State: deployed

Standardmäßig lädt das Tool den API-Proxy in https://api.enterprise.apigee.com, was Edge in der Cloud entspricht. Sie können dieses Tool auch verwenden, um den API-Proxy in eine lokale Version von Edge hochzuladen. Geben Sie dazu das -h Flag an:

python tools/deploy.py -n weatherapi -u me@myCo.com:foo -o myCo -e test -d weatherapi -p / -h https://192.168.11.111:8080

In diesem Beispiel geben Sie die IP-Adresse des Edge-Verwaltungsservers an. Wenn Sie einen DNS-Eintrag für den Verwaltungsserver erstellt haben, können Sie eine URL im folgenden Format angeben:

https://ms_URL:8080

Die vollständige Liste der Flags für den Befehl lautet:

  • -n: Der Name Ihres API-Proxys.
  • -u: Der Nutzername und das Passwort für Ihr Konto in einer Organisation in Apigee Edge.
  • -o: Der Name der Organisation, in der Sie ein Konto haben.
  • -e: Die Umgebung, in der der API-Proxy bereitgestellt werden soll (test oder prod).
  • -d: Der Pfad zum Verzeichnis mit Ihren API-Proxy-Dateien. Ihre API-Proxy Dateien müssen in einem Verzeichnis mit dem Namen „apiproxy“ gespeichert sein. Dieser Wert ist der Pfad des Verzeichnisses, das das Verzeichnis „apiproxy“ enthält, und nicht der Pfad zum Verzeichnis „apiproxy“ selbst.
  • -p: Der URI-Pfad, der als Musterabgleich verwendet wird, um eingehende Nachrichten an diese API Proxy-Bereitstellung weiterzuleiten. In den meisten Fällen können Sie diesen Wert auf „/“ setzen, es sei denn, Sie haben erweiterte Bereitstellungs- und Weiterleitungsanforderungen. Der primäre Pfad, der für das API-Proxy-Routing verwendet wird, ist in der ProxyEndpoint-Konfigurationsdatei des API-Proxys definiert.
  • -h: Die Edge-URL. Standardmäßig ist die URL https://api.enterprise.apigee.com, was Edge in der Cloud entspricht. Verwenden Sie für eine lokale Bereitstellung die URL des Edge Verwaltungsservers und Port 8080, wie in: 
    https://ms_URL:8080

    Alternativ können Sie die IP-Adresse des Verwaltungsservers verwenden, z. B. https://192.168.11.111:8080.

Shell-Skript für die Bereitstellung konfigurieren und ausführen

Am einfachsten ist es, das Bereitstellungsskript auszuführen, das mit dem Beispiel-API-Proxy bereitgestellt wird. Die Shell Skripts umschließen das Apigee Edge-Bereitstellungstool in Python.

Führen Sie im Verzeichnis /simplyProxy Folgendes aus:

$ sh deploy.sh

Hier sollten Sie dies sehen:

Enter your password for user {myname} in the Apigee Enterprise organization {org_name}, followed by [ENTER]:

Geben Sie Ihr Passwort ein und drücken Sie die EINGABETASTE.

Hier sollten Sie dies sehen:

Deploying to test on https://api.enterprise.apigee.com using {myname} on enterprise.apigee.com and {org_name} on enterprise.apigee.com

Wenn Sie Folgendes sehen:

Enter your password for user Your USERNAME on enterprise.apigee.com in the Apigee Enterprise organization Your ORG on enterprise.apigee.com, followed by [ENTER]:

müssen Sie die Datei /setup/setenv.sh in der Platform Samples-Distribution ändern. Eine Anleitung finden Sie in der README-Datei oder in der Apigee Edge API-Referenz.

Bei Erfolg zippt das Bereitstellungstool die Dateien unter /apiproxy, importiert das Paket in Ihre Organisation in Apigee Edge und stellt dann den API-Proxy in der Umgebung „test“ bereit.

Ihr API-Proxy kann jetzt aufgerufen werden.