58f840462c
When using remote podman client, not all transports work as expected. So document this limitation. Fixes: containers/podman#15141 Signed-off-by: Tomas Volf <tomas.volf@showmax.com> |
||
|---|---|---|
| .github | ||
| contrib/cirrus | ||
| copy | ||
| directory | ||
| docker | ||
| docs | ||
| hack | ||
| image | ||
| internal | ||
| manifest | ||
| oci | ||
| openshift | ||
| ostree | ||
| pkg | ||
| sif | ||
| signature | ||
| storage | ||
| tarball | ||
| transports | ||
| types | ||
| version | ||
| .cirrus.Dockerfile | ||
| .cirrus.yml | ||
| .gitignore | ||
| .golangci.yml | ||
| .pullapprove.yml | ||
| CODE-OF-CONDUCT.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| MAINTAINERS | ||
| Makefile | ||
| README.md | ||
| SECURITY.md | ||
| doc.go | ||
| go.mod | ||
| go.sum | ||
| registries.conf | ||
README.md
image is a set of Go libraries aimed at working in various way with
containers' images and container image registries.
The containers/image library allows application to pull and push images from container image registries, like the docker.io and quay.io registries. It also implements "simple image signing".
The containers/image library also allows you to inspect a repository on a
container registry without pulling down the image. This means it fetches the
repository's manifest and it is able to show you a docker inspect-like json
output about a whole repository or a tag. This library, in contrast to docker inspect, helps you gather useful information about a repository or a tag
without requiring you to run docker pull.
The containers/image library also allows you to translate from one image format to another, for example docker container images to OCI images. It also allows you to copy container images between various registries, possibly converting them as necessary, and to sign and verify images.
Command-line usage
The containers/image project is only a library with no user interface;
you can either incorporate it into your Go programs, or use the skopeo tool:
The skopeo tool uses the
containers/image library and takes advantage of many of its features,
e.g. skopeo copy exposes the containers/image/copy.Image functionality.
Dependencies
This library ships as a Go module.
Building
If you want to see what the library can do, or an example of how it is called, consider starting with the skopeo tool instead.
To integrate this library into your project, include it as a Go module,
put it into $GOPATH or use your preferred vendoring tool to include a copy
in your project. Ensure that the dependencies documented in go.mod
are also available (using those exact versions or different versions of
your choosing).
This library, by default, also depends on the GpgME and libostree C libraries. Either install them:
Fedora$ dnf install gpgme-devel libassuan-devel ostree-devel
macOS$ brew install gpgme
or use the build tags described below to avoid the dependencies (e.g. using go build -tags …)
Supported build tags
containers_image_openpgp: Use a Golang-only OpenPGP implementation for signature verification instead of the default cgo/gpgme-based implementation; the primary downside is that creating new signatures with the Golang-only implementation is not supported.containers_image_ostree: Importostree:transport ingithub.com/containers/image/transports/alltransports. This builds the library requiring thelibostreedevelopment libraries. Otherwise a stub which reports that the transport is not supported gets used. Thegithub.com/containers/image/ostreepackage is completely disabled and impossible to import when this build tag is not in use.
Contributing
Information about contributing to this project.
When developing this library, please use make (or make … BUILDTAGS=…) to take advantage of the tests and validation.
License
Apache License 2.0
SPDX-License-Identifier: Apache-2.0
Contact
- Mailing list: containers-dev
- IRC: #container-projects on freenode.net