maksaska commented on code in PR #285:
URL: https://github.com/apache/ignite-extensions/pull/285#discussion_r1945014957


##########
modules/cdc-ext/README.txt:
##########
@@ -0,0 +1,29 @@
+Apache Ignite Change Data Capture Module
+------------------------
+
+Apache Ignite CDC is a data processing pattern used to asynchronously receive 
entries that have been changed on the local node so that action can be taken 
using the changed entry.
+
+This module provides the clients with a simple CDC implementations strategies 
for inter-cluster communication. Active-Passive and Active-Active replication 
regimes can be established with different CDC clients. Each such client should 
be started up for each node participating in CDC.
+
+==== Installation
+
+. Build `cdc-ext` module with maven:
++
+```console
+  $~/src/ignite-extensions/> mvn clean install -f modules/cdc-ext 
-Pcheckstyle,extension-release,skip-docs -DskipTests
+  $~/src/ignite-extensions/> ls modules/cdc-ext/target | grep zip
+ignite-cdc-ext.zip
+```
+
+. The resulting binary will be located under 'target' directory. Unpack 
`ignite-cdc-ext.zip` archive to `$IGNITE_HOME` folder to enable CDC.
+
+For Linux/Macos you can use in the ignite root with cdc binary:
++
+```console
+$ unzip ignite-cdc-ext-bin.zip
+$ cp -r ignite-cdc-ext/* .
+```
+
+Now, you have additional binary `$IGNITE_HOME/bin/kafka-to-ignite.sh` and 
`$IGNITE_HOME/libs/optional/ignite-cdc-ext` module.

Review Comment:
   Added examples in README



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: notifications-unsubscr...@ignite.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org

Reply via email to