Add note about pre-create check and exit code

Signed-off-by: Nathan LeClaire <nathan.leclaire@gmail.com>
This commit is contained in:
Nathan LeClaire 2016-01-12 11:53:07 -08:00 committed by David Gageot
parent b589eb9475
commit c4e798cafd
1 changed files with 12 additions and 0 deletions

View File

@ -224,3 +224,15 @@ Example create:
This will set the swarm scheduling strategy to "binpack" (pack in containers as
tightly as possible per host instead of spreading them out), and the "heartbeat"
interval to 5 seconds.
## Pre-create check
Since many drivers require a certain set of conditions to be in place before
they can successfully perform a create (e.g. VirtualBox should be installed, or
the provided API credentials should be valid), Docker Machine has a "pre-create
check" which is specified at the driver level.
If this pre-create check succeeds, Docker Machine will proceed with the creation
as normal. If the pre-create check fails, the Docker Machine process will exit
with status code 3 to indicate that the source of the non-zero exit was the
pre-create check failing.