diff options
Diffstat (limited to 'API.md')
| -rw-r--r-- | API.md | 43 |
1 files changed, 41 insertions, 2 deletions
@@ -95,6 +95,8 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in [func ImageSave(options: ImageSaveOptions) MoreResponse](#ImageSave) +[func ImageTree(name: string, whatRequires: bool) string](#ImageTree) + [func ImagesPrune(all: bool, filter: []string) []string](#ImagesPrune) [func ImportImage(source: string, reference: string, message: string, changes: []string, delete: bool) string](#ImportImage) @@ -139,7 +141,7 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in [func Ps(opts: PsOpts) PsContainer](#Ps) -[func PullImage(name: string) MoreResponse](#PullImage) +[func PullImage(name: string, creds: AuthConfig) MoreResponse](#PullImage) [func PushImage(name: string, tag: string, compress: bool, format: string, removeSignatures: bool, signBy: string) MoreResponse](#PushImage) @@ -195,6 +197,8 @@ in the [API.md](https://github.com/containers/libpod/blob/master/API.md) file in [func WaitContainer(name: string, interval: int) int](#WaitContainer) +[type AuthConfig](#AuthConfig) + [type BuildInfo](#BuildInfo) [type BuildOptions](#BuildOptions) @@ -775,6 +779,18 @@ $ varlink call -m unix:/run/podman/io.podman/io.podman.ImageExists '{"name": "im method ImageSave(options: [ImageSaveOptions](#ImageSaveOptions)) [MoreResponse](#MoreResponse)</div> ImageSave allows you to save an image from the local image storage to a tarball +### <a name="ImageTree"></a>func ImageTree +<div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> + +method ImageTree(name: [string](https://godoc.org/builtin#string), whatRequires: [bool](https://godoc.org/builtin#bool)) [string](https://godoc.org/builtin#string)</div> +ImageTree returns the image tree for the provided image name or ID +#### Example +~~~ +$ varlink call -m unix:/run/podman/io.podman/io.podman.ImageTree '{"name": "alpine"}' +{ + "tree": "Image ID: e7d92cdc71fe\nTags: [docker.io/library/alpine:latest]\nSize: 5.861MB\nImage Layers\nāāā ID: 5216338b40a7 Size: 5.857MB Top Layer of: [docker.io/library/alpine:latest]\n" +} +~~~ ### <a name="ImagesPrune"></a>func ImagesPrune <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> @@ -1013,7 +1029,7 @@ method Ps(opts: [PsOpts](#PsOpts)) [PsContainer](#PsContainer)</div> ### <a name="PullImage"></a>func PullImage <div style="background-color: #E8E8E8; padding: 15px; margin: 10px; border-radius: 10px;"> -method PullImage(name: [string](https://godoc.org/builtin#string)) [MoreResponse](#MoreResponse)</div> +method PullImage(name: [string](https://godoc.org/builtin#string), creds: [AuthConfig](#AuthConfig)) [MoreResponse](#MoreResponse)</div> PullImage pulls an image from a repository to local storage. After a successful pull, the image id and logs are returned as a [MoreResponse](#MoreResponse). This connection also will handle a WantsMores request to send status as it occurs. @@ -1269,10 +1285,21 @@ WaitContainer takes the name or ID of a container and waits the given interval i stops. Upon stopping, the return code of the container is returned. If the container container cannot be found by ID or name, a [ContainerNotFound](#ContainerNotFound) error is returned. ## Types +### <a name="AuthConfig"></a>type AuthConfig + + + +username [string](https://godoc.org/builtin#string) + +password [string](https://godoc.org/builtin#string) ### <a name="BuildInfo"></a>type BuildInfo BuildInfo is used to describe user input for building images +architecture [string](https://godoc.org/builtin#string) + +addCapabilities [[]string](#[]string) + additionalTags [[]string](#[]string) annotations [[]string](#[]string) @@ -1291,8 +1318,12 @@ contextDir [string](https://godoc.org/builtin#string) defaultsMountFilePath [string](https://godoc.org/builtin#string) +devices [[]string](#[]string) + dockerfiles [[]string](#[]string) +dropCapabilities [[]string](#[]string) + err [string](https://godoc.org/builtin#string) forceRmIntermediateCtrs [bool](https://godoc.org/builtin#bool) @@ -1305,6 +1336,8 @@ layers [bool](https://godoc.org/builtin#bool) nocache [bool](https://godoc.org/builtin#bool) +os [string](https://godoc.org/builtin#string) + out [string](https://godoc.org/builtin#string) output [string](https://godoc.org/builtin#string) @@ -1321,7 +1354,13 @@ reportWriter [string](https://godoc.org/builtin#string) runtimeArgs [[]string](#[]string) +signBy [string](https://godoc.org/builtin#string) + squash [bool](https://godoc.org/builtin#bool) + +target [string](https://godoc.org/builtin#string) + +transientMounts [[]string](#[]string) ### <a name="BuildOptions"></a>type BuildOptions BuildOptions are are used to describe describe physical attributes of the build |