devopshq/artifactory-cleanup

JFrog Artifactory 清理工具镜像

概述

本镜像提供了一个用于JFrog Artifactory的自动化清理工具，旨在帮助用户清理Artifactory中的冗余资源（如旧版本构建产物、未使用的包等），有效管理存储空间并优化资源利用效率。项目源代码及详细说明请参见：https://github.com/devopshq/artifactory-cleanup%E3%80%82

核心功能与特性

• 自动化清理：支持定时或触发式清理操作，减少手动干预成本
• 灵活的清理策略：可配置多种清理规则（如基于资源年龄、版本数量、下载频率等）
• 安全验证机制：提供预览模式（Dry Run），清理前可验证规则效果，避免误删关键资源
• 易于集成：可与CI/CD流程、定时任务工具（如Cron）或容器编排平台（如Kubernetes）无缝集成
• 轻量高效：镜像体积小巧，资源占用低，适合在各类环境中部署运行

使用场景

• Artifactory存储容量持续增长，需定期释放存储空间
• 需删除过期快照版本、旧构建产物或长期未使用的资源
• 企业级Artifactory实例需标准化资源清理流程，确保合规性
• 开发/测试环境中自动清理临时构建产物，保持环境整洁

使用方法与配置说明

基本使用（Docker Run）

bash
docker run -it --rm \
  -e ARTIFACTORY_URL="https://your-artifactory.example.com" \
  -e ARTIFACTORY_API_KEY="your-artifactory-api-key" \
  -e CLEANUP_RULES="keep_last=10;min_age_days=30;repos=generic-local,maven-snapshots" \
  devopshq/artifactory-cleanup

关键配置参数（环境变量）

清理规则详解（CLEANUP_RULES）

支持以下规则键值对（多规则用;分隔）：

• keep_last=<num>: 保留每个资源的最新<num>个版本
• min_age_days=<days>: 仅清理创建时间超过<days>天的资源
• max_age_days=<days>: 强制清理创建时间超过<days>天的资源（覆盖keep_last）
• repos=<repo1>,<repo2>: 指定需清理的仓库列表（默认清理所有仓库）
• exclude=<pattern>: 排除符合<pattern>（支持通配符*）的资源
• include=<pattern>: 仅清理符合<pattern>（支持通配符*）的资源

定时清理配置（Docker Compose示例）

yaml
version: '3'
services:
  artifactory-cleanup:
    image: devopshq/artifactory-cleanup
    environment:
      - ARTIFACTORY_URL=https://artifactory.example.com
      - ARTIFACTORY_API_KEY=${ARTIFACTORY_API_KEY}
      - CLEANUP_RULES=keep_last=5;min_age_days=30;repos=maven-snapshots,npm-snapshots
      - DRY_RUN=false
      - LOG_LEVEL=info
    restart: always
    # 如需定时运行，可结合外部定时任务工具（如cron）或使用Kubernetes CronJob

注意事项

1. 权限验证：确保API密钥拥有目标仓库的删除权限（建议使用最小权限原则）
2. 规则测试：首次使用时建议启用DRY_RUN=true验证清理规则，确认无误后再执行实际清理
3. 数据备份：重要生产环境建议在清理前对关键资源进行备份
4. 版本兼容性：请确认镜像版本与Artifactory实例版本兼容（参考GitHub仓库说明）