Add run_in_background attribute to scenarios

This change adds the possibility to run scenarios as "background
tasks".

Background scenarios/tasks:
  - are started before all "normal scenarios"
  - runs in parallel with "normal scenarios"
  - terminates when all "normal scenarios" have completed
    their tasks

They are intended as a way to perform background tasks, e.g. collect
data such as cpuload etc, in parallel with the execution of normal
benchmarking scenarios.

Note that we already have the 'run_in_parallel' attribute but
this attribute has a couple of issues and do not solve all the
uses cases.

Change-Id: I9c5230bfdbbb66030f57b658ce1db87ff2c2d62b
Signed-off-by: Jo¶rgen Karlsson <jorgen.w.karlsson@ericsson.com>

1 files changed, 60 insertions, 0 deletions

diff --git a/samples/background-task.yaml b/samples/background-task.yaml
new file mode 100644
index 000000000..f81867b33
--- /dev/null
+++ b/samples/background-task.yaml
@@ -0,0 +1,60 @@
+---
+# Sample benchmark task config file
+# Demonstrate use of background scenarios
+
+schema: "yardstick:task:0.1"
+
+scenarios:
+-
+  type: CPUload
+  options:
+    interval: 1
+
+  host: zeus.demo
+
+  # This scenario is run as a background scenario and runs
+  # in parallel with other scenarios.
+  #
+  # Background scenarios are started before normal scenarios
+  # and are terminated when all normal scenarios have ended.
+  #
+  # A background scenario does not need a runner section as it
+  # will always use an infinite duration runner that are terminated
+  # when all normal scenarios have completed.
+  #
+  run_in_background: true   # default: false
+-
+  type: Iperf3
+  options:
+  host: zeus.demo
+  target: hera.demo
+
+  runner:
+    type: Duration
+    duration: 60
+
+  sla:
+    bytes_per_second: 2900000000
+    action: monitor
+
+context:
+  name: demo
+  image: yardstick-trusty-server
+  flavor: yardstick-flavor
+  user: ec2-user
+
+  placement_groups:
+    pgrp1:
+      policy: "availability"
+
+  servers:
+    zeus:
+      floating_ip: true
+      placement: "pgrp1"
+    hera:
+      floating_ip: true
+      placement: "pgrp1"
+
+  networks:
+    test:
+      cidr: '10.0.1.0/24'