Additional details on file system sizing for core dump settings

[Ron Stone]

(master/r8)

The Prerequisites section of the section "Change the Default Coredump Configuration" states that the log filesystem should be resized to ensure adequate storage. However, this recommendation should be expanded to provide additional details and a concrete example so the user knows what is expected.

The following additional information is recommended. Not sure it makes sense to be in Prerequisites section, so will leave that to the author to rework section as required.

The “log” (/var/log) filesystem size is defaulted for standard platform operation. If there is an expected usage increase due to the application core dump files, it should be increased proportionally to the core dump size and the expected number of core dumps that need to be retained. The core dump storage limits can be explicitly configured using the system max_use parameter settings that aligns to the core dump storage and retention requirements.

Example:

Filesystem Setting

8G (default) + 10G (core dump size x retention count – 5G x 2) = 18G

Core Dump Setting

max_use = 10G (core dump size x retention count – 5G x 2)

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.opendev.org/c/starlingx/docs/+/908296

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/starlingx/docs/+/908296
Committed: https://opendev.org/starlingx/docs/commit/2f0404ddc842f49691b0781974fac95582f3c76a
Submitter: "Zuul (22348)"
Branch: master

commit 2f0404ddc842f49691b0781974fac95582f3c76a
Author: Ron Stone <email address hidden>
Date: Wed Feb 7 11:48:34 2024 +0000

    Additional details on file system sizing for core dump settings (r8, dsR8)

    Add details and example to log fs prereqs

    Closes-bug: 2052620

    Change-Id: I2881fd4f5a85deab5b3382cdddbe98aaa265531e
    Signed-off-by: Ron Stone <email address hidden>

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: r/stx.8.0
Review: https://review.opendev.org/c/starlingx/docs/+/910319

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.opendev.org/c/starlingx/docs/+/910319
Committed: https://opendev.org/starlingx/docs/commit/b0ae9fc7ca6632271b7feaafef80dc4447e4a968
Submitter: "Zuul (22348)"
Branch: r/stx.8.0

commit b0ae9fc7ca6632271b7feaafef80dc4447e4a968
Author: Ron Stone <email address hidden>
Date: Wed Feb 7 11:48:34 2024 +0000

    Additional details on file system sizing for core dump settings (r8, dsR8)

    Add details and example to log fs prereqs

    Closes-bug: 2052620

    Change-Id: I2881fd4f5a85deab5b3382cdddbe98aaa265531e
    Signed-off-by: Ron Stone <email address hidden>
    (cherry picked from commit 2f0404ddc842f49691b0781974fac95582f3c76a)