From: Arshad Hussain Date: Wed, 21 Apr 2021 14:46:15 +0000 (+0530) Subject: LUDOC-394 manual: Add meaningful ref names under LNetSelfTest.xml X-Git-Url: https://git.whamcloud.com/?a=commitdiff_plain;h=ab1c86066cb8a75f5b292c820fcb3dc7385217fd;p=doc%2Fmanual.git LUDOC-394 manual: Add meaningful ref names under LNetSelfTest.xml This patch adds meaningful and proper reference name under file LNetSelfTest.xml Signed-off-by: Arshad Hussain Change-Id: I3de2c6ff9c9c0d693497d5ccebd950fd5617e0db Reviewed-on: https://review.whamcloud.com/43442 Tested-by: jenkins Reviewed-by: Andreas Dilger --- diff --git a/LNetSelfTest.xml b/LNetSelfTest.xml index 94a5e12..a65f1d1 100644 --- a/LNetSelfTest.xml +++ b/LNetSelfTest.xml @@ -3,22 +3,22 @@ xmlns:xl="http://www.w3.org/1999/xlink" version="5.0" xml:lang="en-US" xml:id="lnetselftest"> Testing Lustre Network Performance (LNet Self-Test) - This chapter describes the LNet + This chapter describes the LNet self-test, which is used by site administrators to confirm that Lustre Networking (LNet) has been properly installed and configured, and that underlying network software and hardware are performing according to expectations. The chapter includes: - + - + - + -
+
<indexterm><primary>LNet</primary><secondary>self-test</secondary></indexterm> LNet Self-Test Overview LNet self-test is a kernel module that runs over LNet and the Lustre network drivers (LNDs). It is designed to: @@ -88,12 +88,12 @@ LNet Self-Test Overview
-
+
Using LNet Self-Test This section describes how to create and run an LNet self-test. The examples shown are for a test that simulates the traffic pattern of a set of Lustre servers on a TCP network accessed by Lustre clients on an InfiniBand network connected via LNet routers. In this example, half the clients are reading and half the clients are writing.
Creating a Session - A session is a set of processes that run on a test node. Only one session can be run at a time on a test node to ensure that the session has exclusive use of the node. The console node is used to create, change or destroy a session (new_session, end_session, show_session). For more about session parameters, see . + A session is a set of processes that run on a test node. Only one session can be run at a time on a test node to ensure that the session has exclusive use of the node. The console node is used to create, change or destroy a session (new_session, end_session, show_session). For more about session parameters, see . Almost all operations should be performed within the context of a session. From the console node, a user can only operate nodes in his own session. If a session ends, the session context in all test nodes is stopped. The following commands set the LST_SESSION environment variable to identify the session on the console node and create a session called read_write: export LST_SESSION=$$ @@ -124,7 +124,7 @@ lst add_group writers 192.168.1.[2-254/2]@o2ib A console node can associate kernel space test nodes with the session by running lst add_group NIDs, but a userspace test node cannot be actively added to the session. A console node can passively "accept" a test node to associate with a test session while the test node running lstclient connects to the console node, i.e: lstclient --sesid CONSOLE_NID --group NAME).
-
+
Defining and Running the Tests A test generates a network load between two groups of nodes, a source group identified using the --from parameter and a target group @@ -152,7 +152,11 @@ lst add_test --batch bulk_rw --from readers --to servers \ brw read check=simple size=1M lst add_test --batch bulk_rw --from writers --to servers \ brw write check=full size=4K - The traffic pattern and test intensity is determined by several properties such as test type, distribution of test nodes, concurrency of test, and RDMA operation type. For more details, see . + The traffic pattern and test intensity is determined by several + properties such as test type, distribution of test nodes, concurrency + of test, and RDMA operation type. For more details, + see . +
Sample Script @@ -180,10 +184,10 @@ lst end_session
-
+
LNet Self-Test Command Reference The LNet self-test (lst) utility is used to issue LNet self-test commands. The lst utility takes a number of command line arguments. The first argument is the command name and subsequent arguments are command-specific. -
+
Session Commands This section describes lst session commands. @@ -553,7 +557,7 @@ Client1 $ lstclient --sesid 192.168.1.52@tcp --group clients Example: Client1 $ lstclient --sesid 192.168.1.52@tcp |--group clients --server_mode
-
+
Batch and Test Commands This section describes lst batch and test commands. add_batch name @@ -634,7 +638,12 @@ add_test --batch batchname [--loop loop_ ping - Sends a small request message, resulting in a small reply message. For more details, see . ping does not have any additional options. + Sends a small request message, resulting in a small + reply message. For more details, see + . + ping + does not have any additional options. + @@ -642,7 +651,10 @@ add_test --batch batchname [--loop loop_ brw - Sends a small request message followed by a bulk data transfer, resulting in a small reply message. . Options are: + Sends a small request message followed by a bulk data + transfer, resulting in a small reply message. + . Options are: +