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