diff options
| author | Qi Wang <qiwan@redhat.com> | 2020-03-19 14:37:58 -0400 |
|---|---|---|
| committer | Qi Wang <qiwan@redhat.com> | 2020-03-19 14:38:12 -0400 |
| commit | 9ac58fd78e4f04f3807f18020124882ad68e3ffb (patch) | |
| tree | 503c17531b38724992645c7e6b2712390ef52329 /API.md | |
| parent | 173f430852e52a1acf69b4d9d18da20893031a79 (diff) | |
| download | podman-9ac58fd78e4f04f3807f18020124882ad68e3ffb.tar.gz podman-9ac58fd78e4f04f3807f18020124882ad68e3ffb.tar.bz2 podman-9ac58fd78e4f04f3807f18020124882ad68e3ffb.zip | |
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 <qiwan@redhat.com>
Diffstat (limited to 'API.md')
| -rw-r--r-- | API.md | 13 |
1 files changed, 11 insertions, 2 deletions
@@ -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)</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. @@ -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 +### <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 |