Update executor retry config docs (#3001)

Signed-off-by: Paolo Di Tommaso <[email protected]>

Author: pditommaso

docs/azure.rst

@@ -382,4 +382,8 @@ azure.batch.pools.<name>.runAs                  Specify the username under which
 azure.registry.server                           Specify the container registry from which to pull the Docker images (default: ``docker.io``, requires ``[email protected]``).
 azure.registry.userName                         Specify the username to connect to a private container registry (requires ``[email protected]``).
 azure.registry.password                         Specify the password to connect to a private container registry (requires ``[email protected]``).
+azure.retryPolicy.delay                         Delay when retrying failed API requests (default: ``500ms``).
+azure.retryPolicy.maxDelay                      Max delay when retrying failed API requests (default: ``60s``).
+azure.retryPolicy.jitter                        Jitter value when retrying failed API requests (default: ``0.25``).
+azure.retryPolicy.maxAttempts                   Max attempts when retrying failed API requests (default: ``10``).
 ============================================== =================

docs/config.rst

@@ -342,24 +342,24 @@ The ``executor`` configuration scope allows you to set the optional executor set
 ===================== =====================
 Name                  Description
 ===================== =====================
-name                  The name of the executor to be used e.g. ``local``, ``sge``, etc.
+name                  The name of the executor to be used (default: ``local``).
 queueSize             The number of tasks the executor will handle in a parallel manner (default: ``100``).
-pollInterval          Determines how often a poll occurs to check for a process termination.
-dumpInterval          Determines how often the executor status is written in the application log file (default: ``5min``).
-queueStatInterval     Determines how often the queue status is fetched from the cluster system. This setting is used only by grid executors (default: ``1min``).
-exitReadTimeout       Determines how long the executor waits before to an error status when a process is terminated but the ``.exitcode`` file does not exist or is empty. This setting is used only by grid executors (default: ``270 sec``).
-killBatchSize         Determines the number of jobs that can be `killed` in a single command execution (default: ``100``).
-submitRateLimit       Determines the max rate of job submission per time unit, for example ``'10sec'`` eg. max 10 jobs per second or ``'50/2min'`` i.e. 50 job submissions every 2 minutes (default: `unlimited`).
+submitRateLimit       Determines the max rate of job submission per time unit, for example ``'10sec'`` (10 jobs per second) or ``'50/2min'`` (50 jobs every 2 minutes) (default: unlimited).
+pollInterval          Determines how often to check for process termination. Default varies for each executor.
+dumpInterval          Determines how often to log the executor status (default: ``5min``).
+queueStatInterval     Determines how often to fetch the queue status from the scheduler (default: ``1min``). Used only by grid executors.
+exitReadTimeout       Determines how long to wait before returning an error status when a process is terminated but the ``.exitcode`` file does not exist or is empty (default: ``270 sec``). Used only by grid executors.
+killBatchSize         Determines the number of jobs that can be killed in a single command execution (default: ``100``).
 perJobMemLimit        Specifies Platform LSF *per-job* memory limit mode. See :ref:`lsf-executor`.
 perTaskReserve        Specifies Platform LSF *per-task* memory reserve mode. See :ref:`lsf-executor`.
-jobName               Determines the name of jobs submitted to the underlying cluster executor e.g. ``executor.jobName = { "$task.name - $task.hash" }`` Note: when using this option you need to make sure the resulting job name matches the validation constraints of the underlying batch scheduler.
-cpus                  The maximum number of CPUs made available by the underlying system (only used by the ``local`` executor).
-memory                The maximum amount of memory made available by the underlying system (only used by the ``local`` executor).
-retry.delay           Delay when re-retying failed submit operations (default: ``500ms``, only used by grid based executors e.g. ``slurm``, requires version ``22.03.0-edge`` or later).
-retry.maxDelay        Max delay when re-retying failed submit operations (default: ``30s``, only used by grid based executors e.g. ``slurm``, requires version ``22.03.0-edge`` or later).
-retry.jitter          Jitter value when re-retying failed submit operations (default: ``0.25``, only used by grid based executors e.g. ``slurm``, requires version ``22.03.0-edge`` or later)
-retry.maxAttempts     Max attempts when re-retying failed submit operations (default: ``3``, only used by grid based executors e.g. ``slurm``, requires version ``22.03.0-edge`` or later)
-retry.reason          Regex pattern that when verified cause a failed submit operation to be re-tried (default: ``Socket timed out``, only used by grid based executors e.g. ``slurm``, requires version ``22.03.0-edge`` or later)
+jobName               Determines the name of jobs submitted to the underlying cluster executor e.g. ``executor.jobName = { "$task.name - $task.hash" }``. Make sure the resulting job name matches the validation constraints of the underlying batch scheduler.
+cpus                  The maximum number of CPUs made available by the underlying system. Used only by the ``local`` executor.
+memory                The maximum amount of memory made available by the underlying system. Used only by the ``local`` executor.
+retry.delay           Delay when retrying failed job submissions (default: ``500ms``). NOTE: used only by grid executors (requires ``22.03.0-edge`` or later).
+retry.maxDelay        Max delay when retrying failed job submissions (default: ``30s``). NOTE: used only by grid executors (requires ``22.03.0-edge`` or later).
+retry.jitter          Jitter value when retrying failed job submissions (default: ``0.25``). NOTE: used only by grid executors (requires ``22.03.0-edge`` or later).
+retry.maxAttempts     Max attempts when retrying failed job submissions (default: ``3``). NOTE: used only by grid executors (requires ``22.03.0-edge`` or later).
+retry.reason          Regex pattern that when verified cause a failed submit operation to be re-tried (default: ``Socket timed out``). NOTE: used only by grid executors (requires ``22.03.0-edge`` or later).
 ===================== =====================
 
 The executor settings can be defined as shown below::