summaryrefslogtreecommitdiff
path: root/docs/podman-pull.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/podman-pull.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/podman-pull.1.md')
-rw-r--r--docs/podman-pull.1.md147
1 files changed, 0 insertions, 147 deletions
diff --git a/docs/podman-pull.1.md b/docs/podman-pull.1.md
deleted file mode 100644
index de9688f5e..000000000
--- a/docs/podman-pull.1.md
+++ /dev/null
@@ -1,147 +0,0 @@
-% podman-pull(1)
-
-## NAME
-podman\-pull - Pull an image from a registry
-
-## SYNOPSIS
-**podman pull** [*options*] *name*[:*tag*|@*digest*]
-
-**podman image pull** [*options*] *name*[:*tag*|@*digest*]
-
-## DESCRIPTION
-Copies an image from a registry onto the local machine. **podman 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, **podman pull** defaults to the image with the
-**latest** tag (if it exists) and pulls it. After the image is pulled, podman will
-print the full image ID. **podman pull** can also pull an image
-using its digest **podman pull** *image*@*digest*. **podman 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 `(podman 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_.
-
-## OPTIONS
-
-**--all-tags**, **a**
-
-All tagged images in the repository will be pulled.
-
-Note: When using the all-tags flag, Podman will not iterate over the search registries in the containers-registries.conf(5) but will always use docker.io for unqualified image names.
-
-**--authfile**=*path*
-
-Path of the authentication file. Default is ${XDG\_RUNTIME\_DIR}/containers/auth.json, which is set using `podman login`.
-If the authorization state is not found there, $HOME/.docker/config.json is checked, which is set using `docker login`. (Not available for remote commands)
-
-Note: You can also override the default path of the authentication file by setting the REGISTRY\_AUTH\_FILE
-environment variable. `export REGISTRY_AUTH_FILE=path`
-
-**--cert-dir**=*path*
-
-Use certificates at *path* (\*.crt, \*.cert, \*.key) to connect to the registry.
-Default certificates directory is _/etc/containers/certs.d_. (Not available for remote commands)
-
-**--creds**=*[username[:password]]*
-
-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.
-
-**--quiet**, **-q**
-
-Suppress output information when pulling images
-
-**--tls-verify**=*true|false*
-
-Require HTTPS and verify certificates when contacting registries (default: true). If explicitly set to true,
-then TLS verification will be used. If set to false, then TLS verification will not be used. If not specified,
-TLS verification will be used unless the target registry is listed as an insecure registry in registries.conf. (Not available for remote commands)
-
-**--help**, **-h**
-
-Print usage statement
-
-## EXAMPLES
-
-```
-$ podman pull 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
-04660052281190168dbb2362eb15bf7067a8dc642d2498055e0e72efa961a4b6
-```
-
-```
-$ podman 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
-03290064078cb797f3e0a530e78c20c13dd22a3dd3adf84a5da2127b48df0438
-```
-
-```
-$ podman 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
-03290064078cb797f3e0a530e78c20c13dd22a3dd3adf84a5da2127b48df0438
-```
-
-```
-$ podman 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
-03290064078cb797f3e0a530e78c20c13dd22a3dd3adf84a5da2127b48df0438
-```
-## FILES
-
-**registries.conf** (`/etc/containers/registries.conf`)
-
- 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.
-
-## SEE ALSO
-podman(1), podman-push(1), podman-login(1), containers-registries.conf(5)
-
-## HISTORY
-July 2017, Originally compiled by Urvashi Mohnani <umohnani@redhat.com>