Kafka Consume Configuration

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

構成

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

互換性のあるプロトコル

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

grpc, grpcs, http, https, ws, wss

パラメータ

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

• name or plugin

  string required

  プラグイン名。この場合は kafka-consume 。

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

• instance_name

  string

  プラグインのインスタンスを識別するための任意のカスタム名 (例: kafka-consume_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 を使用する場合は必要ありません。

• consumer.name or consumer.id

  string

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

• enabled

  boolean default: true

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

• config

  record required
  • bootstrap_servers

    set of type record required

    Set of bootstrap brokers in a {host: host, port: port} list format.

    • host

      string required

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

    • port

      integer required between: 0 65535

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

  • topics

    array of type record required len_min: 1

    The Kafka topics and their configuration you want to consume from.

    • name

      string required

  • mode

    string required default: http-get Must be one of: server-sent-events, http-get

    The mode of operation for the plugin.

  • message_deserializer

    string required default: noop Must be one of: json, noop

    The deserializer to use for the consumed messages.

  • auto_offset_reset

    string required default: latest Must be one of: earliest, latest

    The offset to start from when there is no initial offset in the consumer group.

  • commit_strategy

    string required default: auto Must be one of: auto, off

    The strategy to use for committing offsets.

  • authentication

    record required
    • strategy

      string Must be one of: sasl

      The authentication strategy for the plugin, the only option for the value is sasl.

    • mechanism

      string Must be one of: PLAIN, SCRAM-SHA-256, SCRAM-SHA-512

      The SASL authentication mechanism. Supported options: PLAIN or SCRAM-SHA-256.

    • tokenauth

      boolean

      Enable this to indicate DelegationToken authentication

    • user

      string referenceable encrypted

      Username for SASL authentication.

    • password

      string referenceable encrypted

      Password for SASL authentication.

  • security

    record required
    • certificate_id

      string

      UUID of certificate entity for mTLS authentication.

    • ssl

      boolean

      Enables TLS.

  • cluster_name

    string

    An identifier for the Kafka cluster.