旧バージョンのドキュメントを参照しています。 最新のドキュメントはこちらをご参照ください。
用語集
用語 | 定義 |
---|---|
管理者 | 管理者は、Admin APIまたはKong ManagerにアクセスできるKong Gatewayユーザー アカウントです。 |
認証 | 認証とは、システムがユーザー アカウントの ID を検証するプロセスです。 |
承認 | 認可は、特定のリソースへのアクセスを定義するシステムです。Kong Gateway では、ロールベースのアクセス制御(RBAC)が主な認証モードです。 |
ベータ | 安定性を参照してください。 |
カタログ | Dev Portalインスタンス内のすべての仕様の一覧。このカタログは開発者の権限に対応しているので、特定の開発者は自分のロールで許可されている仕様をすべて見ることができます。 |
クライアント | Kongクライアントとは、Kong Gatewayのプロキシポートにリクエストを行うダウンストリームクライアントを指します。分散型アプリケーションのその他サービス、ユーザーのID、ユーザーのブラウザ、または特定のデバイスである可能性があります。 |
Consumer(コンシューマ) | コンシューマーオブジェクトはサービスのクライアントを表します。コンシューマーは、APIを使用する開発者またはマシンを表すAdmin APIエンティティでもあります。 |
Credential(認証情報) | コンシューマに関連付けられた一意の文字列。APIキーとも呼ばれます。 |
Dev Portal | API 製品、仕様、およびドキュメントオブジェクトのコレクションとして機能するウェブアプリケーション。ポータルの目的は、Kong を通して実行されるサービスを他のチーム、開発者、パートナーが登録して利用できるようにすることです。 |
グループ | ロール定義エンティティのセット。 |
ホスト | ホストは、アップストリームのトラフィックを受信することを目的とした(DNSを使用する)ドメインホストを表します。Kong Gatewayでは、ルートオブジェクトに一致するドメイン名のリストです。 |
Kongプラグインまたはバンドルプラグイン | Kongが開発、保守、サポートしているプラグインです。Kong Plugin Hubのプラグインの説明に特に記載がない限り、Kongでサポートされているすべてのプラグインは、関連するKong Gatewayインストールパッケージにバンドルされており、 Konnectで利用できます。 |
権限 | 権限とは、エンドポイントによって定義されたAdmin APIエンティティを作成、読み取り、更新、または破棄できることを示すポリシーです。 |
プラグイン | プラグインは高度な機能を提供し、Kong Gateway の使用を拡張して、ゲートウェイへの新しい機能の追加を可能にします。プラグインは、特定のルートからすべてのアップストリームまで、さまざまなコンテキストで実行するように構成できます。プラグインは、認証、流量制限、またはプロキシされたリクエストの変換など、環境内で操作を実行できます。 |
プロキシ | Kong Gatewayは、クライアントとホスト間のトラフィックを管理するリバースプロキシです。Kongのプロキシ機能はゲートウェイとして、構成済みルートに照らして受信HTTPを評価します。 |
流量制限 | 流量制限により、アップストリームサービスがAPIコンシューマから受け取るリクエストの数、または各ユーザーがAPIを呼び出す頻度を制限できます。流量制限により、APIが不注意または悪意によって過剰に使用されるのを防ぎます。 |
Role(ロール) | ロールとは、再利用して管理者に割り当てることができる権限のセットです。 |
ルート | ルートはルートオブジェクトとも呼ばれ、クライアントのリクエストをアップストリームサービスに一致させるためのルールを定義します。各ルートはサービスに関連付けられており、1つのサービスに複数のルートが関連付けられている場合があります。ルートはアップストリームサービスへのエントリポイントです。 |
サービス | サービス(サービスオブジェクトとも呼ばれます)は、Kongが管理するアップストリームAPIとマイクロサービスです。たとえば、サービスとしては、データ変換マイクロサービスや課金APIなどがあります。サービスの主な属性はURLであり、これはKong Gatewayがトラフィックをプロキシする宛先です。URLは単一の文字列として設定することも、プロトコル、ホスト、ポート、パスを指定して設定することもできます。 |
スーパー管理者 | スーパー管理者、または/adminsおよび/rbacエンドポイントへの読み取りおよび書き込みアクセス権を持つ任意のロールは、新しいロールを作成し、権限をカスタマイズします。スーパー管理者は、他の管理者アカウントの招待および無効化、管理者へのロールの割り当てや取り消し、カスタム権限を持つ新しいロールの作成、新しいワークスペースの作成ができます。 |
スペック | YAMLまたはJSON形式でのサービスのOpenAPI定義。Dev Portalにアップロードして、組織内の開発者と共有できます。 |
タグ | タグはカスタマが定義したラベルであり、?tags クエリ文字列パラメータを使用した、コアエンティティの管理、検索、フィルタリングを可能にします。タグはほとんどのコアエンティティの作成または編集時に追加できます。各タグには英数字、\_\ 、- 、. または~ を1つ以上含める必要があります。 |
チーム | チームは、開発者をワーキンググループとして編成します。 |
技術プレビュー | 安定性を参照してください。 |
Tech partner plugin Premium partner plugin |
Kongによって検証され、特定の基準を満たしたサードパーティのカスタムプラグインです。これらのプラグインは外部の開発者によって開発、テスト、保守されていますが、プラグインの所有者はプラグインのバージョンとKong Gatewayの互換性も保証します。 |
サードパーティまたはコミュニティプラグイン | Kongではなく、外部の開発者によって開発、保守、サポートされているカスタムプラグイン Unless explicitly labeled as a tech partner or a premium partner, Kong does not test these plugins or maintain their version compatibility. If you need any support with these plugins, contact the maintainer directly. |
アップストリーム | アップストリームオブジェクトとは、クライアントリクエストが転送されるKong Gatewayによって管理されるAPIまたはサービスを指します。アップストリームオブジェクトは仮想ホスト名を表し、複数のサービスにわたる受信リクエストのロードバランシングに使用できます。 |
ワークスペース | ワークスペースを使用すると、組織はオブジェクトと管理者を名前空間に分割できます。セグメンテーションにより、同じKong Gatewayクラスターを共有する管理者チームは、特定のオブジェクトを操作する役割を担うことができます。 |