Kafka codec configuration for Generic Proxy (proto)

This extension has the qualified name envoy.generic_proxy.codecs.kafka

Note

This extension is only available in contrib images.

Note

This extension is work-in-progress. Functionality is incomplete and it is not intended for production use.

This extension is not hardened and should only be used in deployments where both the downstream and upstream are trusted.

Tip

This extension extends and can be used with the following extension category:

This extension must be configured with one of the following type URLs:

Warning

This API feature is currently work-in-progress. API features marked as work-in-progress are not considered stable, are not covered by the threat model, are not supported by the security team, and are subject to breaking changes. Do not use this feature without understanding each of the previous points.

extensions.filters.network.generic_proxy.codecs.kafka.v3.KafkaCodecConfig

[extensions.filters.network.generic_proxy.codecs.kafka.v3.KafkaCodecConfig proto]

Configuration for Kafka codec. This codec gives the generic proxy the ability to proxy Kafka traffic. But note any route configuration for Kafka traffic is not supported yet. The generic proxy can only used to generate logs or metrics for Kafka traffic but cannot do matching or routing.

Note

The codec can currently only be used in the sidecar mode. And to ensure the codec works properly, please make sure the following conditions are met:

  1. The generic proxy must be configured with a wildcard route that matches all traffic.

  2. The target cluster must be configured as a original destination cluster.

  3. The bind_upstream_connection of generic proxy router must be set to true to ensure same upstream connection is used for all traffic from same downstream connection.