OPA設定

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

構成

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

互換性のあるプロトコル

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

grpc, grpcs, http, https

パラメータ

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

• name or plugin

  string required

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

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

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: opa_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
  • 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

    A string representing a host name, such as example.com.

  • opa_port

    integer required default: 8181 between: 0 65535

    An integer representing a port number between 0 and 65535, inclusive.

  • opa_path

    string required starts_with: /

    A string representing a URL path, such as /path/to/resource. Must start with a forward slash (/) and must not contain empty segments (i.e., two consecutive forward slashes).

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

  • include_body_in_opa_input

    boolean default: false

  • include_parsed_json_body_in_opa_input

    boolean default: false

    If set to true and the Content-Type header of the current request is application/json, the request body will be JSON decoded and the decoded struct is included as input to OPA.

  • include_uri_captures_in_opa_input

    boolean default: false

    If set to true, the regex capture groups captured on the Kong Gateway Route’s path field in the current request (if any) are included as input to OPA.

  • ssl_verify

    boolean required default: true

    If set to true, the OPA certificate will be verified according to the CA certificates specified in lua_ssl_trusted_certificate.