Container Storage Library
Go to file
Nalin Dahyabhai bcedb54d05 layerStore.Load(): don't try to lock the mounts list on cleanup
When cleaning up an incomplete layer, don't call regular Delete() to
handle it, since that calls Save(), which tries to lock the mountpoints
list, which we've already obtained a lock over.  Add a variation on
Delete() that skips the Save() step, which we're about to do anyway, and
call that instead.

Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2019-09-12 11:17:54 -04:00
cmd/containers-storage Add tests for the ReadOnly field 2019-05-21 11:54:50 -04:00
contrib/cirrus Cirrus: Increase Ubuntu install timeouts 2019-09-12 09:33:25 -04:00
docs Add support for ignoreChownErrors to vfs 2019-07-29 14:30:17 -04:00
drivers Ignore ro mount options in btrfs and windows drivers 2019-08-09 11:26:02 -04:00
hack Disable cgo-requiring bits when cgo is not enabled 2019-08-05 13:42:50 -04:00
opts Replace deprecated repo 'github.com/docker/engine-api' 2018-01-17 21:31:21 +08:00
pkg Don't chown on safechown if directory exists and has correct ownership 2019-08-05 20:32:05 -04:00
tests layerStore.Load(): don't try to lock the mounts list on cleanup 2019-09-12 11:17:54 -04:00
vagrant vagrant: install ostree 2018-06-29 18:47:10 +02:00
vendor vendor ffjson deps required during generation 2019-08-05 10:43:25 +02:00
.cirrus.yml Merge pull request #385 from saschagrunert/internal-tools 2019-07-17 16:20:36 +02:00
.dockerignore Add vendor/pkg to .dockerignore 2015-12-04 17:03:24 -08:00
.gitignore Switch to golangci-lint 2019-07-17 11:13:06 +02:00
.golangci.yml Switch to golangci-lint 2019-07-17 11:13:06 +02:00
.mailmap Fix double entry in authors 2016-06-03 12:40:36 +02:00
.travis.yml Bump to latest golang for testing. 2019-03-19 09:22:12 -04: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 Makefile: use go proxy 2019-08-30 11:58:36 +02: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 bump to v1.13.3-dev 2019-08-09 20:39:13 +02:00
Vagrantfile Vagrantfile: update to Fedora 28 2018-06-29 18:47:10 +02:00
containers.go locking: take read locks on read-only stores 2019-07-02 11:14:03 -04:00
containers_ffjson.go add digest locks 2019-03-28 09:53:02 +01:00
errors.go lockfile: implement reader-writer locks 2019-02-15 09:49:44 +01:00
ffjson_deps.go vendor ffjson deps required during generation 2019-08-05 10:43:25 +02:00
go.mod go build: use `-mod=vendor` for go >= 1.11.x 2019-08-01 15:34:54 +02:00
go.sum Switch to go modules 2019-07-09 08:32:22 +02:00
images.go wrap ID or digest to ErrImageUnkown errors 2019-09-11 10:03:08 +02:00
images_ffjson.go add digest locks 2019-03-28 09:53:02 +01:00
layers.go layerStore.Load(): don't try to lock the mounts list on cleanup 2019-09-12 11:17:54 -04:00
layers_ffjson.go Update generated files 2019-09-10 12:58:33 -04:00
lockfile_compat.go Move lockfiles to their own package 2019-07-02 11:14:04 -04:00
storage.conf Add support for ignoreChownErrors to vfs 2019-07-29 14:30:17 -04:00
store.go wrap ID or digest to ErrImageUnkown errors 2019-09-11 10:03:08 +02:00
utils.go utils: fix check for missing conf file 2019-06-23 23:28:48 +02: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.