[GNUnet-SVN] r22711 - gnunet-planetlab/gplmt

[gnunet]

Author: wachs
Date: 2012-07-17 11:26:32 +0200 (Tue, 17 Jul 2012)
New Revision: 22711

Modified:
   gnunet-planetlab/gplmt/README
Log:
- more docu

Modified: gnunet-planetlab/gplmt/README
===================================================================
--- gnunet-planetlab/gplmt/README       2012-07-17 09:02:39 UTC (rev 22710)
+++ gnunet-planetlab/gplmt/README       2012-07-17 09:26:32 UTC (rev 22711)
@@ -6,7 +6,8 @@
 
 GNUnet is peer-to-peer framework focusing on security.  GNUnet use the 
 PlanetLab testbed for largescale testing. We use gplmt to deploy and 
-manage GNUnet and administer.
+manage GNUnet and administer. You can use gplmt to perform maintenance 
+or adminitrative tasks on a large number of hosts in parallel.
 
 Additional information and documentation about gplmt can be found at
 https://gnunet.org/gplmt.
@@ -44,7 +45,6 @@
 On GNU/Linux use: sudo pip install elementtree
 Or check http://effbot.org/zone/element-index.htm
 
-
 Paramiko
 --------
 
@@ -52,13 +52,80 @@
 Or check http://www.lag.net/paramiko/
 
 
-
 Usage
 ===============
 
+To run run gplmt you have to specify a configuration file, a node file 
+and a task file containing the tasks to perform.
 
-Configuration 
+./gplmt.py -c <configuration> -n <nodes> -t <tasks>
+
+The task and node file can also be specified in the configuration file.
+Command line arguments overwrite settings in the configuration file
+
+The Configuration File
 ===============
 
-Set up a Tasklist
+Here an example for an configuration file:
+
+[planetlab]
+slice = tum_dht_testing
+nodes = contrib/current.nodes
+tasks = contrib/tasks.xml
+
+A configuration file specifies the following options:
+
+slice:
+The name of the respective planetlab slice
+
+nodes:
+The file containing the list of hosts
+
+tasks:
+The file containing the tasks to perform
+
+Nodes file
 ===============
+
+A node file contains the list of the hosts where the tasks should be 
+performed on. The structure is simple, each line contains a hostname
+
+Example:
+
+dummy1.de
+dummy2.org
+
+The Tasklist
+===============
+
+A tasklist is the specification which tasks should be performed in 
+which order. The task list is written in XML. The basic element is the 
+root <tasklist> containing the tasks to execute. The tasks are 
+sequentially executed. A task is defined using the <task> element. 
+
+Here we have an example a tasklist first obtaining the current date and 
+and the listing the contents of the tmp directory:
+
+<?xml version="1.0" encoding="UTF-8"?>
+<tasklist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; 
xsi:noNamespaceSchemaLocation="../tasklist_schema.xsd">
+  <task>
+        <id>0</id>
+        <name>get date</name>
+        <type>run</type> 
+        <command>date</command> 
+        <arguments></arguments> 
+        <expected_return_code>0</expected_return_code>
+        <expected_output></expected_output>
+        <stop_on_fail>0</stop_on_fail>
+    </task> 
+  <task>
+        <id>1</id>
+        <name>list tmp</name>
+        <type>run</type> 
+        <command>ls /tmp</command> 
+        <arguments></arguments> 
+        <expected_return_code>0</expected_return_code>
+        <expected_output></expected_output>
+        <stop_on_fail>0</stop_on_fail>
+    </task>     
+</tasklist>