Merge pull request #69 from bojand/master

add syslog output docs

Author: Benjamin Huo

README.md

@@ -143,6 +143,7 @@ The listing below shows supported plugins currently. It is based on Fluent Bit v
     - [stdout](docs/plugins/output/stdout.md)
     - [tcp](docs/plugins/output/tcp.md)
     - [loki](docs/plugins/output/loki.md)
+    - [syslog](docs/plugins/output/syslog.md)
 
 ## Best Practice
 

docs/crd.md

@@ -189,6 +189,7 @@ InputSpec defines the desired state of Input
 
 | Field | Description | Scheme |
 | ----- | ----------- | ------ |
+| alias | A user friendly alias name for this input plugin. | string |
 | dummy | Dummy defines Dummy Input configuration. | *[input.Dummy](plugins/input/dummy.md) |
 | tail | Tail defines Tail Input configuration. | *[input.Tail](plugins/input/tail.md) |
 | systemd | Systemd defines Systemd Input configuration. | *[input.Systemd](plugins/input/systemd.md) |
@@ -234,6 +235,7 @@ OutputSpec defines the desired state of Output
 | stdout | Stdout defines Stdout Output configuration. | *[output.Stdout](plugins/output/stdout.md) |
 | tcp | TCP defines TCP Output configuration. | *[output.TCP](plugins/output/tcp.md) |
 | loki | Loki defines Loki Output configuration. | *[output.Loki](plugins/output/loki.md) |
+| syslog | Syslog defines Syslog Output configuration. | *[output.Syslog](plugins/output/syslog.md) |
 
 [Back to TOC](#table-of-contents)
 ## Parser

docs/plugins/output/syslog.md

@@ -0,0 +1,21 @@
+# Syslog
+
+The Syslog output plugin allows you to deliver messages to Syslog servers, it supports RFC3164 and RFC5424 formats through different transports such as UDP, TCP or TLS.
+
+
+| Field | Description | Scheme |
+| ----- | ----------- | ------ |
+| host |  Host domain or IP address of the remote Syslog server. | string |
+| port | TCP or UDP port of the remote Syslog server. | *int32 |
+| mode | The desired transport type. | string |
+| syslogFormat | The desired Syslog protocol format to use. | string |
+| syslogMaxSize | Maximum size allowed per message. | *int32 |
+| syslogSeverityKey | Name of the key from the original record that contains the Syslog severity number. | string |
+| syslogFacilityKey | Key from the original record that contains the Syslog facility number. | string |
+| syslogHostnameKey | Key name from the original record that contains the hostname that generated the message. | string |
+| syslogAppnameKey | Key name from the original record that contains the Process ID that generated the message. | string |
+| syslogProcessIDKey | Key name from the original record that contains the Message ID associated to the message. | string |
+| syslogMessageIDKey | Key name from the original record that contains the Message ID associated to the message. | string |
+| syslogSDKey | Key name from the original record that contains the Structured Data (SD) content. | string |
+| syslogMessageKey | Key key name that contains the message to deliver. | string |
+| tls | HTTP output plugin supports TTL/SSL, for more details about the properties available and general configuration, please refer to the TLS/SSL section. | *[plugins.TLS](../tls.md) |