[PATCH] osmo-gsm-manuals[master]: OsmoGSMTester: Add scenarios_dir section

[Pau Espin Pedrol]

Hello Neels Hofmeyr, Jenkins Builder,

I'd like you to reexamine a change.  Please visit

    https://gerrit.osmocom.org/4667

to look at the new patch set (#4).

OsmoGSMTester: Add scenarios_dir section

It explains how scenario combination works

Change-Id: I3f89bd3d71400da14cda7ea8bb9c190fe80a539f
---
M OsmoGSMTester/chapters/config.adoc
1 file changed, 34 insertions(+), 0 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/osmo-gsm-manuals refs/changes/67/4667/4

diff --git a/OsmoGSMTester/chapters/config.adoc b/OsmoGSMTester/chapters/config.adoc
index 3f8cb44..a6a6c16 100644
--- a/OsmoGSMTester/chapters/config.adoc
+++ b/OsmoGSMTester/chapters/config.adoc
@@ -58,6 +58,40 @@
 that the 'state_dir' is used to reserve resources, which only works when all
 configurations that share resources also use the same 'state_dir'.
 
+[[scenarios_dir]]
+==== 'scenarios_dir'
+
+Scenarios define contrains that match one-to-one with the resources specified
+in a 'suite.conf' for a specific type of resource after the list is expanded
+taking the 'times' attribute into account. This means, for instance, that given
+'suite.conf' requests 2 BTS and that we want to enforce both to be of type
+'osmo-bts-sysmo', we then need to provide an scenario like the one below:
+
+----
+resources:
+  bts:
+  - type: osmo-bts-sysmo
+  - type: osmo-bts-sysmo
+----
+
+or alternatively,
+
+----
+resources:
+  bts:
+  - times: 2
+    type: osmo-bts-sysmo
+----
+
+If only one resource is specified in the scenario, then the resource allocator
+assumes the restriction is to be applied to the first resource and that next
+resources have no restrictions to be taken into consideration. If the user wants
+to apply no restrictions to the first resource but wants to do so for any of the
+other ones, the first element can be listed but left empty in the scenario file.
+
+Any number of such scenario configurations can be combined in the form
+'<suite_name>:<scenario>+<scenario>+...', e.g. 'my_suite:sysmo+tch_f+amr'.
+
 [[resources_conf]]
 === 'resources.conf'
 

-- 
To view, visit https://gerrit.osmocom.org/4667
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: newpatchset
Gerrit-Change-Id: I3f89bd3d71400da14cda7ea8bb9c190fe80a539f
Gerrit-PatchSet: 4
Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-Owner: Pau Espin Pedrol <pespin at sysmocom.de>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: Neels Hofmeyr <nhofmeyr at sysmocom.de>
Gerrit-Reviewer: Pau Espin Pedrol <pespin at sysmocom.de>