From 82eba7e520964b794adb74b7740cfc794cf31fc4 Mon Sep 17 00:00:00 2001 From: XuWei Date: Mon, 19 Sep 2016 22:31:35 -0400 Subject: [PATCH 1/6] Add probe docs, some docs' status is TODO --- docs/source/advanced/index.rst | 1 + docs/source/advanced/probe/detect_dhcpd.rst | 6 ++ docs/source/advanced/probe/discovery.rst | 6 ++ docs/source/advanced/probe/image.rst | 4 + docs/source/advanced/probe/index.rst | 25 +++++ docs/source/advanced/probe/osdeploy.rst | 100 +++++++++++++++++++ docs/source/advanced/probe/switch-macmap.rst | 4 + docs/source/advanced/probe/xcatmn.rst | 57 +++++++++++ 8 files changed, 203 insertions(+) create mode 100644 docs/source/advanced/probe/detect_dhcpd.rst create mode 100644 docs/source/advanced/probe/discovery.rst create mode 100644 docs/source/advanced/probe/image.rst create mode 100644 docs/source/advanced/probe/index.rst create mode 100644 docs/source/advanced/probe/osdeploy.rst create mode 100644 docs/source/advanced/probe/switch-macmap.rst create mode 100644 docs/source/advanced/probe/xcatmn.rst diff --git a/docs/source/advanced/index.rst b/docs/source/advanced/index.rst index dacf235d0..7193f3b71 100755 --- a/docs/source/advanced/index.rst +++ b/docs/source/advanced/index.rst @@ -16,6 +16,7 @@ Advanced Topics mixed_cluster/index.rst networks/index.rst ports/xcat_ports.rst + probe/index.rst raid/index.rst restapi/index.rst security/index.rst diff --git a/docs/source/advanced/probe/detect_dhcpd.rst b/docs/source/advanced/probe/detect_dhcpd.rst new file mode 100644 index 000000000..f6fe1ac17 --- /dev/null +++ b/docs/source/advanced/probe/detect_dhcpd.rst @@ -0,0 +1,6 @@ +detect_dhcpd +============ + +**detect_dhcp** can be used to detect the dhcp server in a network for a specific mac address. + +**TODO** diff --git a/docs/source/advanced/probe/discovery.rst b/docs/source/advanced/probe/discovery.rst new file mode 100644 index 000000000..68c3ecc12 --- /dev/null +++ b/docs/source/advanced/probe/discovery.rst @@ -0,0 +1,6 @@ +discovery +========= + +**discovery** can be used to probe the discovery process, including pre-check for required configuration and realtime monitor of discovery process. + +**TODO** diff --git a/docs/source/advanced/probe/image.rst b/docs/source/advanced/probe/image.rst new file mode 100644 index 000000000..0d7af57ba --- /dev/null +++ b/docs/source/advanced/probe/image.rst @@ -0,0 +1,4 @@ +image +===== + +**TODO** diff --git a/docs/source/advanced/probe/index.rst b/docs/source/advanced/probe/index.rst new file mode 100644 index 000000000..74da5e1e7 --- /dev/null +++ b/docs/source/advanced/probe/index.rst @@ -0,0 +1,25 @@ +xCAT probe +========== + +xCAT offers a tool **probe** to help customer to use xCAT. + +You can use ``xcatprobe -l`` to list all valid subcommand, output will be as below :: + + osdeploy Probe for OS provision process, realtime monitor of OS provision process. + xcatmn After xcat installation, use this command to check if xcat has been installed correctly and is + ready for use. Before using this command, install 'tftp', 'nslookup' and 'wget' commands. + switch-macmap To retrieve MAC address mapping for the specified switch, or all the switches defined in + 'switches' table in xCAT db. + ...... + +.. toctree:: + :maxdepth: 2 + + xcatmn.rst + detect_dhcpd.rst + image.rst + osdeploy.rst + discovery.rst + switch-macmap.rst + + diff --git a/docs/source/advanced/probe/osdeploy.rst b/docs/source/advanced/probe/osdeploy.rst new file mode 100644 index 000000000..3afa37760 --- /dev/null +++ b/docs/source/advanced/probe/osdeploy.rst @@ -0,0 +1,100 @@ +osdeploy +======== + +**osdeploy** can be used to probe OS provision process. Realtime monitor or replay history of OS provision process. + +If realtime monitor, run this command before ``rpower`` node(including the command rpower node indirectly, e.g ``rinstall``, ``rnetboot``). + +**Note**: Currently, hierarchical structure is not supported. + +Usage +----- + +:: + + xcatprobe osdeploy -h + xcatprobe osdeploy -n [-V] + xcatprobe osdeploy -n -r [-V] + +Options: + +* **-n**: The range of nodes for monitor or replay log. +* **-r**: Replay history log for probe provisioniong. Input a start time when probe should begin. Supported time formats are ``xxhxxm``, ``xxh``, or ``xxm``. If units not specified, hour will be used by default. +* **-t**: The maximum time in minutes to wait when doing monitor, default is 60. +* **-V**: Output more information for debug. + +``-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 :: + + xcatprobe osdeploy -n cn1 [-V] + +after pre-check will wait for provision information and show as below :: + + # xcatprobe osdeploy -n c910f03c17k20 + The install NIC in current server is enp0s1 [INFO] + All nodes which will be deployed are valid [ OK ] + ------------------------------------------------------------- + Start capturing every message during OS provision process...... + ------------------------------------------------------------- + +do provision on another terminal window. :: + + nodeset cn1 osimage= + rpower cn1 boot + +When all the nodes complete provision, will exit and output summary as below :: + + # xcatprobe osdeploy -n c910f03c17k20 + The install NIC in current server is enp0s1 [INFO] + All nodes which will be deployed are valid [ OK ] + ------------------------------------------------------------- + Start capturing every message during OS provision process...... + ------------------------------------------------------------- + + [c910f03c17k20] Use command rinstall to reboot node c910f03c17k20 + [c910f03c17k20] Node status is changed to powering-on + [c910f03c17k20] Receive DHCPDISCOVER via enp0s1 + [c910f03c17k20] Send DHCPOFFER on 10.3.17.20 back to 42:d0:0a:03:11:14 via enp0s1 + [c910f03c17k20] DHCPREQUEST for 10.3.17.20 (10.3.5.4) from 42:d0:0a:03:11:14 via enp0s1 + [c910f03c17k20] Send DHCPACK on 10.3.17.20 back to 42:d0:0a:03:11:14 via enp0s1 + [c910f03c17k20] Via TFTP download /boot/grub2/grub2-c910f03c17k20 + [c910f03c17k20] Via TFTP download /boot/grub2/powerpc-ieee1275/normal.mod + ...... + [c910f03c17k20] Postscript: otherpkgs exited with code 0 + [c910f03c17k20] Node status is changed to booted + [c910f03c17k20] done + [c910f03c17k20] provision completed.(c910f03c17k20) + [c910f03c17k20] provision completed [ OK ] + All nodes specified to monitor, have finished OS provision process [ OK ] + ==================conclusion_report================= + All nodes provision 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 :: + + 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 :: + + xcatprobe osdeploy -n cn1 -r 1h20m + +The outout will be as below :: + + # xcatprobe osdeploy -n c910f03c17k20 + The install NIC in current server is enp0s1 [INFO] + All nodes which will be deployed are valid [ OK ] + Start to scan logs which are later than *********, waiting for a while............. + ==================conclusion_report================= + All nodes provision successfully [ OK ] + diff --git a/docs/source/advanced/probe/switch-macmap.rst b/docs/source/advanced/probe/switch-macmap.rst new file mode 100644 index 000000000..ffd57a92f --- /dev/null +++ b/docs/source/advanced/probe/switch-macmap.rst @@ -0,0 +1,4 @@ +switch-macmap +============= + +**TODO** diff --git a/docs/source/advanced/probe/xcatmn.rst b/docs/source/advanced/probe/xcatmn.rst new file mode 100644 index 000000000..750c6752e --- /dev/null +++ b/docs/source/advanced/probe/xcatmn.rst @@ -0,0 +1,57 @@ +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. + +Command is as below :: + + xcatprobe xcatmn -i [-V] + +* **-i**: [Required] Specify the network interface name of provision network on management node. +* **-V**: Output more information for debug. + +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 :: + + [MN]: Sub process 'xcatd: SSL listener' is running [ OK ] + [MN]: Sub process 'xcatd: DB Access' is running [ OK ] + [MN]: Sub process 'xcatd: UDP listener' is running [ OK ] + [MN]: Sub process 'xcatd: install monitor' is running [ OK ] + [MN]: Sub process 'xcatd: Discovery worker' is running [ OK ] + [MN]: Sub process 'xcatd: Command log writer' is running [ OK ] + [MN]: xcatd is listening on port 3001 [ OK ] + [MN]: xcatd is listening on port 3002 [ OK ] + [MN]: 'lsxcatd -a' works [ OK ] + [MN]: The value of 'master' in 'site' table is an IP address [ OK ] + [MN]: NIC enp0s1 exists on current server [ OK ] + [MN]: Get IP address of NIC eth0 [ OK ] + [MN]: The IP *.*.*.* of eth0 equals the value of 'master' in 'site' table [ OK ] + [MN]: IP *.*.*.* of NIC eth0 is a static IP on current server [ OK ] + [MN]: *.*.*.* belongs to one of networks defined in 'networks' table [ OK ] + [MN]: There is domain definition in 'site' table [ OK ] + [MN]: There is a configuration in 'passwd' table for 'system' for node provisioning [ OK ] + [MN]: There is /install directory on current server [ OK ] + [MN]: There is /tftpboot directory on current server [ OK ] + [MN]: The free space of '/' is less than 12 G [ OK ] + [MN]: SELinux is disabled on current server [ OK ] + [MN]: Firewall is closed on current server [ OK ] + [MN]: HTTP service is ready on *.*.*.* [ OK ] + [MN]: TFTP service is ready on *.*.*.* [ OK ] + [MN]: DNS server is ready on *.*.*.* [ OK ] + [MN]: The size of /var/lib/dhcpd/dhcpd.leases is less than 100M [ OK ] + [MN]: DHCP service is ready on *.*.*.* [ OK ] + ======================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``. + +For hierarchical clusters, ``xcatmn`` will check Service Node automatically. + +For Service Nodes, the output will contain ``[SN:nodename]`` to distinguish different Service Nodes. From 037a250ab83bb099fb7b6d1c3f77756ee243f76d Mon Sep 17 00:00:00 2001 From: XuWei Date: Tue, 20 Sep 2016 21:32:53 -0400 Subject: [PATCH 2/6] modified depending on comments --- docs/source/advanced/probe/index.rst | 3 ++- docs/source/advanced/probe/xcatmn.rst | 1 + 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/advanced/probe/index.rst b/docs/source/advanced/probe/index.rst index 74da5e1e7..ba35db10a 100644 --- a/docs/source/advanced/probe/index.rst +++ b/docs/source/advanced/probe/index.rst @@ -1,10 +1,11 @@ xCAT probe ========== -xCAT offers a tool **probe** to help customer to use xCAT. +xCAT offers a new tool suite, which called **xCAT probe**, to help customer to probe all the possible issues in xCAT. You can use ``xcatprobe -l`` to list all valid subcommand, output will be as below :: + # xcatprobe -l osdeploy Probe for OS provision process, realtime monitor of OS provision process. xcatmn After xcat installation, use this command to check if xcat has been installed correctly and is ready for use. Before using this command, install 'tftp', 'nslookup' and 'wget' commands. diff --git a/docs/source/advanced/probe/xcatmn.rst b/docs/source/advanced/probe/xcatmn.rst index 750c6752e..5a052ee2d 100644 --- a/docs/source/advanced/probe/xcatmn.rst +++ b/docs/source/advanced/probe/xcatmn.rst @@ -20,6 +20,7 @@ For example, run command on Management Node :: Output will be like this :: + # xcatprobe xcatmn -i eth0 [MN]: Sub process 'xcatd: SSL listener' is running [ OK ] [MN]: Sub process 'xcatd: DB Access' is running [ OK ] [MN]: Sub process 'xcatd: UDP listener' is running [ OK ] From 2adcf733f1a9bdd64fffc26758a0b74770818670 Mon Sep 17 00:00:00 2001 From: XuWei Date: Wed, 21 Sep 2016 04:19:22 -0400 Subject: [PATCH 3/6] modified depending usage --- docs/source/advanced/probe/osdeploy.rst | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/docs/source/advanced/probe/osdeploy.rst b/docs/source/advanced/probe/osdeploy.rst index 3afa37760..58efa8d90 100644 --- a/docs/source/advanced/probe/osdeploy.rst +++ b/docs/source/advanced/probe/osdeploy.rst @@ -1,9 +1,11 @@ osdeploy ======== -**osdeploy** can be used to probe OS provision process. Realtime monitor or replay history of OS provision process. - -If realtime monitor, run this command before ``rpower`` node(including the command rpower node indirectly, e.g ``rinstall``, ``rnetboot``). +**osdeploy** operating system provision process. Supports two modes - 'Realtime monitor' and 'Replay history'. + +Realtime monitor: This is a default. This tool with monitor provision state of the node. Trigger 'Realtime monitor' before rebooting target node to do provisioning. + +Replay history: Used after provisioning is finished to probe the previously completed provisioning. **Note**: Currently, hierarchical structure is not supported. @@ -13,15 +15,15 @@ Usage :: xcatprobe osdeploy -h - xcatprobe osdeploy -n [-V] + xcatprobe osdeploy -n [-t ] [-V] xcatprobe osdeploy -n -r [-V] Options: -* **-n**: The range of nodes for monitor or replay log. -* **-r**: Replay history log for probe provisioniong. Input a start time when probe should begin. Supported time formats are ``xxhxxm``, ``xxh``, or ``xxm``. If units not specified, hour will be used by default. -* **-t**: The maximum time in minutes to wait when doing monitor, default is 60. -* **-V**: Output more information for debug. +* **-n**: The range of nodes to be monitored or replayed. +* **-r**: Trigger 'Replay history' mode. Follow the duration of rolling back. Units are 'h' (hour) or 'm' (minute). If unit is not specified, hour will be used by default. +* **-t**: The maximum time to wait when doing monitor, unit is minutes. default is 60. +* **-V**: Output more information. ``-r`` means replay history of OS provision, if no ``-r`` means to do realtime monitor. From 80cefd327b8e89f05f1f1732bfa98a6cff91199c Mon Sep 17 00:00:00 2001 From: XuWei Date: Tue, 11 Oct 2016 02:44:57 -0400 Subject: [PATCH 4/6] modified depending on comments --- docs/source/advanced/probe/index.rst | 2 +- docs/source/advanced/probe/osdeploy.rst | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/source/advanced/probe/index.rst b/docs/source/advanced/probe/index.rst index ba35db10a..371ff79ef 100644 --- a/docs/source/advanced/probe/index.rst +++ b/docs/source/advanced/probe/index.rst @@ -6,7 +6,7 @@ xCAT offers a new tool suite, which called **xCAT probe**, to help customer to p You can use ``xcatprobe -l`` to list all valid subcommand, output will be as below :: # xcatprobe -l - osdeploy Probe for OS provision process, realtime monitor of OS provision process. + osdeploy Probe operating system provision process. Supports two modes - 'Realtime monitor' and 'Replay history'. xcatmn After xcat installation, use this command to check if xcat has been installed correctly and is ready for use. Before using this command, install 'tftp', 'nslookup' and 'wget' commands. switch-macmap To retrieve MAC address mapping for the specified switch, or all the switches defined in diff --git a/docs/source/advanced/probe/osdeploy.rst b/docs/source/advanced/probe/osdeploy.rst index 58efa8d90..aadf8e575 100644 --- a/docs/source/advanced/probe/osdeploy.rst +++ b/docs/source/advanced/probe/osdeploy.rst @@ -74,8 +74,8 @@ When all the nodes complete provision, will exit and output summary as below :: [c910f03c17k20] provision completed.(c910f03c17k20) [c910f03c17k20] provision completed [ OK ] All nodes specified to monitor, have finished OS provision process [ OK ] - ==================conclusion_report================= - All nodes provision successfully [ OK ] + ==================osdeploy_probe_report================= + 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 :: @@ -97,6 +97,6 @@ The outout will be as below :: The install NIC in current server is enp0s1 [INFO] All nodes which will be deployed are valid [ OK ] Start to scan logs which are later than *********, waiting for a while............. - ==================conclusion_report================= - All nodes provision successfully [ OK ] + ==================osdeploy_probe_report================= + All nodes provisioned successfully [ OK ] From 73914c339a11f87ecca3ed01ba0357561616f571 Mon Sep 17 00:00:00 2001 From: XuWei Date: Tue, 11 Oct 2016 21:21:45 -0400 Subject: [PATCH 5/6] modified depending on comments --- docs/source/advanced/probe/detect_dhcpd.rst | 1 - docs/source/advanced/probe/discovery.rst | 1 - docs/source/advanced/probe/image.rst | 1 - docs/source/advanced/probe/index.rst | 5 +++-- docs/source/advanced/probe/nodecheck.rst | 2 ++ docs/source/advanced/probe/osimagecheck.rst | 2 ++ docs/source/advanced/probe/switch-macmap.rst | 1 - 7 files changed, 7 insertions(+), 6 deletions(-) create mode 100644 docs/source/advanced/probe/nodecheck.rst create mode 100644 docs/source/advanced/probe/osimagecheck.rst diff --git a/docs/source/advanced/probe/detect_dhcpd.rst b/docs/source/advanced/probe/detect_dhcpd.rst index f6fe1ac17..fe7449497 100644 --- a/docs/source/advanced/probe/detect_dhcpd.rst +++ b/docs/source/advanced/probe/detect_dhcpd.rst @@ -3,4 +3,3 @@ detect_dhcpd **detect_dhcp** can be used to detect the dhcp server in a network for a specific mac address. -**TODO** diff --git a/docs/source/advanced/probe/discovery.rst b/docs/source/advanced/probe/discovery.rst index 68c3ecc12..611dba27e 100644 --- a/docs/source/advanced/probe/discovery.rst +++ b/docs/source/advanced/probe/discovery.rst @@ -3,4 +3,3 @@ discovery **discovery** can be used to probe the discovery process, including pre-check for required configuration and realtime monitor of discovery process. -**TODO** diff --git a/docs/source/advanced/probe/image.rst b/docs/source/advanced/probe/image.rst index 0d7af57ba..31d20dbfa 100644 --- a/docs/source/advanced/probe/image.rst +++ b/docs/source/advanced/probe/image.rst @@ -1,4 +1,3 @@ image ===== -**TODO** diff --git a/docs/source/advanced/probe/index.rst b/docs/source/advanced/probe/index.rst index 371ff79ef..0fd687cdc 100644 --- a/docs/source/advanced/probe/index.rst +++ b/docs/source/advanced/probe/index.rst @@ -3,7 +3,7 @@ xCAT probe xCAT offers a new tool suite, which called **xCAT probe**, to help customer to probe all the possible issues in xCAT. -You can use ``xcatprobe -l`` to list all valid subcommand, output will be as below :: +You can use ``xcatprobe -l`` to list all valid subcommands, output will be as below :: # xcatprobe -l osdeploy Probe operating system provision process. Supports two modes - 'Realtime monitor' and 'Replay history'. @@ -22,5 +22,6 @@ You can use ``xcatprobe -l`` to list all valid subcommand, output will be as bel osdeploy.rst discovery.rst switch-macmap.rst - + nodecheck.rst + osimagecheck.rst diff --git a/docs/source/advanced/probe/nodecheck.rst b/docs/source/advanced/probe/nodecheck.rst new file mode 100644 index 000000000..479846e75 --- /dev/null +++ b/docs/source/advanced/probe/nodecheck.rst @@ -0,0 +1,2 @@ +nodecheck +========= diff --git a/docs/source/advanced/probe/osimagecheck.rst b/docs/source/advanced/probe/osimagecheck.rst new file mode 100644 index 000000000..9bf8d6c81 --- /dev/null +++ b/docs/source/advanced/probe/osimagecheck.rst @@ -0,0 +1,2 @@ +osimagecheck +============ diff --git a/docs/source/advanced/probe/switch-macmap.rst b/docs/source/advanced/probe/switch-macmap.rst index ffd57a92f..bf600a239 100644 --- a/docs/source/advanced/probe/switch-macmap.rst +++ b/docs/source/advanced/probe/switch-macmap.rst @@ -1,4 +1,3 @@ switch-macmap ============= -**TODO** From a459a4a9eca4208148fc6eec756f83083e3dd2aa Mon Sep 17 00:00:00 2001 From: XuWei Date: Sun, 16 Oct 2016 21:38:19 -0400 Subject: [PATCH 6/6] modified depending on comments --- docs/source/advanced/probe/index.rst | 2 +- docs/source/advanced/probe/osdeploy.rst | 19 ++++++++----------- docs/source/advanced/probe/xcatmn.rst | 10 ++++------ 3 files changed, 13 insertions(+), 18 deletions(-) diff --git a/docs/source/advanced/probe/index.rst b/docs/source/advanced/probe/index.rst index 0fd687cdc..4e6932de7 100644 --- a/docs/source/advanced/probe/index.rst +++ b/docs/source/advanced/probe/index.rst @@ -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 :: diff --git a/docs/source/advanced/probe/osdeploy.rst b/docs/source/advanced/probe/osdeploy.rst index aadf8e575..546d33198 100644 --- a/docs/source/advanced/probe/osdeploy.rst +++ b/docs/source/advanced/probe/osdeploy.rst @@ -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= 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] diff --git a/docs/source/advanced/probe/xcatmn.rst b/docs/source/advanced/probe/xcatmn.rst index 5a052ee2d..c692e6a98 100644 --- a/docs/source/advanced/probe/xcatmn.rst +++ b/docs/source/advanced/probe/xcatmn.rst @@ -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.