Add documentation for the jobs failure policy#4676
Conversation
acroca
force-pushed
the
jobs-failure-policy
branch
from
8ffe3db to
17442bc
Compare
| `failure_policy` specifies how the job should handle failures. | ||
|
|
||
| It can be set to `constant` or `drop`. | ||
| - The `constant` policy will retry the job up to `max_retries` times, with a delay of `interval` between retries. |
There was a problem hiding this comment.
Please add that if max_retries is not set, it will retry forever.
| `dueTime` | An optional time at which the job should be active, or the "one shot" time, if other scheduling type fields are not provided. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from creation time), or non-repeating ISO8601. | ||
| `repeats` | An optional number of times in which the job should be triggered. If not set, the job runs indefinitely or until expiration. | ||
| `ttl` | An optional time to live or expiration of the job. Accepts a "point in time" string in the format of RFC3339, Go duration string (calculated from job creation time), or non-repeating ISO8601. | ||
| `failure_policy` | An optional failure policy for the job. Details of the format are below. |
There was a problem hiding this comment.
Add to this line what the default value is when unset.
Please can we add a new table with the full failure_policy API definitions- add what the defaults are when fields are unset.
There was a problem hiding this comment.
Didn't add a table, but different bullet points for the two fields of the constant policy. Do you think this is good enough? I find a table might be confusing given that there are two types of policies, and one of them doesn't have any configuration.
|
@JoshVanL shouldn't this PR target the |
Signed-off-by: Albert Callarisa <albert@diagrid.io>
…n the constant policy Signed-off-by: Albert Callarisa <albert@diagrid.io>
Signed-off-by: Albert Callarisa <albert@diagrid.io>
acroca
force-pushed
the
jobs-failure-policy
branch
from
17751d3 to
461c37f
Compare
alicejgibbons
left a comment
alicejgibbons
left a comment
There was a problem hiding this comment.
LGTM a couple of clarifications
Co-authored-by: Alice Gibbons <alicejgibbons@gmail.com> Signed-off-by: Albert Callarisa <albert@acroca.com>
Signed-off-by: Albert Callarisa <albert@diagrid.io>
4 participants
Thank you for helping make the Dapr documentation better!
Please follow this checklist before submitting:
In addition, please fill out the following to help reviewers understand this pull request:
Description
Document the use of FailurePolicy for jobs. This new field has been introduced in this PR
Issue reference