Add note about required docker config options

This commit is contained in:
Brian Cain 2018-09-19 10:38:40 -07:00
parent 166fe374b6
commit aecfc45eab
No known key found for this signature in database
GPG Key ID: 43D51080D357A001
1 changed files with 4 additions and 2 deletions

View File

@ -14,14 +14,16 @@ you may set. A complete reference is shown below.
### Required
One of the following settings is required when using the Docker provider:
* `build_dir` (string) - The path to a directory containing a Dockerfile.
One of this, `image` or `git_repo` is required.
* `image` (string) - The image to launch, specified by the image ID or a name
such as `ubuntu:12.04`. One of this, `git_repo` or `build_dir` is required.
* `git_repo` (string) - The URL of a git repository to build the image from.
Supports pulling specific tags, branches and revision, consult the
Supports pulling specific tags, branches and revision, consult the
[docker documenation](https://docs.docker.com/engine/reference/commandline/build/#/git-repositories)
for more information. One of this, `image` or `build_dir` is required.