Container Storage Library
Go to file
Giuseppe Scrivano 2d959dd4bf
store: drop remap-[ug]ids
drop the possibility to configure a remapping for all the layers in
the storage.

The feature dates back to the initial fork from Docker, that supported
a single user namespace where all the images were pulled. It was never
used by the container tools since we have a finer control of the user
namespaces.

Signed-off-by: Giuseppe Scrivano <gscrivan@redhat.com>
2024-06-24 13:15:04 +02:00
.github Remove dependabot, we use renovate now 2024-04-24 08:49:17 -04:00
cmd/containers-storage cmd: replace usage of deprecated functions 2024-05-10 15:21:00 +02:00
contrib/cirrus cirrus: kill zfs dataset owner only when there is one 2023-08-22 16:25:07 +02:00
docs store: drop remap-[ug]ids 2024-06-24 13:15:04 +02:00
drivers store: drop remap-[ug]ids 2024-06-24 13:15:04 +02:00
hack Remove devicemapper storage driver 2024-04-15 14:44:29 -07:00
internal/opts Format sources with gofumpt 2023-05-26 16:17:31 -07:00
pkg store: drop remap-[ug]ids 2024-06-24 13:15:04 +02:00
tests Remove devicemapper storage driver 2024-04-15 14:44:29 -07:00
types store: drop remap-[ug]ids 2024-06-24 13:15:04 +02:00
vendor Vendor update after removing pwalk 2024-06-19 16:04:40 +02:00
.cirrus.yml chore(deps): update dependency containers/automation_images to v20240529 2024-05-29 23:09:09 +00: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 ci: use gofumpt, rm hack/gofmt.sh 2023-05-26 16:19:32 -07:00
.mailmap Fix double entry in authors 2016-06-03 12:40:36 +02:00
AUTHORS Inherit system storage driver in rootless configurations 2021-03-02 10:28:53 -06:00
CODE-OF-CONDUCT.md [CI:DOCS] Fix docs links due to branch rename 2021-06-10 11:37:44 -04: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 Test that we can build all subpackages on all platforms 2024-06-07 15:36:44 +02:00
NOTICE Update LICENSE date 2015-12-31 13:07:35 +00:00
OWNERS Add an OWNERS file for the merge bot to refer to 2023-09-12 14:18:13 -04:00
README.md make: clean up .PHONY targets list 2018-10-31 19:03:59 +01:00
SECURITY.md [CI:DOCS] Fix docs links due to branch rename 2021-06-10 11:37:44 -04:00
VERSION Bump to v1.55.0-dev 2024-05-17 13:40:30 -04:00
check.go check: be able to complain about both diff digests and sizes 2023-06-13 14:14:56 -04:00
check_test.go Use generics in readAllImageStores 2023-04-18 21:25:04 +02:00
containers.go Format sources with gofumpt 2023-05-26 16:17:31 -07:00
deprecated.go store: drop deprecated functions 2024-05-10 15:21:00 +02:00
errors.go store: add independent AddNames and RemoveNames for images,layers,containers 2022-03-01 01:33:35 +05:30
go.mod fix(deps): update module github.com/klauspost/compress to v1.17.9 2024-06-12 15:17:04 +00:00
go.sum fix(deps): update module github.com/klauspost/compress to v1.17.9 2024-06-12 15:17:04 +00:00
idset.go Use the new built-in min() and max() functions 2024-04-23 22:21:27 +02:00
idset_test.go Use the new built-in min() and max() functions 2024-04-23 22:21:27 +02:00
images.go Format sources with gofumpt 2023-05-26 16:17:31 -07:00
images_test.go Complete "pulling up" of images in updateNames() 2023-03-31 10:36:30 -04:00
jsoniter.go Use json-iterator instead of encoding/json 2021-05-06 12:24:24 -04:00
layers.go store: lock both graphroot and the imagestore root 2024-02-29 16:35:58 +01:00
lockfile_compat.go Fix ignore of Using a deprecated function, variable, constant or field (SA1019) 2024-06-19 11:11:17 +02:00
storage.conf store: drop remap-[ug]ids 2024-06-24 13:15:04 +02:00
storage.conf-freebsd store: drop remap-[ug]ids 2024-06-24 13:15:04 +02:00
store.go store: drop remap-[ug]ids 2024-06-24 13:15:04 +02:00
store_test.go store: add support to split ImageStore 2023-04-14 17:34:27 +05:30
userns.go store: new API ApplyStagedLayer 2024-02-15 21:57:00 +01:00
userns_test.go Rework autons ID mapping generation. 2021-04-03 13:22:23 -07:00
utils.go store: drop rootless from arguments 2023-11-16 21:13:28 +01: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.