[camel-kafka-connector] branch main updated: Fixed missing syslog documentation.

[ac...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

acosentino pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/camel-kafka-connector.git


The following commit(s) were added to refs/heads/main by this push:
     new 9c6826e  Fixed missing syslog documentation.
9c6826e is described below

commit 9c6826e7aad0119fb4c01925cf4bfc72e39114d7
Author: Andrea Tarocchi <an...@gmail.com>
AuthorDate: Thu Nov 11 12:36:45 2021 +0100

    Fixed missing syslog documentation.
---
 .../camel-syslog-kafka-sink-connector.adoc         | 27 ++++++++++++++++++++++
 .../camel-syslog-kafka-source-connector.adoc       | 27 ++++++++++++++++++++++
 2 files changed, 54 insertions(+)

diff --git a/docs/modules/ROOT/pages/reference/connectors/camel-syslog-kafka-sink-connector.adoc b/docs/modules/ROOT/pages/reference/connectors/camel-syslog-kafka-sink-connector.adoc
new file mode 100644
index 0000000..53a23e0
--- /dev/null
+++ b/docs/modules/ROOT/pages/reference/connectors/camel-syslog-kafka-sink-connector.adoc
@@ -0,0 +1,27 @@
+// kafka-connector options: START
+[[camel-syslog-kafka-connector-sink]]
+= camel-syslog-kafka-connector sink configuration
+
+When using camel-syslog-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:
+
+[source,xml]
+----
+<dependency>
+  <groupId>org.apache.camel.kafkaconnector</groupId>
+  <artifactId>camel-syslog-kafka-connector</artifactId>
+  <version>x.x.x</version>
+  <!-- use the same version as your Camel Kafka connector version -->
+</dependency>
+----
+
+
+The camel-syslog sink connector supports is based on camel-netty sink connector and supports all its options (see: xref:reference/connectors/camel-netty-kafka-sink-connector.adoc[Netty Sink Docs]);
+however has been already preconfigured and should be sufficient to provide the following properties:
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Priority
+| *camel.sink.path.protocol* | The protocol to use which can be tcp or udp. One of: [tcp] [udp] | null | HIGH
+| *camel.sink.path.host* | The hostname. For the consumer the hostname is localhost or 0.0.0.0. For the producer the hostname is the remote host to connect to | null | HIGH
+| *camel.sink.path.port* | The host port number | null | HIGH
+|===
+// kafka-connector options: END
diff --git a/docs/modules/ROOT/pages/reference/connectors/camel-syslog-kafka-source-connector.adoc b/docs/modules/ROOT/pages/reference/connectors/camel-syslog-kafka-source-connector.adoc
new file mode 100644
index 0000000..b55a916
--- /dev/null
+++ b/docs/modules/ROOT/pages/reference/connectors/camel-syslog-kafka-source-connector.adoc
@@ -0,0 +1,27 @@
+// kafka-connector options: START
+[[camel-syslog-kafka-connector-source]]
+= camel-syslog-kafka-connector source configuration
+
+When using camel-syslog-kafka-connector as source make sure to use the following Maven dependency to have support for the connector:
+
+[source,xml]
+----
+<dependency>
+  <groupId>org.apache.camel.kafkaconnector</groupId>
+  <artifactId>camel-syslog-kafka-connector</artifactId>
+  <version>x.x.x</version>
+  <!-- use the same version as your Camel Kafka connector version -->
+</dependency>
+----
+
+
+The camel-syslog source connector supports is based on camel-netty source connector and supports all its options (see: xref:reference/connectors/camel-netty-kafka-source-connector.adoc[Netty Source Docs]);
+however has been already preconfigured and should be sufficient to provide the following properties:
+[width="100%",cols="2,5,^1,2",options="header"]
+|===
+| Name | Description | Default | Priority
+| *camel.source.path.protocol* | The protocol to use which can be tcp or udp. One of: [tcp] [udp] | null | HIGH
+| *camel.source.path.host* | The hostname. For the consumer the hostname is localhost or 0.0.0.0. For the producer the hostname is the remote host to connect to | null | HIGH
+| *camel.source.path.port* | The host port number | null | HIGH
+|===
+// kafka-connector options: END