From 2b9565820b2a1532b041abcb7892c1fffa073f50 Mon Sep 17 00:00:00 2001 From: "Georgios P. Katsikas" <gkatsikas@ubitech.eu> Date: Mon, 4 Nov 2024 07:46:51 +0000 Subject: [PATCH] doc: improved instructions in p4 test --- src/tests/p4-fwd-l1/README.md | 6 ++++++ src/tests/p4-fwd-l1/probe/probe-tfs/README.md | 21 ++++++++++++++++++- 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/src/tests/p4-fwd-l1/README.md b/src/tests/p4-fwd-l1/README.md index 43920d14d..8389e6741 100644 --- a/src/tests/p4-fwd-l1/README.md +++ b/src/tests/p4-fwd-l1/README.md @@ -2,6 +2,12 @@ This directory contains the necessary scripts and configurations to run tests for the P4 functionality of TFS. +## Prerequisites + +This test requires some custom monitoring services (latency monitoring and probe). +These services are implemented in Rust and can be found in the `./probe` directory. +To build these services on your target platform, follow the instructions in `./probe/probe-tfs/README.md`. + ## Basic scripts To run the experiments you should use the five scripts in the following order: diff --git a/src/tests/p4-fwd-l1/probe/probe-tfs/README.md b/src/tests/p4-fwd-l1/probe/probe-tfs/README.md index f88d7c542..3cff11314 100644 --- a/src/tests/p4-fwd-l1/probe/probe-tfs/README.md +++ b/src/tests/p4-fwd-l1/probe/probe-tfs/README.md @@ -1,2 +1,21 @@ -# rust-tfs +# Rust-tfs + Client for TFS functionalities written in Rust. + +## Dependencies + +This project requires the cargo Rust compiler: + +```sh +sudo apt-get install protobuf-compiler cargo +``` + +## Build + +Build sources as follows: + +```sh +cargo build +``` + +After a successfuly build, two new executables will be generated in `target/`. -- GitLab