Skip to content

[WIP]:DOCTEAM-2062- kdump#628

Open
Amrita42 wants to merge 24 commits into
mainfrom
DOCTEAM-2062
Open

[WIP]:DOCTEAM-2062- kdump#628
Amrita42 wants to merge 24 commits into
mainfrom
DOCTEAM-2062

Conversation

@Amrita42
Copy link
Copy Markdown
Contributor

PR creator: Description

Describe the overall goals of this pull request.

PR creator: Are there any relevant issues/feature requests?

  • bsc#...
  • jsc#...

PR reviewer: Checklist for editorial review

Apart from the usual checks, please double-check also the following:

@Amrita42 Amrita42 self-assigned this Jan 12, 2026
@Amrita42 Amrita42 changed the title [WIP]DOCTEAM-2062: adds toc structure for kdump [WIP]DOCTEAM-2062: kdump Jan 20, 2026
@Amrita42 Amrita42 changed the title [WIP]DOCTEAM-2062: kdump [WIP]:DOCTEAM-2062- kdump Jan 22, 2026
@Amrita42
Copy link
Copy Markdown
Contributor Author

Amrita42 commented Feb 2, 2026

SLES-kdump_en.pdf

@Amrita42
Copy link
Copy Markdown
Contributor Author

Amrita42 commented May 15, 2026

SLES-kdump_en.pdf latest

@Amrita42
Copy link
Copy Markdown
Contributor Author

SLES-kdump_en.pdf
27th May

@Amrita42 Amrita42 requested a review from lvicoun May 27, 2026 09:12
Copy link
Copy Markdown
Contributor

@lvicoun lvicoun left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi Amrita,
please see my suggestion. Thanks!

Comment thread tasks/configure-kdump.xml
<step><para>Enable and immediately start the &kdump; service:</para>
<screen>&prompt.sudo; systemctl enable --now kdump </screen>
<para>When the systemctl command triggers the main <literal>kdump.service</literal>, it automatically calls a helper service named <literal>kdump-commandline.service</literal> before attempting to load the kernel.
This helper service verifies if the current kernel command line contains the expected <literal>crashkernel= options</literal>. If they are missing, automatically updates the boot loader configuration to apply the settings on the next boot sequence.</para>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This helper service verifies if the current kernel command line contains the expected <literal>crashkernel= options</literal>. If they are missing, automatically updates the boot loader configuration to apply the settings on the next boot sequence.</para>
This helper service verifies if the current kernel command line contains the expected <literal>crashkernel= options</literal>. If the options are missing, the helper service automatically modifies the boot loader configuration to contain the crashkernel options to be applied on the next boot.</para>

Comment thread concepts/about-kdump.xml
<listitem><para><emphasis role="bold">VMCOREINFO:</emphasis>special section that tells analysis tools how the kernel's memory was laid out so they can make sense of the raw data.</para></listitem>
</itemizedlist>
</section>
<section xml:id="kexec-kdump">
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd move it before the vmcore file section. The vmcore is though very briefly described in the beginning, but the vmcore section mentions kexec that is not defined anywhere before you use it.

Comment thread tasks/configure-kdump.xml
<para>Any modifications made to this configuration file require a manual restart of the &kdump; service to take effect. However, if any changes are made specifically to the <literal>KDUMP_CRASHKERNEL</literal> memory allocation size, a full system reboot is required because these settings alter the system's core boot parameters.</para>
</section>
<section xml:id="kdump-transact">
<title>Configuring &kdump; for transactional systems </title>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<title>Configuring &kdump; for transactional systems </title>
<title>Configuring &kdump; on immutable systems </title>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is officially called immutable system. And the immutable flavor is not available for SLES 4 SAP, so this needs to be profiled for SLES only.

Comment thread tasks/configure-kdump.xml
</section>
<section xml:id="kdump-transact">
<title>Configuring &kdump; for transactional systems </title>
<para>On a transactional (read-only) file system, the standard <literal>kdump-commandline.service</literal> is unable to directly modify the boot loader configuration.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<para>On a transactional (read-only) file system, the standard <literal>kdump-commandline.service</literal> is unable to directly modify the boot loader configuration.
<para>On an immutable file system, the standard <literal>kdump-commandline.service</literal> is unable to directly modify the boot loader configuration.

Comment thread tasks/configure-kdump.xml
To specify custom memory sizes directly on a transactional system, you can append the crashkernel parameter to the command by running:</para>
<screen>&prompt.sudo; transactional-update setup-kdump [--crashkernel=low,high]</screen>
<para><emphasis role="bold">Other configurations:</emphasis></para>
<para>Just as with non-transactional systems, modifying the <filename>/etc/sysconfig/kdump </filename> configuration file on a transactional system requires the &kdump; service to be manually restarted for the changes to take effect.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You actually need to reboot the system after you run the tr-up command to boot into the newly created snapshot, unlike in regular SLES. So you need to run the tr-up command and reboot, then there is no need to manually restart the service.

Comment thread tasks/configure-kdump.xml
<listitem><para> Install the <package>openssh-clients</package> package to store over SSH.</para></listitem>
</itemizedlist>
</listitem>
<listitem><para>The <literal>mailx</literal> utility to enable sending notifications when a crash dump is saved. </para></listitem>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<listitem><para>The <literal>mailx</literal> utility to enable sending notifications when a crash dump is saved. </para></listitem>
<para>To enable sending notifications when a crash dump is saved, install the <literal>mailx</literal> package. </para>

Comment thread tasks/configure-kdump.xml
</itemizedlist>
</listitem>
<listitem><para>The <literal>mailx</literal> utility to enable sending notifications when a crash dump is saved. </para></listitem>
</itemizedlist>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
</itemizedlist>

Ensure no critical workloads are running and no unsaved data is present on the system. Additionally, ensure to
sync and unmount file systems:</para>
<screen>echo s &gt; /proc/sysrq-trigger</screen>
<screen>echo u &gt; /proc/sysrq-trigger </screen>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What each command does? An introduction text for each one is really appreciated.

<screen>echo u &gt; /proc/sysrq-trigger </screen>
<para>Then you can simulate a kernel crash:</para>
<screen>echo c &gt; /proc/sysrq-trigger</screen>
<para>Verify by checking if there is a new directory created under your <literal>KDUMP_SAVEDIR</literal> which is <filename>/var/crash</filename> by default. This contains the dmesg and
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<para>Verify by checking if there is a new directory created under your <literal>KDUMP_SAVEDIR</literal> which is <filename>/var/crash</filename> by default. This contains the dmesg and
<para>Check if there is a new directory created under your <literal>KDUMP_SAVEDIR</literal> which is <filename>/var/crash</filename> by default. This contains the dmesg and

<para>During &kdump;, if you see error messages mentioning low memory and invoking the
Out of Memory (OOM) killer, this is the likely cause. In case, you don't see such messages, trying with increased crash kernel reservation is a good
first step.</para>
<para>The recommended ways to rectify this are:</para>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think here it should be steps not ways and then use a procedure not an orderedlist.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants