[system-administrators-guide] Updated the chapter.
Jaromir Hradilek
jhradile at fedoraproject.org
Mon Jan 2 15:22:26 UTC 2012
commit fcb63d46ba5adc3fcca885676c3a75eae12bf675
Author: Jaromir Hradilek <jhradile at redhat.com>
Date: Mon Jan 2 15:50:54 2012 +0100
Updated the chapter.
en-US/The_kdump_Crash_Recovery_Service.xml | 263 ++++++++++++++--------------
1 files changed, 130 insertions(+), 133 deletions(-)
---
diff --git a/en-US/The_kdump_Crash_Recovery_Service.xml b/en-US/The_kdump_Crash_Recovery_Service.xml
index 3b7efc0..2b3814f 100644
--- a/en-US/The_kdump_Crash_Recovery_Service.xml
+++ b/en-US/The_kdump_Crash_Recovery_Service.xml
@@ -4,15 +4,29 @@
<chapter id="ch-kdump">
<title>The kdump Crash Recovery Service</title>
<para>
- <systemitem class="service">kdump</systemitem> is an advanced crash dumping mechanism. When enabled, the system is booted from the context of another kernel. This second kernel reserves a small amount of memory, and its only purpose is to capture the core dump image in case the system crashes. Since being able to analyze the core dump helps significantly to determine the exact cause of the system failure, it is strongly recommended to have this feature enabled.
+ When the <systemitem class="service">kdump</systemitem> crash dumping mechanism is enabled, the system is booted from the context of another kernel. This second kernel reserves a small amount of memory and its only purpose is to capture the core dump image in case the system crashes.
</para>
<para>
- This chapter explains how to configure, test, and use the <systemitem class="service">kdump</systemitem> service in &MAJOROS;, and provides a brief overview of how to analyze the resulting core dump using the <application>crash</application> debugging utility.
+ Being able to analyze the core dump significantly helps to determine the exact cause of the system failure, and it is therefore strongly recommended to have this feature enabled. This chapter explains how to configure, test, and use the <systemitem class="service">kdump</systemitem> service in &MAJOROS;, and provides a brief overview of how to analyze the resulting core dump using the <application>crash</application> debugging utility.
</para>
+ <section id="s1-kdump-installation">
+ <title>Installing the kdump Service</title>
+ <indexterm>
+ <primary><systemitem class="service">kdump</systemitem></primary>
+ <secondary>installing</secondary>
+ </indexterm>
+ <para>
+ In order use the <systemitem class="service">kdump</systemitem> service on your system, make sure you have the <package>kexec-tools</package> package installed. To do so, type the following at a shell prompt as <systemitem class="username">root</systemitem>:
+ </para>
+ <screen><command>yum install kexec-tools</command></screen>
+ <para>
+ For more information on how to install new packages in &MAJOROS;, refer to <xref linkend="sec-Installing" />.
+ </para>
+ </section>
<section id="s1-kdump-configuration">
<title>Configuring the kdump Service</title>
<para>
- This section covers two common means of configuring the <systemitem class="service">kdump</systemitem> service: using the <application>Kernel Dump Configuration</application> graphical utility, and doing so manually on the command line. It also describes how to test the configuration to verify that everything works as expected.
+ There are three common means of configuring the <systemitem class="service">kdump</systemitem> service: at the first boot, using the <application>Kernel Dump Configuration</application> graphical utility, and doing so manually on the command line.
</para>
<indexterm>
<primary><systemitem class="service">kdump</systemitem></primary>
@@ -24,16 +38,39 @@
A limitation in the current implementation of the <systemitem>Intel IOMMU</systemitem> driver can occasionally prevent the <systemitem class="service">kdump</systemitem> service from capturing the core dump image. To use <systemitem class="service">kdump</systemitem> on Intel architectures reliably, it is advised that the IOMMU support is disabled.
</para>
</important>
- <note>
- <title>Make sure you have relevant packages installed</title>
- <para>
- To use the <systemitem class="service">kdump</systemitem> service, you must have the <package>kexec-tools</package> and <package>system-config-kdump</package> packages installed. To do so, type the following at a shell prompt as <systemitem class="username">root</systemitem>:
- </para>
- <screen><command>yum install kexec-tools system-config-kdump</command></screen>
+ <section id="s2-kdump-configuration-firstboot">
+ <title>Configuring the kdump at First Boot</title>
<para>
- For more information on how to install new packages in &MAJOROS;, refer to <xref linkend="sec-Installing" />.
+ When the system boots for the first time, the <application>firstboot</application> application is launched to guide the user through the initial configuration of the freshly installed system. To configure <systemitem class="service">kdump</systemitem>, navigate to the <guilabel>Kdump</guilabel> section and follow the instructions below.
</para>
- </note>
+ <important>
+ <title>Make sure the system has enough memory</title>
+ <para>
+ Unless the system has enough memory, this option will not be available. For the information on minimum memory requirements, refer to the <citetitle pubwork="section">Required minimums</citetitle> section of the <ulink url="http://www.redhat.com/rhel/compare/"><citetitle pubwork="webpage">Red Hat Enterprise Linux Technology capabilities and limits</citetitle></ulink> comparison chart. When the <systemitem class="service">kdump</systemitem> crash recovery is enabled, the minimum memory requirements increase by the amount of memory reserved for it. This value is determined by the user, and defaults to 128 MB plus 64 MB for each TB of physical memory (that is, a total of 192 MB for a system with 1 TB of physical memory).
+ </para>
+ </important>
+ <section id="s3-kdump-configuration-firstboot-enable">
+ <title>Enabling the Service</title>
+ <indexterm>
+ <primary><systemitem class="service">kdump</systemitem></primary>
+ <secondary>enabling the service</secondary>
+ </indexterm>
+ <para>
+ To allow the <systemitem class="service">kdump</systemitem> daemon to start at boot time, select the <guilabel>Enable kdump?</guilabel> checkbox. This will enable the service and start it for the current session. Similarly, unselecting the checkbox will disable it for and stop the service immediately.
+ </para>
+ </section>
+ <section id="s3-kdump-configuration-firstboot-memory">
+ <title>Configuring the Memory Usage</title>
+ <indexterm>
+ <primary><systemitem class="service">kdump</systemitem></primary>
+ <secondary>configuring the service</secondary>
+ <tertiary>memory usage</tertiary>
+ </indexterm>
+ <para>
+ To configure the amount of memory that is reserved for the <systemitem>kdump</systemitem> kernel, click the up and down arrow buttons next to the <guilabel>Kdump Memory</guilabel> field to increase or decrease the value. Notice that the <guilabel>Usable System Memory</guilabel> field changes accordingly showing you the remaining memory that will be available to the system.
+ </para>
+ </section>
+ </section>
<section id="s2-kdump-configuration-gui">
<title>Using the Kernel Dump Configuration Utility</title>
<indexterm>
@@ -53,20 +90,7 @@
<important>
<title>Make sure the system has enough memory</title>
<para>
- Unless the system has enough memory, the utility will not start, and you will be presented with the following error message:
- </para>
- <mediaobject>
- <imageobject>
- <imagedata fileref="images/kdump-kernel_dump_configuration-not_enough_memory.png" align="center" format="PNG" scalefit="1" />
- </imageobject>
- <textobject>
- <para>
- The <quote>not enough memory</quote> error
- </para>
- </textobject>
- </mediaobject>
- <para>
- For the information on minimum memory requirements, refer to the <citetitle pubwork="section">Hardware Overview</citetitle> section of the <ulink url="http://docs.fedoraproject.org/en-US/Fedora/15/html/Release_Notes/index.html"><citetitle pubwork="webpage">Fedora 15 Release Notes</citetitle></ulink>. Note that when the <systemitem class="service">kdump</systemitem> crash recovery is enabled, the minimum memory requirements increase by the amount of memory reserved for it. This value is determined by a user, and defaults to 128MB.
+ Unless the system has enough memory, the utility will not start and you will be presented with an error message. For the information on minimum memory requirements, refer to the <citetitle pubwork="section">Required minimums</citetitle> section of the <ulink url="http://www.redhat.com/rhel/compare/"><citetitle pubwork="webpage">Red Hat Enterprise Linux Technology capabilities and limits</citetitle></ulink> comparison chart. When the <systemitem class="service">kdump</systemitem> crash recovery is enabled, the minimum memory requirements increase by the amount of memory reserved for it. This value is determined by the user, and defaults to 128 MB plus 64 MB for each TB of physical memory (that is, a total of 192 MB for a system with 1 TB of physical memory).
</para>
</important>
<section id="s3-kdump-configuration-gui-enable">
@@ -76,10 +100,10 @@
<secondary>enabling the service</secondary>
</indexterm>
<para>
- To start the <systemitem class="service">kdump</systemitem> daemon at boot time, click the <guibutton>Enable</guibutton> button on the toolbar. This will enable the service for runlevels <literal>2</literal>, <literal>3</literal>, <literal>4</literal>, and <literal>5</literal>, and start it for the current session. Similarly, clicking the <guibutton>Disable</guibutton> button will disable it for all runlevels and stop the service immediately.
+ To start the <systemitem class="service">kdump</systemitem> daemon at boot time, click the <guibutton>Enable</guibutton> button on the toolbar. This will enable the service and start it for the current session. Similarly, clicking the <guibutton>Disable</guibutton> button will disable it and stop the service immediately.
</para>
<para>
- For more information on runlevels and configuring services in general, refer to <xref linkend="ch-Services_and_Daemons" />.
+ For more information on system services and their configuration, refer to <xref linkend="ch-Services_and_Daemons" />.
</para>
</section>
<section id="s3-kdump-configuration-gui-basic">
@@ -238,17 +262,6 @@
</tbody>
</tgroup>
</table>
- <indexterm>
- <primary><systemitem class="service">kdump</systemitem></primary>
- <secondary>known issues</secondary>
- <tertiary><systemitem class="resource">hpsa</systemitem> driver</tertiary>
- </indexterm>
- <important>
- <title>Using the hpsa driver for a storage</title>
- <para>
- Due to known issue with the <systemitem class="resource">hpsa</systemitem> driver, <systemitem class="service">kdump</systemitem> is unable to save the dump to a storage that uses this driver for HP Smart Array Controllers. If this applies to your machine, it is advised that you save the dump to a remote system using the NFS or SSH protocol instead.
- </para>
- </important>
</section>
<section id="s3-kdump-configuration-gui-filtering">
<title>The Filtering Settings Tab</title>
@@ -274,7 +287,7 @@
</mediaobject>
</figure>
<para>
- To exclude the <guilabel>zero page</guilabel>, <guilabel>cache page</guilabel>, <guilabel>cache private</guilabel>, <guilabel>user data</guilabel>, or <guilabel>free page</guilabel> from the dump, select the check box next to the appropriate label.
+ To exclude the <guilabel>zero page</guilabel>, <guilabel>cache page</guilabel>, <guilabel>cache private</guilabel>, <guilabel>user data</guilabel>, or <guilabel>free page</guilabel> from the dump, select the checkbox next to the appropriate label.
</para>
</section>
<section id="s3-kdump-configuration-gui-expert">
@@ -325,7 +338,7 @@
<tertiary>default action</tertiary>
</indexterm>
<para>
- To choose what steps should be taken when the kernel crash is captured, select the appropriate option from the <guilabel>Default action</guilabel> pulldown list. Available options are <guimenuitem>mount rootfs and run /sbin/init</guimenuitem> (the default action), <guimenuitem>reboot</guimenuitem> (to reboot the system), <guimenuitem>shell</guimenuitem> (to present a user with an interactive shell prompt), <guimenuitem>halt</guimenuitem> (to halt the system), and <guimenuitem>poweroff</guimenuitem> (to power the system off).
+ To choose what action to perform when <systemitem class="service">kdump</systemitem> fails to create a core dump, select an appropriate option from the <guilabel>Default action</guilabel> pulldown list. Available options are <guimenuitem>mount rootfs and run /sbin/init</guimenuitem> (the default action), <guimenuitem>reboot</guimenuitem> (to reboot the system), <guimenuitem>shell</guimenuitem> (to present a user with an interactive shell prompt), <guimenuitem>halt</guimenuitem> (to halt the system), and <guimenuitem>poweroff</guimenuitem> (to power the system off).
</para>
<indexterm>
<primary><systemitem class="service">kdump</systemitem></primary>
@@ -339,10 +352,6 @@
</section>
<section id="s2-kdump-configuration-cli">
<title>Configuring kdump on the Command Line</title>
- <para>
- To perform actions described in this section, you have to be logged in as <systemitem class="username">root</systemitem>. To do so, run the following command:
- </para>
- <screen><command>su -</command></screen>
<section id="s3-kdump-configuration-cli-memory">
<title>Configuring the Memory Usage</title>
<indexterm>
@@ -350,9 +359,6 @@
<secondary>configuring the service</secondary>
<tertiary>memory usage</tertiary>
</indexterm>
- <para>
- To configure the amount of memory that is reserved for the <systemitem>kdump</systemitem> kernel, open the <filename>/boot/grub/grub.conf</filename> file in a text editor such as <application>vi</application> or <application>nano</application>, and add the <option>crashkernel=<replaceable><size></replaceable>M</option> parameter to the list of kernel options as shown in <xref linkend="ex-kdump-configuration-cli-memory-grub" />.
- </para>
<indexterm>
<primary><systemitem class="service">kdump</systemitem></primary>
<secondary>configuring the service</secondary>
@@ -368,9 +374,24 @@
<secondary>configuring the service</secondary>
<tertiary>kernel options</tertiary>
</indexterm>
+ <para>
+ To configure the amount of memory that is reserved for the <systemitem>kdump</systemitem> kernel, as <systemitem class="username">root</systemitem>, open the <filename>/boot/grub/grub.conf</filename> file in a text editor and add the <option>crashkernel=<replaceable><size></replaceable>M</option> (or <option>crashkernel=auto</option>) parameter to the list of kernel options as shown in <xref linkend="ex-kdump-configuration-cli-memory-grub" />.
+ </para>
+ <important>
+ <title>Make sure the system has enough memory</title>
+ <para>
+ Unless the system has enough memory, the <systemitem class="service">kdump</systemitem> crash recovery service will not be operational. For the information on minimum memory requirements, refer to the <citetitle pubwork="section">Required minimums</citetitle> section of the <ulink url="http://www.redhat.com/rhel/compare/"><citetitle pubwork="webpage">Red Hat Enterprise Linux Technology capabilities and limits</citetitle></ulink> comparison chart. When <systemitem class="service">kdump</systemitem> is enabled, the minimum memory requirements increase by the amount of memory reserved for it. This value is determined by a user, and when the <option>crashkernel=auto</option> option is used, it defaults to 128 MB plus 64 MB for each TB of physical memory (that is, a total of 192 MB for a system with 1 TB of physical memory).
+ </para>
+ </important>
+ <important>
+ <title>Using the crashkernel=auto parameter</title>
+ <para>
+ In &MAJOROSVER;, the <option>crashkernel=auto</option> only reserves memory if the system has 4 GB of physical memory or more.
+ </para>
+ </important>
<example id="ex-kdump-configuration-cli-memory-grub">
<title>A sample /boot/grub/grub.conf file</title>
- <screen># grub.conf generated by anaconda
+ <programlisting># grub.conf generated by anaconda
#
# Note that you do not have to rerun grub after making changes to this file
# NOTICE: You have a /boot partition. This means that
@@ -386,15 +407,8 @@ hiddenmenu
title Red Hat Enterprise Linux (2.6.32-54.el6.i686)
root (hd0,0)
kernel /boot/vmlinuz-2.6.32-54.el6.i686 root=/dev/sda3 ro crashkernel=128M
- initrd /initramfs-2.6.32-54.el6.i686.img
-</screen>
+ initrd /initramfs-2.6.32-54.el6.i686.img</programlisting>
</example>
- <important>
- <title>Make sure the system has enough memory</title>
- <para>
- When the <systemitem class="service">kdump</systemitem> crash recovery is enabled, the minimum memory requirements increase by the amount of memory reserved for it. This value is determined by a user, and defaults to 128 MB, as lower values proved to be unreliable. For the information on minimum memory requirements, refer to the <citetitle pubwork="section">Hardware Overview</citetitle> section of the <ulink url="http://docs.fedoraproject.org/en-US/Fedora/15/html/Release_Notes/index.html"><citetitle pubwork="webpage">Fedora 15 Release Notes</citetitle></ulink>.
- </para>
- </important>
</section>
<section id="s3-kdump-configuration-cli-target">
<title>Configuring the Target Type</title>
@@ -404,25 +418,25 @@ title Red Hat Enterprise Linux (2.6.32-54.el6.i686)
<tertiary>target location</tertiary>
</indexterm>
<para>
- When a kernel crash is captured, the core dump can be either stored as a file in a local file system, written directly to a device, or sent over a network using the NFS (Network File System) or SSH (Secure Shell) protocol. Note that only one of these options can be set at the moment. The default option is to store the <filename>vmcore</filename> file in the <filename class="directory">/var/crash/</filename> directory of the local file system. To change this, open the <filename>/etc/kdump.conf</filename> configuration file in a text editor such as <application>vi</application> or <application>nano</application>, and edit the options as described below.
+ When a kernel crash is captured, the core dump can be either stored as a file in a local file system, written directly to a device, or sent over a network using the NFS (Network File System) or SSH (Secure Shell) protocol. Only one of these options can be set at the moment, and the default option is to store the <filename>vmcore</filename> file in the <filename class="directory">/var/crash/</filename> directory of the local file system. To change this, as <systemitem class="username">root</systemitem>, open the <filename>/etc/kdump.conf</filename> configuration file in a text editor and edit the options as described below.
</para>
<para>
To change the local directory in which the core dump is to be saved, remove the hash sign (<quote>#</quote>) from the beginning of the <literal>#path /var/crash</literal> line, and replace the value with a desired directory path. Optionally, if you wish to write the file to a different partition, follow the same procedure with the <literal>#ext4 /dev/sda3</literal> line as well, and change both the file system type and the device (a device name, a file system label, and UUID are all supported) accordingly. For example:
</para>
- <screen>ext3 /dev/sda4
-path /usr/local/cores</screen>
+ <programlisting>ext3 /dev/sda4
+path /usr/local/cores</programlisting>
<para>
To write the dump directly to a device, remove the hash sign (<quote>#</quote>) from the beginning of the <literal>#raw /dev/sda5</literal> line, and replace the value with a desired device name. For example:
</para>
- <screen>raw /dev/sdb1</screen>
+ <programlisting>raw /dev/sdb1</programlisting>
<para>
To store the dump to a remote machine using the NFS protocol, remove the hash sign (<quote>#</quote>) from the beginning of the <literal>#net my.server.com:/export/tmp</literal> line, and replace the value with a valid hostname and directory path. For example:
</para>
- <screen>net penguin.example.com:/export/cores</screen>
+ <programlisting>net penguin.example.com:/export/cores</programlisting>
<para>
To store the dump to a remote machine using the SSH protocol, remove the hash sign (<quote>#</quote>) from the beginning of the <literal>#net user at my.server.com</literal> line, and replace the value with a valid username and hostname. For example:
</para>
- <screen>net john at penguin.example.com</screen>
+ <programlisting>net john at penguin.example.com</programlisting>
<para>
Refer to <xref linkend="ch-OpenSSH" /> for information on how to configure an SSH server, and how to set up a key-based authentication.
</para>
@@ -434,18 +448,6 @@ path /usr/local/cores</screen>
<para>
For a complete list of currently supported targets, see <xref linkend="tab-kdump-supported_targets" />.
</para>
- <indexterm>
- <primary><systemitem class="service">kdump</systemitem></primary>
- <secondary>known issues</secondary>
- <tertiary><systemitem class="resource">hpsa</systemitem> driver</tertiary>
- </indexterm>
- <important>
- <title>Using the hpsa driver for a storage</title>
- <para>
- Due to known issue with the <systemitem class="resource">hpsa</systemitem> driver, <systemitem class="service">kdump</systemitem> is unable to save the dump to a storage that uses this driver for HP Smart Array Controllers. If this applies to your machine, it is advised that you save the dump to a remote system using the NFS or SSH protocol instead.
-
- </para>
- </important>
</section>
<section id="s3-kdump-configuration-cli-filtering">
<title>Configuring the Core Collector</title>
@@ -453,7 +455,7 @@ path /usr/local/cores</screen>
To reduce the size of the <filename>vmcore</filename> dump file, <systemitem class="service">kdump</systemitem> allows you to specify an external application (that is, a core collector) to compress the data, and optionally leave out all irrelevant information. Currently, the only fully supported core collector is <command>makedumpfile</command>.
</para>
<para>
- To enable the core collector, open the <filename>/etc/kdump.conf</filename> configuration file in a text editor such as <application>vi</application> or <application>nano</application>, remove the hash sign (<quote>#</quote>) from the beginning of the <literal>#core_collector makedumpfile -c --message-level 1 -d 31</literal> line, and edit the command line options as described below.
+ To enable the core collector, as <systemitem class="username">root</systemitem>, open the <filename>/etc/kdump.conf</filename> configuration file in a text editor, remove the hash sign (<quote>#</quote>) from the beginning of the <literal>#core_collector makedumpfile -c --message-level 1 -d 31</literal> line, and edit the command line options as described below.
</para>
<indexterm>
<primary><systemitem class="service">kdump</systemitem></primary>
@@ -463,7 +465,7 @@ path /usr/local/cores</screen>
<para>
To enable the dump file compression, add the <option>-c</option> parameter. For example:
</para>
- <screen>core_collector makedumpfile -c</screen>
+ <programlisting>core_collector makedumpfile -c</programlisting>
<indexterm>
<primary><systemitem class="service">kdump</systemitem></primary>
<secondary>configuring the service</secondary>
@@ -472,7 +474,7 @@ path /usr/local/cores</screen>
<para>
To remove certain pages from the dump, add the <option>-d <replaceable>value</replaceable></option> parameter, where <replaceable>value</replaceable> is a sum of values of pages you want to omit as described in <xref linkend="table-kdump-configuration-cli-filtering-makedumpfile" />. For example, to remove both zero and free pages, use the following:
</para>
- <screen>core_collector makedumpfile -d 17 -c</screen>
+ <programlisting>core_collector makedumpfile -d 17 -c</programlisting>
<para>
Refer to the manual page for <command>makedumpfile</command> for a complete list of available options.
</para>
@@ -544,9 +546,8 @@ path /usr/local/cores</screen>
<tertiary>default action</tertiary>
</indexterm>
<para>
- By default, when the kernel crash is captured, the root file system is mounted, and <command>/sbin/init</command> is run. To change this behavior, open the <filename>/etc/kdump.conf</filename> configuration file in a text editor such as <application>vi</application> or <application>nano</application>, remove the hash sign (<quote>#</quote>) from the beginning of the <literal>#default shell</literal> line, and replace the value with a desired action as described in <xref linkend="table-kdump-configuration-cli-action-actions" />. For example:
+ By default, when <systemitem class="service">kdump</systemitem> fails to create a core dump, the root file system is mounted and <command>/sbin/init</command> is run. To change this behavior, as <systemitem class="username">root</systemitem>, open the <filename>/etc/kdump.conf</filename> configuration file in a text editor, remove the hash sign (<quote>#</quote>) from the beginning of the <literal>#default shell</literal> line, and replace the value with a desired action as described in <xref linkend="table-kdump-configuration-cli-action-actions" />.
</para>
- <screen>default halt</screen>
<table id="table-kdump-configuration-cli-action-actions">
<title>Supported actions</title>
<tgroup cols="2">
@@ -576,7 +577,7 @@ path /usr/local/cores</screen>
<option>halt</option>
</entry>
<entry>
- After attempting to capture a core, halt the system no matter if it succeeded.
+ Halt the system.
</entry>
</row>
<row>
@@ -598,6 +599,10 @@ path /usr/local/cores</screen>
</tbody>
</tgroup>
</table>
+ <para>
+ For example:
+ </para>
+ <programlisting>default halt</programlisting>
</section>
<section id="s3-kdump-configuration-cli-enable">
<title>Enabling the Service</title>
@@ -606,19 +611,19 @@ path /usr/local/cores</screen>
<secondary>enabling the service</secondary>
</indexterm>
<para>
- To start the <systemitem class="service">kdump</systemitem> daemon at boot time, type the following at a shell prompt:
+ To start the <systemitem class="service">kdump</systemitem> daemon at boot time, type the following at a shell prompt as <systemitem class="username">root</systemitem>:
</para>
- <screen><command>systemctl enable kdump.service</command></screen>
+ <synopsis><command>systemctl</command> <option>enable</option> <option>kdump.service</option></synopsis>
<para>
- Similarly, typing <command>systemctl disable kdump.service</command> will disable it. To start the service in the current session, use the following command:
+ Similarly, typing <command>systemctl disable kdump.service</command> will disable it. To start the service in the current session, use the following command as <systemitem class="username">root</systemitem>:
</para>
<indexterm>
<primary><systemitem class="service">kdump</systemitem></primary>
<secondary>running the service</secondary>
</indexterm>
- <screen><command>systemctl start kdump.service</command></screen>
+ <synopsis><command>systemctl</command> <option>start</option> <option>kdump.service</option></synopsis>
<para>
- For more information on runlevels and configuring services in general, refer to <xref linkend="ch-Services_and_Daemons" />.
+ For more information on services and their configuration, refer to <xref linkend="ch-Services_and_Daemons" />.
</para>
</section>
</section>
@@ -646,15 +651,6 @@ path /usr/local/cores</screen>
<para>
This will force the Linux kernel to crash, and the <filename><replaceable>address</replaceable>-<replaceable>YYYY-MM-DD</replaceable>-<replaceable>HH:MM:SS</replaceable>/vmcore</filename> file will be copied to the location you have selected in the configuration (that is, to <filename class="directory">/var/crash/</filename> by default).
</para>
- <example id="ex-kdump-configuration-testing-vmcore">
- <title>Listing a content of /var/crash/ after a crash</title>
- <screen>~]# <command>tree --charset=ascii /var/crash</command>
-/var/crash
-`-- 127.0.0.1-2010-08-25-08:45:02
- `-- vmcore
-
-1 directory, 1 file</screen>
- </example>
</section>
</section>
<section id="s1-kdump-crash">
@@ -691,7 +687,7 @@ path /usr/local/cores</screen>
<para>
To start the utility, type the command in the following form at a shell prompt:
</para>
- <screen><command>crash /var/crash/<replaceable>timestamp</replaceable>/vmcore /usr/lib/debug/lib/modules/<replaceable>kernel</replaceable>/vmlinux</command></screen>
+ <synopsis><command>crash</command> <filename>/var/crash/<replaceable>timestamp</replaceable>/vmcore</filename> <filename>/usr/lib/debug/lib/modules/<replaceable>kernel</replaceable>/vmlinux</filename></synopsis>
<para>
Note that the <replaceable>kernel</replaceable> version should be the same that was captured by <systemitem class="service">kdump</systemitem>. To find out which kernel you are currently running, use the <command>uname -r</command> command.
</para>
@@ -949,58 +945,59 @@ ROOT: / CWD: /root
<secondary>additional resources</secondary>
<tertiary>installed documents</tertiary>
</indexterm>
+ <itemizedlist>
+ <listitem>
+ <para>
+ <emphasis role="bold">kdump.conf</emphasis>(5) — a manual page for the <filename>/etc/kdump.conf</filename> configuration file containing the full documentation of available options.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">makedumpfile</emphasis>(8) — a manual page for the <command>makedumpfile</command> core collector.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">kexec</emphasis>(8) — a manual page for <application>kexec</application>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis role="bold">crash</emphasis>(8) — a manual page for the <application>crash</application> utility.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <filename>/usr/share/doc/kexec-tools-<replaceable>version</replaceable>/kexec-kdump-howto.txt</filename> — an overview of the <systemitem class="service">kdump</systemitem> and <application>kexec</application> installation and usage.
+ </para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section id="s2-kdump-resources-online">
+ <title>Useful Websites</title>
+ <indexterm>
+ <primary><systemitem class="service">kdump</systemitem></primary>
+ <secondary>additional resources</secondary>
+ <tertiary>websites</tertiary>
+ </indexterm>
<variablelist>
<varlistentry>
- <term><command>man kdump.conf</command></term>
- <listitem>
- <para>
- The manual page for the <filename>/etc/kdump.conf</filename> configuration file containing the full documentation of available options.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>man makedumpfile</command></term>
- <listitem>
- <para>
- The manual page for the <command>makedumpfile</command> core collector containing the full documentation on its usage.
- </para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><command>man kexec</command></term>
+ <term><ulink url="https://access.redhat.com/kb/docs/DOC-6039" /></term>
<listitem>
<para>
- The manual page for <command>kexec</command> containing the full documentation on its usage.
+ The Red Hat Knowledgebase article about the <command>kexec</command> and <systemitem class="service">kdump</systemitem> configuration.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><command>man crash</command></term>
+ <term><ulink url="https://access.redhat.com/kb/docs/DOC-45183" /></term>
<listitem>
<para>
- The manual page for the <application>crash</application> utility containing the full documentation on its usage.
+ The Red Hat Knowledgebase article about supported <systemitem class="service">kdump</systemitem> targets.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><filename>/usr/share/doc/kexec-tools-<replaceable>version</replaceable>/kexec-kdump-howto.txt</filename></term>
- <listitem>
- <para>
- An overview of the <systemitem class="service">kdump</systemitem> and <command>kexec</command> installation and usage.
- </para>
- </listitem>
- </varlistentry>
- </variablelist>
- </section>
- <section id="s2-kdump-resources-online">
- <title>Useful Websites</title>
- <indexterm>
- <primary><systemitem class="service">kdump</systemitem></primary>
- <secondary>additional resources</secondary>
- <tertiary>websites</tertiary>
- </indexterm>
- <variablelist>
- <varlistentry>
<term><ulink url="http://people.redhat.com/anderson/" /></term>
<listitem>
<para>
More information about the docs-commits
mailing list