• This repository has been archived on 02/Feb/2021
  • Stars
    star
    5,068
  • Rank 7,770 (Top 0.2 %)
  • Language
    Shell
  • License
    Apache License 2.0
  • Created almost 10 years ago
  • Updated about 3 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

INACTIVE: Docker garbage collection of containers and images

docker-gc

Build Status License

Status: mature

We're not developing or accepting new features.

Consider using docker system prune instead.

A simple Docker container and image garbage collection script.

  • Containers that exited more than an hour ago are removed.
  • Images that don't belong to any remaining container after that are removed.
  • Optionally, remove volumes that are not associated to any remaining container after removal (Available only for docker >= 1.9.0)

Although docker normally prevents removal of images that are in use by containers, we take extra care to not remove any image tags (e.g., ubuntu:14.04, busybox, etc) that are in use by containers. A naive docker rmi $(docker images -q) will leave images stripped of all tags, forcing docker to re-pull the repositories when starting new containers even though the images themselves are still on disk.

This script is intended to be run as a cron job, but you can also run it as a Docker container (see below).

Building the Debian Package

sudo apt-get install git devscripts debhelper build-essential dh-make
git clone https://github.com/spotify/docker-gc.git
cd docker-gc
debuild -us -uc -b

If you get lintian errors during debuild, try debuild --no-lintian -us -uc -b.

Installing the Debian Package

sudo dpkg -i ../docker-gc_0.1.0_all.deb

This installs the docker-gc script into /usr/sbin. If you want it to run as a cron job, you can configure it now by creating a root-owned executable file /etc/cron.hourly/docker-gc with the following contents:

#!/bin/bash
/usr/sbin/docker-gc

To test that the job will actually run you can use this command

run-parts --test /etc/cron.hourly

Manual Usage

To use the script manually, run docker-gc. The system user under which docker-gc runs needs to have read and write access to the $STATE_DIR environment variable which defaults to /var/lib/docker-gc.

Excluding Images From Garbage Collection

There can be images that are large that serve as a common base for many application containers, and as such, make sense to pin to the machine, as many derivative containers will use it. This can save time in pulling those kinds of images. There may be other reasons to exclude images from garbage collection. To do so, create /etc/docker-gc-exclude, or if you want the file to be read from elsewhere, set the EXCLUDE_FROM_GC environment variable to its location. This file can contain image name patterns (in the grep sense), one per line, such as spotify/cassandra:latest or it can contain image ids (truncated to the length shown in docker images which is 12.

An example image excludes file might contain:

spotify/cassandra:latest
redis:.*
9681260c3ad5

Excluding Containers From Garbage Collection

There can also be containers (for example data only containers) which you would like to exclude from garbage collection. To do so, create /etc/docker-gc-exclude-containers, or if you want the file to be read from elsewhere, set the EXCLUDE_CONTAINERS_FROM_GC environment variable to its location. This file should contain name patterns (in the grep sense), one per line, such as mariadb-data.

An example container excludes file might contain:

mariadb-data
drunk_goodall

Excluding Volumes From Garbage Collection

There can be occasions where you don't want to remove a dangling volume. To enable this functionality you can create a file named /etc/docker-gc-exclude-volumes (or specify EXCLUDE_VOLUMES_IDS_FILE env var with any path for such file), containing name patterns (in the grep sense), one per line, of volumes that will be excluded from garbage collection.

Forcing deletion of images that have multiple tags

By default, docker will not remove an image if it is tagged in multiple repositories. If you have a server running docker where this is the case, for example in CI environments where dockers are being built, re-tagged, and pushed, you can enable a force flag to override this default.

FORCE_IMAGE_REMOVAL=1 docker-gc

Preserving a minimum number of images for every repository

You might want to always keep a set of the most recent images for any repository. For example, if you are continually rebuilding an image during development you would want to clear out all but the most recent version of an image. To do so, set the MINIMUM_IMAGES_TO_SAVE=1 environment variable. You can preserve any count of the most recent images, e.g. save the most recent 10 with MINIMUM_IMAGES_TO_SAVE=10.

Forcing deletion of containers

By default, if an error is encountered when cleaning up a container, Docker will report the error back and leave it on disk. This can sometimes lead to containers accumulating. If you run into this issue, you can force the removal of the container by setting the environment variable below:

FORCE_CONTAINER_REMOVAL=1 docker-gc

Excluding Recently Exited Containers and Images From Garbage Collection

By default, docker-gc will not remove a container if it exited less than 3600 seconds (1 hour) ago. In some cases you might need to change this setting (e.g. you need exited containers to stick around for debugging for several days). Set the GRACE_PERIOD_SECONDS variable to override this default.

GRACE_PERIOD_SECONDS=86400 docker-gc

This setting also prevents the removal of images that have been created less than GRACE_PERIOD_SECONDS seconds ago.

Dry run

By default, docker-gc will proceed with deletion of containers and images. To test your command-line options set the DRY_RUN variable to override this default.

DRY_RUN=1 docker-gc

Running as a Docker Image

A Dockerfile is provided as an alternative to a local installation. By default the container will start up, run a single garbage collection, and shut down.

The image is published as spotify/docker-gc.

Building the Docker Image

The image is currently built with Docker 17.09.0-ce, but to build it against a newer Docker version (to ensure that the API version of the command-line interface matches with your Docker daemon), simply edit the ENV DOCKER_VERSION line in Dockerfile prior to the build step below.

Build the Docker image with make -f Makefile.docker image or:

docker build -t spotify/docker-gc .

Running as a Docker Container

The docker-gc container requires access to the docker socket in order to function, so you need to map it when running, e.g.:

docker run --rm --privileged -v /var/run/docker.sock:/var/run/docker.sock -v /etc:/etc:ro spotify/docker-gc

The /etc directory is also mapped so that it can read any exclude files that you've created.

If you want to remove volumes, you can do so by passing REMOVE_VOLUMES env var set to 1.

$ docker run --rm -v /var/run/docker.sock:/var/run/docker.sock -v /etc:/etc -e REMOVE_VOLUMES=1 spotify/docker-gc

If you want to remove volumes only for a specified driver, you can do it by passing VOLUME_DELETE_ONLY_DRIVER env var set to the driver name.

If your docker daemon is configured to run with user namespace, you will need to run the container with user namespace disabled:

docker run --rm --userns host -v /var/run/docker.sock:/var/run/docker.sock -v /etc:/etc spotify/docker-gc

More Repositories

1

luigi

Luigi is a Python module that helps you build complex pipelines of batch jobs. It handles dependency resolution, workflow management, visualization etc. It also comes with Hadoop support built in.
Python
17,089
star
2

annoy

Approximate Nearest Neighbors in C++/Python optimized for memory usage and loading/saving to disk
C++
12,458
star
3

pedalboard

๐ŸŽ› ๐Ÿ”Š A Python library for audio.
C++
4,811
star
4

chartify

Python library that makes it easy for data scientists to create charts.
Python
3,447
star
5

basic-pitch

A lightweight yet powerful audio-to-MIDI converter with pitch bend detection
Python
2,818
star
6

dockerfile-maven

MATURE: A set of Maven tools for dealing with Dockerfiles
Java
2,730
star
7

docker-maven-plugin

INACTIVE: A maven plugin for Docker
Java
2,652
star
8

scio

A Scala API for Apache Beam and Google Cloud Dataflow.
Scala
2,485
star
9

helios

Docker container orchestration platform
Java
2,097
star
10

web-api-examples

Basic examples to authenticate and fetch data using the Spotify Web API
HTML
1,889
star
11

HubFramework

DEPRECATED โ€“ Spotifyโ€™s component-driven UI framework for iOS
Objective-C
1,864
star
12

apollo

Java libraries for writing composable microservices
Java
1,648
star
13

dh-virtualenv

Python virtualenvs in Debian packages
Python
1,590
star
14

docker-client

INACTIVE: A simple docker client for the JVM
Java
1,425
star
15

docker-kafka

Kafka (and Zookeeper) in Docker
Shell
1,400
star
16

SPTPersistentCache

Everyone tries to implement a cache at some point in their iOS appโ€™s lifecycle, and this is ours.
Objective-C
1,244
star
17

mobius

A functional reactive framework for managing state evolution and side-effects.
Java
1,205
star
18

sparkey

Simple constant key/value storage library, for read-heavy systems with infrequent large bulk inserts.
C
1,143
star
19

ruler

Gradle plugin which helps you analyze the size of your Android apps.
Kotlin
1,100
star
20

voyager

๐Ÿ›ฐ๏ธ Voyager is an approximate nearest-neighbor search library for Python and Java with a focus on ease of use, simplicity, and deployability.
C++
1,090
star
21

XCMetrics

XCMetrics is the easiest way to collect Xcode build metrics and improve developer productivity.
Swift
1,074
star
22

web-api

This issue tracker is no longer used. Join us in the Spotify for Developers forum for support with the Spotify Web API โžก๏ธ https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer
RAML
981
star
23

echoprint-codegen

Codegen for Echoprint
C++
948
star
24

snakebite

A pure python HDFS client
Python
859
star
25

heroic

The Heroic Time Series Database
Java
843
star
26

klio

Smarter data pipelines for audio.
Python
827
star
27

XCRemoteCache

Swift
815
star
28

apps-tutorial

A Spotify App that contains working examples of the use of Spotify Apps API
627
star
29

SPTDataLoader

The HTTP library used by the Spotify iOS client
Objective-C
624
star
30

ios-sdk

Spotify SDK for iOS
Objective-C
609
star
31

postgresql-metrics

Tool that extracts and provides metrics on your PostgreSQL database
Python
584
star
32

JniHelpers

Tools for writing great JNI code
C++
584
star
33

reactochart

๐Ÿ“ˆ React chart component library ๐Ÿ“‰
JavaScript
548
star
34

Mobius.swift

A functional reactive framework for managing state evolution and side-effects [Swift implementation]
Swift
540
star
35

dockerfile-mode

An emacs mode for handling Dockerfiles
Emacs Lisp
520
star
36

threaddump-analyzer

A JVM threaddump analyzer
JavaScript
482
star
37

featran

A Scala feature transformation library for data science and machine learning
Scala
467
star
38

android-sdk

Spotify SDK for Android
HTML
440
star
39

echoprint-server

Server for the Echoprint audio fingerprint system
Java
398
star
40

web-scripts

DEPRECATED: A collection of base configs and CLI wrappers used to speed up development @ Spotify.
TypeScript
382
star
41

completable-futures

Utilities for working with futures in Java 8
Java
378
star
42

SpotifyLogin

Swift framework for authenticating with the Spotify API
Swift
344
star
43

ratatool

A tool for data sampling, data generation, and data diffing
Scala
334
star
44

fmt-maven-plugin

Opinionated Maven Plugin that formats your Java code.
Java
299
star
45

big-data-rosetta-code

Code snippets for solving common big data problems in various platforms. Inspired by Rosetta Code
Scala
286
star
46

trickle

A small library for composing asynchronous code
Java
284
star
47

coordinator

A visual interface for turning an SVG into XY coรถrdinates.
HTML
282
star
48

pythonflow

๐Ÿ Dataflow programming for python.
Python
279
star
49

styx

"The path to execution", Styx is a service that schedules batch data processing jobs in Docker containers on Kubernetes.
Java
267
star
50

cstar

Apache Cassandra cluster orchestration tool for the command line
Python
254
star
51

netty-zmtp

A Netty implementation of ZMTP, the ZeroMQ Message Transport Protocol.
Java
242
star
52

ios-style

Guidelines for iOS development in use at Spotify
240
star
53

cassandra-reaper

Software to run automated repairs of cassandra
235
star
54

confidence

Python
232
star
55

spotify-web-api-ts-sdk

A Typescript SDK for the Spotify Web API with types for returned data.
TypeScript
231
star
56

docker-cassandra

Cassandra in Docker with fast startup
Shell
219
star
57

terraform-gke-kubeflow-cluster

Terraform module for creating GKE clusters to run Kubeflow
HCL
209
star
58

dns-java

DNS wrapper library that provides SRV lookup functionality
Java
203
star
59

linux

Spotify's Linux kernel for Debian-based systems
C
203
star
60

git-test

test your commits
Shell
202
star
61

SPStackedNav

[DEPRECATED] Navigation controller which represents its content in stacks of panes, rather than one at a time
Objective-C
195
star
62

basic-pitch-ts

A lightweight yet powerful audio-to-MIDI converter with pitch bend detection.
TypeScript
194
star
63

quickstart

A CommonJS module resolver, loader and compiler for node.js and browsers.
JavaScript
193
star
64

spotify-json

Fast and nice to use C++ JSON library.
C++
190
star
65

dbeam

DBeam exports SQL tables into Avro files using JDBC and Apache Beam
Java
181
star
66

flink-on-k8s-operator

Kubernetes operator for managing the lifecycle of Apache Flink and Beam applications.
Go
178
star
67

bazel-tools

Tools for dealing with very large Bazel-managed repositories
Java
165
star
68

lingon

A user friendly tool for building single-page JavaScript applications
JavaScript
162
star
69

dataenum

Algebraic data types in Java.
Java
159
star
70

magnolify

A collection of Magnolia add-on modules
Scala
157
star
71

async-google-pubsub-client

[SUNSET] Async Google Pubsub Client
Java
156
star
72

gcp-audit

A tool for auditing security properties of GCP projects.
Python
156
star
73

spark-bigquery

Google BigQuery support for Spark, SQL, and DataFrames
Scala
154
star
74

flo

A lightweight workflow definition library
Java
146
star
75

folsom

An asynchronous memcache client for Java
Java
143
star
76

should-up

Remove most of the "should" noise from your tests
JavaScript
143
star
77

missinglink

Build time tool for detecting link problems in java projects
Java
142
star
78

zoltar

Common library for serving TensorFlow, XGBoost and scikit-learn models in production.
Java
141
star
79

android-auth

Spotify authentication and authorization for Android. Part of the Spotify Android SDK.
HTML
139
star
80

proto-registry

An implementation of the Protobuf Registry API
TypeScript
139
star
81

futures-extra

Java library for working with Guava futures
Java
136
star
82

annoy-java

Approximate nearest neighbors in Java
Java
134
star
83

spydra

Ephemeral Hadoop clusters using Google Compute Platform
Java
132
star
84

spotify-tensorflow

Provides Spotify-specific TensorFlow helpers
Python
124
star
85

docker-stress

Simple docker stress test and monitoring tools
Python
124
star
86

spotify-web-playback-sdk-example

React based example app that creates a new player in Spotify Connect to play music from in the browse using Spotify Web Playback SDK.
JavaScript
120
star
87

crtauth

a public key backed client/server authentication system
Python
118
star
88

redux-location-state

Utilities for reading & writing Redux store state to & from the URL
JavaScript
118
star
89

sparkey-java

Java implementation of the Sparkey key value store
Java
117
star
90

rspec-dns

Easily test your DNS with RSpec
Ruby
108
star
91

web-playback-sdk

This issue tracker is no longer used. Join us in the Spotify for Developers forum for support with the Spotify Web Playback SDK โžก๏ธ https://community.spotify.com/t5/Spotify-for-Developers/bd-p/Spotify_Developer
108
star
92

ffwd-ruby

An event and metrics fast-forwarding agent.
Ruby
106
star
93

realbook

Easier audio-based machine learning with TensorFlow.
Python
106
star
94

github-java-client

A Java client to Github API
Java
105
star
95

gimme

Creating time bound IAM Conditions with ease and flair
Python
103
star
96

super-smash-brogp

Sends and withdraws BGP prefixes for fun.
Python
98
star
97

lighthouse-audit-service

TypeScript
93
star
98

noether

Scala Aggregators used for ML Model metrics monitoring
Scala
91
star
99

python-graphwalker

Python re-implementation of the graphwalker testing tool
Python
90
star
100

spotify-js-challenge

JavaScript
87
star