tools/report/report_head.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, AT&T and others.
   4
   5 Introduction
   6 ============
   7 The objective of the OPNFV project titled **"Characterise vSwitch Performance
   8 for Telco NFV Use Cases"**, is to evaluate a virtual switch to identify its
   9 suitability for a Telco Network Function Virtualization (NFV) environment. As
  10 well as this, the project aims to identify any gaps or bottlenecks in order to
  11 drive architectural changes to improve virtual switch performance and
  12 determinism. The purpose of this document is to summarize the results of the
  13 tests carried out on the virtual switch in the Network Function Virtualization
  14 Infrastructure (NFVI) and, from these results, provide evaluations and
  15 recommendations for the virtual switch. Test results will be outlined in
  16 details-of-LTR_, preceded by the document-identifier_ and the scope_ and
  17 references_).
  18
  19 This document is currently in draft form.
  20
  21 .. _document-identifier:
  22
  23 Document identifier
  24 -------------------
  25 The document id will be used to uniquely identify versions of the LTR. The
  26 format for the document id will be:
  27 OPNFV\_vswitchperf\_LTR\_rel\_STATUS, the status is one of: DRAFT, REVIEWED,
  28 CORRECTED or FINAL. The document id for this version of the LTR is:
  29 OPNFV\_vswitchperf\_LTR\_Brahmaputra\_DRAFT.
  30
  31 .. _scope:
  32
  33 Scope
  34 -----
  35 The scope of this report is to detail the results of the tests that have been
  36 performed on the virtual switch. This report will also evaluate the results of
  37 these tests and, based on these evaluations, provide recommendations on the
  38 suitability of the virtual switch for use in a Telco NFV environment.
  39
  40 .. _references:
  41
  42 References
  43 ----------
  44 `OPNFV_vswitchperf_LTD_Brahmaputra_REVIEWED
  45 <http://artifacts.opnfv.org/vswitchperf/docs/requirements/vswitchperf_ltd.html>`__
  46
  47 .. _details-of-LTR:
  48
  49 Details of the Level Test Report
  50 ================================
  51 This section provides a test-results-overview_. Also included are the rationale_
  52 and the conclusions_.
  53
  54 .. _test-results-overview:
  55