From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 48B0F46B73; Mon, 14 Jul 2025 19:13:52 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id D17444026B; Mon, 14 Jul 2025 19:13:51 +0200 (CEST) Received: from mail-il1-f179.google.com (mail-il1-f179.google.com [209.85.166.179]) by mails.dpdk.org (Postfix) with ESMTP id 8331E4021F for ; Mon, 14 Jul 2025 19:13:50 +0200 (CEST) Received: by mail-il1-f179.google.com with SMTP id e9e14a558f8ab-3df2d8cb8d2so16409275ab.2 for ; Mon, 14 Jul 2025 10:13:50 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=iol.unh.edu; s=unh-iol; t=1752513229; x=1753118029; darn=dpdk.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=FMBF9et479OhtNLTftcxEND/6QAV2ayM7K/dkrPNxCQ=; b=bpgLwk7D8ho6RbzpaPU3WKYVfvJZQsoS1/EwgYBjwx48a7sqEW41lO/eiPjsr29KxT U/9OKFCT6JLB6CA1Y8PkjuLpXglqT1EAE+mIBDDiIZyv8L1loiwfmQyLwzMVIXppNbZN kO4Ma/oMcWIkRFzkOHwFdFi3riUnkTbLWP3QQ= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1752513229; x=1753118029; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=FMBF9et479OhtNLTftcxEND/6QAV2ayM7K/dkrPNxCQ=; b=r3dzZbf7JnGvPhpxaze3dTTD51r2oOkt7BiFBzlm4ocNTzvDeKqZySsof7RY0cKdj+ ktOIMjdV1BXDt6rFmaSDovDyVMHiljHgomnd8Es6NVyMb3n07YumGlpxY7cusG7d+3/A i8pK9YHUWyR1k/7CycYaLHUGXE08k64ho3qQQJbqpTvDYtx4/ES7xont/eyOPWSWBfom ZBzgx8VolYedrbj4vV0iXQYVNp5SJgRN3pv95FbXc8eAq0FtMol+WZfNeJPPekpYxFsh r0vuEvm0dMvE4UxfrU6ilGwF9JfPORE7oDH63Br0hNa1hb2eMdaMPwbOABmY0x9W+2Cj gVcg== X-Gm-Message-State: AOJu0YwkRJeXvlMXDErLDZA1AOVQWcavr8YChzc3FvYfYvxk2onLqJSZ U8g2Rtr5U/qt/iURvPDBjVddiwa4/FlKPc+GV6+KCmZe+eX9zZQ9t72LzzfbQ57rTYBLYp20dQq FOiFc X-Gm-Gg: ASbGncu3fOS79I3iTdxHx2Hh+jm0zoVkYGhuzW2kzG0U+kKVTzFxWtR2RGyHhqGtEkS 9foLBzEqULXdkz5IzOXM9rRpR54fNbDMwWNNuKHIru+ZCvIxxJFUR6MwGo8SQlmpKeHwRpUVr1f MR/lf8n0gXQEBmmAQz2gW8uiEta5UVxF2ahaEYTMrqQmGCJSSZfVcLehUSlZ9hOca1K1u+KOH65 ZJYsQpwxOHzG49/lrfb6lcjZ5zHLN4nO0MaCB9uccLPhvQ3EuOt8VUDF39EnSSXNfHY2eKTqUua x1Kkt9y0JBtAq6T8SecrUYI6s4sQ7eUrBbh/SbGbkM82hmhv1gYJ0w1J4XIK9ztKgaKMcVhPOYe 3G7V5H4LQ X-Google-Smtp-Source: AGHT+IFtDEVm2eeNEfc5eEQHKSGe29V9VAOSf4g77vLcHIkPD8iur69qsh8CPtRjED7uJmRaTZxi/Q== X-Received: by 2002:a05:6e02:1d9a:b0:3dd:cc4f:d85a with SMTP id e9e14a558f8ab-3e253286980mr138548045ab.6.1752513229404; Mon, 14 Jul 2025 10:13:49 -0700 (PDT) Received: from fedora.unh.edu ([2606:4100:3880:1257::100a]) by smtp.gmail.com with ESMTPSA id 8926c6da1cb9f-50556b14167sm2111784173.131.2025.07.14.10.13.48 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 14 Jul 2025 10:13:48 -0700 (PDT) From: Dean Marx To: probb@iol.unh.edu, luca.vizzarro@arm.com, yoan.picchi@foss.arm.com, Honnappa.Nagarahalli@arm.com, paul.szczepanek@arm.com Cc: dev@dpdk.org, Dean Marx Subject: [PATCH v4 1/3] dts: rewrite README Date: Mon, 14 Jul 2025 13:13:42 -0400 Message-ID: <20250714171346.564267-1-dmarx@iol.unh.edu> X-Mailer: git-send-email 2.49.0 In-Reply-To: <20250711172534.540416-1-dmarx@iol.unh.edu> References: <20250711172534.540416-1-dmarx@iol.unh.edu> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Refactor README to contain only a high level description of relevant DTS concepts and a simple getting started guide. Signed-off-by: Dean Marx Reviewed-by: Patrick Robb Reviewed-by: Paul Szczepanek --- dts/README.md | 115 ++++++++++++++++++++++++-------------------------- 1 file changed, 55 insertions(+), 60 deletions(-) diff --git a/dts/README.md b/dts/README.md index 2b3a7f89c5..20b09a4b7e 100644 --- a/dts/README.md +++ b/dts/README.md @@ -1,67 +1,66 @@ -# DTS Environment - -The execution and development environments for DTS are the same, -a [Docker](https://docs.docker.com/) container defined by our [Dockerfile](./Dockerfile). -Using a container for the development environment helps with a few things. - -1. It helps enforce the boundary between the DTS environment and the TG/SUT, - something which caused issues in the past. -2. It makes creating containers to run DTS inside automated tooling much easier, since - they can be based off of a known-working environment that will be updated as DTS is. -3. It abstracts DTS from the server it is running on. This means that the bare-metal OS - can be whatever corporate policy or your personal preferences dictate, - and DTS does not have to try to support all distros that are supported by DPDK CI. -4. It makes automated testing for DTS easier, - since new dependencies can be sent in with the patches. -5. It fixes the issue of undocumented dependencies, - where some test suites require Python libraries that are not installed. -6. Allows everyone to use the same Python version easily, - even if they are using a distribution or Windows with out-of-date packages. -7. Allows you to run the tester on Windows while developing via Docker for Windows. - -## Tips for setting up a development environment - -### Getting a docker shell - -These commands will give you a bash shell inside the container -with all the Python dependencies installed. -This will place you inside a Python virtual environment. -DTS is mounted via a volume, which is essentially a symlink from the host to the container. -This enables you to edit and run inside the container -and then delete the container when you are done, keeping your work. -It is also strongly recommended that you mount your SSH keys into the container -to allow you to connect to hosts without specifying a password. - -#### Start docker container with SSH keys +# Description + +DTS is a testing framework and set of testsuites for end to end testing of DPDK and DPDK +enabled hardware. Unlike DPDK's dpdk-test application, which is used for running unit tests, +DTS is intended to be used to evaluate real DPDK workloads run over supported hardware. For instance, +DTS will control a traffic generator node which will send packets to a system under test node which +is running a DPDK application, and evaluate the resulting DPDK application behavior. + +# Supported Test Node Topologies + +DTS is a python application which will control a traffic generator node (TG) and system +under test node (SUT). The nodes represent a DPDK device (usually a NIC) located on a +host. The devices/NICs can be located on two separate servers, or on the same server. If you use +the same server for both NICs, install them on separate NUMA domains if possible (this is ideal +for performance testing.) + +- 2 links topology: Represents a topology in which the TG node and SUT node both have two network interfaces +which form the TG <-> SUT connection. An example of this would be a dual interface NIC which is the +TG node connected to a dual interface NIC which is the SUT node. Interface 0 on TG <-> interface 0 +on SUT, interface 1 on TG <-> interface 1 on SUT. +- 1 link topology: Works, but may result in skips for testsuites which are explicitly decorated with a +2 link requirement. 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. + +# Simple Linux Setup + +1. On your TG and SUT nodes, add a dedicated user. In this example I will add a dedicated user for DTS. +2. Grant passwordless sudo to the dts user, like so: + 2a: enter 'visudo' in your terminal + 2b: In the visudo text editor, add: + dts ALL=(ALL:ALL) NOPASSWD:ALL +3. DTS uses ssh key auth to control the nodes. Copy your ssh keys to the TG and SUT: + ssh-copy-id dts@{your host}. + +For additional detail, please refer to [dts.rst](../doc/guides/tools/dts.rst) + +# DTS Configuration + +DTS requires two yaml files to be filled out with information about your environment, +test_run.yaml and nodes.yaml, which follow the format illustrated in the example files. + +1. Install Docker on the SUT, and Scapy on the TG. +2. Create and fill out a test_run.yaml and nodes.yaml file within your dts + directory, based on the structure from the example config files. +3. Run the bash terminal commands below in order to run the DTS container + and start the DTS execution. ```shell docker build --target dev -t dpdk-dts . -docker run -v $(pwd)/..:/dpdk -v /home/dtsuser/.ssh:/root/.ssh:ro -it dpdk-dts bash +docker run -v $(pwd)/..:/dpdk -v /home/{name of dts user}/.ssh:/root/.ssh:ro -it dpdk-dts bash $ poetry install -$ poetry shell +$ poetry run ./main.py ``` -#### Start docker container without SSH keys +These commands will give you a bash shell inside a docker container +with all DTS Python dependencies installed. -```shell -docker build --target dev -t dpdk-dts . -docker run -v $(pwd)/..:/dpdk -it dpdk-dts bash -$ poetry install -$ poetry shell -``` - -### Vim/Emacs - -Any editor in the Ubuntu repos should be easy to use, -with Vim and Emacs already installed. -You can add your normal config files as a volume, -enabling you to use your preferred settings. - -```shell -docker run -v ${HOME}/.vimrc:/root/.vimrc -v $(pwd)/..:/dpdk -it dpdk-dts bash -``` +## Visual Studio Code -### Visual Studio Code +Usage of VScode devcontainers is NOT required for developing on DTS and running DTS, +but provide some small quality of life improvements for the developer. If you +want to develop from a devcontainer, see the instructions below: VSCode has first-class support for developing with containers. You may need to run the non-Docker setup commands in the integrated terminal. @@ -75,7 +74,3 @@ Additionally, there is a line in `.devcontainer/devcontainer.json` that, when in will mount the SSH keys of the user currently running VSCode into the container for you. The `source` on this line can be altered to mount any SSH keys on the local machine into the container at the correct location. - -### Other - -Searching for '$IDE dev containers' will probably lead you in the right direction. -- 2.49.0