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 This document provides the release notes for <RELEASE> of <COMPONENT>.
   6
   7 .. contents::
   8    :depth: 3
   9    :local:
  10
  11
  12 Version history
  13 ---------------
  14
  15 +--------------------+--------------------+--------------------+--------------------+
  16 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
  17 |                    |                    |                    |                    |
  18 +--------------------+--------------------+--------------------+--------------------+
  19 | 2015-04-14         | 0.1.0              | Jonas Bjurel       | First draft        |
  20 |                    |                    |                    |                    |
  21 +--------------------+--------------------+--------------------+--------------------+
  22 |                    | 0.1.1              |                    |                    |
  23 |                    |                    |                    |                    |
  24 +--------------------+--------------------+--------------------+--------------------+
  25 |                    | 1.0                |                    |                    |
  26 |                    |                    |                    |                    |
  27 +--------------------+--------------------+--------------------+--------------------+
  28
  29 Important notes
  30 ===============
  31
  32 <STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE>
  33
  34 <EXAMPLE>:
  35
  36 **Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master -
  37 see the OPNFV@Fuel SW installation instructions
  38
  39
  40 Summary
  41 =======
  42
  43 <SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES>
  44
  45 <EXAMPLE>:
  46
  47 Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1,
  48 but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations......
  49
  50
  51 Release Data
  52 ============
  53 <STATE RELEVANT RELEASE DATA/RECORDS>
  54
  55 <EXAMPLE>:
  56
  57 +--------------------------------------+--------------------------------------+
  58 | **Project**                          | E.g. Arno/genesis/fuel@opnfv         |
  59 |                                      |                                      |
  60 +--------------------------------------+--------------------------------------+
  61 | **Repo/commit-ID**                   | E.g. genesis/adf634a0d4.....         |
  62 |                                      |                                      |
  63 +--------------------------------------+--------------------------------------+
  64 | **Release designation**              | E.g. Arno RC2                        |
  65 |                                      |                                      |
  66 +--------------------------------------+--------------------------------------+
  67 | **Release date**                     | E.g. 2015-04-16                      |
  68 |                                      |                                      |
  69 +--------------------------------------+--------------------------------------+
  70 | **Purpose of the delivery**          | E.g. OPNFV Internal quality assurance|
  71 |                                      |                                      |
  72 +--------------------------------------+--------------------------------------+
  73
  74 Version change
  75 ^^^^^^^^^^^^^^^^
  76
  77 Module version changes
  78 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  79 <STATE WHAT UPSTREAM, - AS WELL AS OPNFV MODULE VERSIONS HAVE CHANGED>
  80
  81 <EXAMPLE>:
  82
  83 - Fuel have changed from 5.1 to 6.0.1
  84
  85 - OpenDaylight has changed from Helium-SR1 to Helium-SR2
  86
  87 Document version changes
  88 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  89 <STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE>
  90
  91 <EXAMPLE>:
  92
  93 - The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2
  94
  95 Reason for version
  96 ^^^^^^^^^^^^^^^^^^^^
  97 Feature additions
  98 ~~~~~~~~~~~~~~~~~~~~~~~
  99 <STATE ADDED FEATURES BY REFERENCE TO JIRA>
 100
 101 <EXAMPLE>:
 102
 103 **JIRA BACK-LOG:**
 104
 105 +--------------------------------------+--------------------------------------+
 106 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 107 |                                      |                                      |
 108 +--------------------------------------+--------------------------------------+
 109 | BGS-123                              | ADD OpenDaylight ml2 integration     |
 110 |                                      |                                      |
 111 +--------------------------------------+--------------------------------------+
 112 | BGS-456                              | Add auto-deployment of Fuel@OPNFV    |
 113 |                                      |                                      |
 114 +--------------------------------------+--------------------------------------+
 115
 116 Bug corrections
 117 ~~~~~~~~~~~~~~~~~~~~~
 118
 119 **JIRA TICKETS:**
 120
 121 +--------------------------------------+--------------------------------------+
 122 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 123 |                                      |                                      |
 124 +--------------------------------------+--------------------------------------+
 125 | BGS-888                              | Fuel doesn't deploy                  |
 126 |                                      |                                      |
 127 +--------------------------------------+--------------------------------------+
 128 | BGS-999                              | Floating IP doesn't work             |
 129 |                                      |                                      |
 130 +--------------------------------------+--------------------------------------+
 131
 132 Deliverables
 133 ----------------
 134
 135 Software deliverables
 136 ^^^^^^^^^^^^^^^^^^^^^^^
 137
 138 <STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
 139
 140 <EXAMPLE>:
 141
 142 Documentation deliverables
 143 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 144
 145 <STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED>
 146
 147 <EXAMPLE>:
 148
 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