docker/artifactory-agent 镜像文档

1. 镜像概述与主要用途

docker/artifactory-agent 是一款用于集成 JFrog Artifactory（及 JFrog Container Registry）与 Docker Scout 的服务型镜像。其核心定位是作为两者之间的桥梁，主要用途为：索引 JFrog Artifactory 中存储的容器镜像，并将镜像元数据（如版本信息、依赖关系、构建详情等）上传至 Docker Scout 平台，实现镜像管理与安全分析工具的无缝协同。

2. 核心功能与特性

• 镜像索引能力：深度扫描 JFrog Artifactory 或 JFrog Container Registry 中的容器镜像仓库，自动发现并索引镜像资源。
• 元数据同步：提取镜像的关键元数据（包括但不限于标签、digest、构建历史、层信息），并上传至 Docker Scout。
• 多平台支持：兼容 JFrog Artifactory 与 JFrog Container Registry 两种镜像存储方案。
• Docker Scout 集成：原生支持与 Docker Scout 的数据交互，无需额外适配层。

3. 使用场景与适用范围

使用场景

• 企业级容器镜像管理：当用户采用 JFrog Artifactory 作为私有镜像仓库，并希望通过 Docker Scout 进行镜像安全扫描、合规性检查或供应链分析时。
• 自动化元数据同步：需定期将 Artifactory 中的镜像变更（如新镜像推送、版本更新）同步至 Docker Scout，确保分析数据实时性的场景。

适用范围

• 用户环境：已部署 JFrog Artifactory 或 JFrog Container Registry，并需接入 Docker Scout 的容器化环境。
• 权限要求：运行该 agent 的环境需具备 Artifactory 镜像仓库的读取权限，以及 Docker Scout 的数据写入权限。

4. 使用方法与配置说明

4.1 前提条件

• 已部署 JFrog Artifactory/JFrog Container Registry 实例，且网络可访问。
• 已获取 Docker Scout 认证令牌（可通过 Docker Hub 或 Scout 控制台生成）。
• 已准备 Artifactory API 密钥（需具备镜像仓库的读取权限）。

4.2 部署示例

4.2.1 单容器部署（docker run）

通过 docker run 命令快速启动 agent，需指定必要的环境变量配置：

bash
docker run -d \
  --name artifactory-agent \
  -e ARTIFACTORY_URL="[***]" \
  -e ARTIFACTORY_API_KEY="your-artifactory-api-key" \
  -e DOCKER_SCOUT_TOKEN="your-docker-scout-token" \
  -e ARTIFACTORY_REPO_FILTER="docker-local,oci-local"  # 可选，指定需索引的仓库
  docker/artifactory-agent

4.2.2 编排部署（docker-compose）

创建 docker-compose.yml 文件，定义服务配置：

yaml
version: '3.8'
services:
  artifactory-agent:
    image: docker/artifactory-agent
    container_name: artifactory-agent
    restart: unless-stopped
    environment:
      # 必需配置
      - ARTIFACTORY_URL=[***]
      - ARTIFACTORY_API_KEY=your-artifactory-api-key
      - DOCKER_SCOUT_TOKEN=your-docker-scout-token
      # 可选配置
      - ARTIFACTORY_REPO_FILTER=docker-local,oci-local  # 过滤需索引的仓库
      - SYNC_INTERVAL=60  # 同步间隔（分钟），默认30
      - LOG_LEVEL=info  # 日志级别：info/warn/debug
    logging:
      driver: "json-file"
      options:
        max-size: "10m"
        max-file: "3"

启动服务：

bash
docker-compose up -d

4.3 核心配置参数（环境变量）

4.4 部署验证

部署后，通过容器日志确认运行状态：

bash
docker logs artifactory-agent

若日志显示 Successfully connected to Artifactory 和 Metadata sync to Docker Scout completed 等信息，表明 agent 运行正常。

5. 参考文档

完整配置说明、高级功能（如自定义同步策略、权限细粒度控制）及故障排查，请参考***文档：
Artifactory 集成（Docker Scout 文档）