yardstick: Documentation and YAML testcase definitions

Yardstick supports execution of vsperf specific testcases.
These testcases are specified by YAML files located
inside yardstick/tests directory. Documentation describing
yardstick usage and execution of vsperf testcases is
part of the userguide.

JIRA: VSPERF-288

Change-Id: I5a575d28d344e0f3e0a1c8434e2f3231fd312d31
Signed-off-by: Martin Klozik <martinx.klozik@intel.com>
Reviewed-by: Maryam Tahhan <maryam.tahhan@intel.com>
Reviewed-by: Al Morton <acmorton@att.com>
Reviewed-by: Christian Trautman <ctrautma@redhat.com>
Reviewed-by: <bmichalo@redhat.com>
Reviewed-by: <sridhar.rao@spirent.com>

3 files changed, 222 insertions, 0 deletions

diff --git a/yardstick/tests/p2p_back2back.yaml b/yardstick/tests/p2p_back2back.yaml
new file mode 100644
index 00000000..39ab03e1
--- /dev/null
+++ b/yardstick/tests/p2p_back2back.yaml
@@ -0,0 +1,74 @@
+# Copyright 2016 Intel Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# VSPERF specific configuration file for execution of back2back traffic.
+# Traffic executed by traffic generator is forwarded directly between
+# interfaces connected to the traffic generator. So test will only
+# benchmark the performance of OVS external bridge at controller node.
+# For details about supported test options see following file from
+# the yardstick repository:
+#
+# yardstick/benchmark/scenarios/networking/vsperf.py
+
+schema: "yardstick:task:0.1"
+
+scenarios:
+-
+  type: Vsperf
+  options:
+    testname: 'rfc2544_p2p_back2back'
+    traffic_type: 'back2back'
+    pkt_sizes: '64'
+    bidirectional: 'True'
+    iload: 100
+    duration: 30
+    trafficgen_port1: 'eth1'
+    trafficgen_port2: 'eth3'
+    external_bridge: 'br-ex'
+    conf-file: '~/vsperf-yardstick.conf'
+
+  host: vsperf.demo
+
+  runner:
+    type: Sequence
+    scenario_option_name: pkt_sizes
+    sequence:
+    - 64
+    - 128
+    - 512
+    - 1024
+    - 1518
+  sla:
+    metrics: 'b2b_frames'
+    b2b_frames: 1
+    action: monitor
+
+context:
+  name: demo
+  image: vsperf
+  flavor: vsperf-flavor
+  user: ubuntu
+
+  placement_groups:
+    pgrp1:
+      policy: "availability"
+
+  servers:
+    vsperf:
+      floating_ip: true
+      placement: "pgrp1"
+
+  networks:
+    test:
+      cidr: '10.0.0.0/24'
diff --git a/yardstick/tests/p2p_cont.yaml b/yardstick/tests/p2p_cont.yaml
new file mode 100644
index 00000000..5cd63793
--- /dev/null
+++ b/yardstick/tests/p2p_cont.yaml
@@ -0,0 +1,74 @@
+# Copyright 2016 Intel Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# VSPERF specific configuration file for execution of continuous traffic.
+# Traffic executed by traffic generator is forwarded directly between
+# interfaces connected to the traffic generator. So test will only
+# benchmark the performance of OVS external bridge at controller node.
+# For details about supported test options see following file from
+# the yardstick repository:
+#
+# yardstick/benchmark/scenarios/networking/vsperf.py
+
+schema: "yardstick:task:0.1"
+
+scenarios:
+-
+  type: Vsperf
+  options:
+    testname: 'rfc2544_p2p_continuous'
+    traffic_type: 'continuous'
+    pkt_sizes: '64'
+    bidirectional: 'True'
+    iload: 100
+    duration: 30
+    trafficgen_port1: 'eth1'
+    trafficgen_port2: 'eth3'
+    external_bridge: 'br-ex'
+    conf-file: '~/vsperf-yardstick.conf'
+
+  host: vsperf.demo
+
+  runner:
+    type: Sequence
+    scenario_option_name: pkt_sizes
+    sequence:
+    - 64
+    - 128
+    - 512
+    - 1024
+    - 1518
+  sla:
+    metrics: 'throughput_rx_fps'
+    throughput_rx_fps: 500000
+    action: monitor
+
+context:
+  name: demo
+  image: vsperf
+  flavor: vsperf-flavor
+  user: ubuntu
+
+  placement_groups:
+    pgrp1:
+      policy: "availability"
+
+  servers:
+    vsperf:
+      floating_ip: true
+      placement: "pgrp1"
+
+  networks:
+    test:
+      cidr: '10.0.0.0/24'
diff --git a/yardstick/tests/p2p_tput.yaml b/yardstick/tests/p2p_tput.yaml
new file mode 100644
index 00000000..7a172450
--- /dev/null
+++ b/yardstick/tests/p2p_tput.yaml
@@ -0,0 +1,74 @@
+# Copyright 2016 Intel Corporation.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# VSPERF specific configuration file for execution of RFC2544 throughput
+# traffic. Traffic executed by traffic generator is forwarded directly
+# between interfaces connected to the traffic generator. So test will only
+# benchmark the performance of OVS external bridge at controller node.
+# For details about supported test options see following file from
+# the yardstick repository:
+#
+# yardstick/benchmark/scenarios/networking/vsperf.py
+
+schema: "yardstick:task:0.1"
+
+scenarios:
+-
+  type: Vsperf
+  options:
+    testname: 'rfc2544_p2p_tput'
+    traffic_type: 'rfc2544'
+    pkt_sizes: '64'
+    bidirectional: 'True'
+    iload: 100
+    duration: 30
+    trafficgen_port1: 'eth1'
+    trafficgen_port2: 'eth3'
+    external_bridge: 'br-ex'
+    conf-file: '~/vsperf-yardstick.conf'
+
+  host: vsperf.demo
+
+  runner:
+    type: Sequence
+    scenario_option_name: pkt_sizes
+    sequence:
+    - 64
+    - 128
+    - 512
+    - 1024
+    - 1518
+  sla:
+    metrics: 'throughput_rx_fps'
+    throughput_rx_fps: 500000
+    action: monitor
+
+context:
+  name: demo
+  image: vsperf
+  flavor: vsperf-flavor
+  user: ubuntu
+
+  placement_groups:
+    pgrp1:
+      policy: "availability"
+
+  servers:
+    vsperf:
+      floating_ip: true
+      placement: "pgrp1"
+
+  networks:
+    test:
+      cidr: '10.0.0.0/24'