Docs: Review and update the docs for E-release
[samplevnf.git] / docs / testing / developer / requirements / 03-Requirements.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3 .. (c) OPNFV, Intel Corporation and others.
4
5 .. OPNFV SAMPLEVNF Documentation design file.
6
7 ============
8 Requirements
9 ============
10
11 **Required Test setup:**
12
13 .. _SampleVNF: https://wiki.opnfv.org/samplevnf
14 .. _Technical_Briefs: https://wiki.opnfv.org/display/SAM/Technical+Briefs+of+VNFs
15
16 Supported Test setup:
17 --------------------
18 The device under test (DUT) consists of a system following;
19   * A single or dual processor and PCH chip, except for System on Chip (SoC) cases
20   * DRAM memory size and frequency (normally single DIMM per channel)
21   * Specific Intel Network Interface Cards (NICs)
22   * BIOS settings noting those that updated from the basic settings
23   * DPDK build configuration settings, and commands used for tests
24 Connected to the DUT is an IXIA* or Software Traffic generator like pktgen or TRex,
25 simulation platform to generate packet traffic to the DUT ports and
26 determine the throughput/latency at the tester side.
27
28 Below are the supported/tested (:term:`VNF`) deployment type.
29 .. image:: images/deploy_type.png
30    :width: 800px
31    :alt: SampleVNF supported topology
32
33 Hardware & Software Ingredients
34 -------------------------------
35 .. code-block:: console
36    +---------------+------------------+
37    | Item          | Description      |
38    +---------------+------------------+
39    | Memory        | Min 20GB         |
40    +---------------+------------------+
41    | NICs          | 2 x 10G          |
42    +---------------+------------------+
43    | HostOS/Guest  | Ubuntu 16.04 LTS |
44    +---------------+------------------+
45    | kernel        | >4.4.0-34-generic|
46    +---------------+------------------+
47    |DPDK           | >17.02           |
48    +---------------+------------------+
49
50    Boot and BIOS settings
51    +------------------+---------------------------------------------------+
52    | Boot settings    | default_hugepagesz=1G hugepagesz=1G hugepages=16  |
53    |                  | hugepagesz=2M hugepages=2048 isolcpus=1-11,22-33  |
54    |                  | nohz_full=1-11,22-33 rcu_nocbs=1-11,22-33         |
55    |                  | Note: nohz_full and rcu_nocbs is to disable Linux*|
56    |                  | kernel interrupts, and it’s import                |
57    +------------------+---------------------------------------------------+
58    |BIOS              | CPU Power and Performance Policy <Performance>    |
59    |                  | CPU C-state Disabled                              |
60    |                  | CPU P-state Disabled                              |
61    |                  | Enhanced Intel® Speedstep® Tech Disabled          |
62    |                  | Hyper-Threading Technology (If supported) Enable  |
63    |                  | Virtualization Techology Enable                   |
64    |                  | Coherency Enable                                  |
65    |                  | Turbo Boost Disabled                              |
66    +------------------+---------------------------------------------------+
67
68 Network Topology for testing VNFs
69 ---------------------------------
70
71 The ethernet cables should be connected between traffic generator and the VNF server (BM,
72 SRIOV or OVS) setup based on the test profile.
73
74 The connectivity could be
75
76 - Single port pair : One pair ports used for traffic
77
78 ::
79      e.g. Single port pair link0 and link1 of VNF are used
80      TG:port 0 <------> VNF:Port 0
81      TG:port 1 <------> VNF:Port 1
82
83 -  Multi port pair :  More than one pair of traffic
84
85 ::
86
87      e.g. Two port pair link 0, link1, link2 and link3 of VNF are used
88      TG:port 0 <------> VNF:Port 0
89      TG:port 1 <------> VNF:Port 1
90      TG:port 2 <------> VNF:Port 2
91      TG:port 3 <------> VNF:Port 3
92 For openstack/Standalone virtualization, installation please refer the openstack guide and ovs-dpdk/sriov github.
93 (TBA - Add link to guide)