Work with containers' images
Go Makefile
Switch branches/tags
Nothing to show
Clone or download
Latest commit c6e0eee Jul 17, 2018
Permalink
Failed to load latest commit information.
copy Call Close() on the return value of gzip.NewReader() Jul 17, 2018
directory Add types.ImageDestination.IgnoresEmbeddedDockerReference Jun 4, 2018
docker docker tarfile: report correct size of compressed layers Jul 17, 2018
docs Update registries.conf man Jun 21, 2018
image Add a special case for GzippedEmptyLayer to storageImage.GetBlob Jul 13, 2018
internal tmpdir: unixTempDirForBigFiles can be overridden at build time May 7, 2018
manifest Add EmptyLayer to manifest.LayerInfo. Jul 13, 2018
oci Issue #475 Add flag for image compress layer for oci destination Jul 12, 2018
openshift Add types.ImageDestination.IgnoresEmbeddedDockerReference Jun 4, 2018
ostree Add types.ImageDestination.IgnoresEmbeddedDockerReference Jun 4, 2018
pkg Add tests for compression.AutoDecompress Jul 17, 2018
signature Put context.Context arguments on almost everything Apr 7, 2018
storage Don't physically store "empty layers" in v2s1 images Jul 13, 2018
tarball Add TODO notes for places which do a lot of work on the local filesystem Apr 10, 2018
transports alltransports: ostree is linux only Feb 27, 2018
types Issue #475 Add flag for image compress layer for oci destination Jul 12, 2018
version version: adjust variables Jun 27, 2016
.gitignore Issue #475 Add flag for image compress layer for oci destination Jul 12, 2018
.pullapprove.yml *: add pullapprove Jun 27, 2016
.travis.Dockerfile Update Go from 1.8.3 to 1.9.2 Jan 18, 2018
.travis.yml make and travis: cross platform compile check Jun 19, 2018
CONTRIBUTING.md Modify CONTRIBUTING.md to prefer smaller commits over squashing them Nov 6, 2017
LICENSE Move to Apache 2 license Jun 24, 2016
MAINTAINERS *: add MAINTAINERS Jun 27, 2016
Makefile make and travis: cross platform compile check Jun 19, 2018
README.md Make it easier for CONTRIBUTORS to find information Jul 5, 2018
doc.go Fix the example in doc.go Apr 10, 2018
registries.conf Add registries.conf file and build library to parse it Aug 29, 2017
vendor.conf pkg: compression: support xz (lzma) decompression Jul 17, 2018

README.md

GoDoc Build Status

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 upstream docker registry. 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 does not ship a committed version of its dependencies in a vendor subdirectory. This is so you can make well-informed decisions about which libraries you should use with this package in your own projects, and because types defined in the vendor directory would be impossible to use from your projects.

What this project tests against dependencies-wise is located in vendor.conf.

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, put it into $GOPATH or use your preferred vendoring tool to include a copy in your project. Ensure that the dependencies documented in vendor.conf 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 libostree-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_stub: Instead of importing ostree: transport in github.com/containers/image/transports/alltransports, use a stub which reports that the transport is not supported. This allows building the library without requiring the libostree development libraries. The github.com/containers/image/ostree package is completely disabled and impossible to import when this build tag is 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

ASL 2.0

Contact

  • Mailing list: containers-dev
  • IRC: #container-projects on freenode.net