Edge for Private Cloud v. 4.17.01
組織、環境、仮想ホストを一度に作成する
Apigee Edge に API プロキシを作成するためには、事前に 1 つ以上の組織を作成し、各組織内に 1 つ以上の環境と仮想ホストを作成する必要があります。
通常、組織と環境は一緒に作成されます。このプロセスを簡単にするには、apigee-provision ユーティリティを使用します。Edge Management Server のコマンドラインで、このユーティリティを次のように呼び出します。
> /opt/apigee/apigee-service/bin/apigee-service apigee-provision setup-org -f configFile
構成ファイルの内容は次のとおりです。
# 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. # AXGROUP=axgroup-001 # Default value is axgroup-001
このコマンドは次の処理を行います。
- 組織を作成します。
注: 組織を作成した後にその組織名を変更することはできません。 - 組織を Pod に関連付けます。デフォルトでは、この組織を「gateway」Pod に関連付けます。
- 指定したユーザーを組織管理者として追加します。ユーザーが存在しない場合は、ユーザーを作成できます。
- 1 つ以上の環境を作成する
- 環境ごとに 1 つ以上の仮想ホストを作成する
- 環境をすべての Message Processor に関連付ける
- アナリティクスを有効にする
サイレント構成ファイルの詳細については、組織のオンボーディングをご覧ください。
apigee-provision ユーティリティを使用する場合、デフォルトでは組織名と環境名は 20 文字以内に制限されます。Edge API を使用して組織または環境を直接作成する場合には、この制限は適用されません。
組織を作成する
create-org コマンドを使用して組織を作成します。
> /opt/apigee/apigee-service/bin/apigee-service apigee-provision create-org -f configFile
このスクリプトは組織を作成するだけであり、この組織で API 呼び出しを処理するために必要な環境と仮想ホストの追加や構成は行われません。
構成ファイルには、組織名と組織管理者のメールアドレスが含まれています。name 属性に使用できる文字は、a-z0-9\-$% に制限されています。名前にスペース、ピリオド、大文字の英字は使用しないでください。
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
このコマンドは次のことを行います。
- 組織を作成します。
- 組織をポッドに関連付けます。デフォルトでは、「gateway」ポッドに関連付けられます。
- 指定したユーザーを組織管理者として追加します。このユーザーはすでに存在していなければなりません。存在しない場合はエラーが返されます。
<Error>
<Code>organizations.OrganizationAlreadyExists</Code>
<Message>Organization : test already exists</Message>
<Contexts/>
</Error>
API 呼び出しを使用して組織を作成する
または、次の API 呼び出しを使用して組織を作成することもできます。最初の呼び出しで組織を作成します。
curl -H "Content-Type:application/xml" -u <sysAdminEmail>:<adminPasswd> \ -X POST http://<ms-ip>:8080/v1/organizations \ -d '<Organization name="<org-name>" type="paid"/>'
次の呼び出しは、組織をポッドに関連付けます。
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"
この呼び出しを複数回行うと、組織を複数のポッドに関連付けることができます。
最後の呼び出しで、既存のユーザーを組織管理者として追加します。
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>'
ユーザーが存在しない場合は、ユーザーの追加で説明されている呼び出しを使用してユーザーを作成できます。
環境の作成
add-env コマンドを使用して、既存の組織に環境を作成します。
> /opt/apigee/apigee-service/bin/apigee-service apigee-provision add-env -f configFile
この構成ファイルには、環境と仮想ホストを作成するのに必要な情報が含まれています。
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
コマンド:
- 環境を作成する
- 環境に単一の仮想ホストを作成する
- その環境を含む組織に関連付けられている Pod 内のすべての Message Processor に、その環境を関連付けます。
- 分析を有効にする
注: 組織内の 1 つの環境に対して Analytics を有効にする場合は、組織内のすべての環境に対して Analytics を有効にする必要があります。
API 呼び出しを使用して環境を作成する
または、次の API 呼び出しを使用して環境を作成することもできます。最初の呼び出しで、環境を作成します。
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>"/>'
次の呼び出しで、環境を Message Processor に関連付けます。この呼び出しは、環境に関連付ける Message Processor ごとに行います。
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>"
ここで、<uuid> は Message Processor の UUID です。UUID は、次のコマンドで取得できます。
> curl http://<mp-ip>:8082/v1/servers/self
ここで、<mp-ip> は Message Processor の IP アドレスです。
次の API 呼び出しで、所定の環境に対して Analytics を有効にします。この API 呼び出しでは、まず、すべてのデータセンターのポッド内で Qpid と Postgres サーバーの存在を確認します。次に、指定された組織と環境の Analytics オンボーディングを開始します。
> /opt/apigee/apigee-service/bin/apigee-service apigee-provision enable-ax -f configFile
この構成ファイルには以下が含まれます。
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"
ここで、sample.json には次のものが含まれます。
{
"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"]
}
}
postgres-servers プロパティには Postgres UUID のカンマ区切りのリストが含まれ、qpid-server プロパティには Qpid UUID が含まれます。該当する UUID を取得する場合は、次のコマンドを使用します。
Qpid の場合は、次のコマンドを実行します。
curl -u <sysAdminEmail>:<passwd> http://<ms-ip>/v1/servers?pod=central
このコマンドの出力は、JSON オブジェクトです。各 Qpid サーバーについて、次の形式の出力が表示されます。
"type" : [ "qpid-server" ], "uUID" : "d3c5acf0-f88a-478e-948d-6f3094f12e3b"
Postgres の場合は、次のコマンドを実行します。
curl -u <sysAdminEmail>:<passwd> http://<ms-ip>/v1/servers?pod=analytics
各 Postgres サーバーについて、次の形式の出力が表示されます。
"type" : [ "postgres-server" ], "uUID" : "d3c5acf0-f88a-478e-948d-6f3094f12e3b"
仮想ホストを作成する
組織の既存の環境内に仮想ホストを作成できます。多くの場合、1 つの環境で複数の仮想ホストがサポートされています。たとえば、ある仮想ホストで HTTP プロトコルをサポートし、同じ環境内の別の仮想ホストで暗号化された HTTPS プロトコルをサポートするといった具合です。
追加の仮想ホストを作成する場合、または仮想ホストのない環境に新しい仮想ホストを作成する場合は、次の API 呼び出しを使用します。
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>9002</Port> \
</VirtualHost>'
HTTPS で TLS/SSL を使用するセキュアな仮想ホストの作成方法など、仮想ホストを作成する方法について詳しくは、http://apigee.com/docs/api-services/content/creating-virtual-host をご覧ください。