Edge for Private Cloud Version 4.17.05
Organisation erstellen, Umgebung und virtueller Host gleichzeitig
Bevor Sie einen API-Proxy in Apigee Edge erstellen, müssen Sie mindestens eine Organisation erstellen und in jeder Organisation, eine oder mehrere Umgebungen und virtuelle Hosts.
Normalerweise werden Organisationen und Umgebungen gemeinsam erstellt. Verwenden Sie zur Vereinfachung dieses Vorgangs das Dienstprogramm apigee-provision. Rufen Sie ihn über die Befehlszeile auf dem Edge-Verwaltungsserver auf:
> /opt/apigee/apigee-service/bin/apigee-service apigee-provision setup-org -f configFile
Die Konfigurationsdatei enthält Folgendes:
# Set Edge sys admin credentials. ADMIN_EMAIL=your@email.com APIGEE_ADMINPW=adminPword # If omitted, you are prompted for it. NEW_USER="y" USER_NAME=orgAdmin@myCo.com FIRST_NAME=foo LAST_NAME=bar USER_PWD="userPwrod" ORG_NAME=example # lowercase only, no spaces, underscores, or periods. ENV_NAME=prod VHOST_PORT=9001 VHOST_NAME=default VHOST_ALIAS="$IP1:9001" # Optionally configure TLS/SSL for virtual host. # VHOST_SSL=y # Set to "y" to enable TLS/SSL on the virtual host. # KEYSTORE_JAR= # JAR file containing the cert and private key. # KEYSTORE_NAME= # Name of the keystore. # KEYSTORE_ALIAS= # The key alias. # KEY_PASSWORD= # The key password, if it has one. # Optionally set the base URL displayed by the Edge UI for an # API proxy deployed to the virtual host. # VHOST_BASEURL="http://myCo.com" # AXGROUP=axgroup-001 # Default value is axgroup-001
Der Befehl führt dann folgende Schritte aus:
- Organisation erstellen
Hinweis: Sie können eine Organisation nach dem Erstellen nicht mehr umbenennen. - Die Organisation mit einem Pod verknüpfen, standardmäßig mit dem „Gateway“ Pod
- Fügen Sie den angegebenen Nutzer als Administrator der Organisation hinzu. Wenn der Nutzer nicht vorhanden ist, können Sie eins.
- Eine oder mehrere Umgebungen erstellen
- Einen oder mehrere virtuelle Hosts für jede Umgebung erstellen
- Umgebung mit allen Nachrichtenprozessoren verknüpfen
- Analysen aktivieren
Eine vollständige Konfigurationsdatei im Hintergrund finden Sie unter Einrichten eines Organisation.
Wenn Sie das Dienstprogramm apigee-provision verwenden, beträgt die maximale Länge des Namens der Organisation und der Umgebung standardmäßig 20 Zeichen. Diese Beschränkung gilt nicht, wenn Sie die Edge API direkt zum Erstellen der Organisation oder zu verbessern.
Organisation erstellen
Verwenden Sie den Befehl „create-org“, um eine Organisation zu erstellen:
> /opt/apigee/apigee-service/bin/apigee-service apigee-provision create-org -f configFile
Mit diesem Script wird die Organisation erstellt, aber die Umgebungen und virtuellen Hosts, die die Organisation zum Verarbeiten von API-Aufrufen benötigt, werden nicht hinzugefügt oder konfiguriert.
Die Konfigurationsdatei enthält den Namen der Organisation und die E-Mail-Adresse des Administratoren. Folgende Zeichen sind im Attribut „Name“ zulässig: a–z0–9\-$%. Verwenden Sie keine Leerzeichen, Punkte oder Großbuchstaben im Namen:
APIGEE_ADMINPW=adminPword # If omitted, you are prompted for it. ORG_NAME=example # lowercase only, no spaces, underscores, or periods. ORG_ADMIN=orgAdmin@myCo.com
Der Befehl führt dann Folgendes aus:
- Die Organisation wird erstellt.
- Ordnet die Organisation einem Pod zu, standardmäßig dem „gateway“-Pod.
- Fügt den angegebenen Nutzer als Organisationsadministrator hinzu. Der Nutzer muss bereits vorhanden sein. Andernfalls wird das Skript gibt einen Fehler aus.
<Error>
<Code>organizations.OrganizationAlreadyExists</Code>
<Message>Organization : test already exists</Message>
<Contexts/>
</Error>
Organisation mithilfe von API-Aufrufe
Alternativ können Sie die folgenden API-Aufrufe verwenden, um eine Organisation zu erstellen. Der erste Aufruf erstellt der Organisation:
curl -H "Content-Type:application/xml" -u <sysAdminEmail>:<adminPasswd> \ -X POST http://<ms-ip>:8080/v1/organizations \ -d '<Organization name="<org-name>" type="paid"/>'
Beim nächsten Aufruf wird die Organisation mit einem Pod verknüpft:
curl -H "Content-Type:application/x-www-form-urlencoded" \ -u <sysAdminEmail>:<adminPasswd> -X POST \ http://<ms-ip>:8080/v1/organizations/<org-name>/pods \ -d "region=default&pod=gateway"
Sie können diesen Aufruf mehrmals ausführen, um die Organisation mit mehreren Pods zu verknüpfen.
Mit dem letzten Aufruf wird ein vorhandener Nutzer als Organisationsadministrator für die Organisation hinzugefügt:
curl -H "Content-Type:application/xml" -u <sysAdminEmail>:<adminPasswd> \ -X POST \ http://<ms-ip>:8080/v1/organizations/<org-name>/users/<user-email>/userroles/ \ -d '<Roles><Role name="orgadmin"/></Roles>'
Wenn der Nutzer nicht vorhanden ist, können Sie den folgenden Aufruf verwenden, um den Nutzer wie in Nutzer hinzufügen
Umgebung erstellen
Verwenden Sie den Befehl add-env, um eine Umgebung in einer vorhandenen Organisation erstellen:
> /opt/apigee/apigee-service/bin/apigee-service apigee-provision add-env -f configFile
Diese Konfigurationsdatei enthält die Informationen, die zum Erstellen der Umgebung und des virtuellen Hosts erforderlich sind:
APIGEE_ADMINPW=adminPword # If omitted, you are prompted for it. ORG_NAME=example # lowercase only, no spaces, underscores, or periods. ENV_NAME=prod VHOST_PORT=9001 VHOST_NAME=default VHOST_ALIAS="$IP1:9001" # Optionally configure TLS/SSL for virtual host. # VHOST_SSL=y # Set to "y" to enable TLS/SSL on the virtual host. # KEYSTORE_JAR= # JAR file containing the cert and private key. # KEYSTORE_NAME= # Name of the keystore. # KEYSTORE_ALIAS= # The key alias. # KEY_PASSWORD= # The key password, if it has one. # Optionally set the base URL displayed by the Edge UI for an # API proxy deployed to the virtual host. # VHOST_BASEURL="http://myCo.com" # AXGROUP=axgroup-001 # Default value is axgroup-001
Der Befehl bewirkt Folgendes:
- Schafft die Umgebung
- Erstellt einen einzelnen virtuellen Host für die Umgebung
- Ordnet die Umgebung allen Message Processor(s) in dem Pod zu, der mit dem Organisation, die die Umwelt enthält.
- Analysen aktivieren
Hinweis: Wenn Sie Analysen für eine Umgebung in einer Organisation aktivieren, müssen Sie Analysen für alle Umgebungen in der Organisation aktivieren.
Erstellen Sie eine Umgebung mithilfe von API-Aufrufe
Alternativ können Sie die folgenden API-Aufrufe verwenden, um eine Umgebung zu erstellen. Mit dem ersten Aufruf wird die Umgebung erstellt:
curl -H "Content-Type:application/xml" -u <sysAdminEmail>:<adminPasswd> \ -X POST http://<ms-ip>:8080/v1/organizations/<org-name>/environments \ -d '<Environment name="<env-name>"/>'
Beim nächsten Aufruf wird die Umgebung einem Message Processor zugeordnet. Tätigen Sie diesen Aufruf für jede Message Processor, den Sie mit der Umgebung verknüpfen möchten:
curl -H "Content-Type:application/x-www-form-urlencoded" \ -u <sysAdminEmail>:<adminPasswd> -X POST \ http://<ms-ip>:8080/v1/organizations/<org-name>/environments/<env-name>/servers \ -d "action=add&uuid=<uuid>"
Wobei "<uuid>" ist der UUID des Message Processor. Sie können die UUID mit dem Befehl abrufen:
> curl http://<mp-ip>:8082/v1/servers/self
Dabei ist <mp-ip> die IP-Adresse des Nachrichten-Prozessors.
Mit dem nächsten API-Aufruf wird Analytics für die jeweilige Umgebung aktiviert. Sie bestätigt die Existenz Qpid- und Postgres-Server in den PODs aller Rechenzentren. Anschließend wird das Analytics-Onboarding für die angegebene Organisation und Umgebung gestartet.
> /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-ax -f configFile
Diese Konfigurationsdatei enthält Folgendes:
ORG_NAME=orgName # lowercase only, no spaces, underscores, or periods. ENV_NAME=envName
curl -H "Content-Type:application/json" -u <sysAdminEmail>:<adminPasswd> -X POST http://<ms-ip>:8080/v1/organizations/<org-name>/environments/<env-name>/analytics/admin -d "@sample.json"
Die Datei „sample.json“ enthält Folgendes:
{
"properties" : {
"samplingAlgo" : "reservoir_sampler",
"samplingTables" : "10=ten;1=one;",
"aggregationinterval" : "300000",
"samplingInterval" : "300000",
"useSampling" : "100",
"samplingThreshold" : "100000"
},
"servers" : {
"postgres-server" : [ "1acff3a5-8a6a-4097-8d26-d0886853239c", "f93367f7-edc8-4d55-92c1-2fba61ccc4ab" ],
"qpid-server" : [ "d3c5acf0-f88a-478e-948d-6f3094f12e3b", "74f67bf2-86b2-44b7-a3d9-41ff117475dd"]
}
}
Das Attribut postgres-servers enthält eine durch Kommas getrennte Liste der Postgres-UUIDs und die Eigenschaft qpid-server enthält die Qpid-UUIDs. Wenn Sie diese UUIDs benötigen, verwenden Sie die folgenden Befehle.
Führen Sie für Qpid folgenden Befehl aus:
curl -u <sysAdminEmail>:<passwd> http://<ms-ip>/v1/servers?pod=central
Die Ausgabe dieses Befehls ist ein JSON-Objekt. Für jeden Qpid-Server sehen Sie die Ausgabe in der Formular:
"type" : [ "qpid-server" ], "uUID" : "d3c5acf0-f88a-478e-948d-6f3094f12e3b"
Führen Sie für Postgres den Befehl aus:
curl -u <sysAdminEmail>:<passwd> http://<ms-ip>/v1/servers?pod=analytics
Für jeden Postgres-Server wird die folgende Ausgabe angezeigt:
"type" : [ "postgres-server" ], "uUID" : "d3c5acf0-f88a-478e-948d-6f3094f12e3b"
Virtuellen Host erstellen
Sie können einen virtuellen Host in einer vorhandenen Umgebung in einer Organisation erstellen. Häufig unterstützt eine Umgebung mehrere virtuelle Hosts. Ein virtueller Host unterstützt beispielsweise das HTTP-Protokoll, während ein anderer virtueller Host in derselben Umgebung das verschlüsselte HTTPS-Protokoll unterstützt.
Verwenden Sie den folgenden API-Aufruf, um zusätzliche virtuelle Hosts oder einen virtuellen Host für eine Umgebung ohne virtuellen Host zu erstellen:
curl -H "Content-Type:application/xml" -u <sysAdminEmail>:<adminPasswd> \
-X POST \
http://<ms-ip>:8080/v1/organizations/<org-name>/environments/<env-name>/virtualhosts \
-d '<VirtualHost name="default"> \
<HostAliases> \
<HostAlias>myorg-test.apigee.net</HostAlias> \
</HostAliases> \
<Interfaces/> \
<Port>443</Port> \
</VirtualHost>'
Eine vollständige Beschreibung der Erstellung eines virtuellen Hosts, einschließlich der Erstellung eines sicheren virtuellen Hosts Host, der TLS/SSL über HTTPS verwendet, siehe TLS-Zugriff auf eine API konfigurieren für die Private Cloud.