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