summaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/release-notes.rst
blob: c998f0fbfe1c0da6af479c6c723bfda5b608a2ec (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
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
License
=======

OPNFV Euphrates release note for Yardstick Docs
are licensed under a Creative Commons Attribution 4.0 International License.
You should have received a copy of the license along with this.
If not, see <http://creativecommons.org/licenses/by/4.0/>.

The *Yardstick framework*, the *Yardstick test cases* are open-source software,
 licensed under the terms of the Apache License, Version 2.0.

OPNFV Euphrates Release Note for Yardstick
==========================================

.. toctree::
   :maxdepth: 2

.. _Yardstick: https://wiki.opnfv.org/yardstick

.. _Dashboard: http://testresults.opnfv.org/grafana/dashboard/db/yardstick-main

.. _NFV-TST001: http://www.etsi.org/deliver/etsi_gs/NFV-TST/001_099/001/01.01.01_60/gs_NFV-TST001v010101p.pdf


Abstract
--------

This document describes the release note of Yardstick project.


Version History
---------------
+------------------+-----------+---------------------------------+
| *Date*           | *Version* | *Comment*                       |
|                  |           |                                 |
+------------------+-----------+---------------------------------+
| October 20, 2017 | 5.0.0     | Yardstick for Euphrates release |
|                  |           |                                 |
+------------------+-----------+---------------------------------+


Important Notes
---------------

The software delivered in the OPNFV Yardstick_ Project, comprising the
*Yardstick framework*, the *Yardstick test cases* and the experimental
framework *Apex Lake* is a realization of the methodology in ETSI-ISG
NFV-TST001_.

The *Yardstick* framework is *installer*, *infrastructure* and *application*
independent.

OPNFV Euphrates Release
-----------------------

This Euphrates release provides *Yardstick* as a framework for NFVI testing
and OPNFV feature testing, automated in the OPNFV CI pipeline, including:

* Documentation generated with Sphinx

  * User Guide

  * Developer Guide

  * Release notes (this document)

  * Results

* Automated Yardstick test suite (daily, weekly)

  * Jenkins Jobs for OPNFV community labs

* Automated Yardstick test results visualization

  * Dashboard_ using Grafana (user:opnfv/password: opnfv), influxDB is used as
    backend

* Yardstick framework source code

* Yardstick test cases yaml files

* Yardstick plug-in configuration yaml files, plug-in install/remove scripts

For Euphrates release, the *Yardstick framework* is used for the following
testing:

* OPNFV platform testing - generic test cases to measure the categories:

  * Compute

  * Network

  * Storage

* OPNFV platform network service benchmarking(NSB)

  * NSB

* Test cases for the following OPNFV Projects:

  * High Availability

  * IPv6

  * KVM

  * Parser

  * StorPerf

  * VSperf

  * virtual Traffic Classifier

The *Yardstick framework* is developed in the OPNFV community, by the
Yardstick_ team.

.. note:: The test case description template used for the Yardstick test cases
  is based on the document ETSI-ISG NFV-TST001_; the results report template
  used for the Yardstick results is based on the IEEE Std 829-2008.


Release Data
------------

+--------------------------------+-----------------------+
| **Project**                    | Yardstick             |
|                                |                       |
+--------------------------------+-----------------------+
| **Repo/tag**                   | yardstick/opnfv-5.0.0 |
|                                |                       |
+--------------------------------+-----------------------+
| **Yardstick Docker image tag** | opnfv-5.0.0           |
|                                |                       |
+--------------------------------+-----------------------+
| **Release designation**        | Euphrates             |
|                                |                       |
+--------------------------------+-----------------------+
| **Release date**               | October 20, 2017      |
|                                |                       |
+--------------------------------+-----------------------+
| **Purpose of the delivery**    | OPNFV Euphrates 5.0.0 |
|                                |                       |
+--------------------------------+-----------------------+


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

Documents
^^^^^^^^^

 - User Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/yardstick/docs/testing/user/userguide/index.html

 - Developer Guide: http://docs.opnfv.org/en/stable-euphrates/submodules/yardstick/docs/testing/developer/devguide/index.html


Software Deliverables
^^^^^^^^^^^^^^^^^^^^^


 - The Yardstick Docker image: https://hub.docker.com/r/opnfv/yardstick (tag: opnfv-5.0.0)


New Contexts
############

+--------------+-------------------------------------------+
| **Context**  | **Description**                           |
|              |                                           |
+--------------+-------------------------------------------+
| *Heat*       | Models orchestration using OpenStack Heat |
|              |                                           |
+--------------+-------------------------------------------+
| *Node*       | Models Baremetal, Controller, Compute     |
|              |                                           |
+--------------+-------------------------------------------+
| *Standalone* | Models VM running on Non-Managed NFVi     |
|              |                                           |
+--------------+-------------------------------------------+
| *Kubernetes* | Models VM running on Non-Managed NFVi     |
|              |                                           |
+--------------+-------------------------------------------+


New Runners
###########

+--------------+-------------------------------------------------------+
| **Runner**   | **Description**                                       |
|              |                                                       |
+--------------+-------------------------------------------------------+
| *Arithmetic* | Steps every run arithmetically according to specified |
|              | input value                                           |
|              |                                                       |
+--------------+-------------------------------------------------------+
| *Duration*   | Runs for a specified period of time                   |
|              |                                                       |
+--------------+-------------------------------------------------------+
| *Iteration*  | Runs for a specified number of iterations             |
|              |                                                       |
+--------------+-------------------------------------------------------+
| *Sequence*   | Selects input value to a scenario from an input file  |
|              | and runs all entries sequentially                     |
|              |                                                       |
+--------------+-------------------------------------------------------+


New Scenarios
#############

+----------------+-----------------------------------------------------+
| **Category**   | **Delivered**                                       |
|                |                                                     |
+----------------+-----------------------------------------------------+
| *Availability* | Attacker:                                           |
|                |                                                     |
|                | * baremetal, process                                |
|                |                                                     |
|                | HA tools:                                           |
|                |                                                     |
|                | * check host, openstack, process, service           |
|                | * kill process                                      |
|                | * start/stop service                                |
|                |                                                     |
|                | Monitor:                                            |
|                |                                                     |
|                | * command, process                                  |
|                |                                                     |
+----------------+-----------------------------------------------------+
| *Compute*      | * cpuload                                           |
|                |                                                     |
|                | * cyclictest                                        |
|                |                                                     |
|                | * lmbench                                           |
|                |                                                     |
|                | * lmbench_cache                                     |
|                |                                                     |
|                | * perf                                              |
|                |                                                     |
|                | * unixbench                                         |
|                |                                                     |
|                | * ramspeed                                          |
|                |                                                     |
|                | * cachestat                                         |
|                |                                                     |
|                | * memeoryload                                       |
|                |                                                     |
|                | * computecapacity                                   |
|                |                                                     |
+----------------+-----------------------------------------------------+
| *Networking*   | * iperf3                                            |
|                |                                                     |
|                | * netperf                                           |
|                |                                                     |
|                | * netperf_node                                      |
|                |                                                     |
|                | * ping                                              |
|                |                                                     |
|                | * ping6                                             |
|                |                                                     |
|                | * pktgen                                            |
|                |                                                     |
|                | * sfc                                               |
|                |                                                     |
|                | * sfc with tacker                                   |
|                |                                                     |
|                | * vtc instantion validation                         |
|                |                                                     |
|                | * vtc instantion validation with noisy neighbors    |
|                |                                                     |
|                | * vtc throughput                                    |
|                |                                                     |
|                | * vtc throughput in the presence of noisy neighbors |
|                |                                                     |
|                | * networkcapacity                                   |
|                |                                                     |
|                | * netutilization                                    |
|                |                                                     |
|                | * nstat                                             |
|                |                                                     |
+----------------+-----------------------------------------------------+
| *Parser*       | Tosca2Heat                                          |
|                |                                                     |
+----------------+-----------------------------------------------------+
| *Storage*      | fio                                                 |
|                |                                                     |
|                | storagecapacity                                     |
|                |                                                     |
+----------------+-----------------------------------------------------+
| *StorPerf*     | storperf                                            |
|                |                                                     |
+----------------+-----------------------------------------------------+
| *NSB*          | vPE thoughput test case                             |
|                |                                                     |
+----------------+-----------------------------------------------------+



New Test cases
^^^^^^^^^^^^^^



Version Change
--------------

Module Version Changes
^^^^^^^^^^^^^^^^^^^^^^

This is the fourth tracked release of Yardstick. It is based on following
upstream versions:

- OpenStack Ocata


Document Version Changes
^^^^^^^^^^^^^^^^^^^^^^^^

This is the fourth tracked version of the Yardstick framework in OPNFV.
It includes the following documentation updates:

- Yardstick User Guide: add "network service benchmarking(NSB)" chapter;
  add "Yardstick - NSB Testing -Installation" chapter; add "Yardstick API" chapter;
  add "Yardstick user interface" chapter; Update Yardstick installation chapter;

- Yardstick Developer Guide

- Yardstick Release Notes for Yardstick: this document


Feature additions
^^^^^^^^^^^^^^^^^

- Yardstick RESTful API support

- Introduce Network service benchmarking

- Introduce stress testing with Bottlenecks team

- Yardstick framework improvement:

  - Parellel test cases execution support

  - yardstick report CLI

  - Node context support OpenStack configuration via Ansible

  - Https support

- Python 3 support


Scenario Matrix
---------------

For Euphrates 5.0.0, Yardstick was tested on the following scenarios:

+--------------------------+------+---------+------+------+
| Scenario                 | Apex | Compass | Fuel | Joid |
+==========================+======+=========+======+======+
| os-nosdn-nofeature-noha  |      |         | X    | X    |
+--------------------------+------+---------+------+------+
| os-nosdn-nofeature-ha    | X    | X       | X    | X    |
+--------------------------+------+---------+------+------+
| os-odl_l2-nofeature-ha   |      | X       | X    | X    |
+--------------------------+------+---------+------+------+
| os-odl_l2-nofeature-noha |      |         | X    |      |
+--------------------------+------+---------+------+------+
| os-odl_l3-nofeature-ha   | X    | X       | X    |      |
+--------------------------+------+---------+------+------+
| os-odl_l3-nofeature-noha |      |         | X    |      |
+--------------------------+------+---------+------+------+
| os-onos-sfc-ha           |      |         |      |      |
+--------------------------+------+---------+------+------+
| os-onos-nofeature-ha     |      | X       |      | X    |
+--------------------------+------+---------+------+------+
| os-onos-nofeature-noha   |      |         |      |      |
+--------------------------+------+---------+------+------+
| os-odl_l2-sfc-ha         |      |         | X    |      |
+--------------------------+------+---------+------+------+
| os-odl_l2-sfc-noha       |      |         | X    |      |
+--------------------------+------+---------+------+------+
| os-odl_l2-bgpvpn-ha      | X    |         | X    |      |
+--------------------------+------+---------+------+------+
| os-odl_l2-bgpvpn-noha    |      |         | X    |      |
+--------------------------+------+---------+------+------+
| os-nosdn-kvm-ha          | X    |         | X    |      |
+--------------------------+------+---------+------+------+
| os-nosdn-kvm-noha        |      |         | X    |      |
+--------------------------+------+---------+------+------+
| os-nosdn-ovs-ha          |      |         | X    |      |
+--------------------------+------+---------+------+------+
| os-nosdn-ovs-noha        |      |         | X    |      |
+--------------------------+------+---------+------+------+
| os-ocl-nofeature-ha      |      | X       |      |      |
+--------------------------+------+---------+------+------+
| os-nosdn-lxd-ha          |      |         |      | X    |
+--------------------------+------+---------+------+------+
| os-nosdn-lxd-noha        |      |         |      | X    |
+--------------------------+------+---------+------+------+
| os-nosdn-fdio-ha         | X    |         |      |      |
+--------------------------+------+---------+------+------+
| os-odl_l2-fdio-noha      | X    |         |      |      |
+--------------------------+------+---------+------+------+
| os-odl-gluon-noha        | X    |         |      |      |
+--------------------------+------+---------+------+------+
| os-nosdn-openo-ha        |      | X       |      |      |
+--------------------------+------+---------+------+------+
| os-nosdn-kvm_ovs_dpdk    |      |         | X    |      |
| -noha                    |      |         |      |      |
+--------------------------+------+---------+------+------+
| os-nosdn-kvm_ovs_dpdk-ha |      |         | X    |      |
+--------------------------+------+---------+------+------+
| os-nosdn-kvm_ovs_dpdk    |      |         | X    |      |
| _bar-ha                  |      |         |      |      |
+--------------------------+------+---------+------+------+
| os-nosdn-kvm_ovs_dpdk    |      |         | X    |      |
| _bar-noha                |      |         |      |      |
+--------------------------+------+---------+------+------+
| opnfv_os-ovn-nofeature-  | X    |         |      |      |
| noha_daily               |      |         |      |      |
+--------------------------+------+---------+------+------+

Test results
------------

Test results are available in:

 - jenkins logs on CI: https://build.opnfv.org/ci/view/yardstick/

The reporting pages can be found at:

+---------------+-------------------------------------------------------------------------------------+
| apex          | http://testresults.opnfv.org/reporting/euphrates/yardstick/status-apex.html         |
+---------------+-------------------------------------------------------------------------------------+
| compass       | http://testresults.opnfv.org/reporting/euphrates/yardstick/status-compass.html      |
+---------------+-------------------------------------------------------------------------------------+
| fuel\@x86     | http://testresults.opnfv.org/reporting/euphrates/yardstick/status-fuel@x86.html     |
+---------------+-------------------------------------------------------------------------------------+
| fuel\@aarch64 | http://testresults.opnfv.org/reporting/euphrates/yardstick/status-fuel@aarch64.html |
+---------------+-------------------------------------------------------------------------------------+
| joid          | http://testresults.opnfv.org/reporting/euphrates/yardstick/status-joid.html         |
+---------------+-------------------------------------------------------------------------------------+

Known Issues/Faults
^^^^^^^^^^^^^^^^^^^


Corrected Faults
^^^^^^^^^^^^^^^^

Euphrates 5.0.0:

+---------------------+--------------------------------------------+
| **JIRA REFERENCE**  | **DESCRIPTION**                            |
|                     |                                            |
+---------------------+--------------------------------------------+
| JIRA: YARDSTICK-599 | Could not load EntryPoint.parse when using |
|                     | 'openstack -h'                             |
+---------------------+--------------------------------------------+
| JIRA: YARDSTICK-602 | Don't rely on staic ip addresses as they   |
|                     | are dynamic                                |
+---------------------+--------------------------------------------+


Euphratess 5.0.0 known restrictions/issues
------------------------------------------
+-----------+-----------+----------------------------------------------+
| Installer | Scenario  | Issue                                        |
+===========+===========+==============================================+
| any       | \*-bgpvpn | Floating ips not supported. Some Test cases  |
|           |           | related to floating ips are excluded.        |
+-----------+-----------+----------------------------------------------+
| any       | odl_l3-\* | Some test cases related to using floating IP |
|           |           | addresses fail because of a known ODL bug.   |
|           |           |                                              |
+-----------+-----------+----------------------------------------------+
| compass   | odl_l2-\* | In some test cases, VM instance will failed  |
|           |           | raising network interfaces.                  |
|           |           |                                              |
+-----------+-----------+----------------------------------------------+


Open JIRA tickets
-----------------

+---------------------+----------------------------------------------+
| **JIRA REFERENCE**  | **DESCRIPTION**                              |
|                     |                                              |
+---------------------+----------------------------------------------+
| JIRA: YARDSTICK-626 | Fio and Lmbench don't work in Ubuntu-arm64   |
|                     | image                                        |
+---------------------+----------------------------------------------+
| JIRA: YARDSTICK-603 | Timeout waiting for floating ip              |
|                     | (which actually pingable)                    |
+---------------------+----------------------------------------------+
| JIRA: YARDSTICK-412 | IPv6 test case should add support for newton |
|                     |                                              |
+---------------------+----------------------------------------------+


Useful links
------------

 - wiki project page: https://wiki.opnfv.org/display/yardstick/Yardstick

 - wiki Yardstick Euphrates release planing page: https://wiki.opnfv.org/display/yardstick/Yardstick+Euphrates+Release+Planning

 - Yardstick repo: https://git.opnfv.org/cgit/yardstick

 - Yardstick CI dashboard: https://build.opnfv.org/ci/view/yardstick

 - Yardstick grafana dashboard: http://testresults.opnfv.org/grafana/

 - Yardstick IRC chanel: #opnfv-yardstick