testcontainersofficial/ryuk

Moby Ryuk

镜像概述和主要用途

Moby Ryuk是一个用于自动清理Docker资源的工具，能够在指定延迟后根据用户提供的过滤器删除容器、网络、卷和镜像。主要用于解决Docker资源泄露问题，适用于需要自动清理测试环境或临时资源的场景。

核心功能和特性

• 按过滤器删除资源：支持基于标签（label）、健康状态（health）等条件过滤需删除的资源
• 延迟删除机制：在连接关闭或指定时间后延迟执行删除操作
• TCP接口：通过TCP连接接收过滤器配置
• Docker兼容：可作为Docker容器运行，需挂载Docker socket以访问Docker引擎

使用场景和适用范围

• 自动化测试环境：测试完成后自动清理临时容器和网络
• CI/CD流水线：避免构建过程中Docker资源堆积
• 开发环境：防止调试过程中遗留未清理的Docker资源

使用方法和配置说明

启动方式

直接运行

bash
./bin/moby-ryuk -p 8080

Docker容器运行

bash
docker run -v /var/run/docker.sock:/var/run/docker.sock -p 8080:8080 quay.io/testcontainers/ryuk

说明：需挂载/var/run/docker.sock以允许Ryuk访问Docker引擎，映射端口8080用于TCP通信

连接与配置过滤器

1. 通过TCP连接

   bash
   nc localhost 8080
   

2. 发送过滤器
   连接后可发送一个或多个过滤器，每行一个过滤器，服务器返回ACK确认：

   label=testing=true&health=unhealthy
   ACK
   label=something
   ACK
   

3. 关闭连接
   关闭TCP连接后，Ryuk将在延迟后执行删除操作

4. 一次性发送过滤器
   通过管道一次性发送过滤器（无需保持连接）：

   bash
   printf "label=something_else" | nc localhost 8080
   

查看删除结果

操作完成后，Ryuk会在日志中输出删除结果，例如：

2018/01/15 18:38:52 Timed out waiting for connection
2018/01/15 18:38:52 Deleting {"label":{"something":true}}
2018/01/15 18:38:52 Deleting {"label":{"something_else":true}}
2018/01/15 18:38:52 Deleting {"health":{"unhealthy":true},"label":{"testing=true":true}}
2018/01/15 18:38:52 Removed 1 container(s), 0 network(s), 0 volume(s), 0 image(s)