summaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/danube.rst
blob: 6f2ab48f352aa9b8d001a7655b5408850297962f (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
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0

******
Danube
******

This document provides the release notes for Danube of QTIP.

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

Version history
===============

+--------------------+--------------------+--------------------+--------------------+
| **Date**           | **Ver.**           | **Author**         | **Comment**        |
|                    |                    |                    |                    |
+--------------------+--------------------+--------------------+--------------------+
| 2017-03-30         | Danube 1.0         | Yujun Zhang        |                    |
|                    |                    |                    |                    |
+--------------------+--------------------+--------------------+--------------------+
| 2017-05-04         | Danube 2.0         | Yujun Zhang        |                    |
|                    |                    |                    |                    |
+--------------------+--------------------+--------------------+--------------------+

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 performance benchmark plan is provided as a sample use case.

Available benchmark plans can be listed, shown and executed from command line or over API.

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

+--------------------------------------+--------------------------------------+
| **Project**                          | QTIP                                 |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/commit-ID**                   | qtip/danube.2.0                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Danube bug fix release               |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | 2017-05-04                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | OPNFV quality assurance              |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Version change
--------------

New in Danube 2.0
^^^^^^^^^^^^^^^^^

* Bug fix in regex of ssl

Module version changes
^^^^^^^^^^^^^^^^^^^^^^

The following Python packages are used in this release::

   ansible==2.1.2.0
   click==6.7
   connexion==1.1.5
   Jinja2==2.9.5
   numpy==1.12.1
   paramiko==2.1.2
   pbr==2.0.0
   prettytable==0.7.2
   six==1.10.0
   PyYAML==3.12


It is considered as a baseline for future releases.

Reason for version
------------------

Features additions
^^^^^^^^^^^^^^^^^^

* Compute QPI (QTIP Performance Index) specification and benchmarking plan
* Command line interface
* API server

Framework evolution
^^^^^^^^^^^^^^^^^^^

The following components are implemented and integrated

* Native runner
* File loader
* Ansible driver
* Logfile collector
* Grep parser
* Console reporter

See JIRA for full `change log <https://jira.opnfv.org/jira/secure/ReleaseNote.jspa?projectId=10308&version=10555>`_

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

Software
^^^^^^^^

- `QTIP Docker image <https://hub.docker.com/r/opnfv/qtip>`_ (tag: danube.2.0)
- `QTIP Docker image <https://hub.docker.com/r/opnfv/qtip>`_ (tag: danube.1.0)

Documentation
^^^^^^^^^^^^^

- `Installation & Configuration <http://docs.opnfv.org/en/stable-danube/qtip/docs/testing/user/configguide>`_
- `User Guide <http://docs.opnfv.org/en/stable-danube/submodules/qtip/docs/testing/user/userguide>`_
- `Developer Guide <http://docs.opnfv.org/en/stable-danube/submodules/qtip/docs/testing/developer/devguide>`_

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

Limitations
-----------

- The compute benchmark plan is hard coded in native runner
- Baseline for Compute QPI is not created yet, therefore scores are not available

Known issues
------------

* QTIP-230 - logger warns about socket /dev/log when running in container

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

QTIP has undergone QA test runs with the following results:

+---------------------------------------------------+--------------------------------------+
| **TEST-SUITES**                                   | **Results:**                         |
|                                                   |                                      |
+---------------------------------------------------+--------------------------------------+
| qtip-verify-danube                                | 94/94 passed                         |
|                                                   |                                      |
+---------------------------------------------------+--------------------------------------+
| qtip-os-nosdn-kvm-ha-zte-pod3-daily-danube        | Successful                           |
|                                                   |                                      |
+---------------------------------------------------+--------------------------------------+
| qtip-os-nosdn-nofeature-ha-zte-pod3-daily-danube  | Successful                           |
|                                                   |                                      |
+---------------------------------------------------+--------------------------------------+
| qtip-os-odl_l2-nofeature-ha-zte-pod1-daily-danube | Successful                           |
|                                                   |                                      |
+---------------------------------------------------+--------------------------------------+