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