.nh
.TH buildah-pull "1" "July 2018" "buildah"
.SH NAME
.PP
buildah-pull - Pull an image from a registry.

.SH SYNOPSIS
.PP
\fBbuildah pull\fP [\fIoptions\fP] \fIimage\fP

.SH DESCRIPTION
.PP
Pulls an image based upon the specified input. It supports all transports from \fB\fCcontainers-transports(5)\fR (see examples below). If no transport is specified, the input is subject to short-name resolution (see \fB\fCcontainers-registries.conf(5)\fR) and the \fB\fCdocker\fR (i.e., container registry) transport is used.

.SS DEPENDENCIES
.PP
Buildah resolves the path to the registry to pull from by using the /etc/containers/registries.conf
file, containers-registries.conf(5).  If the \fB\fCbuildah pull\fR command fails with an "image not known" error,
first verify that the registries.conf file is installed and configured appropriately.

.SH RETURN VALUE
.PP
The image ID of the image that was pulled.  On error 1 is returned.

.SH OPTIONS
.PP
\fB--all-tags\fP, \fB-a\fP

.PP
All tagged images in the repository will be pulled.

.PP
\fB--arch\fP="ARCH"

.PP
Set the ARCH of the image to be pulled to the provided value instead of using the architecture of the host. (Examples: arm, arm64, 386, amd64, ppc64le, s390x)

.PP
\fB--authfile\fP \fIpath\fP

.PP
Path of the authentication file. Default is ${XDG_RUNTIME_DIR}/containers/auth.json. See containers-auth.json(5) for more information. This file is created using \fB\fCbuildah login\fR\&.

.PP
If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using \fB\fCdocker login\fR\&.

.PP
Note: You can also override the default path of the authentication file by setting the REGISTRY_AUTH_FILE
environment variable. \fB\fCexport REGISTRY_AUTH_FILE=path\fR

.PP
\fB--cert-dir\fP \fIpath\fP

.PP
Use certificates at \fIpath\fP (*\&.crt, *\&.cert, *\&.key) to connect to the registry.
The default certificates directory is \fI/etc/containers/certs.d\fP\&.

.PP
\fB--creds\fP \fIcreds\fP

.PP
The [username[:password]] to use to authenticate with the registry if required.
If one or both values are not supplied, a command line prompt will appear and the
value can be entered.  The password is entered without echo.

.PP
\fB--decryption-key\fP \fIkey[:passphrase]\fP

.PP
The [key[:passphrase]] to be used for decryption of images. Key can point to keys and/or certificates. Decryption will be tried with all keys. If the key is protected by a passphrase, it is required to be passed in the argument and omitted otherwise.

.PP
\fB--os\fP="OS"

.PP
Set the OS of the image to be pulled instead of using the current operating system of the host.

.PP
\fB--platform\fP="OS/ARCH[/VARIANT]"

.PP
Set the OS/ARCH of the image to be pulled
to the provided value instead of using the current operating system and
architecture of the host (for example \fB\fClinux/arm\fR).

.PP
OS/ARCH pairs are those used by the Go Programming Language.  In several cases
the ARCH value for a platform differs from one produced by other tools such as
the \fB\fCarch\fR command.  Valid OS and architecture name combinations are listed as
values for $GOOS and $GOARCH at https://golang.org/doc/install/source#environment,
and can also be found by running \fB\fCgo tool dist list\fR\&.

.PP
\fBNOTE:\fP The \fB\fC--platform\fR option may not be used in combination with the \fB\fC--arch\fR, \fB\fC--os\fR, or \fB\fC--variant\fR options.

.PP
\fB--policy\fP=\fBalways\fP|\fBmissing\fP|\fBnever\fP|\fBnewer\fP

.PP
Pull image policy. The default is \fBmissing\fP\&.

.RS
.IP \(bu 2
\fBalways\fP: Always pull the image and throw an error if the pull fails.
.IP \(bu 2
\fBmissing\fP: Pull the image only if it could not be found in the local containers storage.  Throw an error if no image could be found and the pull fails.
.IP \(bu 2
\fBnever\fP: Never pull the image but use the one from the local containers storage.  Throw an error if no image could be found.
.IP \(bu 2
\fBnewer\fP: Pull if the image on the registry is newer than the one in the local containers storage.  An image is considered to be newer when the digests are different.  Comparing the time stamps is prone to errors.  Pull errors are suppressed if a local image was found.

.RE

.PP
\fB--quiet\fP, \fB-q\fP

.PP
If an image needs to be pulled from the registry, suppress progress output.

.PP
\fB--remove-signatures\fP

.PP
Don't copy signatures when pulling images.

.PP
\fB--retry\fP \fIattempts\fP

.PP
Number of times to retry in case of failure when performing pull of images from registry.

.PP
Defaults to \fB\fC3\fR\&.

.PP
\fB--retry-delay\fP \fIduration\fP

.PP
Duration of delay between retry attempts in case of failure when performing pull of images from registry.

.PP
Defaults to \fB\fC2s\fR\&.

.PP
\fB--tls-verify\fP \fIbool-value\fP

.PP
Require HTTPS and verification of certificates when talking to container registries (defaults to true).  TLS verification cannot be used when talking to an insecure registry.

.PP
\fB--variant\fP=""

.PP
Set the architecture variant of the image to be pulled.

.SH EXAMPLE
.PP
buildah pull imagename

.PP
buildah pull docker://myregistry.example.com/imagename

.PP
buildah pull docker-daemon:imagename:imagetag

.PP
buildah pull docker-archive:filename

.PP
buildah pull oci-archive:filename

.PP
buildah pull dir:directoryname

.PP
buildah pull --tls-verify=false myregistry/myrepository/imagename:imagetag

.PP
buildah pull --creds=myusername:mypassword --cert-dir ~/auth myregistry/myrepository/imagename:imagetag

.PP
buildah pull --authfile=/tmp/auths/myauths.json myregistry/myrepository/imagename:imagetag

.PP
buildah pull --arch=aarch64 myregistry/myrepository/imagename:imagetag

.PP
buildah pull --arch=arm --variant=v7 myregistry/myrepository/imagename:imagetag

.SH ENVIRONMENT
.PP
\fBBUILD_REGISTRY_SOURCES\fP

.PP
BUILD_REGISTRY_SOURCES, if set, is treated as a JSON object which contains
lists of registry names under the keys \fB\fCinsecureRegistries\fR,
\fB\fCblockedRegistries\fR, and \fB\fCallowedRegistries\fR\&.

.PP
When pulling an image from a registry, if the name of the registry matches any
of the items in the \fB\fCblockedRegistries\fR list, the image pull attempt is denied.
If there are registries in the \fB\fCallowedRegistries\fR list, and the registry's
name is not in the list, the pull attempt is denied.

.PP
\fBTMPDIR\fP
The TMPDIR environment variable allows the user to specify where temporary files
are stored while pulling and pushing images.  Defaults to '/var/tmp'.

.SH FILES
.PP
\fBregistries.conf\fP (\fB\fC/etc/containers/registries.conf\fR)

.PP
registries.conf is the configuration file which specifies which container registries should be consulted when completing image names which do not include a registry or domain portion.

.PP
\fBpolicy.json\fP (\fB\fC/etc/containers/policy.json\fR)

.PP
Signature policy file.  This defines the trust policy for container images.  Controls which container registries can be used for image, and whether or not the tool should trust the images.

.SH SEE ALSO
.PP
buildah(1), buildah-from(1), buildah-login(1), docker-login(1), containers-policy.json(5), containers-registries.conf(5), containers-transports(5), containers-auth.json(5)