# gitlab-janitor

GitLab Janitor is a tool to automatically manage stalled containers when using Docker.

Commain line options and default valuee:

```bash
$ ./gitlab-janitor.rb --help

Usage: gitlab-janitor.rb [options] 
        --clean-delay=30m            Delay between clean operation ENV[CLEAN_DELAY]
        --include=*units*            <List> Include container for removal. ENV[INCLUDE]
        --exclude=*gitlab*           <List> Exclude container from removal by name. ENV[EXCLUDE]
        --container-deadline=1s      Maximum container run duration. ENV[CONTAINER_DEADLINE]
        --volume-deadline=2d6h       Maximum volume life dudation. ENV[VOLUME_DEADLINE]
        --image-deadline=20d         Maximum image life duration. ENV[IMAGE_DEADLINE]
        --remove                     Real remove instead of dry run. ENV[REMOVE]
        --docker=unix:///var/run/docker.sock
                                     Docker api endpoint. ENV[DOCKER_HOST]
```


## Удаление зависших контейнеров

Порядок определения контейнреов для удаления:

- `include=*units*` - в список на удаление включаются контейнеры удовлетворябющие шаблону;
- `exclude=*gitlab*` - из спсика исключаются контейнеры по шаблону;
- `container-deadline=[1h10m]` - результирующий список проверяется на длительность запуска контенйра;

## Удаление ненужных volumes

Порядок определения вольюмов для удалени:

- на удаление попадают только вольюмы, не являющиеся именованными;
- `volume-deadline=[2d6h]` - результирующий список проверяется на длительность существования вольюма;

## Удаление образов

Docker не сохраняет временную метку образа при скачивании (pull), там образом используя средства Docker API невозможно понять как давно образ был скачан и когда его поря удалять. Для решения этой задачи сервис сохраняет информацию о скачанных образах, отслеживая там образом интервалы устаревания.

Порядок определения образов для удалени:

- на удаление попадают только образы, не имеющие тэг `latest`;
- `image-deadline=[20d]` - результирующий список проверяется на длительность существования образа;


## Пример запуска

```bash
REMOVE=true INCLUDE="*integr*, *units*" EXCLUDE="*gitlab*" CONTAINER_DEADLINE="1h10m" VOLUME_DEADLINE="3d" IMAGE_DEADLINE="20d" ./main.rb
```