Bug 1942908 - Include prerequisites section when using clusterlogforwarder for syslog
Summary: Include prerequisites section when using clusterlogforwarder for syslog
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.7
Hardware: All
OS: All
unspecified
high
Target Milestone: ---
: ---
Assignee: Rolfe Dlugy-Hegwer
QA Contact: Anping Li
Petr Kovar
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-03-25 10:18 UTC by Jatan Malde
Modified: 2024-06-14 01:00 UTC (History)
7 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-09-23 11:16:41 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Issue Tracker RHDEVDOCS-2882 0 Low Open Tracker for Bug 1942908 - Include prerequisites section when using clusterlogforwarder for syslog 2021-04-12 12:57:35 UTC

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
Note You need to log in before you can comment on or make changes to this bug.