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