summaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/release-notes.rst
blob: ad690bb300dba8c621e80d0105fb8da04268c3fa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0


This document provides the release notes for Gambia of Doctor.

.. contents::
   :depth: 3
   :local:


Version history
---------------

+--------------------+--------------------+--------------------+-------------+
| **Date**           | **Ver.**           | **Author**         | **Comment** |
+--------------------+--------------------+--------------------+-------------+
| 2018-09-20         | 7.0.0              | Tomi Juvonen       |             |
+--------------------+--------------------+--------------------+-------------+

Important notes
===============

In Gambia release, Doctor has been working with our second use case over
maintenance. Design guideline is now done and test case exists with sample
maintenance workflow code implemented in Doctor. Work has also started to have
the real implementation done in the OpenStack Fenix project
https://wiki.openstack.org/wiki/Fenix.

Doctor CI testing has now moved to use tox instead of Functest.

In this release, Doctor has not been working with the fault management use case as
the basic framework has been already done. However, we might need to get back to
it later to better meet the tough industry requirements as well as requirements
from edge, containers and 5G.


Summary
=======

Gambia Doctor framework uses OpenStack Queens integrated into its test cases.
Compared to the previous release, the Heat project is also being used in the
maintenance test case.

Release Data
============

Doctor changes

+------------------------------------------+----------------------------------------------------------+
| **commit-ID**                            | **Subject**                                              |
+------------------------------------------+----------------------------------------------------------+
| 825a0a0dd5e8028129b782ed21c549586257b1c5 | delete doctor datasource in congress when cleanup        |
+------------------------------------------+----------------------------------------------------------+
| fcf53129ab2b18b84571faff13d7cb118b3a41b3 | run profile even the notification time is larger than 1S |
+------------------------------------------+----------------------------------------------------------+
| 495965d0336d42fc36494c81fd15cee2f34c96e9 | Update and add test case                                 |
+------------------------------------------+----------------------------------------------------------+
| da25598a6a31abe0579ffed12d1719e5ff75f9a7 | bugfix: add doctor datasource in congress                |
+------------------------------------------+----------------------------------------------------------+
| f9e1e3b1ae4be80bc2dc61d9c4213c81c091ea72 | Update the maintenance design document                   |
+------------------------------------------+----------------------------------------------------------+
| 4639f15e6db2f1480b41f6fbfd11d70312d4e421 | Add maintenance test code                                |
+------------------------------------------+----------------------------------------------------------+
| b54cbc5dd2d32fcb27238680b4657ed384d021c5 | Add setup and cleanup for maintenance test               |
+------------------------------------------+----------------------------------------------------------+
| b2bb504032ac81a2ed3f404113b097d9ce3d7f14 | bugfix: kill the stunnel when cleanup                    |
+------------------------------------------+----------------------------------------------------------+
| eaeb3c0f9dc9e6645a159d0a78b9fc181fce53d4 | add ssh_keyfile for connect to installer in Apex         |
+------------------------------------------+----------------------------------------------------------+
| dcbe7bf1c26052b0e95d209254e7273aa1eaace1 | Add tox and test case to testing document                |
+------------------------------------------+----------------------------------------------------------+
| 0f607cb5efd91ee497346b7f792dfa844d15595c | enlarge the time of link down                            |
+------------------------------------------+----------------------------------------------------------+
| 1351038a65739b8d799820de515178326ad05f7b | bugfix: fix the filename of ssh tunnel                   |
+------------------------------------------+----------------------------------------------------------+
| e70bf248daac03eee6b449cd1654d2ee6265dd8c | Use py34 instead of py35                                 |
+------------------------------------------+----------------------------------------------------------+
| 2a60d460eaf018951456451077b7118b60219b32 | add INSPECTOR_TYPE and TEST_CASE to tox env              |
+------------------------------------------+----------------------------------------------------------+
| 2043ceeb08c1eca849daeb2b3696d385425ba061 | [consumer] fix default value for port number             |
+------------------------------------------+----------------------------------------------------------+

Releng changes

+------------------------------------------+-----------------------------------------------------------------------+
| **commit-ID**                            | **Subject**                                                           |
+------------------------------------------+-----------------------------------------------------------------------+
| c87309f5a75ccc5d595f708817b97793c24c4387 | Add Doctor maintenance job                                            |
+------------------------------------------+-----------------------------------------------------------------------+
| bd16a9756ffd0743e143f0f2f966da8dd666c7a3 | remove congress test in Daisy                                         |
+------------------------------------------+-----------------------------------------------------------------------+
| c47aaaa53c91aae93877f2532c72374beaa4eabe | remove fuel job in Doctor                                             |
+------------------------------------------+-----------------------------------------------------------------------+
| ab2fed2522eaf82ea7c63dd05008a37c56e825d0 | use 'workspace-cleanup' plugin in publisher                           |
+------------------------------------------+-----------------------------------------------------------------------+
| 3aaed5cf40092744f1b87680b9205a2901baecf3 | clean the workspace in the publisher                                  |
+------------------------------------------+-----------------------------------------------------------------------+
| 50151eb3717edd4ddd996f3705fbe1732de7f3b7 | run tox with 'sudo'                                                   |
+------------------------------------------+-----------------------------------------------------------------------+
| a3adc85ecb52f5d19ec4e9c49ca1ac35aa429ff9 | remove inspector variable form job template                           |
+------------------------------------------+-----------------------------------------------------------------------+
| adfbaf2a3e8487e4c9152bf864a653a0425b8582 | run doctor tests with different inspectors in sequence                |
+------------------------------------------+-----------------------------------------------------------------------+
| 2e98e56224cd550cb3bf9798e420eece28139bd9 | add the ssh_key info if the key_file is exist                         |
+------------------------------------------+-----------------------------------------------------------------------+
| c109c271018e9a85d94be1b9b468338d64589684 | prepare installer info for doctor test                                |
+------------------------------------------+-----------------------------------------------------------------------+
| 57cbefc7160958eae1d49e4753779180a25864af | use py34 for tox                                                      |
+------------------------------------------+-----------------------------------------------------------------------+
| 3547754e808a581b09c9d22e013a7d986d9f6cd1 | specify the cacert file when it exits                                 |
+------------------------------------------+-----------------------------------------------------------------------+
| ef4f36aa1c2ff0819d73cde44f84b99a42e15c7e | bugfix: wrong usage of '!include-raw'                                 |
+------------------------------------------+-----------------------------------------------------------------------+
| 0e0e0d4cb71fb27b1789a2bef2d3c4ff313e67ff | use tox instead of functest for doctor CI jobs                        |
+------------------------------------------+-----------------------------------------------------------------------+
| 5b22f1b95feacaec0380f6a7543cbf510b628451 | pass value to parameters                                              |
+------------------------------------------+-----------------------------------------------------------------------+
| 44ab0cea07fa2a734c4f6b80776ad48fd006d1b8 | Doctor job bugfix: fix the scenario                                   |
+------------------------------------------+-----------------------------------------------------------------------+
| 17617f1c0a78c7bdad0d11d329a6c7e119cbbddd | bugfix: run doctor tests parallelly                                   |
+------------------------------------------+-----------------------------------------------------------------------+
| 811e4ef7f4c37b7bc246afc34ff880c014ecc05d | delete 'opnfv-build-ubuntu-defaults' parameters for doctor verify job |
+------------------------------------------+-----------------------------------------------------------------------+
| 0705f31ab5bc54c073df120cbe0fe62cf10f9a81 | delete the 'node' parameter in 'doctor-slave-parameter' macro         |
+------------------------------------------+-----------------------------------------------------------------------+
| 304151b15f9d7241db8c5fea067cafe048287d84 | fix the default node label for doctor test                            |
+------------------------------------------+-----------------------------------------------------------------------+
| a6963f92f015a33b44b27199886952205499b44c | Fix project name                                                      |
+------------------------------------------+-----------------------------------------------------------------------+
| f122bfed998b3b0e0178106a7538377c609c6512 | add a default value for SSH_KEY                                       |
+------------------------------------------+-----------------------------------------------------------------------+

Version change
^^^^^^^^^^^^^^

Module version changes
~~~~~~~~~~~~~~~~~~~~~~

- OpenStack has changed from Pike-1 to Queens-1

Document version changes
~~~~~~~~~~~~~~~~~~~~~~~~

These documents have been updated in Gambia release

- Testing document
  docs/development/overview/testing.rst
- Doctor scenario in functest
  docs/development/overview/functest_scenario/doctor-scenario-in-functest.rst
- Maintenance design guideline
  docs/development/design/maintenance-design-guideline.rst

Reason for version
^^^^^^^^^^^^^^^^^^

Documentation is updated due to tox usage in testing and adding maintenance
use case related documentation.

Feature additions
~~~~~~~~~~~~~~~~~

+--------------------+--------------------------------------------------------+
| **JIRA REFERENCE** | **SLOGAN**                                             |
+--------------------+--------------------------------------------------------+
| DOCTOR-106         | Maintenance scenario                                   |
+--------------------+--------------------------------------------------------+
| DOCTOR-125         | Maintenance design document according to our test case |
+--------------------+--------------------------------------------------------+
| DOCTOR-126         | Use Tox instead of Functest for doctor CI jobs         |
+--------------------+--------------------------------------------------------+
| DOCTOR-127         | Maintenance test POD                                   |
+--------------------+--------------------------------------------------------+


Deliverables
------------


Software deliverables
=====================

None

Documentation deliverables
==========================

https://git.opnfv.org/doctor/tree/docs

Known Limitations, Issues and Workarounds
=========================================

System Limitations
^^^^^^^^^^^^^^^^^^

Maintenance test case requirements:

- Minimum number of nodes:   1 Controller, 3 Computes
- Min number of VCPUs:       2 VCPUs for each compute

Known issues
^^^^^^^^^^^^

None

Workarounds
^^^^^^^^^^^

None

Test Result
===========

Doctor CI results with TEST_CASE='fault_management' and INSPECTOR_TYPE=sample
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

+--------------------------------------+--------------+
| **TEST-SUITE**                       | **Results:** |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Apex'                | SUCCESS      |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Compass'             | N/A          |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Daisy'               | SUCCESS      |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Fuel'                | No POD       |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Joid'                | N/A          |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Local'               | N/A          |
+--------------------------------------+--------------+

Doctor CI results with TEST_CASE='fault_management' and INSPECTOR_TYPE=congress
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

+--------------------------------------+--------------+
| **TEST-SUITE**                       | **Results:** |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Apex'                | FAILED       |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Compass'             | N/A          |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Daisy'               | N/A          |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Fuel'                | No POD       |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Joid'                | N/A          |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Local'               | N/A          |
+--------------------------------------+--------------+


Doctor Functest results with TEST_CASE='fault_management'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

+--------------------------------------+--------------+
| **TEST-SUITE**                       | **Results:** |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Apex'                | skipped      |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Compass'             | N/A          |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Daisy'               | skipped      |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Fuel'                | skipped      |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Joid'                | N/A          |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Local'               | N/A          |
+--------------------------------------+--------------+

Note: Installer Functest does not currently test features or skips running the
project test cases

Doctor CI results with TEST_CASE='maintenance'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

+--------------------------------------+--------------+
| **TEST-SUITE**                       | **Results:** |
+--------------------------------------+--------------+
| INSTALLER_TYPE='Apex'                | SUCCESS      |
+--------------------------------------+--------------+

Doctor Functest results with TEST_CASE='maintenance'
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

N/A - Needs special target and currently there is only sample implementation

References
==========

For more information about the OPNFV Doctor latest work, please see:

https://wiki.opnfv.org/display/doctor/Doctor+Home