Bug 1886121 - [Doc] Wrong example configuration for journald.conf in cluster logging
Summary: [Doc] Wrong example configuration for journald.conf in cluster logging
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: OpenShift Container Platform
Classification: Red Hat
Component: Documentation
Version: 4.3.z
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ---
: ---
Assignee: Vikram Goyal
QA Contact: Xiaoli Tian
Vikram Goyal
URL:
Whiteboard:
Depends On: 1886113
Blocks: 1886117 1886118
TreeView+ depends on / blocked
 
Reported: 2020-10-07 17:01 UTC by oarribas
Modified: 2020-10-26 08:16 UTC (History)
4 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of: 1886113
Environment:
Last Closed: 2020-10-26 08:16:31 UTC
Target Upstream Version:


Attachments (Terms of Use)

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


Note You need to log in before you can comment on or make changes to this bug.