<div dir="ltr"><div dir="ltr"><br></div><div dir="ltr"><div dir="ltr"><br></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Fri, Jul 11, 2025 at 1:25 PM Dean Marx <<a href="mailto:dmarx@iol.unh.edu" target="_blank">dmarx@iol.unh.edu</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">Remove unnecessary information from README.md,<br></blockquote><div><br></div><div>I would call the dropped information "extraneous".</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
and add new sections to clarify the purpose/use<br>
of DTS along with clear setup instructions.<br></blockquote><div><br></div><div>Maybe say that the goal of the commit is refactoring the README to be a document which contains only a high level description of the relevant concepts in DTS and a simple getting started guide.</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><br>
+<br>
+1. 2 links topology: Represents a topology in which the TG node and SUT node both have two network interfaces<br>
+which form the TG <-> SUT connection. An example of this would be a dual interface NIC which is the<br>
+TG node connected to a dual interface NIC which is the SUT node. Interface 0 on TG <-> interface 0<br>
+on SUT, interface 1 on TG <-> interface 1 on SUT.<br>
+2. 1 links topology: Works, but may result in skips for testsuites which are explicitly decorated with a</blockquote><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
+2 link requirement. Represents a topology in which the TG node and SUT node are both located on one<br>
+network interface. An example of this would be a dual interface NIC with a connection between<br>
+its own ports.<br></blockquote><div><br></div><div>1 links -> 1 link</div><div><br></div><div><div>And the phrasing seems slightly off. Can you reword the 1 link topology to:<br><br>"Represents a topology in which the TG node and SUT node are connected over a single networking link. An example of this would be two single interface NICs directly connected to each other."</div><div><br></div><div>or similar to this phrasing.</div><div><br></div><div>And, maybe make this an unordered list? the "1. 2" and "2. 1" thing looks a touch weird. Not a big deal but probably worth doing: <a href="https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists">https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#lists</a></div></div><div><br></div><div>Also, I never did get a response from you about whether it would be good to include some ascii art to depict these topologies :)</div><div><br></div><div>You don't have to be a fan, but it would be good to get your opinion. If you think it's a good idea, can you add a bugzilla ticket so we can do this during 25.11? If you're opposed I'm okay with it - ultimately the wording should make the valid topologies clear enough to people. It's not something we can add during RC4 in any case.</div><div><br></div><div><br></div><div>2 link topology:</div><div><div><pre style="margin-top:0px;margin-bottom:0px;padding:0px;overflow:hidden;line-height:1.2em;color:rgb(0,0,0)"><br class="gmail-Apple-interchange-newline">+------------------------------+                 +------------------------------+                      
|                              |                 |                              |                      
|                              | --------------- |                              |                      
|                              |                 |                              |                      
|  Tester (Traffic Generator)  |                 |     System Under Test        |                      
|                              |                 |                              |                      
|                              | --------------- |                              |                      
|                              |                 |                              |                      
+------------------------------+                 +------------------------------+             </pre><pre style="margin-top:0px;margin-bottom:0px;padding:0px;overflow:hidden;line-height:1.2em;color:rgb(0,0,0)"><br></pre><pre style="margin-top:0px;margin-bottom:0px;padding:0px;overflow:hidden;line-height:1.2em;color:rgb(0,0,0)"><br></pre><pre style="margin-top:0px;margin-bottom:0px;padding:0px;overflow:hidden;line-height:1.2em;color:rgb(0,0,0)">   </pre><pre style="margin-top:0px;margin-bottom:0px;padding:0px;overflow:hidden;line-height:1.2em;color:rgb(0,0,0)"><br></pre><pre style="margin-top:0px;margin-bottom:0px;padding:0px;overflow:hidden;line-height:1.2em;color:rgb(0,0,0)">1 link topology: </pre><pre style="margin-top:0px;margin-bottom:0px;padding:0px;overflow:hidden;line-height:1.2em;color:rgb(0,0,0)"><br></pre><pre style="margin-top:0px;margin-bottom:0px;padding:0px;overflow:hidden;line-height:1.2em;color:rgb(0,0,0)">+------------------------------+                 +------------------------------+                      
|                              |                 |                              |                      
|                              | --------------- |                              |                      
|                              |                 |                              |                      
|  Tester (Traffic Generator)  |                 |     System Under Test        |                      
|                              |                 |                              |                      
|                              |                 |                              |                      
|                              |                 |                              |                      
</pre><pre style="margin-top:0px;margin-bottom:0px;padding:0px;overflow:hidden;line-height:1.2em;color:rgb(0,0,0)">+-----------------------------<span style="font-family:Arial,Helvetica,sans-serif">-+                                   </span>+-----------------------------<span style="font-family:Arial,Helvetica,sans-serif">-+</span> <span style="font-family:Arial,Helvetica,sans-serif">      </span></pre><pre style="margin-top:0px;margin-bottom:0px;padding:0px;overflow:hidden;line-height:1.2em;color:rgb(0,0,0)">                                                                                                       
                                                                                                       
<br></pre><pre style="margin-top:0px;margin-bottom:0px;padding:0px;overflow:hidden;line-height:1.2em;color:rgb(0,0,0)">2 link topology on a single host:                                                                                                       
                                                                                                       
                                                                                                       
                       -----------------------------------                                             
                      |                                   |                                            
                      |     -------------------------     |                                            
                      |    |                        |     |                                            
                      |    |                        |     |                                            
                      |    |                        |     |                                            
                      |    |                        |     |                                            
                      |    |                        |     |                                            
                      |    |                        |     |                                            
                      |    |                        |     |                                            
                      |    |                        |     |                                            
                +--------------------------------------------------+                                   
                |                                                  |                                   
                |                                                  |                                   
                |                                                  |                                   
                |                                                  |                                   
                |          Combined Tester & SUT system            |                                   
                |                                                  |                                   
                |                                                  |                                  -
                |                                                  |                                   
                |                                                  |                                   
                +--------------------------------------------------+  </pre></div><div><br></div></div><div><br></div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
+<br>
+# Simple Linux Setup<br>
+<br>
+1. On your TG and SUT nodes, add a dedicated user. In this example I will name the user "dts."<br></blockquote><div><br></div><div>"add a dedicated user for DTS"</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
+2. Grant passwordless sudo to the dts user, like so:<br>
+    2a: enter 'visudo' in your terminal<br>
+    2b: In the visudo text editor, add:<br>
+        dts   ALL=(ALL:ALL) NOPASSWD:ALL<br>
+3. DTS uses ssh key auth to control the nodes. Copy your ssh keys to the TG and SUT:<br>
+    ssh-copy-id dts@{your host}.<br>
+<br>
+For additional detail, please refer to [dts.rst](../doc/guides/tools/dts.rst)<br>
+<br>
+# DTS Configuration<br>
+<br>
+DTS requires two yaml files to be filled out with information about your environment,<br>
+test_run.yaml and nodes.yaml, which follow the format illustrated in the example files.<br>
+<br>
+1. Download Docker on the SUT, and Scapy on the TG.<br></blockquote><div><br></div><div>It's semantics but let's say Install instead of download.</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
-### Visual Studio Code<br>
+Usage of VScode devcontainers is NOT required for developing on DTS and running DTS,<br>
+but provide some small quality of life improvements for the developer. If you<br>
+want to develop from a devcontainer, see the instructions below:<br>
<br>
 VSCode has first-class support for developing with containers.<br>
 You may need to run the non-Docker setup commands in the integrated terminal.<br>
@@ -76,6 +75,6 @@ will mount the SSH keys of the user currently running VSCode into the container<br>
 The `source` on this line can be altered to mount any SSH keys<br>
 on the local machine into the container at the correct location.<br>
<br>
-### Other<br>
+## Other</blockquote><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
<br>
-Searching for '$IDE dev containers' will probably lead you in the right direction.<br>
+Searching for '$IDE dev containers' will probably lead you in the right direction.<br></blockquote><div><br></div><div>I would just drop this whole "Other" section with the comment about searching for dev containers - it's not needed. </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex">
\ No newline at end of file<br>
-- <br>
2.49.0<br>
<br>
</blockquote></div></div>
</div>