test_spec: Add Introduction to test spec
[vswitchperf.git] / test_spec / vswitchperf_ltd.md
1 #CHARACTERIZE VSWITCH PERFORMANCE FOR TELCO NFV USE CASES LEVEL TEST DESIGN
2
3 ##Table of Contents
4
5 - [1. Introduction](#Introduction)
6   - [1.1. Document identifier](#DocId)
7   - [1.2. Scope](#Scope)
8  - [1.3. References](#References)
9
10 - [2. Details of the Level Test Design](#DetailsOfTheLevelTestDesign)
11   - [2.1. Features to be tested](#FeaturesToBeTested)
12   - [2.2. Approach](#Approach)
13   - [2.3. Test identification](#TestIdentification)
14     - [2.3.1 Throughput tests](#ThroughputTests)
15     - [2.3.2 Packet Delay Tests](#PacketDelayTests)
16     - [2.3.3 Scalability Tests](#ScalabilityTests)
17     - [2.3.4 CPU and Memory Consumption Tests](#CPUTests)
18     - [2.3.5 Coupling Between the Control Path and The Datapath Tests](#CPDPTests)
19     - [2.3.6 Time to Establish Flows Tests](#FlowLatencyTests)
20     - [2.3.7 Noisy Neighbour Tests](#NoisyNeighbourTests)
21     - [2.3.8 Overlay Tests](#OverlayTests)
22     - [2.3.9 Summary Test List](#SummaryList)
23   - [2.4. Feature pass/fail criteria](#PassFail)
24   - [2.5. Test deliverables](#TestDeliverables)
25
26 - [3. General](#General)
27   - [3.1. Glossary](#Glossary)
28   - [3.2. Document change procedures and history](#History)
29   - [3.3. Contributors](#Contributors)
30
31 <br/>
32
33 ---
34 <a name="Introduction"></a>
35 ##1. Introduction ##
36   The objective of the OPNFV project titled **“Characterize vSwitch Performance for Telco NFV Use Cases”**, is to evaluate a virtual switch to identify its suitability for a Telco Network Function Virtualization (NFV) environment. The intention of this Level Test Design (LTD) document is to specify the set of tests to carry out in order to objectively measure the current characteristics of a virtual switch in the Network Function Virtualization Infrastructure (NFVI) as well as the test pass criteria. The detailed test cases will be defined in [Section 2](#DetailsOfTheLevelTestDesign), preceded by the [Document identifier](#DocId) and the [Scope](#Scope).
37
38  This document is currently in draft form.
39
40   <a name="DocId"></a>
41   ###1.1. Document identifier
42   The document id will be used to uniquely identify versions of the LTD. The format for the document id will be: OPNFV\_vswitchperf\_LTD\_ver\_NUM\_MONTH\_YEAR\_STATUS, where by the status is one of: draft, reviewed, corrected or final. The document id for this version of the LTD is: OPNFV\_vswitchperf\_LTD\_ver\_1.6\_Jan\_15\_DRAFT.
43
44   <a name="Scope"></a>
45   ###1.2. Scope
46   The main purpose of this project is to specify a suite of performance tests in order to objectively measure the current packet transfer characteristics of a virtual switch in the NFVI. The intent of the project is to facilitate testing of any virtual switch. Thus, a generic suite of tests shall be developed, with no hard dependencies to a single implementation. In addition, the test case suite shall be architecture independent.
47
48   The test cases developed in this project shall not form part of a separate test framework, all of these tests may be inserted into the Continuous Integration Test Framework and/or the Platform Functionality Test Framework - if a vSwitch becomes a standard component of an OPNFV release.
49
50   <a name="References"></a>
51   ###1.3. References
52
53   - [RFC 2544 Benchmarking Methodology for Network Interconnect Devices](https://www.ietf.org/rfc/rfc2544.txt)
54   - [RFC 2885 Benchmarking Terminology for LAN Switching Devices](https://www.ietf.org/rfc/rfc2885.txt)
55   - [RFC 2889 Benchmarking Methodology for LAN Switching Devices](https://www.ietf.org/rfc/rfc2889.txt)
56   - [RFC 3918 Methodology for IP Multicast Benchmarking](https://www.ietf.org/rfc/rfc3918.txt)
57   - [RFC 4737 Packet Reordering Metrics](https://www.ietf.org/rfc/rfc4737.txt)
58   - [RFC 5481 Packet Delay Variation Applicability Statement](https://www.ietf.org/rfc/rfc5481.txt)
59
60 <br/>
61