Updated content of README

Added helper images

kafka-connector-cdc/.gitignore

@@ -1 +1,2 @@
 kafka-connect-dse-2.0.0-20190925-LABS.jar
+kafka-connect-dse-2.0.0-20190925-LABS.tar.gz

kafka-connector-cdc/README.md

@@ -1,17 +1,27 @@
-# DataStax Kafka Connector Source Demo
+# DataStax CDC for Apache Kafka
+
+Below is a guide for running and validating the DataStax Enterprise CDC Connector for Apache Kafka. This builds on the excellent foundation of the DataStax Apache Kafka Connector by adding CDC functionality as a Source Connector.
 
 ## Install Dependencies
 
 1. Install Docker
 2. Install Docker Compose
-3. Download kafaka-connect-dse-2.0.0-20190925-LABS.jar from [DataStax Labs]() and place it within this directory.
+3. Check out a copy of this repository
+4. Download kafaka-connect-dse-2.0.0-20190925-LABS.jar from [DataStax Labs](https://downloads.datastax.com/#labs) and place it within this directory.
+
+## Start the DataStax Enterprise and Apache Kafka Components
+
+Note that the Source functionality of this connector will **ONLY** work with a specific Labs Edition build of DataStax Enterprise 6.8.0. This build is currently only available as a Docker container at [datastaxlabs/dse-cdc-server](https://hub.docker.com/r/datastaxlabs/dse-cdc-server). This container is referenced in the Docker Compose [configuration file](https://github.com/datastax/labs/blob/master/kafka-connector-cdc/docker-compose.yml) in this directory. This container does not have to be run within Docker compose, it's included here as a way to ease testing efforts. 
+
+This container does have modified `cassandra.yaml` and `dse.yaml` files. `cassandra.yaml` has been tuned to reduce the periodic commit log sync to 500ms and enable CDC. `dse.yaml` has DSE Advanced Replication enabled.
 
-## Start the components
 1. Start up the stack `docker-compose up -d`
 
-If for some reason a component does not come up due a dependency being down try running this command again.
+If for some reason a component does not come up due to the order of containers being started try running the command again.
+
+## Configure DataStax Enterprise for Replication to Kafka
+DataStax Enterprise Advanced Replication underpins the deduplication and replication of mutations for a set of source tables, through a replication channel, and to a destination. In this setup we must create a keyspace and table to write messages to. Followed by a DSE Advanced Replication Destination and Channel.
 
-## Configure DSE
 1. Configure DSE schema 
 
    ```
@@ -42,29 +52,48 @@ If for some reason a component does not come up due a dependency being down try
    ```
 
 ## Configure Kafka and the Connector
+With everything configured within DSE it is now time to create a topic to receive our mutations and an instance of the connector to process the CDC messages.
+
 1. Connect to the Confluent Control Panel http://localhost:9021/
 2. Select the only cluster
-3. Click "Topics" in the left sidebar
-4. Click "Add a topic" in the top right corner
-5. Enter the following parameters then click "Create with defaults"
+
+   ![Confluent Control Center](images/control_center_cluster_selection.png)
+
+3. Click "_Topics_" in the left sidebar
+
+    ![Topics Button](images/topics_sidebar.png)
+
+4. Click "_Add a topic_" in the top right corner
+5. Enter the following parameters then click "_Create with defaults_"
 
-    Topic name: demo-topic
-    Number of partitions: 1
-
-6. Open "Connect" in the left sidebar
-7. Click "connect-default"
-8. Click "Add Connector"
-9. Click "Connect" under "DseSourceConnector"
-10. Enter the following parameters and click "Continue"
-
-    Name: demo-connector
-    Tasks max: 1
-    Key converter class: JsonConverter
-    Value converter class: JsonConverter
-    topic: demo-topic
-    destination: demo_destination
-    contact_points: dse
-11. Verify configuration parameters and click "Launch"
+    **Topic name:** demo-topic
+    **Number of partitions:** 1
+
+    ![Create the topic](images/create_topic.png)
+
+6. Open "_Connect_" in the left sidebar
+7. Click "_connect-default_"
+8. Click "_Add Connector_"
+9. Click "_Connect_" under "_DseSourceConnector_"
+
+   ![Dse Source Connector](images/browse_connector_list.png)
+
+10. Enter the following parameters and click "_Continue_"
+
+    **Name:** demo-connector
+    **Tasks max:** 1
+    **Key converter class:** JsonConverter
+    **Value converter class:** JsonConverter
+    **topic:** demo-topic
+    **destination:** demo_destination
+    **contact_points:** dse
+
+    ![Common Configuration](images/add_connector_common.png)
+    ![General Configuration](images/add_connector_general.png)
+
+11. Verify configuration parameters and click "_Launch_"
+
+    ![Verify](images/add_connector_verify.png)
 
 ## Insert data to be replicated
 1. Start `cqlsh` and insert data
@@ -87,7 +116,16 @@ If for some reason a component does not come up due a dependency being down try
     docker-compose exec dse dse advrep replog count --source-keyspace demo_ks --source-table demo_table --destination demo_destination
     ```
 2. Navigate to the topic view in the confluent control center
-3. Click "Topics" in the left side bar
-4. Select "demo-topic"
+3. Click "_Topics_" in the left side bar
+4. Select "_demo-topic_" from the list
 5. Validate messages are being produced and consumed
 6. Optionally look at the messages
+
+   ![Incoming messages](images/incoming_mutations.gif)
+   
+   Note the record structure:
+
+   * Key: JSON object representing all primary key columns
+   * Value: JSON object representing all non-primary key columns
+   * Timestamp: Microsecond timestamp of the mutation converted to milliseconds
+   * Headers: Includes the keyspace name, table name, and replication type (INSERT, UPDATE, or DELETE)