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