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 Hunter of Doctor.
   6
   7 Important notes
   8 ===============
   9
  10 In Hunter release, Doctor has been working with fault management alarming
  11 enhancement and maintenance use case to upstream.
  12
  13 OpenStack Fenix (unofficial project) has been futher worked to implement the
  14 infrastructure rolling maintenance in interaction with VNFM. Doctor CI testing
  15 also supports maintenance testing with Fenix latest master version.
  16
  17 MCP and Apex installers are currently supported. In MCP we test fault management
  18 without the enhanced alarm. In Apex we test fault management with alarm
  19 enhancement with sample implementation. Apex is also used for maintenance use
  20 case testing. Congress inspector support is not working.
  21
  22 In this release, Doctor has not yet been working to look outside OpenStack.
  23 We might need to get back to this later to better meet the tough industry
  24 requirements as well as requirements from edge, containers and 5G.
  25
  26 Summary
  27 =======
  28
  29 Hunter Doctor framework uses OpenStack Rocky integrated into its test cases.
  30 For testing, we use Doctor CI on OPNFV installers.
  31
  32 Release Data
  33 ============
  34
  35 Doctor changes
  36
  37 +------------------------------------------+----------------------------------------------------------+
  38 | **commit-ID**                            | **Subject**                                              |
  39 +------------------------------------------+----------------------------------------------------------+
  40 | b19b69d731cfb5a87f7c928cc898ea04ec85cec6 | Fix tox to clean python cache                            |
  41 +------------------------------------------+----------------------------------------------------------+
  42 | 364d2c2344be5775a0eef6fe19fda125d2c8853d | Handle the exception for running the profiler            |
  43 +------------------------------------------+----------------------------------------------------------+
  44 | e6c857ba931a03fb7bfb49746cc4a7eb5b6ce6e1 | Hunter release documentation                             |
  45 +------------------------------------------+----------------------------------------------------------+
  46 | 73605c5c34b97ab56306bfa9af0f5888f3c7e46d | Support Fenix as admin tool                              |
  47 +------------------------------------------+----------------------------------------------------------+
  48 | 33293e9c23a21ad3228f46d2063f18c915eb2b79 | Wrong yamllint disable command                           |
  49 +------------------------------------------+----------------------------------------------------------+
  50 | d82ab34f15a9b67185c85c6afc5562bc8b72cb8b | Add local.conf.sample for devstack deployment of Doctor  |
  51 +------------------------------------------+----------------------------------------------------------+
  52 | 7ecc40b445b2aa42f0680c96dc672accf4e40ba0 | Hi, the automation job failed.                           |
  53 +------------------------------------------+----------------------------------------------------------+
  54 | 2cd1ca4463121e2354fd920af2b26c65848fb9e2 | Remove Ryota from committers                             |
  55 +------------------------------------------+----------------------------------------------------------+
  56 | f31ab961c594595772b0c3d4bd40a0d9491fc6cb | Removing committers                                      |
  57 +------------------------------------------+----------------------------------------------------------+
  58 | c653d95c67436698296e238396bf5d8370e3169a | Update to INFO file                                      |
  59 +------------------------------------------+----------------------------------------------------------+
  60 | e6708c869855ab69f9b53959befd82bb2f32f9ad | Bug - Testing in Apex with OpenStack master fails        |
  61 +------------------------------------------+----------------------------------------------------------+
  62 | e1c5dd0158d5168738fcc9918d24c04ca724b056 | remove to set ceilometer config in MCP                   |
  63 +------------------------------------------+----------------------------------------------------------+
  64 | d673e9218a53e047edc5ff6cd047ac6db5112651 | Support Fenix and sample implementation accordingly      |
  65 +------------------------------------------+----------------------------------------------------------+
  66 | 916e4931a56c1a5d41d46148609bf348d4326d37 | fix the configparser for  Python 2 and 3 Compatibility   |
  67 +------------------------------------------+----------------------------------------------------------+
  68 | 4075b417e973adb257ae39ff5c25aa182a2af3ea | index.rst was blank                                      |
  69 +------------------------------------------+----------------------------------------------------------+
  70 | dafdfcfad6866d7c413d4b8d5a9d25f3ab1f76dc | Minor docs updates                                       |
  71 +------------------------------------------+----------------------------------------------------------+
  72
  73 Releng changes
  74
  75 +------------------------------------------+----------------------------------------------------------+
  76 | **commit-ID**                            | **Subject**                                              |
  77 +------------------------------------------+----------------------------------------------------------+
  78 | cc290b2f937a2edbd60a5d2d1e20f333dfc7eb88 | Doctor to run Fenix as admin tool                        |
  79 +------------------------------------------+----------------------------------------------------------+
  80 | 488c558492201aacd359305a7afa3d5640a90b0e | Add parameter of `DEPLOY_SCENARIO` for doctor            |
  81 +------------------------------------------+----------------------------------------------------------+
  82 | 30478e1e193485cce93164e9877002b811acf950 | remove `SSH_KEY` parameter from `doctor-slave-parameter` |
  83 +------------------------------------------+----------------------------------------------------------+
  84 | 513b05275cbac2ff98950bb0a384a275dd8884f5 | Parpare ssh_key for MCP in doctor                        |
  85 +------------------------------------------+----------------------------------------------------------+
  86
  87 Version change
  88 ^^^^^^^^^^^^^^
  89
  90 Module version changes
  91 ~~~~~~~~~~~~~~~~~~~~~~
  92
  93 - OpenStack has changed from Queens-1 to Rocky-1 since previous Gambia release.
  94
  95 Document version changes
  96 ~~~~~~~~~~~~~~~~~~~~~~~~
  97
  98 These documents have been updated in Hunter release
  99
 100 - Testing document
 101   docs/development/overview/testing.rst
 102 - Doctor scenario in functest:
 103   docs/development/overview/functest_scenario/doctor-scenario-in-functest.rst
 104
 105 Reason for version
 106 ^^^^^^^^^^^^^^^^^^
 107
 108 Documentation is updated due to maintenance use case testing using Fenix.
 109
 110 Feature additions
 111 ~~~~~~~~~~~~~~~~~
 112
 113 +--------------------+----------------------------------------------------------+
 114 | **JIRA REFERENCE** | **SLOGAN**                                               |
 115 +--------------------+----------------------------------------------------------+
 116 | DOCTOR-129         | Maintenance use case implementation in OpenStack Fenix   |
 117 +--------------------+----------------------------------------------------------+
 118 | DOCTOR-131         | Support Fenix and sample implementation accordingly      |
 119 +--------------------+----------------------------------------------------------+
 120 | DOCTOR-132         | Integrate with MCP                                       |
 121 +--------------------+----------------------------------------------------------+
 122 | DOCTOR-133         | Doctor fault management with notification from Inspector |
 123 +--------------------+----------------------------------------------------------+
 124
 125 Deliverables
 126 ------------
 127
 128 Software deliverables
 129 =====================
 130
 131 None
 132
 133 Documentation deliverables
 134 ==========================
 135
 136 https://git.opnfv.org/doctor/tree/docs
 137
 138 Known Limitations, Issues and Workarounds
 139 =========================================
 140
 141 System Limitations
 142 ^^^^^^^^^^^^^^^^^^
 143
 144 Maintenance test case requirements:
 145
 146 - Minimum number of nodes:   1 Controller, 3 Computes
 147 - Min number of VCPUs:       2 VCPUs for each compute
 148
 149 Known issues
 150 ^^^^^^^^^^^^
 151
 152 None
 153
 154 Workarounds
 155 ^^^^^^^^^^^
 156
 157 None
 158
 159 Test Result
 160 ===========
 161
 162 Doctor CI results with TEST_CASE='fault_management' and INSPECTOR_TYPE=sample
 163 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 164
 165 +--------------------------------------+--------------+
 166 | **TEST-SUITE**                       | **Results:** |
 167 +--------------------------------------+--------------+
 168 | INSTALLER_TYPE='Apex' 1)             | SUCCESS      |
 169 +--------------------------------------+--------------+
 170 | INSTALLER_TYPE='Fuel' 2)             | SUCCESS      |
 171 +--------------------------------------+--------------+
 172 | INSTALLER_TYPE='Local'               | N/A          |
 173 +--------------------------------------+--------------+
 174 1) Uses enhanced alarming worked in DOCTOR-133
 175 2) Uses alarm from Nova reset server state API generated notification. API call
 176    can take a lot of time and alarm might take over a second. This also happens
 177    with different installer and for more Telco grade performance we need the
 178    enhanced alarming.
 179
 180 Doctor CI results with TEST_CASE='fault_management' and INSPECTOR_TYPE=congress
 181 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 182
 183 +--------------------------------------+--------------+
 184 | **TEST-SUITE**                       | **Results:** |
 185 +--------------------------------------+--------------+
 186 | INSTALLER_TYPE='Apex' 1)             | FAILED       |
 187 +--------------------------------------+--------------+
 188 | INSTALLER_TYPE='Fuel'                | N/A          |
 189 +--------------------------------------+--------------+
 190 | INSTALLER_TYPE='Local'               | N/A          |
 191 +--------------------------------------+--------------+
 192 1) Takes over one second because Nova reset server state error API is too slow
 193
 194 Doctor Functest results with TEST_CASE='fault_management'
 195 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 196
 197 +--------------------------------------+--------------+
 198 | **TEST-SUITE**                       | **Results:** |
 199 +--------------------------------------+--------------+
 200 | INSTALLER_TYPE='Apex'                | skipped      |
 201 +--------------------------------------+--------------+
 202 | INSTALLER_TYPE='Fuel'                | skipped      |
 203 +--------------------------------------+--------------+
 204 | INSTALLER_TYPE='Local'               | N/A          |
 205 +--------------------------------------+--------------+
 206
 207 Note: Installer Functest does not currently test features or skips running the
 208 project test cases
 209
 210 Doctor CI results with TEST_CASE='maintenance'
 211 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 212
 213 +--------------------------------------+--------------+
 214 | **TEST-SUITE**                       | **Results:** |
 215 +--------------------------------------+--------------+
 216 | INSTALLER_TYPE='Apex'                | SUCCESS      |
 217 | ADMIN_TOOL_TYPE='sample'             |              |
 218 +--------------------------------------+--------------+
 219 | INSTALLER_TYPE='Apex'                | SUCCESS      |
 220 | ADMIN_TOOL_TYPE='fenix'              |              |
 221 +--------------------------------------+--------------+
 222
 223 Doctor Functest results with TEST_CASE='maintenance'
 224 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 225
 226 N/A - Needs special target environment with at least 3 compute nodes
 227
 228 References
 229 ==========
 230
 231 For more information about the OPNFV Doctor latest work, please see:
 232
 233 https://wiki.opnfv.org/display/doctor/Doctor+Home