Container Storage Library
Go to file
Paul Holzinger 0668a1040e
fix libsubid detection script
The library argument must be after the sources. Not sure why this works
on fedora. Taken from a the podman fix[1].

[1] 8ff54cbe8c

Signed-off-by: Paul Holzinger <pholzing@redhat.com>
2025-03-28 14:12:40 +01:00
.github
cmd/containers-storage cmd: drop args to MountImage to use with vfs 2025-03-25 15:49:02 +01:00
contrib/cirrus cirrus: update dnf comamnd for dnf5 2024-11-15 16:51:34 +01:00
docs When applying a chunked layer with a tar-split, compute its uncompressed digest 2025-01-07 16:56:09 +01:00
drivers driver/overlay: inline the mutex in driver 2025-03-28 12:02:20 +01:00
hack fix libsubid detection script 2025-03-28 14:12:40 +01:00
internal internal/dedup: fix ST1012 linter warning 2025-03-26 18:42:54 -07:00
pkg pkg/idtools: fix lint gofumpt error 2025-03-28 12:06:12 +01:00
tests store: use canonical image mapping when mounting 2025-03-25 17:30:28 +01:00
types types: use strings.ReplaceAll 2025-03-26 14:29:57 -07:00
vendor Update github.com/containerd/cgroups/v3 to v3.0.5 2025-03-26 21:00:20 +01:00
.cirrus.yml CI: add libsubid to lint task 2025-03-28 12:09:51 +01:00
.codespellrc ci: add codespell 2024-10-15 17:39:07 -07:00
.dockerignore
.gitignore
.golangci.yml ci: switch to golangci-lint v2 2025-03-26 18:47:22 -07:00
.mailmap
AUTHORS
CODE-OF-CONDUCT.md
CONTRIBUTING.md Add link to c/common contributor's guide 2025-03-17 21:43:09 +01:00
LICENSE
Makefile ci: switch to golangci-lint v2 2025-03-26 18:47:22 -07:00
NOTICE
OWNERS Audit and update OWNERS file 2024-10-04 13:16:59 -05:00
README.md
SECURITY.md
VERSION Bump c/storage to v1.58.0-dev 2025-01-29 18:33:14 -05:00
check.go check: adapt to work with ForceMask 2024-12-06 08:50:08 +01:00
check_test.go Use assert.ElementsMatch instead of manually copying+sorting 2024-09-05 19:44:50 +02:00
containers.go Refactor of copying maps 2024-10-25 10:24:48 +02:00
deprecated.go
errors.go
go.mod Update github.com/containerd/cgroups/v3 to v3.0.5 2025-03-26 21:00:20 +01:00
go.sum Update github.com/containerd/cgroups/v3 to v3.0.5 2025-03-26 21:00:20 +01:00
idset.go
idset_test.go
images.go Refactor of copying maps 2024-10-25 10:24:48 +02:00
images_test.go
jsoniter.go
layers.go layers: write read only layers to imagestore 2025-02-20 09:24:55 +01:00
layers_test.go layers: write read only layers to imagestore 2025-02-20 09:24:55 +01:00
lockfile_compat.go
storage.conf When applying a chunked layer with a tar-split, compute its uncompressed digest 2025-01-07 16:56:09 +01:00
storage.conf-freebsd
store.go Apply De Morgan's law 2025-03-26 18:43:02 -07:00
store_test.go Create newTestStore 2024-08-19 15:25:58 +02:00
userns.go Use securejoin.SecureJoin when forming userns paths 2024-10-14 12:36:11 -04:00
userns_test.go Use securejoin.SecureJoin when forming userns paths 2024-10-14 12:36:11 -04:00
userns_unsupported.go Use securejoin.SecureJoin when forming userns paths 2024-10-14 12:36:11 -04:00
utils.go Avoid unnecessary manually-coded loops 2024-09-05 19:45:45 +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.