旧バージョンのドキュメントを参照しています。 最新のドキュメントはこちらをご参照ください。
Kongを入手
注記: このクイックスタートはローカルコンピューター上で実行され、 Kong Gatewayの機能を検索します。Kong Gatewayを本番環境ですぐに使えるAPIプラットフォームの一部として実行したい場合は、/installページから始めてください。
Kong Gatewayは軽量、高速、柔軟なクラウドネイティブAPIゲートウェイです。
Kong Gatewayはサービスアプリケーションの前面に位置し、動的に制御、分析、 リクエストと応答のルーティングを行います。Kong Gatewayは、柔軟でローコードのプラグインベースの アプローチを使用して、APIトラフィックポリシーを実装します
このチュートリアルでは、ローカルインストールをセットアップしてKong Gatewayを使い始める方法、および一般的なAPIマネジメントタスクをいくつか説明します。
このページでは、 Kong Gatewayの実行とAdmin APIによる検証について説明します。完了したら、次のタスクを実行してチュートリアルを完了できます。
- サービスとルートの理解と設定
- アップストリームサービスを保護するための Rate Limiting の設定
- プロキシキャッシュによるシステムパフォーマンスの向上
- サービスの水平スケーリングのためのロードバランシング
- Key Authenticationによるサービスの保護
前提条件
- Dockerは、 Kong Gatewayとサポートデータベースをローカルで実行するために使用されます。
-
curlはKong Gatewayにリクエストを送信するために使用されます。
curl
は多くのシステムにプリインストールされています。 -
jqは、コマンドラインでJSON応答を処理するために使用されます。このツールは便利ですが、この チュートリアルのタスクを完了させるために必要なものではありません。
jq
を使用せずに続行する場合は、コマンドを 変更してjq
処理を削除します。
Kong を入手
このチュートリアルでは、Kong Gateway とそのサポートデータベースをすばやく実行するための quickstart
スクリプトが提供されています。
このスクリプトは、Docker を使用して Kong Gateway を実行し、PostgreSQL データベースをバックアップデータベースとして使用します。
-
以下のように
quickstart
スクリプトを使用してKong Gatewayを実行します。curl -Ls https://get.konghq.com/quickstart | bash
注 : クイックスタートのスクリプトは、Kong Gateway Enterprise をフリーモードで実行します。環境変数を介してライセンスをスクリプトに渡すことで、ライセンス付きで Kong を実行できます。これに関する機能やその他の高度な使用方法については、コードリポジトリのドキュメントを参照してください。
このスクリプトは、Kong Gatewayおよびサポートする PostgreSQLデータベースのDockerコンテナを実行します。 このスクリプトは、これらのコンテナが通信するためのDockerネットワークも作成します。最後に、データベースは 適切な移行手順で初期化され、 Kong Gatewayの準備が整うと、次のメッセージが表示されます。
Kong Gateway Ready
-
Kong Gateway が実行されていることを確認します。
Kong Gateway は、デフォルトポート
8001
で Admin API を提供します。Admin API は、Kong Gateway の状態の照会と制御の両方に使用できます。次のコマンドは Admin API を照会し、ヘッダーのみを取得します。curl --head localhost:8001
Kong Gatewayが正常に実行されている場合、次のような
200
HTTPコードで応答します。HTTP/1.1 200 OK Date: Mon, 22 Aug 2022 19:25:49 GMT Content-Type: application/json Connection: keep-alive Access-Control-Allow-Origin: * Content-Length: 11063 X-Kong-Admin-Latency: 6 Server: kong/3.7.1
-
Kong Gateway構成を評価します。
Admin APIのルートルートは、ネットワーク、セキュリティ、プラグインの情報といった
Kong Gateway実行に関する重要な情報を提供します。完全な 構成は、返される JSON ドキュメントの
.configuration
キーで提供されます。curl -s localhost:8001 | jq '.configuration'
Kong Gateway の設定情報が記載された大きな JSON 応答が返されるはずです。
-
Kong Managerへのアクセス
このガイドの残りではAdmin APIを使用したKong Gatewayの構成を示していますが、Kong Managerを使用してサービス、ルート、プラグインなどを管理することもできます。Kong Managerにアクセスするには、URL http://localhost:8002にアクセスします。
注: Kong Gateway (OSS) をインストールすると、Kong Manager Open Source が使用されます。その他すべての Kong Gateway インストールでは Kong Manager Enterprise を使用します。
このチュートリアルのすべての手順には実行中のKong Gatewayが必要であるため、すべてを実行中のままこのチュートリアルの次の手順に進んでください。