Differences

This shows you the differences between two versions of the page.

--- scenario_file_format [2017/10/20 11:21] – [Grammar] mimbert
+++ scenario_file_format [2019/11/28 15:46] – [Grammar] mimbert
@@ Line 13: / Line 13: @@
 The scenario.yaml file is structured as follows:
-  * It //MUST// contain a //description// key, value pair whose value is a string: ''description: <string>''
+  * It //MUST// contain a ''description'' key, value pair whose value is a string: ''description: <string>''
-  * It //MUST// contain a //duration// key, value pair, whose value is an integer, the max experiment duration expressed in seconds: ''duration: <integer>''
+  * It //MUST// contain a ''duration'' key, value pair, whose value is an integer, the max experiment duration expressed in seconds: ''duration: <integer>''
-  * It //MUST// contain a //nodes// key, whose value is a mapping (aka hash, or dictionnary): ''nodes:''. This mapping //MUST// contain:
+  * It //MUST// contain a ''nodes'' key, whose value is a mapping (aka hash, or dictionnary). This mapping //MUST// contain:
-    * Nodes key, value pairs, whose keys are the node names (in the set //node1// to //node40//, and whose values are mappings:
+    * Nodes key, value pairs, whose keys are the node names (in the set ''node1'' to ''node40'', and whose values are mappings:
-      * which //MUST// contain a //command// key, value pair, whose value is the command line string which will be run on the corresponding node: ''command: <string>''. Note that any filesystem path may be absolute or relative. If relative, it will be relative to the task top directory on the node. Note also that minus does NO magic with filesystem permissions, thus if a script or binary is to be executed, it needs to have executable permissions set before creating the task. The //command// may also, if needed, contain a list of commands to be executed, instead of a single command. All the commands will be executed in parallel on the node. In this case, the syntax is multiline: <code>
+      * which //MUST// contain //ONLY ONE// of the following:
+        * (new syntax) //EITHER// a ''container'' key, value pair, whose value is a mapping with the following key, value pairs:
+          * ''image'' //MANDATORY// a string, the docker image name
+          * ''command'' //OPTIONAL// a string, the command to run in the container, which overrides the image default command (see https://docs.docker.com/engine/reference/run/#cmd-default-command-or-options https://docs.docker.com/engine/reference/builder/#cmd)
+          * ''exec'' //OPTIONAL// a string or array of strings: additionnal commands which are executed in the container (see https://docs.docker.com/engine/reference/commandline/exec/)
+          * ''name'' //OPTIONAL// a string for specifying the container's name. If not given, a default name will be automatically generated, with the minus task number and the container rank on the node.
+        * (old syntax) //OR// a //command// key, value pair, whose value is the command line string which will be run on the corresponding node: ''command: <string>''. Note that any filesystem path may be absolute or relative. If relative, it will be relative to the task top directory on the node. Note also that minus does NO magic with filesystem permissions, thus if a script or binary is to be executed, it needs to have executable permissions set before creating the task. The //command// may also, if needed, contain a list of commands to be executed, instead of a single command. All the commands will be executed in parallel on the node. In this case, the syntax is multiline: <code>
 nodes:
   node1: