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

Doc fixes for xcatperftest and bmcdiscover (#5876)

Browse Source 
* Doc fixes for xcatperftest and bmcdiscover

* Fixes after review

* example command change
This commit is contained in:
Mark Gurevich
2018-12-11 22:25:42 -05:00
committed by Bin Xu
parent 661c187c57
commit 3dc1f0f72e
4 changed files with 64 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/source/guides/admin-guides/references/man1/bmcdiscover.1.rst
View File

@ -48,13 +48,13 @@ OPTIONS
\ **-**\ **-range**\
Specify one or more IP ranges acceptable to nmap. IP range can be hostnames, IP addresses, networks, etc. A single IP address (10.1.2.3), several IPs with commas (10.1.2.3,10.1.2.10), Ip range with "-" (10.1.2.0-100) or an IP range (10.1.2.0/24) can be specified. If the range is very large, the \ **bmcdiscover**\ command may take a long time to return.
Specify one or more IP ranges acceptable to \ **nmap**\ . IP range can be hostnames, IP addresses, networks, etc. A single IP address (10.1.2.3), several IPs with commas (10.1.2.3,10.1.2.10), Ip range with "-" (10.1.2.0-100) or an IP range (10.1.2.0/24) can be specified. If the range is very large, the \ **bmcdiscover**\ command may take a long time to return.
\ **-**\ **-sn**\
Specify one or more service nodes on which bmcdiscover will run. In hierarchical cluster, the MN may not be able to access the BMC of CN directly, but SN can. With this option, bmcdiscover will be dispatched to the specified SNs. Then, the nodename of the service node that 'bmcdiscover' is running on will be set to the 'servicenode' attribute of the discovered BMC node.
Specify one or more service nodes on which bmcdiscover will run. In hierarchical cluster, the MN may not be able to access the BMC of CN directly, but SN can. With this option, \ **bmcdiscover**\ will be dispatched to the specified SNs. Then, the nodename of the service node that \ **bmcdiscover**\ is running on will be set to the 'servicenode' attribute of the discovered BMC node.
@ -163,7 +163,7 @@ Output is similar to:
conserver=sn01
4. Discover the BMCs and write the discovered-node definitions into the xCAT database and write out the stanza foramt to the console:
4. Discover the BMCs and write the discovered node definitions into the xCAT database and write out the stanza format to the console:
.. code-block:: perl

50
docs/source/guides/admin-guides/references/man1/xcatperftest.1.rst
View File

@ -21,6 +21,8 @@ SYNOPSIS
\ **xcatperftest**\ [\ **-?|-h**\ ]
[\ **PERF_DRYRUN**\ =y] \ **xcatperftest run**\ [\ *command-list-file*\ ]
[\ **PERF_DRYRUN**\ =y] [\ **PERF_NOCREATE**\ =y] \ **xcatperftest**\ <total> [\ *command-list-file*\ ]
@ -29,23 +31,23 @@ DESCRIPTION
***********
The xcatperftest command runs commandes defined in a command list file and get their execution response time baseline for performance purpose.
The xcatperftest command is part of the xCAT package xCAT-test, and you can run it standalone or leverage it to build up your automation test cases.
The \ **xcatperftest**\ command runs commands defined in a command list file and get their execution response time baseline for performance purpose.
The \ **xcatperftest**\ command is part of the xCAT package \ **xCAT-test**\ , and you can run it standalone or leverage it to build up your automation test cases.
Any commands could be defined in the command list file, however, it is recommended that the one-time initial configuration are well prepared prior to run xcatperftest command.
For example, the network object, osdistor and osimage image objects.
Any command could be defined in the command list file, however, it is recommended that the one-time initial configuration is well prepared prior to running \ **xcatperftest**\ command.
For example, the network object, osdistro and osimage image objects.
Follow the below steps to run xcatperftest command:
Follow the steps below to run \ **xcatperftest**\ command:
1, Install xCAT-test on a xCAT management nodes.
1. Install \ **xCAT-test**\ on a xCAT management node.
2, Prepare a command list in which the commands are what you want to messure.
2. Prepare a command list with the commands you want to measure.
3, Prepare the initial configuration based on the command list to make sure all commands could be executed in techinal.
3. Prepare the initial configuration based on the command list to make sure all commands could be executed in techinal.
4, Run xcatperftest with the total fake nodes number and the above command list file.
4. Run \ **xcatperftest**\ with the total fake nodes number and the above command list file.
Node: It is suggested to run the command in background as it normally takes long time to finish all the performanc testing with large amount of fake nodes.
Node: It is suggested to run the command in background as it normally takes long time to finish all the performance testing with large amount of fake nodes.
*******
@ -60,7 +62,7 @@ OPTIONS
<command-list-file>
\ *command-list-file*\
Specifies the command list file with full-path. xCAT supports an example command file: /opt/xcat/share/xcat/tools/autotest/perfcmds.lst
@ -88,7 +90,7 @@ COMMAND LIST FILE
*****************
The command list file is in flat text format, the testing framework will parse the file line by line, here is an example of the commannd list file:
The command list file is in flat text format, the testing framework will parse the file line by line, here is an example of the command list file:
.. code-block:: perl
@ -110,13 +112,13 @@ The command list file is in flat text format, the testing framework will parse t
\ **Note**\ : Each line defines one command, and the commands dependency should be handled by the line order.
If you define a node range series line (started with #SERIES#) in this file, xcatperftest will run the command for each node range defined in series line.
If you define a node range series line (started with \ **#SERIES#**\ ) in this file, xcatperftest will run the command for each node range defined in series line.
\ **#SERIES#**\ To define a node range series, and the series should be an comma split incremental number sequence.
\ **#STANZ#**\ It will be replaced with real stanz file path when this command line runs.
\ **#NODES#**\ It will be replaced with real node range defined in #SERIES# line when this command line runs. If no series line, the node group will be used.
\ **#NODES#**\ It will be replaced with real node range defined in \ **#SERIES#**\ line when this command line runs. If no series line, the node group will be used.
\ **#PERFGRP#**\ It will be replaced with node group when this command line runs.
@ -126,7 +128,7 @@ ENVIRONMENT VARIABLE
********************
The xcatperftest command supports be customized by some environment variables.
The \ **xcatperftest**\ command supports customization by some environment variables.
\ **FAKE_NODE_PREFIX**\
@ -148,15 +150,15 @@ It must be a string like 'A.B' and no need to be defined in 'networks' table.
\ **PERF_NODETEMPL**\
Optional, The node template name used for generating fake nodes. By default, it will be auto-detected according to the current arch.
Optional, the node template name used for generating fake nodes. By default, it will be auto-detected according to the current arch.
\ **PERF_DRYRUN**\
Optional, Indicate no real commands will be executed if the environment variable is set.
Optional, indicate no real commands will be executed if the environment variable is set.
\ **PERF_NOCREATE**\
Optional, Indicate no new fake nodes will be created if the environment variable is set.
Optional, indicate no new fake nodes will be created if the environment variable is set.
********
@ -201,6 +203,18 @@ EXAMPLES
4.
To run the performance testing for the commands defined in /tmp/cmd.lst in existing xCAT environment:
.. code-block:: perl
xcatperftest run /tmp/cmd.lst
*****
FILES

6
xCAT-client/pods/man1/bmcdiscover.1.pod
View File

@ -27,11 +27,11 @@ Note: The scan method currently support is B<nmap>.
=item B<--range>
Specify one or more IP ranges acceptable to nmap. IP range can be hostnames, IP addresses, networks, etc. A single IP address (10.1.2.3), several IPs with commas (10.1.2.3,10.1.2.10), Ip range with "-" (10.1.2.0-100) or an IP range (10.1.2.0/24) can be specified. If the range is very large, the B<bmcdiscover> command may take a long time to return.
Specify one or more IP ranges acceptable to B<nmap>. IP range can be hostnames, IP addresses, networks, etc. A single IP address (10.1.2.3), several IPs with commas (10.1.2.3,10.1.2.10), Ip range with "-" (10.1.2.0-100) or an IP range (10.1.2.0/24) can be specified. If the range is very large, the B<bmcdiscover> command may take a long time to return.
=item B<--sn>
Specify one or more service nodes on which bmcdiscover will run. In hierarchical cluster, the MN may not be able to access the BMC of CN directly, but SN can. With this option, bmcdiscover will be dispatched to the specified SNs. Then, the nodename of the service node that 'bmcdiscover' is running on will be set to the 'servicenode' attribute of the discovered BMC node.
Specify one or more service nodes on which bmcdiscover will run. In hierarchical cluster, the MN may not be able to access the BMC of CN directly, but SN can. With this option, B<bmcdiscover> will be dispatched to the specified SNs. Then, the nodename of the service node that B<bmcdiscover> is running on will be set to the 'servicenode' attribute of the discovered BMC node.
=item B<-s>
@ -101,7 +101,7 @@ Output is similar to:
servicenode=sn01
conserver=sn01
4. Discover the BMCs and write the discovered-node definitions into the xCAT database and write out the stanza foramt to the console:
4. Discover the BMCs and write the discovered node definitions into the xCAT database and write out the stanza format to the console:
bmcdiscover -s nmap --range "10.4.22-23.100-254" -w -z

44
xCAT-test/pods/man1/xcatperftest.1.pod
View File

@ -6,28 +6,30 @@ B<xcatperftest> - Run xCAT command performance baseline testing on fake nodes.
B<xcatperftest> [B<-?|-h>]
[B<PERF_DRYRUN>=y] B<xcatperftest run> [I<command-list-file>]
[B<PERF_DRYRUN>=y] [B<PERF_NOCREATE>=y] B<xcatperftest> <total> [I<command-list-file>]
=head1 DESCRIPTION
The xcatperftest command runs commandes defined in a command list file and get their execution response time baseline for performance purpose.
The xcatperftest command is part of the xCAT package xCAT-test, and you can run it standalone or leverage it to build up your automation test cases.
The B<xcatperftest> command runs commands defined in a command list file and get their execution response time baseline for performance purpose.
The B<xcatperftest> command is part of the xCAT package B<xCAT-test>, and you can run it standalone or leverage it to build up your automation test cases.
Any commands could be defined in the command list file, however, it is recommended that the one-time initial configuration are well prepared prior to run xcatperftest command.
For example, the network object, osdistor and osimage image objects.
Any command could be defined in the command list file, however, it is recommended that the one-time initial configuration is well prepared prior to running B<xcatperftest> command.
For example, the network object, osdistro and osimage image objects.
Follow the below steps to run xcatperftest command:
Follow the steps below to run B<xcatperftest> command:
1, Install xCAT-test on a xCAT management nodes.
1. Install B<xCAT-test> on a xCAT management node.
2, Prepare a command list in which the commands are what you want to messure.
2. Prepare a command list with the commands you want to measure.
3, Prepare the initial configuration based on the command list to make sure all commands could be executed in techinal.
3. Prepare the initial configuration based on the command list to make sure all commands could be executed in techinal.
4, Run xcatperftest with the total fake nodes number and the above command list file.
4. Run B<xcatperftest> with the total fake nodes number and the above command list file.
Node: It is suggested to run the command in background as it normally takes long time to finish all the performanc testing with large amount of fake nodes.
Node: It is suggested to run the command in background as it normally takes long time to finish all the performance testing with large amount of fake nodes.
=head1 OPTIONS
@ -37,7 +39,7 @@ Node: It is suggested to run the command in background as it normally takes long
Display usage message.
=item <command-list-file>
=item I<command-list-file>
Specifies the command list file with full-path. xCAT supports an example command file: /opt/xcat/share/xcat/tools/autotest/perfcmds.lst
@ -56,7 +58,7 @@ Total number of fake nodes will be defined during the testing.
=head1 COMMAND LIST FILE
The command list file is in flat text format, the testing framework will parse the file line by line, here is an example of the commannd list file:
The command list file is in flat text format, the testing framework will parse the file line by line, here is an example of the command list file:
#SERIES# 1,50,100,250,500,1000,2500,5000
mkdef -z -f < #STANZ#
@ -75,19 +77,19 @@ The command list file is in flat text format, the testing framework will parse t
B<Note>: Each line defines one command, and the commands dependency should be handled by the line order.
If you define a node range series line (started with #SERIES#) in this file, xcatperftest will run the command for each node range defined in series line.
If you define a node range series line (started with B<#SERIES#>) in this file, xcatperftest will run the command for each node range defined in series line.
B<#SERIES#> To define a node range series, and the series should be an comma split incremental number sequence.
B<#STANZ#> It will be replaced with real stanz file path when this command line runs.
B<#NODES#> It will be replaced with real node range defined in #SERIES# line when this command line runs. If no series line, the node group will be used.
B<#NODES#> It will be replaced with real node range defined in B<#SERIES#> line when this command line runs. If no series line, the node group will be used.
B<#PERFGRP#> It will be replaced with node group when this command line runs.
=head1 ENVIRONMENT VARIABLE
The xcatperftest command supports be customized by some environment variables.
The B<xcatperftest> command supports customization by some environment variables.
B<FAKE_NODE_PREFIX>
@ -110,15 +112,15 @@ It must be a string like 'A.B' and no need to be defined in 'networks' table.
B<PERF_NODETEMPL>
Optional, The node template name used for generating fake nodes. By default, it will be auto-detected according to the current arch.
Optional, the node template name used for generating fake nodes. By default, it will be auto-detected according to the current arch.
B<PERF_DRYRUN>
Optional, Indicate no real commands will be executed if the environment variable is set.
Optional, indicate no real commands will be executed if the environment variable is set.
B<PERF_NOCREATE>
Optional, Indicate no new fake nodes will be created if the environment variable is set.
Optional, indicate no new fake nodes will be created if the environment variable is set.
=head1 EXAMPLES
@ -142,6 +144,12 @@ To run the performance testing for the commands defined in /opt/xcat/share/xcat/
PERF_NOCREATE=y xcatperftest 5000 /opt/xcat/share/xcat/tools/autotest/perfcmds.lst
=item 4.
To run the performance testing for the commands defined in /tmp/cmd.lst in existing xCAT environment:
xcatperftest run /tmp/cmd.lst
=back
=head1 FILES