docs/templates/release-notes.rst

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