git/gitflow/gitlib>> gitlab-runner-docker-cleanup>> 返回
项目作者： PengBAI

项目描述 ：
Project imported from gitlab to use docker hub auto build
高级语言： Go
项目地址: git://github.com/PengBAI/gitlab-runner-docker-cleanup.git
创建时间： 2018-10-12T15:34:29Z
项目社区：https://github.com/PengBAI/gitlab-runner-docker-cleanup
开源协议：MIT License
下载


Docker Hub

GitLab Runner Docker Cleanup

Project forked from gitlab-org/gitlab-runner-docker-cleanup. Thanks to the original project owner.

This is simple docker application that automatically garbage collects the GitLab Runner Caches and Images when running on low disk space. Same require features are implemented in this project.

New features:

  • Update go version to 1.9
  • Be able to define a protected internal images list in a file to prevent from removing, your builder image for example.
  • Support to remove multi-tag images

How to run it?

The tool requires access to Docker Engine.

By default the Docker Engine listens under /var/run/docker.sock

  1. docker run -d \
  2.     -e LOW_FREE_SPACE=10G \
  3.     -e EXPECTED_FREE_SPACE=20G \
  4.     -e LOW_FREE_FILES_COUNT=1048576 \
  5.     -e EXPECTED_FREE_FILES_COUNT=2097152 \
  6.     -e DEFAULT_TTL=10m \
  7.     -e USE_DF=1 \
  8.     --restart always \
  9.     -v /var/run/docker.sock:/var/run/docker.sock \
  10.     -v /etc/gitlab_runner_docker_cleanup_internal_images:/etc/gitlab_runner_docker_cleanup_internal_images \
  11.     --name=gitlab-runner-docker-cleanup \
  12.     pengbai/gitlab-runner-docker-cleanup

example of /etc/gitlab_runner_docker_cleanup_internal_images

  1. $ cat /etc/gitlab_runner_docker_cleanup_internal_images
  2. golang:l.8.4
  3. tutum/curl:alpine
  4. alpine:*

The above command will ensure to always have at least 10GB of free disk space and at least 1M of free files (i-nodes) on disk.

The i-nodes is especially important when using Docker with overlay storage engine.
More information about i-node problem here.

Options

You can configure GitLab Runner Docker Cleanup with environment variables:

Variable Default Description
CHECK_PATH / The path which is used when checking disk usage
LOW_FREE_SPACE 1GB When trigger the cache and image removal
EXPECTED_FREE_SPACE 2GB How much the free space to cleanup
LOW_FREE_FILES_COUNT 131072 When the number of free files (i-nodes) runs below this value trigger the cache and image removal
EXPECTED_FREE_FILES_COUNT 262144 How many free files (i-nodes) to cleanup
USE_DF true Use a command line df tool to check disk space. Set to false when connecting to remote Docker Engine. Set to true when using with locally installed Docker Engine
CHECK_INTERVAL 10s How often to check the disk space
RETRY_INTERVAL 30s How long to wait before retrying in case of failure
DEFAULT_TTL 1m Minimum time to preserve a newly downloaded images or created caches
ADDITIONAL_INTERNAL_IMAGES_FILE_PATH /etc/gitlab_runner_docker_cleanup_internal_images User defined images not to remove

Automated build

The image is automatically built by hub.docker.com.

To see a latest build status, go to:

Development

  1. Install Go Runtime, the 1.9.x is preferred

  2. Download the sources with dependencies:

  1. go get gitlab.com/gitlab-org/gitlab-runner-docker-cleanup
  1. Modifying sources and run tests:
  1. cd $GOPATH/src/gitlab.com/gitlab-org/gitlab-runner-docker-cleanup
  3. go test
  4. `

Author

Kamil Trzciński

Contributor

Peng BAI

License

MIT