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 Gambia of Doctor.
   6
   7 Important notes
   8 ===============
   9
  10 In Gambia release, Doctor has been working with our second use case over
  11 maintenance. Design guideline is now done and test case exists with sample
  12 maintenance workflow code implemented in Doctor. Work has also started to have
  13 the real implementation done in the OpenStack Fenix project
  14 https://wiki.openstack.org/wiki/Fenix.
  15
  16 Doctor CI testing has now moved to use tox instead of Functest.
  17
  18 In this release, Doctor has not been working with the fault management use case as
  19 the basic framework has been already done. However, we might need to get back to
  20 it later to better meet the tough industry requirements as well as requirements
  21 from edge, containers and 5G.
  22
  23
  24 Summary
  25 =======
  26
  27 Gambia Doctor framework uses OpenStack Queens integrated into its test cases.
  28 Compared to the previous release, the Heat project is also being used in the
  29 maintenance test case.
  30
  31 Release Data
  32 ============
  33
  34 Doctor changes
  35
  36 +------------------------------------------+----------------------------------------------------------+
  37 | **commit-ID**                            | **Subject**                                              |
  38 +------------------------------------------+----------------------------------------------------------+
  39 | 825a0a0dd5e8028129b782ed21c549586257b1c5 | delete doctor datasource in congress when cleanup        |
  40 +------------------------------------------+----------------------------------------------------------+
  41 | fcf53129ab2b18b84571faff13d7cb118b3a41b3 | run profile even the notification time is larger than 1S |
  42 +------------------------------------------+----------------------------------------------------------+
  43 | 495965d0336d42fc36494c81fd15cee2f34c96e9 | Update and add test case                                 |
  44 +------------------------------------------+----------------------------------------------------------+
  45 | da25598a6a31abe0579ffed12d1719e5ff75f9a7 | bugfix: add doctor datasource in congress                |
  46 +------------------------------------------+----------------------------------------------------------+
  47 | f9e1e3b1ae4be80bc2dc61d9c4213c81c091ea72 | Update the maintenance design document                   |
  48 +------------------------------------------+----------------------------------------------------------+
  49 | 4639f15e6db2f1480b41f6fbfd11d70312d4e421 | Add maintenance test code                                |
  50 +------------------------------------------+----------------------------------------------------------+
  51 | b54cbc5dd2d32fcb27238680b4657ed384d021c5 | Add setup and cleanup for maintenance test               |
  52 +------------------------------------------+----------------------------------------------------------+
  53 | b2bb504032ac81a2ed3f404113b097d9ce3d7f14 | bugfix: kill the stunnel when cleanup                    |
  54 +------------------------------------------+----------------------------------------------------------+
  55 | eaeb3c0f9dc9e6645a159d0a78b9fc181fce53d4 | add ssh_keyfile for connect to installer in Apex         |
  56 +------------------------------------------+----------------------------------------------------------+
  57 | dcbe7bf1c26052b0e95d209254e7273aa1eaace1 | Add tox and test case to testing document                |
  58 +------------------------------------------+----------------------------------------------------------+
  59 | 0f607cb5efd91ee497346b7f792dfa844d15595c | enlarge the time of link down                            |
  60 +------------------------------------------+----------------------------------------------------------+
  61 | 1351038a65739b8d799820de515178326ad05f7b | bugfix: fix the filename of ssh tunnel                   |
  62 +------------------------------------------+----------------------------------------------------------+
  63 | e70bf248daac03eee6b449cd1654d2ee6265dd8c | Use py34 instead of py35                                 |
  64 +------------------------------------------+----------------------------------------------------------+
  65 | 2a60d460eaf018951456451077b7118b60219b32 | add INSPECTOR_TYPE and TEST_CASE to tox env              |
  66 +------------------------------------------+----------------------------------------------------------+
  67 | 2043ceeb08c1eca849daeb2b3696d385425ba061 | [consumer] fix default value for port number             |
  68 +------------------------------------------+----------------------------------------------------------+
  69
  70 Releng changes
  71
  72 +------------------------------------------+-----------------------------------------------------------------------+
  73 | **commit-ID**                            | **Subject**                                                           |
  74 +------------------------------------------+-----------------------------------------------------------------------+
  75 | c87309f5a75ccc5d595f708817b97793c24c4387 | Add Doctor maintenance job                                            |
  76 +------------------------------------------+-----------------------------------------------------------------------+
  77 | bd16a9756ffd0743e143f0f2f966da8dd666c7a3 | remove congress test in Daisy                                         |
  78 +------------------------------------------+-----------------------------------------------------------------------+
  79 | c47aaaa53c91aae93877f2532c72374beaa4eabe | remove fuel job in Doctor                                             |
  80 +------------------------------------------+-----------------------------------------------------------------------+
  81 | ab2fed2522eaf82ea7c63dd05008a37c56e825d0 | use 'workspace-cleanup' plugin in publisher                           |
  82 +------------------------------------------+-----------------------------------------------------------------------+
  83 | 3aaed5cf40092744f1b87680b9205a2901baecf3 | clean the workspace in the publisher                                  |
  84 +------------------------------------------+-----------------------------------------------------------------------+
  85 | 50151eb3717edd4ddd996f3705fbe1732de7f3b7 | run tox with 'sudo'                                                   |
  86 +------------------------------------------+-----------------------------------------------------------------------+
  87 | a3adc85ecb52f5d19ec4e9c49ca1ac35aa429ff9 | remove inspector variable form job template                           |
  88 +------------------------------------------+-----------------------------------------------------------------------+
  89 | adfbaf2a3e8487e4c9152bf864a653a0425b8582 | run doctor tests with different inspectors in sequence                |
  90 +------------------------------------------+-----------------------------------------------------------------------+
  91 | 2e98e56224cd550cb3bf9798e420eece28139bd9 | add the ssh_key info if the key_file is exist                         |
  92 +------------------------------------------+-----------------------------------------------------------------------+
  93 | c109c271018e9a85d94be1b9b468338d64589684 | prepare installer info for doctor test                                |
  94 +------------------------------------------+-----------------------------------------------------------------------+
  95 | 57cbefc7160958eae1d49e4753779180a25864af | use py34 for tox                                                      |
  96 +------------------------------------------+-----------------------------------------------------------------------+
  97 | 3547754e808a581b09c9d22e013a7d986d9f6cd1 | specify the cacert file when it exits                                 |
  98 +------------------------------------------+-----------------------------------------------------------------------+
  99 | ef4f36aa1c2ff0819d73cde44f84b99a42e15c7e | bugfix: wrong usage of '!include-raw'                                 |
 100 +------------------------------------------+-----------------------------------------------------------------------+
 101 | 0e0e0d4cb71fb27b1789a2bef2d3c4ff313e67ff | use tox instead of functest for doctor CI jobs                        |
 102 +------------------------------------------+-----------------------------------------------------------------------+
 103 | 5b22f1b95feacaec0380f6a7543cbf510b628451 | pass value to parameters                                              |
 104 +------------------------------------------+-----------------------------------------------------------------------+
 105 | 44ab0cea07fa2a734c4f6b80776ad48fd006d1b8 | Doctor job bugfix: fix the scenario                                   |
 106 +------------------------------------------+-----------------------------------------------------------------------+
 107 | 17617f1c0a78c7bdad0d11d329a6c7e119cbbddd | bugfix: run doctor tests parallelly                                   |
 108 +------------------------------------------+-----------------------------------------------------------------------+
 109 | 811e4ef7f4c37b7bc246afc34ff880c014ecc05d | delete 'opnfv-build-ubuntu-defaults' parameters for doctor verify job |
 110 +------------------------------------------+-----------------------------------------------------------------------+
 111 | 0705f31ab5bc54c073df120cbe0fe62cf10f9a81 | delete the 'node' parameter in 'doctor-slave-parameter' macro         |
 112 +------------------------------------------+-----------------------------------------------------------------------+
 113 | 304151b15f9d7241db8c5fea067cafe048287d84 | fix the default node label for doctor test                            |
 114 +------------------------------------------+-----------------------------------------------------------------------+
 115 | a6963f92f015a33b44b27199886952205499b44c | Fix project name                                                      |
 116 +------------------------------------------+-----------------------------------------------------------------------+
 117 | f122bfed998b3b0e0178106a7538377c609c6512 | add a default value for SSH_KEY                                       |
 118 +------------------------------------------+-----------------------------------------------------------------------+
 119
 120 Version change
 121 ^^^^^^^^^^^^^^
 122
 123 Module version changes
 124 ~~~~~~~~~~~~~~~~~~~~~~
 125
 126 - OpenStack has changed from Pike-1 to Queens-1
 127
 128 Document version changes
 129 ~~~~~~~~~~~~~~~~~~~~~~~~
 130
 131 These documents have been updated in Gambia release
 132
 133 - Testing document
 134   docs/development/overview/testing.rst
 135 - Doctor scenario in functest
 136   docs/development/overview/functest_scenario/doctor-scenario-in-functest.rst
 137 - Maintenance design guideline
 138   docs/development/design/maintenance-design-guideline.rst
 139
 140 Reason for version
 141 ^^^^^^^^^^^^^^^^^^
 142
 143 Documentation is updated due to tox usage in testing and adding maintenance
 144 use case related documentation.
 145
 146 Feature additions
 147 ~~~~~~~~~~~~~~~~~
 148
 149 +--------------------+--------------------------------------------------------+
 150 | **JIRA REFERENCE** | **SLOGAN**                                             |
 151 +--------------------+--------------------------------------------------------+
 152 | DOCTOR-106         | Maintenance scenario                                   |
 153 +--------------------+--------------------------------------------------------+
 154 | DOCTOR-125         | Maintenance design document according to our test case |
 155 +--------------------+--------------------------------------------------------+
 156 | DOCTOR-126         | Use Tox instead of Functest for doctor CI jobs         |
 157 +--------------------+--------------------------------------------------------+
 158 | DOCTOR-127         | Maintenance test POD                                   |
 159 +--------------------+--------------------------------------------------------+
 160
 161
 162 Deliverables
 163 ------------
 164
 165
 166 Software deliverables
 167 =====================
 168
 169 None
 170
 171 Documentation deliverables
 172 ==========================
 173
 174 https://git.opnfv.org/doctor/tree/docs
 175
 176 Known Limitations, Issues and Workarounds
 177 =========================================
 178
 179 System Limitations
 180 ^^^^^^^^^^^^^^^^^^
 181
 182 Maintenance test case requirements:
 183
 184 - Minimum number of nodes:   1 Controller, 3 Computes
 185 - Min number of VCPUs:       2 VCPUs for each compute
 186
 187 Known issues
 188 ^^^^^^^^^^^^
 189
 190 None
 191
 192 Workarounds
 193 ^^^^^^^^^^^
 194
 195 None
 196
 197 Test Result
 198 ===========
 199
 200 Doctor CI results with TEST_CASE='fault_management' and INSPECTOR_TYPE=sample
 201 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 202
 203 +--------------------------------------+--------------+
 204 | **TEST-SUITE**                       | **Results:** |
 205 +--------------------------------------+--------------+
 206 | INSTALLER_TYPE='Apex'                | SUCCESS      |
 207 +--------------------------------------+--------------+
 208 | INSTALLER_TYPE='Compass'             | N/A          |
 209 +--------------------------------------+--------------+
 210 | INSTALLER_TYPE='Daisy'               | SUCCESS      |
 211 +--------------------------------------+--------------+
 212 | INSTALLER_TYPE='Fuel'                | No POD       |
 213 +--------------------------------------+--------------+
 214 | INSTALLER_TYPE='Joid'                | N/A          |
 215 +--------------------------------------+--------------+
 216 | INSTALLER_TYPE='Local'               | N/A          |
 217 +--------------------------------------+--------------+
 218
 219 Doctor CI results with TEST_CASE='fault_management' and INSPECTOR_TYPE=congress
 220 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 221
 222 +--------------------------------------+--------------+
 223 | **TEST-SUITE**                       | **Results:** |
 224 +--------------------------------------+--------------+
 225 | INSTALLER_TYPE='Apex'                | FAILED       |
 226 +--------------------------------------+--------------+
 227 | INSTALLER_TYPE='Compass'             | N/A          |
 228 +--------------------------------------+--------------+
 229 | INSTALLER_TYPE='Daisy'               | N/A          |
 230 +--------------------------------------+--------------+
 231 | INSTALLER_TYPE='Fuel'                | No POD       |
 232 +--------------------------------------+--------------+
 233 | INSTALLER_TYPE='Joid'                | N/A          |
 234 +--------------------------------------+--------------+
 235 | INSTALLER_TYPE='Local'               | N/A          |
 236 +--------------------------------------+--------------+
 237
 238
 239 Doctor Functest results with TEST_CASE='fault_management'
 240 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 241
 242 +--------------------------------------+--------------+
 243 | **TEST-SUITE**                       | **Results:** |
 244 +--------------------------------------+--------------+
 245 | INSTALLER_TYPE='Apex'                | skipped      |
 246 +--------------------------------------+--------------+
 247 | INSTALLER_TYPE='Compass'             | N/A          |
 248 +--------------------------------------+--------------+
 249 | INSTALLER_TYPE='Daisy'               | skipped      |
 250 +--------------------------------------+--------------+
 251 | INSTALLER_TYPE='Fuel'                | skipped      |
 252 +--------------------------------------+--------------+
 253 | INSTALLER_TYPE='Joid'                | N/A          |
 254 +--------------------------------------+--------------+
 255 | INSTALLER_TYPE='Local'               | N/A          |
 256 +--------------------------------------+--------------+
 257
 258 Note: Installer Functest does not currently test features or skips running the
 259 project test cases
 260
 261 Doctor CI results with TEST_CASE='maintenance'
 262 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 263
 264 +--------------------------------------+--------------+
 265 | **TEST-SUITE**                       | **Results:** |
 266 +--------------------------------------+--------------+
 267 | INSTALLER_TYPE='Apex'                | SUCCESS      |
 268 +--------------------------------------+--------------+
 269
 270 Doctor Functest results with TEST_CASE='maintenance'
 271 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 272
 273 N/A - Needs special target and currently there is only sample implementation
 274
 275 References
 276 ==========
 277
 278 For more information about the OPNFV Doctor latest work, please see:
 279
 280 https://wiki.opnfv.org/display/doctor/Doctor+Home