Added images, configuration params descriptions and disabled encryption by default (#140)

Author: conker84

doc/asciidoc/kafka-connect/index.adoc

@@ -1,5 +1,8 @@
 == Kafka Connect
 
+image::neo4j-loves-confluent.png[Neo4j Loves Confluent]
+
+
 Kafka Connect, an open source component of Apache Kafka, is a framework for connecting Kafka with external systems such as databases, key-value stores, search indexes, and file systems.
 
 The Neo4j Streams project provides a Kafka Connect plugin that can be installed into the Confluent Platform enabling:
@@ -17,4 +20,16 @@ Inside the directory `/kafka-connect-neo4j/docker` you'll find a compose file th
 include::../../../kafka-connect-neo4j/docker/docker-compose.yml[]
 ----
 
-include::../../../kafka-connect-neo4j/docker/readme.adoc[]
+include::../../../kafka-connect-neo4j/docker/readme.adoc[]
+
+=== Monitor via Confluent Platform UI
+
+The Kafka Monitoring UI can be found at http://<localhost>:9021/management/connect
+
+image::confluent-metrics.jpg[Confluent Importing Metrics]
+
+They show up properly in my topic, and then are added to Neo4j via the sink.
+
+Below you see the data that has been ingested into Neo4j. During my testing I got up to more than 2M events.
+
+image::confluent-imported-data.jpg[Confluent Platform Management]

doc/images/confluent-imported-data.jpg

@@ -11,7 +11,6 @@
     "neo4j.server.uri": "bolt://neo4j:7687",
     "neo4j.authentication.basic.username": "neo4j",
     "neo4j.authentication.basic.password": "connect",
-    "neo4j.encryption.enabled": false,
     "neo4j.topic.cypher.my-topic": "MERGE (p:Person{name: event.name, surname: event.surname, from: 'AVRO'}) MERGE (f:Family{name: event.surname}) MERGE (p)-[:BELONGS_TO]->(f)"
   }
 }

doc/images/confluent-metrics.jpg

@@ -14,7 +14,6 @@
     "neo4j.server.uri": "bolt://neo4j:7687",
     "neo4j.authentication.basic.username": "neo4j",
     "neo4j.authentication.basic.password": "connect",
-    "neo4j.encryption.enabled": false,
     "neo4j.topic.cypher.my-topic": "MERGE (p:Person{name: event.name, surname: event.surname, from: 'JSON'}) MERGE (f:Family{name: event.surname}) MERGE (p)-[:BELONGS_TO]->(f)"
   }
 }

doc/images/neo4j-loves-confluent.png

@@ -1,3 +1,29 @@
+=== Configuration parameters
+
+You can set the following configuration values via Confluent Connect UI, or via REST endpoint
+
+[cols="3*",options="header"]
+|===
+|Field|Type|Description
+
+|neo4j.server.uri|String|The Bolt URI
+|neo4j.authentication.type|enum[NONE, BASIC, KERBEROS]| The authentication type (default BASIC)
+|neo4j.batch.size|Int|The max number of events processed by the Cypher query (default 1000)
+|neo4j.batch.timeout.msec|Long|The execution timeout for the cypher query (default 30000)
+|neo4j.authentication.basic.username|String| The authentication username
+|neo4j.authentication.basic.password|String| The authentication password
+|neo4j.authentication.basic.realm|String| The authentication realm
+|neo4j.authentication.kerberos.ticket|String| The Kerberos ticket
+|neo4j.encryption.enabled|Boolean| If the encryption is enabled (default false)
+|neo4j.encryption.trust.strategy|enum[TRUST_ALL_CERTIFICATES,TRUST_CUSTOM_CA_SIGNED_CERTIFICATES,TRUST_SYSTEM_CA_SIGNED_CERTIFICATES]| The Neo4j trust strategy (default TRUST_ALL_CERTIFICATES)
+|neo4j.encryption.ca.certificate.path|String| The path of the certificate
+|neo4j.connection.max.lifetime.msecs|Long| The max Neo4j connection lifetime (default 1 hour)
+|neo4j.connection.acquisition.timeout.msecs|Long| The max Neo4j acquisition timeout (default 1 hour)
+|neo4j.connection.liveness.check.timeout.msecs|Long| The max Neo4j liveness check timeout (default 1 hour)
+|neo4j.connection.max.pool.size|Int| The max pool size (default 100)
+|neo4j.load.balance.strategy|enum[ROUND_ROBIN,LEAST_CONNECTED]| The Neo4j load balance strategy (default LEAST_CONNECTED)
+|===
+
 === Build it locally
 
 Build the project by running the following command:
@@ -84,7 +110,7 @@ http://localhost:9021/management/connect
 
 (or on 0.0.0.0 instead of localhost depending on your Docker environment)
 
-and click to the **Sink** tab. You must find a table just like this:
+and click to the **Send data out** (or **Sink** depending on your Confluent Platform Version) tab. You must find a table just like this:
 
 [cols="4*",options="header"]
 |===

kafka-connect-neo4j/docker/README.md

@@ -182,7 +182,7 @@ class Neo4jSinkConnectorConfig(originals: Map<*, *>) : AbstractConfig(config(),
                             .build())
                     .define(ConfigKeyBuilder.of(ENCRYPTION_ENABLED, ConfigDef.Type.BOOLEAN)
                             .documentation(ENCRYPTION_ENABLED)
-                            .importance(ConfigDef.Importance.HIGH).defaultValue(true)
+                            .importance(ConfigDef.Importance.HIGH).defaultValue(false)
                             .group(GROUP_ENCRYPTION).build())
                     .define(
                             ConfigKeyBuilder.of(ENCRYPTION_TRUST_STRATEGY, ConfigDef.Type.STRING)

kafka-connect-neo4j/docker/contrib.sink.avro.neo4j.json

@@ -5,6 +5,7 @@ import org.junit.Test
 import org.neo4j.driver.internal.async.pool.PoolSettings
 import org.neo4j.driver.v1.Config
 import kotlin.test.assertEquals
+import kotlin.test.assertFalse
 import kotlin.test.assertNull
 import kotlin.test.assertTrue
 
@@ -33,7 +34,7 @@ class Neo4jSinkConnectorConfigTest {
         val config = Neo4jSinkConnectorConfig(originals)
 
         assertEquals(originals["${Neo4jSinkConnectorConfig.TOPIC_CYPHER_PREFIX}foo"], config.topicMap["foo"])
-        assertTrue { config.encryptionEnabled }
+        assertFalse { config.encryptionEnabled }
         assertEquals(originals[Neo4jSinkConnectorConfig.SERVER_URI], config.serverUri.toString())
         assertEquals(originals[Neo4jSinkConnectorConfig.BATCH_SIZE], config.batchSize)
         assertEquals(Config.TrustStrategy.Strategy.TRUST_ALL_CERTIFICATES, config.encryptionTrustStrategy)