Edge for Private Cloud v. 4.16.05
Organisation, Umgebung und virtuellen Host gleichzeitig erstellen
Bevor Sie einen API-Proxy in Apigee Edge erstellen können, müssen Sie mindestens eine Organisation und in jeder Organisation eine oder mehrere Umgebungen und virtuelle Hosts erstellen.
In der Regel werden Organisationen und Umgebungen zusammen erstellt. Verwenden Sie das Dienstprogramm apigee-provision, um den Prozess zu vereinfachen. Rufen Sie ihn über die Befehlszeile auf dem Edge Management Server auf:
> /<inst_root>/apigee/apigee-service/bin/apigee-service apigee-provision setup-org -f configFile
Die Konfigurationsdatei enthält Folgendes:
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. # AXGROUP=axgroup-001 # Default value is axgroup-001
Der Befehl führt dann Folgendes aus:
- Erstellen Sie die Organisation
Hinweis: Sie können eine Organisation nach dem Erstellen nicht mehr umbenennen. - Verknüpfen Sie die Organisation mit einem Pod. Standardmäßig wird sie mit dem „Gateway“-Pod verknüpft.
- Fügen Sie den angegebenen Nutzer als Admin der Organisation hinzu. Wenn der Nutzer nicht vorhanden ist, können Sie einen erstellen.
- Eine oder mehrere Umgebungen erstellen
- Einen oder mehrere virtuelle Hosts für jede Umgebung erstellen
- Umgebung mit allen Message Processors verknüpfen
- Analysen aktivieren
Eine vollständige Konfigurationsdatei für die unbeaufsichtigte Installation finden Sie unter Organisation einbinden.
Standardmäßig beträgt die maximale Länge des Organisationsnamens und des Umgebungsnamens 20 Zeichen, wenn das Dienstprogramm apigee-provision verwendet wird. Dieses Limit gilt nicht, wenn Sie die Edge API direkt zum Erstellen der Organisation oder Umgebung verwenden.
Organisation erstellen
Verwenden Sie den Befehl „create-org“, um eine Organisation zu erstellen:
> /<inst_root>/apigee/apigee-service/bin/apigee-service apigee-provision create-org -f configFile
Mit diesem Skript wird die Organisation erstellt, aber die Umgebungen und virtuellen Hosts, die die Organisation für die Verarbeitung 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 Administrators der Organisation. Die Zeichen, die Sie im Attribut „name“ verwenden können, sind auf folgende Zeichen beschränkt: a-z0-9\-$%. Verwenden Sie im Namen keine Leerzeichen, Punkte oder Großbuchstaben:
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:
- Erstellt die Organisation
- Verknüpft die Organisation mit einem Pod. Standardmäßig wird sie mit dem „Gateway“-Pod verknüpft.
- Fügt den angegebenen Nutzer als Admin der Organisation hinzu. Der Nutzer muss bereits vorhanden sein, sonst gibt das Script einen Fehler aus.
<Error>
<Code>organizations.OrganizationAlreadyExists</Code>
<Message>Organization : test already exists</Message>
<Contexts/>
</Error>Organisation mithilfe von API-Aufrufen erstellen
Alternativ können Sie die folgenden API-Aufrufe verwenden, um eine Organisation zu erstellen. Mit dem ersten Aufruf wird die Organisation erstellt:
curl -H "Content-Type:application/xml" -u <sysAdminEmail>:<adminPasswd> \ -X POST http://<ms-ip>:8080/v1/organizations \ -d '<Organization name="<org-name>" type="paid"/>'
Der nächste Aufruf verknüpft die Organisation mit einem Pod:
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 Admin der 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 ihn mit dem folgenden Aufruf erstellen, wie unter „Nutzer hinzufügen“ beschrieben.
Umgebung erstellen
Verwenden Sie den Befehl add-env, um eine Umgebung in einer vorhandenen Organisation zu erstellen:
> /<inst_root>/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. # AXGROUP=axgroup-001 # Default value is axgroup-001
Der Befehl bewirkt Folgendes:
- Erstellt die Umgebung
- Erstellt einen einzelnen virtuellen Host für die Umgebung
- Verknüpft die Umgebung mit allen Message Processors im Pod, der mit der Organisation verknüpft ist, die die Umgebung enthält.
- Aktiviert die Analyse
Hinweis: Wenn Sie die Analyse für eine Umgebung in einer Organisation aktivieren, müssen Sie die Analyse für alle Umgebungen in der Organisation aktivieren.
Umgebung mithilfe von API-Aufrufen erstellen
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>"/>'
Mit dem nächsten Aufruf wird die Umgebung mit einem Message Processor verknüpft. Führen Sie diesen Aufruf für jeden Message Processor aus, 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>"
Dabei ist „<uuid>“ die UUID des Message Processors. Sie können die UUID mit dem folgenden Befehl abrufen:
> curl http://<mp-ip>:8082/v1/servers/self
Dabei ist <mp-ip> die IP-Adresse des Message Processors.
Mit dem nächsten API-Aufruf wird Analytics für eine bestimmte Umgebung aktiviert. Es wird geprüft, ob Qpid- und Postgres-Server in den PODs aller Rechenzentren vorhanden sind. Anschließend wird das Analytics-Onboarding für die angegebene Organisation und Umgebung gestartet.
> /<inst_root>/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"
Dabei enthält sample.json Einträge für das Analytics-Onboarding. Wenden Sie sich an den Apigee-Support, um die JSON-Datei zu erhalten.
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. Beispielsweise kann ein virtueller Host das HTTP-Protokoll unterstützen, 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 zu erstellen 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 zum Erstellen eines virtuellen Hosts, einschließlich eines sicheren virtuellen Hosts, der TLS/SSL über HTTPS verwendet, finden Sie unter http://apigee.com/docs/api-services/content/creating-virtual-host.