Added Kafka Connect configuration summary (#324)

Author: mroiter-larus

doc/asciidoc/kafka-connect/index.adoc

@@ -253,6 +253,7 @@ Following an example:
 }
 ----
 
+[[kafka_connect_error_handling]]
 === How deal with bad data
 
 In Kafka Connect plugin, in the creation phase of the Sink instance, in addition to the properties
@@ -289,4 +290,70 @@ Below you see the data that has been ingested into Neo4j. During my testing I go
 
 image::../../images/confluent-imported-data.png[title="Confluent Platform Management", align="center"]
 
-include::config-override-policy/index.adoc[]
+include::config-override-policy/index.adoc[]
+
+=== Configuration Summary
+
+Following a summary of all the configuration parameters you can use for the Kafka Connect plugin:
+
+.Kafka Connect configuration parameters
+[%autowidth,cols="m,m,m,a", opts=header]
+|===
+| Name
+| Value
+| Mandatory
+| Note
+
+| database | <DATABASE_NAME> | false | Specify a database name only if you want to use a non-default database. Default value is 'neo4j'
+| topics | <topicA,topicB> | true | A list of comma-separated topics
+| connector.class | streams.kafka.connect.sink.Neo4jSinkConnector | true |
+| key.converter | org.apache.kafka.connect.storage.StringConverter | false | Converter class for key Connect data
+| value.converter | org.apache.kafka.connect.json.JsonConverter | false | Converter class for value Connect data
+| key.converter.schemas.enable | true/false | false | If true the key will be treated as a composite JSON object containing schema and the data. Default value is false
+| value.converter.schemas.enable | true/false | false | If true the value will be treated as a composite JSON object containing schema and the data. Default value is false
+| key.converter.schema.registry.url | http://localhost:8081 | false | The Schema Registry URL has to be provide only when you decide to use AvroConverter
+| value.converter.schema.registry.url | http://localhost:8081 | false | The Schema Registry URL has to be provide only when you decide to use AvroConverter
+| kafka.bootstrap.servers | <localhost:9092> | false | The Broker URI is mandatory only when if you have configured DLQ
+| kafka.<any_other_kafka_property | | false |
+| errors.tolerance | all/none | false | all == lenient, silently ignore bad messages. none (default) means that any error will result in a connector failure
+| errors.log.enable | false/true | false | log errors (default: false)
+| errors.log.include.messages | false/true | false | log bad messages too (default: false)
+| errors.deadletterqueue.topic.name | topic-name | false | dead letter queue topic name, if left off no DLQ, default: not set
+| errors.deadletterqueue.context.headers.enable | false/true | false | enrich messages with metadata headers like exception, timestamp, org. topic, org.part, default:false
+| errors.deadletterqueue.context.headers.prefix | prefix-text | false | common prefix for header entries, e.g. `"__streams.errors."` , default: not set
+| errors.deadletterqueue.topic.replication.factor | 3/1 | false | replication factor, need to set to 1 for single partition, default:3
+| neo4j.server.uri | "bolt://neo4j:7687" | true | Neo4j Server URI
+| neo4j.authentication.basic.username | your_neo4j_user | true | Neo4j username
+| neo4j.authentication.basic.password | your_neo4j_password | true | Neo4j password
+| neo4j.encryption.enabled | true/false | false |
+| neo4j.topic.cdc.sourceId | <list of topics separated by semicolon> | false |
+| neo4j.topic.cdc.sourceId.labelName | <the label attached to the node> | false | default value is *SourceEvent*
+| neo4j.topic.cdc.sourceId.idName | <the id name given to the CDC id field> | false | default value is *sourceId*
+| neo4j.topic.cdc.schema | <list of topics separated by semicolon> | false |
+| neo4j.topic.pattern.node.<TOPIC_NAME> | <node extraction pattern> | false |
+| neo4j.topic.pattern.relationship.<TOPIC_NAME> | <relationship extraction pattern> | false |
+| neo4j.topic.cud | <list of topics separated by semicolon> | false |
+|===
+
+[NOTE]
+====
+If you need to manage data in JSON format without using the Schema Registry, then you can use the
+`org.apache.kafka.connect.json.JsonConverter` and disabling both `key.converter.schemas.enable` and
+`value.converter.schemas.enable`.
+
+Other supported converters are:
+
+* *org.apache.kafka.connect.storage.StringConverter*
+* *org.apache.kafka.connect.converters.ByteArrayConverter*
+* *io.confluent.connect.avro.AvroConverter*
+
+Please see the following for further details: https://docs.confluent.io/current/connect/userguide.html#configuring-key-and-value-converters
+
+For further information about Kafka Connect properties, please checkout the following:
+
+* https://docs.confluent.io/current/installation/configuration/connect/sink-connect-configs.html#kconnect-sink-configurations
+* https://docs.confluent.io/current/installation/configuration/connect/source-connect-configs.html#kconnect-source-configurations
+
+For further details about error handling properties refers to <<kafka_connect_error_handling, How deal with bad data>> section
+
+====