docs/release-notes.rst

   1 .. Modifications Copyright 2017-2018 AT&T Intellectual Property.
   2 .. _release_notes:
   3
   4 .. Licensed under the Creative Commons License, Attribution 4.0 Intl.
   5    (the "License"); you may not use this documentation except in compliance
   6    with the License. You may obtain a copy of the License at
   7
   8 .. https://creativecommons.org/licenses/by/4.0/
   9
  10 .. Unless required by applicable law or agreed to in writing, software
  11    distributed under the License is distributed on an "AS IS" BASIS,
  12    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13    See the License for the specific language governing permissions and
  14    limitations under the License.
  15
  16 VNFRQTS Project Release Notes
  17 ==============================
  18
  19 Version: 6.0.0
  20 --------------
  21
  22 :Release Date: 2020-05-14
  23
  24 .. container:: note
  25
  26    :doc:`Detailed Summary of Changes <changes-by-section-frankfurt>`
  27
  28 A higher level summary of changes as well as non-requirement impacting
  29 changes can be found below.
  30
  31 **New Features**
  32     - Moved Release Notes to be more discover-able
  33     - Significant additions, updates, and removals in Security requirements
  34     - Updated latest
  35       :ref:`VES Event Listener Specification  <ves_event_listener_7_1>` to 7.1.1
  36     - Added :ref:`VES Event Listener Specification 5.4.1 <ves_event_listener_5_4_1>`
  37       as ONAP still supports this version
  38     - Updated Ansible Requirements in :ref:`vnf_configuration_management`
  39
  40 **Bug Fixes**
  41     - Fixed typos
  42     - Fixed metadata errors
  43     - Fixed traceability matrix rendering
  44     - Reformatted VES spec docs
  45     - Cleaning requirements for TOSCA/HEAT
  46     - Cleaning requirements for VNF or PNF
  47
  48 **Known Issues**
  49     - Links that refer to "latest" version are static.  Please report
  50       any broken links.
  51
  52 **Security Issues**
  53     - None
  54
  55 **Upgrade Notes**
  56     - If you would like to add requirements, you **MUST** follow
  57       `instructions on Wiki <https://wiki.onap.org/display/DW/VNFRQTS+How+to+Contribute>`__.
  58     - If you would like to see a list of JIRA tickets closed in El Alto,
  59       `please click here for Frankfurt changes <https://jira.onap.org/projects/VNFRQTS/versions/10841>`_.
  60
  61 **Deprecation Notes**
  62     - None
  63
  64 **Other**
  65     - None
  66
  67
  68 Version: 5.0.1
  69 --------------
  70
  71 :Release Date: 2019-08-16
  72
  73 .. container:: note
  74
  75    :doc:`Detailed Summmary of Changes <changes-by-section-el-alto>`
  76
  77 A higher level summary of changes as well as non-requirement impacting
  78 changes can be found below.
  79
  80 **New Features**
  81     - Added Release notes to be more discoverable
  82     - Added new Security Requirements
  83
  84 **Bug Fixes**
  85     - Fixed typos
  86     - Fixed metadata errors
  87     - Fixed traceability matrix rendering
  88     - Reformatted VES spec docs
  89     - Cleaning requirements for TOSCA/HEAT
  90     - Cleaning requirements for VNF or PNF
  91     - Granularized TOSCA Section
  92
  93 **Known Issues**
  94     - Links that refer to "latest" version are static.  Please report
  95       any broken links.
  96     - Doc references to Chapter 5 and 7 are breaking linkage in vnfrqts docs.
  97
  98 **Security Issues**
  99     - None
 100
 101 **Upgrade Notes**
 102     - If you would like to add requirements, you **MUST** follow
 103       `instructions on Wiki <https://wiki.onap.org/display/DW/VNFRQTS+How+to+Contribute>`__.
 104     - If you would like to see a list of JIRA tickets closed in El Alto,
 105       `please click here for El Alto changes <https://jira.onap.org/projects/VNFRQTS/versions/10737>`_.
 106
 107 **Deprecation Notes**
 108     - None
 109
 110 **Other**
 111     - None
 112
 113
 114 Version: 4.0.0
 115 --------------
 116
 117 :Release Date: 2019-5-30
 118
 119 .. container:: note
 120
 121    :doc:`Detailed Summmary of Changes <changes-by-section-dublin>`
 122
 123 A higher level summary of changes as well as non-requirement impacting
 124 changes can be found below.
 125
 126 **New Features**
 127     - Added information for PNF
 128     - Added Release notes to higher level
 129     - Added CICD build to generate requirements and create traceability matrix
 130     - Added Traceability matrix with dynamic links
 131     - Moved VES spec
 132     - Created RST Requirement generator in wiki
 133
 134 **Bug Fixes**
 135     - Fixed typos
 136     - Fixed metadata errors
 137     - Fixed XNF -> PNF or VNF
 138     - Cleaning requirements for TOSCA/HEAT
 139     - Cleaning requirements for VNF or PNF
 140
 141 **Known Issues**
 142     - Links that refer to "latest" version are static.  Please report
 143       any broken links.
 144     - Wiki RST generator has been disabled, please use local make_ids.py
 145       to create new requirements.
 146     - Traceability matrix table rendering issues.
 147
 148 **Security Issues**
 149     - None
 150
 151 **Upgrade Notes**
 152     - If you would like to add requirements, you **MUST** follow
 153       `instructions on Wiki <https://wiki.onap.org/display/DW/VNFRQTS+How+to+Contribute>`__.
 154     - If you would like to see a list of JIRA tickets closed in Dublin,
 155       `please click here for Dublin Changes <https://jira.onap.org/projects/VNFRQTS/versions/10474>`_.
 156
 157 **Deprecation Notes**
 158     - None
 159
 160 **Other**
 161     - None
 162
 163 Version: 3.0.1
 164 --------------
 165
 166 :Release Date: 2019-1-30
 167
 168 **New Features**
 169     - No new features added during Casablanca Maintenance release
 170
 171 **Bug Fixes**
 172     - Fixed typos
 173     - Fixed metadata errors
 174
 175 **Known Issues**
 176     - Links that refer to "latest" version are static.  Please report
 177       any broken links.
 178
 179 **Security Issues**
 180     - None
 181
 182 **Upgrade Notes**
 183     - If you would like to add requirements, you **MUST** follow
 184       `instructions on Wiki <https://wiki.onap.org/display/DW/VNFRQTS+How+to+Contribute>`__.
 185
 186 **Deprecation Notes**
 187     - None
 188
 189 **Other**
 190     - None
 191
 192
 193 Version: 3.0.0
 194 --------------
 195
 196 :Release Date: 2018-11-30
 197
 198 .. container:: note
 199
 200    :doc:`Detailed Summmary of Changes <changes-by-section-casablanca>`
 201
 202 A higher level summary of changes as well as non-requirement impacting
 203 changes can be found below.
 204
 205 **New Features**
 206     - Updated the Security requirements in Chapter 4 (Added, Removed, Reworded,
 207       or Moved)
 208     - Created new cybersecurity section in Chapter 4
 209     - Changed the theme of the documents
 210     - Moved Requirements list from Chapter 8 to Chapter 9
 211     - Added a downloadable, dynamic JSON of all requirements, separated by
 212       versions.  This is available on the Requirements List page.
 213     - Updated the hierarchy and moved the VNF Requirements to a higher level in
 214       the doc project
 215     - Updated and created new wiki material on how to contribute
 216     - Created enumerated requirements for TOSCA
 217     - Updated Heat requirements
 218     - Created new section for PNF Plug-and-Play with associated requirements
 219     - Updated Management requirements
 220     - Updated section for VES support
 221     - Introduced new directive for requirements to use metadata
 222     - Update test description annex
 223
 224 **Bug Fixes**
 225     - Fixed typos
 226     - Fixed broken links
 227     - Fixing formatting in examples to print properly
 228     - Fixed formatting of tables
 229
 230 **Known Issues**
 231     - Links that refer to "latest" version are static.  Please report
 232       any broken links.
 233
 234 **Security Issues**
 235     - None
 236
 237 **Upgrade Notes**
 238     - If you would like to add requirements, you **MUST** follow
 239       `instructions on Wiki <https://wiki.onap.org/display/DW/VNFRQTS+How+to+Contribute>`__.
 240
 241 **Deprecation Notes**
 242     - None
 243
 244 **Other**
 245     - None
 246
 247 Version: 2.0.0
 248 --------------
 249
 250 :Release Date: 2018-06-07 (Beijing Release)
 251
 252 **New Features**
 253     - Chapter 5 Requirements changed from test to numbered requirements.
 254
 255         -https://jira.onap.org/browse/VNFRQTS-83
 256
 257     - Chapter Header re-structured to help readability of documents.
 258
 259         - https://jira.onap.org/browse/VNFRQTS-130
 260         - https://wiki.onap.org/display/DW/VNF+Requirement+Updated+Header+Structure
 261
 262     - Changed language to take into consider PNF (xNF).
 263
 264         - https://jira.onap.org/browse/VNFRQTS-188
 265         - https://jira.onap.org/browse/VNFRQTS-189
 266
 267     - Added copyright License Header in all source files
 268
 269         - https://jira.onap.org/browse/VNFRQTS-180
 270
 271 **Bug Fixes**
 272     - Fixed Chapter Header Structure warnings.
 273
 274         - https://jira.onap.org/browse/VNFRQTS-193
 275
 276     - Found table in Chapter 8 section C.2 that was not printing,
 277       corrected format.
 278
 279         - https://jira.onap.org/browse/VNFRQTS-192
 280
 281     - Fixes for language within requirements from clarification/grammar.
 282
 283         - The full list of changes made to requirements  is available on `JIRA <https://jira.onap.org/projects/VNFRQTS/issues>`_
 284
 285 **Known Issues**
 286     - 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>`_
 287
 288         - https://jira.onap.org/browse/VNFRQTS-195
 289
 290 **Security Issues**
 291     - None
 292
 293 **Upgrade Notes**
 294     - Requirements will still need to go and be updated in multiple
 295       locations, but there is an upgrade proposal to handle this.
 296
 297 **Deprecation Notes**
 298     - Chapter numbers will no longer be used, numbers for chapters
 299       will be assigned dynamically based off of the header structure in rst.
 300
 301         - More information on the new header structure is available on `Headers <https://wiki.onap.org/display/DW/VNF+Requirement+Updated+Header+Structure>`_
 302
 303 **Other**
 304     NA
 305
 306 Version: 1.0.0
 307 --------------
 308
 309 :Release Date: 2017-11-16 (Amsterdam Release)
 310
 311 **New Features**
 312
 313     - Initial release of VNF Provider Guidelines and Requirements for
 314       Open Network Automation Platform (ONAP)
 315
 316     - This initial releases is based on seed documents that came from Open-O
 317       and Open ECOMP. For details, refer
 318       `Seed Document Mappings to VNFRQTS Deliverable Outlines <https://wiki.onap.org/display/DW/Seed+Document+Mappings+to+VNFRQTS+Deliverable+Outlines>`_.
 319
 320     - This release provides a consolidated list of requirements as prototype
 321       text for RFPs to acquire VNFs to run in an ONAP context. The
 322       requirements are uniquely numbered and in a consistent format.
 323
 324 **Bug Fixes**
 325     - None
 326
 327 **Known Issues**
 328     - `VNFRQTS-83 Chapter 5, Section B Requirements <https://jira.onap.org/browse/VNFRQTS-83>`__.
 329
 330     - Heat requirements have not been formatted into the standard
 331       format used throughout the document.
 332
 333     - Therefore they are not included in the summary of requirements
 334       listed in Appendix 8.d.
 335
 336     - These requirements can be found by searching for the keywords must,
 337       should in the sections of the document that discuss Heat.
 338
 339 **Security Issues**
 340     - No known security issues.
 341
 342 **Upgrade Notes**
 343     - Initial release - none
 344
 345 **Deprecation Notes**
 346     - Initial release - none
 347
 348 **Other**
 349     NA
 350
 351 ===========
 352
 353 End of Release Notes