共用方式為


在 Azure Arc 上部署 Azure API 管理閘道 (預覽)

適用於:開發人員 | 進階

在 Azure API 管理與 Kubernetes 上的 Azure Arc 之間整合時,您可以部署 API 管理閘道元件,作為已啟用 Azure Arc 的 Kubernetes 叢集中的延伸模組

在已啟用 Azure Arc 的 Kubernetes 叢集上部署 API 管理閘道,可擴充混合式和多重雲端環境的 API 管理支援。 使用叢集延伸模組啟用部署,並管理或套用原則至已啟用 Azure Arc 的叢集,以實現一致的體驗。

重要

Azure Arc 上的 API 管理自我裝載閘道目前是預覽版。 在預覽期間,API 管理閘道擴充功能可在下列區域中使用:

  • 亞洲 (東部、東南部)
  • 澳大利亞 (中部、中部 2、東部和東南部)
  • 巴西 (南部和東南部)
  • 加拿大 (中部、東部)
  • 歐洲 (北部、西部)
  • 法國 (中部和南部)
  • 德國 (北部和中西部)
  • 印度 (中部、南部、西部、Jio 中部和 Jio 西部)
  • 日本 (東部和西部)
  • 南韓 (中部和南部)
  • 挪威 (東部和西部)
  • 南非 (北部和西部)
  • 瑞典 (中部)
  • 瑞士 (北部和西部)
  • 阿拉伯聯合大公國 (UAE - 中部和北部)
  • 英國 (UK - 南部)
  • 美國 (美國 - 中部、中部 EUAP、東部、東部 2、東部 2 EUAP、中北部、中南部、中西部、西部、西部 2、西部 3)

必要條件

使用 Azure CLI 部署 API 管理閘道延伸模組

  1. 在 Azure 入口網站中,瀏覽至您的 API 管理執行個體。

  2. 從側邊的導覽功能表選取 [閘道]。

  3. 從清單選取並開啟您佈建的閘道資源。

  4. 在佈建的閘道資源中,按一下側邊導覽功能表的 [部署]。

  5. 記錄下一個步驟的權杖設定 URL 值。

  6. 在 Azure CLI 中,使用 az k8s-extension create 命令部署閘道延伸模組。 填寫 tokenconfiguration URL 值。

    az k8s-extension create --cluster-type connectedClusters --cluster-name <cluster-name> \
        --resource-group <rg-name> --name <extension-name> --extension-type Microsoft.ApiManagement.Gateway \
        --scope namespace --target-namespace <namespace> \
        --configuration-settings gateway.configuration.uri='<Configuration URL>' \
        --config-protected-settings gateway.auth.token='<token>' \
        --configuration-settings service.type='LoadBalancer' --release-train preview
    

    提示

    gateway.auth.token-protected- 旗標為選用,但建議您使用。

  7. 使用下列 CLI 命令確認部署狀態:

    az k8s-extension show --cluster-type connectedClusters --cluster-name <cluster-name> --resource-group <rg-name> --name <extension-name>
    
  8. 瀏覽回 [閘道] 清單,確認閘道狀態顯示包含節點計數的綠色核取記號。 以下狀態表示已部署自我裝載閘道 Pod:

    • 與 API 管理服務通訊成功。
    • 顯示一般「活動訊號」。

使用 Azure 入口網站部署 API 管理閘道延伸模組

  1. 在 Azure 入口網站中,瀏覽至 Azure Arc 連線的叢集。

  2. 在左側功能表中,選取 [擴充功能]>[+ 新增]>[API 管理閘道 (預覽)]

  3. 選取 建立

  4. 在 [安裝 API 管理閘道] 視窗中,設定閘道延伸模組:

    • 選取 API 管理執行個體的訂閱和資源群組。
    • 在 [閘道詳細資料] 中,選取 [API 管理執行個體] 和 [閘道名稱]。 如果支援您的 API 管理服務層級,請輸入延伸模組的命名空間範圍,並選擇性輸入一些複本
    • 在 [Kubernetes 設定] 中,選取叢集的預設設定或不同的設定。 如需選項,請參閱可用的延伸模組設定

    在 Azure 入口網站中部署延伸模組的螢幕擷取畫面

  5. 在 [監視] 索引標籤上,選擇性啟用監視,並上傳計量追蹤要求至閘道和後端。 如果啟用,請選取現有的 Log Analytics 工作區。

  6. 選取 [檢閱 + 安裝],然後選取 [安裝]。

可用的延伸模組設定

Azure Arc 的自我裝載閘道擴充功能提供許多組態設定,以自訂您環境的擴充功能。 本節列出與 Log Analytics 整合的必要部署設定和選擇性設定。 如需設定的完整清單,請參閱自我裝載閘道延伸模組參考

必要的設定

下列是必要的延伸模組設定。

設定 描述
gateway.configuration.uri 自我裝載閘道的 API 管理服務中的設定端點。
gateway.auth.token 要向 API 管理服務進行驗證的閘道權杖 (驗證金鑰)。 一般而言,從 GatewayKey 開始。
service.type 閘道的 Kubernetes 服務設定:LoadBalancerNodePortClusterIP

記錄分析設定

若要啟用自我裝載閘道的監視,請設定下列 Log Analytics 設定:

設定 描述
monitoring.customResourceId API 管理執行個體的 Azure Resource Manager 資源識別碼。
monitoring.workspaceId Log Analytics 的工作區識別碼。
monitoring.ingestionKey 包含 Log Analytics 擷取金鑰的祕密。

注意

如果未啟用 Log Analytics:

  1. 逐步解說建立 Log Analytics 工作區快速入門。
  2. 了解尋找 Log Analytics 代理程式設定的位置。

後續步驟