The Moby Project - a collaborative project for the container ecosystem to assemble container-based systems
Find a file
Sebastiaan van Stijn 51c7992928
API: add "prune" events
This patch adds a new "prune" event type to indicate that pruning of a resource
type completed.

This event-type can be used on systems that want to perform actions after
resources have been cleaned up. For example, Docker Desktop performs an fstrim
after resources are deleted (https://github.com/linuxkit/linuxkit/tree/v0.7/pkg/trim-after-delete).

While the current (remove, destroy) events can provide information on _most_
resources, there is currently no event triggered after the BuildKit build-cache
is cleaned.

Prune events have a `reclaimed` attribute, indicating the amount of space that
was reclaimed (in bytes). The attribute can be used, for example, to use as a
threshold for performing fstrim actions. Reclaimed space for `network` events
will always be 0, but the field is added to be consistent with prune events for
other resources.

To test this patch:

Create some resources:

    for i in foo bar baz; do \
        docker network create network_$i \
        && docker volume create volume_$i \
        && docker run -d --name container_$i -v volume_$i:/volume busybox sh -c 'truncate -s 5M somefile; truncate -s 5M /volume/file' \
        && docker tag busybox:latest image_$i; \
    done;

    docker pull alpine
    docker pull nginx:alpine

    echo -e "FROM busybox\nRUN truncate -s 50M bigfile" | DOCKER_BUILDKIT=1 docker build -

Start listening for "prune" events in another shell:

    docker events --filter event=prune

Prune containers, networks, volumes, and build-cache:

    docker system prune -af --volumes

See the events that are returned:

    docker events --filter event=prune
    2020-07-25T12:12:09.268491000Z container prune  (reclaimed=15728640)
    2020-07-25T12:12:09.447890400Z network prune  (reclaimed=0)
    2020-07-25T12:12:09.452323000Z volume prune  (reclaimed=15728640)
    2020-07-25T12:12:09.517236200Z image prune  (reclaimed=21568540)
    2020-07-25T12:12:09.566662600Z builder prune  (reclaimed=52428841)

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2020-07-28 12:41:14 +02:00
.github Remove refs to jhowardmsft from .go code 2019-09-25 10:51:18 -07:00
api API: add "prune" events 2020-07-28 12:41:14 +02:00
builder vendor: update buildkit to 4d1f260e8 2020-07-20 11:34:22 -07:00
cli remove uses of deprecated pkg/term 2020-04-21 16:29:27 +02:00
client Merge pull request #40826 from thaJeztah/cleanup_service 2020-07-28 10:47:21 +02:00
cmd/dockerd API: add "prune" events 2020-07-28 12:41:14 +02:00
container Merge pull request #40856 from cpuguy83/reduce_allocs_on_env_repalce 2020-05-12 15:19:10 -07:00
contrib Upgrading the versions of images in Dockerfile. 2020-06-30 12:24:06 +08:00
daemon API: add "prune" events 2020-07-28 12:41:14 +02:00
distribution fix code note when push all tags 2020-06-16 21:05:10 +08:00
dockerversion Use -X ldflags to set dockerversion package vars 2019-12-02 10:21:41 -08:00
docs API: add "prune" events 2020-07-28 12:41:14 +02:00
errdefs bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
hack bump up rootlesskit to v0.10.0 2020-07-28 16:33:30 +09:00
image bump gotest.tools v3.0.1 for compatibility with Go 1.14 2020-02-11 00:06:42 +01:00
integration Replace service "Capabilities" w/ add/drop API 2020-07-27 10:09:42 -07:00
integration-cli Remove apt.dockerproject.org from test 2020-07-28 00:10:37 +02:00
internal/test/suite integration-cli: move each test suite to its own TestX testing function 2019-09-18 18:26:36 +00:00
layer Remove "could not get checksum with tar-split" debug message 2020-03-06 12:45:15 +01:00
libcontainerd Remove unused useShimV2() 2020-07-15 14:28:48 +02:00
oci Replace service "Capabilities" w/ add/drop API 2020-07-27 10:09:42 -07:00
opts fix address pool flags merge #40388 2020-07-21 22:12:28 +08:00
patches Remove blurb about fixed in go1.11 in patch file 2020-04-24 11:23:14 -07:00
pkg Merge pull request #41208 from thaJeztah/remove_shellwords 2020-07-17 15:46:24 -07:00
plugin Configure shims from runtime config 2020-07-13 14:18:02 -07:00
profiles seccomp: allow 'rseq' syscall in default seccomp profile 2020-06-26 16:06:26 +02:00
project project: remove obviously outdated docs 2020-06-24 19:58:25 +09:00
reference fix goimports 2020-02-11 22:16:54 +09:00
registry registry: fix mtls config dir passing 2020-05-14 12:02:09 -07:00
reports Fix typos 2018-05-16 09:15:43 +08:00
restartmanager unconvert: remove unnescessary conversions 2019-09-18 12:57:33 +02:00
rootless rootless: support --exec-opt native.cgroupdriver=systemd 2020-02-14 15:32:31 +09:00
runconfig pkg/sysinfo: rm duplicates 2020-06-26 16:19:52 -07:00
testutil Upgrading the versions of images in Dockerfile. 2020-06-30 12:24:06 +08:00
vendor Merge pull request #41249 from cpuguy83/swarm_caps 2020-07-28 01:07:49 +02:00
volume API: add "prune" events 2020-07-28 12:41:14 +02:00
.DEREK.yml Update .DEREK.yml 2019-05-06 13:27:04 -07:00
.dockerignore update .dockerignore to prevent '-unsupported' builds 2020-01-13 12:55:15 +01:00
.gitignore Use -X ldflags to set dockerversion package vars 2019-12-02 10:21:41 -08:00
.mailmap Update mailmap and authors 2019-09-30 19:12:18 +02:00
AUTHORS Update mailmap and authors 2019-09-30 19:12:18 +02:00
CHANGELOG.md Fix some typos 2018-09-07 13:13:47 +08:00
codecov.yml Add code coverage report and codecov config 2018-01-16 16:50:56 -05:00
CONTRIBUTING.md Update CONTRIBUTING.md to have an option to keep name anonymous if requested 2019-07-15 16:04:11 +02:00
Dockerfile Bump Golang 1.13.14 2020-07-17 15:17:15 +02:00
Dockerfile.buildx Bump Golang 1.13.14 2020-07-17 15:17:15 +02:00
Dockerfile.e2e Bump Golang 1.13.14 2020-07-17 15:17:15 +02:00
Dockerfile.simple Bump Golang 1.13.14 2020-07-17 15:17:15 +02:00
Dockerfile.windows Bump Golang 1.13.14 2020-07-17 15:17:15 +02:00
Jenkinsfile hack: add more debugging to understand exit codepath 2020-05-27 23:40:11 +00:00
LICENSE Update LICENSE 2018-09-12 14:27:53 +01:00
MAINTAINERS Add myself as a curator 2020-01-09 15:03:38 -05:00
Makefile Makefile: remove empty targets, and slight refactor 2020-05-01 16:48:07 +02:00
NOTICE switch kr/pty to creack/pty v1.1.7 2019-07-29 16:59:08 -07:00
poule.yml Poule: remove random assign 2019-09-05 20:57:17 +02:00
README.md Add "Lego set" back in README.md 2017-10-10 14:10:39 +00:00
ROADMAP.md Fix some typos in ROADMAP.md 2019-01-25 14:27:13 +08:00
SECURITY.md Update SECURITY.md to have an option to keep name anonymous if requested. 2019-06-18 16:37:16 +00:00
TESTING.md fix typos and grammar in docs 2020-06-26 17:30:59 -06:00
vendor.conf Merge pull request #41249 from cpuguy83/swarm_caps 2020-07-28 01:07:49 +02:00
VENDORING.md fix the bare url and the Summary of http://semver.org 2017-01-17 16:20:11 +08:00

The Moby Project

Moby Project logo

Moby is an open-source project created by Docker to enable and accelerate software containerization.

It provides a "Lego set" of toolkit components, the framework for assembling them into custom container-based systems, and a place for all container enthusiasts and professionals to experiment and exchange ideas. Components include container build tools, a container registry, orchestration tools, a runtime and more, and these can be used as building blocks in conjunction with other tools and projects.

Principles

Moby is an open project guided by strong principles, aiming to be modular, flexible and without too strong an opinion on user experience. It is open to the community to help set its direction.

  • Modular: the project includes lots of components that have well-defined functions and APIs that work together.
  • Batteries included but swappable: Moby includes enough components to build fully featured container system, but its modular architecture ensures that most of the components can be swapped by different implementations.
  • Usable security: Moby provides secure defaults without compromising usability.
  • Developer focused: The APIs are intended to be functional and useful to build powerful tools. They are not necessarily intended as end user tools but as components aimed at developers. Documentation and UX is aimed at developers not end users.

Audience

The Moby Project is intended for engineers, integrators and enthusiasts looking to modify, hack, fix, experiment, invent and build systems based on containers. It is not for people looking for a commercially supported system, but for people who want to work and learn with open source code.

Relationship with Docker

The components and tools in the Moby Project are initially the open source components that Docker and the community have built for the Docker Project. New projects can be added if they fit with the community goals. Docker is committed to using Moby as the upstream for the Docker Product. However, other projects are also encouraged to use Moby as an upstream, and to reuse the components in diverse ways, and all these uses will be treated in the same way. External maintainers and contributors are welcomed.

The Moby project is not intended as a location for support or feature requests for Docker products, but as a place for contributors to work on open source code, fix bugs, and make the code more useful. The releases are supported by the maintainers, community and users, on a best efforts basis only, and are not intended for customers who want enterprise or commercial support; Docker EE is the appropriate product for these use cases.


Legal

Brought to you courtesy of our legal counsel. For more context, please see the NOTICE document in this repo.

Use and transfer of Moby may be subject to certain restrictions by the United States and other governments.

It is your responsibility to ensure that your use and/or transfer does not violate applicable laws.

For more information, please see https://www.bis.doc.gov

Licensing

Moby is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.