summaryrefslogtreecommitdiffstats
path: root/docs/nfvparser/release-notes/release-notes.rst
blob: 395dd6b060af1735dfb19db6f05ff91412692b49 (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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0


This document provides the release notes for nfv-toscaparser.

.. contents::
   :depth: 3
   :local:


Version history
---------------

+--------------------+--------------------+--------------------+--------------------+
| **Date**           | **Ver.**           | **Author**         | **Comment**        |
|                    |                    |                    |                    |
+--------------------+--------------------+--------------------+--------------------+
| 2017-09-25         | 0.5.0                | Shang Xiaodong   |  ONAP release 1    |
|                    |                    |                    |                    |
+--------------------+--------------------+--------------------+--------------------+
|                    |                    |                    |                    |
|                    |                    |                    |                    |
+--------------------+--------------------+--------------------+--------------------+


Summary
=======

Modeling has provides two submodules to serve as simple tosca template parse/prevalidation
tools: nfv-toscaparser and javatoscachecker. Specifically, nfv-toscaparser module provides
an integration of OpenStack tosca-parser and OPNFV parser with additional some unique features
from ONAP.


Release Data
============


+--------------------------------------+--------------------------------------+
| **Project**                          | ONAP Modeling                        |
+--------------------------------------+--------------------------------------+
| **Repo/commit-ID**                   |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Release 1.0                          |
+--------------------------------------+--------------------------------------+
| **Release date**                     | E.g. 2017-09-25                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | Simple TOSCA Template Parse/Preval-  |
|                                      | idation tooling                      |
+--------------------------------------+--------------------------------------+

Version change
^^^^^^^^^^^^^^

Module version changes
~~~~~~~~~~~~~~~~~~~~~~

- OpenStack tosca-parser have changed from 0.8

- new feature added according to the others ONAP project's requirements

- Fixed some bugs.

Document version changes
~~~~~~~~~~~~~~~~~~~~~~~~

- nfv-toscaparser documentation has adoped a new format.

Reason for version
^^^^^^^^^^^^^^^^^^
Feature additions
~~~~~~~~~~~~~~~~~
<STATE ADDED FEATURES BY REFERENCE TO JIRA>

<EXAMPLE>:

**JIRA BACK-LOG:**

+---------------------+--------------------------------------+
| **REFERENCE ID**    | **SLOGAN**                           |
|                     |                                      |
+---------------------+--------------------------------------+
|  1                  | Verigraph Code Base                  |
+---------------------+--------------------------------------+
|  2                  | Init api gateway framework           |
+---------------------+--------------------------------------+
|  3                  | Add input validation test case       |
+---------------------+--------------------------------------+
|  4                  | Add output in vRNC for substitution  |
|                     | mappings.                            |
+---------------------+--------------------------------------+
|  5                  | Add output validation for            |
|                     | substitution.                        |
+---------------------+--------------------------------------+
|  6                  | Add output validation test case for  |
|                     | substitution.                        |
+---------------------+--------------------------------------+
|  7                  | Add ip output in compute node        |
+---------------------+--------------------------------------+
|  8                  | Package for funectest with docker    |
|                     | container.                           |
+---------------------+--------------------------------------+
|  9                  | Support costum datatype in           |
|                     | capability.                          |
+---------------------+--------------------------------------+
|  10                 | Support metadata validation          |
+---------------------+--------------------------------------+
|  11                 | Support yaml file with suffix of yml |
+---------------------+--------------------------------------+
|  12                 | Support costum datatype definition   |
|                     | cin parameters.                      |
+---------------------+--------------------------------------+
|  13                 | Add required parameters validation   |
|                     | for nested service                   |
+---------------------+--------------------------------------+
|  14                 | Add parameter validation in design   |
|                     | time for ONAP                        |
+---------------------+--------------------------------------+
|  15                 | Add import file with suffix of yml   |
|                     | testcases                            |
+---------------------+--------------------------------------+
|  16                 | Support template version of          |
|                     | tosca_simple_yaml_1_1                |
+---------------------+--------------------------------------+
|  17                 | Add debug mode parameter             |
+---------------------+--------------------------------------+
|  18                 | Refactor heat-translator setup.py    |
+---------------------+--------------------------------------+
|  19                 | code optimizations about graph       |
|                     | manipulation and formula generation. |
+---------------------+--------------------------------------+


Bug corrections
~~~~~~~~~~~~~~~

**JIRA TICKETS:**

+---------------------+--------------------------------------+
| **REFERENCE ID**    | **SLOGAN**                           |
|                     |                                      |
+---------------------+--------------------------------------+
|  1                  | Fix ci bug when integrated with      |
|                     | functest                             |
+---------------------+--------------------------------------+
|  2                  | Fix docs bug                         |
+---------------------+--------------------------------------+
|  3                  | Fix exceptions overwritten when      |
|                     | nested import service topology       |
+---------------------+--------------------------------------+
|  4                  | fix costum datatype definition       |
|                     | in parameters                        |
+---------------------+--------------------------------------+
|  5                  | Fix StatefulEntityType when          |
|                     | entitytype is not define             |
+---------------------+--------------------------------------+
|  6                  | Fix substitution mapping assigned    |
|                     | value to nodetemplate                |
+---------------------+--------------------------------------+
|  7                  | Fix functest_run script for role     |
|                     | of heat_stack_owner                  |
+---------------------+--------------------------------------+


Deliverables
------------

Software deliverables
^^^^^^^^^^^^^^^^^^^^^

- nfv-toscaaparser


Documentation deliverables
^^^^^^^^^^^^^^^^^^^^^^^^^^

- release document
- installation document
- user guide document


Known Limitations, Issues and Workarounds
=========================================

System Limitations
^^^^^^^^^^^^^^^^^^


Known issues
^^^^^^^^^^^^


**JIRA TICKETS:**

+--------------------------------------+--------------------------------------+
| **REFERENCE ID**                     | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Workarounds
^^^^^^^^^^^

<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE>

<EXAMPLE>:

- In case the contact with a compute is lost - restart the compute host
- In case the disk is full on a controller - delete all files in /tmp

Test Result
===========
<STATE THE QA COVERAGE AND RESULTS>

<EXAMPLE>:

Test runs with the following results:

+--------------------------------------+--------------------------------------+
| **TEST-SUITE**                       | **Results:**                         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|   Unit test                          |   PASS                               |
+--------------------------------------+--------------------------------------+