Kong Functions (Pre-Plugins) Configuration

このページは、まだ日本語ではご利用いただけません。翻訳中です。

古いプラグインバージョンのドキュメントを閲覧しています。

構成

このプラグインはDB-lessモードと部分的に互換性があります。

The functions will be executed, but if the configured functions attempt to write to the database, the writes will fail.

互換性のあるプロトコル

Kong Functions (Pre-Plugins)プラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https, ws, wss

パラメータ

このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。

• name or plugin

  string required

  プラグイン名。この場合は pre-function 。

  • Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドはnameです。
  • Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドはpluginです。

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: pre-function_my-service 。

  インスタンス名はKong ManagerとKonnectに表示されるので、 例えば複数のサービスで同じプラグインを複数のコンテキストで実行する場合に便利です。また、Kong Admin API経由で特定のプラグインインスタンスに アクセスするためにも使用できます。

  インスタンス名は、次のコンテキスト内で一意である必要があります。

  • Kong Gateway Enterpriseのワークスペース内
  • Konnectのコントロールプレーン（CP）またはコントロールプレーン（CP）グループ内
  • Kong Gateway (OSS)の全世界

• service.name or service.id

  string

  プラグインが対象とするサービス名または ID。最上位の /plugins エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください /services/{serviceName|Id}/plugins を使用する場合は必要ありません。

• route.name or route.id

  string

  プラグインがターゲットとするルート名または ID。最上位の /plugins エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください /routes/{routeName|Id}/plugins を使用する場合は必要ありません。

• enabled

  boolean default: true

  このプラグインが適用されるかどうか。

• config

  record required
  • certificate

    array of type string required

    Array of stringified Lua code to be cached and run in sequence during the certificate phase.

    Note: This only runs on global plugins.

  • rewrite

    array of type string required

    Array of stringified Lua code to be cached and run in sequence during the rewrite phase.

    Note: This only runs on global plugins.

  • access

    array of type string required

    Array of stringified Lua code to be cached and run in sequence during the access phase.

  • header_filter

    array of type string required

    Array of stringified Lua code to be cached and run in sequence during the header_filter phase.

  • body_filter

    array of type string required

    Array of stringified Lua code to be cached and run in sequence during the body_filter phase.

  • log

    array of type string required

    Array of stringified Lua code to be cached and run in sequence during the log phase.

  • ws_handshake

    array of type string required

  • ws_client_frame

    array of type string required

  • ws_upstream_frame

    array of type string required

  • ws_close

    array of type string required