docs/release/release-notes/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International
   2 .. License.
   3 .. http://creativecommons.org/licenses/by/4.0
   4 .. (c) OPNFV, Intel Corporation and others.
   5
   6 =======
   7 License
   8 =======
   9
  10 OPNFV release note for SampleVNF Docs
  11 are licensed under a Creative Commons Attribution 4.0 International License.
  12 You should have received a copy of the license along with this.
  13 If not, see <http://creativecommons.org/licenses/by/4.0/>.
  14 :
  15
  16 The *SampleVNFs*, the *SampleVNF test cases* are opensource software,
  17 licensed under the terms of the Apache License, Version 2.0.
  18
  19 ==========================================
  20 OPNFV Euphrates Release Note for SampleVNF
  21 ==========================================
  22
  23 .. toctree::
  24    :maxdepth: 2
  25
  26 .. _SampleVNF: https://wiki.opnfv.org/samplevnf
  27
  28 .. _Yardstick: https://wiki.opnfv.org/yardstick
  29
  30 .. _NFV-TST001: http://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/001/01.01.01_60/gs_NFV-TST001v010101p.pdf
  31
  32
  33 Abstract
  34 ========
  35
  36 This document describes the release note of SampleVNF project.
  37
  38
  39 Version History
  40 ===============
  41
  42 +----------------+--------------------+---------------------------------+
  43 | *Date*         | *Version*          | *Comment*                       |
  44 |                |                    |                                 |
  45 +----------------+--------------------+---------------------------------+
  46 +----------------+--------------------+---------------------------------+
  47 |                |  1.0               | SampleVNF for Euphrates release    |
  48 |                |                    |                                 |
  49 +----------------+--------------------+---------------------------------+
  50
  51
  52 Important Notes
  53 ===============
  54
  55 The software delivered in the OPNFV SampleVNF_ Project, comprising the
  56 *SampleVNF VNFs*, the *SampleVNF test cases* and performance test case
  57 are part of  OPNFV Yardstick_ Project is a realization of the methodology in
  58 ETSI-ISG NFV-TST001_.
  59
  60
  61 OPNFV Euphrates Release
  62 ======================
  63
  64 This Euphrates release provides *SampleVNF* as a approx VNF repository for
  65 VNF/NFVI testing, characterization and OPNFV feature testing, automated on
  66 OPNFV platform, including:
  67
  68 * Documentation generated with Sphinx
  69
  70   * User Guide
  71
  72   * Developer Guide
  73
  74   * Release notes (this document)
  75
  76   * Results
  77
  78 * Automated SampleVNF test suit in OPNFV Yardstick_ Project
  79
  80 * SampleVNF source code
  81
  82 For Euphrates release, the *SampleVNF* is used for the following
  83 testing:
  84
  85 * OPNFV platform testing - generic test cases to measure the categories:
  86
  87   * NFVI Characterization:
  88
  89     * Network
  90
  91   * VNF Characterization:
  92
  93     * Network - rfc2544, rfc3511, latency, http_test etc
  94
  95
  96 The *SampleVNF* is developed in the OPNFV community, by the
  97 SampleVNF_ team. The *Network Service Benchmarking* Testing tool is a part of
  98 the Yardstick Project.
  99
 100 .. note:: The test case description template used for the SampleVNF in yardstick
 101   test cases is based on the document ETSI-ISG NFV-TST001_; the results report template
 102   used for the SampleVNF test results is based on the IEEE Std 829-2008.
 103
 104
 105 Release Data
 106 ============
 107
 108 +--------------------------------------+--------------------------------------+
 109 | **Project**                          | SampleVNF                            |
 110 |                                      |                                      |
 111 +--------------------------------------+--------------------------------------+
 112 | **Repo/tag**                         |                                      |
 113 |                                      |                                      |
 114 +--------------------------------------+--------------------------------------+
 115 | **SampleVNF Docker image tag**       |                                      |
 116 |                                      |                                      |
 117 +--------------------------------------+--------------------------------------+
 118 | **Release designation**              | Euphrates                            |
 119 |                                      |                                      |
 120 +--------------------------------------+--------------------------------------+
 121 | **Release date**                     |                                      |
 122 |                                      |                                      |
 123 +--------------------------------------+--------------------------------------+
 124 | **Purpose of the delivery**          |                                      |
 125 |                                      |                                      |
 126 +--------------------------------------+--------------------------------------+
 127
 128
 129 Deliverables
 130 ============
 131
 132 Documents
 133 ---------
 134
 135  - User Guide
 136
 137  - Developer Guide
 138
 139
 140 Software Deliverables
 141 ---------------------
 142
 143  - The SampleVNF Docker image: To be added
 144
 145
 146 **SampleVNF tested on Contexts**
 147
 148 +---------------------+-------------------------------------------------------+
 149 | **Context**         | **Description**                                       |
 150 |                     |                                                       |
 151 +---------------------+-------------------------------------------------------+
 152 | *Heat*              | Models orchestration using OpenStack Heat             |
 153 |                     |                                                       |
 154 +---------------------+-------------------------------------------------------+
 155 | *Node*              | Models Baremetal, Controller, Compute                 |
 156 |                     |                                                       |
 157 +---------------------+-------------------------------------------------------+
 158 | *Standalone*        | Models VM running on Non-Managed NFVi                 |
 159 |                     |                                                       |
 160 +---------------------+-------------------------------------------------------+
 161
 162 Document Version Changes
 163 ------------------------
 164
 165 This is the first version of the SampleVNF  in OPNFV.
 166 It includes the following documentation updates:
 167
 168 - SampleVNF User Guide:
 169   add "network service benchmarking(NSB)" chapter;
 170   add "SampleVNF - NSB Testing -Installation" chapter; add "SampleVNF API" chapter;
 171   add "SampleVNF user interface" chapter; Update SampleVNF installation chapter;
 172
 173 - SampleVNF Developer Guide
 174
 175 - SampleVNF Release Notes for SampleVNF: this document
 176
 177
 178 Feature additions
 179 -----------------
 180
 181 - SampleVNF RESTful API support
 182
 183 - Introduce Network service benchmarking
 184
 185
 186 Known Issues/Faults
 187 -------------------
 188
 189
 190
 191 Corrected Faults
 192 ----------------
 193
 194 Euphrates.1.0:
 195
 196 +----------------------------+------------------------------------------------+
 197 | **JIRA REFERENCE**         | **DESCRIPTION**                                |
 198 |                            |                                                |
 199 +----------------------------+------------------------------------------------+
 200 | JIRA: samplevnf-           |                                                |
 201 |                            |                                                |
 202 +----------------------------+------------------------------------------------+
 203
 204
 205 Euphrates  known restrictions/issues
 206 ====================================
 207 +-----------+-----------+----------------------------------------------+
 208 | Installer | Scenario  |  Issue                                       |
 209 +===========+===========+==============================================+
 210 |           |           |                                              |
 211 +-----------+-----------+----------------------------------------------+
 212
 213
 214 Open JIRA tickets
 215 =================
 216
 217 +----------------------------+------------------------------------------------+
 218 | **JIRA REFERENCE**         | **DESCRIPTION**                                |
 219 |                            |                                                |
 220 +----------------------------+------------------------------------------------+
 221 |                            |                                                |
 222 |                            |                                                |
 223 +----------------------------+------------------------------------------------+
 224
 225
 226 Useful links
 227 ============
 228
 229  - wiki project page: https://wiki.opnfv.org/display/SAM
 230
 231  - wiki SampleVNF Euphrates release planing page: https://wiki.opnfv.org/display/SAM/SampleVNF+Euphrates+Release+Planning
 232
 233  - SampleVNF repo: https://git.opnfv.org/cgit/samplevnf
 234
 235  - SampleVNF IRC chanel: #opnfv-samplevnf