docs/release-notes.rst

   1 .. Modifications Copyright © 2017-2018 AT&T Intellectual Property.
   2
   3 .. Licensed under the Creative Commons License, Attribution 4.0 Intl.
   4    (the "License"); you may not use this documentation except in compliance
   5    with the License. You may obtain a copy of the License at
   6
   7 .. https://creativecommons.org/licenses/by/4.0/
   8
   9 .. Unless required by applicable law or agreed to in writing, software
  10    distributed under the License is distributed on an "AS IS" BASIS,
  11    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12    See the License for the specific language governing permissions and
  13    limitations under the License.
  14
  15
  16 VNF Requirements Release Notes
  17 ==============================
  18
  19 Version: 3.0.0
  20 --------------
  21
  22 :Release Date: In Progress (Casablanca Release)
  23
  24 A detailed summary of all requirement changes per section can be found
  25 :doc:`here <changes-by-section-casablanca>`.
  26
  27 A higher level summary of changes as well as non-requirement impacting
  28 changes can be found below.
  29
  30 **New Features**
  31     - Updated the Security requirements in Chapter 4 (Added, Removed, Reworded,
  32       or Moved)
  33     - Created new cybersecurity section in Chapter 4
  34     - Changed the theme of the documents
  35     - Moved Requirements list from Chapter 8 to Chapter 9
  36     - Added a downloadable, dynamic JSON of all requirements, separated by
  37       versions.  This is available on the Requirements List page.
  38     - Updated the hierarchy and moved the VNF Requirements to a higher level in
  39       the doc project
  40     - Updated and created new wiki material on how to contribute
  41     - Created enumerated requirements for TOSCA
  42     - Updated Heat requirements
  43     - Created new section for PNF Plug-and-Play with associated requirements
  44     - Updated Management requirements
  45     - Updated section for VES support
  46     - Introduced new directive for requirements to use metadata
  47     - Update test description annex
  48
  49 **Bug Fixes**
  50     - Fixed typos
  51     - Fixed broken links
  52     - Fixing formatting in examples to print properly
  53     - Fixed formatting of tables
  54
  55 **Known Issues**
  56     - Links that refer to "latest" version are static.  Please report
  57       any broken links.
  58
  59 **Security Issues**
  60     - None
  61
  62 **Upgrade Notes**
  63     - If you would like to add requirements, you **MUST** follow
  64       `instructions on Wiki <https://wiki.onap.org/display/DW/VNFRQTS+How+to+Contribute>`__.
  65
  66 **Deprecation Notes**
  67     - None
  68
  69 **Other**
  70     - None
  71
  72 Version: 2.0.0
  73 --------------
  74
  75 :Release Date: 2018-06-07 (Beijing Release)
  76
  77 **New Features**
  78     - Chapter 5 Requirements changed from test to numbered requirements.
  79
  80         -https://jira.onap.org/browse/VNFRQTS-83
  81
  82     - Chapter Header re-structured to help readability of documents.
  83
  84         - https://jira.onap.org/browse/VNFRQTS-130
  85         - https://wiki.onap.org/display/DW/VNF+Requirement+Updated+Header+Structure
  86
  87     - Changed language to take into consider PNF (xNF).
  88
  89         - https://jira.onap.org/browse/VNFRQTS-188
  90         - https://jira.onap.org/browse/VNFRQTS-189
  91
  92     - Added copyright License Header in all source files
  93
  94         - https://jira.onap.org/browse/VNFRQTS-180
  95
  96 **Bug Fixes**
  97     - Fixed Chapter Header Structure warnings.
  98
  99         - https://jira.onap.org/browse/VNFRQTS-193
 100
 101     - Found table in Chapter 8 section C.2 that was not printing,
 102       corrected format.
 103
 104         - https://jira.onap.org/browse/VNFRQTS-192
 105
 106     - Fixes for language within requirements from clarification/grammar.
 107
 108         - The full list of changes made to requirements  is available on `JIRA <https://jira.onap.org/projects/VNFRQTS/issues>`_
 109
 110 **Known Issues**
 111     - Need to review requirements that have bullet points as well as paragraphs to meet guidelines listed on `VNFRQTS <https://wiki.onap.org/display/DW/VNFRQTS+Requirement+Format+discussion>`_
 112
 113         - https://jira.onap.org/browse/VNFRQTS-195
 114
 115 **Security Issues**
 116     - None
 117
 118 **Upgrade Notes**
 119     - Requirements will still need to go and be updated in multiple
 120       locations, but there is an upgrade proposal to handle this.
 121
 122 **Deprecation Notes**
 123     - Chapter numbers will no longer be used, numbers for chapters
 124       will be assigned dynamically based off of the header structure in rst.
 125
 126         - More information on the new header structure is available on `Headers <https://wiki.onap.org/display/DW/VNF+Requirement+Updated+Header+Structure>`_
 127
 128 **Other**
 129     NA
 130
 131 Version: 1.0.0
 132 --------------
 133
 134 :Release Date: 2017-11-16 (Amsterdam Release)
 135
 136 **New Features**
 137
 138     - Initial release of VNF Provider Guidelines and Requirements for
 139       Open Network Automation Platform (ONAP)
 140
 141     - This initial releases is based on seed documents that came from Open-O
 142       and Open ECOMP. For details, refer
 143       `Seed Document Mappings to VNFRQTS Deliverable Outlines <https://wiki.onap.org/display/DW/Seed+Document+Mappings+to+VNFRQTS+Deliverable+Outlines>`_.
 144
 145     - This release provides a consolidated list of requirements as prototype
 146       text for RFPs to acquire VNFs to run in an ONAP context. The
 147       requirements are uniquely numbered and in a consistent format.
 148
 149 **Bug Fixes**
 150     - None
 151
 152 **Known Issues**
 153     - `VNFRQTS-83 Chapter 5, Section B Requirements <https://jira.onap.org/browse/VNFRQTS-83>`__.
 154
 155     - Heat requirements have not been formatted into the standard
 156       format used throughout the document.
 157
 158     - Therefore they are not included in the summary of requirements
 159       listed in Appendix 8.d.
 160
 161     - These requirements can be found by searching for the keywords must,
 162       should in the sections of the document that discuss Heat.
 163
 164 **Security Issues**
 165     - No known security issues.
 166
 167 **Upgrade Notes**
 168     - Initial release - none
 169
 170 **Deprecation Notes**
 171     - Initial release - none
 172
 173 **Other**
 174     NA
 175
 176 ===========
 177
 178 End of Release Notes