建立機構、環境和虛擬主機

私有雲的邊緣 4.16.05 版

同時建立機構、環境和虛擬主機

您必須先建立至少一個機構,並在每個機構中建立一或多個環境和虛擬主機,才能在 Apigee Edge 中建立 API Proxy。

機構和環境通常會一起建立。如要簡化這項程序,請使用 apigee-provision 公用程式。從 Edge Management Server 的指令列叫用權杖:

> /<inst_root>/apigee/apigee-service/bin/apigee-service apigee-provision setup-org -f configFile

設定檔中包含:

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 建立關聯
  • 將指定使用者新增為機構組織管理員。如果使用者不存在,您可以建立一個。
  • 建立一或多個環境
  • 為每個環境建立一或多個虛擬主機
  • 將環境與所有訊息處理器建立關聯
  • 啟用數據分析功能

如需完整的無訊息設定檔,請參閱「為機構加入」。

根據預設,使用 apigee-provision 公用程式時,機構名稱和環境名稱的長度上限為 20 個字元。如果您直接使用 Edge API 建立機構或環境,則不適用這項限制。

建立機構

使用 create-org 指令建立機構:

> /<inst_root>/apigee/apigee-service/bin/apigee-service apigee-provision create-org -f configFile

這個指令碼會建立機構,但不會新增或設定機構所需的環境和虛擬主機來處理 API 呼叫。

設定檔中包含機構名稱和機構管理員的電子郵件地址。您可在名稱屬性中使用的字元僅限: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

指令隨後會:

  • 建立機構
  • 根據預設,建立機構與 Pod 的關聯
  • 將指定使用者新增為機構組織管理員。使用者必須已存在;否則指令碼會發生錯誤。
<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"/>'

下一次呼叫會將機構與 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" 

您可以多次進行這項呼叫,將機構與多個 Pod 建立關聯。

在最終呼叫中,系統會將現有使用者新增為機構組織的管理員:

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 指令在現有機構中建立環境:

> /<inst_root>/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 中與包含環境機構相關聯的所有訊息處理器建立關聯。
  • 啟用數據分析
    注意:如果您為機構中的某個環境啟用數據分析功能,就必須為機構組織中的所有環境啟用數據分析功能。

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

下一次呼叫會將環境與訊息處理器建立關聯。請為要與環境建立關聯的每個訊息處理器進行這個呼叫:

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>」是訊息處理器的 UUID。您可以使用下列指令取得 UUID:

> curl http://<mp-ip>:8082/v1/servers/self

其中「<mp-ip>」是訊息處理器的 IP 位址。

下一個 API 呼叫會為指定環境啟用 Analytics (分析)。驗證 Qpid 和 Postgres 伺服器確實存在於所有資料中心的 POD 中。接著,系統就會在指定機構組織和環境上開始使用 Analytics (分析)。

> /<inst_root>/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 包含 Analytics (分析) 新手上路的項目。如需 JSON 檔案,請與 Apigee 支援團隊聯絡。

建立虛擬主機

您可以在機構的現有環境中建立虛擬主機。一個環境通常會支援多個虛擬主機。舉例來說,一個虛擬主機可能支援 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>443</Port> \
  </VirtualHost>' 

如需建立虛擬主機的完整說明,包括建立透過 HTTPS 使用 TLS/SSL 的安全虛擬主機,請參閱 http://apigee.com/docs/api-services/content/creating-virtual-host