summaryrefslogtreecommitdiffstats
path: root/puppet/services/manila-backend-netapp.yaml
blob: c95a8da7567d0553c0c74fac8f48292b14870e10 (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
heat_template_version: 2016-04-08

description: >
  Openstack Manila netapp backend.

parameters:
  ManilaNetappEnableBackend:
    type: boolean
    default: false
  ManilaNetappDriverHandlesShareServers:
    type: string
    default: true
  ManilaNetappBackendName:
    type: string
    default: tripleo_netapp
  ManilaNetappLogin:
    type: string
    default: ''
  ManilaNetappPassword:
    type: string
    default: ''
  ManilaNetappServerHostname:
    type: string
    default: ''
  ManilaNetappTransportType:
    type: string
    default: 'http'
  ManilaNetappStorageFamily:
    type: string
    default: 'ontap_cluster'
  ManilaNetappServerPort:
    type: number
    default: 80
  ManilaNetappVolumeNameTemplate:
    type: string
    default: 'share_%(share_id)s'
  ManilaNetappVserver:
    type: string
    default: ''
  ManilaNetappVserverNameTemplate:
    type: string
    default: 'os_%s'
  ManilaNetappLifNameTemplate:
    type: string
    default: 'os_%(net_allocation_id)s'
  ManilaNetappAggrNameSearchPattern:
    type: string
    default: '(.*)'
  ManilaNetappRootVolumeAggr:
    type: string
    default: ''
  ManilaNetappRootVolume:
    type: string
    default: 'root'
  ManilaNetappPortNameSearchPattern:
    type: string
    default: '(.*)'
  ManilaNetappTraceFlags:
    type: string
    default: ''
  ManilaNetappEnabledShareProtocols:
    type: string
    default: 'nfs3, nfs4.0'
  ManilaNetappVolumeSnapshotReservePercent:
    type: number
    default: 5
  ManilaNetappSnapmirrorQuiesceTimeout:
    type: number
    default: 3600
  ServiceNetMap:
    default: {}
    description: Mapping of service_name -> network name. Typically set
                 via parameter_defaults in the resource registry.  This
                 mapping overrides those in ServiceNetMapDefaults.
    type: json
  DefaultPasswords:
    default: {}
    type: json
  EndpointMap:
    default: {}
    type: json
    description: Mapping of service endpoint -> protocol. Typically set
                 via parameter_defaults in the resource registry.

outputs:
  role_data:
    description: Role data for the Manila Netapp backend.
    value:
      service_name: manila_backend_netapp
      config_settings:
        manila_netapp_enable_backend: {get_param: ManilaNetappEnableBackend}
        manila::backend::netapp::title: {get_param: ManilaNetappBackendName}
        manila::backend::netapp::netapp_login: {get_param: ManilaNetappLogin}
        manila::backend::netapp::driver_handles_share_servers: {get_param: ManilaNetappDriverHandlesShareServers}
        manila::backend::netapp::netapp_password: {get_param: ManilaNetappPassword}
        manila::backend::netapp::netapp_server_hostname: {get_param: ManilaNetappServerHostname}
        manila::backend::netapp::netapp_transport_type: {get_param: ManilaNetappTransportType}
        manila::backend::netapp::netapp_storage_family: {get_param: ManilaNetappStorageFamily}
        manila::backend::netapp::netapp_server_port: {get_param: ManilaNetappServerPort}
        manila::backend::netapp::netapp_volume_name_template: {get_param: ManilaNetappVolumeNameTemplate}
        manila::backend::netapp::netapp_vserver: {get_param: ManilaNetappVserver}
        manila::backend::netapp::netapp_vserver_name_template: {get_param: ManilaNetappVserverNameTemplate}
        manila::backend::netapp::netapp_lif_name_template: {get_param: ManilaNetappLifNameTemplate}
        manila::backend::netapp::netapp_aggregate_name_search_pattern: {get_param: ManilaNetappAggrNameSearchPattern}
        manila::backend::netapp::netapp_root_volume_aggregate: {get_param: ManilaNetappRootVolumeAggr}
        manila::backend::netapp::netapp_root_volume: {get_param: ManilaNetappRootVolume}
        manila::backend::netapp::netapp_port_name_search_pattern: {get_param: ManilaNetappPortNameSearchPattern}
        manila::backend::netapp::netapp_trace_flags: {get_param: ManilaNetappTraceFlags}
        manila::backend::netapp::netapp_enabled_share_protocols: {get_param: ManilaNetappEnabledShareProtocols}
        manila::backend::netapp::netapp_volume_snapshot_reserve_percent: {get_param: ManilaNetappVolumeSnapshotReservePercent}
        manila::backend::netapp::netapp_snapmirror_quiesce_timeout: {get_param: ManilaNetappSnapmirrorQuiesceTimeout}
      step_config:
4 } /* Literal.String.Single */ .highlight .ss { color: #e6db74 } /* Literal.String.Symbol */ .highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #a6e22e } /* Name.Function.Magic */ .highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */ .highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */ .highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */ .highlight .vm { color: #f8f8f2 } /* Name.Variable.Magic */ .highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */ } @media (prefers-color-scheme: light) { .highlight .hll { background-color: #ffffcc } .highlight .c { color: #888888 } /* Comment */ .highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */ .highlight .k { color: #008800; font-weight: bold } /* Keyword */ .highlight .ch { color: #888888 } /* Comment.Hashbang */ .highlight .cm { color: #888888 } /* Comment.Multiline */ .highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */ .highlight .cpf { color: #888888 } /* Comment.PreprocFile */ .highlight .c1 { color: #888888 } /* Comment.Single */ .highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ .highlight .gr { color: #aa0000 } /* Generic.Error */ .highlight .gh { color: #333333 } /* Generic.Heading */ .highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */ .highlight .go { color: #888888 } /* Generic.Output */ .highlight .gp { color: #555555 } /* Generic.Prompt */ .highlight .gs { font-weight: bold } /* Generic.Strong */ .highlight .gu { color: #666666 } /* Generic.Subheading */ .highlight .gt { color: #aa0000 } /* Generic.Traceback */ .highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */ .highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */ .highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */ .highlight .kp { color: #008800 } /* Keyword.Pseudo */ .highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */ .highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */ .highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */ .highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */ .highlight .na { color: #336699 } /* Name.Attribute */ .highlight .nb { color: #003388 } /* Name.Builtin */ .highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */ .highlight .no { color: #003366; font-weight: bold } /* Name.Constant */ .highlight .nd { color: #555555 } /* Name.Decorator */ .highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */ .highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */ .highlight .nl { color: #336699; font-style: italic } /* Name.Label */ .highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */ .highlight .py { color: #336699; font-weight: bold } /* Name.Property */ .highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */ .highlight .nv { color: #336699 } /* Name.Variable */ .highlight .ow { color: #008800 } /* Operator.Word */ .highlight .w { color: #bbbbbb } /* Text.Whitespace */ .highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */ .highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */ .highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */ .highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */ .highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */ .highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */ .highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */ .highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */ .highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */ .highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */ .highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */ .highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */ .highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */ .highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */ .highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */ .highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */ .highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */ .highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */ .highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */ .highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */ .highlight .vc { color: #336699 } /* Name.Variable.Class */ .highlight .vg { color: #dd7700 } /* Name.Variable.Global */ .highlight .vi { color: #3333bb } /* Name.Variable.Instance */ .highlight .vm { color: #336699 } /* Name.Variable.Magic */ .highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */ }
=======
License
=======

OPNFV Danube 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 opensource software,
 licensed under the terms of the Apache License, Version 2.0.

=========================================
OPNFV Danube 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*                       |
|                |                    |                                 |
+----------------+--------------------+---------------------------------+
|                |  3.1               | Yardstick for Danube release    |
|                |                    |                                 |
|                |                    | Note: The 3.1 tag is due to git |
|                |                    | tag issue during Danube 3.0     |
|                |                    | release                         |
|                |                    |                                 |
+----------------+--------------------+---------------------------------+
| May 4th, 2017  |  2.0               | Yardstick for Danube release    |
|                |                    |                                 |
+----------------+--------------------+---------------------------------+
| Mar 31st, 2017 |  1.0               | Yardstick for Danube 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 Danube Release
======================

This Danube 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 configration yaml files, plug-in install/remove scripts

For Danube 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. The *virtual Traffic Classifier* is a part of the Yardstick
Project.

.. 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/Danube.3.1                 |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Yardstick Docker image tag**       | Danube.3.1                           |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Danube                               |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | July 14th, 2017                      |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | OPNFV Danube release 3.0             |
|                                      |                                      |
+--------------------------------------+--------------------------------------+


Deliverables
============

Documents
---------

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

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


Software Deliverables
---------------------


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


**Contexts**

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


**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                     |
|                     |                                                       |
+---------------------+-------------------------------------------------------+


**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                               |
|                     |                                                       |
+---------------------+-------------------------------------------------------+


**Test Results Output**

+-----------------------------+-----------------------------------------------+
| **Dispatcher**              | **Description**                               |
|                             |                                               |
+-----------------------------+-----------------------------------------------+
|  file                       | Log to a file.                                |
|                             |                                               |
+-----------------------------+-----------------------------------------------+
|  http                       | Post data to html.                            |
|                             |                                               |
+-----------------------------+-----------------------------------------------+
|  influxdb                   | Post data to influxDB.                        |
|                             |                                               |
+-----------------------------+-----------------------------------------------+


Delivered Test cases
--------------------

* Generic NFVI test cases

  * OPNFV_YARDSTICK_TCOO1 - NW Performance

  * OPNFV_YARDSTICK_TCOO2 - NW Latency

  * OPNFV_YARDSTICK_TCOO4 - Cache Utilization

  * OPNFV_YARDSTICK_TCOO5 - Storage Performance

  * OPNFV_YARDSTICK_TCOO8 - Packet Loss Extended Test

  * OPNFV_YARDSTICK_TCOO9 - Packet Loss

  * OPNFV_YARDSTICK_TCO10 - Memory Latency

  * OPNFV_YARDSTICK_TCO11 - Packet Delay Variation Between VMs

  * OPNFV_YARDSTICK_TCO12 - Memory Bandwidth

  * OPNFV_YARDSTICK_TCO14 - Processing Speed

  * OPNFV_YARDSTICK_TCO24 - CPU Load

  * OPNFV_YARDSTICK_TCO37 - Latency, CPU Load, Throughput, Packet Loss

  * OPNFV_YARDSTICK_TCO38 - Latency, CPU Load, Throughput, Packet Loss Extended
    Test

  * OPNFV_YARDSTICK_TCO42 - Network Performance

  * OPNFV_YARDSTICK_TCO43 - Network Latency Between NFVI Nodes

  * OPNFV_YARDSTICK_TCO44 - Memory Utilization

  * OPNFV_YARDSTICK_TCO55 - Compute Capacity

  * OPNFV_YARDSTICK_TCO61 - Network Utilization

  * OPNFV_YARDSTICK_TCO63 - Storage Capacity

  * OPNFV_YARDSTICK_TCO69 - Memory Bandwidth

  * OPNFV_YARDSTICK_TCO70 - Latency, Memory Utilization, Throughput, Packet
    Loss

  * OPNFV_YARDSTICK_TCO71 - Latency, Cache Utilization, Throughput, Packet Loss

  * OPNFV_YARDSTICK_TCO72 - Latency, Network Utilization, Throughput, Packet
    Loss

  * OPNFV_YARDSTICK_TC073 - Network Latency and Throughput Between Nodes

  * OPNFV_YARDSTICK_TCO75 - Network Capacity and Scale

  * OPNFV_YARDSTICK_TCO76 - Network frame error rate

* Test Cases for OPNFV HA Project:

  * OPNFV_YARDSTICK_TCO19 - HA: Control node Openstack service down

  * OPNFV_YARDSTICK_TC025 - HA: OpenStacK Controller Node abnormally down

  * OPNFV_YARDSTICK_TCO45 - HA: Control node Openstack service down - neutron
    server

  * OPNFV_YARDSTICK_TC046 - HA: Control node Openstack service down - keystone

  * OPNFV_YARDSTICK_TCO47 - HA: Control node Openstack service down - glance
    api

  * OPNFV_YARDSTICK_TC048 - HA: Control node Openstack service down - cinder
    api

  * OPNFV_YARDSTICK_TCO49 - HA: Control node Openstack service down - swift
    proxy

  * OPNFV_YARDSTICK_TC050 - HA: OpenStack Controller Node Network High
    Availability

  * OPNFV_YARDSTICK_TCO51 - HA: OpenStack Controller Node CPU Overload High
    Availability

  * OPNFV_YARDSTICK_TC052 - HA: OpenStack Controller Node Disk I/O Block High
    Availability

  * OPNFV_YARDSTICK_TCO53 - HA: OpenStack Controller Load Balance Service High
    Availability

  * OPNFV_YARDSTICK_TC054 - HA: OpenStack Virtual IP High Availability

* Test Case for OPNFV IPv6 Project:

  * OPNFV_YARDSTICK_TCO27 - IPv6 connectivity

* Test Case for OPNFV KVM Project:

  * OPNFV_YARDSTICK_TCO28 - KVM Latency measurements

* Test Case for OPNFV Parser Project:

  * OPNFV_YARDSTICK_TCO40 - Verify Parser Yang-to-Tosca

* Test Case for OPNFV StorPerf Project:

  * OPNFV_YARDSTICK_TCO74 - Storperf

* Test Cases for Virtual Traffic Classifier:

  * OPNFV_YARDSTICK_TC006 - Virtual Traffic Classifier Data Plane Throughput

* Benchmarking Test:

  * OPNFV_YARDSTICK_TC007 - Virtual Traffic Classifier Data Plane Throughput

* Benchmarking in presence of noisy neighbors Test:

  * OPNFV_YARDSTICK_TC020 - Virtual Traffic Classifier Instantiation Test

  * OPNFV_YARDSTICK_TC021 - Virtual Traffic Classifier Instantiation in
    presence of noisy neighbors Test


Version Change
==============

Module Version Changes
----------------------

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

- ONOS Ibis

- OpenStack Newton

- OpenDaylight Boron


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 Danube 3.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/yardstick/release/danube/index-status-apex.html
 * compass: http://testresults.opnfv.org/reporting/yardstick/release/danube/index-status-compass.html
 * fuel: http://testresults.opnfv.org/reporting/yardstick/release/danube/index-status-fuel.html
 * joid: http://testresults.opnfv.org/reporting/yardstick/release/danube/index-status-joid.html


Known Issues/Faults
------------

 - Floating IP not supported in bgpvpn scenario

 - VM instance cannot get floating IP in compass-os-odl_l2-nofeature-ha scenario

.. note:: The faults not related to *Yardstick* framework, addressing scenarios
  which were not fully verified, are listed in the OPNFV installer's release
  notes.


Corrected Faults
----------------

Danube.3.1:

+----------------------------+------------------------------------------------+
| **JIRA REFERENCE**         | **DESCRIPTION**                                |
|                            |                                                |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-714        | Add yardstick env influxdb/grafana command for |
|                            | CentOS                                         |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-655        | Monitor command in tc019 may not show the      |
|                            | real nova-api service status                   |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-397        | HA testing framework improvement               |
|                            |                                                |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-660        | Improve monitor_process pass criteria          |
|                            |                                                |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-657        | HA monitor_multi bug,                          |
|                            | KeyError: 'max_outage_time'                    |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-647        | TC025 fault_type value is wrong when using     |
|                            | baremetal pod scripts                          |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-659        | Terminate openstack service process using kill |
|                            | command in HA test cases                       |
+----------------------------+------------------------------------------------+
| JIRA: ARMBAND-275          | Yardstick TC005 fails with                     |
|                            | "Cannot map zero-fill pages" error             |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-561        | Bugfix: AttributeError: 'dict' object has no   |
|                            | attribute 'split' if run sample/ping-hot.yaml  |
+----------------------------+------------------------------------------------+
| JIRA: ARMBAND-268          | ERROR No JSON object could be decoded from     |
|                            | LMBENCH in TC010                               |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-680        | storperf test case tc074 do not get results    |
|                            |                                                |
+----------------------------+------------------------------------------------+

Danube.2.0:

+----------------------------+------------------------------------------------+
| **JIRA REFERENCE**         | **DESCRIPTION**                                |
|                            |                                                |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-608        | Set work directory in Yardstick container      |
|                            |                                                |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-616        | Bugfix: https support should adapt insecure    |
|                            | situation                                      |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-620        | Yardstick virtualenv support                   |
|                            |                                                |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-621        | Bugfix: fix query job status in TC074          |
|                            |                                                |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-622        | Bugfix: take test case modification into       |
|                            | effect in load_images.sh                       |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-623        | change openrc file path to                     |
|                            | /etc/yardstick/openstack.creds                 |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-624        | Add opnfv_os-ovn-nofeature-noha_daily test     |
|                            | suite                                          |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-628        | Bugfix: Make tc019 and tc025 accept            |
|                            | --task-args options                            |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-629        | Bugfix: yardstick env prepare cmd do not       |
|                            | support other installer                        |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-632        | Bugfix: KeyError when using http dispatcher    |
|                            |                                                |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-633        | Bugfix: Environment Compatibility Issues in HA |
|                            | Test Cases                                     |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-634        | fix ha issue when run tc050~tc054 in ci        |
|                            |                                                |
+----------------------------+------------------------------------------------+
| JIRA: YARDSTICK-635        | Bugfix: Local Openstack Operation in HA test   |
|                            | frameworks                                     |
+----------------------------+------------------------------------------------+

Danube.1.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                                    |
+----------------------------+------------------------------------------------+


Danube 3.1 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 Danube release planing page: https://wiki.opnfv.org/display/yardstick/Yardstick+Danube+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