Skip to content

Documentation for pre-start timeout #148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dlresende merged 2 commits into from
Sep 25, 2020
Merged

Documentation for pre-start timeout #148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5eeb9f0
Documentation for pre-start timeout
krutten Aug 21, 2020
1e8aed2
Update docs pr
mrosecrance Sep 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/config.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ directory of your job.

#### `hooks` Schema

| **Property** | **Type** | **Required** | **Description** |
|--------------|----------|--------------|---------------------------------------------------------------------------------------|
| `pre_start` | string | No | The path to an executable to run before starting the main executable of this process. |
| **Property** | **Type** | **Required** | **Description** |
|--------------|----------|--------------|-----------------------------------------------------------------------------------------------------------------------|
| `pre_start` | string | No | The path to an executable to run before starting the main executable of this process. Should not exceed 30 seconds |

#### `limits` Schema

Expand Down
16 changes: 14 additions & 2 deletions docs/runtime.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,10 @@ us know so that we can be explicit about the interface and guarantees provided.

## Lifecycle

Your process is started and has an unlimited amount of time to start up. You
should use a [post-start script][post-start] and a health check if you want
Your process is started and has an unlimited amount of time to start up. If
present, a bpm [pre-start script][pre-start] can run before your process' pre-start and start. Bpm's
[pre-start script][pre-start] must complete in within 30 seconds to avoid a monit timeout. A job's [pre-start][pre-start]
script is not bound by this timeout. You should use a [post-start script][post-start] and a health check if you want
your job to only say it has completed deploying after it has started up. You do
not need to manage any PID files yourself.

Expand All @@ -22,6 +24,7 @@ can shutdown within 15 seconds. It is acceptable and supported to terminate
your process while running the drain script. However, if you do terminate the
process then you should also delete the PID file.

[pre-start]:https://bosh.io/docs/pre-start.html
[post-start]:https://bosh.io/docs/post-start.html
[drain]:https://bosh.io/docs/drain.html

Expand Down Expand Up @@ -161,3 +164,12 @@ conditions. It is completely safe (from a correctness perspective, you may
still break your service) to run `monit restart` on a job which uses bpm.

[monit-mail]: https://lists.nongnu.org/archive/html/monit-general/2012-09/msg00103.html

### Execution Failed

In some cases Monit reports the process as execution failed when the process is actually healthy.
There is a [known][execution-failed] race condition that can occur in certain unavoidable circumstances.
This same failure will also appear if bpm's [pre-start script][pre-start] exceeds monit's timeout when executing.
It is recommended to move time consuming logic from bpm's pre-start to the job's pre-start script.

[execution-failed]:https://community.pivotal.io/s/article/Deployment-fails-because-monit-reports-job-as-failed?language=en_US