Bug 1856703

Summary:	Include the syslog output in the Log Forwarding documentation
Product:	OpenShift Container Platform	Reporter:	Oscar Casal Sanchez <ocasalsa>
Component:	Documentation	Assignee:	Rolfe Dlugy-Hegwer <rdlugyhe>
Status:	CLOSED WONTFIX	QA Contact:	Xiaoli Tian <xtian>
Severity:	unspecified	Docs Contact:	Vikram Goyal <vigoyal>
Priority:	unspecified
Version:	4.5	CC:	aos-bugs, cvogel, jokerman, oarribas, rdlugyhe
Target Milestone:	---
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2021-03-17 23:03:00 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 Oscar Casal Sanchez 2020-07-14 09:11:10 UTC

[Document URL]
https://docs.openshift.com/container-platform/4.5/logging/cluster-logging-external.html#cluster-logging-collector-log-forward-about_cluster-logging-external

[Section Number and Name]
Understanding the Log Forwarding API

[Describe the issue]
In OCP 4.5 is included the syslog output, for more information here [1], but it's not included in the documentation. 

[Suggestions for improvement]
- Include the syslog output as endpoint in the documentation
- At least one example about how to configure it with the different options



[1] https://github.com/openshift/cluster-logging-operator/blob/release-4.5/manifests/4.5/logforwardings.crd.yaml

Comment 1 Christian Heidenreich 2020-08-13 08:10:04 UTC

Hi Oscar. We are currently working with the docs team to write the initial docs for the log forwarding API GA release. It will include much more information than today. Would you want to review the initial draft once it is ready to be reviewed to give further feedback?

Comment 2 Oscar Casal Sanchez 2020-08-13 09:06:42 UTC

Hello Christian,

I would be happy to do it. Let me know about it and I'll get time to review it and test.

Regards,
Oscar