diff --git a/docs/source/guides/admin-guides/references/man1/xcatperftest.1.rst b/docs/source/guides/admin-guides/references/man1/xcatperftest.1.rst index 4911358cd..3c7bf5394 100644 --- a/docs/source/guides/admin-guides/references/man1/xcatperftest.1.rst +++ b/docs/source/guides/admin-guides/references/man1/xcatperftest.1.rst @@ -29,10 +29,10 @@ 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 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. -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. +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. Follow the below steps to run xcatperftest command: @@ -54,22 +54,22 @@ OPTIONS -\ **-?|-h**\ - +\ **-?|-h**\ + Display usage message. - + - + Specifies the command list file with full-path. xCAT supports an example command file: /opt/xcat/share/xcat/tools/autotest/perfcmds.lst - + - + Total number of fake nodes will be defined during the testing. - + @@ -109,7 +109,7 @@ The command list file is in flat text format, the testing framework will parse t noderm #PERFGRP# -\ **Note**\ : Each line defines one command, and the commands dependency should be handled by the line order. +\ **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. \ **#SERIES#**\ To define a node range series, and the series should be an comma split incremental number sequence. @@ -128,33 +128,33 @@ ENVIRONMENT VARIABLE The xcatperftest command supports be customized by some environment variables. -\ **FAKE_NODE_PREFIX**\ +\ **FAKE_NODE_PREFIX**\ Optional, the prefix of the fake compute node name. By default, the value is 'fake' -\ **FAKE_NODE_GROUP**\ +\ **FAKE_NODE_GROUP**\ # Optional, the group name of all the fake compute nodes. By default, the value is 'perftest' -\ **FAKE_NETWORK_PRO**\ +\ **FAKE_NETWORK_PRO**\ Mandatory, the Provision network for all the fake compute nodes. By default, the value is '192.168'. It must be a string like 'A.B', and be matched with \`tabdump networks\` -\ **FAKE_NETWORK_BMC**\ +\ **FAKE_NETWORK_BMC**\ Mandatory, the BMC network for all the fake compute nodes. By default, the value is '192.168'. Note: It could not be the same subnet as 'FAKE_NETWORK_PRO' It must be a string like 'A.B' and no need to be defined in 'networks' table. -\ **PERF_NODETEMPL**\ +\ **PERF_NODETEMPL**\ Optional, The node template name used for generating fake nodes. By default, it will be auto-detected according to the current arch. -\ **PERF_DRYRUN**\ +\ **PERF_DRYRUN**\ Optional, Indicate no real commands will be executed if the environment variable is set. -\ **PERF_NOCREATE**\ +\ **PERF_NOCREATE**\ Optional, Indicate no new fake nodes will be created if the environment variable is set. @@ -166,39 +166,39 @@ EXAMPLES 1. - + To run the performance testing for the commands defined in /tmp/cmd.lst on 5000 fake nodes: - - + + .. code-block:: perl - + xcatperftest 5000 /tmp/cmd.lst - - + + 2. - + To generate an xCAT node object stanz file for 10000 nodes in subnet 10.100.0.0: - - + + .. code-block:: perl - + FAKE_NETWORK_PRO=10.100 FAKE_NETWORK_BMC=10.200 xcatperftest 10000 - - + + 3. - + To run the performance testing for the commands defined in /opt/xcat/share/xcat/tools/autotest/perfcmds.lst on 5000 existing fake nodes: - - + + .. code-block:: perl - + PERF_NOCREATE=y xcatperftest 5000 /opt/xcat/share/xcat/tools/autotest/perfcmds.lst - - + +