diff options
author | Daniel J Walsh <dwalsh@redhat.com> | 2017-12-15 16:58:36 -0500 |
---|---|---|
committer | Atomic Bot <atomic-devel@projectatomic.io> | 2017-12-18 16:46:05 +0000 |
commit | 5770dc2640c216525ab84031e3712fcc46b3b087 (patch) | |
tree | 8a1c5c4e4a6ce6a35a3767247623a62bfd698f77 /docs/kpod-pull.1.md | |
parent | de3468e120d489d046c08dad72ba2262e222ccb1 (diff) | |
download | podman-5770dc2640c216525ab84031e3712fcc46b3b087.tar.gz podman-5770dc2640c216525ab84031e3712fcc46b3b087.tar.bz2 podman-5770dc2640c216525ab84031e3712fcc46b3b087.zip |
Rename all references to kpod to podman
The decision is in, kpod is going to be named podman.
Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Closes: #145
Approved by: umohnani8
Diffstat (limited to 'docs/kpod-pull.1.md')
-rw-r--r-- | docs/kpod-pull.1.md | 136 |
1 files changed, 0 insertions, 136 deletions
diff --git a/docs/kpod-pull.1.md b/docs/kpod-pull.1.md deleted file mode 100644 index f9933b6c6..000000000 --- a/docs/kpod-pull.1.md +++ /dev/null @@ -1,136 +0,0 @@ -% kpod(1) kpod-pull - Simple tool to pull an image from a registry -% Urvashi Mohnani -# kpod-pull "1" "July 2017" "kpod" - -## NAME -kpod-pull - Pull an image from a registry - -## SYNOPSIS -**kpod pull** -**NAME[:TAG|@DIGEST]** -[**--help**|**-h**] - -## DESCRIPTION -Copies an image from a registry onto the local machine. **kpod pull** pulls an -image from Docker Hub if a registry is not specified in the command line argument. -If an image tag is not specified, **kpod pull** defaults to the image with the -**latest** tag (if it exists) and pulls it. **kpod pull** can also pull an image -using its digest **kpod pull [image]@[digest]**. **kpod pull** can be used to pull -images from archives and local storage using different transports. - -## imageID -Image stored in local container/storage - -## SOURCE - - The SOURCE is a location to get container images - The Image "SOURCE" uses a "transport":"details" format. - - Multiple transports are supported: - - **dir:**_path_ - An existing local directory _path_ storing the manifest, layer tarballs and signatures as individual files. This is a non-standardized format, primarily useful for debugging or noninvasive container inspection. - - **docker://**_docker-reference_ - An image in a registry implementing the "Docker Registry HTTP API V2". By default, uses the authorization state in `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using `(kpod login)`. If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using `(docker login)`. - - **docker-archive:**_path_[**:**_docker-reference_] - An image is stored in the `docker save` formatted file. _docker-reference_ is only used when creating such a file, and it must not contain a digest. - - **docker-daemon:**_docker-reference_ - An image _docker-reference_ stored in the docker daemon internal storage. _docker-reference_ must contain either a tag or a digest. Alternatively, when reading images, the format can also be docker-daemon:algo:digest (an image ID). - - **oci-archive:**_path_**:**_tag_ - An image _tag_ in a directory compliant with "Open Container Image Layout Specification" at _path_. - - **ostree:**_image_[**@**_/absolute/repo/path_] - An image in local OSTree repository. _/absolute/repo/path_ defaults to _/ostree/repo_. - -**kpod [GLOBAL OPTIONS]** - -**kpod pull [GLOBAL OPTIONS]** - -**kpod pull NAME[:TAG|@DIGEST]** - -## OPTIONS - -**--authfile** - -Path of the authentication file. Default is ${XDG_RUNTIME\_DIR}/containers/auth.json, which is set using `kpod login`. -If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. - -**--cert-dir** - -Pathname of a directory containing TLS certificates and keys - -**--creds** - -Credentials (USERNAME:PASSWORD) to use for authenticating to a registry - -**--quiet, -q** - -Suppress output information when pulling images - -**--signature-policy="PATHNAME"** - -Pathname of a signature policy file to use. It is not recommended that this -option be used, as the default behavior of using the system-wide default policy -(frequently */etc/containers/policy.json*) is most often preferred - -**--tls-verify** - -Require HTTPS and verify certificates when contacting registries (default: true) - -## EXAMPLES - -``` -# kpod pull --signature-policy /etc/containers/policy.json alpine:latest -Trying to pull registry.access.redhat.com/alpine:latest... Failed -Trying to pull registry.fedoraproject.org/alpine:latest... Failed -Trying to pull docker.io/library/alpine:latest...Getting image source signatures -Copying blob sha256:88286f41530e93dffd4b964e1db22ce4939fffa4a4c665dab8591fbab03d4926 - 1.90 MB / 1.90 MB [========================================================] 0s -Copying config sha256:76da55c8019d7a47c347c0dceb7a6591144d232a7dd616242a367b8bed18ecbc - 1.48 KB / 1.48 KB [========================================================] 0s -Writing manifest to image destination -Storing signatures -``` - -``` -# kpod pull --authfile temp-auths/myauths.json docker://docker.io/umohnani/finaltest -Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures -Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913 - 1.90 MB / 1.90 MB [========================================================] 0s -Copying config sha256:ad4686094d8f0186ec8249fc4917b71faa2c1030d7b5a025c29f26e19d95c156 - 1.41 KB / 1.41 KB [========================================================] 0s -Writing manifest to image destination -Storing signatures -``` - -``` -# kpod pull --creds testuser:testpassword docker.io/umohnani/finaltest -Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures -Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913 - 1.90 MB / 1.90 MB [========================================================] 0s -Copying config sha256:ad4686094d8f0186ec8249fc4917b71faa2c1030d7b5a025c29f26e19d95c156 - 1.41 KB / 1.41 KB [========================================================] 0s -Writing manifest to image destination -Storing signatures -``` - -``` -# kpod pull --tls-verify=false --cert-dir image/certs docker.io/umohnani/finaltest -Trying to pull docker.io/umohnani/finaltest:latest...Getting image source signatures -Copying blob sha256:6d987f6f42797d81a318c40d442369ba3dc124883a0964d40b0c8f4f7561d913 - 1.90 MB / 1.90 MB [========================================================] 0s -Copying config sha256:ad4686094d8f0186ec8249fc4917b71faa2c1030d7b5a025c29f26e19d95c156 - 1.41 KB / 1.41 KB [========================================================] 0s -Writing manifest to image destination -Storing signatures -``` - -## SEE ALSO -kpod(1), kpod-push(1), crio(8), crio.conf(5), docker-login(1) - -## HISTORY -July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com> |