Versioning and Compatibility for Data Transforms
The data transforms SDKs use semantic versioning to ensure compatibility and stability. Use this guide to learn the SDKs that are compatible with different versions of Redpanda, and what guarantees are provided regarding SDK and Redpanda compatibility.
Semantic versioning
The data transforms SDKs use semantic versioning, which is a versioning scheme with a three-part number: major.minor.patch. When a new version is released, one part of the version number is changed. The changed part of the version number signifies the level of change:
-
Major: Indicate breaking changes.
-
Minor: Indicate backward-compatible functionality.
-
Patch: Indicate backward-compatible bug fixes.
For example, in the version number 1.2.3, 1 is the major version, 2 is the minor version, and 3 is the patch version.
Compatibility matrix
This compatibility matrix provides detailed information on which versions of the SDK are supported with which versions of Redpanda. Always consult the compatibility matrix to ensure that you are using compatible versions.
SDK versions are backwards-compatible and will continue to be supported in newer versions of Redpanda. However, newer SDK versions may not work with older versions of Redpanda. Always check this compatibility matrix when upgrading the SDK or Redpanda.
Best practices
-
Stay updated: Regularly check the release notes for updates to both the data transform SDK and Redpanda. Ensure that you are using compatible versions as specified in the compatibility matrix.
-
Test upgrades: Before upgrading either the SDK or Redpanda, test the upgrade in a staging environment. This helps ensure that your data transforms continue to work as expected.
-
Monitor logs and metrics: Watch the logs and metrics to catch any issues early. Ensure that you set up monitoring and alerting to notify you of any problems with your data transforms.
Release notes
Check the Redpanda release notes for updates to the data transform SDKs.
The SDKs have their own version numbers, which are separate from Redpanda version numbers. The release notes include data transforms changes that ship in a Redpanda release. They do not list every SDK release. To find the SDK versions that work with your Redpanda version, see the compatibility matrix.
