diff --git a/docs/source/guides/admin-guides/manage_clusters/common/deployment/enable_kdump.rst b/docs/source/guides/admin-guides/manage_clusters/common/deployment/enable_kdump.rst index 4152a6cf9..eeafb39b3 100644 --- a/docs/source/guides/admin-guides/manage_clusters/common/deployment/enable_kdump.rst +++ b/docs/source/guides/admin-guides/manage_clusters/common/deployment/enable_kdump.rst @@ -1,2 +1,170 @@ Enable Kdump Over Ethernet ========================== + +Overview +-------- + +kdump 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. + + +xCAT Interface +-------------- + +The pkglist, exclude and postinstall files location and name can be obtained by running the following command: :: + + lsdef -t osimage + +The pkglist file +---------------- + +For RHEL6 and RHEL7, there are two rpm packages for kdump: :: + + kexec-tools + crash + +For SLES11, there are 3 rpm packages for kdump: :: + + kdump + kexec-tools + makedumpfile + +For SLES10, there are 4 rpm packages for kdump: :: + + kernel-kdump + kexec-tools + kdump + makedumpfile + +Setup pkglist +------------- + +Before setting up kdump,the approprite rpms should be added to the pkglist file as found by running: :: + + lsdef -t osimage + +The exclude file +---------------- + +The base diskless image excludes the /boot directory, but it is required for kdump. Update the exlist file and remove the entry for /boot. Then run the packimage or liteimg command to update your image with the changes. + +The postinstall file +-------------------- + +The kdump will create a new initrd which used in the dumping stage. The /tmp or /var/tmp directory will be used as the temporary directory. These 2 directory only are allocated 10M space by default. You need to enlarge it to 200M. + +For RHELS6 or SLES10, modify the postinstall file to increase /tmp space: :: + + tmpfs /var/tmp tmpfs defaults,size=200m 0 2 + +For SLES11, modify the postinstall file to increase /tmp/space: :: + + tmpfs /tmp tmpfs defaults,size=200m 0 2 + +The dump attribute +------------------ + +In order to support kdump, the dump attribute was added into linuximage table, which is used to define the remote path where the crash information should be dumped to. Use the chdef command to change the image's dump attribute using the URI format. :: + + chdef -t osimage dump=nfs:/// + +The can be excluded if the destination NFS server is the service or management node. :: + + chdef -t osimage dump=nfs:/// + +The crashkernelsize attribute +----------------------------- + +For system x machine, on sles10 set the crashkernelsize attribute like this: :: + + chdef -t osimage crashkernelsize=M@16M + +On sles11 and rhels6 set the crashkernelsize attribute like this: :: + + chdef -t osimage crashkernelsize=M + +Where recommended value is 256. For more information about the size can refer to the following information: + ``_. + + ``_. + + ``_. + + ``_. + +For system p machine, set the crashkernelsize attribute to this: :: + + chdef -t osimage crashkernelsize=@32M + +Where recommended value is 256, more information can refer the kdump document for the system x. + +When your node starts, and you get a kdump start error like this: :: + + Your running kernel is using more than 70% of the amount of space you reserved for kdump, you should consider increasing your crashkernel + +You should modify this attribute using this chdef command: :: + + chdef -t osimage crashkernelsize=512M@32M + +If 512M@32M is not large enough, you should change the crashkernelsize larger like 1024M until the error message disappear. + +The enablekdump postscript +-------------------------- + +This postscript enablekdump is used to start the kdump service when the node is booting up. Add it to your nodes list of postscripts by running this command: :: + + chdef -t node -p postscripts=enablekdump + + +Notes +----- + +Currently, only NFS is supported for the setup of kdump. + +If the dump attribute is not set, the kdump service will not be enabled. + +Please make sure the NFS remote path(nfs:///) is exported and it is read-writeable to the node where kdump service is enabled. + +How to trigger kernel panic on Linux +------------------------------------ + +Normally, kernel panic() will trigger booting into capture kernel. Once the kernel panic is triggered, the node will reboot into the capture kernel, and a kernel dump (vmcore) will be automatically saved to the directory on the specified NFS server (). + +#. For RHESL6 the directory is /var/crash/-