From b1229d5968013134bb660425c812480bdb07f262 Mon Sep 17 00:00:00 2001 From: rolfedh Date: Wed, 24 Feb 2021 08:21:55 -0500 Subject: [PATCH] RHDEVDOCS-2614 Define ClusterLogForwarder compatability Matrix --- logging/cluster-logging-external.adoc | 16 ++++----- ...ctor-log-forwarding-supported-plugins.adoc | 34 +++++++++++++++++++ 2 files changed, 42 insertions(+), 8 deletions(-) create mode 100644 modules/cluster-logging-collector-log-forwarding-supported-plugins.adoc diff --git a/logging/cluster-logging-external.adoc b/logging/cluster-logging-external.adoc index bb3ae6214db2..a1c7298e47e3 100644 --- a/logging/cluster-logging-external.adoc +++ b/logging/cluster-logging-external.adoc @@ -29,11 +29,11 @@ You cannot use the config map methods and the Log Forwarding API in the same clu // assemblies. include::modules/cluster-logging-collector-log-forwarding-about.adoc[leveloffset=+1] -include::modules/cluster-logging-collector-log-forward-es.adoc[leveloffset=+2] -include::modules/cluster-logging-collector-log-forward-fluentd.adoc[leveloffset=+2] -include::modules/cluster-logging-collector-log-forward-syslog.adoc[leveloffset=+2] -include::modules/cluster-logging-collector-log-forward-kafka.adoc[leveloffset=+2] -include::modules/cluster-logging-collector-log-forward-project.adoc[leveloffset=+2] -include::modules/cluster-logging-collector-legacy-fluentd.adoc[leveloffset=+2] -include::modules/cluster-logging-collector-legacy-syslog.adoc[leveloffset=+2] -// modules/cluster-logging-collector-log-forward-update.adoc[leveloffset=+2] +include::modules/cluster-logging-collector-log-forwarding-supported-plugins.adoc[leveloffset=+1] +include::modules/cluster-logging-collector-log-forward-es.adoc[leveloffset=+1] +include::modules/cluster-logging-collector-log-forward-fluentd.adoc[leveloffset=+1] +include::modules/cluster-logging-collector-log-forward-syslog.adoc[leveloffset=+1] +include::modules/cluster-logging-collector-log-forward-kafka.adoc[leveloffset=+1] +include::modules/cluster-logging-collector-log-forward-project.adoc[leveloffset=+1] +include::modules/cluster-logging-collector-legacy-fluentd.adoc[leveloffset=+1] +include::modules/cluster-logging-collector-legacy-syslog.adoc[leveloffset=+1] diff --git a/modules/cluster-logging-collector-log-forwarding-supported-plugins.adoc b/modules/cluster-logging-collector-log-forwarding-supported-plugins.adoc new file mode 100644 index 000000000000..d1b5fabd6dd1 --- /dev/null +++ b/modules/cluster-logging-collector-log-forwarding-supported-plugins.adoc @@ -0,0 +1,34 @@ +// Module included in the following assemblies: +// +// logging/cluster-logging-external.adoc + +[id="cluster-logging-collector-log-forwarding-supported-plugins_{context}"] + += Supported log data output types + +[role="_abstract"] +Red Hat OpenShift Logging version 5.0 provides the following output types and protocols for sending log data to target log collectors. + +Red Hat tests each of the combinations shown in the following table. However, you should be able to send log data to a wider range target log collectors that ingest these protocols. + +[options="header"] +|==== +| Output types | Protocols | Tested with + +| fluentdForward | fluent forward v1 | fluentd 1.7.4 + +| elasticsearch | elasticsearch v? | Elasticsearch 6.8.1 + +| syslog | RFC-3164, RFC-5424 | rsyslog 8.37.0-9.el7 + +| kafka | kafka 0.11 | kafka 2.4.1 + +|==== + +// Note to tech writer, validate these items against the corresponding line of the test configuration file that Red Hat OpenShift Logging version 5.0 uses: https://github.com/openshift/origin-aggregated-logging/blob/release-5.0/fluentd/Gemfile.lock. This file is the authoritative source of information about which items and versions Red Hat tests and supports. +// According to this link:https://github.com/zendesk/ruby-kafka#compatibility[Zendesk compatibility list for ruby-kafka], the fluent-plugin-kafka plug-in supports Kafka version 0.11. + +[NOTE] +==== +Previously, the syslog output supported only RFC-3164. The current syslog output adds support for RFC-5424. +====