Container Storage Library
Go to file
Nalin Dahyabhai ccf8bef6fa Teach images to hold multiple manifests
Change how we compute digests for BigData items with names that start
with "manifest" so that we use the image library's manifest.Digest()
function, which knows how to preprocess schema1 manifests to get the
right value, instead of just trying to finesse it.

Track the digests of multiple manifest-named items for images.

Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2019-02-07 10:27:36 -05:00
cmd/containers-storage Teach images to hold multiple manifests 2019-02-07 10:27:36 -05:00
docs Teach images to hold multiple manifests 2019-02-07 10:27:36 -05:00
drivers overlay: do not attempt metacopyup when using a mount program 2019-01-21 10:10:25 +01:00
hack Check for the OS when setting btrfs/libdm/ostree tags 2019-01-16 14:02:54 -05:00
opts Replace deprecated repo 'github.com/docker/engine-api' 2018-01-17 21:31:21 +08:00
pkg Move structs for storage.conf to pkg/config 2019-02-03 21:21:32 -05:00
tests Teach images to hold multiple manifests 2019-02-07 10:27:36 -05:00
vagrant vagrant: install ostree 2018-06-29 18:47:10 +02:00
vendor Vendor github.com/containers/image 2019-02-06 10:04:37 -05:00
.dockerignore Add vendor/pkg to .dockerignore 2015-12-04 17:03:24 -08:00
.gitignore Update packages to match latest code in moby/pkg 2017-09-12 18:00:29 +00:00
.mailmap Fix double entry in authors 2016-06-03 12:40:36 +02:00
.travis.yml Remove an empty echo 2019-01-17 14:32:54 -05:00
AUTHORS Fix double entry in authors 2016-06-03 12:40:36 +02:00
CONTRIBUTING.md Change cri-o IRC channel to container-projects in CONTRIBUTING.md 2017-10-26 17:02:34 -04:00
LICENSE Update LICENSE date 2015-12-31 13:07:35 +00:00
Makefile make: clean up .PHONY targets list 2018-10-31 19:03:59 +01:00
NOTICE Update LICENSE date 2015-12-31 13:07:35 +00:00
README.md make: clean up .PHONY targets list 2018-10-31 19:03:59 +01:00
VERSION Move to v1.10-dev 2019-02-01 12:50:55 +00:00
Vagrantfile Vagrantfile: update to Fedora 28 2018-06-29 18:47:10 +02:00
containers.go Allow the passing in and retrieval of mount options 2018-11-19 19:14:21 -05:00
containers_ffjson.go Update generated files 2019-01-17 14:30:04 -05:00
errors.go Add LayerParentOwners()/ContainerParentOwners() 2018-04-03 10:34:32 -04:00
images.go Teach images to hold multiple manifests 2019-02-07 10:27:36 -05:00
images_ffjson.go Update generated files 2019-01-17 14:30:04 -05:00
layers.go Add a CreateFromTemplate() method to drivers, and use it for mapped layers 2019-01-17 14:28:40 -05:00
layers_ffjson.go Update generated files 2019-01-17 14:30:04 -05:00
lockfile.go Add lock sanity checks to Save() methods 2018-08-24 20:31:47 -07:00
lockfile_darwin.go lockfile: reshape for multiplatform 2018-01-30 05:00:58 -05:00
lockfile_linux.go lockfile: reshape for multiplatform 2018-01-30 05:00:58 -05:00
lockfile_unix.go Add lock sanity checks to Save() methods 2018-08-24 20:31:47 -07:00
lockfile_windows.go Implement Locker.Locked() for windows 2018-08-28 11:57:11 -07:00
storage.conf Remove the last traces of the "override_kernel_check" option 2019-01-16 16:59:39 -05:00
store.go Teach images to hold multiple manifests 2019-02-07 10:27:36 -05:00
vendor.conf Vendor github.com/containers/image 2019-02-06 10:04:37 -05:00

README.md

storage is a Go library which aims to provide methods for storing filesystem layers, container images, and containers. A containers-storage CLI wrapper is also included for manual and scripting use.

To build the CLI wrapper, use 'make binary'.

Operations which use VMs expect to launch them using 'vagrant', defaulting to using its 'libvirt' provider. The boxes used are also available for the 'virtualbox' provider, and can be selected by setting $VAGRANT_PROVIDER to 'virtualbox' before kicking off the build.

The library manages three types of items: layers, images, and containers.

A layer is a copy-on-write filesystem which is notionally stored as a set of changes relative to its parent layer, if it has one. A given layer can only have one parent, but any layer can be the parent of multiple layers. Layers which are parents of other layers should be treated as read-only.

An image is a reference to a particular layer (its top layer), along with other information which the library can manage for the convenience of its caller. This information typically includes configuration templates for running a binary contained within the image's layers, and may include cryptographic signatures. Multiple images can reference the same layer, as the differences between two images may not be in their layer contents.

A container is a read-write layer which is a child of an image's top layer, along with information which the library can manage for the convenience of its caller. This information typically includes configuration information for running the specific container. Multiple containers can be derived from a single image.

Layers, images, and containers are represented primarily by 32 character hexadecimal IDs, but items of each kind can also have one or more arbitrary names attached to them, which the library will automatically resolve to IDs when they are passed in to API calls which expect IDs.

The library can store what it calls metadata for each of these types of items. This is expected to be a small piece of data, since it is cached in memory and stored along with the library's own bookkeeping information.

Additionally, the library can store one or more of what it calls big data for images and containers. This is a named chunk of larger data, which is only in memory when it is being read from or being written to its own disk file.

Contributing Information about contributing to this project.