Organisation, Umgebung und virtuellen Host erstellen

Edge for Private Cloud v4.18.05

Sie können eine Organisation, eine Umgebung und einen virtuellen Host in der Befehlszeile mit einem einzigen Befehl erstellen oder sie einzeln erstellen. Außerdem können Sie viele dieser Aktionen mit der Verwaltungs-API ausführen.

Video: In diesem kurzen Video erhalten Sie einen Überblick über die Einrichtung und Konfiguration von Apigee-Organisationen.

Organisation, Umgebung und virtuellen Host gleichzeitig erstellen

Bevor Sie einen API-Proxy auf Apigee Edge erstellen, müssen Sie mindestens eine Organisation und innerhalb jeder Organisation eine oder mehrere Umgebungen und virtuelle Hosts erstellen.

Normalerweise werden Organisationen und Umgebungen gemeinsam erstellt. Verwenden Sie das Dienstprogramm apigee-provision, um den Vorgang zu vereinfachen. Rufen Sie ihn über die Befehlszeile auf dem Edge-Verwaltungsserver auf:

/opt/apigee/apigee-service/bin/apigee-service apigee-provision setup-org -f configFile

Dabei ist configFile der Pfad zu einer Konfigurationsdatei, die in etwa so aussieht:

# Set Edge sys admin credentials.
ADMIN_EMAIL=your@email.com
APIGEE_ADMINPW=admin_password  # If omitted, you are prompted for it.
NEW_USER="y"
USER_NAME=orgAdmin@myCo.com
FIRST_NAME=foo
LAST_NAME=bar
USER_PWD="userPword"
ORG_NAME=example  # lowercase only, no spaces, underscores, or periods.
ENV_NAME=prod  # lowercase only
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

Beim Einrichten einer Organisation führt das setup-org-Script folgende Schritte aus:

  • Die Organisation wird erstellt.
  • Verknüpft die Organisation mit dem Gateway-Pod. Diese Einstellung kann nicht geändert werden.
  • Der angegebene Nutzer wird als Administrator der Organisation hinzugefügt. Wenn der Nutzer nicht existiert, können Sie ihn erstellen.
  • Erstellt eine oder mehrere Umgebungen.
  • Es werden für jede Umgebung ein oder mehrere virtuelle Hosts erstellt.
  • Die Umgebung wird mit allen Nachrichtenprozessoren verknüpft.
  • Aktiviert Analysen.

Bei Verwendung des Dienstprogramms apigee-provision beträgt die maximale Länge des Namens der Organisation und der Umgebung standardmäßig 20 Zeichen. Diese Einschränkung 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, wie im folgenden Beispiel gezeigt:

/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 Administrators der Organisation. Folgende Zeichen sind im Attribut name zulässig: a-z0-9\-$%. Verwenden Sie im Namen keine Leerzeichen, Punkte oder Großbuchstaben:

APIGEE_ADMINPW=admin_password  # If omitted, you are prompted for it.
ORG_NAME=example  # lowercase only, no spaces, underscores, or periods.
ORG_ADMIN=orgAdmin@myCo.com

Das create-org-Script:

  • Die Organisation wird erstellt.
  • Verknüpft die Organisation mit dem Gateway-Pod.
  • Der angegebene Nutzer wird als Administrator der Organisation hinzugefügt. Der Nutzer muss bereits vorhanden sein. Andernfalls gibt das Script einen Fehler aus.

Organisation mit API-Aufrufen erstellen

Mit den folgenden API-Aufrufen können Sie eine Organisation erstellen. Mit dem ersten Aufruf wird die Organisation erstellt:

curl -H "Content-Type:application/xml" -u sysAdminEmail:adminPasswd \
  -X POST http://management_server_IP:8080/v1/organizations \
  -d '<Organization name="org_name" type="paid"/>'

Im 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://management_server_IP:8080/v1/organizations/org_name/pods \
  -d "region=default&pod=gateway"

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, kannst du ihn mit dem folgenden Aufruf erstellen, wie unter Nutzer hinzufügen beschrieben.

Umgebung erstellen

Verwenden Sie das Skript add-env, um eine Umgebung in einer vorhandenen Organisation zu 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=admin_password  # If omitted, you are prompted for it.
ORG_NAME=example  # lowercase only, no spaces, underscores, or periods.
ENV_NAME=prod  # lowercase only
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

Führen Sie den Befehl add-env aus:

  • Erstellt die Umgebung.
  • Erstellt einen einzelnen virtuellen Host für die Umgebung.
  • Verknüpft die Umgebung mit allen Nachrichtenprozessoren im Pod, der mit der Organisation verknüpft ist, in der sich die Umgebung befindet.
  • Aktiviert Analysen

Umgebung mit 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://management_server_IP:8080/v1/organizations/org_name/environments \
  -d  '<Environment name="env_name"/>'

Beim nächsten Aufruf wird die Umgebung mit einem Nachrichtenprozessor verknüpft. Führen Sie diesen Aufruf für jeden Nachrichtenprozessor aus, den Sie der Umgebung zuordnen möchten:

curl -H "Content-Type:application/x-www-form-urlencoded" \
  -u sysAdminEmail:adminPasswd -X POST \
  http://management_server_IP:8080/v1/organizations/org_name/environments/env_name/servers \
  -d "action=add&uuid=uuid"

Dabei ist uuid die UUID des Nachrichtenverarbeiters. Sie können die UUID mit dem Befehl abrufen:

curl http://Message_Processor_IP:8082/v1/servers/self

Dabei ist Message_Processor_IP die IP-Adresse des Nachrichten-Prozessors.

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.

Diese Konfigurationsdatei enthält Folgendes:

ORG_NAME=orgName  # lowercase only, no spaces, underscores, or periods.
ENV_NAME=envName  # lowercase only

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 das Attribut qpid-server die Qpid-UUIDs. Wenn Sie diese UUIDs abrufen möchten, verwenden Sie die folgenden Befehle.

Führen Sie für Qpid den folgenden Befehl aus:

curl -u sysAdminEmail:password http://management_server_IP/v1/servers?pod=central

Die Ausgabe dieses Befehls ist ein JSON-Objekt. Für jeden Qpid-Server wird die folgende Ausgabe angezeigt:

"type" : [ "qpid-server" ],
"uUID" : "d3c5acf0-f88a-478e-948d-6f3094f12e3b"

Führen Sie für Postgres den folgenden Befehl aus:

curl -u sysAdminEmail:passwor http://management_server_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://management_server_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 TLS-Zugriff auf eine API für die Private Cloud konfigurieren.