opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-08-06 03:19:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

Document the required varlink build args

Browse Source 
The API document incorrectly documented the wrong varlink build
arguments.  The output attribute is required.

Fixes: #3204

Signed-off-by: baude <bbaude@redhat.com>
This commit is contained in:
baude
2019-09-23 15:59:42 -05:00
parent 6ce8d05a5b
commit e9421479d1
2 changed files with 72 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
API.md
View File

@ -304,8 +304,43 @@ method AttachControl(name: [string](https://godoc.org/builtin#string)) </div>
method BuildImage(build: [BuildInfo](#BuildInfo)) [MoreResponse](#MoreResponse)</div>
BuildImage takes a [BuildInfo](#BuildInfo) structure and builds an image. At a minimum, you must provide the
'dockerfile' and 'tags' options in the BuildInfo structure. It will return a [MoreResponse](#MoreResponse) structure
contextDir tarball path, the 'dockerfiles' path, and 'output' option in the BuildInfo structure. The 'output'
options is the name of the of the resulting build. It will return a [MoreResponse](#MoreResponse) structure
that contains the build logs and resulting image ID.
#### Example
~~~
$ sudo varlink call -m unix:///run/podman/io.podman/io.podman.BuildImage '{"build":{"contextDir":"/tmp/t/context.tar","dockerfiles":["Dockerfile"], "output":"foobar"}}'
{
"image": {
"id": "",
"logs": [
"STEP 1: FROM alpine\n"
]
}
}
{
"image": {
"id": "",
"logs": [
"STEP 2: COMMIT foobar\n"
]
}
}
{
"image": {
"id": "",
"logs": [
"b7b28af77ffec6054d13378df4fdf02725830086c7444d9c278af25312aa39b9\n"
]
}
}
{
"image": {
"id": "b7b28af77ffec6054d13378df4fdf02725830086c7444d9c278af25312aa39b9",
"logs": []
}
}
~~~
### <a name="BuildImageHierarchyMap"></a>func BuildImageHierarchyMap
<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;">