aboutsummaryrefslogtreecommitdiffstats
path: root/test/mocks/mass-pnf-sim/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'test/mocks/mass-pnf-sim/README.md')
-rw-r--r--test/mocks/mass-pnf-sim/README.md60
1 files changed, 45 insertions, 15 deletions
diff --git a/test/mocks/mass-pnf-sim/README.md b/test/mocks/mass-pnf-sim/README.md
index 07f74e2b7..f997f56ad 100644
--- a/test/mocks/mass-pnf-sim/README.md
+++ b/test/mocks/mass-pnf-sim/README.md
@@ -1,48 +1,78 @@
### Mass PNF simulator
+
The purpose of this simulator is to mimic the PNF for benchmark purposes.
This variant is based on the PNF simulator and use several components.
The modification are focusing on the following areas:
- -add a script configuring and governing multiple instances of PNF simualtor
- -removing parts which are not required for benchmark purposes.
- -add functionality which creates and maintains the ROP files
- -add functionality to query the actual ROP files and construct VES events based on them
+- add a script configuring and governing multiple instances of PNF simualtor
+- removing parts which are not required for benchmark purposes.
+- add functionality which creates and maintains the ROP files
+- add functionality to query the actual ROP files and construct VES events based on them
+### Pre-configuration
-###Pre-configuration
The ipstart should align to a /28 Ip address range start (e.g. 10.11.0.16, 10.11.0.32)
For debug purposes, you can use your own IP address as VES collector, use "ip" command to determine it.
Example:
+
+```
./mass-pnf-sim.py --bootstrap 2 --urlves http://10.148.95.??:10000/eventListener/v7 --ipfileserver 10.148.95.??? --typefileserver sftp --ipstart 10.11.0.16
+```
Note that the file creator is started at a time of the bootstrapping.
Stop/start will not re-launch it.
-###Replacing VES for test purposes
-`sudo nc -vv -l -k -p 10000`
+### Replacing VES for test purposes
+
+```
+sudo nc -vv -l -k -p 10000
+```
+
+### Start
-###Start
Define the amount of simulators to be launched
+
+```
./mass-pnf-sim.py --start 2
+```
+
+### Trigger
-###Trigger
+```
./mass-pnf-sim.py --trigger 2
+```
-###Trigger only a subset of the simulators
+### Trigger only a subset of the simulators
+
+The following command will trigger 0,1,2,3:
+
+```
./mass-pnf-sim.py --triggerstart 0 --triggerend 3
-#this will trigger 0,1,2,3
+```
+
+The following command will trigger 4 and 5:
+```
./mass-pnf-sim.py --triggerstart 4 --triggerend 5
-#this will trigger 4,5
+```
-###Stop and clean
+### Stop and clean
+
+```
./mass-pnf-sim.py --stop 2
./mass-pnf-sim.py --clean
+```
+
+### Verbose printout from Python
-###Verbose printout from Python
+```
python3 -m trace --trace --count -C . ./mass-pnf-sim.py .....
+```
+
+### Cleaning and recovery after incorrect configuration
-###Cleaning and recovery after incorrect configuration
+```
docker stop $(docker ps -aq); docker rm $(docker ps -aq)
+```