步驟 5:建立環境群組

在這個步驟中,您會建立環境和環境群組。

在 Apigee 中,API Proxy 會部署至環境,為 Proxy 提供獨立的環境。環境會劃分為環境群組,為部署至群組內環境的所有 Proxy 提供主機名稱。您必須至少有一個環境和至少一個環境群組。詳情請參閱「關於環境和環境群組」。

建立環境

請先建立環境,再建立環境群組。您可以使用 Apigee Hybrid UI 或 CLI 建立環境。您可能想使用 UI 執行這些步驟,以便熟悉 UI。

Apigee Hybrid UI

如要存取混合式 UI 並新增環境,請執行下列步驟:

  1. 開啟 Apigee UI。如果您是首次登入,混合式裝置會顯示同意對話方塊。如果系統提示您從多個帳戶中選取,請選擇您在「步驟 2:建立 Google Cloud 專案」中建立專案時使用的帳戶。然後按一下「允許」
  2. 瀏覽器會前往混合型 UI 的主要到達網頁:

    Apigee Hybrid 使用者介面的到達網頁,包含左側導覽列和大型圖片連結。

  3. 確認已從機構下拉式清單中選取啟用混合式功能的機構。 如果未選取,請從下拉式選單中選取,如下列範例所示:

    已啟用混合功能的機構清單

  4. 依序點選「管理」>「環境」>「總覽」

    Apigee Hybrid 使用者介面選單,顯示展開的「管理」、「環境」和「總覽」

    系統會顯示「環境」檢視畫面,但目前沒有任何環境:

    空白的「環境」檢視畫面 (沒有任何環境)

  5. 按一下「+ 環境」

    系統會顯示「New environment」(新增環境) 對話方塊:

    新的環境對話方塊

  6. 在「New Environment」(新增環境) 對話方塊中輸入以下資訊:
    1. 顯示名稱 (必填):環境的簡單名稱,用於 UI。 例如「我的第一個環境」或「測試」。與環境名稱不同,顯示名稱可包含大寫和其他特殊字元。
    2. 環境名稱 (必填):環境的程式輔助名稱,也稱為環境 ID

      例如「my-environment」或「test」。

      「顯示名稱」和「環境名稱」可以不同。

    3. 說明 (選填):環境的額外資訊,可做為環境用途的提醒。例如「在初始安裝期間建立」。
  7. 按一下 [建立]。

    Apigee 會建立新環境,並指出該環境「正在佈建」

    待佈建狀態訊息

    過一會兒,狀態會變更為「已佈建」

    已佈建新環境訊息

    不過,您尚未完成設定。您也需要在執行階段的 overrides.yaml 檔案中新增環境,但首先必須安裝執行階段,因此請先完成這項作業。

gcloud CLI

如要使用「建立環境」API 建立環境,請按照下列步驟操作:

  1. 在用於管理 Apigee 的裝置上開啟終端機。
  2. 在指令列中取得 gcloud 驗證憑證,如下列範例所示:

    TOKEN=$(gcloud auth print-access-token)

    如要確認權杖是否已填入,請使用 echo,如下列範例所示:

    echo $TOKEN

    這時應該會以編碼字串的形式顯示權杖。

    詳情請參閱 gcloud 指令列工具總覽

  3. 為環境元素建立環境變數。您會在建立該變數的指令中使用下列變數:
    • ENV_NAME (必填) 是您環境的程式輔助 ID。環境名稱可包含小寫字母、破折號和數字,但開頭必須為小寫字母。這個名稱會做為 ID 使用,且建立後即無法變更。
      export ENV_NAME=environment_name
    • ENV_DISPLAY_NAME (必填):環境的易記名稱。這個值不必是專屬值,可以包含空格和特殊字元。例如「My Example Environment」。
      ENV_DISPLAY_NAME=friendly_name
    • ORG_NAME (必填) 是您的機構 ID。請確認您已在步驟 4:建立機構中定義 ORG_NAME 環境變數:
      echo $ORG_NAME
    • ENV_DESCRIPTION (選填) 是環境相關資訊,可做為環境用途的提醒。例如「Example environment for Apigee Hybrid instructions」。
      ENV_DESCRIPTION=description_text
  4. 將通過驗證的 POST 要求傳送至 Create environments API。

    下列範例顯示建立環境的要求結構,使用的指令如下:

    curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json"   -d '{
        "name": "'"$ENV_NAME"'",
        "displayName": "'"$ENV_DISPLAY_NAME"'",
        "description": "'"$ENV_DESCRIPTION"'"
      }'   "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/environments"

    如果建立要求成功,Environments API 應會傳回類似下列內容的訊息:

    {
      "name": "organizations/hybrid-example/operations/c2aee040-7e79-4fd4-b0cf-79ca1b7098a8",
      "metadata": {
        "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
        "operationType": "INSERT",
        "targetResourceName": "organizations/hybrid-example/environments/example-env",
        "state": "IN_PROGRESS"
      }
    }

    如回應中的 state 屬性所示,Apigee 已開始建立新環境,因此其狀態為 IN_PROGRESS。這項作業可能需要幾分鐘才能完成。

建立環境群組

現在請建立環境群組,並將剛才建立的環境指派給該群組。 環境群組可讓您將環境分組,並提供主機名稱,以便將部署至群組內環境的 Proxy 路由傳送。您必須建立至少一個環境群組,並為該群組指派至少一個主機名稱。如要瞭解環境群組的總覽,請參閱「 關於環境和環境群組」。

Apigee Hybrid UI

如要使用 Apigee UI 建立環境群組,請執行下列步驟:

  1. 開啟 Apigee UI
  2. 瀏覽器會前往混合式 UI 的主要到達網頁。

  3. 確認已從機構下拉式清單中選取啟用混合式功能的機構。 如果未選取,請從下拉式清單中選取。
  4. 依序點選「管理」>「環境」>「群組」

    系統會顯示「環境群組總覽」檢視畫面,以及所有已建立的環境群組:

    環境群組檢視畫面,顯示所有已建立的群組

  5. 按一下「+ 環境群組」

    系統會顯示「Add an Environment Group」(新增環境群組) 對話方塊。

    顯示空白「名稱」欄位的「新增環境群組」對話方塊

  6. 輸入名稱,然後按一下「新增」
  7. 將指標保持置於新建立的環境群組上方,然後按一下「編輯」

    新增主機名稱,這個群組環境中部署的所有 Proxy 都會使用該名稱。這個網域必須是您有管理存取權的網域。如要註冊網域,請洽詢 Google Domains 等網域註冊商。

  8. 「編輯環境群組」視窗,顯示未指派任何環境

  9. 按一下「新增 (+)」
  10. 系統會顯示「新增環境」對話方塊。
  11. 「新增環境」對話方塊,列出可用的環境

  12. 從清單中選取環境,然後按一下「新增」

gcloud CLI

如要使用指令列建立環境群組,請執行下列步驟:

  1. 在指令列中取得 gcloud 驗證憑證,如下列範例所示:

    TOKEN=$(gcloud auth print-access-token)

    如要確認權杖是否已填入,請使用 echo,如下列範例所示:

    echo $TOKEN

    這時應該會以編碼字串的形式顯示權杖。

    詳情請參閱 gcloud 指令列工具總覽

  2. 請確認您已設定 DOMAIN 環境變數,如下列範例所示:
    echo $DOMAIN

    這是部署至這個群組內環境的所有 Proxy 都會使用的主機名稱。您必須擁有該網域的管理存取權。

    如未設定,請使用您打算用於 Apigee Hybrid 安裝作業的網域建立該記錄。 例如:

    export DOMAIN=domain-name.com
  3. 請確認 ENV_NAME 環境變數已設為您在先前步驟中建立的環境。例如:
    echo $ENV_NAME
  4. 為預期的環境群組名稱建立環境變數。例如:
    export ENV_GROUP=environment-group-name
  5. 使用下列指令建立環境群組:
    curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
       -d '{
         "name": "'"$ENV_GROUP"'",
         "hostnames":["'"$DOMAIN"'"]
       }' \
       "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups"
        
  6. 使用下列指令將環境指派給新群組:
    curl -H "Authorization: Bearer $TOKEN" -X POST -H "content-type:application/json" \
       -d '{
         "environment": "'"$ENV_NAME"'",
       }' \
       "https://apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups/$ENV_GROUP/attachments"
        

下一步

如要繼續安裝,請參閱「執行階段安裝:事前準備」。