佈建不含虛擬私有雲對等互連的付費機構

本頁內容適用於 Apigee,但不適用於 Apigee Hybrid

查看 Apigee Edge 說明文件。

本文說明如何不透過 VPC 對等互連,從指令列安裝及設定 Apigee。這些步驟適用於付費機構的訂閱和隨用隨付計價模式,無論是否啟用資料存放位置皆可使用。

另請參閱佈建選項

限制

本文所述的非 VPC 對等互連安裝選項有以下限制:

如需非 VPC 對等互連支援和不支援的功能與網路方法完整清單,請參閱「如何選擇網路選項」。

步驟摘要

佈建步驟如下:

步驟 1:定義環境變數

設定 gcloud 並定義環境變數,以供後續步驟使用:

  1. 請務必先完成「 事前準備」一文列出的設定需求。
  2. 您必須安裝 Cloud SDK。如需安裝,請參閱「 安裝 Cloud SDK」。
  3. 如「初始化 gcloud CLI」一文所述,初始化 Cloud SDK,或確保您在「必要條件」中建立的 Google Cloud 專案是 gcloud 的預設專案。
  4. 在指令終端機中定義下列環境變數。 選取與所需機構類型對應的分頁: 沒有資料落地或有 資料落地

    沒有資料落地

    AUTH="$(gcloud auth print-access-token)"
    PROJECT_ID="YOUR_PROJECT_ID"
    PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID --format="value(projectNumber)")
    RUNTIME_LOCATION="YOUR_RUNTIME_LOCATION"
    ANALYTICS_REGION="YOUR_ANALYTICS_REGION"
    BILLING_TYPE="YOUR_BILLING_TYPE"

    其中:

    • AUTH 會定義含有不記名權杖的 Authentication 標頭。呼叫 Apigee API 時,您會使用這個標頭。請注意,權杖會在一段時間後過期,屆時您只要使用相同指令重新產生即可。詳情請參閱「 print-access-token 指令」參考頁面。
    • PROJECT_ID 是您在必要條件中建立的 Cloud 專案 ID。
    • PROJECT_NUMBER 是您在必要條件中建立的 Cloud 專案編號。
    • RUNTIME_LOCATION 是您稍後建立的 Apigee 執行個體所在實際位置。如需可用執行階段位置清單,請參閱 Apigee 位置

    • ANALYTICS_REGION 是指 Apigee 數據分析資料的實際儲存位置。如需 Apigee API Analytics 可用區域的清單,請參閱「 Apigee 位置」。

      RUNTIME_LOCATIONANALYTICS_REGION 可以是相同區域,但並非必要。

    • BILLING_TYPE 是您建立機構的帳單類型。有效的值包括:

    資料落地

    AUTH="$(gcloud auth print-access-token)"
    PROJECT_ID="YOUR_PROJECT_ID"
    PROJECT_NUMBER=$(gcloud projects describe $PROJECT_ID --format="value(projectNumber)")
    RUNTIME_LOCATION="YOUR_RUNTIME_LOCATION"
    CONTROL_PLANE_LOCATION="YOUR_CONTROL_PLANE_LOCATION"
    CONSUMER_DATA_REGION="YOUR_CONSUMER_DATA_REGION"
    BILLING_TYPE="YOUR_BILLING_TYPE"

    其中:

    • AUTH 會定義含有不記名權杖的 Authentication 標頭。呼叫 Apigee API 時,您會使用這個標頭。請注意,權杖會在一段時間後過期,屆時您只要使用相同指令重新產生即可。詳情請參閱「 print-access-token 指令」參考頁面。
    • PROJECT_ID 是您在必要條件中建立的 Cloud 專案 ID。
    • PROJECT_NUMBER 是您在必要條件中建立的 Cloud 專案編號。
    • RUNTIME_LOCATION 是您稍後建立的 Apigee 執行個體所在實際位置。如需可用執行階段位置清單,請參閱 Apigee 位置

      執行階段位置必須位於控制層位置內。
    • CONTROL_PLANE_LOCATION 是 Apigee 控制平面資料的實際儲存位置。 如需可用的控制層位置清單,請參閱 Apigee 位置
    • CONSUMER_DATA_REGION 是控制層區域的子區域。您必須同時指定 CONTROL_PLANE_LOCATION 和 CONSUMER_DATA_REGION。 如需可用的消費者資料地區清單,請參閱 Apigee 位置
    • BILLING_TYPE 是您建立機構的帳單類型。有效的值包括:

  5. (選用) 透過回顯剛才設定的值,檢查您的工作。請注意,如要在指令中使用變數,請在變數名稱前加上美元符號 ($)。

    沒有資料落地

    echo $AUTH
    echo $PROJECT_ID
    echo $PROJECT_NUMBER
    echo $RUNTIME_LOCATION
    echo $ANALYTICS_REGION
    echo $BILLING_TYPE
    

    echo 指令的回應內容應如下所示:

    YOUR_TOKEN
    my-cloud-project
    1234567890
    us-west1
    us-west1
    SUBSCRIPTION
    

    資料落地

    echo $AUTH
    echo $PROJECT_ID
    echo $PROJECT_NUMBER
    echo $RUNTIME_LOCATION
    echo $CONTROL_PLANE_LOCATION
    echo $CONSUMER_DATA_REGION
    echo $BILLING_TYPE
    

    echo 指令的回應內容應如下所示:

    YOUR_TOKEN
    my-cloud-project
    1234567890
    us-west1
    us
    us-west1
    SUBSCRIPTION
    

步驟 2:啟用 API

  1. Apigee 需要啟用多個 Google Cloud API。執行下列 services enable 指令來啟用這些 API:

    gcloud services enable apigee.googleapis.com \
        apihub.googleapis.com \
        compute.googleapis.com \
        cloudkms.googleapis.com --project=$PROJECT_ID
  2. (選用) 如要檢查作業,請使用 services list 指令顯示所有已啟用的 API:

    gcloud services list

    回應會顯示所有已啟用的服務,包括您剛啟用的 API。

步驟 3:建立 Apigee 服務身分

  1. 建立 Apigee 服務身分

    gcloud beta services identity create --service=apigee.googleapis.com \
      --project=$PROJECT_ID
  2. 確認代理程式已成功建立。回覆應以以下格式顯示代理程式名稱:service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com。例如:

    Service identity created: service-1234567890@gcp-sa-apigee.iam.gserviceaccount.com

步驟 4:建立機構

建立機構前,您必須先建立執行階段資料庫加密金鑰環和金鑰 (請參閱步驟 1),並視情況建立控制平面加密金鑰環和金鑰 (請參閱步驟 2)。這些 Cloud KMS 金鑰會加密儲存及複製到執行階段和控制層位置的資料。Apigee 會使用這些實體加密應用程式資料 (例如 KVM、快取和用戶端密鑰),然後儲存在資料庫中。詳情請參閱「 關於 Apigee 加密金鑰」。

  1. 建立執行階段資料庫加密金鑰環和金鑰。

    1. 定義執行階段資料庫加密環和金鑰位置的環境變數。這有助於確保建立時的一致性,並方便您在說明文件中追蹤。

      這個值是儲存執行階段資料庫加密金鑰環和金鑰的實體位置。

      單一區域

      單一區域設定 (只有一個區域中的一個執行個體):從支援的 KMS 區域位置中選擇。

      例如:

      RUNTIMEDBKEY_LOCATION="us-west1"

      這個值可以與 $RUNTIME_LOCATION (也是區域) 相同,但並非必要。不過,如果兩者相同,效能可能會有所提升。

      多區域

      多區域設定:從支援的多區域位置 (例如 useurope) 或雙區域位置中選擇。

      例如:

      RUNTIMEDBKEY_LOCATION="us"

      如果您在美國有多區域設定,建議盡可能使用 us 做為位置。否則請使用 nam4

    2. 定義資料庫金鑰環和金鑰名稱的環境變數。

      金鑰環名稱不得與貴機構重複。如果您建立第二個或後續區域,名稱不得與其他金鑰環的名稱相同。

      RUNTIMEDB_KEY_RING_NAME=YOUR_DB_KEY_RING_NAME
      RUNTIMEDB_KEY_NAME=YOUR_DB_KEY_NAME
    3. (選用) 透過回顯剛才設定的值,檢查您的工作。請注意,如要在指令中使用變數,請在變數名稱前加上美元符號 ($)。
      echo $RUNTIMEDBKEY_LOCATION
      echo $RUNTIMEDB_KEY_RING_NAME
      echo $RUNTIMEDB_KEY_NAME
    4. 建立新的金鑰環:
      gcloud kms keyrings create $RUNTIMEDB_KEY_RING_NAME \
        --location $RUNTIMEDBKEY_LOCATION --project $PROJECT_ID

      Apigee 執行階段資料庫加密金鑰的位置支援所有支援 Cloud HSMCloud EKM 的 Cloud KMS 位置。

    5. 建立金鑰:

      gcloud kms keys create $RUNTIMEDB_KEY_NAME \
        --keyring $RUNTIMEDB_KEY_RING_NAME \
        --location $RUNTIMEDBKEY_LOCATION \
        --purpose "encryption" \
        --project $PROJECT_ID

      這項指令會建立金鑰並新增至金鑰環。

      取得金鑰 ID:

      gcloud kms keys list \
        --location=$RUNTIMEDBKEY_LOCATION \
        --keyring=$RUNTIMEDB_KEY_RING_NAME \
        --project=$PROJECT_ID

      金鑰 ID 的語法如下 (類似於檔案路徑):

      projects/PROJECT_ID/locations/RUNTIMEDBKEY_LOCATION/keyRings/RUNTIMEDB_KEY_RING_NAME/cryptoKeys/RUNTIMEDB_KEY_NAME
    6. 將金鑰 ID 放在環境變數中。您將在後續指令中使用此變數:

      RUNTIMEDB_KEY_ID=YOUR_RUNTIMEDB_KEY_ID
    7. 授予 Apigee 服務代理人使用新金鑰的權限:

      gcloud kms keys add-iam-policy-binding $RUNTIMEDB_KEY_NAME \
        --location $RUNTIMEDBKEY_LOCATION \
        --keyring $RUNTIMEDB_KEY_RING_NAME \
        --member serviceAccount:service-$PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com \
        --role roles/cloudkms.cryptoKeyEncrypterDecrypter \
        --project $PROJECT_ID

      這項指令會將金鑰繫結至 Apigee 服務代理。

      成功完成這項要求後,gcloud 會傳回類似下列內容的回應:

      Updated IAM policy for key [runtime].
      bindings:
      - members:
        - serviceAccount:service-1234567890@gcp-sa-apigee.iam.gserviceaccount.com
        role: roles/cloudkms.cryptoKeyEncrypterDecrypter
      etag: BwWqgEuCuwk=
      version: 1

      如果收到類似下方的錯誤訊息:

      INVALID_ARGUMENT: Role roles/cloudkms.cryptokms.cryptoKeyEncrypterDecrypter is not supported for this resource.

      請務必使用專案編號,而非專案名稱,做為服務帳戶電子郵件地址。

  2. 如果您使用 資料駐留,請建立控制平面加密金鑰環和金鑰。如果未使用資料落地機制,請前往步驟 3
  3. 請執行下列步驟,建立控制層加密金鑰環和金鑰。

    1. 定義控制層資料庫加密環和金鑰位置的環境變數:
      CONTROL_PLANE_LOCATION=YOUR_CONTROL_PLANE_LOCATION
      CONSUMER_DATA_REGION=YOUR_CONSUMER_DATA_REGION

      其中:

      • CONTROL_PLANE_LOCATION 是 Apigee 控制平面資料的實際儲存位置。 如需可用的控制層位置清單,請參閱 Apigee 位置
      • CONSUMER_DATA_REGION 是控制層區域的子區域。您必須同時指定 CONTROL_PLANE_LOCATION 和 CONSUMER_DATA_REGION。 如需可用的消費者資料地區清單,請參閱 Apigee 位置
    2. 定義控制層資料庫金鑰環和金鑰名稱的環境變數。

      金鑰環名稱不得與貴機構重複。

      CONTROL_PLANE_KEY_RING_NAME=YOUR_CONTROL_PLANE_KEY_RING_NAME
      CONTROL_PLANE_KEY_NAME=YOUR_CONTROL_PLANE_KEY_NAME
      CONSUMER_DATA_KEY_RING_NAME=YOUR_CONSUMER_DATA_KEY_RING_NAME
      CONSUMER_DATA_KEY_NAME=YOUR_CONSUMER_DATA_REGION_KEY_NAME

      其中:

      • CONTROL_PLANE_KEY_RING_NAME 是用來識別控制平面加密金鑰環的金鑰環名稱。
      • 「CONTROL_PLANE_KEY_NAME」CONTROL_PLANE_KEY_NAME是您用來識別控制平面加密金鑰的金鑰名稱。
      • CONSUMER_DATA_KEY_RING_NAME 是用來識別消費者資料區域加密金鑰環的金鑰環名稱。
      • 「CONSUMER_DATA_KEY_NAME」CONSUMER_DATA_KEY_NAME是您用來識別消費者資料區域加密金鑰的金鑰名稱。
    3. 建立新的金鑰環:
      gcloud kms keyrings create $CONTROL_PLANE_KEY_RING_NAME \
        --location $CONTROL_PLANE_LOCATION \
        --project $PROJECT_ID
      gcloud kms keyrings create $CONSUMER_DATA_KEY_RING_NAME \
        --location $CONSUMER_DATA_REGION \
        --project $PROJECT_ID
    4. 建立金鑰:
      gcloud kms keys create $CONTROL_PLANE_KEY_NAME \
        --keyring $CONTROL_PLANE_KEY_RING_NAME \
        --location $CONTROL_PLANE_LOCATION \
        --purpose "encryption" \
        --project $PROJECT_ID
      gcloud kms keys create $CONSUMER_DATA_KEY_NAME \
        --keyring $CONSUMER_DATA_KEY_RING_NAME \
        --location $CONSUMER_DATA_REGION \
        --purpose "encryption" \
        --project $PROJECT_ID

      這項指令會建立金鑰並新增至金鑰環。

      取得金鑰 ID:

      gcloud kms keys list \
      --location=$CONTROL_PLANE_LOCATION \
      --keyring=$CONTROL_PLANE_KEY_RING_NAME \
      --project=$PROJECT_ID
      gcloud kms keys list \
      --location=$CONSUMER_DATA_REGION \
      --keyring=$CONSUMER_DATA_KEY_RING_NAME \
      --project=$PROJECT_ID

      金鑰 ID 的語法如下 (類似於檔案路徑):

      projects/PROJECT_ID/locations/CONTROL_PLANE_LOCATION/keyRings/CONTROL_PLANE_KEY_RING_NAME/cryptoKeys/CONTROL_PLANE_KEY_NAME
      projects/PROJECT_ID/locations/CONSUMER_DATA_REGION/keyRings/CONSUMER_DATA_KEY_RING_NAME/cryptoKeys/CONSUMER_DATA_KEY_NAME
    5. 將金鑰 ID 放在環境變數中。您將在後續指令中使用此變數:
      CONTROL_PLANE_KEY_ID=YOUR_CONTROL_PLANE_KEY_ID
      
      CONSUMER_DATA_KEY_ID=YOUR_CONSUMER_DATA_KEY_ID
    6. 授予 Apigee 服務代理人使用新金鑰的權限:
      gcloud kms keys add-iam-policy-binding $CONTROL_PLANE_KEY_NAME \
        --location $CONTROL_PLANE_LOCATION \
        --keyring $CONTROL_PLANE_KEY_RING_NAME \
        --member "serviceAccount:service-$PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com" \
        --role roles/cloudkms.cryptoKeyEncrypterDecrypter \
        --project $PROJECT_ID
      
      gcloud kms keys add-iam-policy-binding $CONSUMER_DATA_KEY_NAME \
       --location $CONSUMER_DATA_REGION \
       --keyring $CONSUMER_DATA_KEY_RING_NAME \
       --member "serviceAccount:service-$PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com" \
       --role roles/cloudkms.cryptoKeyEncrypterDecrypter \
       --project $PROJECT_ID
      

      這項指令會將金鑰繫結至 Apigee 服務代理。成功完成這項要求後,gcloud 會傳回類似下列內容的回應:

      Updated IAM policy for key [runtime].
      bindings:
      - members:
        - serviceAccount:service-1234567890@gcp-sa-apigee.iam.gserviceaccount.com
        role: roles/cloudkms.cryptoKeyEncrypterDecrypter
      etag: BwWqgEuCuwk=
      version: 1

      如果收到類似下方的錯誤訊息:

      INVALID_ARGUMENT: Role roles/cloudkms.cryptokms.cryptoKeyEncrypterDecrypter is not supported for this resource.

      請確認您在服務帳戶電子郵件地址中使用的是專案編號,而非專案名稱。

    另請參閱: CMEK 疑難排解

  4. 如要建立機構,請將下列要求傳送至 Apigee 機構 API

    沒有資料落地

    curl "https://apigee.googleapis.com/v1/organizations?parent=projects/$PROJECT_ID"  \
      -H "Authorization: Bearer $AUTH" \
      -X POST \
      -H "Content-Type:application/json" \
      -d '{
        "name":"'"$PROJECT_ID"'",
        "analyticsRegion":"'"$ANALYTICS_REGION"'",
        "runtimeType":"CLOUD",
        "billingType":"'"$BILLING_TYPE"'",
        "disableVpcPeering":"true",
        "runtimeDatabaseEncryptionKeyName":"'"$RUNTIMEDB_KEY_ID"'"
      }'

    其中:

    • -d 定義要求的資料酬載。這項酬載必須包含下列項目:
      • name:用來識別新機構。名稱必須與專案 ID 相同。

      • analyticsRegion:指定要儲存 Analytics 資料的實體位置。

      • runtimeType:將這個值設為 CLOUD
      • billingType:指定所建立機構的帳單類型。
      • disableVpcPeering:如不想使用虛擬私有雲對等互連,請設為 true。預設值:false
      • runtimeDatabaseEncryptionKeyName:您在上一個步驟中建立的應用程式加密金鑰 ID。請注意,ID 的結構類似檔案路徑。例如:
        projects/my-project/locations/us-west1/keyRings/my-key-ring/cryptoKeys/my-key

    資料落地

    使用 API 建立機構

    curl "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations?parent=projects/$PROJECT_ID"  \
      -H "Authorization: Bearer $AUTH" \
      -X POST \
      -H "Content-Type:application/json" \
      -d '{
        "name":"'"$PROJECT_ID"'",
        "runtimeType":"CLOUD",
        "billingType":"'"$BILLING_TYPE"'",
        "controlPlaneEncryptionKeyName":"'"$CONTROL_PLANE_KEY_ID"'",
        "apiConsumerDataLocation":"'"$CONSUMER_DATA_REGION"'",
        "apiConsumerDataEncryptionKeyName":"'"$CONSUMER_DATA_KEY_ID"'",
        "disableVpcPeering":"true",
        "runtimeDatabaseEncryptionKeyName":"'"$RUNTIMEDB_KEY_ID"'"
      }'

    其中:

    -d 定義要求的資料酬載。這個酬載必須包含下列項目:

    • name:用來識別新機構。名稱必須與專案 ID 相同。
    • runtimeType:將這個值設為 CLOUD
    • billingType:指定所建立機構的帳單類型。
    • controlPlaneEncryptionKeyName:是您的控制平面金鑰 ID。
    • apiConsumerDataLocation:您也必須指定子區域,供內部資源使用。如需支援的值,請參閱「 資料落地區域」。
    • apiConsumerDataEncryptionKeyName:是消費者資料區域金鑰 ID。
    • disableVpcPeering:如不想使用虛擬私有雲對等互連,請設為 true。預設值:false
    • runtimeDatabaseEncryptionKeyName:您在上一個步驟中建立的應用程式加密金鑰 ID。請注意,ID 的結構類似於檔案路徑。例如:
      projects/my-project/locations/us-west1/keyRings/my-key-ring/cryptoKeys/my-key

    執行這項指令後,Apigee 會啟動長期執行作業,可能需要幾分鐘才能完成。

    如果發生錯誤,請檢查資料酬載中的變數值是否以半形引號括住。請務必在 $PROJECT_ID 變數前後加上雙引號,如以下範例所示:

    "'"$PROJECT_ID"'"

    如果要求值使用純字串 (而非環境變數),您可以在單引號括住的酬載字串中,以雙引號括住這些字串,如下例所示:

    '{ "name":"my-gcp-project", ... }'
  5. 請稍候片刻。
  6. 如要查看建立要求狀態,您可以將 GET 要求傳送至 Apigee List organizations API,如下列範例所示:

    沒有資料落地

    curl -H "Authorization: Bearer $AUTH" "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID"

    資料落地

    curl -H "Authorization: Bearer $AUTH" "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID"

    如果看到這則回應,表示機構尚未建立完成:

    {
      "error": {
        "code": 403,
        "message": "Permission denied on resource \"organizations/apigee-docs-m\" (or it may not exist)",
        "status": "PERMISSION_DENIED"
      }
    }

    成功後,回應物件會顯示 "state": "ACTIVE",您可以繼續下一個步驟。

    如果 Apigee 傳回 HTTP 錯誤回應,請參閱 建立 Apigee 機構

步驟 5:建立執行階段執行個體

執行階段例項會儲存 Apigee 專案和相關服務,並為服務提供面向使用者的端點。如要建立新的執行階段例項,請按照下列步驟操作:

  1. 確認 Apigee 已完成建立機構。您已在「建立 Apigee 機構」中提交建立新機構的要求,但請務必確認要求已完成,再繼續操作。

    如要這麼做,請將下列要求傳送至機構 API

    沒有資料落地

    curl -i -H "Authorization: Bearer $AUTH" \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID"

    資料落地

    curl -i -H "Authorization: Bearer $AUTH" \
        "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID"

    如果機構存在 (且您有適當的檢視權限),Apigee 會回覆機構的詳細資料。如果 Apigee 回應錯誤,請稍候幾分鐘,然後再次傳送要求。

  2. 與先前為資料庫建立加密金鑰的作業類似,現在您需要建立 Cloud KMS 金鑰,用於加密伺服器端的資料。首先,請定義下列環境變數:
    INSTANCE_NAME=YOUR_INSTANCE_NAME
    RUNTIME_LOCATION=YOUR_RUNTIME_LOCATION
    DISK_KEY_RING_NAME=YOUR_DISK_KEY_RING_NAME
    DISK_KEY_NAME=YOUR_DISK_KEY_NAME
  3. 其中:

    • INSTANCE_NAME:新執行個體的名稱。例如:my-runtime-instance。名稱開頭須為小寫英文字母,長度上限為 32 個字元,且只能包含小寫英文字母、數字和連字號。開頭或結尾不得為連字號,且長度至少須為兩個字元。
    • RUNTIME_LOCATION 是叢集代管的實體位置。 有效值為 Compute Engine 允許的任何位置。(請參閱可用地區和區域)。本範例使用 us-west1
    • DISK_KEY_RING_NAME 是磁碟加密金鑰環的名稱。
    • DISK_KEY_NAME 是磁碟加密金鑰的名稱。
  4. 建立磁碟加密金鑰:
    1. 建立新的磁碟金鑰環:
      gcloud kms keyrings create $DISK_KEY_RING_NAME \
        --location $RUNTIME_LOCATION \
        --project $PROJECT_ID

      磁碟金鑰環必須設為與執行個體相同的位置。每個執行個體和金鑰環都應有自己的位置。

    2. 建立新的磁碟金鑰:
      gcloud kms keys create $DISK_KEY_NAME \
        --keyring $DISK_KEY_RING_NAME \
        --location $RUNTIME_LOCATION \
        --purpose "encryption" \
        --project $PROJECT_ID

      您可以透過金鑰路徑參照金鑰。您可以使用下列指令取得金鑰路徑:

      gcloud kms keys list \
        --location=$RUNTIME_LOCATION \
        --keyring=$DISK_KEY_RING_NAME \
        --project=$PROJECT_ID

      金鑰路徑看起來會與下列內容相似:

      projects/PROJECT_ID/locations/RUNTIME_LOCATION/keyRings/my-disk-key-ring/cryptoKeys/my-disk-key
    3. 將金鑰路徑放在環境變數中。您將在後續指令中使用這個變數:

      DISK_KEY_ID=YOUR_DISK_KEY_ID

      例如:DISK_KEY_ID=projects/my-project/locations/us-west1/keyRings/my-key-ring/cryptoKeys/my-key

    4. 授予 Apigee 服務代理人使用新金鑰的權限:

      gcloud kms keys add-iam-policy-binding $DISK_KEY_NAME \
        --location $RUNTIME_LOCATION \
        --keyring $DISK_KEY_RING_NAME \
        --member serviceAccount:service-$PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com \
        --role roles/cloudkms.cryptoKeyEncrypterDecrypter \
        --project $PROJECT_ID

      這項指令會將金鑰繫結至 Apigee 服務代理。

    詳情請參閱「關於 Apigee 加密金鑰」。

  5. POST 要求傳送至 Apigee Instances API,為專案建立新的執行階段執行個體:

    沒有資料落地

    curl "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances" \
      -X POST -H "Authorization: Bearer $AUTH" \
      -H "Content-Type:application/json" \
      -d '{
        "name":"'"$INSTANCE_NAME"'",
        "location":"'"$RUNTIME_LOCATION"'",
        "diskEncryptionKeyName":"'"$DISK_KEY_ID"'",
        "consumerAcceptList":["'"$PROJECT_ID"'"]
      }'

    資料落地

    curl "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances" \
      -X POST -H "Authorization: Bearer $AUTH" \
      -H "Content-Type:application/json" \
      -d '{
        "name":"'"$INSTANCE_NAME"'",
        "location":"'"$RUNTIME_LOCATION"'",
        "diskEncryptionKeyName":"'"$DISK_KEY_ID"'",
        "consumerAcceptList":["'"$PROJECT_ID"'"]
      }'

    其中:

    • consumerAcceptList (選用) 指定可私下連線至 Apigee VPC 服務附件的 Google Cloud 專案 ID 清單。服務連結是搭配 Google Cloud Private Service Connect 使用的實體,可讓服務供應商 (在本例中為 Apigee) 向服務消費者 (在本例中為您擁有的 Cloud 專案) 公開服務。根據預設,我們會使用已與 Apigee 機構建立關聯的 Cloud 專案。例如: "consumerAcceptList": ["project1", "project2", "project3"]

      請注意,您也可以在執行個體使用者介面中設定及變更接受的專案清單。詳情請參閱「 管理執行個體」。

    這項要求最多可能需要 20 分鐘才能完成,因為 Apigee 必須建立及啟動新的 Kubernetes 叢集、在該叢集上安裝 Apigee 資源,並設定負載平衡。

    如果 Apigee 傳回錯誤,請參閱「 建立新執行個體」。

  6. 如要檢查執行階段執行個體建立要求的狀態,請執行下列指令。狀態為「ACTIVE」時,即可繼續下一個步驟。

    沒有資料落地

    curl -i -X GET -H "Authorization: Bearer $AUTH" \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances/$INSTANCE_NAME"

    資料落地

    curl -i -X GET -H "Authorization: Bearer $AUTH" \
        "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances/$INSTANCE_NAME"

步驟 6:建立環境

如要建立環境並透過指令列將其附加至執行階段,請執行下列操作:

  1. 定義本節中使用的環境變數。您建立的特定環境變數,取決於您是為訂閱還是隨用隨付機構建立環境。

    訂閱

    如果是訂閱環境,請建立下列變數:

    ENVIRONMENT_NAME="YOUR_ENV_NAME"
    ENV_GROUP_NAME="YOUR_ENV_GROUP_NAME"
    ENV_GROUP_HOSTNAME="YOUR_ENV_GROUP_HOSTNAME"

    其中:

    • ENVIRONMENT_NAME 是字串名稱。例如:test
    • ENV_GROUP_NAME 是字串名稱。例如:test-group
    • ENV_GROUP_HOSTNAME 是有效的網域主機名稱。例如:foo.example.com

    即付即用

    如果是隨用隨付環境,請建立下列變數:

    ENVIRONMENT_NAME="YOUR_ENV_NAME"
    ENVIRONMENT_TYPE="YOUR_ENV_TYPE"
    ENV_GROUP_NAME="YOUR_ENV_GROUP_NAME"
    ENV_GROUP_HOSTNAME="YOUR_ENV_GROUP_HOSTNAME"

    其中:

    • ENVIRONMENT_NAME 是字串名稱。例如:test
    • ENVIRONMENT_TYPE 是這個環境的環境類型,僅適用於Pay-as-you-go使用者,且使用者必須指定下列其中一個值:BASEINTERMEDIATECOMPREHENSIVE。其他使用者應省略環境類型。
    • ENV_GROUP_NAME 是字串名稱。例如:test-group
    • ENV_GROUP_HOSTNAME 是有效的網域主機名稱。例如:foo.example.com
  2. 使用 Environments API 建立新環境。您使用的具體指令取決於您是為訂閱還是隨用隨付機構建立環境。

    訂閱

    如果是新的訂閱環境,請使用下列指令:

    沒有資料落地

    curl "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments" \
        -H "Authorization: Bearer $AUTH" \
        -X POST \
        -H "Content-Type:application/json" \
        -d '{
          "name":"'"$ENVIRONMENT_NAME"'"
      }'

    資料落地

    curl "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments" \
        -H "Authorization: Bearer $AUTH" \
        -X POST \
        -H "Content-Type:application/json" \
        -d '{
          "name":"'"$ENVIRONMENT_NAME"'"
      }'

    Apigee 會建立新環境。

    即付即用

    如要使用新的隨用隨付環境,請執行下列指令:

    沒有資料落地

    curl "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments" \
        -H "Authorization: Bearer $AUTH" \
        -X POST \
        -H "Content-Type:application/json" \
        -d '{
          "name":"'"$ENVIRONMENT_NAME"'",
          "type":"'"$ENVIRONMENT_TYPE"'"
      }'

    資料落地

    curl "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments" \
        -H "Authorization: Bearer $AUTH" \
        -X POST \
        -H "Content-Type:application/json" \
        -d '{
          "name":"'"$ENVIRONMENT_NAME"'",
          "type":"'"$ENVIRONMENT_TYPE"'"
      }'

    Apigee 會建立新環境。

  3. 繼續操作前,請先呼叫 Environments API,確認 Apigee 已建立新環境:

    沒有資料落地

    curl -i -H "Authorization: Bearer $AUTH" \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments"

    資料落地

    curl -i -H "Authorization: Bearer $AUTH" \
        "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments"

    Apigee 會傳回可用環境的清單。舉例來說,如果您的環境名稱為 test,Apigee 會傳回下列內容:

    [
      "test"
    ]
  4. 將新環境附加至執行階段執行個體:

    沒有資料落地

    curl "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances/$INSTANCE_NAME/attachments" \
        -X POST -H "Authorization: Bearer $AUTH" \
        -H "content-type:application/json" \
        -d '{
          "environment":"'"$ENVIRONMENT_NAME"'"
        }'

    資料落地

    curl "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances/$INSTANCE_NAME/attachments" \
        -X POST -H "Authorization: Bearer $AUTH" \
        -H "content-type:application/json" \
        -d '{
          "environment":"'"$ENVIRONMENT_NAME"'"
        }'

    這項作業可能需要幾分鐘才能完成。如要檢查附件是否已完成,請執行下列指令:

    沒有資料落地

    curl -i -H "Authorization: Bearer $AUTH" \
      "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances/$INSTANCE_NAME/attachments"

    資料落地

    curl -i -H "Authorization: Bearer $AUTH" \
      "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances/$INSTANCE_NAME/attachments"

    看到類似下列內容的輸出內容時,即可前往下一個步驟:

    {
      "attachments": [
        {
          "name": "ed628782-c893-4095-b71c-f4731805290a",
          "environment": "test",
          "createdAt": "1641604447542"
        }
      ]
    }
  5. 使用下列指令建立新的環境群組。詳情請參閱「關於環境和環境群組」:

    沒有資料落地

    curl "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/envgroups" \
        -H "Authorization: Bearer $AUTH" \
        -X POST \
        -H "Content-Type:application/json" \
        -d '{
          "name": "'"$ENV_GROUP_NAME"'",
          "hostnames":["'"$ENV_GROUP_HOSTNAME"'"]
      }'

    資料落地

    curl "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/envgroups" \
        -H "Authorization: Bearer $AUTH" \
        -X POST \
        -H "Content-Type:application/json" \
        -d '{
          "name": "'"$ENV_GROUP_NAME"'",
          "hostnames":["'"$ENV_GROUP_HOSTNAME"'"]
      }'
  6. 等待作業完成,您可以透過下列要求查看新群組的狀態:

    沒有資料落地

    curl -i -H "Authorization: Bearer $AUTH" \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/envgroups/$ENV_GROUP_NAME"

    資料落地

    curl -i -H "Authorization: Bearer $AUTH" \
        "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/envgroups/$ENV_GROUP_NAME"
  7. 使用下列指令,將新環境連結至新環境群組:

    沒有資料落地

    curl "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/envgroups/$ENV_GROUP_NAME/attachments" \
        -X POST \
        -H "Authorization: Bearer $AUTH" \
        -H "content-type:application/json" \
        -d '{
          "environment":"'"$ENVIRONMENT_NAME"'"
      }'

    資料落地

    curl "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/envgroups/$ENV_GROUP_NAME/attachments" \
        -X POST \
        -H "Authorization: Bearer $AUTH" \
        -H "content-type:application/json" \
        -d '{
          "environment":"'"$ENVIRONMENT_NAME"'"
      }'
  8. 如要查看作業狀態,請呼叫這個 API:

    沒有資料落地

    curl -H "Authorization: Bearer $AUTH" \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/envgroups/$ENV_GROUP_NAME/attachments"

    資料落地

    curl -H "Authorization: Bearer $AUTH" \
        "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/envgroups/$ENV_GROUP_NAME/attachments"

步驟 7:設定轉送

在這個步驟中,您將設定用戶端應用程式與 Apigee 的通訊方式。用戶端到 Apigee 的流量也稱為「北向」流量。北向設定選項包括:前往要使用的設定選項,然後按照該選項的步驟操作:

存取權類型 設定和部署程序說明
內部與 PSC (新)

使用 Private Service Connect (PSC),只允許從任何 Google Cloud 專案內部存取 API Proxy。

PSC 可在服務供應商 (Apigee) 和服務消費者 (對等互連的 VPC 專案,和/或您控管的一或多個其他 Cloud 專案) 之間建立私人連線。使用這種方法時,要求會通過服務端點或區域性內部負載平衡器,到達單一連結點 (稱為服務連結)。完成這項設定後,內部用戶端就能從任何啟用網路的機器傳送 Apigee API Proxy 要求。

外部 (含 PSC) (新功能)

使用 Private Service Connect (PSC) 允許外部存取 API Proxy。

使用 Private Service Connect (PSC) 啟用服務供應商 (Apigee) 與服務消費者 (對等互連的虛擬私有雲專案,和/或您控管的一或多個其他 Cloud 專案) 之間的私人連線。使用這種方法時,要求會通過全域外部負載平衡器或區域外部負載平衡器,傳送至單一附加點,也就是服務附件。完成這項設定後,您就能從任何啟用網路的機器傳送 Apigee API Proxy 要求。

下方的操作說明將介紹這些路由方法。

內部轉送 (PSC)

本節說明如何使用 Private Service Connect (PSC),只允許從任何 Google Cloud 專案內部存取 API Proxy。

您可以透過下列兩種方式,使用 PSC 設定內部存取權:

  • 服務端點:要求會通過服務端點,傳送至單一連結點,也就是服務連結
  • 內部區域負載平衡器:要求會通過區域內部 HTTP(S) 負載平衡器。另請參閱「全球性與地區性負載平衡」。

選取下方分頁標籤,瞭解所選設定的步驟:

服務端點

為服務連結建立 PSC 服務端點

  1. 從先前建立的執行個體取得服務附件:

    沒有資料落地

    curl -i -X GET -H "Authorization: Bearer $AUTH" \
    "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances"

    資料落地

    curl -i -X GET -H "Authorization: Bearer $AUTH" \
    "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances"

    在下列輸出範例中,serviceAttachment 值會以粗體顯示:

    {
      "instances": [
        {
          "name": "us-west1",
          "location": "us-west1",
          "createdAt": "1645731488019",
          "lastModifiedAt": "1646504754219",
          "diskEncryptionKeyName": "projects/my-project/locations/us-west1/keyRings/us-west1/cryptoKeys/dek",
          "state": "ACTIVE",
          "runtimeVersion": "1-7-0-20220228-190814",
          "consumerAcceptList": [
            "my-project"
          ],
          "serviceAttachment": "projects/bfac74a67a320c43a12p-tp/regions/us-west1/serviceAttachments/apigee-us-west1-crw1"
        }
      ]
    }
  2. 建立指向服務連結的 PSC 服務端點,該服務連結是您在上一個步驟中從執行個體回應主體取得,如「建立 Private Service Connect 端點」一文所述。
  3. Apigee 佈建完成。請參閱「部署範例 Proxy」。

內部區域負載平衡器

步驟 7a:設定環境變數

本節的操作說明會使用環境變數,參照重複使用的字串。請務必在「定義環境變數」中設定變數。

此外,請設定下列環境變數:

NEG_NAME=YOUR_NEG_NAME
  NETWORK_NAME=YOUR_NETWORK_NAME
  SUBNET_NAME=YOUR_SUBNET_NAME
  TARGET_SERVICE=TARGET_SERVICE_ATTACHMENT

其中:

  • NEG_NAME:網路端點群組的名稱。
  • NETWORK_NAME:(選用) 建立 NEG 的網路名稱。如果省略這個參數,系統會使用 default 專案網路。
  • SUBNET_NAME:用於與生產者建立私有連線的子網路名稱。 子網路大小可以很小:PSC NEG 只需要子網路中的一個 IP。如果是 Apigee,每個區域只需要一個 PSC NEG。VM 或其他實體可以共用及使用子網路。如果未指定子網路,網路端點可能會屬於建立網路端點群組的區域中任何子網路。
  • TARGET_SERVICE:要連線的服務附件。例如:projects/bfac7497a40c32a12p-tp/regions/us-west1/serviceAttachments/apigee-us-west1-crw7

步驟 7b:建立僅限 Proxy 的子網路

gcloud compute networks subnets create testproxyonlysubnet \
--purpose=REGIONAL_MANAGED_PROXY --role=ACTIVE --region=$RUNTIME_REGION --network=$NETWORK_NAME \
--range=100.0.0.0/24 --project=$PROJECT_ID

步驟 7c:建立網路端點群組 (NEG)

  1. 從先前建立的執行個體取得服務附件:

    沒有資料落地

    curl -i -X GET -H "Authorization: Bearer $AUTH" \
    "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances"

    資料落地

    curl -i -X GET -H "Authorization: Bearer $AUTH" \
    "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances"

    在下列輸出範例中,serviceAttachment 值會以粗體顯示:

    {
      "instances": [
        {
          "name": "us-west1",
          "location": "us-west1",
          "createdAt": "1645731488019",
          "lastModifiedAt": "1646504754219",
          "diskEncryptionKeyName": "projects/my-project/locations/us-west1/keyRings/us-west1/cryptoKeys/dek",
          "state": "ACTIVE",
          "runtimeVersion": "1-7-0-20220228-190814",
          "consumerAcceptList": [
            "my-project"
          ],
          "serviceAttachment": "projects/bfac7497a40c32a12p-tp/regions/us-west1/serviceAttachments/apigee-us-west1-crw7"
        }
      ]
      }
  2. 建立 Private Service Connect NEG,指向您在上一個步驟中從執行個體回應主體取得的服務附件。

    gcloud compute network-endpoint-groups create $NEG_NAME \
    --network-endpoint-type=private-service-connect \
    --psc-target-service=$TARGET_SERVICE \
    --region=$RUNTIME_LOCATION \
    --project=$PROJECT_ID
    --network=$NETWORK_NAME
    --subnet=$SUBNET_NAME
    

    地點

    • $PROJECT_ID 可以是已與 Apigee 機構建立關聯的 Cloud 專案,也可以是建立 Apigee 執行階段例項consumerAcceptlist 中包含的 Cloud 專案。

步驟 7d:設定區域內部負載平衡器

  1. 為負載平衡器保留內部 IPv4 位址。
    gcloud compute addresses create ADDRESS_NAME \
    --ip-version=IPV4 --subnet=$SUBNET_NAME \
    --region=$RUNTIME_LOCATION --project=$PROJECT_ID

    ADDRESS_NAME 替換為 IP 位址資源的名稱。

    執行下列指令,查看保留的 IP 位址:

    gcloud compute addresses describe ADDRESS_NAME \
    --format="get(address)" --region=$RUNTIME_LOCATION --project=$PROJECT_ID
  2. 為 NEG 建立後端服務。
    gcloud compute backend-services create BACKEND_SERVICE_NAME \
    --load-balancing-scheme=INTERNAL_MANAGED \
    --protocol=HTTPS \
    --region=$RUNTIME_LOCATION \
    --project=$PROJECT_ID
  3. BACKEND_SERVICE_NAME 改為後端服務的名稱。

  4. 將 NEG 新增至後端服務:
    gcloud compute backend-services add-backend BACKEND_SERVICE_NAME \
    --network-endpoint-group=$NEG_NAME \
    --region=$RUNTIME_LOCATION \
    --project=$PROJECT_ID

    更改下列內容:

    • NEG_NAME:網路端點群組的名稱。
    • BACKEND_SERVICE_NAME 改為後端服務的名稱。
  5. 如要建立 HTTPS 負載平衡器,您必須具備 SSL 憑證資源,才能在 HTTPS 目標 Proxy 中使用。

    使用這個指令建立自行管理的 SSL 憑證資源。如要建立自行管理的 SSL 憑證,您需要本機私密金鑰檔案和本機憑證檔案。如需建立這些檔案,請參閱使用自行管理的 SSL 憑證的步驟 1

    gcloud compute ssl-certificates create CERTIFICATE \
    --certificate LB_CERT \
    --private-key LB_PRIVATE_KEY
    --region=$RUNTIME_LOCATION --project=$PROJECT_ID

    更改下列內容:

    • CERTIFICATE:憑證名稱。
    • LB_CERT:PEM 格式的憑證檔案路徑 (適用於自行管理的憑證)。
    • LB_PRIVATE_KEY:PEM 格式的私密金鑰檔案路徑,適用於您自行管理的憑證。
  6. 為負載平衡器建立網址對應。

    網址對應必須參照預設後端服務。將您剛建立的後端服務設為預設服務。

    gcloud compute url-maps create URL_MAP_NAME \
    --default-service=DEFAULT_BACKEND_SERVICE_NAME \
    --region=$RUNTIME_REGION \
    --project=$PROJECT_ID

    更改下列內容:

    • URL_MAP_NAME:網址對應表名稱。
    • DEFAULT_BACKEND_SERVICE_NAME:負載平衡器的預設後端服務名稱。如果沒有任何主機規則與要求的主機名稱相符,系統就會使用預設規則。
  7. 使用 SSL 憑證資源建立目標 HTTPS Proxy。

    gcloud compute target-https-proxies create PROXY_NAME \
    --url-map=URL_MAP_NAME \
    --ssl-certificates=CERTIFICATE \
    --region=$RUNTIME_LOCATION --project=$PROJECT_ID

    更改下列內容:

    • PROXY_NAME:目標 HTTPS Proxy 的名稱。
    • URL_MAP_NAME:網址對應表名稱。
    • CERTIFICATE:憑證資源的名稱。
  8. 建立轉送規則。
    gcloud compute forwarding-rules create FWD_RULE \
    --load-balancing-scheme=INTERNAL_MANAGED \
    --address=ADDRESS_NAME \
    --target-https-proxy=PROXY_NAME \
    --ports=443 \
    --target-https-proxy-region=$RUNTIME_REGION \
    --region=$RUNTIME_REGION \
    --project=$PROJECT_ID \
    --network=$NETWORK_NAME \
    --subnet=$SUBNET_NAME
    

    更改下列內容:

    • FWD_RULE:轉送規則的名稱。
    • ADDRESS_NAME:您預留用於轉送規則的 IP 位址資源。
    • PROXY_NAME:目標 HTTPS Proxy 的名稱。
    • NETWORK_NAME:(選用) 建立 NEG 的網路名稱。如果省略這個參數,系統會使用 default 專案網路。
    • SUBNET_NAME:用於與生產者建立私有連線的子網路名稱。
  9. Apigee 佈建完成。請參閱「部署範例 Proxy」。

外部轉送 (PSC)

本節說明如何使用 Private Service Connect (PSC) 設定外部路由,允許 Apigee 與您控管的虛擬私有雲進行通訊。您必須先完成這項操作,才能從外部用戶端將要求傳送至 Apigee 執行階段例項。

步驟 7b:建立 NEG 並設定負載平衡器

您可以建立全域或區域負載平衡器。

全域外部負載平衡器

設定全域外部 HTTP(S) 負載平衡器 (負載平衡配置設為 EXTERNAL_MANAGED)。

雖然 Private Service Connect NEG 是區域性的,但這項設定中的所有其他負載平衡元件都是全域性的。

  1. 請確認您已在「定義環境變數」中設定環境變數。
  2. 從先前建立的執行個體取得服務附件:

    沒有資料落地

    curl -i -X GET -H "Authorization: Bearer $AUTH" \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances"

    資料落地

    curl -i -X GET -H "Authorization: Bearer $AUTH" \
        "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances"

    在下列輸出範例中,serviceAttachment 值會以粗體顯示:

    {
      "instances": [
        {
          "name": "us-west1",
          "location": "us-west1",
          "host": "10.82.192.2",
          "port": "443",
          "createdAt": "1645731488019",
          "lastModifiedAt": "1646504754219",
          "diskEncryptionKeyName": "projects/my-project/locations/us-west1/keyRings/us-west1/cryptoKeys/dek",
          "state": "ACTIVE",
          "peeringCidrRange": "SLASH_22",
          "runtimeVersion": "1-7-0-20220228-190814",
          "ipRange": "10.82.192.0/22,10.82.196.0/28",
          "consumerAcceptList": [
            "875609189304"
          ],
          "serviceAttachment": "projects/bfac7497a40c32a12p-tp/regions/us-west1/serviceAttachments/apigee-us-west1-crw7"
        }
      ]
    }
    這是清單中唯一的專案。
  3. 建立 Private Service Connect NEG,指向您在上一個步驟中從執行個體回應本文取得的服務連結。

      gcloud compute network-endpoint-groups create NEG_NAME \
        --network-endpoint-type=private-service-connect \
        --psc-target-service=TARGET_SERVICE \
        --region=$RUNTIME_LOCATION \
        --network=NETWORK_NAME \
        --subnet=SUBNET_NAME \
        --project=$PROJECT_ID
    

    更改下列內容:

    • NEG_NAME:網路端點群組的名稱。
    • TARGET_SERVICE:要連線的服務附件。使用上一個指令傳回的服務附件值。例如: projects/bfac7497a40c32a12p-tp/regions/us-west1/serviceAttachments/apigee-us-west1-crw7
    • NETWORK_NAME:(選用) 建立 NEG 的網路名稱。如果省略這個參數,系統會使用 default 專案網路。
    • SUBNET_NAME:用於與生產者建立私有連線的子網路名稱。 子網路大小可以很小:PSC NEG 只需要子網路中的一個 IP。如果是 Apigee,每個區域只需要一個 PSC NEG。子網路可供 VM 或其他實體共用及使用。如果未指定子網路,網路端點可能會屬於建立網路端點群組的區域中任何子網路。
    • $PROJECT_ID:已與 Apigee 機構建立關聯的 Cloud 專案,或是建立 Apigee 執行階段執行個體consumerAcceptlist 中包含的 Cloud 專案。如果尚未建立環境變數來保存專案 ID,請建立一個,因為後續大部分指令都會用到這個 ID。
  4. 為負載平衡器保留全域外部 IPv4 位址。
    gcloud compute addresses create ADDRESS_NAME \
        --ip-version=IPV4 --global --project=$PROJECT_ID

    ADDRESS_NAME 替換為 IP 位址資源的名稱。

    執行下列指令,查看保留的 IP 位址:

    gcloud compute addresses describe ADDRESS_NAME \
        --format="get(address)" --global --project=$PROJECT_ID
  5. 為 NEG 建立後端服務。
    gcloud compute backend-services create BACKEND_SERVICE_NAME \
        --load-balancing-scheme=EXTERNAL_MANAGED \
        --protocol=HTTPS \
        --global --project=$PROJECT_ID
  6. BACKEND_SERVICE_NAME 改為後端服務的名稱。

  7. 將 NEG 新增至後端服務。
    gcloud compute backend-services add-backend BACKEND_SERVICE_NAME \
        --network-endpoint-group=NEG_NAME \
        --network-endpoint-group-region=REGION \
        --global --project=$PROJECT_ID

    更改下列內容:

    • BACKEND_SERVICE_NAME:後端服務的名稱。
    • NEG_NAME:網路端點群組的名稱。
    • REGION:網路端點群組的區域。
  8. 為負載平衡器建立網址對應。

    網址對應必須參照預設後端服務。將您剛建立的後端服務設為預設服務。

    gcloud compute url-maps create URL_MAP_NAME \
        --default-service=DEFAULT_BACKEND_SERVICE_NAME \
        --global --project=$PROJECT_ID

    更改下列內容:

    • URL_MAP_NAME:網址對應表名稱。
    • DEFAULT_BACKEND_SERVICE_NAME:負載平衡器的預設後端服務名稱。 如果沒有任何主機規則與要求的主機名稱相符,系統就會使用預設規則。
  9. 建立目標 HTTPS Proxy。

    如要建立 HTTPS 負載平衡器,您必須具備SSL 憑證資源,才能在 HTTPS 目標 Proxy 中使用。您可以使用 Google 代管的 SSL 憑證或自行管理的 SSL 憑證,建立 SSL 憑證資源。建議使用 Google 代管憑證,因為 Google Cloud 會自動取得、管理及更新這些憑證。

    如要建立 Google 代管的憑證,您必須擁有網域

    使用這個指令建立 Google 代管的 SSL 憑證資源:

    gcloud compute ssl-certificates create CERTIFICATE \
        --domains DOMAIN --project=$PROJECT_ID

    更改下列內容:

    • CERTIFICATE:憑證名稱。
    • DOMAIN:負載平衡器的網域名稱。

    使用這個指令建立自行管理的 SSL 憑證資源。如要建立自行管理的 SSL 憑證,您需要本機私密金鑰檔案和本機憑證檔案。如需建立這些檔案,請參閱使用自行管理的 SSL 憑證的步驟 1

    gcloud compute ssl-certificates create CERTIFICATE \
        --certificate LB_CERT \
        --private-key LB_PRIVATE_KEY --project=$PROJECT_ID

    更改下列內容:

    • CERTIFICATE:憑證名稱。
    • LB_CERT:PEM 格式的憑證檔案路徑 (適用於自行管理的憑證)。
    • LB_PRIVATE_KEY:PEM 格式的私密金鑰檔案路徑,適用於您自行管理的憑證。

    使用 SSL 憑證資源建立目標 HTTPS Proxy。

    gcloud compute target-https-proxies create PROXY_NAME \
        --url-map=URL_MAP_NAME \
        --ssl-certificates=CERTIFICATE --project=$PROJECT_ID

    更改下列內容:

    • PROXY_NAME:目標 HTTPS Proxy 的名稱。
    • URL_MAP_NAME:網址對應表名稱。
    • CERTIFICATE:憑證資源的名稱。
  10. 建立轉送規則。
    gcloud compute forwarding-rules create FWD_RULE \
        --load-balancing-scheme=EXTERNAL_MANAGED \
        --network-tier=PREMIUM \
        --address=ADDRESS_NAME \
        --target-https-proxy=PROXY_NAME \
        --ports=443 \
        --global --project=$PROJECT_ID

    更改下列內容:

    • FWD_RULE:轉送規則的名稱。
    • ADDRESS_NAME:您預留用於轉送規則的 IP 位址資源。
    • PROXY_NAME:目標 HTTPS Proxy 的名稱。

區域型外部負載平衡器

設定區域型外部 HTTP(S) 負載平衡器。另請參閱外部 HTTP(S) 負載平衡器總覽

  1. 請務必在「定義環境變數」中設定變數。
  2. 建立僅限 Proxy 的子網路:
    gcloud compute networks subnets create SUBNET_NAME \
          --purpose=REGIONAL_MANAGED_PROXY --role=ACTIVE \
          --region=$RUNTIME_LOCATION --network=NETWORK_NAME \
          --range=100.0.0.0/24 --project=$PROJECT_ID

    更改下列內容:

    • SUBNET_NAME:子網路的名稱。
    • (選用) NETWORK_NAME:子網路建立所在的網路名稱。如果省略這個參數,系統會使用預設專案網路。
  3. 從先前建立的執行個體取得服務附件:

    沒有資料落地

    curl -i -X GET -H "Authorization: Bearer $AUTH" \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances"

    資料落地

    curl -i -X GET -H "Authorization: Bearer $AUTH" \
        "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/instances"

    在下列輸出範例中,serviceAttachment 值會以粗體顯示:

    {
      "instances": [
        {
          "name": "us-west1",
          "location": "us-west1",
          "host": "10.82.192.2",
          "port": "443",
          "createdAt": "1645731488019",
          "lastModifiedAt": "1646504754219",
          "diskEncryptionKeyName": "projects/my-project/locations/us-west1/keyRings/us-west1/cryptoKeys/dek",
          "state": "ACTIVE",
          "peeringCidrRange": "SLASH_22",
          "runtimeVersion": "1-7-0-20220228-190814",
          "ipRange": "10.82.192.0/22,10.82.196.0/28",
          "consumerAcceptList": [
            "875609189304"
          ],
          "serviceAttachment": "projects/bfac7497a40c32a12p-tp/regions/us-west1/serviceAttachments/apigee-us-west1-crw7"
        }
      ]
    }
    這是清單中唯一的專案。
  4. 建立網路端點群組。
    gcloud compute network-endpoint-groups create NEG_NAME \
        --network-endpoint-type=private-service-connect \
        --psc-target-service=TARGET_SERVICE \
        --region=$RUNTIME_LOCATION --project=$PROJECT_ID

    更改下列內容:

    • NEG_NAME:網路端點群組的名稱。
    • TARGET_SERVICE:要連線的服務附件名稱。 例如:projects/bfac7497a40c32a12p-tp/regions/us-west1/serviceAttachments/apigee-us-west1-crw7
  5. 為 NEG 建立後端服務。
    gcloud compute backend-services create BACKEND_SERVICE_NAME \
      --load-balancing-scheme=EXTERNAL_MANAGED \
      --protocol=HTTPS \
      --region=$RUNTIME_LOCATION  \
      --project=$PROJECT_ID
  6. BACKEND_SERVICE_NAME 改為後端服務的名稱。

  7. 將 NEG 新增至後端服務。
    gcloud compute backend-services add-backend BACKEND_SERVICE_NAME \
      --network-endpoint-group=NEG_NAME \
      --region=$RUNTIME_LOCATION  \
      --project=$PROJECT_ID

    更改下列內容:

    • BACKEND_SERVICE_NAME:後端服務的名稱。
    • NEG_NAME:網路端點群組的名稱。
  8. 為負載平衡器建立網址對應。

    網址對應必須參照預設後端服務。將您剛建立的後端服務設為預設服務。

    gcloud compute url-maps create URL_MAP_NAME \
      --default-service=DEFAULT_BACKEND_SERVICE_NAME \
      --region=$RUNTIME_LOCATION  \
      --project=$PROJECT_ID

    更改下列內容:

    • URL_MAP_NAME:網址對應表名稱。
    • DEFAULT_BACKEND_SERVICE_NAME:負載平衡器的預設後端服務名稱。 如果沒有任何主機規則與要求的主機名稱相符,系統就會使用預設規則。
  9. 建立目標 HTTPS Proxy。

    如要建立 HTTPS 負載平衡器,您必須具備SSL 憑證資源,才能在 HTTPS 目標 Proxy 中使用。

    使用這個指令建立自行管理的 SSL 憑證資源。如要建立自行管理的 SSL 憑證,您需要本機私密金鑰檔案和本機憑證檔案。如需建立這些檔案,請參閱使用自行管理的 SSL 憑證的步驟 1

    gcloud compute ssl-certificates create CERTIFICATE \
      --certificate LB_CERT \
      --private-key LB_PRIVATE_KEY --region=$RUNTIME_LOCATION \
      --project=$PROJECT_ID

    更改下列內容:

    • CERTIFICATE:憑證名稱。
    • LB_CERT:PEM 格式的憑證檔案路徑 (適用於自行管理的憑證)。
    • LB_PRIVATE_KEY:PEM 格式的私密金鑰檔案路徑,適用於您自行管理的憑證。

    使用 SSL 憑證資源建立目標 HTTPS Proxy。

    gcloud compute target-https-proxies create PROXY_NAME \
      --url-map=URL_MAP_NAME --region=$RUNTIME_LOCATION \
      --ssl-certificates=CERTIFICATE --project=$PROJECT_ID

    更改下列內容:

    • PROXY_NAME:目標 HTTPS Proxy 的名稱。
    • URL_MAP_NAME:網址對應表名稱。
    • CERTIFICATE:憑證資源的名稱。
  10. 為負載平衡器保留區域外部位址。請注意,網路層級必須設為 STANDARD
    gcloud compute addresses create ADDRESS_NAME \
          --region=$RUNTIME_LOCATION --network-tier=STANDARD \
          --project=$PROJECT_ID

    ADDRESS_NAME 替換為 IP 位址資源的名稱。

    執行下列指令,查看保留的 IP 位址:

    gcloud compute addresses describe ADDRESS_NAME \
          --format="get(address)" --region=$RUNTIME_LOCATION \
          --project=$PROJECT_ID
  11. 建立轉送規則。
    gcloud compute forwarding-rules create FWD_RULE \
      --load-balancing-scheme=EXTERNAL_MANAGED \
      --network-tier=STANDARD \
      --address=ADDRESS_NAME \
      --target-https-proxy=PROXY_NAME \
      --ports=443  --region=$RUNTIME_LOCATION \
      --target-https-proxy-region=$RUNTIME_LOCATION --project=$PROJECT_ID

    更改下列內容:

    • FWD_RULE:轉送規則的名稱。
    • ADDRESS_NAME:您預留用於轉送規則的 IP 位址資源。
    • PROXY_NAME:目標 HTTPS Proxy 的名稱。

Apigee 佈建完成。前往「部署範例 Proxy」。

步驟 8:部署範例 Proxy

  1. 從 GitHub 下載 範例 Proxy。Proxy 的目標是 httpbin.org 服務,這項服務是常用的公開要求和回應服務。
  2. 使用 Apigee apis API,將 API Proxy 套件上傳至執行階段:

    沒有資料落地

    curl -i -X POST -H "Authorization: Bearer $AUTH" \
        -H "Content-Type:multipart/form-data" \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/apis?name=httpbin&action=import" \
        -F 'file=@PATH_TO_ZIP_FILE/httpbin_rev1_2020_02_02.zip'

    資料落地

    curl -i -X POST -H "Authorization: Bearer $AUTH" \
        -H "Content-Type:multipart/form-data" \
        "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/apis?name=httpbin&action=import" \
        -F 'file=@PATH_TO_ZIP_FILE/httpbin_rev1_2020_02_02.zip'

    其中 PATH_TO_ZIP_FILE 是包含已下載 ZIP 檔案的目錄路徑。

  3. 將 API Proxy 部署至先前建立的環境

    沒有資料落地

    curl -i -H "Authorization: Bearer $AUTH" -X POST \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments/$ENVIRONMENT_NAME/apis/httpbin/revisions/1/deployments"

    資料落地

    curl -i -H "Authorization: Bearer $AUTH" -X POST \
        "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments/$ENVIRONMENT_NAME/apis/httpbin/revisions/1/deployments"
  4. 使用下列 API 呼叫,確認部署作業已順利完成:

    沒有資料落地

    curl -i -H "Authorization: Bearer $AUTH" \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments/$ENVIRONMENT_NAME/apis/httpbin/revisions/1/deployments"

    資料落地

    curl -i -H "Authorization: Bearer $AUTH" \
        "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments/$ENVIRONMENT_NAME/apis/httpbin/revisions/1/deployments"
  5. 呼叫 API Proxy:

    從任何已啟用網路的機器執行下列指令,將要求傳送至 API Proxy:

    curl -i -H "Host: ENV_GROUP_HOSTNAME" \
        "https://ENV_GROUP_HOSTNAME/httpbin/headers"

    如有需要,您可以使用這個 API 取得 ENV_GROUP_HOSTNAME 值:

    沒有資料落地

    curl -i -H "Authorization: Bearer $AUTH" \
        "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/envgroups"

    資料落地

    curl -i -H "Authorization: Bearer $AUTH" \
        "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$PROJECT_ID/envgroups"

    如果收到類似這樣的錯誤: CONNECT_CR_SRVR_HELLO:sslv3 alert handshake failure,請檢查先前建立的 SSL 憑證是否已佈建。 使用這項指令檢查佈建狀態。憑證佈建完成後,狀態會顯示為 ACTIVE

    gcloud compute ssl-certificates describe CERTIFICATE \
        --global \
        --format="get(name,managed.status, managed.Status)"

    成功後,範例 API 代理程式會傳回類似以下內容的回應:

    {
        "headers": {
          "Accept": "*/*",
          "Grpc-Trace-Bin": "AAD/8WC/I4AUSrMEch0E9yj+AYck1x9afwckAgA",
          "Host": "httpbin.org",
          "Traceparent": "00-fff160bf2380144ab304721d04f728fe-8724d71f5a7f0724-00",
          "User-Agent": "curl/7.77.0",
          "X-Amzn-Trace-Id": "Root=1-61d785ef-7613aa8a7fde7a910441fab9",
          "X-B3-Sampled": "0",
          "X-B3-Spanid": "8724d71f5a7f0724",
          "X-B3-Traceid": "fff160bf2380144ab304721d04f728fe",
          "X-Cloud-Trace-Context": "fff160bf2380144ab304721d04f728fe/9738144823944087332;o=0",
          "X-Envoy-Attempt-Count": "1"
        }
    }

如要進一步瞭解如何部署 Proxy,包括其他疑難排解資訊,請參閱「 部署 API Proxy」。