xCAT/xcat-core
2
0
Fork 0
mirror of https://github.com/xcat2/xcat-core.git synced 2025-05-29 09:13:08 +00:00
Code Issues Releases Wiki Activity

Merge pull request #1338 from penguhyang/debugmode_docs

Browse Source 
update the doc to add description of how to use diskless log
This commit is contained in:
yangsong 2016-06-21 22:12:21 -05:00 committed by GitHub
commit 109e4f93db
1 changed files with 62 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

96
docs/source/troubleshooting/os_installation/log_to_mn_cn.rst
View File

@ -1,51 +1,79 @@
Log Collecting: Collecting logs of the whole installation process
-----------------------------------------------------------------
The ability to collect logs during the installation process can be helpful when debugging installation problems.
The ability to collect logs during the installation(diskfull and diskless) can be enabled by setting the "site.xcatdebugmode" to different levels(0,1,2), which is quite helpful when debugging installation problems.
Pre-Install: the logs of pre-installation scripts, the pre-installation scripts include "%pre" section in anaconda, "<pre-scripts/>" 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"
The logs during diskfull provision:
```````````````````````````````````
Installer: the logs from the os installer itself, i.e, the logs of installation program(anaconda, autoyast and preseed,etc.)
* Pre-Install logs: the logs of pre-installation scripts, the pre-installation scripts include "%pre" section in anaconda, "<pre-scripts/>" 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"
Post-Install: the logs of post-installation scripts, the post-installation scripts include "%post" section in anaconda, "<chroot-scripts/>" and "<post-scripts/>" 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"
* Installer logs: the logs from the os installer itself, i.e, the logs of installation program(anaconda, autoyast and preseed,etc.)
Post-Script: This section is useful for functions such as updating node status. This section contains the postbootscripts.
* Post-Install logs: the logs of post-installation scripts, the post-installation scripts include "%post" section in anaconda, "<chroot-scripts/>" and "<post-scripts/>" 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"
The following behavior is observed during OS install:
* 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 |
+------------------+----+----+----+----+----+----+----+----+----+
| |RHEL|SLES|UBT |RHEL|SLES|UBT |RHEL|SLES|UBT |
+=============+====+====+====+====+====+====+====+====+====+====+
| Pre-Install | MN | N | N | N |
+ log +----+----+----+----+----+----+----+----+----+----+
| | CN | Y1 | Y2 | Y2 |
+-------------+----+----+----+----+----+----+----+----+----+----+
| Installer | MN | N | N | N | Y6 | Y6 | Y6 | Y6 | Y6 | Y6 |
+ log +----+----+----+----+----+----+----+----+----+----+
| | CN | Y5 | Y5 | Y5 | Y5 | Y5 | Y5 | Y5 | Y5 | Y5 |
+-------------+----+----+----+----+----+----+----+----+----+----+
| Post-Install| MN | Y4 | Y3 | Y3 |
+ log +----+----+----+----+----+----+----+----+----+----+
| | CN | Y1 | Y2 | Y2 |
+-------------+----+----+----+----+----+----+----+----+----+----+
| Post-Script | MN | Y4 | Y3 | Y3 |
+ log +----+----+----+----+----+----+----+----+----+----+
| | CN | Y1 | Y2 | Y2 |
+-------------+----+----+----+----+----+----+----+----+----+----+
+------------------------+-----------------------+-----------------------+-----------------------+
| **xcatdebugmode** | 0 | 1 | 2 |
+------------------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
| OS Distribution | RHEL | SLES | UBT | RHEL | SLES | UBT | RHEL | SLES | UBT |
+================+=======+=======+=======+=======+=======+=======+=======+=======+=======+=======+
| Pre-Install | [MN]_ | [N]_ | [N]_ | [N]_ |
+ logs +-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
| | [CN]_ | [Y1]_ | [Y2]_ | [Y2]_ |
+----------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
| Installer | [MN]_ | [N]_ | [N]_ | [N]_ | [Y7]_ | [Y7]_ | [Y7]_ | [Y7]_ | [Y7]_ | [Y7]_ |
+ logs +-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
| | [CN]_ | [Y6]_ | [Y6]_ | [Y6]_ | [Y6]_ | [Y6]_ | [Y6]_ | [Y6]_ | [Y6]_ | [Y6]_ |
+----------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
| Post-Install | [MN]_ | [Y5]_ | [Y3]_ | [Y3]_ |
+ logs +-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
| | [CN]_ | [Y1]_ | [Y2]_ | [Y2]_ |
+----------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
| PostBootScript | [MN]_ | [Y5]_ | [Y3]_ | [Y3]_ |
+ logs +-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
| | [CN]_ | [Y1]_ | [Y2]_ | [Y2]_ |
+----------------+-------+-------+-------+-------+-------+-------+-------+-------+-------+-------+
Y1 means the installation logs can be saved to ``/var/log/xcat/xcat.log`` file on CN.
The logs during diskless provision:
```````````````````````````````````
Y2 means the installation logs and debug trace("set -x" or "-o xtrace") of bash scripts can be saved to ``/var/log/xcat/xcat.log`` file on CN.
* Provision logs: the logs during the diskless provision.
Y3 means the installation logs can be forwarded to ``/var/log/xcat/computes.log`` file on MN.
* 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.
Y4 means the error messages can be forwarded to ``/var/log/xcat/computes.log`` file on MN only when critical error happens.
+------------------------+--------------+--------------+--------------+
| **xcatdebugmode** | 0 | 1 | 2 |
+------------------------+----+----+----+----+----+----+----+----+----+
| OS Distribution |RHEL|SLES|UBT |RHEL|SLES|UBT |RHEL|SLES|UBT |
+================+=======+====+====+====+====+====+====+====+====+====+
| Provision | [MN]_ | [N]_ | [Y3]_ | [Y3]_ |
+ logs +-------+----+----+----+----+----+----+----+----+----+
| | [CN]_ | [N]_ | [N]_ | [N]_ |
+----------------+-------+----+----+----+----+----+----+----+----+----+
| PostBootScript | [MN]_ | [Y3]_ | [Y4]_ | [Y4]_ |
+ logs +-------+----+----+----+----+----+----+----+----+----+
| | [CN]_ | [Y1]_ | [Y2]_ | [Y2]_ |
+----------------+-------+----+----+----+----+----+----+----+----+----+
Y5 means the installer log can be saved to the CN in ``/var/log/anaconda`` for RHEL, ``/var/log/YaST2`` for SLES, ``/var/log/installer`` for UBT.
.. [MN] means the logs forwarded to management node.
Y6 means the installer log can be forwarded to the MN in ``/var/log/xcat/computes.log`` file.
.. [CN] means the logs on compute node.
N means the logs can not be forwarded or saved.
.. [Y1] means the installation logs can be saved to ``/var/log/xcat/xcat.log`` file on CN.
.. [Y2] means the installation logs and debug trace("set -x" or "-o xtrace") of bash scripts can be saved to ``/var/log/xcat/xcat.log`` file on CN.
.. [Y3] means the installation logs can be forwarded to ``/var/log/xcat/computes.log`` file on MN.
.. [Y4] means the installation logs and debug trace("set -x" or "-o xtrace") of bash scripts can be forwarded to ``/var/log/xcat/computes.log`` file on MN.
.. [Y5] means the error messages can be forwarded to ``/var/log/xcat/computes.log`` file on MN only when critical error happens.
.. [Y6] means the installer log can be saved to the CN in ``/var/log/anaconda`` for RHEL, ``/var/log/YaST2`` for SLES, ``/var/log/installer`` for UBT.
.. [Y7] means the installer log can be forwarded to the MN in ``/var/log/xcat/computes.log`` file.
.. [N] means the logs can not be forwarded or saved.