20884f
% CONTAINERS-TRANSPORTS(5) Containers Transports Man Page
20884f
% Valentin Rothberg
20884f
% April 2019
20884f
20884f
## NAME
20884f
20884f
containers-transports - description of supported transports for copying and storing container images
20884f
20884f
## DESCRIPTION
20884f
20884f
Tools which use the containers/image library, including skopeo(1), buildah(1), podman(1), all share a common syntax for referring to container images in various locations.
20884f
The general form of the syntax is _transport:details_, where details are dependent on the specified transport, which are documented below.
20884f
20884f
### **containers-storage**:[**[**storage-specifier**]**]{image-id|docker-reference[@image-id]}
20884f
20884f
An image located in a local containers storage.
20884f
The format of _docker-reference_ is described in detail in the **docker** transport.
20884f
20884f
The _storage-specifier_ allows for referencing storage locations on the file system and has the format `[[driver@]root[+run-root][:options]]` where the optional `driver` refers to the storage driver (e.g., overlay or btrfs) and where `root` is an absolute path to the storage's root directory.
20884f
The optional `run-root` can be used to specify the run directory of the storage where all temporary writable content is stored.
20884f
The optional `options` are a comma-separated list of driver-specific options.
20884f
Please refer to containers-storage.conf(5) for further information on the drivers and supported options.
20884f
20884f
### **dir:**_path_
20884f
20884f
An existing local directory _path_ storing the manifest, layer tarballs and signatures as individual files.
20884f
This is a non-standardized format, primarily useful for debugging or noninvasive container inspection.
20884f
20884f
### **docker://**_docker-reference_
20884f
20884f
An image in a registry implementing the "Docker Registry HTTP API V2".
20884f
By default, uses the authorization state in `$XDG_RUNTIME_DIR/containers/auth.json`, which is set using podman-login(1).
20884f
If the authorization state is not found there, `$HOME/.docker/config.json` is checked, which is set using docker-login(1).
20884f
The containers-registries.conf(5) further allows for configuring various settings of a registry.
20884f
20884f
Note that a _docker-reference_ has the following format: `name[:tag|@digest]`.
20884f
While the docker transport does not support both a tag and a digest at the same time some formats like containers-storage do.
20884f
Digests can also be used in an image destination as long as the manifest matches the provided digest.
20884f
The digest of images can be explored with skopeo-inspect(1).
20884f
If `name` does not contain a slash, it is treated as `docker.io/library/name`.
20884f
Otherwise, the component before the first slash is checked if it is recognized as a `hostname[:port]` (i.e., it contains either a . or a :, or the component is exactly localhost).
20884f
If the first component of name is not recognized as a `hostname[:port]`, `name` is treated as `docker.io/name`.
20884f
20884f
### **docker-archive:**_path[:{docker-reference|@source-index}]_
20884f
20884f
An image is stored in the docker-save(1) formatted file.
20884f
_docker-reference_ must not contain a digest.
20884f
Alternatively, for reading archives, @_source-index_ is a zero-based index in archive manifest
20884f
(to access untagged images).
20884f
If neither _docker-reference_ nor @_source_index is specified when reading an archive, the archive must contain exactly one image.
20884f
20884f
It is further possible to copy data to stdin by specifying `docker-archive:/dev/stdin` but note that the used file must be seekable.
20884f
20884f
### **docker-daemon:**_docker-reference|algo:digest_
20884f
20884f
An image stored in the docker daemon's internal storage.
20884f
The image must be specified as a _docker-reference_ or in an alternative _algo:digest_ format when being used as an image source.
20884f
The _algo:digest_ refers to the image ID reported by docker-inspect(1).
20884f
20884f
### **oci:**_path[:tag]_
20884f
20884f
An image compliant with the "Open Container Image Layout Specification" at _path_.
20884f
Using a _tag_ is optional and allows for storing multiple images at the same _path_.
20884f
20884f
### **oci-archive:**_path[:tag]_
20884f
20884f
An image compliant with the "Open Container Image Layout Specification" stored as a tar(1) archive at _path_.
20884f
20884f
### **ostree:**_docker-reference[@/absolute/repo/path]_
20884f
20884f
An image in the local ostree(1) repository.
20884f
_/absolute/repo/path_ defaults to _/ostree/repo_.
20884f
20884f
## Examples
20884f
20884f
The following examples demonstrate how some of the containers transports can be used.
20884f
The examples use skopeo-copy(1) for copying container images.
20884f
20884f
**Copying an image from one registry to another**:
20884f
```
20884f
$ skopeo copy docker://docker.io/library/alpine:latest docker://localhost:5000/alpine:latest
20884f
```
20884f
20884f
**Copying an image from a running Docker daemon to a directory in the OCI layout**:
20884f
```
20884f
$ mkdir alpine-oci
20884f
$ skopeo copy docker-daemon:alpine:latest oci:alpine-oci
20884f
$ tree alpine-oci
20884f
test-oci/
20884f
├── blobs
20884f
│   └── sha256
20884f
│       ├── 83ef92b73cf4595aa7fe214ec6747228283d585f373d8f6bc08d66bebab531b7
20884f
│       ├── 9a6259e911dcd0a53535a25a9760ad8f2eded3528e0ad5604c4488624795cecc
20884f
│       └── ff8df268d29ccbe81cdf0a173076dcfbbea4bb2b6df1dd26766a73cb7b4ae6f7
20884f
├── index.json
20884f
└── oci-layout
20884f
20884f
2 directories, 5 files
20884f
```
20884f
20884f
**Copying an image from a registry to the local storage**:
20884f
```
20884f
$ skopeo copy docker://docker.io/library/alpine:latest containers-storage:alpine:latest
20884f
```
20884f
20884f
## SEE ALSO
20884f
20884f
docker-login(1), docker-save(1), ostree(1), podman-login(1), skopeo-copy(1), skopeo-inspect(1), tar(1), container-registries.conf(5), containers-storage.conf(5)
20884f
20884f
## AUTHORS
20884f
20884f
Miloslav Trmač <mitr@redhat.com>
20884f
Valentin Rothberg <rothberg@redhat.com>