From 28bb64214488f1994420aaa984c41fb6e0057e05 Mon Sep 17 00:00:00 2001 From: Mark Gurevich Date: Thu, 30 Jun 2016 14:44:50 -0400 Subject: [PATCH] Suggested improvements --- docs/source/troubleshooting/index.rst | 2 +- .../os_installation/debug_port.rst | 12 ++--- .../troubleshooting/os_installation/index.rst | 6 +-- .../os_installation/log_to_mn_cn.rst | 46 +++++++++++-------- 4 files changed, 33 insertions(+), 33 deletions(-) diff --git a/docs/source/troubleshooting/index.rst b/docs/source/troubleshooting/index.rst index cc481d124..d8f69a11b 100644 --- a/docs/source/troubleshooting/index.rst +++ b/docs/source/troubleshooting/index.rst @@ -1,7 +1,7 @@ Troubleshooting =============== -This chapter introduces the methods of troubleshooting a real cluster. It includes the following parts. +This chapter introduces the methods of troubleshooting a xCAT cluster. It includes the following parts. .. toctree:: :maxdepth: 2 diff --git a/docs/source/troubleshooting/os_installation/debug_port.rst b/docs/source/troubleshooting/os_installation/debug_port.rst index e7264b252..f5d043892 100644 --- a/docs/source/troubleshooting/os_installation/debug_port.rst +++ b/docs/source/troubleshooting/os_installation/debug_port.rst @@ -7,15 +7,9 @@ xCAT creates a server in the **installer**, listening on port ``3001``. It execu The command ``runcmdinstaller`` can be used to send request to installer: -Usage: :: +Usage: ``runcmdinstaller ""`` - runcmdinstaller "" +Note: Make sure all the commands are quoted by ``""`` -make sure all the commands are quoted by ``""`` - -Example: - -To list all the items under the /etc directory in the installer :: - - runcmdinstaller c910f03c01p03 "ls /etc" +To list all the items under the /etc directory in the installer: ``runcmdinstaller c910f03c01p03 "ls /etc"`` diff --git a/docs/source/troubleshooting/os_installation/index.rst b/docs/source/troubleshooting/os_installation/index.rst index 4330f5080..6a263c5f3 100644 --- a/docs/source/troubleshooting/os_installation/index.rst +++ b/docs/source/troubleshooting/os_installation/index.rst @@ -5,9 +5,9 @@ The ability to access the installer or to collect logs during the installation p A new attribute is provided in the **site** table called ``xcatdebugmode``. -* xcatdebugmode=0: Diagnose Log will be shown in corresponding files. -* xcatdebugmode=1: Diagnose Log will be shown in corresponding files and debug port will be opened. -* xcatdebugmode=2: Diagnose Log will be shown in corresponding files, debug port will be opened and SSH access is enabled. +* xcatdebugmode=0: Diagnostic entries will be shown in corresponding log files. +* xcatdebugmode=1: Diagnostic entries will be shown in corresponding log files and debug port will be opened. +* xcatdebugmode=2: Diagnostic entries will be shown in corresponding log files, debug port will be opened and SSH access is enabled. Supported OS: diff --git a/docs/source/troubleshooting/os_installation/log_to_mn_cn.rst b/docs/source/troubleshooting/os_installation/log_to_mn_cn.rst index 334ad5274..007142084 100644 --- a/docs/source/troubleshooting/os_installation/log_to_mn_cn.rst +++ b/docs/source/troubleshooting/os_installation/log_to_mn_cn.rst @@ -3,17 +3,8 @@ Log Collection: Collecting logs of the whole installation process The ability to collect logs during the installation (diskful and diskless) can be enabled by setting the "site.xcatdebugmode" to different levels (0,1,2), which is quite helpful when debugging installation problems. -The logs during diskful provision: +The diskful provision logs: `````````````````````````````````` - -* Pre-Install logs: the logs of pre-installation scripts, the pre-installation scripts include "%pre" section in anaconda, "" section for SUSE and "partman/early_command" and "preseed/early_command" sections for ubuntu. The logs include the STDOUT and STDERR of the scripts as well as the debug trace output of bash scripts with "set -x" - -* Installer logs: the logs from the os installer itself, i.e, the logs of installation program (anaconda, autoyast and preseed,etc.) - -* Post-Install logs: the logs of post-installation scripts, the post-installation scripts include "%post" section in anaconda, "" and "" sections for SUSE and "preseed/late_command" section for ubuntu. The logs include the STDOUT and STDERR of the scripts as well as the debug trace output of bash scripts with "set -x" - -* PostBootScript logs: the logs during the post boot scripts execution, which are specified in "postbootscripts" attribute of node and osimage definition and run during the 1st reboot after installation. - +---------------------+--------------+--------------+--------------+ | **xcatdebugmode** | 0 | 1 | 2 | +---------------------+----+----+----+----+----+----+----+----+----+ @@ -36,13 +27,8 @@ The logs during diskful provision: | | CN | C1 | C1 C2 | C1 C2 | +----------------+----+----+----+----+----+----+----+----+----+----+ -The logs during diskless provision: +The diskless provision logs: ``````````````````````````````````` - -* Provision logs: the logs during the diskless provision. - -* PostBootScript logs: the logs during the post boot scripts execution, which are specified in "postbootscripts" attribute of node and osimage definition and run during the 1st reboot after installation. - +---------------------+--------------+--------------+--------------+ | **xcatdebugmode** | 0 | 1 | 2 | +---------------------+----+----+----+----+----+----+----+----+----+ @@ -57,7 +43,27 @@ The logs during diskless provision: | | CN | C1 | C1 C2 | C1 C2 | +----------------+----+----+----+----+----+----+----+----+----+----+ -MN: the logs forwarded to management node (M1-M4 is the operation for MN). +* **Pre-Install** logs: the logs of pre-installation scripts, including: + + * ``%pre`` section in anaconda, + * ```` section for SUSE and ``partman/early_command`` and ``preseed/early_command`` sections for ubuntu. + * STDOUT and STDERR of the scripts + * debug trace output of bash scripts with ``set -x`` + +* **Installer** logs: the logs from the os installer itself, i.e, the logs of installation program (anaconda, autoyast and preseed,etc.) + +* **Post-Install** logs: the logs of post-installation scripts, including + + * ``%post`` section in anaconda, + * ```` and ```` sections for SUSE and ``preseed/late_command`` section for ubuntu. + * STDOUT and STDERR of the scripts + * debug trace output of bash scripts with ``set -x`` + +* **Provision** logs: the logs during the diskless provision. + +* **PostBootScript** logs: the logs during the post boot scripts execution, which are specified in ``postbootscripts`` attribute of node and osimage definition and run during the 1st reboot after installation. + +MN: the logs forwarded to management node: * M1: the installer logs will be forwarded to the MN in ``/var/log/xcat/computes.log`` file. @@ -65,15 +71,15 @@ MN: the logs forwarded to management node (M1-M4 is the operation for MN). * M3: the installation logs will be forwarded to ``/var/log/xcat/computes.log`` file on MN. -* M4: the debug trace("set -x" or "-o xtrace") of bash scripts enabled. +* M4: the debug trace(``set -x`` or ``-o xtrace``) of bash scripts enabled. * N: the logs will not be forwarded to MN. -CN: the logs on compute node (C1-C3 is the operation for CN). +CN: the logs on compute node: * C1 - the installation logs will be saved to ``/var/log/xcat/xcat.log`` file on CN. -* C2 - the debug trace("set -x" or "-o xtrace") of bash scripts enabled. +* C2 - the debug trace(``set -x`` or ``-o xtrace``) of bash scripts enabled. * C3 - the installer logs will be saved to the CN in ``/var/log/anaconda`` for RHEL, ``/var/log/YaST2`` for SLES, ``/var/log/installer`` for UBT.