github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Checks doc: minor copy edits to use a consistent voice and sentence structure

Browse Source
This commit is contained in:
Trevor Turk
2016-03-03 12:46:03 -06:00
parent b8c264f173
commit 2acd2c294a
1 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
docs/checks-examples.md
View File

@@ -6,7 +6,7 @@ checks:disable <app>
checks:enable <app> Enable zero-downtime checks checks:enable <app> Enable zero-downtime checks
``` ```
Following a deploy, dokku will now wait `10` seconds before routing traffic to the new container. If the container is not running after this time, then the deploy is failed and your old container will continue serving traffic. You can modify this value globally or on a per-application basis: Following a deploy, dokku will wait `10` seconds before routing traffic to the new container to give your application time to boot up. If the application is not running after this time, then the deploy is failed and your old container will continue serving traffic. You can modify this value globally or on a per-application basis:
```shell ```shell
dokku config:set --global DOKKU_DEFAULT_CHECKS_WAIT=30 dokku config:set --global DOKKU_DEFAULT_CHECKS_WAIT=30
@@ -34,20 +34,20 @@ If your application needs a longer period to boot up - perhaps to load data into
To specify checks, add a `CHECKS` file to the root of your project directory. The `CHECKS` file should be plain text and may contain: To specify checks, add a `CHECKS` file to the root of your project directory. The `CHECKS` file should be plain text and may contain:
* empty lines * Check instructions
* comments (lines starting with #) * Settings (NAME=VALUE)
* settings (NAME=VALUE) * Comments (lines starting with #)
* check instructions * Empty lines
### Checks Instructions ### Check Instructions
The format of a check instruction is a path or relative URL, optionally followed by the expected content. For example: The format of a check instruction is a path or relative URL, optionally followed by the expected content:
``` ```
/about Our Amazing Team /about Our Amazing Team
``` ```
The `CHECKS` file can contain multiple checks, for example: The `CHECKS` file can contain multiple checks:
``` ```
/ My Amazing App / My Amazing App
@@ -56,25 +56,25 @@ The `CHECKS` file can contain multiple checks, for example:
/images/logo.png /images/logo.png
``` ```
To check an application that supports multiple hostnames, use relative URLs that include the hostname, for example: To check an application that supports multiple hostnames, use relative URLs that include the hostname:
``` ```
//admin.example.com Admin Dashboard //admin.example.com Admin Dashboard
//static.example.com/logo.png //static.example.com/logo.png
``` ```
You can also specify the protocol to explicitly check HTTPS requests. You can also specify the protocol to explicitly check HTTPS requests:
``` ```
https://admin.example.com Admin Dashboard https://admin.example.com Admin Dashboard
https://static.example.com/logo.png https://static.example.com/logo.png
``` ```
### Checks Settings ### Check Settings
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. 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.
You can change the default behavior by setting `WAIT`, `TIMEOUT`, and `ATTEMPTS` to different values in the `CHECKS` file. For example: You can change the default behavior by setting `WAIT`, `TIMEOUT`, and `ATTEMPTS` to different values in the `CHECKS` file:
``` ```
WAIT=30 # Wait 1/2 minute WAIT=30 # Wait 1/2 minute
@@ -84,14 +84,14 @@ ATTEMPTS=10 # Attempt checks 10 times
/ My Amazing App / My Amazing App
``` ```
You may also override the default `WAIT` and `ATTEMPTS` variables for the global dokku installation: You can also override the default `WAIT` and `ATTEMPTS` variables for the global dokku installation:
```shell ```shell
dokku config:set --global DOKKU_CHECKS_WAIT=15 dokku config:set --global DOKKU_CHECKS_WAIT=30
dokku config:set --global DOKKU_CHECKS_ATTEMPTS=2 dokku config:set --global DOKKU_CHECKS_ATTEMPTS=10
``` ```
If your application runs multiple processes (a background worker configured in a `Procfile`, for example) you may want to disable the default check wait time for that application to avoid the `10` second default delay per process: If your application runs multiple processes (a background worker configured in your `Procfile`, for example) and you have checks to ensure that your web application has booted up, you may want to disable the default check wait time for that application to avoid the `10` second wait per non-web process:
```shell ```shell
dokku config:set <app> DOKKU_DEFAULT_CHECKS_WAIT=0 dokku config:set <app> DOKKU_DEFAULT_CHECKS_WAIT=0