diff --git a/docs/checks-examples.md b/docs/checks-examples.md index de12c6eac..5f41d1a5a 100644 --- a/docs/checks-examples.md +++ b/docs/checks-examples.md @@ -72,30 +72,22 @@ https://static.example.com/logo.png ### Checks Settings -The default behavior is to wait for 5 seconds before running the first check, and timeout each check to 30 seconds. +The default behavior is to wait for `5` seconds before running the checks, to timeout the checks after `30` seconds, and to attempt the checks `5` times. If the checks fail `5` times, the deployment is considered failed and the old container will continue serving traffic. -By default, checks will be attempted 5 times. (Retried 4 times) - -You can change these by setting `WAIT`, `TIMEOUT` and `ATTEMPTS` to different values, for -example: +You can change the default behavior by setting `WAIT`, `TIMEOUT`, and `ATTEMPTS` to different values in the `CHECKS` file. For example: ``` WAIT=30 # Wait 1/2 minute TIMEOUT=60 # Timeout after a minute -ATTEMPTS=10 # attempt checks 10 times +ATTEMPTS=10 # Attempt checks 10 times / My Amazing App ``` -Dokku will wait `5` seconds before running the checks to give the server time to start. This value can be overridden on a per-app basis in the `CHECKS` file by setting `WAIT=nn`. You may also override this for the global dokku installation: +You may also override the default `WAIT` and `ATTEMPTS` variables for the global dokku installation: ```shell dokku config:set --global DOKKU_CHECKS_WAIT=15 -``` - -Dokku will retry the checks `5` times until the checks are successful. If all 5 checks fail, the deployment is considered failed. This can be overridden in the `CHECKS` file by setting `ATTEMPTS=nn`. This number is also configurable globally: - -```shell dokku config:set --global DOKKU_CHECKS_ATTEMPTS=2 ```