Added use case "Forwaring Rate At Maximum Offered Load"
[samplevnf.git] / VNFs / DPPD-PROX / helper-scripts / dpi / README
1 ##
2 ## Copyright (c) 2010-2017 Intel Corporation
3 ##
4 ## Licensed under the Apache License, Version 2.0 (the "License");
5 ## you may not use this file except in compliance with the License.
6 ## You may obtain a copy of the License at
7 ##
8 ##     http://www.apache.org/licenses/LICENSE-2.0
9 ##
10 ## Unless required by applicable law or agreed to in writing, software
11 ## distributed under the License is distributed on an "AS IS" BASIS,
12 ## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 ## See the License for the specific language governing permissions and
14 ## limitations under the License.
15 ##
16
17 The scripts in this directory characterize flow a DPI-enabled VNF. The
18 characeterization is split up into two steps. The first step (dpi1.py)
19 searches for the traffic profile parameter boundaries. The second step
20 (dpi2.py) takes as input the output of the first step and searches for
21 the maximum sustainable throughput of a DPI-enabled VNF.
22
23 To run the first script, use:
24
25    python2.7 ./dpi1.py -t TEST_SYSTEM_DESCRIPTIONS -o OUTPUT1
26
27 TEST_SYSTEM_DESCRIPTIONS is a comma-separated list of systems where
28 the syntax of defining each system is shown below:
29
30    user@ip:proxDir:cfgDir
31
32 To run the second script, use:
33
34    python2.7 ./dpi2.py -t TEST_SYSTEM_DESCRIPTIONS \
35              -s SYSTEM_UNDER_TEST_DESCRIPTIONS \
36              -o OUTPUT2 -d \
37              -i OUTPUT1
38
39 Finally, the results can be processed using the following command:
40
41    python2.7 ./maketable.py -i OUTPUT1 -j OUTPUT2 -o FINAL_TABLE