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 | 2017-03-06         | 1.0                | Howard Huang       | Danube Release     |
  20 |                    |                    |                    |                    |
  21 +--------------------+--------------------+--------------------+--------------------+
  22 |                    |                    |                    |                    |
  23 |                    |                    |                    |                    |
  24 +--------------------+--------------------+--------------------+--------------------+
  25 |                    |                    |                    |                    |
  26 |                    |                    |                    |                    |
  27 +--------------------+--------------------+--------------------+--------------------+
  28
  29 Important notes
  30 ===============
  31
  32 **Attention**: Parser's submodules should be installed independantly from OPNFV platform, for
  33 instructions please refer to the installation documention.
  34
  35
  36 Summary
  37 =======
  38
  39 OPNFV Parser Danube release has provides four submodules to serve as translation/prevalidation
  40 tools: tosca2heat, yang2tosca, policy2tosca, and verigraph. Specifically, tosca2heat module
  41 provides an integration of OpenStack tosca-parser and heat-translater
  42 upstream projects 0.7 release with additional Parser unique features.
  43
  44
  45 Release Data
  46 ============
  47
  48
  49 +--------------------------------------+--------------------------------------+
  50 | **Project**                          | OPNFV Parser                         |
  51 +--------------------------------------+--------------------------------------+
  52 | **Repo/commit-ID**                   |                                      |
  53 +--------------------------------------+--------------------------------------+
  54 | **Release designation**              | Danube 1.0                           |
  55 +--------------------------------------+--------------------------------------+
  56 | **Release date**                     | E.g. 2015-04-16                      |
  57 +--------------------------------------+--------------------------------------+
  58 | **Purpose of the delivery**          | OPNFV Template Translation/Prevalida-|
  59 |                                      | tion tooling                         |
  60 +--------------------------------------+--------------------------------------+
  61
  62 Version change
  63 ^^^^^^^^^^^^^^^^
  64
  65 Module version changes
  66 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  67
  68 - OpenStack tosca-parser and heat-translator have changed from 0.6 to 0.7
  69
  70 - new verigraph module
  71
  72 - no feature changes in yang2tosca and policy2tosca since Colorado Release.
  73
  74 Document version changes
  75 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  76
  77 - Parser Dabube Release documentation has adoped a new format.
  78
  79 Reason for version
  80 ^^^^^^^^^^^^^^^^^^^^
  81 Feature additions
  82 ~~~~~~~~~~~~~~~~~~~~~~~
  83 <STATE ADDED FEATURES BY REFERENCE TO JIRA>
  84
  85 <EXAMPLE>:
  86
  87 **JIRA BACK-LOG:**
  88
  89 +--------------------------------------+--------------------------------------+
  90 | **JIRA REFERENCE**                   | **SLOGAN**                           |
  91 |                                      |                                      |
  92 +--------------------------------------+--------------------------------------+
  93 | PARSER-111                           | Verigraph Code Base                  |
  94 +--------------------------------------+--------------------------------------+
  95 | PARSER-112                           | Init api gateway framework           |
  96 +--------------------------------------+--------------------------------------+
  97 | PARSER-113                           | Add input validation test case       |
  98 +--------------------------------------+--------------------------------------+
  99 | PARSER-114                           | Add output in vRNC for substitution  |
 100 |                                      | mappings.                            |
 101 +--------------------------------------+--------------------------------------+
 102 | PARSER-115                           | Add output validation for            |
 103 |                                      | substitution.                        |
 104 +--------------------------------------+--------------------------------------+
 105 | PARSER-116                           | Add output validation test case for  |
 106 |                                      | substitution.                        |
 107 +--------------------------------------+--------------------------------------+
 108 | PARSER-121                           | Add ip output in compute node        |
 109 +--------------------------------------+--------------------------------------+
 110
 111
 112 Bug corrections
 113 ~~~~~~~~~~~~~~~~~~~~~
 114
 115 **JIRA TICKETS:**
 116
 117 +--------------------------------------+--------------------------------------+
 118 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 119 |                                      |                                      |
 120 +--------------------------------------+--------------------------------------+
 121 | PARSER-117                           | Fix ci bug when integrated with      |
 122 |                                      | functest                             |
 123 +--------------------------------------+--------------------------------------+
 124 | PARSER-122                           | Fix docs bug                         |
 125 +--------------------------------------+--------------------------------------+
 126
 127 Deliverables
 128 ------------
 129
 130 Software deliverables
 131 ^^^^^^^^^^^^^^^^^^^^^
 132
 133 - tosca2heat
 134 - yang2tosca
 135 - policy2tosca
 136 - verigraph
 137 - apigateway
 138
 139 Documentation deliverables
 140 ^^^^^^^^^^^^^^^^^^^^^^^^^^
 141
 142 - release document
 143 - design document
 144 - development document
 145 - testing document
 146
 147
 148 Known Limitations, Issues and Workarounds
 149 =========================================
 150
 151 System Limitations
 152 ^^^^^^^^^^^^^^^^^^
 153
 154
 155
 156
 157 Known issues
 158 ^^^^^^^^^^^^
 159
 160
 161 **JIRA TICKETS:**
 162
 163 +--------------------------------------+--------------------------------------+
 164 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 165 |                                      |                                      |
 166 +--------------------------------------+--------------------------------------+
 167 |                                      |                                      |
 168 +--------------------------------------+--------------------------------------+
 169 |                                      |                                      |
 170 +--------------------------------------+--------------------------------------+
 171
 172 Workarounds
 173 ^^^^^^^^^^^
 174
 175 <STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE>
 176
 177 <EXAMPLE>:
 178
 179 - In case the contact with a compute is lost - restart the compute host
 180 - In case the disk is full on a controller - delete all files in /tmp
 181
 182 Test Result
 183 ===========
 184 <STATE THE QA COVERAGE AND RESULTS>
 185
 186 <EXAMPLE>:
 187
 188 Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results:
 189
 190 +--------------------------------------+--------------------------------------+
 191 | **TEST-SUITE**                       | **Results:**                         |
 192 |                                      |                                      |
 193 +--------------------------------------+--------------------------------------+
 194 |                                      |                                      |
 195 +--------------------------------------+--------------------------------------+
 196 |                                      |                                      |
 197 +--------------------------------------+--------------------------------------+
 198
 199 References
 200 ==========
 201
 202
 203 For more information on the OPNFV Danube release, please see:
 204
 205 http://opnfv.org/danube