docs/templates/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 OPNFV <Project Name> Release Notes
   6 ======================================================================
   7
   8 This document provides the release notes for <RELEASE> of <COMPONENT>.
   9
  10 .. contents::
  11    :depth: 3
  12    :local:
  13
  14
  15 Version history
  16 ------------------
  17
  18 +--------------------+--------------------+--------------------+--------------------+
  19 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  20 |                    |                    |                    |                    |
  21 +--------------------+--------------------+--------------------+--------------------+
  22 | 2015-04-14         | 0.1.0              | Jonas Bjurel       | First draft        |
  23 |                    |                    |                    |                    |
  24 +--------------------+--------------------+--------------------+--------------------+
  25 |                    | 0.1.1              |                    |                    |
  26 |                    |                    |                    |                    |
  27 +--------------------+--------------------+--------------------+--------------------+
  28 |                    | 1.0                |                    |                    |
  29 |                    |                    |                    |                    |
  30 +--------------------+--------------------+--------------------+--------------------+
  31
  32 Important notes
  33 -----------------
  34
  35 <STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE>
  36
  37 <EXAMPLE>:
  38
  39 **Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master -
  40 see the OPNFV@Fuel SW installation instructions
  41
  42 Summary
  43 ------------
  44
  45 <SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
  46
  47 <EXAMPLE>:
  48
  49 Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1,
  50 but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations......
  51
  52 Release Data
  53 ---------------
  54 <STATE RELEVANT RELEASE DATA/RECORDS>
  55
  56 <EXAMPLE>:
  57
  58 +--------------------------------------+--------------------------------------+
  59 | **Project**                          | E.g. Arno/genesis/fuel@opnfv         |
  60 |                                      |                                      |
  61 +--------------------------------------+--------------------------------------+
  62 | **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
  63 |                                      |                                      |
  64 +--------------------------------------+--------------------------------------+
  65 | **Release designation**              | E.g. Arno RC2                        |
  66 |                                      |                                      |
  67 +--------------------------------------+--------------------------------------+
  68 | **Release date**                     | E.g. 2015-04-16                      |
  69 |                                      |                                      |
  70 +--------------------------------------+--------------------------------------+
  71 | **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|
  72 |                                      |                                      |
  73 +--------------------------------------+--------------------------------------+
  74
  75 Version change
  76 ^^^^^^^^^^^^^^^^
  77
  78 Module version changes
  79 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  80 <STATE WHAT UPSTREAM, - AS WELL AS OPNFV MODULE VERSIONS HAVE CHANGED>
  81
  82 <EXAMPLE>:
  83
  84 - Fuel have changed from 5.1 to 6.0.1
  85
  86 - OpenDaylight has changed from Helium-SR1 to Helium-SR2
  87
  88 Document version changes
  89 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  90 <STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE>
  91
  92 <EXAMPLE>:
  93
  94 - The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2
  95
  96 Reason for version
  97 ^^^^^^^^^^^^^^^^^^^^
  98 Feature additions
  99 ~~~~~~~~~~~~~~~~~~~~~~~
 100 <STATE ADDED FEATURES BY REFERENCE TO JIRA>
 101
 102 <EXAMPLE>:
 103
 104 **JIRA BACK-LOG:**
 105
 106 +--------------------------------------+--------------------------------------+
 107 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 108 |                                      |                                      |
 109 +--------------------------------------+--------------------------------------+
 110 | BGS-123                              | ADD OpenDaylight ml2 integration     |
 111 |                                      |                                      |
 112 +--------------------------------------+--------------------------------------+
 113 | BGS-456                              | Add auto-deployment of Fuel@OPNFV    |
 114 |                                      |                                      |
 115 +--------------------------------------+--------------------------------------+
 116
 117 Bug corrections
 118 ~~~~~~~~~~~~~~~~~~~~~
 119
 120 **JIRA TICKETS:**
 121
 122 +--------------------------------------+--------------------------------------+
 123 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 124 |                                      |                                      |
 125 +--------------------------------------+--------------------------------------+
 126 | BGS-888                              | Fuel doesn't deploy                  |
 127 |                                      |                                      |
 128 +--------------------------------------+--------------------------------------+
 129 | BGS-999                              | Floating IP doesn't work             |
 130 |                                      |                                      |
 131 +--------------------------------------+--------------------------------------+
 132
 133 Deliverables
 134 ----------------
 135
 136 Software deliverables
 137 ^^^^^^^^^^^^^^^^^^^^^^^
 138
 139 <STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
 140
 141 <EXAMPLE>:
 142
 143 Documentation deliverables
 144 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 145
 146 <STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
 147
 148 <EXAMPLE>:
 149
 150 Known Limitations, Issues and Workarounds
 151 --------------------------------------------
 152
 153 System Limitations
 154 ^^^^^^^^^^^^^^^^^^^^
 155 <STATE ALL RELEVANT SYSTEM LIMITATIONS>
 156
 157 <EXAMPLE>:
 158
 159 **Max number of blades:**   1 Fuel master, 3 Controllers, 20 Compute blades
 160
 161 **Min number of blades:**   1 Fuel master, 1 Controller, 1 Compute blade
 162
 163 **Storage:**    Ceph is the only supported storage configuration.
 164
 165 **Max number of networks:**   3800 (Needs special switch config.)
 166
 167 **L3Agent:**   L3 agent and floating IPs is not supported.
 168
 169 Known issues
 170 ^^^^^^^^^^^^^^^
 171 <STATE ALL KNOWN ISSUES WITH JIRA REFERENCE>
 172
 173 <EXAMPLE>:
 174
 175 **JIRA TICKETS:**
 176
 177 +--------------------------------------+--------------------------------------+
 178 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 179 |                                      |                                      |
 180 +--------------------------------------+--------------------------------------+
 181 | BGS-987                              | Nova-compute process does            |
 182 |                                      | not re-spawn when killed             |
 183 |                                      |                                      |
 184 +--------------------------------------+--------------------------------------+
 185 | BGS-654                              | MOS 5.1 : neutron net-list returns   |
 186 |                                      | "400 Bad request"                    |
 187 |                                      |                                      |
 188 +--------------------------------------+--------------------------------------+
 189
 190 Workarounds
 191 ^^^^^^^^^^^^^^^^^
 192
 193 <STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE>
 194
 195 <EXAMPLE>:
 196
 197 - In case the contact with a compute is lost - restart the compute host
 198 - In case the disk is full on a controller - delete all files in /tmp
 199
 200 Test Result
 201 ---------------
 202 <STATE THE QA COVERAGE AND RESULTS>
 203
 204 <EXAMPLE>:
 205
 206 Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results:
 207
 208 +--------------------------------------+--------------------------------------+
 209 | **TEST-SUITE**                       | **Results:**                         |
 210 |                                      |                                      |
 211 +--------------------------------------+--------------------------------------+
 212 | Tempest test suite 123               | Following tests failed:              |
 213 |                                      |                                      |
 214 |                                      | 1. Image resizing....                |
 215 |                                      |                                      |
 216 |                                      | 2. Heat deploy....                   |
 217 +--------------------------------------+--------------------------------------+
 218 | Robot test suite 456                 | Following tests failed:              |
 219 |                                      |                                      |
 220 |                                      | 1.......                             |
 221 |                                      |                                      |
 222 |                                      | 2.......                             |
 223 +--------------------------------------+--------------------------------------+
 224
 225 References
 226 ------------
 227 <STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION>
 228
 229 <EXAMPLE>:
 230
 231 For more information on the OPNFV Danube release, please see:
 232
 233 http://opnfv.org/danube