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