Bug 1886121

Summary: [Doc] Wrong example configuration for journald.conf in cluster logging
Product: OpenShift Container Platform Reporter: oarribas <oarribas>
Component: DocumentationAssignee: Vikram Goyal <vigoyal>
Status: CLOSED CURRENTRELEASE QA Contact: Xiaoli Tian <xtian>
Severity: unspecified Docs Contact: Vikram Goyal <vigoyal>
Priority: unspecified    
Version: 4.3.zCC: aos-bugs, jokerman, vigoyal, xtian
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: 1886113 Environment:
Last Closed: 2020-10-26 08:16:31 UTC Type: ---
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: 1886113    
Bug Blocks: 1886117, 1886118    

Description oarribas 2020-10-07 17:01:03 UTC 
+++ This bug was initially created as a clone of Bug #1886113 +++

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
~~~