rpms/kexec-tools
7
0
Fork 0
Code Issues Pull Requests Releases Activity

kdump.conf comments fixes

Browse Source 
The default action comment about "halt" is wrong, default action means
the action to perform after a vmcore saving failure.

Also there are lots of typos and incorrect expressions.
Fix them here as well.

[dyoung: fixed trailing whitespaces, drop unnecessary comments, change the
alignment.]
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:
Xunlei Pang 2016-07-06 13:02:08 +08:00 committed by Dave Young
parent 3859893fee
commit bf902fc65b
1 changed files with 105 additions and 113 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

218
kdump.conf
View File

@ -1,145 +1,137 @@
# Configures where to put the kdump /proc/vmcore files # This file contains a series of commands to perform (in order) in the kdump
# kernel after a kernel crash in the crash kernel(1st kernel) has happened.
# #
# This file contains a series of commands to perform (in order) when a # Directives in this file are only applicable to the kdump initramfs, and have
# kernel crash has happened and the kdump kernel has been loaded. Directives in # no effect once the root filesystem is mounted and the normal init scripts are
# this file are only applicable to the kdump initramfs, and have no effect if # processed.
# the root filesystem is mounted and the normal init scripts are processed
# #
# Currently only one dump target and path may be configured at once # Currently, only one dump target and path can be specified. If the dumping to
# if the configured dump target fails, the default action will be preformed # the configured target fails, the default action which can be configured via
# the default action may be configured with the default directive below. If the # the "default" directive will be performed.
# configured dump target succedes
# #
# Basics commands supported are: # Supported options:
# raw <partition> - Will dd /proc/vmcore into <partition>.
# Use persistent device names for partition devices,
# such as /dev/vg/<devname>.
# #
# nfs <nfs mount> - Will mount fs and copy /proc/vmcore to # raw <partition>
# <mnt>/var/crash/%HOST-%DATE/, supports DNS. # - Will dd /proc/vmcore into <partition>.
# Use persistent device names for partition devices,
# such as /dev/vg/<devname>.
# #
# ssh <user@server> - Will scp /proc/vmcore to # nfs <nfs mount>
# <user@server>:/var/crash/%HOST-%DATE/, supports DNS # - Will mount nfs to <mnt>, and copy /proc/vmcore to
# NOTE: make sure user has necessary write # <mnt>/<path>/%HOST-%DATE/, supports DNS.
# permissions on server
# #
# sshkey <path> - Will use the sshkey to do ssh dump # ssh <user@server>
# Specifies the path of the ssh key you want to use # - Will scp /proc/vmcore to <user@server>:<path>/%HOST-%DATE/,
# when do ssh dump, the default value is # supports DNS.
# /root/.ssh/kdump_id_rsa. # NOTE: make sure the user has write permissions on the server.
# #
# <fs type> <partition> - Will mount -t <fs type> <partition> /mnt and copy # sshkey <path>
# /proc/vmcore to /mnt/var/crash/%DATE/. # - Will use the sshkey to do ssh dump.
# NOTE: <partition> can be a device node, label or uuid. # Specify the path of the ssh key to use when dumping
# It's recommended to use persistent device names # via ssh. The default value is /root/.ssh/kdump_id_rsa.
# such as /dev/vg/<devname>.
# Otherwise it's suggested to use label or uuid.
# #
# path <path> - "path" represents the file system path in which # <fs type> <partition>
# vmcore will be saved. If a dump target is specified # - Will mount -t <fs type> <partition> <mnt>, and copy
# in kdump.conf, then "path" is relative to the # /proc/vmcore to <mnt>/<path>/%DATE/.
# specified dump target. Interpretation of path # NOTE: <partition> can be a device node, label or uuid.
# changes a bit if user has not specified a dump # It's recommended to use persistent device names
# target explicitly in kdump.conf. In this case, # such as /dev/vg/<devname>.
# "path" represents the absolute path from root. # Otherwise it's suggested to use label or uuid.
# And dump target and adjusted path are arrived #
# at automatically depending on what's mounted # path <path>
# in the current system. # - "path" represents the file system path in which vmcore
# Ignored for raw device dumps. If unset, will # will be saved. If a dump target is specified in
# default to /var/crash. # kdump.conf, then "path" is relative to the specified
# dump target.
#
# 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 absolute path from root. The
# dump target and adjusted path are arrived at automatically
# depending on what's mounted in the current system.
#
# Ignored for raw device dumps. If unset, will use the default
# "/var/crash".
# #
# core_collector <command> <options> # core_collector <command> <options>
# - This allows you to specify the command to copy # - This allows you to specify the command to copy
# the vmcore. You could use the dump filtering # the vmcore. The default is makedumpfile, which on
# program makedumpfile, the default one, to retrieve # some architectures can drastically reduce vmcore size.
# your core, which on some arches can drastically # See /sbin/makedumpfile --help for a list of options.
# reduce core file size. See /sbin/makedumpfile --help # Note that the -i and -g options are not needed here,
# for a list of options. Note that the -i and -g # as the initrd will automatically be populated with a
# options are not needed here, as the initrd will # config file appropriate for the running kernel.
# automatically be populated with a config file # The default core_collector for raw/ssh dump is:
# appropriate for the running kernel. # "makedumpfile -F -l --message-level 1 -d 31".
# Default core_collector for raw/ssh dump is: # The default core_collector for other targets is:
# "makedumpfile -F -l --message-level 1 -d 31". # "makedumpfile -l --message-level 1 -d 31".
# Default core_collector for other targets is: #
# "makedumpfile -l --message-level 1 -d 31". # "makedumpfile -F" will create a flattened vmcore.
# For core_collector format details please refer to # You need to use "makedumpfile -R" to rearrange the dump data to
# kexec-kdump-howto.txt or kdump.conf manpage. # a normal dumpfile readable with analysis tools. For example:
# "makedumpfile -R vmcore < vmcore.flat".
#
# For core_collector format details, you can refer to
# kexec-kdump-howto.txt or kdump.conf manpage.
# #
# kdump_post <binary | script> # kdump_post <binary | script>
# - This directive allows you to run a specified # - This directive allows you to run a executable binary
# executable just after the memory dump process # or script after the vmcore dump process terminates.
# terminates. The exit status from the dump process # The exit status of the current dump process is fed to
# is fed to the kdump_post executable, which can be # the executable binary or script as its first argument.
# used to trigger different actions for success or
# failure.
# #
# kdump_pre <binary | script> # kdump_pre <binary | script>
# - works just like the kdump_post directive, but instead # - Works like the "kdump_post" directive, but instead of running
# of running after the dump process, runs immediately # after the dump process, runs immediately before it.
# before. Exit status of this binary is interpreted # Exit status of this binary is interpreted as follows:
# as follows: # 0 - continue with dump process as usual
# 0 - continue with dump process as usual # non 0 - reboot the system
# non 0 - reboot the system
# #
# extra_bins <binaries | shell scripts> # extra_bins <binaries | shell scripts>
# - This directive allows you to specify additional # - This directive allows you to specify additional binaries or
# binaries or shell scripts you'd like to include in # shell scripts to be included in the kdump initrd.
# your kdump initrd. Generally only useful in # Generally they are useful in conjunction with a kdump_post
# conjunction with a kdump_post binary or script that # or kdump_pre binary or script which depends on these extra_bins.
# relies on other binaries or scripts.
# #
# extra_modules <module(s)> # extra_modules <module(s)>
# - This directive allows you to specify extra kernel # - This directive allows you to specify extra kernel modules
# modules that you want to be loaded in the kdump # that you want to be loaded in the kdump initrd.
# initrd, typically used to set up access to # Multiple modules can be listed, separated by spaces, and any
# non-boot-path dump targets that might otherwise # dependent modules will automatically be included.
# not be accessible in the kdump environment. Multiple
# modules can be listed, separated by a space, and any
# dependent modules will automatically be included.
# #
# default <reboot | halt | poweroff | shell | dump_to_rootfs> # default <reboot | halt | poweroff | shell | dump_to_rootfs>
# - Action to preform in case dumping to intended target # - Action to perform in case dumping fails.
# fails. If no default action is specified, "reboot" # reboot: Reboot the system.
# is assumed default. # halt: Halt the system.
# reboot: If the default action is reboot simply reboot # poweroff: Power down the system.
# the system and loose the core that you are # shell: Drop to a bash shell.
# trying to retrieve. # Exiting the shell reboots the system.
# halt: If the default action is halt, then simply # dump_to_rootfs: Dump vmcore to rootfs from initramfs context and
# halt the system after attempting to capture # reboot. Useful when non-root dump target is specified.
# a vmcore, regardless of success or failure. # The default option is "reboot".
# poweroff: The system will be powered down
# shell: If the default action is shell, then drop to
# an shell session inside the initramfs from
# where you can try to record the core manually.
# Exiting this shell reboots the system.
# Note: kdump uses bash as the default shell.
# dump_to_rootfs: If non-root dump target is specified,
# the default action can be set as dump_to_rootfs.
# That means when dump to target fails, dump vmcore
# to rootfs from initramfs context and reboot.
# #
# force_rebuild <0 | 1> # force_rebuild <0 | 1>
# - By default, kdump initrd only will be rebuilt when # - By default, kdump initrd will only be rebuilt whennecessary.
# necessary. Specify 1 to force rebuilding kdump # Specify 1 to force rebuilding kdump initrd every time when kdump
# initrd every time when kdump service starts. # service starts.
# #
#override_resettable <0 | 1> # override_resettable <0 | 1>
# - Usually a unresettable block device can't be dump target. # - Usually an unresettable block device can't be a dump target.
# Specifying 1 means though block target is unresettable, user # Specifying 1 when you want to dump even though the block
# understand this situation and want to try dumping. By default, # target is unresettable
# it's set to 0, means not to try a destined failure. # By default, it is 0, which will not try dumping destined to fail.
# #
# dracut_args <arg(s)> # dracut_args <arg(s)>
# - Pass extra dracut options when rebuilding kdump # - Pass extra dracut options when rebuilding kdump initrd.
# initrd.
# #
# fence_kdump_args <arg(s)> # fence_kdump_args <arg(s)>
# - Command line arguments for fence_kdump_send (it can contain # - Command line arguments for fence_kdump_send (it can contain
# all valid arguments except hosts to send notification to). # all valid arguments except hosts to send notification to).
# #
# fence_kdump_nodes <node(s)> # fence_kdump_nodes <node(s)>
# - List of cluster node(s) separated by space to send fence_kdump # - List of cluster node(s), separated by spaces, to send
# notification to (this option is mandatory to enable fence_kdump). # fence_kdump notifications to (this option is mandatory to
# enable fence_kdump).
# #
#raw /dev/vg/lv_kdump #raw /dev/vg/lv_kdump