cri-o/docs/kpod-push.1.md
Ryan Cole 680f7a6106 Add kpod push command
Push an image to a specified location, such as to an atomic registry
or a local directory

Signed-off-by: Ryan Cole <rcyoalne@gmail.com>
2017-07-20 11:12:40 -04:00

3.5 KiB

kpod-push "1" "June 2017" "kpod"

NAME

kpod push - Push an image from local storage to elsewhere.

SYNOPSIS

kpod push [options [...]] imageID [destination]

DESCRIPTION

Pushes an image from local storage to a specified destination, decompressing and recompessing layers as needed.

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.

OPTIONS

--creds="CREDENTIALS"

Credentials (USERNAME:PASSWORD) to use for authenticating to a registry

cert-dir="PATHNAME"

Pathname of a directory containing TLS certificates and keys

--disable-compression, -D

Don't compress copies of filesystem layers which will be pushed

--quiet, -q

When writing the output image, suppress progress output

--remove-signatures

Discard any pre-existing signatures in the image

--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

--sign-by="KEY"

Add a signature at the destination using the specified key

--tls-verify

Require HTTPS and verify certificates when contacting registries (default: true)

EXAMPLE

This example extracts the imageID image to a local directory in docker format.

# kpod push imageID dir:/path/to/image

This example extracts the imageID image to a local directory in oci format.

# kpod push imageID oci:/path/to/layout

This example extracts the imageID image to a container registry named registry.example.com

# kpod push imageID docker://registry.example.com/repository:tag

This example extracts the imageID image and puts into the local docker container store

# kpod push imageID docker-daemon:image:tag

This example extracts the imageID image and pushes it to an OpenShift(Atomic) registry

# kpod push imageID atomic:registry.example.com/company/image:tag

SEE ALSO

kpod(1)