crazymax/artifactory-cleanup

artifactory-cleanup Docker镜像文档

镜像概述

artifactory-cleanup镜像是一个专为JFrog Artifactory设计的制品清理工具，通过高级配置执行制品清理操作，帮助用户有效管理Artifactory存储空间，自动删除过期或不再需要的制品。

核心功能与特性

• 自定义清理规则：支持根据制品年龄、大小、版本号等多维度条件筛选待清理制品
• 灵活保留策略：可配置保留最新N个版本、特定标签或满足自定义条件的制品
• 多仓库支持：支持同时对多个Artifactory仓库执行清理操作
• 预览模式：提供干运行（Dry Run）功能，可在实际删除前预览清理结果
• 安全认证：通过API密钥实现与Artifactory的安全通信
• 详细日志：提供不同级别日志输出，便于监控和问题排查

使用场景与适用范围

• 定期清理Artifactory中的过期构建制品，释放存储空间
• 管理测试环境中的临时制品，避免存储资源浪费
• 遵循企业数据保留政策，自动删除超过保留期限的制品
• 维护仓库整洁，提升Artifactory性能和管理效率

使用方法与配置说明

基本使用（Docker Run）

bash
docker run -d \
  --name artifactory-cleanup \
  -e ARTIFACTORY_URL="https://your-artifactory-instance.example.com" \
  -e ARTIFACTORY_API_KEY="your-secure-api-key" \
  -e CLEANUP_RULES='[{"repo":"maven-snapshots","age":14,"keepLatest":5}]' \
  crazy-max/artifactory-cleanup

环境变量配置

清理规则配置示例

清理规则是一个JSON数组，每个规则对象可包含以下字段：

json
[
  {
    "repo": "maven-snapshots",          // 目标仓库名称
    "age": 14,                          // 制品最大保留天数（超过此天数将被清理）
    "keepLatest": 5,                    // 保留最新的5个版本
    "exclude": ["*.md5", "*.sha1"],     // 排除匹配的文件
    "include": ["com/example/*"]        // 仅包含匹配的路径
  },
  {
    "repo": "docker-prod",
    "age": 90,
    "keepTags": ["latest", "stable"],   // 保留指定标签的制品
    "minSize": 1048576                  // 仅清理大于1MB的制品（字节）
  }
]

Docker Compose配置示例

yaml
version: '3.8'

services:
  artifactory-cleanup:
    image: crazy-max/artifactory-cleanup
    container_name: artifactory-cleanup
    environment:
      - ARTIFACTORY_URL=https://artifactory.example.com
      - ARTIFACTORY_API_KEY=your-api-key-here
      - SCHEDULE=0 3 * * *  # 每天凌晨3点执行
      - DRY_RUN=false
      - LOG_LEVEL=info
      - CLEANUP_RULES=[
          {"repo":"npm-dev","age":30,"keepLatest":10},
          {"repo":"docker-test","age":7,"keepTags":["dev-latest"]}
        ]
    restart: unless-stopped

注意事项

• 首次使用建议启用DRY_RUN=true验证清理规则效果
• 确保API密钥具有足够权限（至少需要删除制品的权限）
• 复杂规则建议先在测试环境验证，避免误删重要制品
• 详细文档和更多配置选项请参考https://github.com/crazy-max/artifactory-cleanup