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