update README
authorThierry Parmentelat <thierry.parmentelat@inria.fr>
Wed, 12 Jun 2013 07:25:19 +0000 (09:25 +0200)
committerThierry Parmentelat <thierry.parmentelat@inria.fr>
Wed, 12 Jun 2013 07:25:19 +0000 (09:25 +0200)
README

diff --git a/README b/README
index d5188bc..f3dc058 100644 (file)
--- a/README
+++ b/README
@@ -1,11 +1,23 @@
-The PlanetLab NodeManager manages all aspects of PlanetLab node and slice management once the node has been initialized and configured by the Boot Manager. It periodically contacts its management authority for configuration updates. It provides an XML-RPC API for performing local operations on slices.
+The PlanetLab NodeManager manages all aspects of PlanetLab node and
+slice management once the node has been initialized and configured by
+the Boot Manager. It periodically contacts its management authority
+for configuration updates. It provides an XML-RPC API for performing
+local operations on slices.
 
 Copyright 2008 Princeton University
 http://www.planet-lab.org
 
 ========================================
---- NOTES on debugging
+--- NOTES on packaging
+
+we use the same codebase for vs-nodes and lxc-nodes
+common software gets shipped in nodemanager-lib, and specifics go in
+nodemanager-vs or nodemanager-lxc resp.
 
+we have chosen to keep the same historical layout for codebase,
+see setup-{lib,vs,lxc}.py for details of what goes where
+
+--- NOTES on debugging
 
 (*) service nm restartdebug
 this lets you restart the nodemanager in interactive mode, and with faster periods
@@ -13,21 +25,18 @@ this lets you restart the nodemanager in interactive mode, and with faster perio
 
 (*) logs
 logging is a bit confusing; the main recipient is 
-    /var/log/nm
-together with
-    /var/log/nm.daemon (which should be empty)
+    /var/log/nodemanager
 
+[older notes, not sure thisis still relevant]
 but beware that part of the logs eventually end up in 
-    /vservers/<slicename>/var/log/nm
+    /vservers/<slicename>/var/log/nodemanager
 as well as in here (although this should not be used anymore by now)
     /vservers/<slicename>/var/log/boot.log
 
-
 (*) connecting with PLC
 also, note that each time GetSlivers gets sucessfully fetched, it is saved in
-    /var/log/getslivers.txt
+    /var/lib/nodemanager/getslivers.txt
 
-When the connection is broken, for obscure reasons, all modules are
-invoked anyway, but with an empty dict as data, triggering various
-exceptions that complain about missing keys. In general these are red
-herrings.
+An effort was made so that the various pieces of nodemanager do not
+get called when connection with PLC is broken, however be aware that
+this might not be too robust and end up with red herrings