Bug 1886113

Summary:	[Doc] Wrong example configuration for journald.conf in cluster logging
Product:	OpenShift Container Platform	Reporter:	oarribas <oarribas>
Component:	Documentation	Assignee:	Michael Burke <mburke>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Xiaoli Tian <xtian>
Severity:	unspecified	Docs Contact:	Vikram Goyal <vigoyal>
Priority:	unspecified
Version:	4.6	CC:	aos-bugs, jokerman, mburke
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:
Clones:	1886117 1886118 1886121 (view as bug list)		Environment:
Last Closed:	2020-11-23 21:21:21 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:
Bug Depends On:
Bug Blocks:	1886117, 1886118, 1886121

Description oarribas 2020-10-07 16:55:23 UTC

Document URL: 
https://docs.openshift.com/container-platform/4.6/logging/config/cluster-logging-systemd.html#cluster-logging-systemd-scaling_cluster-logging-systemd


Section Number and Name: 
Configuring systemd-journald for cluster logging
 - Procedure
   1. Create a journald.conf file with the required settings


Describe the issue: 
The `SystemMaxFileSize10M` in the `journald.conf` example is wrong. It could be `SystemMaxFileSize=10M`.

With the wrong configuration in journald.conf, any mc applied after it (including cluster upgrades) will fail as the MCO will not be able to check the configuration to apply.


Additional information: 

The example in that procedure has different configurations than default ones. Some customers copy configurations from documentation, that can cause issues in their clusters. The configuration in the example must be the default one to avoid issues.


Suggestions for improvement: 

Change the example to the default values for each setting:
~~~
Compress=yes
ForwardToConsole=no
ForwardToSyslog=no 
MaxRetentionSec=1month
RateLimitBurst=10000 
RateLimitInterval=1s 
Storage=persistent 
SyncIntervalSec=1s 
SystemMaxUse=8g 
SystemKeepFree=20% 
SystemMaxFileSize=10M
~~~

Comment 1 Michael Burke 2020-10-08 17:00:01 UTC

Oscar -- 

Please take a look.
https://github.com/openshift/openshift-docs/pull/26243

Michael

Comment 3 oarribas 2020-10-13 08:50:44 UTC

Michael, apologies for the late reply.

The `journald.conf` part looks good to me, but the ignition version for previous OCP versions needs to be changed. For OCP 4.5 and older it's 2.2.0 and not 3.1.0. I will add a comment to BZ 1886363.

Comment 4 Michael Burke 2020-11-23 21:21:21 UTC

Changes are live: https://docs.openshift.com/container-platform/4.6/logging/config/cluster-logging-systemd.html#cluster-logging-systemd-scaling_cluster-logging-systemd