Proxys über die Befehlszeile bereitstellen

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

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 in der Verwendung eines in Python geschriebenen Apigee Edge-Bereitstellungstools. Die andere ist die Konfiguration und Ausführung eines Shell-Skripts.

Verwenden Sie die Befehlszeilenbereitstellungsmethoden, wenn Sie direkt mit Proxy-Quelldateien auf Ihrem System arbeiten. Es gibt viele Gründe, warum Sie offline arbeiten können. Möglicherweise möchten Sie einen Ihrer bevorzugten XML-Editoren verwenden oder Sie entwickeln Richtlinien, die eine Java-Codierung erfordern, und arbeiten hauptsächlich in einer IDE. Mit den in diesem Abschnitt beschriebenen Techniken können Sie Ihre Quelldateien in die ausgewählte Umgebung der API-Dienste hochladen und bereitstellen.

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

Sie sehen die Apigee Edge-Dokumentation.
Rufen Sie die Apigee X-Dokumentation auf.
weitere Informationen

Apigee Edge-Python-Bereitstellungstool ausführen

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

Verwenden Sie das Apigee Edge Python-Tool, um Ihre API in einem einfachen Prozess zu importieren (hochzuladen) und bereitzustellen.

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

Ersetzen Sie im folgenden Befehl den Proxynamen, Ihren Edge-Benutzernamen und das Edge-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 /

Dieser Befehl komprimiert Ihre Dateien, überträgt sie in Ihre Organisation auf Apigee Edge und stellt sie in der angegebenen Umgebung bereit.

Das Bereitstellungstool ermittelt automatisch die aktuelle Version Ihres API-Proxys, hebt die Bereitstellung der vorhandenen Überarbeitung auf und stellt eine heraufgesetzte Version des API-Proxys bereit.

Bei Erfolg wird die 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 hoch, 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 Flag -h 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: Nutzername und 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, das Ihre API-Proxydateien enthält. Ihre API-Proxydateien müssen in einem Verzeichnis namens "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 Musterübereinstimmung verwendet wird, um eingehende Nachricht an diese API-Proxy-Bereitstellung weiterzuleiten. In den meisten Fällen können Sie diesen Wert auf „/“ setzen, sofern Sie keine erweiterten Bereitstellungs- und Routinganforderungen haben. Der primäre Pfad, der für das API-Proxy-Routing verwendet wird, wird in der Konfigurationsdatei ProxyEndpoint des API-Proxys definiert.
  • -h: die Edge-URL. Standardmäßig lautet 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 wie in https://192.168.11.111:8080 verwenden.

Deployment-Shell-Script konfigurieren und ausführen

Der einfachste Ansatz besteht darin, das Bereitstellungsskript auszuführen, das mit dem Beispiel-API-Proxy bereitgestellt wird. Die Shell-Skripts umschließen das Python-Bereitstellungstool von Apigee Edge.

Führen Sie im Verzeichnis /simplyProxy folgenden Befehl aus:

$ sh deploy.sh

Hier sollten Sie das 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.

Sie sollten dann Folgendes 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]: 

bedeutet dies, dass Sie die Datei /setup/setenv.sh in der Verteilung der Plattformstichproben ändern müssen. Eine Anleitung finden Sie in der Infodatei oder in den Apigee Edge-APIs.

Bei Erfolg komprimiert das Bereitstellungstool die Dateien unter /apiproxy,, importiert das Paket in Ihre Organisation auf Apigee Edge und stellt dann den API-Proxy in der Testumgebung bereit.

Ihr API-Proxy kann jetzt aufgerufen werden.