summaryrefslogtreecommitdiffstats
path: root/docs/release-notes.rst
blob: a36c68a336bbd9e5d2e38ed18e2f6b6ac8a2c2e7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
.. Modifications Copyright © 2017-2018 AT&T Intellectual Property.

.. Licensed under the Creative Commons License, Attribution 4.0 Intl.
   (the "License"); you may not use this documentation except in compliance
   with the License. You may obtain a copy of the License at

.. https://creativecommons.org/licenses/by/4.0/

.. Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.


VNF Requirements Release Notes
==============================

Version: 3.0.0
--------------

:Release Date: In Progress (Casablanca Release)

A detailed summary of all requirement changes per section can be found
:doc:`here <changes-by-section-casablanca>`.

A higher level summary of changes as well as non-requirement impacting
changes can be found below.

**New Features**
    - Added R-17528 to Heat section regarding Nested YAML requirements

**Bug Fixes**

**Known Issues**

**Security Issues**
    - None

**Upgrade Notes**

**Deprecation Notes**

**Other**

Version: 2.0.0
--------------

:Release Date: 2018-06-07 (Beijing Release)

**New Features**
    - Chapter 5 Requirements changed from test to numbered requirements.

        -https://jira.onap.org/browse/VNFRQTS-83

    - Chapter Header re-structured to help readability of documents.

        - https://jira.onap.org/browse/VNFRQTS-130
        - https://wiki.onap.org/display/DW/VNF+Requirement+Updated+Header+Structure

    - Changed language to take into consider PNF (xNF).

        - https://jira.onap.org/browse/VNFRQTS-188
        - https://jira.onap.org/browse/VNFRQTS-189

    - Added copyright License Header in all source files

        - https://jira.onap.org/browse/VNFRQTS-180

**Bug Fixes**
    - Fixed Chapter Header Structure warnings.

        - https://jira.onap.org/browse/VNFRQTS-193

    - Found table in Chapter 8 section C.2 that was not printing,
      corrected format.

        - https://jira.onap.org/browse/VNFRQTS-192

    - Fixes for language within requirements from clarification/grammar.

        - The full list of changes made to requirements  is available on `JIRA <https://jira.onap.org/projects/VNFRQTS/issues>`_

**Known Issues**
    - 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>`_

        - https://jira.onap.org/browse/VNFRQTS-195

**Security Issues**
    - None

**Upgrade Notes**
    - Requirements will still need to go and be updated in multiple
      locations, but there is an upgrade proposal to handle this.

**Deprecation Notes**
    - Chapter numbers will no longer be used, numbers for chapters
      will be assigned dynamically based off of the header structure in rst.

        - More information on the new header structure is available on `Headers <https://wiki.onap.org/display/DW/VNF+Requirement+Updated+Header+Structure>`_

**Other**
    NA

Version: 1.0.0
--------------

:Release Date: 2017-11-16 (Amsterdam Release)

**New Features**

    - Initial release of VNF Provider Guidelines and Requirements for
      Open Network Automation Platform (ONAP)

    - This initial releases is based on seed documents that came from Open-O
      and Open ECOMP. For details, refer
      `Seed Document Mappings to VNFRQTS Deliverable Outlines <https://wiki.onap.org/display/DW/Seed+Document+Mappings+to+VNFRQTS+Deliverable+Outlines>`_.

    - This release provides a consolidated list of requirements as prototype
      text for RFPs to acquire VNFs to run in an ONAP context. The
      requirements are uniquely numbered and in a consistent format.

**Bug Fixes**
    - None

**Known Issues**
    - `VNFRQTS-83 Chapter 5, Section B Requirements <https://jira.onap.org/browse/VNFRQTS-83>`_.

    - Heat requirements have not been formatted into the standard
      format used throughout the document.

    - Therefore they are not included in the summary of requirements
      listed in Appendix 8.d.

    - These requirements can be found by searching for the keywords must,
      should in the sections of the document that discuss Heat.

**Security Issues**
    - No known security issues.

**Upgrade Notes**
    - Initial release - none

**Deprecation Notes**
    - Initial release - none

**Other**
    NA

===========

End of Release Notes