Skip to content

[WIP]:DOCTEAM-2062- kdump#628

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

[WIP]:DOCTEAM-2062- kdump#628
Amrita42 wants to merge 30 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

Amrita42 commented Feb 2, 2026

Copy link
Copy Markdown
Contributor Author

SLES-kdump_en.pdf

@Amrita42

Amrita42 commented May 15, 2026

Copy link
Copy Markdown
Contributor Author

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

@lvicoun lvicoun left a comment

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.

Hi Amrita,
please see my suggestion. Thanks!

Comment thread tasks/configure-kdump.xml Outdated
Comment thread concepts/about-kdump.xml Outdated
Comment thread tasks/configure-kdump.xml Outdated
Comment thread tasks/configure-kdump.xml Outdated
Comment thread tasks/configure-kdump.xml Outdated
Comment thread tasks/configure-kdump.xml Outdated
Comment thread tasks/configure-kdump.xml Outdated
Comment thread tasks/troubleshoot-kdump.xml Outdated
Comment thread tasks/troubleshoot-kdump.xml Outdated
Comment thread tasks/troubleshoot-kdump.xml Outdated
@Amrita42

Copy link
Copy Markdown
Contributor Author

SLES-kdump_en.pdf

@lvicoun lvicoun left a comment

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.

Hi Amrita, please see my suggestions. Thanks!

Comment thread tasks/configure-kdump.xml Outdated
Comment thread tasks/configure-kdump.xml Outdated
Comment thread tasks/configure-kdump.xml Outdated
Comment thread concepts/about-kdump.xml Outdated
Comment thread tasks/configure-kdump.xml Outdated
Comment thread tasks/configure-kdump.xml Outdated
Comment thread tasks/configure-kdump.xml Outdated
Comment thread tasks/configure-kdump.xml Outdated
Comment thread tasks/troubleshoot-kdump.xml Outdated
Comment thread tasks/troubleshoot-kdump.xml Outdated
@Amrita42 Amrita42 requested a review from dariavladykina June 11, 2026 15:06
@Amrita42

Copy link
Copy Markdown
Contributor Author

@dariavladykina ptal thanks.

@dariavladykina dariavladykina left a comment

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.

Hi, please see some suggestions for this article. Thanks!

Comment thread articles/kdump.asm.xml
<term>WHAT?</term>
<listitem>
<para>
Configure &kdump; in case your system crashes. Its primary purpose is to capture a snapshot of the system's memory (a vmcore file) at the exact moment a kernel crashes (kernel panic).

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
Configure &kdump; in case your system crashes. Its primary purpose is to capture a snapshot of the system's memory (a vmcore file) at the exact moment a kernel crashes (kernel panic).
&kdump; is a Linux kernel crash dumping mechanism that captures
a snapshot of system memory (a vmcore file) when the Linux kernel
encounters a fatal error (kernel panic).

Comment thread articles/kdump.asm.xml
<term>WHY?</term>
<listitem>
<para>
Correctly setting up kdump and obtaining the memory dump may help SUSE support or kernel developers to debug a potential kernel crash.

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
Correctly setting up kdump and obtaining the memory dump may help SUSE support or kernel developers to debug a potential kernel crash.
Use Kdump to collect diagnostic data for kernel crash analysis and root-cause
investigation. Correctly setting up Kdump and obtaining the memory dump may
help SUSE support or kernel developers to debug a potential kernel crash.

Comment thread concepts/about-kdump.xml
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion">
<info>
<title>About &kdump;</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>About &kdump;</title>
<title>What is &kdump; and how does it work?</title>

Comment thread concepts/about-kdump.xml
<abstract>
<para>
&kdump; is a kernel crash dumping mechanism that captures the system’s memory state into a vmcore file when
system crash occurs. A vmcore file is a snapshot of your computer's system memory (RAM) taken at the exact moment the Linux kernel crashed.

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
system crash occurs. A vmcore file is a snapshot of your computer's system memory (RAM) taken at the exact moment the Linux kernel crashed.
a system crash occurs. A vmcore file is a snapshot of your computer's system memory (RAM) taken at the exact moment the Linux kernel crashed.

Comment thread concepts/about-kdump.xml
</abstract>
</info>
<section xml:id="important-kdump">
<title>Why is &kdump; important?</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>Why is &kdump; important?</title>
<title>Why is &kdump; critical for system crash debugging?</title>

more memory than estimated by <command>kdumptool calibrate</command> and set up automatically in
the boot loader config by the <literal>kdump-commandline.service</literal>.</para>
<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

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
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
Out of Memory (OOM) killer, this is the likely cause. If you don't see such messages, trying with increased crash kernel reservation is a good

Comment on lines +83 to +84
<literal>KDUMP_VERBOSE</literal> to 11 turns on debugging output during all stages of the &kdump;
process, it:</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
<literal>KDUMP_VERBOSE</literal> to 11 turns on debugging output during all stages of the &kdump;
process, it:</para>
<literal>KDUMP_VERBOSE</literal> to 11 turns on debugging output during all stages of the &kdump;
process and results in the following behavior:</para>

Comment on lines +94 to +98
<listitem><para> During the capture kernel boot, if you see problems with
<literal>makedumpfile</literal>, network config etc., set <literal>KDUMP_CONTINUE_ON_ERROR=false</literal>
or <literal>KDUMP_IMMEDIATE_REBOOT=false</literal>. This opens up an interactive shell when
an error occurs or when <literal>makedumpfile</literal> finishes,enabling you to manually debug problems
from within the capture system.

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> During the capture kernel boot, if you see problems with
<literal>makedumpfile</literal>, network config etc., set <literal>KDUMP_CONTINUE_ON_ERROR=false</literal>
or <literal>KDUMP_IMMEDIATE_REBOOT=false</literal>. This opens up an interactive shell when
an error occurs or when <literal>makedumpfile</literal> finishes,enabling you to manually debug problems
from within the capture system.
<listitem><para> During the capture kernel boot, if you see problems with
<literal>makedumpfile</literal>, network config, etc., set <literal>KDUMP_CONTINUE_ON_ERROR=false</literal>
or <literal>KDUMP_IMMEDIATE_REBOOT=false</literal>. This opens up an interactive shell when
an error occurs or when <literal>makedumpfile</literal> finishes, enabling you to manually debug problems
from within the capture system.

Comment on lines +110 to +111
<command>mkdumprd -fd</command>. You can also unpack and inspect the generated initramfs image with <command>lsinitrd --unpack /var/lib/kdump/initrd
</command> command. </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
<command>mkdumprd -fd</command>. You can also unpack and inspect the generated initramfs image with <command>lsinitrd --unpack /var/lib/kdump/initrd
</command> command. </para></listitem>
<command>mkdumprd -fd</command>. You can also unpack and inspect the generated initramfs image with <command>lsinitrd --unpack /var/lib/kdump/initrd
</command>. </para></listitem>

Comment thread articles/kdump.asm.xml
Comment on lines +75 to +80
<meta name="title" its:translate="yes">Introduction to kdump</meta>
<meta name="social-descr" its:translate="yes">Learn how to configure kdump in case your system crashes. kdump is a
kernel crash dumping mechanism. When a system encounters a fatal error, kdump allows the system to save the contents of its memory to a file for expert analysis.</meta>

<!-- Search -->
<meta name="description" its:translate="yes">Use kdump to capture data on system crashes </meta>

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
<meta name="title" its:translate="yes">Introduction to kdump</meta>
<meta name="social-descr" its:translate="yes">Learn how to configure kdump in case your system crashes. kdump is a
kernel crash dumping mechanism. When a system encounters a fatal error, kdump allows the system to save the contents of its memory to a file for expert analysis.</meta>
<!-- Search -->
<meta name="description" its:translate="yes">Use kdump to capture data on system crashes </meta>
<meta name="title" its:translate="yes">SUSE Linux Kdump Setup and Troubleshooting Guide</meta>
<meta name="social-descr" its:translate="yes">Configure and troubleshoot Kdump on SUSE Linux</meta>
<meta name="description" its:translate="yes">Learn how to install, configure and troubleshoot Kdump on standard and immutable SUSE Linux systems to capture memory snapshots during a kernel crash</meta>

@dariavladykina dariavladykina left a comment

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.

Hi, please see some suggestions for this article. Thanks!

Comment thread articles/kdump.asm.xml
<!-- S T R U C T U R E -->
<structure renderas="article" xml:id="ansible" xml:lang="en">
<merge>
<title>Introduction to &kdump;</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.

Can we have a longer title, please?

Suggested change
<title>Introduction to &kdump;</title>
<title>Kdump Configuration and Troubleshooting Guide</title>

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.

3 participants