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