Add hover and test for docker-image PutParams
This commit is contained in:
@@ -0,0 +1 @@
|
||||
*Optional.* The path of a directory containing a `Dockerfile` to build.
|
||||
@@ -0,0 +1,10 @@
|
||||
*Optional.* A map of Docker build arguments.
|
||||
|
||||
Example:
|
||||
|
||||
```yaml
|
||||
build_args:
|
||||
do_thing: true
|
||||
how_many_things: 2
|
||||
email: me@yopmail.com
|
||||
```
|
||||
@@ -0,0 +1,8 @@
|
||||
Optional.* Path to a JSON file containing Docker build
|
||||
arguments.
|
||||
|
||||
Example file contents:
|
||||
|
||||
```yaml
|
||||
{ "email": "me@yopmail.com", "how_many_things": 1, "do_thing": false }
|
||||
```
|
||||
@@ -0,0 +1,10 @@
|
||||
*Optional.* Default `false`. When the `build` parameter is set,
|
||||
first pull `image:tag` from the Docker registry (so as to use cached
|
||||
intermediate images when building). This will cause the resource to fail
|
||||
if it is set to `true` and the image does not exist yet.
|
||||
Note: Since docker 1.10 docker images [do not contain all necessary metadata to
|
||||
restore the build cache](https://github.com/docker/docker/issues/20316).
|
||||
Additional metadata needs to be saved and re-applied after a docker pull to have
|
||||
subsequent builds skip identical intermediate layers. This additional
|
||||
metadata is stored as a very small separate image (`image:${cache_tag}-buildcache`)
|
||||
in the repository of this resource.
|
||||
@@ -0,0 +1,5 @@
|
||||
*Optional.* Default `tag`. The specific tag to pull before
|
||||
building when `cache` parameter is set. Instead of pulling the same tag
|
||||
that's going to be built, this allows picking a different tag like
|
||||
`latest` or the previous version. This will cause the resource to fail
|
||||
if it is set to a tag that does not exist yet.
|
||||
@@ -0,0 +1,2 @@
|
||||
*Optional.* The path of the `Dockerfile` in the directory if
|
||||
it's not at the root of the directory.
|
||||
@@ -0,0 +1 @@
|
||||
*Optional.* A path to a file to `docker import` and then push.
|
||||
@@ -0,0 +1,2 @@
|
||||
*Optional.* The path of a directory containing an image that was
|
||||
fetched using this same resource with `save: true`.
|
||||
@@ -0,0 +1,3 @@
|
||||
*Optional.* A path to a directory containing an image to `docker load`
|
||||
before running `docker build`. The directory must have `image`,
|
||||
`image-id`, `repository`, and `tag` present, i.e. the tree produced by `/in`.
|
||||
@@ -0,0 +1,2 @@
|
||||
*Optional.* A path to a file to `docker load` and then push.
|
||||
Requires `load_repository`.
|
||||
@@ -0,0 +1 @@
|
||||
*Optional.* The repository of the image loaded from `load_file`.
|
||||
@@ -0,0 +1 @@
|
||||
*Optional.* Default `latest`. The tag of image loaded from `load_file`.
|
||||
@@ -0,0 +1,2 @@
|
||||
*Optional.* **DEPRECATED. Use `get` and `load` instead.** A
|
||||
path to a repository to pull down, and then push to this resource.
|
||||
@@ -0,0 +1,2 @@
|
||||
*Optional.* **DEPRECATED. Use `get` and `load` instead.** Default
|
||||
`latest`. The tag of the repository to pull down via `pull_repository`.
|
||||
@@ -0,0 +1,2 @@
|
||||
*Optional.* The value should be a path to a file containing the name
|
||||
of the tag.
|
||||
@@ -0,0 +1,2 @@
|
||||
*Optional.* Default `false`. If true, the pushed image will
|
||||
be tagged as `latest` in addition to whatever other tag was specified.
|
||||
@@ -0,0 +1,3 @@
|
||||
*Optional.* If specified, the tag read from the file will be
|
||||
prepended with this string. This is useful for adding `v` in front of version
|
||||
numbers.
|
||||
Reference in New Issue
Block a user