test/mocks/masspnfsim/README.md

   1 ### Mass PNF simulator
   2
   3 The purpose of this simulator is to mimic the PNF for benchmark purposes.
   4 This variant is based on the PNF simulator and use several components.
   5 The modification are focusing on the following areas:
   6
   7 - add a script configuring and governing multiple instances of PNF simualtor
   8 - removing parts which are not required for benchmark purposes.
   9 - add functionality which creates and maintains the ROP files
  10 - add functionality to query the actual ROP files and construct VES events based on them
  11
  12 ### Pre-configuration
  13
  14 The ipstart should align to a /28 Ip address range start (e.g. 10.11.0.16, 10.11.0.32)
  15
  16 For debug purposes, you can use your own IP address as VES collector, use "ip" command to determine it.
  17
  18 Run ./setup.sh to create pre-set Python virtualenv with all required dependencies for the scripts.
  19
  20 ### Build simulator image
  21
  22 ```
  23 ./mass-pnf-sim.py build
  24 ```
  25
  26 ### Bootstrap simulator instances
  27
  28 ```
  29 ./mass-pnf-sim.py bootstrap --count 2 --urlves http://10.148.95.??:10000/eventListener/v7 --ipfileserver 10.148.95.??? --typefileserver sftp --ipstart 10.11.0.16
  30 ```
  31
  32 Note that the file creator is started at a time of the bootstrapping.
  33 Stop/start will not re-launch it.
  34
  35 ### Replacing VES for test purposes
  36
  37 ```
  38 sudo nc -vv -l -k -p 10000
  39 ```
  40
  41 ### Start all bootstrapped instances
  42
  43 ```
  44 ./mass-pnf-sim.py start
  45 ```
  46
  47 ### Trigger
  48
  49 ```
  50 ./mass-pnf-sim.py trigger
  51 ```
  52
  53 ### Trigger only a subset of the simulators
  54
  55 The following command will trigger 0,1,2,3:
  56
  57 ```
  58 ./mass-pnf-sim.py trigger-custom --triggerstart 0 --triggerend 3
  59 ```
  60
  61 The following command will trigger 4 and 5:
  62
  63 ```
  64 ./mass-pnf-sim.py trigger-custom --triggerstart 4 --triggerend 5
  65 ```
  66
  67 ### Stop sending PNF registration messages from simulators
  68
  69 ```
  70 ./mass-pnf-sim.py stop_simulator
  71 ```
  72
  73 ### Stop docker containers and clean bootstrapped simulators
  74
  75 ```
  76 ./mass-pnf-sim.py stop
  77 ./mass-pnf-sim.py clean
  78 ```
  79
  80 ### Verbose printout from Python
  81
  82 ```
  83 python3 -m trace --trace --count -C . ./mass-pnf-sim.py .....
  84 ```
  85
  86 ### Cleaning and recovery after incorrect configuration
  87
  88 ```
  89 ./clean.sh
  90 ```