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