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

[gnunet]

Author: wachs
Date: 2013-10-16 15:31:52 +0200 (Wed, 16 Oct 2013)
New Revision: 30224

Modified:
   gnunet-planetlab/gplmt/README
Log:
apply newspeak


Modified: gnunet-planetlab/gplmt/README
===================================================================
--- gnunet-planetlab/gplmt/README       2013-10-16 13:17:29 UTC (rev 30223)
+++ gnunet-planetlab/gplmt/README       2013-10-16 13:31:52 UTC (rev 30224)
@@ -1,13 +1,12 @@
-   Welcome to GNUnet Planetlab Largescale Management Tool (gplmt)
+   Welcome to GNUnet Parallel Largescale Management Tool (gplmt)
 
 
-What is GNUnet Planetlab Largescale Management Tool?
+What is GNUnet Parallel Largescale Management Tool?
 ===============
 
-GNUnet is peer-to-peer framework focusing on security.  GNUnet use the 
-PlanetLab testbed for largescale testing. We use gplmt to deploy, 
-manage and administer GNUnet. You can use gplmt to perform maintenance 
-or adminitrative tasks on a large number of hosts in parallel.
+GNUnet is peer-to-peer framework focusing on security. We use GPLMT to 
+deploy, manage and administer GNUnet on a large number of remote nodes 
+parallel.
 
 Additional information and documentation about gplmt can be found at
 https://gnunet.org/gplmt .
@@ -43,8 +42,8 @@
 contrib/
 example configuration files, tasklists and tasklist XML schema
 
-contrib/
-some scripts to manage planetlab slices and other scripts
+docs/
+documentation file, e.g. user guide
 
 
 Dependencies:
@@ -95,163 +94,4 @@
 Usage
 ===============
 
-Run ./gplmt --help to get information about commandline arguments
-
-Usage
-===============
-
-To run gplmt you need to specify at least a configuration file to perform:
-
-./gplmt.py -c <configuration>
-
-If a configuration file is not passed to gplmt, it will try to use
-~/.gplmt/gplmt.conf instead.
-
-The command(s) to run can be specified in different ways:
-
-Single command:
-
-./gplmt.py -c <configuration> -C <command>
-
-Tasklist file specified in configuration file:
-
-tasks = contrib/tasks.xml
-
-Tasklist file passed as argument
-
-./gplmt.py -c <configuration> -t <tasks>
-
-
-The hosts to use can be specified in different ways:
-
-Single host
------------
-
-Perform the tasks on a single host. The host name is given as a command line 
-argument using the -H / --host switch:
-
-./gplmt.py -c <configuration> -t <tasks> -H hostname.local.example.com
-
-File
-----
-
-Perform the tasks on all hosts included in a file. Each line contains a 
-hostname The file name is given as a command line argument using the 
--n / --nodes switch:
-
-./gplmt.py -c <configuration> -t <tasks> -n nodes.file
-
-PlanetLab 
----------
-
-Perform the tasks on all nodes assigned to a PlanetLab slice. Slice name and 
-password can be specified in the configuration. If password required to be 
-secret, pass it  with the -p switch or wait to be prompted for it: 
-
-./gplmt.py -c <configuration> -t <tasks> -a -p <secretpw>
-
-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
-===============
-
-Here an example for an configuration file:
-
-[gplmt]
-# The file containing the list of hosts
-nodes = contrib/test_node.nodes
-# Which notification mechanism to use: 
-# simple: print messages to stdout
-# result: result summary after all threads finish
-notification = result
-# The file containing the tasks to perform
-tasks = contrib/tasklists/check_node.xml
-
-[planetlab]
-# The name of the respective planetlab slice
-slice = tumple_gnunet
-# Configuration for Planetlab API
-# Use PlanetLab nodes instead of nodes file
-# use_pl_nodes = yes
-# PlanetLab Europe
-api_url = https://www.planet-lab.eu/PLCAPI/
-# Planetlab
-#api_url = https://www.planet-lab.org/PLCAPI/
-
-# Planetlab username
-username = <pl_username>
-# Planetlab password
-password = <pl_pw>
-
-[ssh]
-# Order of ssh authentication:
-#
-# The ssh_keyfile_filename passed in (if any)
-# Any key we can find through an SSH agent
-# Any "id_rsa" or "id_dsa" key discoverable in ~/.ssh/
-# Plain password auth, if a ssh_password was given
-ssh_keyfile = <keyfile>
-ssh_password = <password>
-# protocoll for put get operations (Planetlab does not support SFTP)
-ssh_transfer = scp
-#ssh_transfer = sftp
-# Use system's SSH "known hosts" file
-ssh_use_known_hosts = yes
-# Add node hostkeys automatically
-add_unkown_hostkeys = yes
-
-
-Nodes file
-===============
-
-A node file contains the list of the hosts where the tasks should be 
-performed on.
-GPLMT supports the following formats for nodes:
-
-host1.example.com
-host2.example.com:222
address@hidden
address@hidden:222
-user:address@hidden:222
-
-In case a username and/or password is specified for a given node,it will 
-override any credentials specified in the configuration file for this node.
-
-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 as:
-
-<run> element: for running a command and checking the output
-<get> element: for copying a file from remote to local
-<put> element: for copying a file from local to remote
-
-Tasks can also be enclosed in a <sequence> element.
-
-Here we have an example a tasklist first obtaining the current date and 
-and then copying a file to the remote host
-
-<?xml version="1.0" encoding="UTF-8"?>
-<tasklist name="Deploy file" 
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; 
xsi:noNamespaceSchemaLocation="../tasklist_schema.xsd">
-       
-       <run id="0" name="check peer">
-        <command>sudo date</command> 
-        <arguments></arguments> 
-        <timeout>10</timeout>
-        <expected_return_code>0</expected_return_code>
-        <expected_output></expected_output>
-        <stop_on_fail>true</stop_on_fail>
-       </run>
-       
-       <sequence enabled="true">
-               <put id="1" name="put gnunet.conf">
-                       <source>contrib/gnunet.conf</source>
-                       <destination>/home/gnunet.conf</destination>
-                       <stop_on_fail>true</stop_on_fail>
-               </put> 
-    </sequence>
-</tasklist>
+Please have a look at the GPLMT user guide in docs/gplmt-userguide.pdf