aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/danube.rst
blob: b50fb909691266896daf15f7f84cc198a1480635 (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
.. 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 <RELEASE> of <COMPONENT>.

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


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

+--------------------+--------------------+--------------------+--------------------+
| **Date**           | **Ver.**           | **Author**         | **Comment**        |
|                    |                    |                    |                    |
+--------------------+--------------------+--------------------+--------------------+
| 2017-03-14         | TODO(yujunz): tag  | Yujun Zhang        | First draft        |
|                    |                    |                    |                    |
+--------------------+--------------------+--------------------+--------------------+

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

QTIP is totally reworked in Danube release. The legacy benchmarks released in Brahmaputra (compute, network and storage)
are deprecated.

Summary
=======

QTIP Danube release introduces **QPI**, a.k.a. QTIP Performance Index, which is calculated from metrics collected in
performance tests.

A PoC of compute qpi benchmark plan is provided as a sample use case.

Available benchmark plans can be listed, shown and executed from `qtip-cli`, the command line interpreter of QTIP.

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

+--------------------------------------+--------------------------------------+
| **Project**                          | QTIP                                 |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/commit-ID**                   | qtip/TBD                             |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Danube 1.0                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | TODO(yujunz): fill date              |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | OPNFV quality assurance              |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

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

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

N/A

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

N/A

Reason for version
^^^^^^^^^^^^^^^^^^
Feature additions
~~~~~~~~~~~~~~~~~

**JIRA BACK-LOG:**

** TODO(yujunz) pull data from JIRA **

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Bug corrections
~~~~~~~~~~~~~~~

**JIRA TICKETS:**

** TODO(yujunz) pull data from JIRA **

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
+--------------------------------------+--------------------------------------+

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

Software deliverables
^^^^^^^^^^^^^^^^^^^^^

** TODO(yujunz) docker image, pip package **

Documentation deliverables
^^^^^^^^^^^^^^^^^^^^^^^^^^

** TODO(yujunz) links to qtip document publish **

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

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

None

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

** TODO(yujunz) pull data from JIRA **

**JIRA TICKETS:**

+--------------------------------------+--------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
+--------------------------------------+--------------------------------------+
|                                      |                                      |
+--------------------------------------+--------------------------------------+

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

N/A

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

QTIP has undergone QA test runs with the following results:

+--------------------------------------+--------------------------------------+
| **TEST-SUITES**                      | **Results:**                         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| qtip-verify-danube                   | 72/72 passed                         |
|                                      |                                      |
|                                      | 73% lines of code covered            |
+--------------------------------------+--------------------------------------+
| qtip-daily-fuel-zte-pod3-danube      | Last 7 build fails                   |
|                                      |                                      |
|                                      | blocked by the failure of zte-pod3   |
+--------------------------------------+--------------------------------------+

References
==========

For more information on the OPNFV Danube release, please see:

http://opnfv.org/danube