docs/release/release-notes/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4
   5 This document provides the release notes for <Danube Release> of <Parser>.
   6
   7 .. contents::
   8    :depth: 3
   9    :local:
  10
  11
  12 Version history
  13 ---------------
  14
  15 +--------------------+--------------------+--------------------+----------------------+
  16 | **Date**           | **Ver.**           | **Author**         | **Comment**          |
  17 |                    |                    |                    |                      |
  18 +--------------------+--------------------+--------------------+----------------------+
  19 | 2016-04-20         | 0.5                | Howard Huang       | Brahmaputra Release  |
  20 |                    |                    |                    |                      |
  21 +--------------------+--------------------+--------------------+----------------------+
  22 | 2016-09-19         | 1.0                | Howard Huang       | Colorado Release     |
  23 |                    |                    |                    |                      |
  24 +--------------------+--------------------+--------------------+----------------------+
  25 | 2017-03-06         | 2.0                | Howard Huang       | Danube Release       |
  26 |                    |                    |                    |                      |
  27 +--------------------+--------------------+--------------------+----------------------+
  28 | 2017-09-25         | 5.0                | Shang Xiaodong     | Euphrates release    |
  29 |                    | 0.5 ONAP           |                    |                      |
  30 +--------------------+--------------------+--------------------+----------------------+
  31 | 2018-04-20         | 6.0                | Shang Xiaodong     | Fraser release       |
  32 |                    | 1.0 ONAP           |                    |                      |
  33 +--------------------+--------------------+--------------------+----------------------+
  34
  35 Important notes
  36 ===============
  37
  38 **Attention**: Parser's submodules should be installed independantly from OPNFV platform, for
  39 instructions please refer to the installation documention.
  40
  41
  42 Summary
  43 =======
  44
  45 OPNFV Parser Danube release has provides four submodules to serve as translation/prevalidation
  46 tools: tosca2heat, yang2tosca, policy2tosca, and verigraph. Specifically, tosca2heat module
  47 provides an integration of OpenStack tosca-parser and heat-translater
  48 upstream projects 0.7 release with additional Parser unique features, and includes nfv-toscaparser
  49  and nfv-heattranslaotor for ONAP community.
  50
  51
  52 Release Data
  53 ============
  54
  55
  56 +--------------------------------------+--------------------------------------+
  57 | **Project**                          | OPNFV Parser                         |
  58 +--------------------------------------+--------------------------------------+
  59 | **Repo/commit-ID**                   |                                      |
  60 +--------------------------------------+--------------------------------------+
  61 | **Release designation**              | Danube 1.0                           |
  62 +--------------------------------------+--------------------------------------+
  63 | **Release date**                     | E.g. 2015-04-16                      |
  64 +--------------------------------------+--------------------------------------+
  65 | **Purpose of the delivery**          | OPNFV Template Translation/Prevalida-|
  66 |                                      | tion tooling                         |
  67 +--------------------------------------+--------------------------------------+
  68
  69 Fraser Release Data
  70 -----------------------
  71
  72 +--------------------------------------+--------------------------------+
  73 | **Project**                          | OPNFV Parer                    |
  74 |                                      |                                |
  75 +--------------------------------------+--------------------------------+
  76 | **Repo/tag**                         | Parser/6.0.0                   |
  77 |                                      |                                |
  78 |                                      |                                |
  79 +--------------------------------------+--------------------------------+
  80 | **Bottlenecks Docker image tag**     | * 6.0.0                        |
  81 |                                      |                                |
  82 |                                      |                                |
  83 +--------------------------------------+--------------------------------+
  84 | **Release designation**              | * 6.0.0                        |
  85 |                                      |                                |
  86 |                                      |                                |
  87 +--------------------------------------+--------------------------------+
  88 | **Release date**                     | * Apr 20th 2018                |
  89 |                                      |                                |
  90 |                                      |                                |
  91 +--------------------------------------+--------------------------------+
  92 | **Purpose of the delivery**          | Fraser stable release          |
  93 |                                      |                                |
  94 |                                      | OPNFV Template Translation/    |
  95 |                                      | Prevalidation tooling          |
  96 +--------------------------------------+--------------------------------+
  97
  98 Euphrates Release Data
  99 -----------------------
 100
 101 +--------------------------------------+--------------------------------+
 102 | **Project**                          | OPNFV Parer                    |
 103 |                                      |                                |
 104 +--------------------------------------+--------------------------------+
 105 | **Repo/tag**                         | Parser/5.0.0                   |
 106 |                                      |                                |
 107 |                                      |                                |
 108 +--------------------------------------+--------------------------------+
 109 | **Bottlenecks Docker image tag**     | * 5.0.0                        |
 110 |                                      |                                |
 111 |                                      |                                |
 112 +--------------------------------------+--------------------------------+
 113 | **Release designation**              | * 5.0.0                        |
 114 |                                      |                                |
 115 |                                      |                                |
 116 +--------------------------------------+--------------------------------+
 117 | **Release date**                     | * Sept 25th 2017               |
 118 |                                      |                                |
 119 |                                      |                                |
 120 +--------------------------------------+--------------------------------+
 121 | **Purpose of the delivery**          | Euphrates stable release       |
 122 |                                      |                                |
 123 |                                      | OPNFV Template Translation/    |
 124 |                                      | Prevalidation tooling          |
 125 +--------------------------------------+--------------------------------+
 126
 127 Danube Release Data
 128 -----------------------
 129
 130 +--------------------------------------+--------------------------------+
 131 | **Project**                          | OPNFV Parer                    |
 132 |                                      |                                |
 133 +--------------------------------------+--------------------------------+
 134 | **Repo/tag**                         | Parser/danube.2.0              |
 135 |                                      |                                |
 136 +--------------------------------------+--------------------------------+
 137 | **Bottlenecks Docker image tag**     | * danube.2.0                   |
 138 |                                      |                                |
 139 |                                      |                                |
 140 +--------------------------------------+--------------------------------+
 141 | **Release designation**              | * Danube 2.0                   |
 142 |                                      |                                |
 143 |                                      |                                |
 144 +--------------------------------------+--------------------------------+
 145 | **Release date**                     | * March 6st 2017               |
 146 |                                      |                                |
 147 |                                      |                                |
 148 +--------------------------------------+--------------------------------+
 149 | **Purpose of the delivery**          | Danube stable release          |
 150 |                                      |                                |
 151 |                                      | OPNFV Template Translation/    |
 152 |                                      | Prevalidation tooling          |
 153 +--------------------------------------+--------------------------------+
 154
 155 Colorado Release Data
 156 -----------------------
 157
 158 +--------------------------------------+--------------------------------+
 159 | **Project**                          | OPNFV Parer                    |
 160 |                                      |                                |
 161 +--------------------------------------+--------------------------------+
 162 | **Repo/tag**                         | Parser/colorado.1.0            |
 163 |                                      |                                |
 164 +--------------------------------------+--------------------------------+
 165 | **Bottlenecks Docker image tag**     | * colorado.1.0                 |
 166 |                                      |                                |
 167 +--------------------------------------+--------------------------------+
 168 | **Release designation**              | * Colorado 1.0                 |
 169 |                                      |                                |
 170 +--------------------------------------+--------------------------------+
 171 | **Release date**                     | * September 22 2016            |
 172 |                                      |                                |
 173 +--------------------------------------+--------------------------------+
 174 | **Purpose of the delivery**          | Colorado stable release        |
 175 |                                      |                                |
 176 |                                      | OPNFV Template Translation/    |
 177 |                                      | Prevalidation tooling          |
 178 +--------------------------------------+--------------------------------+
 179
 180 Bramaputra Release Data
 181 -----------------------
 182
 183 +--------------------------------------+--------------------------------+
 184 | **Project**                          | OPNFV Parer                    |
 185 |                                      |                                |
 186 +--------------------------------------+--------------------------------+
 187 | **Repo/tag**                         | Parser/brahmaputra.1.0         |
 188 |                                      |                                |
 189 +--------------------------------------+--------------------------------+
 190 | **Bottlenecks Docker image tag**     | * brahmaputra.1.0              |
 191 |                                      |                                |
 192 +--------------------------------------+--------------------------------+
 193 | **Release designation**              | * Brahmaputra 1.0              |
 194 |                                      |                                |
 195 +--------------------------------------+--------------------------------+
 196 | **Release date**                     | * February 25 2016             |
 197 |                                      |                                |
 198 +--------------------------------------+--------------------------------+
 199 | **Purpose of the delivery**          | Brahmaputra stable release     |
 200 |                                      |                                |
 201 |                                      | OPNFV Template Translation/    |
 202 |                                      | Prevalidation tooling          |
 203 +--------------------------------------+--------------------------------+
 204
 205 Version change
 206 ^^^^^^^^^^^^^^
 207
 208 Module version changes
 209 ~~~~~~~~~~~~~~~~~~~~~~
 210
 211 - OpenStack tosca-parser and heat-translator have changed from 0.8 to 0.9
 212
 213 - Parseer support aarch64
 214
 215 - update verigraph module
 216
 217 - Release 0.5 and 1.0 for ONAP community
 218
 219 - no feature changes in yang2tosca and policy2tosca since Colorado Release.
 220
 221 Document version changes
 222 ~~~~~~~~~~~~~~~~~~~~~~~~
 223
 224 - Parser Dabube Release documentation has adoped a new format.
 225
 226 Reason for version
 227 ^^^^^^^^^^^^^^^^^^
 228
 229 Feature additions
 230 ~~~~~~~~~~~~~~~~~
 231
 232 **JIRA BACK-LOG:**
 233
 234 +--------------------------------------+--------------------------------------+
 235 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 236 |                                      |                                      |
 237 +--------------------------------------+--------------------------------------+
 238 | PARSER-111                           | Verigraph Code Base                  |
 239 +--------------------------------------+--------------------------------------+
 240 | PARSER-112                           | Init api gateway framework           |
 241 +--------------------------------------+--------------------------------------+
 242 | PARSER-113                           | Add input validation test case       |
 243 +--------------------------------------+--------------------------------------+
 244 | PARSER-114                           | Add output in vRNC for substitution  |
 245 |                                      | mappings.                            |
 246 +--------------------------------------+--------------------------------------+
 247 | PARSER-115                           | Add output validation for            |
 248 |                                      | substitution.                        |
 249 +--------------------------------------+--------------------------------------+
 250 | PARSER-116                           | Add output validation test case for  |
 251 |                                      | substitution.                        |
 252 +--------------------------------------+--------------------------------------+
 253 | PARSER-121                           | Add ip output in compute node        |
 254 +--------------------------------------+--------------------------------------+
 255 | PARSER-125                           | Package for funectest with docker    |
 256 |                                      | container.                           |
 257 +--------------------------------------+--------------------------------------+
 258 | PARSER-135                           | Support costum datatype in           |
 259 |                                      | capability.                          |
 260 +--------------------------------------+--------------------------------------+
 261 | PARSER-136                           | Support metadata validation          |
 262 +--------------------------------------+--------------------------------------+
 263 | PARSER-137                           | Support yaml file with suffix of yml |
 264 +--------------------------------------+--------------------------------------+
 265 | PARSER-138                           | Support costum datatype definition   |
 266 |                                      | cin parameters.                      |
 267 +--------------------------------------+--------------------------------------+
 268 | PARSER-141                           | Add required parameters validation   |
 269 |                                      | for nested service                   |
 270 +--------------------------------------+--------------------------------------+
 271 | PARSER-142                           | Add parameter validation in design   |
 272 |                                      | time for ONAP                        |
 273 +--------------------------------------+--------------------------------------+
 274 | PARSER-144                           | Add import file with suffix of yml   |
 275 |                                      | testcases                            |
 276 +--------------------------------------+--------------------------------------+
 277 | PARSER-146                           | Support template version of          |
 278 |                                      | tosca_simple_yaml_1_1                |
 279 +--------------------------------------+--------------------------------------+
 280 | PARSER-148                           | Add debug mode parameter             |
 281 +--------------------------------------+--------------------------------------+
 282 | PARSER-151                           | Refactor heat-translator setup.py    |
 283 +--------------------------------------+--------------------------------------+
 284 | PARSER-154                           | code optimizations about graph       |
 285 |                                      | manipulation and formula generation. |
 286 +--------------------------------------+--------------------------------------+
 287
 288
 289 Bug corrections
 290 ~~~~~~~~~~~~~~~
 291
 292 **JIRA TICKETS:**
 293
 294 +--------------------------------------+--------------------------------------+
 295 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 296 |                                      |                                      |
 297 +--------------------------------------+--------------------------------------+
 298 | PARSER-117                           | Fix ci bug when integrated with      |
 299 |                                      | functest                             |
 300 +--------------------------------------+--------------------------------------+
 301 | PARSER-122                           | Fix docs bug                         |
 302 +--------------------------------------+--------------------------------------+
 303 | PARSER-145                           | Fix exceptions overwritten when      |
 304 |                                      | nested import service topology       |
 305 +--------------------------------------+--------------------------------------+
 306 | PARSER-152                           | fix costum datatype definition       |
 307 |                                      | in parameters                        |
 308 +--------------------------------------+--------------------------------------+
 309 | PARSER-153                           | Fix StatefulEntityType when          |
 310 |                                      | entitytype is not define             |
 311 +--------------------------------------+--------------------------------------+
 312 | PARSER-155                           | Fix substitution mapping assigned    |
 313 |                                      | value to nodetemplate                |
 314 +--------------------------------------+--------------------------------------+
 315 | PARSER-156                           | Fix functest_run script for role     |
 316 |                                      | of heat_stack_owner                  |
 317 +--------------------------------------+--------------------------------------+
 318
 319
 320 Deliverables
 321 ------------
 322
 323 Software deliverables
 324 ^^^^^^^^^^^^^^^^^^^^^
 325
 326 - tosca2heat
 327 - yang2tosca
 328 - policy2tosca
 329 - verigraph
 330 - apigateway
 331
 332 Documentation deliverables
 333 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 334
 335 - release document
 336 - design document
 337 - development document
 338 - testing document
 339
 340
 341 Known Limitations, Issues and Workarounds
 342 =========================================
 343
 344 System Limitations
 345 ^^^^^^^^^^^^^^^^^^
 346
 347 None
 348
 349
 350
 351 Known issues
 352 ^^^^^^^^^^^^
 353
 354
 355 **JIRA TICKETS:**
 356
 357 +--------------------------------------+--------------------------------------+
 358 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 359 |                                      |                                      |
 360 +--------------------------------------+--------------------------------------+
 361 |                                      |                                      |
 362 +--------------------------------------+--------------------------------------+
 363 |                                      |                                      |
 364 +--------------------------------------+--------------------------------------+
 365
 366 Workarounds
 367 ^^^^^^^^^^^
 368
 369 <STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE>
 370
 371 <EXAMPLE>:
 372
 373 - In case the contact with a compute is lost - restart the compute host
 374 - In case the disk is full on a controller - delete all files in /tmp
 375
 376 Test Result
 377 ===========
 378
 379
 380 Parser test with functest runs with the following results:
 381
 382 +--------------------------------------+--------------------------------------+
 383 | **TEST-SUITE**                       | **Results:**                         |
 384 |                                      |                                      |
 385 +--------------------------------------+--------------------------------------+
 386 |   Parser with functest in fuel       |   PASS                               |
 387 +--------------------------------------+--------------------------------------+
 388 |   Parser with functest in apex       |   PASS                               |
 389 +--------------------------------------+--------------------------------------+
 390 |   Parser with functest in daisy      |   PASS                               |
 391 +--------------------------------------+--------------------------------------+
 392 |   Parser with functest in compass    |   PASS                               |
 393 +--------------------------------------+--------------------------------------+
 394 |   Parser with functest in joid       |   SKIP                               |
 395 +--------------------------------------+--------------------------------------+
 396
 397 References
 398 ==========
 399
 400
 401  - WIKI project page: https://wiki.opnfv.org/display/parser
 402
 403  - Parser jira page: https://jira.opnfv.org/secure/RapidBoard.jspa?rapidView=121&useStoredSettings=true
 404
 405  - Parser repo: https://git.opnfv.org/cgit/parser
 406
 407  - Parser CI dashboard: https://build.opnfv.org/ci/view/parser
 408
 409  - Parser IRC chanel: #opnfv-parser