Container Storage Library
Go to file
Kan Li d27c88d3ef Fix subtractAll bugs.
The logic of range subtraction [a,b)-[c,d) can be viewed as intersection
of [a,b) with (-inf, c) and [d, +inf), respectively. This makes the
logic simpler, that we no longer need to check 5 different cases.

It also fixes bugs that returns incorrect range.

Closes #763
Signed-off-by: Kan Li <likan@google.com>
2020-11-01 10:52:08 -08:00
cmd/containers-storage new interface for MountImage added 2020-07-07 13:45:51 -04:00
contrib/cirrus Cirrus: Avoid upgrading grub-efi-amd64-signed 2020-10-29 17:36:30 -04:00
docs add note regarding problematic language in codebase 2020-09-30 15:40:17 -04:00
drivers Merge pull request #743 from rhatdan/perms 2020-10-30 10:09:50 -04:00
hack Fix problems found by codespell 2020-09-11 10:49:59 -04:00
internal/opts Fix problems found by codespell 2020-09-11 10:49:59 -04:00
pkg Merge pull request #757 from kolyshkin/eintr 2020-10-30 10:08:52 -04:00
tests Execute tests serially 2020-09-17 13:13:49 -04:00
vagrant Use `bash` binary from env instead of /bin/bash for scripts 2020-08-17 11:23:44 +02:00
vendor build(deps): bump github.com/klauspost/compress from 1.11.1 to 1.11.2 2020-10-29 05:57:39 -04:00
.cirrus.yml Cirrus: Update VM images & modernize scripts 2020-10-05 08:08:29 -04:00
.dockerignore Add vendor/pkg to .dockerignore 2015-12-04 17:03:24 -08:00
.gitignore Fixes: https://github.com/containers/podman/issues/7790 2020-10-06 11:39:51 +08:00
.golangci.yml Enable all linters and selectively disable them 2020-01-28 16:09:15 +01:00
.mailmap Fix double entry in authors 2016-06-03 12:40:36 +02:00
AUTHORS Fix double entry in authors 2016-06-03 12:40:36 +02:00
CODE-OF-CONDUCT.md Add Code of Conduct 2020-02-08 18:13:47 -05: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 Cleanup make vendor code to actualy tidy up repo 2020-04-08 10:35:16 -04: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
SECURITY.md Add Security Policy 2020-05-09 18:12:41 -04:00
VERSION Move to v1.23.9-dev 2020-10-30 15:52:15 -04:00
Vagrantfile Vagrantfile: update to Fedora 28 2018-06-29 18:47:10 +02:00
containers.go lost mountopts when read json from file 2020-04-29 01:34:19 +08: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 build(deps): bump github.com/klauspost/compress from 1.11.1 to 1.11.2 2020-10-29 05:57:39 -04:00
go.sum build(deps): bump github.com/klauspost/compress from 1.11.1 to 1.11.2 2020-10-29 05:57:39 -04:00
images.go store: support mapped layers deletion 2020-08-05 13:33:43 +02:00
images_ffjson.go Fix ffjson compilation 2020-01-31 10:15:20 +01:00
images_test.go Add names-history support 2019-11-11 10:21:14 +01:00
layers.go archive: defer close after DecompressStream to fix resource leak 2020-10-28 15:56:28 +08:00
layers_ffjson.go Fix ffjson compilation 2020-01-31 10:15:20 +01:00
lockfile_compat.go Move lockfiles to their own package 2019-07-02 11:14:04 -04:00
storage.conf Fix problems found by codespell 2020-09-11 10:49:59 -04:00
storage_test.conf Allow any env variable for graphroot, runroot, storagepath 2020-08-11 17:18:28 -04:00
store.go If caller Sets the DefaultConfigFilePath, we need to use it 2020-10-23 16:19:11 -04:00
store_test.go new interface Free for deleting Store object 2020-06-29 13:01:33 -04:00
userns.go Fix subtractAll bugs. 2020-11-01 10:52:08 -08:00
userns_test.go Fix subtractAll bugs. 2020-11-01 10:52:08 -08:00
utils.go If caller Sets the DefaultConfigFilePath, we need to use it 2020-10-23 16:19:11 -04:00
utils_test.go utils_test.go: make test show mismatching items 2020-09-09 21:40:58 -04: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.