From: Claudio-Daniel Freire <claudio-daniel.freire@inria.fr>
Date: Thu, 28 Jul 2011 10:00:03 +0000 (+0200)
Subject: Document the recovery procedure
X-Git-Tag: nepi-3.0.0~339
X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=570de8292e73643d29738c481b8634e46cc67040;p=nepi.git

Document the recovery procedure
---

diff --git a/src/nepi/core/execute.py b/src/nepi/core/execute.py
index 44c9c240..9d30f5ad 100644
--- a/src/nepi/core/execute.py
+++ b/src/nepi/core/execute.py
@@ -147,6 +147,17 @@ class TestbedController(object):
         raise NotImplementedError
 
     def recover(self):
+        """
+        On testbed recovery (if recovery is a supported policy), the controller
+        instance will be re-created and the following sequence invoked:
+        
+            do_setup
+            *recover*
+            <cross-connection methods>
+            
+        Start will not be called, and after cross connection invocations,
+        the testbed is supposed to be fully functional again.
+        """
         raise NotImplementedError
 
     def set(self, guid, name, value, time = TIME_NOW):