Kafka Mesh

This extension may be referenced by the qualified name envoy.filters.network.kafka_mesh

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:

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.

Kafka Mesh configuration overview.

extensions.filters.network.kafka_mesh.v3alpha.KafkaMesh

[extensions.filters.network.kafka_mesh.v3alpha.KafkaMesh proto]

  1. {
  2.   "advertised_host": "...",
  3.   "advertised_port": "...",
  4.   "upstream_clusters": [],
  5.   "forwarding_rules": []
  6. }

advertised_host

(string, REQUIRED) Envoy’s host that’s advertised to clients. Has the same meaning as corresponding Kafka broker properties. Usually equal to filter chain’s listener config, but needs to be reachable by clients (so 0.0.0.0 will not work).

advertised_port

(int32) Envoy’s port that’s advertised to clients.

upstream_clusters

(repeated extensions.filters.network.kafka_mesh.v3alpha.KafkaClusterDefinition) Upstream clusters this filter will connect to.

forwarding_rules

(repeated extensions.filters.network.kafka_mesh.v3alpha.ForwardingRule) Rules that will decide which cluster gets which request.

extensions.filters.network.kafka_mesh.v3alpha.KafkaClusterDefinition

[extensions.filters.network.kafka_mesh.v3alpha.KafkaClusterDefinition proto]

  1. {
  2.   "cluster_name": "...",
  3.   "bootstrap_servers": "...",
  4.   "partition_count": "...",
  5.   "producer_config": "{...}"
  6. }

cluster_name

(string, REQUIRED) Cluster name.

bootstrap_servers

(string, REQUIRED) Kafka cluster address.

partition_count

(int32) Default number of partitions present in this cluster. This is especially important for clients that do not specify partition in their payloads and depend on this value for hashing.

producer_config

(repeated map<string, string>) Custom configuration passed to Kafka producer.

extensions.filters.network.kafka_mesh.v3alpha.ForwardingRule

[extensions.filters.network.kafka_mesh.v3alpha.ForwardingRule proto]

  1. {
  2.   "target_cluster": "...",
  3.   "topic_prefix": "..."
  4. }

target_cluster

(string) Cluster name.

topic_prefix

(string) Intended place for future types of forwarding rules.