diff options
author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2020-03-23 21:22:41 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-03-23 21:22:41 +0100 |
commit | 02de8d576b531430f90ef2ab7a290c7fb59e9f3c (patch) | |
tree | 9d9d8a2c06f2791e83e77673435253a1a21a42e6 /API.md | |
parent | 3e835a8025bfc4a7a2790f1d343c6ea246fc65ee (diff) | |
parent | 9ac58fd78e4f04f3807f18020124882ad68e3ffb (diff) | |
download | podman-02de8d576b531430f90ef2ab7a290c7fb59e9f3c.tar.gz podman-02de8d576b531430f90ef2ab7a290c7fb59e9f3c.tar.bz2 podman-02de8d576b531430f90ef2ab7a290c7fb59e9f3c.zip |
Merge pull request #5560 from QiWang19/remote_ceds
Use creds form PullImage remote
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 |