Skip to content

Commit

Permalink
docs: fixup example of readiness check (#17296)
Browse files Browse the repository at this point in the history
A "readiness" check implies a failing healthcheck will not cause the
deployment of a service to stop - i.e. it is only used as a liveness
probe in the context of service discoverability.

Fix our docs example to reflect that a readiness check is created by
setting on_update to "ignore" (as opposed to "ignore_warnings").
  • Loading branch information
shoenig authored May 23, 2023
1 parent 881083e commit 9ff1d92
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion website/content/docs/job-specification/check.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ service {
path = "/leader"
interval = "10s"
timeout = "2s"
on_update = "ignore_warnings"
on_update = "ignore"
}
}
```
Expand Down

0 comments on commit 9ff1d92

Please sign in to comment.