在 Cloud Marketplace 中自訂 Apigee 開發人員入口網站啟動工具

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

本頁說明如何自訂、維護及保護 Apigee Developer Portal Kickstart 解決方案。部署完成後，您通常可以按照標準 Google Cloud 文件，自訂入口網站使用的所有 Cloud 服務元件。下方各節提供入口網站解決方案專用的設定選項和製作指南。

連線至 Apigee 或 Apigee Hybrid

如要搭配 Apigee 或 Apigee Hybrid 機構使用 Apigee Developer Portal Kickstart 解決方案，必須將入口網站部署至 Apigee 佈建期間使用的 Google Cloud 專案。部署期間，系統會建立具有 Apigee Developer Admin 角色的服務帳戶。服務帳戶呼叫端必須具備這個角色，才能呼叫 Apigee API。

為入口網站設定 HTTPS

在入口網站部署啟動設定中，您可以選擇為入口網站設定 HTTPS。 核取方塊設定選項包括：

未勾選 部署指令碼不會自動啟用 TLS。部署完成後，您可以使用 Cloud Load Balancing 手動設定 TLS。這是預設選項。
已勾選 部署套件會啟用 TLS、佈建 IP 位址、設定網域名稱，並使用 nip.io 要求 SSL 憑證。Google 並未核准使用 nip.io，但為了方便您測試部署作業，我們提供這項選項。選取這個選項即表示接受 nip.io 的條款及細則。

搭配 CMEK 使用 Cloud SQL

入口網站的 Cloud SQL 執行個體會在您啟動設定時選擇的區域中建立。 根據預設，Google 會使用 Google-owned and Google-managed encryption keys加密靜態資料。 如要使用客戶管理的加密金鑰 (CMEK) 加密儲存在 Cloud SQL 執行個體中的資料，請按照「使用客戶管理的加密金鑰」一文中的步驟設定金鑰。

管理 Cloud SQL

如要在部署後管理 Cloud SQL 執行個體：

設定及更新代管執行個體群組

代管執行個體群組 (MIG) 是可視為單一實體來管理的一組虛擬機器 (VM) 執行個體。您可以利用自動調度資源、自動修復、區域 (多可用區) 部署以及自動更新等自動化 MIG 服務，讓工作負載具有可擴充性和高可用性。

部署後如要設定 MIG，請按照下列步驟操作：

Apigee 開發人員入口網站 Kickstart 解決方案的新 VM 映像檔會定期發布。客戶可以按照「更新 MIG 中的執行個體」一文詳述的步驟，取代或重新啟動 MIG 中的執行個體，以使用最新映像檔。

透過 VPC Service Controls 啟用私人 IP

如要為 Cloud SQL 執行個體啟用私人 IP 位址，請按照下列步驟操作：

  • 確認虛擬私有雲網路可使用私人服務存取權。如需必要步驟的詳細清單，請參閱 設定私人服務存取權。
  • VPC Service Controls 不支援 Cloud Deployment Manager。如要在 VPC Service Controls 內啟用入口網站部署作業的 Deployment Manager，請 新增 Cloud Deployment Manager 服務帳戶，允許呼叫受 VPC Service Controls 保護的 API。

自訂入口網站代碼

如果部署後對入口網站程式碼或啟動指令碼進行自訂，請務必將這些變更匯出並備份到 Filestore，以免在更新 Apigee 開發人員入口網站 Kickstart 基本映像檔時遺失。

舉例來說，如果在 Compute Engine 執行個體上安裝新的 Drupal 模組，請按照下列步驟建立備份：

  1. 執行 /opt/apigee/scripts/export-code.sh 匯出變更。
  2. 指令碼會將匯出的檔案複製到掛接在 /mnt/fileshare/portalname/ 的 Filestore 執行個體。
  3. 重新啟動代管執行個體群組中的執行個體，觸發群組中的變更。開機指令碼會自動偵測是否有程式碼備份，載入變更、修正檔案權限，並套用 settings.php 檔案。
  4. 使用 composer update 更新 Drupal 核心和模組。Apigee 對基本映像檔的更新只提供 OS 更新、PHP 修補程式和 NGINX 更新。所有 Drupal 核心和模組更新都由客戶管理，且必須手動套用。

如要在開機指令碼中新增任何自訂項目，請在 /mnt/fileshare/$PORTAL_NAME/custom-startup-script.sh 建立指令碼。

如果安裝任何 PHP 套件，請執行 service supervisor restart 指令來套用變更。

建立備份

建議您定期備份 Apigee Developer Portal Kickstart 解決方案，這是最佳做法。如需詳細步驟，請參閱：

設定入口網站以用於實際工作環境

如要設定入口網站以供正式環境使用，建議採取下列步驟：

Cloud SQL 資料庫
  • 驗證或變更資料庫的機器類型
  • 停用資料庫的公開 IP，並 設定私人 IP
  • 啟用資料庫的自動備份功能
  • 啟用資料庫的高可用性
Filestore
  • 啟用 Filestore 備份
Cloud Load Balancing
  • 啟用 Cloud CDN 來快取靜態內容
  • 視需要新增自訂 SSL 憑證
代管執行個體群組
  • 調整生產流量所需的執行個體數量下限和上限
驗證
  • 移除網站的 HTTP 基本驗證存取限制。

    執行下列指令，讓入口網站可公開存取：

    gcloud beta runtime-config configs variables set site_basic_auth/enabled 0 \
  --is-text --config-name=PORTAL_NAME --project=GCP_PROJECT_NAME
     
    gcloud beta compute instance-groups managed rolling-action \
  replace INSTANCE_GROUP_ID --region=GCP_REGION \
  --replacement-method=substitute --project=GCP_PROJECT_NAME

後續步驟

  • 進一步瞭解 Apigee Developer Portal Kickstart 解決方案的支援資源。