From 8c4cb8fcfd2f82b0f6421cacc228b193428f061f Mon Sep 17 00:00:00 2001
From: tbadts <thomas.badts@inria.fr>
Date: Wed, 19 Feb 2025 16:35:37 +0100
Subject: [PATCH] Update network emulation documentation
---
docs/define_exp_env/index.rst | 2 +-
docs/define_exp_env/network.yaml | 2 +-
e2clab/schemas/network_schema.py | 7 ++++---
3 files changed, 6 insertions(+), 5 deletions(-)
diff --git a/docs/define_exp_env/index.rst b/docs/define_exp_env/index.rst
index 9990823f..422bdc0d 100644
--- a/docs/define_exp_env/index.rst
+++ b/docs/define_exp_env/index.rst
@@ -129,7 +129,7 @@ Schema
Network
=======
-``e2clab`` has the capacity to emulate network constraints between layers. Those constraints are defined in a single ``network.yaml`` configuration file.
+``e2clab`` has the capacity to emulate network constraints between layers, or any subset of services. Those constraints are defined in a single ``network.yaml`` configuration file.
For each network, users may set parameters like:
- delay
diff --git a/docs/define_exp_env/network.yaml b/docs/define_exp_env/network.yaml
index 9d54a47b..7284f094 100644
--- a/docs/define_exp_env/network.yaml
+++ b/docs/define_exp_env/network.yaml
@@ -10,7 +10,7 @@ networks:
rate: 1gbit
loss: 1%
symmetric: false
-- src: fog # Required
+- src: fog.gateway.* # Required
dst: edge # Required
delay: 100ms
rate: 50kbits
diff --git a/e2clab/schemas/network_schema.py b/e2clab/schemas/network_schema.py
index b9a8ada9..211b09a8 100644
--- a/e2clab/schemas/network_schema.py
+++ b/e2clab/schemas/network_schema.py
@@ -16,16 +16,17 @@ SCHEMA: dict = {
"definitions": {
"network": {
"title": "Network emulation",
- # "$$target": "#/definitons/network",
"type": "object",
"properties": {
SRC: {
- "description": "Source layer name",
+ "description": "Source services name",
"type": "string",
+ "examples": ["cloud", "cloud.kafka.*"],
},
DST: {
- "description": "Destination layer name",
+ "description": "Destination services name",
"type": "string",
+ "example": ["edge", "fog.gateway.*"],
},
DELAY: {
"description": "The delay to apply",
--
GitLab