From ab39d028ce1ac292b4e7dbc48ffdd70b86ee023f Mon Sep 17 00:00:00 2001 From: Preetha Appan Date: Tue, 27 Mar 2018 14:09:04 -0500 Subject: [PATCH] more review feedback --- website/source/api/json-jobs.html.md | 12 +++++------- .../source/docs/job-specification/reschedule.html.md | 9 ++++----- 2 files changed, 9 insertions(+), 12 deletions(-) diff --git a/website/source/api/json-jobs.html.md b/website/source/api/json-jobs.html.md index 3ab50703c..40dfadbe9 100644 --- a/website/source/api/json-jobs.html.md +++ b/website/source/api/json-jobs.html.md @@ -530,18 +530,16 @@ The `ReschedulePolicy` object supports the following keys: - `Delay` - A duration to wait before attempting rescheduling. It is specified in nanoseconds. -- `DelayFunction` - Defines how the delay between subsequent reschedule attempts - changes. This is to allow a progressively increasing backoff period. Allowed values - for `DelayFunction` are listed below: - - `linear` - The delay between reschedule attempts stays at the `Delay` value defined above. - - `exponential` - The delay between reschedule attempts doubles until it reaches a specified - `MaxDelay` value. +- `DelayFunction` - Specifies the function that is used to calculate subsequent reschedule delays. + The initial delay is specified by the `Delay` parameter. Allowed values for `DelayFunction` are listed below: + - `constant` - The delay between reschedule attempts stays at the `Delay` value. + - `exponential` - The delay between reschedule attempts doubles. - `fibonacci` - The delay between reschedule attempts is calculated by adding the two most recent delays applied. For example if `Delay` is set to 5 seconds, the next five reschedule attempts will be delayed by 5 seconds, 5 seconds, 10 seconds, 15 seconds, and 25 seconds respectively. - `MaxDelay` - `MaxDelay` is an upper bound on the delay beyond which it will not increase. This parameter is used when - `DelayFunction` is `exponential` or `fibonacci`, and is ignored when `linear` delay is used. + `DelayFunction` is `exponential` or `fibonacci`, and is ignored when `constant` delay is used. - `Unlimited` - `Unlimited` enables unlimited reschedule attempts. If this is set to true the `Attempts` and `Interval` fields are not used. diff --git a/website/source/docs/job-specification/reschedule.html.md b/website/source/docs/job-specification/reschedule.html.md index 2ece2bea9..ac0cb2757 100644 --- a/website/source/docs/job-specification/reschedule.html.md +++ b/website/source/docs/job-specification/reschedule.html.md @@ -64,12 +64,11 @@ job "docs" { - `delay` `(string: )` - Specifies the duration to wait before attempting to reschedule a failed task. This is specified using a label suffix like "30s" or "1h". -- `delay_function` `(string: )` - Specifies the function according to which - the initial delay specified in `delay` changes. `delay_function` has three possible - values which are described below. +- `delay_function` `(string: )` - Specifies the function that is used to + calculate subsequent reschedule delays. The initial delay is specified by the delay parameter. + `delay_function` has three possible values which are described below. - `constant` - The delay between reschedule attempts stays constant at the `delay` value. - - `exponential` - The delay between reschedule attempts doubles until it reaches a specified - `max_delay` value. + - `exponential` - The delay between reschedule attempts doubles. - `fibonacci` - The delay between reschedule attempts is calculated by adding the two most recent delays applied. For example if `delay` is set to 5 seconds, the next five reschedule attempts will be delayed by 5 seconds, 5 seconds, 10 seconds, 15 seconds, and 25 seconds respectively.