cri-o/docs/kpod-pull.1.md
umohnani8 412b98be26 Add 'kpod load' command
Signed-off-by: umohnani8 <umohnani@redhat.com>
2017-07-28 22:30:48 -04:00

2.7 KiB

% 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

DESTINATION

The DESTINATION is a location to store container images The Image "DESTINATION" uses a "transport":"details" format.

Multiple transports are supported:

atomic:hostname/namespace/stream:tag An image served by an OpenShift(Atomic) Registry server. The current OpenShift project and OpenShift Registry instance are by default read from $HOME/.kube/config, which is set e.g. using (oc login).

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 $HOME/.docker/config.json, which is set e.g. 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: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] [GLOBAL OPTIONS]

GLOBAL OPTIONS

--help, -h Print usage statement

SEE ALSO

kpod(1), crio(8), crio.conf(5)

HISTORY

July 2017, Originally compiled by Urvashi Mohnani umohnani@redhat.com