kafka2delta 1.0.0__tar.gz

kafka2delta-1.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Sebastian Daberdaku
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   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.

kafka2delta-1.0.0/PKG-INFO

@@ -0,0 +1,277 @@
+Metadata-Version: 2.4
+Name: kafka2delta
+Version: 1.0.0
+Summary: Stream Change Data Capture data from Kafka into Delta Tables using Spark StructuredStreaming.
+Author-email: Sebastian Daberdaku <112859176+sdaberdaku@users.noreply.github.com>
+Project-URL: Repository, https://github.com/sdaberdaku/kafka2delta.git
+Project-URL: Issues, https://github.com/sdaberdaku/kafka2delta/issues
+Keywords: CDC,Debezium,Kafka,Delta Lake,Spark,PostgreSQL
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: confluent-kafka<2.6.0,>=2.5.0
+Requires-Dist: delta-spark<4.0.0,>=3.2.0
+Requires-Dist: pyspark<4.0.0,>=3.5.1
+Dynamic: license-file
+
+# kafka2delta
+This Python package provides the means to stream Change Data Capture data from Kafka (i.e. generated with Debezium) 
+into one or more Delta Tables using Spark Structured Streaming.
+
+The package allows fully replicating Relational Database (e.g. Postgres, MySQL) tables by merging row-level change 
+events streamed from Kafka topics into Delta Tables. Kafka messages are expected to be compressed following the
+Confluent Avro format. Moreover, the Confluent Schema Registry is required for decoding such messages.
+
+## Kafka Message Format (Source)
+Kafka messages have a **key** and a **value**, both of which are serialized in Confluent Avro.
+
+**key** contains the Avro-encoded primary key of the given record.
+**value** contains the Avro-encoded content of the whole record.
+
+An Avro-encoded message is composed as follows:
+- **Magic Byte (1 byte)** → Always `0x00`, indicating Confluent Avro encoding.
+- **Schema ID (4 bytes, Big-Endian)** → Identifies the Avro schema in Confluent Schema Registry.
+- **Avro Payload (Binary Encoded)** → Actual data serialized in Avro format.
+
+## Setting up local development environment
+Create Conda environment and install the requirements with the following code:
+
+```shell
+conda create --name kafka2delta python=3.10 -y
+conda activate kafka2delta
+pip install -r requirements-dev.txt
+```
+
+## Installation
+The package can be installed with the following command:
+```shell
+pip install git+ssh://git@github.com/sdaberdaku/kafka2delta.git#egg=kafka2delta
+```
+
+Locally, the package can be installed with the following command:
+```shell
+pip install -e .
+```
+
+Build distribution package with the following command:
+```shell
+python -m build .
+```
+
+## Preparing testing environment
+To test the `kafka2delta` package, a Kubernetes cluster can be created with `kind` so that the necessary components can 
+be installed.
+
+The following documentation will describe how to install a Postgres database and create a Change Data Capture (CDC) 
+pipeline with Kafka and Debezium. The `kafka2delta` package can then be used to stream the CDC data from the related 
+Kafka Topics into the corresponding Delta Tables.
+
+First of all, install `kubectl`:
+```shell
+# 1. Download the desired kubectl version
+curl -LO https://dl.k8s.io/release/v1.31.0/bin/linux/amd64/kubectl
+# 2. Install kubectl
+sudo install -o root -g root -m 0755 kubectl /usr/local/bin/kubectl
+```
+
+Now we can install `helm` and `kind`. A convenient way of doing so is by using `brew`:
+```shell
+brew install helm kind
+```
+
+Now we are ready to create our `kind` cluster. Use the following commands to create the K8s cluster for testing:
+```shell
+kind create cluster --name kafka2delta
+kubectl config use-context kind-kafka2delta
+```
+
+As a first step, we should install Telepresence/Traffic Manager. This tool allows us to expose K8s cluster DNS names to
+the host machine, simplifying connectivity and allowing us to avoid using port-forwarding.
+
+Install telepresence client with the following commands:
+```shell
+# 1. Download the latest binary (~95 MB):
+sudo curl -fL https://app.getambassador.io/download/tel2oss/releases/download/v2.17.0/telepresence-linux-amd64 -o /usr/local/bin/telepresence
+# 2. Make the binary executable:
+sudo chmod a+x /usr/local/bin/telepresence
+```
+
+Now we can install the Traffic Manager on the `kind` cluster.
+```shell
+helm repo add datawire https://app.getambassador.io
+helm install traffic-manager datawire/telepresence \
+  --version 2.17.0 \
+  --namespace ambassador \
+  --create-namespace \
+  --wait \
+  --set ambassador-agent.enabled=false
+```
+
+We can now connect to the Kind cluster using telepresence:
+```shell
+telepresence connect --context kind-kafka2delta
+```
+
+Once the cluster is up and running, we can install the Postgres database that we will use for our tests:
+```shell
+# Install Postgres
+export PG_CONFIG=$(cat <<EOF
+listen_addresses = '*'
+wal_level = 'logical'
+EOF
+)
+helm install postgres oci://registry-1.docker.io/bitnamicharts/postgresql \
+  --version 15.5.20 \
+  --namespace postgres \
+  --create-namespace \
+  --wait \
+  --set auth.enablePostgresUser=true \
+  --set auth.postgresPassword=postgres \
+  --set primary.networkPolicy.enabled=false \
+  --set primary.persistence.enabled=false \
+  --set primary.configuration="${PG_CONFIG}"
+```
+
+After the installation is complete, we can create the tables that we will use for testing the CDC replication.
+`psql` can be installed with the following command:
+```shell
+sudo apt update && sudo apt install -y postgresql-client
+```
+
+```shell
+# Create the required tables
+psql "postgresql://postgres:postgres@postgres-postgresql.postgres.svc.cluster.local:5432/postgres" -c "
+CREATE TABLE users (
+    id SERIAL PRIMARY KEY,
+    name VARCHAR(100) NOT NULL,
+    email VARCHAR(100) UNIQUE NOT NULL,
+    created_at DATE NOT NULL
+);
+CREATE TABLE orders (
+    id SERIAL PRIMARY KEY,
+    order_date TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
+    total_amount DECIMAL(10,2) NOT NULL,
+    created_at DATE NOT NULL    
+);
+CREATE TABLE products (
+    id SERIAL PRIMARY KEY,
+    name VARCHAR(100) NOT NULL,
+    price DECIMAL(10,2) NOT NULL,
+    created_at DATE NOT NULL    
+);
+"
+```
+
+Now we can proceed by installing the `Strimzi Operator` that will be used to install and manage Kafka, Debezium, and the
+related resources.
+```shell
+# Install the Strimzi Kafka Operator
+helm install strimzi-kafka-operator oci://quay.io/strimzi-helm/strimzi-kafka-operator \
+  --version 0.42.0\
+  --namespace strimzi \
+  --create-namespace \
+  --wait \
+  --set replicas=1 \
+  --set watchAnyNamespace=true \
+  --set generateNetworkPolicy=false
+```
+
+Create the `cdc` K8s namespace:
+```shell
+kubectl create namespace cdc
+```
+
+Now we can start setting up Kafka and the related resources:
+```shell
+# Create Kafka Cluster and Kafka Nodepool CRs
+kubectl apply -f ./resources/kafka-cluster.yaml
+```
+Once the Kafka cluster and the Entity operator are up, we can create the topics.
+```shell
+# Create Kafka topics (one for each table to replicate)
+kubectl apply -f ./resources/kafka-topics.yaml
+```
+
+At this point we can install the Confluent Schema Registry:
+```shell
+helm install schema-registry oci://registry-1.docker.io/bitnamicharts/schema-registry \
+  --version 20.0.0 \
+  --namespace cdc \
+  --create-namespace \
+  --timeout 15m \
+  --wait \
+  --set replicaCount=1 \
+  --set avroCompatibilityLevel=none \
+  --set networkPolicy.enabled=false \
+  --set kafka.enabled=false \
+  --set "externalKafka.brokers[0]=PLAINTEXT://cdc-kafka-bootstrap:9092"
+```
+
+(Optional) Install the Kafka UI to inspect the created topics and related messages:
+```shell
+helm repo add kafka-ui https://provectus.github.io/kafka-ui-charts
+helm install kafka-ui kafka-ui/kafka-ui \
+  --version 0.7.6 \
+  --namespace cdc \
+  --create-namespace \
+  --wait \
+  --set replicaCount=1 \
+  --set yamlApplicationConfig.kafka.internalTopicPrefix=__ \
+  --set "yamlApplicationConfig.kafka.clusters[0].name=cdc" \
+  --set "yamlApplicationConfig.kafka.clusters[0].bootstrapServers=cdc-kafka-brokers:9092" \
+  --set yamlApplicationConfig.auth.type=disabled \
+  --set yamlApplicationConfig.management.health.ldap.enabled=false
+```
+
+Before installing the Debezium Connector, we need to build the Kafka Connect Docker image, and make it available to the
+Kind cluster. The following command can be used to do so:
+```shell
+# Build Kafka Connect Docker image with the required dependencies for running Debezium
+docker build -t strimzi-debezium-postgres:2.7.0.Final -f ./resources/kafka-connect.Dockerfile .
+
+# Load the image to the Kind cluster
+kind load docker-image strimzi-debezium-postgres:2.7.0.Final --name kafka2delta
+```
+
+Now we can create the Kafka Connect and Debezium connector configuration:
+```shell
+# Create Kafka Connect cluster
+kubectl apply -f ./resources/kafka-connect.yaml
+# Configure Debezium connector
+kubectl apply -f ./resources/kafka-connector.yaml
+```
+
+Setting up LocalStack
+
+```shell
+helm repo add localstack-charts https://localstack.github.io/helm-charts
+helm install localstack localstack-charts/localstack \
+  --version 0.6.22 \
+  --namespace localstack \
+  --create-namespace \
+  --wait \
+  --set replicaCount=1 \
+  --set role.create=false \
+  --set persistence.enabled=false \
+  --set startServices=s3 \
+  --set service.type=ClusterIP
+```
+
+## Running tests
+Test can be run with the following command:
+```shell
+python -m pytest .
+```
+
+The Spark UI can be viewed at [http://localhost:4040](http://localhost:4040).
+
+## Clean up
+To clean up the created resources delete the kind cluster:
+```shell
+kubectl delete -f ./resources/kafka-topics.yaml
+telepresence quit
+kind delete cluster --name kafka2delta
+```