kdump.conf man page fixes
Fix the typos and grammar problems in kdump.conf man page. Reported-by: Donald Berry <dberry@redhat.com> Signed-off-by: Xunlei Pang <xlpang@redhat.com> Signed-off-by: Dave Young <dyoung@redhat.com> Acked-by: Baoquan He <bhe@redhat.com>
This commit is contained in:
parent
bf902fc65b
commit
182f742eed
109
kdump.conf.5
109
kdump.conf.5
@ -10,14 +10,14 @@ collection service.
|
|||||||
|
|
||||||
kdump.conf provides post-kexec instructions to the kdump kernel. It is
|
kdump.conf provides post-kexec instructions to the kdump kernel. It is
|
||||||
stored in the initrd file managed by the kdump service. If you change
|
stored in the initrd file managed by the kdump service. If you change
|
||||||
this file and do not want to restart before it takes effect, restart
|
this file and do not want to reboot in order for the changes to take
|
||||||
the kdump service to rebuild to initrd.
|
effect, restart the kdump service to rebuild the initrd.
|
||||||
|
|
||||||
For most configurations, you can simply review the examples provided
|
For most configurations, you can simply review the examples provided
|
||||||
in the stock /etc/kdump.conf.
|
in the stock /etc/kdump.conf.
|
||||||
|
|
||||||
.B NOTE:
|
.B NOTE:
|
||||||
For filesystem dump the dump target must be mounted before building
|
For filesystem dumps the dump target must be mounted before building
|
||||||
kdump initramfs.
|
kdump initramfs.
|
||||||
|
|
||||||
kdump.conf only affects the behavior of the initramfs. Please read the
|
kdump.conf only affects the behavior of the initramfs. Please read the
|
||||||
@ -34,28 +34,28 @@ partition devices, such as /dev/vg/<devname>.
|
|||||||
|
|
||||||
.B nfs <nfs mount>
|
.B nfs <nfs mount>
|
||||||
.RS
|
.RS
|
||||||
Will mount fs and copy /proc/vmcore to <mnt>/var/crash/%HOST-%DATE/,
|
Will mount nfs to <mnt>, and copy /proc/vmcore to <mnt>/<path>/%HOST-%DATE/,
|
||||||
supports DNS. Note that a fqdn should be used as the server name in the
|
supports DNS. Note that a fqdn should be used as the server name in the
|
||||||
mount point
|
mount point.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.B ssh <user@server>
|
.B ssh <user@server>
|
||||||
.RS
|
.RS
|
||||||
Will scp /proc/vmcore to <user@server>:/var/crash/%HOST-%DATE/,
|
Will scp /proc/vmcore to <user@server>:<path>/%HOST-%DATE/,
|
||||||
supports DNS. NOTE: make sure user has necessary write permissions on
|
supports DNS. NOTE: make sure user has necessary write permissions on
|
||||||
server and that a fqdn is used as the server name
|
server and that a fqdn is used as the server name.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.B sshkey <path>
|
.B sshkey <path>
|
||||||
.RS
|
.RS
|
||||||
Specifies the path of the ssh key you want to use when do ssh dump,
|
Specify the path of the ssh key to use when dumping via ssh.
|
||||||
the default value is /root/.ssh/kdump_id_rsa.
|
The default value is /root/.ssh/kdump_id_rsa.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.B <fs type> <partition>
|
.B <fs type> <partition>
|
||||||
.RS
|
.RS
|
||||||
Will mount -t <fs type> <partition> /mnt and copy /proc/vmcore to
|
Will mount -t <fs type> <partition> <mnt>, and copy /proc/vmcore to
|
||||||
/mnt/var/crash/%DATE/. NOTE: <partition> can be a device node, label
|
<mnt>/<path>/%DATE/. NOTE: <partition> can be a device node, label
|
||||||
or uuid. It's recommended to use persistent device names such as
|
or uuid. It's recommended to use persistent device names such as
|
||||||
/dev/vg/<devname>. Otherwise it's suggested to use label or uuid.
|
/dev/vg/<devname>. Otherwise it's suggested to use label or uuid.
|
||||||
.RE
|
.RE
|
||||||
@ -66,37 +66,36 @@ or uuid. It's recommended to use persistent device names such as
|
|||||||
If a dump target is specified in kdump.conf, then "path" is relative to the
|
If a dump target is specified in kdump.conf, then "path" is relative to the
|
||||||
specified dump target.
|
specified dump target.
|
||||||
.PP
|
.PP
|
||||||
Interpretation of path changes a bit if user has not specified a dump
|
Interpretation of "path" changes a bit if the user didn't specify any dump
|
||||||
target explicitly in kdump.conf. In this case, "path" represents the
|
target explicitly in kdump.conf. In this case, "path" represents the
|
||||||
absolute path from root. And dump target and adjusted path are arrived
|
absolute path from root. The dump target and adjusted path are arrived
|
||||||
at automatically depending on what's mounted in the current system.
|
at automatically depending on what's mounted in the current system.
|
||||||
.PP
|
.PP
|
||||||
Ignored for raw device dumps. If unset, will default to /var/crash.
|
Ignored for raw device dumps. If unset, will use the default "/var/crash".
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.B core_collector <command> <options>
|
.B core_collector <command> <options>
|
||||||
.RS
|
.RS
|
||||||
This allows you to specify the command to copy the vmcore.
|
This allows you to specify the command to copy the vmcore.
|
||||||
You could use the dump filtering program makedumpfile, the default one,
|
The default is makedumpfile, which on some architectures can drastically reduce
|
||||||
to retrieve your core, which on some arches can drastically reduce
|
|
||||||
core file size. See /sbin/makedumpfile --help for a list of options.
|
core file size. See /sbin/makedumpfile --help for a list of options.
|
||||||
Note that the -i and -g options are not needed here, as the initrd
|
Note that the -i and -g options are not needed here, as the initrd
|
||||||
will automatically be populated with a config file appropriate
|
will automatically be populated with a config file appropriate
|
||||||
for the running kernel.
|
for the running kernel.
|
||||||
.PP
|
.PP
|
||||||
Note 1: About default core collector:
|
Note 1: About default core collector:
|
||||||
Default core_collector for raw/ssh dump is:
|
The default core_collector for raw/ssh dump is:
|
||||||
"makedumpfile -F -l --message-level 1 -d 31".
|
"makedumpfile -F -l --message-level 1 -d 31".
|
||||||
Default core_collector for other targets is:
|
The default core_collector for other targets is:
|
||||||
"makedumpfile -l --message-level 1 -d 31".
|
"makedumpfile -l --message-level 1 -d 31".
|
||||||
Even if core_collector option is commented out in kdump.conf, makedumpfile
|
Even if core_collector option is commented out in kdump.conf, makedumpfile
|
||||||
is default core collector and kdump uses it internally.
|
is the default core collector and kdump uses it internally.
|
||||||
If one does not want makedumpfile as default core_collector, then they
|
If one does not want makedumpfile as default core_collector, then they
|
||||||
need to specify one using core_collector option to change the behavior.
|
need to specify one using core_collector option to change the behavior.
|
||||||
.PP
|
.PP
|
||||||
Note 2: If "makedumpfile -F" is used then you will get a flattened format
|
Note 2: If "makedumpfile -F" is used then you will get a flattened format
|
||||||
vmcore.flat, you will need to use "makedumpfile -R" to rearrange the
|
vmcore.flat, you will need to use "makedumpfile -R" to rearrange the
|
||||||
dump data from stdard input to a normal dumpfile (readable with analysis
|
dump data from standard input to a normal dumpfile (readable with analysis
|
||||||
tools).
|
tools).
|
||||||
ie. "makedumpfile -R vmcore < vmcore.flat"
|
ie. "makedumpfile -R vmcore < vmcore.flat"
|
||||||
|
|
||||||
@ -104,20 +103,19 @@ ie. "makedumpfile -R vmcore < vmcore.flat"
|
|||||||
|
|
||||||
.B kdump_post <binary | script>
|
.B kdump_post <binary | script>
|
||||||
.RS
|
.RS
|
||||||
This directive allows you to run a specified
|
This directive allows you to run a specified executable
|
||||||
executable just after the memory dump process
|
just after the vmcore dump process terminates. The exit
|
||||||
terminates. The exit status from the dump process
|
status of the current dump process is fed to the kdump_post
|
||||||
is fed to the kdump_post executable, which can be
|
executable as its first argument($1). Executable can modify
|
||||||
used to trigger different actions for success or
|
it to indicate the new exit status of succeeding dump process,
|
||||||
failure.
|
|
||||||
.PP
|
.PP
|
||||||
Note that scripts written for use with this
|
Note that scripts written for use with this directive must use
|
||||||
directive must use the /bin/bash interpreter
|
the /bin/bash interpreter.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.B kdump_pre <binary | script>
|
.B kdump_pre <binary | script>
|
||||||
.RS
|
.RS
|
||||||
Works just like the kdump_post directive, but instead
|
Works just like the "kdump_post" directive, but instead
|
||||||
of running after the dump process, runs immediately
|
of running after the dump process, runs immediately
|
||||||
before. Exit status of this binary is interpreted
|
before. Exit status of this binary is interpreted
|
||||||
as follows:
|
as follows:
|
||||||
@ -127,7 +125,7 @@ as follows:
|
|||||||
non 0 - reboot the system
|
non 0 - reboot the system
|
||||||
.PP
|
.PP
|
||||||
Note that scripts written for this directive must use
|
Note that scripts written for this directive must use
|
||||||
the /bin/bash interpreter
|
the /bin/bash interpreter.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.B extra_bins <binaries | shell scripts>
|
.B extra_bins <binaries | shell scripts>
|
||||||
@ -146,36 +144,33 @@ modules that you want to be loaded in the kdump
|
|||||||
initrd, typically used to set up access to
|
initrd, typically used to set up access to
|
||||||
non-boot-path dump targets that might otherwise
|
non-boot-path dump targets that might otherwise
|
||||||
not be accessible in the kdump environment. Multiple
|
not be accessible in the kdump environment. Multiple
|
||||||
modules can be listed, separated by a space, and any
|
modules can be listed, separated by spaces, and any
|
||||||
dependent modules will automatically be included.
|
dependent modules will automatically be included.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.B default <reboot | halt | poweroff | shell | dump_to_rootfs>
|
.B default <reboot | halt | poweroff | shell | dump_to_rootfs>
|
||||||
.RS
|
.RS
|
||||||
Action to preform in case dumping to intended target fails. If no default
|
Action to perform in case dumping to the intended target fails. The default is "reboot".
|
||||||
action is specified, "reboot" is assumed default.
|
reboot: Reboot the system (this is what most people will want, as it returns the system
|
||||||
reboot: If the default action is reboot simply reboot the system (this is what
|
to a normal state). halt: Halt the system and lose the vmcore. poweroff: The system
|
||||||
most people will want, as it returns the system to a nominal state). shell: If the default
|
will be powered down. shell: Drop to a shell session inside the initramfs, from which
|
||||||
action is shell, then drop to an shell session inside the initramfs from
|
you can manually perform additional recovery actions. Exiting this shell reboots the
|
||||||
where you can manually preform additional recovery actions. Exiting this shell
|
system. Note: kdump uses bash as the default shell. dump_to_rootfs: If non-root dump
|
||||||
reboots the system. halt: bring the system to a halt, requiring manual reset
|
target is specified, the default action can be set as dump_to_rootfs. That means when
|
||||||
poweroff: The system will be powered down. dump_to_rootfs:If the default action
|
dumping to target fails, dump vmcore to rootfs from initramfs context and reboot.
|
||||||
is dump_to_rootfs, specified root will be mounted and dump will be saved in "path"
|
|
||||||
directory.
|
|
||||||
Note: kdump uses bash as the default shell.
|
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.B force_rebuild <0 | 1>
|
.B force_rebuild <0 | 1>
|
||||||
.RS
|
.RS
|
||||||
By default, kdump initrd only will be rebuilt when necessary.
|
By default, kdump initrd will only be rebuilt when necessary.
|
||||||
Specify 1 to force rebuilding kdump initrd every time when kdump service starts.
|
Specify 1 to force rebuilding kdump initrd every time when kdump service starts.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.B override_resettable <0 | 1>
|
.B override_resettable <0 | 1>
|
||||||
.RS
|
.RS
|
||||||
Usually a unresettable block device can't be dump target. Specifying 1 means
|
Usually an unresettable block device can't be a dump target. Specifying 1 means
|
||||||
though block target is unresettable, user understand this situation and want
|
that even though the block target is unresettable, the user wants to try dumping anyway.
|
||||||
to try dumping. By default, it's set to 0, means not to try a destined failure.
|
By default, it's set to 0, which will not try something destined to fail.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
|
|
||||||
@ -195,7 +190,7 @@ arguments except hosts to send notification to).
|
|||||||
|
|
||||||
.B fence_kdump_nodes <node(s)>
|
.B fence_kdump_nodes <node(s)>
|
||||||
.RS
|
.RS
|
||||||
List of cluster node(s) separated by space to send fence_kdump notification
|
List of cluster node(s), separated by spaces, to send fence_kdump notification
|
||||||
to (this option is mandatory to enable fence_kdump).
|
to (this option is mandatory to enable fence_kdump).
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
@ -210,26 +205,26 @@ directly.
|
|||||||
|
|
||||||
.B options <module> <option list>
|
.B options <module> <option list>
|
||||||
.RS
|
.RS
|
||||||
Use KDUMP_COMMANDLINE_APPEND in /etc/sysconfig/kdump to add proper
|
Use KDUMP_COMMANDLINE_APPEND in /etc/sysconfig/kdump to add module options as
|
||||||
module option as kernel command line params. Such as append loop.max_loop=1
|
kernel command line parameters. For example, specify 'loop.max_loop=1' to limit
|
||||||
to limit maximum loop devices to 1.
|
maximum loop devices to 1.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.B link_delay <seconds>
|
.B link_delay <seconds>
|
||||||
.RS
|
.RS
|
||||||
link_delay was used to wait a network device to initialize before using it.
|
link_delay was used to wait for a network device to initialize before using it.
|
||||||
Now dracut network module take care of this issue automaticlly.
|
Now dracut network module takes care of this issue automatically.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.B disk_timeout <seconds>
|
.B disk_timeout <seconds>
|
||||||
.RS
|
.RS
|
||||||
Similar to link_delay, dracut ensures disks being ready before kdump uses them.
|
Similar to link_delay, dracut ensures disks are ready before kdump uses them.
|
||||||
.RE
|
.RE
|
||||||
|
|
||||||
.B debug_mem_level <0-3>
|
.B debug_mem_level <0-3>
|
||||||
.RS
|
.RS
|
||||||
This was used to turns on debug/verbose output of kdump scripts regarding
|
Turn on verbose debug output of kdump scripts regarding free/used memory at
|
||||||
free/used memory at various points of execution. This feature has been
|
various points of execution. This feature has been
|
||||||
moved to dracut now.
|
moved to dracut now.
|
||||||
Use KDUMP_COMMANDLINE_APPEND in /etc/sysconfig/kdump and
|
Use KDUMP_COMMANDLINE_APPEND in /etc/sysconfig/kdump and
|
||||||
append dracut cmdline param rd.memdebug=[0-3] to enable the debug output.
|
append dracut cmdline param rd.memdebug=[0-3] to enable the debug output.
|
||||||
@ -253,7 +248,7 @@ present in initramfs but it is not actually loaded in kernel. Hence
|
|||||||
retaining blacklist option creates more confusing behavior. It has been
|
retaining blacklist option creates more confusing behavior. It has been
|
||||||
deprecated.
|
deprecated.
|
||||||
.PP
|
.PP
|
||||||
Instead use rd.driver.blacklist option on second kernel to blacklist
|
Instead, use rd.driver.blacklist option on second kernel to blacklist
|
||||||
a certain module. One can edit /etc/sysconfig/kdump.conf and edit
|
a certain module. One can edit /etc/sysconfig/kdump.conf and edit
|
||||||
KDUMP_COMMANDLINE_APPEND to pass kernel command line options. Refer
|
KDUMP_COMMANDLINE_APPEND to pass kernel command line options. Refer
|
||||||
to dracut.cmdline man page for more details on module blacklist option.
|
to dracut.cmdline man page for more details on module blacklist option.
|
||||||
@ -262,7 +257,7 @@ to dracut.cmdline man page for more details on module blacklist option.
|
|||||||
.RE
|
.RE
|
||||||
|
|
||||||
.SH EXAMPLES
|
.SH EXAMPLES
|
||||||
Here is some examples for core_collector option:
|
Here are some examples for core_collector option:
|
||||||
.PP
|
.PP
|
||||||
Core collector command format depends on dump target type. Typically for
|
Core collector command format depends on dump target type. Typically for
|
||||||
filesystem (local/remote), core_collector should accept two arguments.
|
filesystem (local/remote), core_collector should accept two arguments.
|
||||||
|
Loading…
Reference in New Issue
Block a user