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

modified depending on comments

Browse Source
This commit is contained in:
XuWei
2016-10-16 21:38:19 -04:00
parent 73914c339a
commit a459a4a9ec
3 changed files with 13 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/source/advanced/probe/index.rst
View File

@ -1,7 +1,7 @@
xCAT probe
==========
xCAT offers a new tool suite, which called **xCAT probe**, to help customer to probe all the possible issues in xCAT.
To help identify some of the common issues with xCAT, a new tool suite is now available **xCAT probe**.
You can use ``xcatprobe -l`` to list all valid subcommands, output will be as below ::

19
docs/source/advanced/probe/osdeploy.rst
View File

@ -27,16 +27,14 @@ Options:
``-r`` means replay history of OS provision, if no ``-r`` means to do realtime monitor.
This command will do pre-check before realtime monitor and replay history automatically. If all nodes' definition are valid, will run monitor or replay. Or will exit and show error message.
Realtime monitor
----------------
If want to realtime monitor OS provision, please Open 2 terminal windows at least. One is to run ``osdeploy`` command as below ::
To monitor OS provisioning in real time, open at least 2 terminal windows. One to run ``osdeploy`` probe: ::
xcatprobe osdeploy -n cn1 [-V]
after pre-check will wait for provision information and show as below ::
After some pre-checks, the probe will wait for provisioning information, similar to output below: ::
# xcatprobe osdeploy -n c910f03c17k20
The install NIC in current server is enp0s1 [INFO]
@ -45,12 +43,12 @@ after pre-check will wait for provision information and show as below ::
Start capturing every message during OS provision process......
-------------------------------------------------------------
do provision on another terminal window. ::
Open second terminal window to run provisioning: ::
nodeset cn1 osimage=<osimage>
rpower cn1 boot
When all the nodes complete provision, will exit and output summary as below ::
When all the nodes complete provisioning, the probe will exit and display output similar to: ::
# xcatprobe osdeploy -n c910f03c17k20
The install NIC in current server is enp0s1 [INFO]
@ -78,20 +76,19 @@ When all the nodes complete provision, will exit and output summary as below ::
All nodes provisioned successfully [ OK ]
If there is something wrong when provision, will exit when timeout or press ``Ctrl+C`` by user. The maximum time can be set by using ``-t`` as below ::
If there is something wrong when provisioning, this probe will exit when timeout is reachedd or ``Ctrl+C`` is pressed by user. The maximum time can be set by using ``-t`` as below(default 30 minutes) ::
xcatprobe osdeploy -n cn1 -t 30
The maximum time is set to 30 minites.
Replay history
--------------
It want to replay history of OS provision from 1 hour 20 minutes ago, use command as ::
To replay history of OS provision from 1 hour 20 minutes ago, use command as ::
xcatprobe osdeploy -n cn1 -r 1h20m
The outout will be as below ::
Outout will be similar to: ::
# xcatprobe osdeploy -n c910f03c17k20
The install NIC in current server is enp0s1 [INFO]

10
docs/source/advanced/probe/xcatmn.rst
View File

@ -3,7 +3,7 @@ xcatmn
**xcatmn** can be used to check if xcat has been installed correctly and is ready for use.
**Note**: For several check items(eg. tftp service, dns service, http service), 'tftp', 'nslookup' and 'wget' are need. If not be installed, will not check that item and give warning message.
**Note**: For several check items(eg. tftp service, dns service, http service), 'tftp', 'nslookup' and 'wget' are need. If not installed, a warning message will be displayed..
Command is as below ::
@ -16,9 +16,7 @@ For example, run command on Management Node ::
xcatprobe xcatmn -i eth0
**xcatmn** will check xcatd's process, xcat config and xcat service. If the item is ready for xcat use, result label is ``[ OK ]``. If the item is not ready and xcat can not be used, result label is ``[FAIL]``. If the item is not ready but maybe xcat can be used, result label is ``[WARN]``.
Output will be like this ::
Output will be similar to: ::
# xcatprobe xcatmn -i eth0
[MN]: Sub process 'xcatd: SSL listener' is running [ OK ]
@ -51,8 +49,8 @@ Output will be like this ::
======================do summary=====================
[MN]: Check on MN PASS. [ OK ]
**[MN]** means it's MN's check result. When complete all items' check, will show summary to give a conclusion ``PASS`` or ``FAILED``.
**[MN]** means that the verfication is performerd on the Management Node. Overall status of ``PASS`` or ``FAILED`` will be displayed after all items are verified..
For hierarchical clusters, ``xcatmn`` will check Service Node automatically.
Service Nodes are checked automatically for hierarchical clusters.
For Service Nodes, the output will contain ``[SN:nodename]`` to distinguish different Service Nodes.