From 9ac58fd78e4f04f3807f18020124882ad68e3ffb Mon Sep 17 00:00:00 2001 From: Qi Wang Date: Thu, 19 Mar 2020 14:37:58 -0400 Subject: Use creds form PullImage remote fix #5511 Adds creds argument to PullImage API and Enables podman-remote to pull image with --creds Signed-off-by: Qi Wang --- API.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) (limited to 'API.md') diff --git a/API.md b/API.md index 2460de09f..e1255ebd9 100644 --- a/API.md +++ b/API.md @@ -141,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) @@ -197,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) @@ -1027,7 +1029,7 @@ method Ps(opts: [PsOpts](#PsOpts)) [PsContainer](#PsContainer) ### func PullImage
-method PullImage(name: [string](https://godoc.org/builtin#string)) [MoreResponse](#MoreResponse)
+method PullImage(name: [string](https://godoc.org/builtin#string), creds: [AuthConfig](#AuthConfig)) [MoreResponse](#MoreResponse) 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. @@ -1283,6 +1285,13 @@ 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 +### type AuthConfig + + + +username [string](https://godoc.org/builtin#string) + +password [string](https://godoc.org/builtin#string) ### type BuildInfo BuildInfo is used to describe user input for building images -- cgit v1.2.3-54-g00ecf