Bug 1942908

Summary:	Include prerequisites section when using clusterlogforwarder for syslog
Product:	OpenShift Container Platform	Reporter:	Jatan Malde <jmalde>
Component:	Documentation	Assignee:	Rolfe Dlugy-Hegwer <rdlugyhe>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Anping Li <anli>
Severity:	high	Docs Contact:	Petr Kovar <pkovar>
Priority:	unspecified
Version:	4.7	CC:	aos-bugs, eminguez, jokerman, pmutha, rdlugyhe, vigoyal, vkumar
Target Milestone:	---
Target Release:	---
Hardware:	All
OS:	All
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2021-09-23 11:16:41 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Jatan Malde 2021-03-25 10:18:17 UTC

Document URL: 

https://docs.openshift.com/container-platform/4.7/logging/cluster-logging-external.html#cluster-logging-collector-log-forward-syslog_cluster-logging-external

Section Number and Name: 

Forwarding logs using the syslog protocol

Describe the issue: 

The above link mentions the following line "You are responsible for configuring the external log aggregator to receive the logs from OpenShift Container Platform." but does not mentions boldly that a syslog server is required in there. 

Suggestions for improvement: 

Include a Prerequisites tab on the above link to mention that before starting the configuration a syslog server is needed at the other end so that they do not see any data corruption.

Additional information:

Comment 2 Eduardo Minguez 2021-03-25 12:34:46 UTC

There is already a slightly outdated KCS https://access.redhat.com/articles/3549872 (it doesn't explain the steps to perform in a RHEL8 host) so maybe it is just a matter of update the KCS to reflect the RHEL8 steps and have a link in the OpenShift docs pointing to that KCS...

Comment 3 Rolfe Dlugy-Hegwer 2021-03-26 18:07:57 UTC

Jatan, Eduardo,

Thanks for contributing this enhancement request. 
I have created https://issues.redhat.com/browse/RHDEVDOCS-2882 to track it.

Rolfe

Comment 4 Rolfe Dlugy-Hegwer 2021-09-23 11:16:41 UTC

Closed with https://issues.redhat.com/browse/RHDEVDOCS-2882
See https://docs.openshift.com/container-platform/4.8/logging/cluster-logging-external.html#cluster-logging-collector-log-forward-syslog_cluster-logging-external