RequestTaskAgent: Docs: add parameters as config template like structure

DIRACGrid · Jun 21, 2018 · 9fd701c · 9fd701c
1 parent a9934cf
commit 9fd701c
Showing 1 changed file with 60 additions and 11 deletions.
diff --git a/TransformationSystem/Agent/RequestTaskAgent.py b/TransformationSystem/Agent/RequestTaskAgent.py
@@ -1,18 +1,18 @@
 """The Request Task Agent takes request tasks created in the
 TransformationDB and submits to the request management system.
 
+The following options can be set for the RequestTaskAgent.
+
 +----------------------+---------------------------------------+-------------------------------------------------------+
 | **Name**             | **Description**                       | **Example**                                           |
 +----------------------+---------------------------------------+-------------------------------------------------------+
 | *shifterProxy*       | Use a dedicated proxy to submit jobs  | DataManager                                           |
 |                      | to the WMS                            |                                                       |
 +----------------------+---------------------------------------+-------------------------------------------------------+
 | *ShifterCredentials* | Use delegated credentials, same values|                                                       |
-|                      |as for                                 |                                                       |
-|                      | shifterProxy, but there will not be   |                                                       |
-|                      |any actual                             |                                                       |
-|                      | proxy used. (New in v6r21)            |                                                       |
-|                      |                                       |                                                       |
+|                      | as for shifterProxy, but there will   |                                                       |
+|                      | not be any actual proxy used.         |                                                       |
+|                      | (New in v6r21)                        |                                                       |
 +----------------------+---------------------------------------+-------------------------------------------------------+
 | *TransType*          |                                       |                                                       |
 +----------------------+---------------------------------------+-------------------------------------------------------+
@@ -43,13 +43,62 @@
 | *UpdateFileStatus*   |                                       | Active, Completing, Stopped                           |
 +----------------------+---------------------------------------+-------------------------------------------------------+
 
-.. versionadded:: v6r21
 
- It is possible to run the RequestTaskAgent without a *shifterProxy* or
- *ShifterCredentials*, in this case the credentials of the authors of the
- transformations are used to submit the jobs to the RMS. This enables the use of
- a single RequestTaskAgent for multiple VOs. See also the section about the
- :ref:`trans-multi-vo`.
+::
+
+  RequestTaskAgent
+  {
+    # Use a dedicated proxy to submit jobsto the WMS
+    shifterProxy=DataManager
+    # Use delegated credentials. Use this instead of the shifterProxy option (New in v6r21)
+    ShifterCredentials=
+    # TransformationTypes to treat in this agent
+    TransType=Replication,Removal
+    # Location of the transformation plugins
+    PluginLocation=DIRAC.TransformationSystem.Client.TaskManagerPlugin
+    # maximum number of threads to use in this agent
+    maxNumberOfThreads=15
+
+    # Give this option a value if the agent should submit Requests
+    SubmitTasks=
+    # Status of transformations for which to submit Requests
+    SubmitStatus=Active,Completing
+    # Number of tasks to submit in one execution cycle per transformation
+    TasksPerLoop=50
+
+    # Give this option a value if the agent should monitor tasks
+    MonitorTasks=
+    # Status of transformations for which to monitor tasks
+    UpdateTasksStatus  = Active,Completing,Stopped
+    # Status values of tasks taht should be updated
+    TaskUpdateStatus=Checking,Deleted,Killed,Staging,Stalled,Matched
+    TaskUpdateStatus+=Scheduled,Rescheduled,Completed,Submitted
+    TaskUpdateStatus+=Assigned,Received,Waiting,Running
+    # Number of tasks to be updated in one call
+    TaskUpdateChunkSize=0
+
+    # Give this option a value if the agent should monitor files
+    MonitorFiles=
+    # Status of transformations for which to monitor Files
+    UpdateFilesStatus=Active,Completing,Stopped
+
+    # Give this option a value if the agent should check Reserved tasks
+    CheckReserved=
+    # Status of transformations for which to check reserved tasks
+    CheckReservedStatus= Active,Completing,Stopped
+
+  }
+
+* The options *SubmitTasks*, *MonitorTasks*, *MonitorFiles*, and *CheckReserved*
+  need to be assigned any non-empty value to be activated
+
+* .. versionadded:: v6r21
+
+   It is possible to run the RequestTaskAgent without a *shifterProxy* or
+   *ShifterCredentials*, in this case the credentials of the authors of the
+   transformations are used to submit the jobs to the RMS. This enables the use of
+   a single RequestTaskAgent for multiple VOs. See also the section about the
+   :ref:`trans-multi-vo`.
 
 """