From acfc6ca32ab3a385d0c6c5c5da32b671d13cfe5e Mon Sep 17 00:00:00 2001 From: Ron Stone Date: Wed, 15 Jun 2022 09:36:45 -0400 Subject: [PATCH] Configurable coredump size parameters and storage Add section on configuring core dumps. Update sections on resizing file systems to cover log FS. Address patchset 1 review comments. Signed-off-by: Ron Stone Change-Id: If79f6f08dd50a07a42b70ca7ad1297296eabe50d --- .../resizing-filesystems-on-a-host.rst | 3 + ...e-planning-storage-on-controller-hosts.rst | 4 +- ...lt-coredump-configuration-51ff4ce0c9ae.rst | 122 ++++++++++++++++++ .../index-sysconf-kub-78f0e1e9ca5a.rst | 10 ++ 4 files changed, 137 insertions(+), 2 deletions(-) create mode 100644 doc/source/system_configuration/kubernetes/change-the-default-coredump-configuration-51ff4ce0c9ae.rst diff --git a/doc/source/node_management/kubernetes/resizing-filesystems-on-a-host.rst b/doc/source/node_management/kubernetes/resizing-filesystems-on-a-host.rst index 3d8063956..06f5d82c2 100644 --- a/doc/source/node_management/kubernetes/resizing-filesystems-on-a-host.rst +++ b/doc/source/node_management/kubernetes/resizing-filesystems-on-a-host.rst @@ -25,6 +25,8 @@ The following combinations of filesystem and host types are supported. +-------------+----------------+------------------+----------------+--------------+ | **kubelet** | All node types | /var/lib/kubelet | kubelet-lv | 10 GiB | +-------------+----------------+------------------+----------------+--------------+ + | **log** | All node types | /var/log | log-lv | 7.5 GiB | + +-------------+----------------+------------------+----------------+--------------+ | **scratch** | All node types | /scratch | scratch-lv | variable | +-------------+----------------+------------------+----------------+--------------+ @@ -44,6 +46,7 @@ sizes on a controller. | a4d83571-a555-4ba5-999f-af709206ae35 | backup | 25 | backup-lv | | d57652a1-af17-47b8-b941-9ebfeee4a56f | docker | 30 | docker-lv | | a84374c6-8917-4db5-bd34-2a8d244f2bf6 | kubelet | 10 | kubelet-lv | + | f0c5a8a9-57c7-4072-932d-8f7aac519f8c | log | 8 | log-lv | | 2c026d6f-5c03-4135-abca-c0047aa7f5a6 | scratch | 8 | scratch-lv | +--------------------------------------+---------+-------------+----------------+ diff --git a/doc/source/planning/kubernetes/storage-planning-storage-on-controller-hosts.rst b/doc/source/planning/kubernetes/storage-planning-storage-on-controller-hosts.rst index 1ab2e41b7..04fd60261 100755 --- a/doc/source/planning/kubernetes/storage-planning-storage-on-controller-hosts.rst +++ b/doc/source/planning/kubernetes/storage-planning-storage-on-controller-hosts.rst @@ -103,8 +103,8 @@ Host Filesystems ---------------- The following host filesystem commands can be used to resize non-|DRBD| -filesystems \(Backup, Docker, Kubelet and Scratch\) and do not apply to all -hosts of a give personality type: +filesystems \(Backup, Docker, Kubelet, Scratch, and Log\) and do not +apply to all hosts of a given personality type: :command:`host-fs-list`, :command:`host-fs-modify`, and :command:`host-fs-show` diff --git a/doc/source/system_configuration/kubernetes/change-the-default-coredump-configuration-51ff4ce0c9ae.rst b/doc/source/system_configuration/kubernetes/change-the-default-coredump-configuration-51ff4ce0c9ae.rst new file mode 100644 index 000000000..962561796 --- /dev/null +++ b/doc/source/system_configuration/kubernetes/change-the-default-coredump-configuration-51ff4ce0c9ae.rst @@ -0,0 +1,122 @@ +.. _change-the-default-coredump-configuration-51ff4ce0c9ae: + +========================================= +Change the Default Coredump Configuration +========================================= + +You can change the default core dump configuration used to create *core* +files. These are images of the system's working memory used to debug crashes or +abnormal exits. + +.. rubric:: |context| + +The editable parameters and their defaults are as follows: + +``ProcessSizeMax`` + The maximum size of cores that will be processed. + + Default: 2G + + Minimum: 0 + +``ExternalSizeMax`` + The maximum size of cores to be saved. + + Default: 2G + + Minimum: 0 + +``MaxUse`` + Sets a maximum diskspace usage by cores. + + Default: *unset* + +``KeepFree`` + Sets the minimum amount of disk space to keep free when saving cores. + + Default: 1G + + Minimum: 1G + +Maximum values for each configurable coredump parameter depend on system capacity. + +The parameters accept integer/float values followed by a letter representing +the unit of measurement. + +* ``B`` = Bytes +* ``K`` = Kilobytes +* ``M`` = Megabytes +* ``G`` = Gigabytes +* ``T`` = Terabytes +* ``P`` = Petabytes +* ``E`` = Exabytes + +The value 0 (zero) is accepted by parameters ``ProcessSizeMax``, +``ExternalSizeMax`` and ``MaxUse``. + +.. Note:: + Other, non-configurable, parameters are: + + * ``Storage`` = external + * ``Compress`` = yes + * ``JournalSizeMax`` = 767M + + +For more information on these values, see +https://man7.org/linux/man-pages/man5/coredump.conf.5.html + + +.. rubric:: |prereq| + +Ensure that you have sufficient storage available on the host's ``log`` +filesystem. See :ref:`resizing-filesystems-on-a-host` for more information +about adjusting it's size. + + +.. rubric:: |eg| + +When you configure a parameter, it will be replicated to the ``coredump.conf`` file of all +existing nodes (controllers, workers, storages). + +* To add a coredump service parameter: + + .. code-block:: none + + ~(keystone_admin)]$ system service-parameter-add platform coredump = + +* To modify an existing coredump service parameter: + + .. code-block:: + + ~(keystone_admin)]$ system service-parameter-modify platform coredump = + +* To delete an existing coredump service parameter: + + .. code-block:: + + ~(keystone_admin)]$ system service-parameter-delete + + .. note:: + + When a parameter is deleted, its value will reset to the default. + + +Where can be one of: + +* ``process_size_max`` +* ``external_size_max`` +* ``max_use`` +* ``keep_free`` + +The following example sets ``ExternalSizeMax`` to 3 gigabytes. + +.. code-block:: none + + ~(keystone_admin)]$ system service-parameter-add platform coredump external_size_max=3G + +.. note:: + + Configuring a parameter raises the 250.001 *controller-0 Configuration + is out-of-date* adarm. A lock/unlock is required to clear it. For more + information, see :ref:`locking-a-host-using-the-cli` and + :ref:`unlocking-a-host-using-the-cli`. diff --git a/doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst b/doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst index d1abfa5e2..8034abdd0 100644 --- a/doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst +++ b/doc/source/system_configuration/kubernetes/index-sysconf-kub-78f0e1e9ca5a.rst @@ -168,3 +168,13 @@ Apply Registries' Auth-Secret Changes verify-the-registry-secret-changes-and-secret-key-in-system-database add-the-ca-certificate-for-new-registry check-new-registry-and-reapply-application + +-------------------- +Customize Core Dumps +-------------------- + +.. toctree:: + :maxdepth: 1 + + + change-the-default-coredump-configuration-51ff4ce0c9ae