Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Component upgrade compatibitliy: Can I upgrade brokers (or clients / connect / streams) directly from version X to version Y?
  • Client-Server compatibility: Can I use clients version X with brokers version Y?
  • Kafka Connect framework and connectors compatibility: Can I run a version X connector/SMT using Connect cluster version Y?
  • Maybe: Binary compatibility vs source compatibility (for clients, streams, connectors): Can I just switch the jar and re-deploy, or do I need to recompile my code using the new jar first?

We propose to maintain compatibility across two major version going forward. This assume that there is at least 4 minor version, e.g., 5.0.x to 5.3.x. If there is only 3 minor versions, e.g., the last version is 5.2.x before we go to 6.x, compatibility is guaranteed across three major versions, i.e., between 4.x and 6.x.

Component upgrades:

  • Broker and Kafka Connect can be directly upgraded from 4.x to 5.x version. However, there is no guarantee that 3.x brokers / connect workers can be directly upgraded to 5.x.
  • Clients (producer/consumers/admin/Kafka Streams) API compatibility:
    • We are allowed break API compatibility with a major release, i.e., 5.x will remove deprecated API
    • We still guarantee a one year API compatibility window, i.e., APIs deprecated in the last three minor versions of 4.x series will not be removed with the 5.0.0 release
    • These last three minor version of 4.x act as bridge release version, and upgrading to any 5.x version is supported
    • Upgrading clients directly from 3.x to 5.x is not supported any longer.

...

  • Clients with version 4.x can connect to 5.x brokers, but older clients 3.x and older are not supported any longer.
  • Clients with version 5.x can connect to 4.x brokers, but broker 3.x and older are not supported any longer.
  • The clients backward compatibility directly translates into the same guarantees for Kafka Connect and Kafka Streams.

Kafka Connect:

  • Connectors/SMTs compiled with version 4.x can be deployed into a 5.x Connect cluster. However, Connector complied with version 3.x are not supported with Connect 5.x any longer.

...