Skip to content

Latest commit

 

History

History
84 lines (55 loc) · 3.46 KB

README.md

File metadata and controls

84 lines (55 loc) · 3.46 KB
Raw

Ed-Fi Transformations for Apache Kafka® Connect

OpenSSF Scorecard

Single Message Transformations (SMTs) for Apache Kafka Connect.

Transformations

See the Kafka documentation for more details about configuring transformations on how to install transforms.

RenameDmsTopicToOpenSearchIndex

This transformation renames the DMS topic to be an OpenSearch index based on the document ProjectName and ResourceName.

Example of this transformation configuration:

transforms=RenameDmsTopicToOpenSearchIndex
transforms.RenameDmsTopicToOpenSearchIndex.type=org.edfi.kafka.connect.transforms.RenameDmsTopicToOpenSearchIndex

DebeziumDeletedToTombstone

This transformation checks for a Debezium _deleted=true flag. If found, it turns it into a tombstone.

Example of this transformation configuration:

transforms=DebeziumDeletedToTombstone
transforms.DebeziumDeletedToTombstone.type=org.edfi.kafka.connect.transforms.DebeziumDeletedToTombstone

Running transformations

Prerequisites

  • Install, if you don't have it, gradle version 7.2.4 according to the installation guide
  • To verify your installation, open a console (or a Windows command prompt) and run gradle -v to run gradle and display the version, e.g.: > gradle -v Result:
------------------------------------------------------------
Gradle 7.2.4
------------------------------------------------------------
  • To run the transforms locally for the first time you need to build the gradle-wrapper.jar. To generate it, run the following command from the ed-fi-kafka-connect-transforms directory. This will add the gradle-wrapper.jar in the gradle\wrapper folder > gradle wrapper
    • If you encounter an error message java.security.NoSuchAlgorithmException: Error constructing implementation (algorithm: Default, provider: SunJSSE, class: sun.security.ssl.SSLContextImpl$DefaultSSLContext), gradle could not find your Java cacert trustStore directory. Re-run and specify it explicitly e.g. gradle wrapper -Djavax.net.ssl.trustStore=/usr/lib/jvm/default-java/lib/security/cacerts.
    • If you encounter file system watcher errors/warnings and don't care about gradle watching in the background, add the --no-watch-fs flag.

Tasks

This project includes a series of gradle tasks:

  • ./gradlew build: Compile code

  • ./gradlew test: Run unit tests

  • ./gradlew installDist: Creates a jar distributable file, located under /build/install/ed-fi-kafka-connect-transforms/ed-fi-kafka-connect-transforms-{version}.jar

Build container

To build the container with a dev tag, simply run docker build -t edfialliance/ed-fi-kafka-connect:dev . from the kafka directory.

Legal Information

Copyright (c) 2024 Ed-Fi Alliance, LLC and contributors.

Licensed under the Apache License, Version 2.0 (the "License").

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.