Skip to content

Commit 7ab280e

Browse files
mfernestclaudeFeediver1
authored
feat(DOC-2012): document Kafka 4.x client compatibility and KIP-890 (#1614)
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Joyce Fee <joyce@redpanda.com> Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
1 parent 232c4eb commit 7ab280e

1 file changed

Lines changed: 24 additions & 14 deletions

File tree

modules/develop/pages/kafka-clients.adoc

Lines changed: 24 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,24 @@
33
:page-categories: Clients, Development, Kafka Compatibility
44
:pp: {plus}{plus}
55
:description: Kafka clients, version 0.11 or later, are compatible with Redpanda. Validations and exceptions are listed.
6+
:page-topic-type: reference
7+
:personas: developer
8+
:learning-objective-1: Identify which Kafka clients are validated with Redpanda
9+
:learning-objective-2: Identify unsupported Kafka features when integrating with Redpanda
610
// tag::single-source[]
711

8-
Redpanda is compatible with Apache Kafka versions 0.11 and later, with specific exceptions noted on this page.
12+
Redpanda is compatible with Apache Kafka® versions 0.11 and later, with specific exceptions noted on this page.
13+
14+
Use this reference to:
15+
16+
* [ ] {learning-objective-1}
17+
* [ ] {learning-objective-2}
918
1019
== Kafka client compatibility
1120

12-
Clients developed for Kafka versions 0.11 or later are compatible with Redpanda. Modern clients auto-negotiate protocol versions or use an earlier protocol version accepted by Redpanda brokers.
21+
Clients developed for Kafka versions 0.11 or later are compatible with Redpanda. The Apache Kafka Java client at version 4.x is validated against Redpanda using the ducktape and chaos test suites; other clients in the table here remain compatible with the Kafka protocol versions they have always supported. Modern clients auto-negotiate protocol versions or use an earlier protocol version accepted by Redpanda brokers.
1322

14-
TIP: Redpanda Data recommends always using the latest supported version of a client.
23+
TIP: Always use the latest supported version of a Kafka client.
1524

1625
The following clients have been validated with Redpanda.
1726

@@ -34,30 +43,29 @@ The following clients have been validated with Redpanda.
3443
| https://github.com/kafka-rust/kafka-rust[kafka-rust^]
3544

3645
| Node.js
37-
a|
38-
* https://kafka.js.org[KafkaJS^]
46+
a|
47+
* https://kafka.js.org[KafkaJS^]
3948
* https://github.com/confluentinc/confluent-kafka-javascript[confluent-kafka-javascript^]
4049

4150
|===
4251

43-
Clients that have not been validated by Redpanda Data, but use the Kafka protocol, remain compatible with Redpanda subject to the limitations below (particularly those based on librdkafka, such as confluent-kafka-dotnet or confluent-python).
52+
Clients that have not been validated by Redpanda Data, but use the Kafka protocol, remain compatible with Redpanda subject to the limitations in the next section (particularly those based on librdkafka, such as confluent-kafka-dotnet or confluent-python).
4453

45-
If you find a client that is not
46-
supported, reach out to the Redpanda team in the community https://redpanda.com/slack[Slack^].
54+
If you find a client that does not work with Redpanda, reach out in the https://redpanda.com/slack[Redpanda community Slack^].
4755

4856
== Unsupported Kafka features
4957

50-
Redpanda does not currently support the following Apache Kafka features:
58+
Redpanda does not support the following Kafka features:
5159

52-
* Multiple SCRAM mechanisms simultaneously for SASL users; for example, a user having both a `SCRAM-SHA-256` and a `SCRAM-SHA-512` credential. Redpanda supports only one SASL/SCRAM mechanism per user, either `SCRAM-SHA-256` or `SCRAM-SHA-512`.
60+
* Multiple SCRAM mechanisms simultaneously for SASL users. For example, a user cannot have both a `SCRAM-SHA-256` and a `SCRAM-SHA-512` credential. Redpanda supports only one SASL/SCRAM mechanism per user: either `SCRAM-SHA-256` or `SCRAM-SHA-512`.
5361
+
5462
ifndef::env-cloud[]
55-
See the xref:manage:security/authentication.adoc#sasl[Configure Authentication] guide for details.
63+
For details, see xref:manage:security/authentication.adoc#sasl[Configure SASL authentication].
5664
endif::[]
5765
ifdef::env-cloud[]
58-
See the xref:security:cloud-authentication.adoc[Authentication] guide for details.
66+
For details, see xref:security:cloud-authentication.adoc[Authentication].
5967
endif::[]
60-
* HTTP Proxy (pandaproxy): Unlike other REST proxy implementations in the Kafka ecosystem, Redpanda HTTP Proxy does not support topic and ACLs CRUD through the HTTP Proxy. HTTP Proxy is designed for clients producing and consuming data that do not perform administrative functions.
68+
* HTTP Proxy (`pandaproxy`): Unlike other REST proxy implementations in the Kafka ecosystem, Redpanda HTTP Proxy does not support topic and ACLs CRUD through the HTTP Proxy. HTTP Proxy is designed for clients producing and consuming data that do not perform administrative functions.
6169
ifdef::env-cloud[]
6270
+
6371
* The `delete.retention.ms` topic configuration in Kafka is not supported for Tiered Storage topics. Cloud Topics and local storage topics support Tombstone marker deletion using `delete.retention.ms`, but in Tiered Storage topics, Tombstone markers are only removed in accordance with normal topic retention, and only if the cleanup policy is `delete` or `compact, delete`.
@@ -66,7 +74,9 @@ ifndef::env-cloud[]
6674
+
6775
* Quotas per user for bandwidth and API request rates. However, xref:manage:cluster-maintenance/manage-throughput.adoc#client-throughput-limits[quotas per client and per client group] using AlterClientQuotas and DescribeClientQuotas APIs are supported.
6876
endif::[]
77+
+
78+
* https://cwiki.apache.org/confluence/display/KAFKA/KIP-890[KIP-890^] (Transactions Server-Side Defense): Redpanda does not implement the server-side portion of KIP-890, which addresses transaction errors specific to Kafka's replication model. Redpanda's implementation of transactions is not susceptible to this class of errors. When connecting to Redpanda, Kafka 4.x clients detect that Transactions V2 is unsupported and fall back to the original transaction protocol (per-transaction epoch bumping is part of V2 and does not apply).
6979

70-
If you have any issues while working with a Kafka tool, you can https://github.com/redpanda-data/redpanda/issues/new[file an issue^].
80+
If you find an unsupported feature or incompatibility, https://github.com/redpanda-data/redpanda/issues/new[file an issue^] with the Redpanda team.
7181

7282
// end::single-source[]

0 commit comments

Comments
 (0)