[v6r21] RequestTaskAgent options; installTS tutorial options

TransformationSystem/Agent/RequestTaskAgent.py

@@ -3,50 +3,11 @@
 
 The following options can be set for the RequestTaskAgent.
 
-::
-
-  RequestTaskAgent
-  {
-    # Use a dedicated proxy to submit requests to the RMS
-    shifterProxy=DataManager
-    # Use delegated credentials. Use this instead of the shifterProxy option (New in v6r20p5)
-    ShifterCredentials=
-    # Transformation types to be taken into account by the 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
-    # Task statuses considered transient that should be monitored for updates
-    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
-
-  }
+.. literalinclude:: ../ConfigTemplate.cfg
+  :start-after: ##BEGIN RequestTaskAgent
+  :end-before: ##END
+  :dedent: 2
+  :caption: RequestTaskAgent options
 
 * The options *SubmitTasks*, *MonitorTasks*, *MonitorFiles*, and *CheckReserved*
   need to be assigned any non-empty value to be activated

TransformationSystem/ConfigTemplate.cfg

@@ -22,10 +22,55 @@ Agents
   {
     PollingTime = 120
   }
+  ##BEGIN RequestTaskAgent
   RequestTaskAgent
   {
+    # Use a dedicated proxy to submit requests to the RMS
+    shifterProxy =
+    # Use delegated credentials. Use this instead of the shifterProxy option (New in v6r20p5)
+    ShifterCredentials =
+    # Transformation types to be taken into account by the agent. If the option is empty,
+    # the value is taken from # *Operations/Transformations/DataManipulation*
+    # with a default of "Replication, Removal"
+    TransType =
+    # 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 = yes
+    # 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 update the status of tasks
+    MonitorTasks =
+    # Status of transformations for which to monitor tasks
+    UpdateTasksStatus = Active,Completing,Stopped
+    # Task statuses considered transient that should be monitored for updates
+    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 update the status for 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
+
+    #Time between cycles in seconds
     PollingTime = 120
+
   }
+  ##END
   TransformationAgent
   {
     PollingTime = 120

docs/source/AdministratorGuide/Tutorials/installTS.rst

@@ -29,6 +29,7 @@ More Links
 ==========
 
 * :ref:`adminTS`
+* See the options for services and agents in code documentation of the :mod:`~DIRAC.TransformationSystem`
 
 Installing the TransformationSystem
 ===================================
@@ -67,11 +68,11 @@ The TS is no different than any other DIRAC system. The installation steps are t
   Loading configuration template /home/diracuser/DiracInstallation/DIRAC/TransformationSystem/ConfigTemplate.cfg
   Adding to CS agent Transformation/InputDataAgent
   agent Transformation_InputDataAgent is installed, runit status: Run
-  [dirac-tuto]$ install agent Transformation WorkflowTaskAgent -p PollingTime=30
+  [dirac-tuto]$ install agent Transformation WorkflowTaskAgent -p PollingTime=30 -p MonitorTasks=True -p MonitorFiles=True
   Loading configuration template /home/diracuser/DiracInstallation/DIRAC/TransformationSystem/ConfigTemplate.cfg
   Adding to CS agent Transformation/WorkflowTaskAgent
   agent Transformation_WorkflowTaskAgent is installed, runit status: Run
-  [dirac-tuto]$ install agent Transformation RequestTaskAgent -p PollingTime=30
+  [dirac-tuto]$ install agent Transformation RequestTaskAgent -p PollingTime=30 -p MonitorTasks=True -p MonitorFiles=True
   Loading configuration template /home/diracuser/DiracInstallation/DIRAC/TransformationSystem/ConfigTemplate.cfg
   Adding to CS agent Transformation/RequestTaskAgent
   agent Transformation_RequestTaskAgent is installed, runit status: Run