docs/templates/release-notes.rst

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