Organisation, Umgebung und virtuellen Host erstellen

Edge for Private Cloud v4.19.01

Sie können eine Organisation, Umgebung und einen virtuellen Host über die Befehlszeile in einem einzigen oder Sie erstellen jeden einzeln. Darüber hinaus können Sie das Verwaltungs-API um viele dieser Aktionen auszuführen.

Video: Sehen Sie sich ein kurzes Video an, um einen Überblick über die Einrichtung und Konfiguration von Apigee-Organisationen zu erhalten.

Wenn Sie eine Organisation erstellen, Umgebung und virtuellem 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.

In der Regel werden Organisationen und Umgebungen gemeinsam erstellt. Verwenden Sie zur Vereinfachung dieses Vorgangs das Dienstprogramm apigee-provision. Über die Befehlszeile in Edge Management aufrufen Server:

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

Dabei ist configFile der Pfad zu einer Konfigurationsdatei, die dem folgenden Beispiel ähnelt: Folgendes:

# 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 Skript setup-org folgende Schritte aus:

  • Erstellt die Organisation.
  • Verknüpft die Organisation mit dem "Gateway" Pod. Sie können dies nicht ändern.
  • Fügt den angegebenen Nutzer als Organisationsadministrator hinzu. Wenn der Nutzer nicht vorhanden ist, erstellen können.
  • Erstellt eine oder mehrere Umgebungen.
  • Erstellt einen oder mehrere virtuelle Hosts für jede Umgebung.
  • Verbindet die Umgebung mit allen Message Processor(s).
  • Ermöglicht Analysen.

Die maximale Länge von Organisations- und Umgebungsnamen beträgt standardmäßig 20 Zeichen. wenn Sie das Dienstprogramm apigee-provision verwenden. Diese Beschränkung gilt nicht, wenn Sie das Edge API direkt zum Erstellen der Organisation oder Umgebung erstellen. Name der Organisation und Umgebung Name muss kleingeschrieben werden.

Organisation erstellen

Verwenden Sie den Befehl create-org, um eine Organisation zu erstellen, wie im folgenden Beispiel gezeigt. Shows:

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

Mit diesem Script wird die Organisation erstellt, aber die Umgebungen und virtuelle Hosts, die das Unternehmen zur Verarbeitung von API-Aufrufen benötigt.

Die Konfigurationsdatei enthält den Namen der Organisation und die E-Mail-Adresse der Organisation. Admin. Die im Attribut name zulässigen Zeichen sind auf 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 Skript create-org:

  • Erstellt die Organisation.
  • Verknüpft die Organisation mit dem "Gateway" Pod.
  • Fügt den angegebenen Nutzer als Organisationsadministrator hinzu. Der Nutzer muss bereits vorhanden sein. Andernfalls gibt das Skript einen Fehler aus.

Organisation mithilfe von API-Aufrufe

Sie können die folgenden API-Aufrufe verwenden, um eine Organisation zu erstellen. Der erste Aufruf erstellt die Organisation:

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"/>'

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

Im 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>'
<ph type="x-smartling-placeholder">

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 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 Host:

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.
  • Ordnet die Umgebung allen Message Processor(s) in dem Pod zu, der mit dem Organisation, die die Umwelt enthält.
  • Ermöglicht Analysen

Erstellen Sie eine Umgebung mithilfe von API-Aufrufe

Alternativ können Sie die folgenden API-Aufrufe verwenden, um eine Umgebung zu erstellen. Der erste Anruf schafft die Umgebung:

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"/>'

Der nächste Aufruf verknüpft die Umgebung mit einem Message Processor. 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://management_server_IP:8080/v1/organizations/org_name/environments/env_name/servers \
  -d "action=add&uuid=uuid"

Dabei ist uuid die UUID des Message Processor. Sie können die UUID mit der Methode Befehl:

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

Dabei ist Message_Processor_IP die IP-Adresse des Message Processor.

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. Dann beginnt das Analytics-Onboarding für das jeweilige Unternehmen und die jeweilige Umgebung.

Diese Konfigurationsdatei enthält Folgendes:

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

Dabei enthält die Datei sample.json 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 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 sehen Sie die Ausgabe in der Formular:

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

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

curl -u sysAdminEmail:admin_password http://management_server_IP/v1/servers?pod=analytics

Für jeden Postgres-Server wird die Ausgabe in folgendem Format angezeigt:

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

Virtuellen Host erstellen

Sie können einen virtuellen Host in einer vorhandenen Umgebung einer Organisation erstellen. Häufig mehrere virtuelle Hosts unterstützt. So kann z. B. ein virtueller Host das HTTP-Protokoll -Protokoll, während ein anderer virtueller Host in derselben Umgebung das verschlüsselte HTTPS-Protokoll Protokoll.

Verwenden Sie den folgenden API-Aufruf, um zusätzliche virtuelle Hosts oder einen virtuellen Host für Umgebung ohne virtuellen Host:

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 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.