OPA Configuration

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

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

構成

このプラグインはDBレスモードに対応しています。

互換性のあるプロトコル

OPAプラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https

パラメータ

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

• name or plugin

  string required

  プラグイン名。この場合は opa 。

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

• 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
  • opa_protocol

    string default: http Must be one of: http, https

    The protocol to use when talking to Open Policy Agent (OPA) server. Allowed protocols are http and https.

  • opa_host

    string required default: localhost

    The DNS name or IP address of the OPA server.

  • opa_port

    integer required default: 8181 between: 0 65535

    The port of the OPA server.

  • opa_path

    string required starts_with: /

    The HTTP path to use when making a request to the OPA server. This is usually the path to the policy and rule to evaluate, prefixed with /v1/data/. For example, if you want to evaluate the allow rule inside example.kong package, then the path would be /v1/data/example/kong/allowBoolean.

  • include_service_in_opa_input

    boolean default: false

    If set to true, the Kong Gateway Service object in use for the current request is included as input to OPA.

  • include_route_in_opa_input

    boolean default: false

    If set to true, the Kong Gateway Route object in use for the current request is included as input to OPA.

  • include_consumer_in_opa_input

    boolean default: false

    If set to true, the Kong Gateway Consumer object in use for the current request (if any) is included as input to OPA.