Azure API Management のセルフホステッド ゲートウェイを Docker にデプロイする
適用対象: Developer | Premium
この記事では、Azure API Management のセルフホステッド ゲートウェイ コンポーネントを Docker 環境にデプロイする手順について説明します。
重要
Azure API Management セルフホステッド ゲートウェイ バージョン 0 およびバージョン 1 コンテナー イメージのサポートは、それに対応する Configuration API v1 とともに 2023 年 10 月 1 日に終了します。 Configuration API v2 でセルフホステッド ゲートウェイ v2.0.0 以上を使用するには、移行ガイドを使用してください。 非推奨に関するドキュメントで詳細を確認する
注意
セルフホステッド ゲートウェイを Docker でホストすることは、評価と開発のユースケースに最適です。 運用環境での使用には Kubernetes が推奨されます。 Helm を使用してデプロイする方法、またはデプロイ YAML ファイルを使用して、セルフホステッド ゲートウェイを Kubernetes にデプロイする方法について説明します。
前提条件
- Azure API Management インスタンスの作成に関するクイックスタートを完了します
- Docker 環境を作成します。 デスクトップ向けの Docker は、開発および評価の目的に適したオプションです。 Docker のすべてのエディション、その機能、および Docker 自体に関する包括的なドキュメントについては、「Docker Documentation (Docker ドキュメント)」を参照してください。
- API Management インスタンスにゲートウェイ リソースをプロビジョニングします
注意
セルフホステッド ゲートウェイは、x86-64 の Linux ベースの Docker コンテナーとしてパッケージ化されます。
Docker にセルフホステッド ゲートウェイをデプロイする
[Deployment and infrastructure](デプロイとインフラストラクチャ) から [ゲートウェイ] を選択します。
デプロイするゲートウェイ リソースを選択します。
[Deployment]/(デプロイ/) を選択します。
[トークン] テキスト ボックスのアクセス トークンが、既定の [有効期限] および [秘密鍵] の値を使用して、自動生成されたことに注意してください。 必要に応じて、いずれかまたは両方のコントロールで必要な値を選択して、新しいトークンを生成します。
[デプロイ スクリプト] 下で [Docker] が選択されていることを確認します。
[環境] の横にある env.conf ファイル リンクを選択して、ファイルをダウンロードします。
[実行] テキスト ボックスの右端にある [コピー] アイコンを選択して、Docker コマンドをクリップボードにコピーします。
コマンドをターミナル (またはコマンド) ウィンドウに貼り付けます。 必要に応じて、ポート マッピングとコンテナー名を調整します。 コマンドでは、ダウンロードした環境ファイルが現在のディレクトリに存在することが前提であることに注意してください。
docker run -d -p 80:8080 -p 443:8081 --name <gateway-name> --env-file env.conf mcr.microsoft.com/azure-api-management/gateway:<tag>
コマンドを実行します。 このコマンドは、Microsoft Artifact Registry からコンテナー イメージを使用してコンテナーを実行し、コンテナーの HTTP (8080) ポートと HTTPS (8081) ポートをホスト上のポート 80 と 443 にマップするように、Docker 環境に対して指示します。
次のコマンドを実行して、ゲートウェイ コンテナーが実行中であるかどうかを確認します。
docker ps CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES 895ef0ecf13b mcr.microsoft.com/azure-api-management/gateway:latest "/bin/sh -c 'dotnet …" 5 seconds ago Up 3 seconds 0.0.0.0:80->8080/tcp, 0.0.0.0:443->8081/tcp my-gateway
Azure portal に戻り、 [概要] をクリックして、デプロイしたばかりのセルフホステッド ゲートウェイ コンテナーが正常な状態を報告していることを確認します。
ヒント
console docker container logs <gateway-name>
コマンドを使用して、セルフホステッド ゲートウェイ ログのスナップショットを表示します。
docker container logs --help
コマンドを使用して、すべてのログ表示オプションを表示します。
次のステップ
- セルフホステッド ゲートウェイの詳細については、Azure API Management のセルフホステッド ゲートウェイの概要に関するページを参照してください。
- セルフホステッド ゲートウェイのカスタム ドメイン名を構成する。