Container Storage Library
Go to file
Kir Kolyshkin 8b67934cbc pkg/mount: wrap mount/umount errors
The errors returned from Mount and Unmount functions are raw
syscall.Errno errors (like EPERM or EINVAL), which provides
no context about what has happened and why.

Similar to os.PathError type, introduce mount.Error type
with some context. The error messages will now look like this:

> mount /tmp/mount-tests/source:/tmp/mount-tests/target, flags: 0x1001: operation not permitted

or

> mount tmpfs:/tmp/mount-test-source-516297835: operation not permitted

Before this patch, it was just

> operation not permitted

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
2020-03-10 06:41:39 -07:00
cmd/containers-storage Move opts to internal/opts and fork docker filters 2019-10-29 13:12:13 +01:00
contrib/cirrus Cirrus: Support additional test-storage 2020-02-27 12:32:32 -05:00
docs Add `rootless_storage_path` directive to storage.conf 2020-02-24 14:40:03 -05:00
drivers Revert API break due to lint fixes 2020-01-29 11:46:52 +01:00
hack Kill travis testing 2020-02-27 12:32:32 -05:00
internal/opts Enable deadcode linter and fix lints 2020-01-28 15:59:15 +01:00
pkg pkg/mount: wrap mount/umount errors 2020-03-10 06:41:39 -07:00
tests go mod tidy 2020-03-04 10:20:11 -08:00
vagrant storage: drop ostree deduplication 2019-10-05 20:27:45 +02:00
vendor Merge pull request #543 from containers/dependabot/go_modules/github.com/klauspost/compress-1.10.2 2020-03-03 08:31:00 -05:00
.cirrus.yml Cirrus: Temp. Tolerate devicemapper test failure 2020-02-27 12:32:32 -05:00
.dockerignore Add vendor/pkg to .dockerignore 2015-12-04 17:03:24 -08:00
.gitignore Bump github.com/Microsoft/hcsshim from 0.8.6 to 0.8.7 2019-12-03 15:14:30 +01: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 Fix ffjson compilation 2020-01-31 10:15:20 +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.16.3-dev 2020-03-07 06:54:18 -05: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 mod tidy 2020-03-04 10:20:11 -08:00
go.sum go mod tidy 2020-03-04 10:20:11 -08:00
images.go Enable golint linter and fix lints 2020-01-28 15:59:15 +01: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 Remove locking from layer store creation 2020-01-30 10:39:58 +01: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 Merge pull request #529 from QiWang19/rootless-storage-path 2020-02-26 06:29:34 -05:00
store.go Merge pull request #541 from giuseppe/parallel-delete-store 2020-03-05 14:29:07 -05:00
utils.go fix else case for rootless storage path and path match 2020-03-02 09:58:18 -05:00
utils_test.go fix else case for rootless storage path and path match 2020-03-02 09:58:18 -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.