Documents up-to-date
[doctor.git] / 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 Iruya version of Doctor.
6
7 Important notes
8 ===============
9
10 Jerma release has mainly been for finalizing maintenance use case testing
11 supporting the ETSI FEAT03 defined interactino between VNFM and infrastructure.
12 This is mainly to have infrastructure maintenance and upgrade operations
13 opttimized as fast as they can while keeping VNFs on top with zero impact
14 on their service.
15
16 Further more this is the final release of Doctor and the more deep testing is
17 moving more to upstream projects like Fenix for the maintenance. Also in
18 this release we have made sure that all Doctor testing and any deeper testing
19 with ehe upstream projects can be done in DevStack. This also makes DevStack
20 the most important installer.
21
22 Summary
23 =======
24
25 Jerma Doctor framework uses OpenStack Train integrated into its test cases.
26
27 Release Data
28 ============
29
30 Doctor changes
31
32 - Maintenance use case updated to support latest version of Fenix.
33 - Maintenance use case now supports ETSI FEAT03 optimization with Fenix.
34 - Doctor testing is now preferred to be done in DevStack environment
35   where one can easily select OpenStack release from Rocky to Ussuri to
36   test Doctor functionality. Latest OPNFV Fuel can also be used for the
37   OpenStack version it supports.
38
39 Doctor CI
40
41 - Doctor tested with fuel installer.
42 - Fault management use case is tested with sample inspector.
43 - Maintenance use case is tested with sample implementation and towards
44   the latest Fenix version. The includes the new ETSI FEAT03 optimization.
45
46 Version change
47 ^^^^^^^^^^^^^^
48
49 Module version changes
50 ~~~~~~~~~~~~~~~~~~~~~~
51
52 - OpenStack has changed Train
53
54 Document version changes
55 ~~~~~~~~~~~~~~~~~~~~~~~~
56
57 All documentation is updated to OPNFV unified format according to
58 documentation guidelines. Small updates in many documents. 
59
60 Reason for version
61 ^^^^^^^^^^^^^^^^^^
62
63 N/A
64
65 Feature additions
66 ~~~~~~~~~~~~~~~~~
67
68 +--------------------+--------------------------------------------+
69 | **JIRA REFERENCE** | **SLOGAN**                                 |
70 +--------------------+--------------------------------------------+
71 | DOCTOR-137         | VNFM maintenance with ETSI changes         |
72 +--------------------+--------------------------------------------+
73 | DOCTOR-136         | DevStack support                           |
74 +--------------------+--------------------------------------------+
75
76
77 Deliverables
78 ------------
79
80 Software deliverables
81 =====================
82
83 None
84
85 Documentation deliverables
86 ==========================
87
88 https://git.opnfv.org/doctor/tree/docs
89
90 Known Limitations, Issues and Workarounds
91 =========================================
92
93 System Limitations
94 ^^^^^^^^^^^^^^^^^^
95
96 Maintenance test case requirements:
97
98 - Minimum number of nodes:   1 Controller, 3 Computes
99 - Min number of VCPUs:       2 VCPUs for each compute
100
101 Known issues
102 ^^^^^^^^^^^^
103
104 None
105
106 Workarounds
107 ^^^^^^^^^^^
108
109 None
110
111 Test Result
112 ===========
113
114 Doctor CI results with TEST_CASE='fault_management' and INSPECTOR_TYPE=sample
115 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
116
117 +--------------------------------------+--------------+
118 | **TEST-SUITE**                       | **Results:** |
119 +--------------------------------------+--------------+
120 | INSTALLER_TYPE='fuel'                | SUCCESS      |
121 +--------------------------------------+--------------+
122
123 Doctor CI results with TEST_CASE='maintenance' and INSPECTOR_TYPE=sample
124 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
125
126 +--------------------------------------+--------------+
127 | **TEST-SUITE**                       | **Results:** |
128 +--------------------------------------+--------------+
129 | INSTALLER_TYPE='fuel'                | SUCCESS      |
130 | ADMIN_TOOL_TYPE='fenix' *)           |              |
131 +--------------------------------------+--------------+
132
133 *) Sample implementation not updated according to latest upstream Fenix
134    and is currently not being tested.
135
136 References
137 ==========
138
139 For more information about the OPNFV Doctor latest work, please see:
140
141 https://wiki.opnfv.org/display/doctor/Doctor+Home
142
143 Further information about ETSI FEAT03 optimization can be found from Fenix
144 Documentation:
145
146 https://fenix.readthedocs.io/en/latest