tools/report/report.jinja

   1 # CHARACTERIZE VSWITCH PERFORMANCE FOR TELCO NFV USE CASES LEVEL TEST REPORT
   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 - [2. Details of the Level Test Report](#DetailsoftheLevelTestReport)
  10   - [2.1. Overview of test results](#OverviewOfTestResults)
  11   - [2.2. Detailed test results](#DetailedTestResults)
  12   - [2.3. Rationale for decisions](#RationaleForDecisions)
  13   - [2.4. Conclusions and recommendations](#ConclusionsandRecommendations)
  14 - [3. General](#General)
  15   - [3.1. Glossary](#Glossary)
  16   - [3.2. Document change procedures and history](#DocChangeProceduresandHistory)
  17
  18 ---
  19
  20 <a name="Introduction"></a>
  21 ## 1. Introduction
  22
  23 The objective of the OPNFV project titled **"Characterise 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. As well as this, the project aims to identify any gaps or bottlenecks in order to drive architectural changes to improve virtual switch performance and determinism. The purpose of this document is to summarize the results of the tests carried out on the virtual switch in the Network Function Virtualization Infrastructure (NFVI) and, from these results, provide evaluations and recommendations for the virtual switch. Test results will be outlined in [Details of the Level Test Report](#DetailsoftheLevelTestReport), preceded by the [Document Identifier](#DocId), [Scope](#Scope) and [References](#References).
  24
  25 This document is currently in draft form.
  26
  27 <a name="DocId"></a>
  28 ### 1.1. Document identifier
  29
  30 The document id will be used to uniquely identify versions of the LTR. The format for the document id will be: `OPNFV_vswitchperf_LTR_ver_NUM_MONTH_YEAR_AUTHOR_STATUS`, where by the AUTHOR field should be replaced with the initials of the author and the status is one of: DRAFT, REVIEWED, CORRECTED or FINAL. The document id for this version of the LTR is: `OPNFV_vswitchperf_LTR_ver_1.1_Jan_15_CN_DRAFT`.
  31
  32 <a name="Scope"></a>
  33 ### 1.2. Scope
  34
  35 The scope of this report is to detail the results of the tests that have been performed on the virtual switch. This report will also evaluate the results of these tests and, based on these evaluations, provide recommendations on the suitability of the virtual switch for use in a Telco NFV environment.
  36
  37 <a name="References"></a>
  38 ### 1.3. References
  39
  40 - `OPNFV_vswitchperf_LTD_ver_1.6_Jan_15_DRAFT`
  41
  42 ---
  43
  44 <a name="DetailsoftheLevelTestReport"></a>
  45 ## 2. Details of the Level Test Report
  46
  47 This section provides an overview of the test results ([Section 2.1.](#OveriewOfTestResults)) as well as detailed test results for each test ([Section 2.2.](#DetailedTestResults)). Also included are the rationale used to evaluate each test ([Section 2.3.](#RationaleForDecisions)) and the conclusions and recommendations for each test ([Section 2.4.](#ConclusionsandRecommendations)).
  48
  49 <a name="OverviewOfTestResults"></a>
  50 ### 2.1. Overview of test results
  51
  52 ##### Test Environment
  53
  54 Below is the environment that the test was performed in:
  55
  56 - OS: {{tests[0].env.os}}
  57 - Kernel Version: {{tests[0].env.kernel}}
  58 - NIC(s): {{tests[0].env.nic}}
  59 - Board: {{tests[0].env.platform}}
  60 - CPU: {{tests[0].env.cpu}}
  61 - CPU cores: {{tests[0].env.cpu_cores}}
  62 - Memory: {{tests[0].env.memory}}
  63 - Virtual Switch Set-up: {{tests[0].deployment}}
  64 - IxNetwork: {{tests[0].env.ixnetwork_ver}}
  65
  66 For each test, a summary of the key test results is provided.
  67 {% for test in tests %}
  68 #### Test ID: {{ test.ID }}
  69
  70 Below are test details:
  71
  72 - Test ID: {{ "%s"|format(test.id) }}
  73 - Description: {{ "%s"|format(test.conf['Description']) }}
  74 - Deployment: {{ "%s"|format(test.deployment) }}
  75 - Traffic type: {{ "%s"|format(test.result['type']) }}
  76 - Packet size: {{ "%s"|format(test.result['packet_size']) }}
  77 - Bidirectional : {{ "%s"|format(test.conf['biDirectional']) }}
  78 {% endfor %}
  79
  80 <a name="DetailedTestResults"></a>
  81 ### 2.2. Detailed test results
  82
  83 A detailed summary of the main results for each test is outlined below.
  84 {% for test in tests %}
  85 #### Test ID: {{ test.ID }}
  86
  87 ##### Results/Metrics Collected
  88
  89 The following are the metrics obtained during this test:
  90
  91 |             Metric             |             Result             |
  92 | ------------------------------ | ------------------------------ |
  93 {%- for item, value in test.result.items() %}
  94 | {{ "%-30s | %30s |"|format(item,value)}}
  95 {%- endfor %}
  96
  97 ##### Statistics collected
  98
  99 The following system statistics were collected during testcase execution:
 100 {% for process in test.stats %}
 101 | --------------------------------------------------------------- |
 102 | Process: {{ "%-54s |"|format('_'.join(process.split('_')[:-1])) }}
 103 | ------------------------------ | ------------------------------ |
 104 |           Statistic            |             Value              |
 105 | ------------------------------ | ------------------------------ |
 106 {%- for item, value in test.stats[process].items() %}
 107 | {{ "%-30s | %30s |"|format(item,value)}}
 108 {%- endfor %}
 109
 110 {% endfor %}
 111
 112 ##### Anomalies
 113
 114 No anomalies were detected during the course of this test.
 115
 116 ##### Testing Activities/Events
 117
 118 There were no significant testing activities for this test.
 119 {% endfor %}
 120 <a name="RationaleForDecisions"></a>
 121 ### 2.3. Rationale for decisions
 122
 123 TODO.
 124
 125 <a name="ConclusionsandRecommendations"></a>
 126 ### 2.4. Conclusions and recommendations
 127
 128 TODO.
 129
 130 -----
 131
 132 <a name="General"></a>
 133 ## 3. General
 134
 135 <a name="Glossary"></a>
 136 ### 3.1. Glossary
 137
 138 - NFV - Network Function Virtualization
 139 - Mbps - 1,000,000bps
 140
 141 <a name="DocChangeProceduresandHistory"></a>
 142 ### 3.2. Document change procedures and history
 143
 144 | Document ID | Author | Date Modified |
 145 | ----------- |------- | ------------- |
 146 | `OPNFV_vswitchperf_LTR_ver_1.0_Jan_15_CN_DRAFT` | Christopher Nolan | 23/01/2015
 147 | `OPNFV_vswitchperf_LTR_ver_1.1_Jan_15_CN_DRAFT` | Christopher Nolan | 28/01/2015