Artifact Gateway 镜像文档

1. 镜像概述

Artifact Gateway 是一款轻量级制品网关服务，旨在为企业软件研发流程提供统一的制品管理与分发能力。该服务通过整合多类型制品仓库（如Maven、npm、Docker Registry等），简化跨仓库访问复杂度，同时提供缓存加速、安全管控和统一访问入口，有效提升制品分发效率与系统安全性。

2. 核心功能与特性

2.1 多类型仓库集成

• 支持主流制品仓库协议：Maven、npm、Docker Registry、PyPI、Helm Chart Repository
• 支持多仓库聚合配置，可同时连接内部私有仓库与外部公共仓库
• 自动路由机制，根据制品类型匹配对应上游仓库

2.2 智能缓存机制

• 实现制品自动缓存，减少重复下载，降低上游仓库带宽压力
• 可配置缓存策略：基于TTL（默认24小时）、空间配额（默认10GB）、制品热度的缓存淘汰机制
• 支持缓存预热与手动刷新功能

2.3 全面安全管控

• 基于RBAC模型的细粒度访问控制，支持按仓库/制品类型/用户组配置权限
• 集成企业级认证系统：LDAP/Active Directory、OAuth2/OIDC、API Key认证
• 完整审计日志：记录所有制品访问、上传、删除操作，支持日志导出与第三方SIEM集成

2.4 统一访问入口

• 提供标准化REST API与Web控制台，简化多仓库管理复杂度
• 单一域名/端口访问所有连接仓库，减少客户端配置成本
• 支持自定义域名与路径映射，适配企业现有URL规范

2.5 制品生命周期管理

• 制品元数据自动采集：版本信息、依赖关系、校验和、上传时间
• 支持制品标记（如"RELEASE"/"SNAPSHOT"）与生命周期状态管理
• 提供制品搜索功能，支持按名称、版本、仓库类型等多维度检索

3. 典型使用场景

3.1 企业内部制品共享平台

统一管理多团队私有仓库（如部门级Maven仓库、项目级npm仓库），实现跨团队制品共享，避免重复建设存储资源。

3.2 全球化研发协作加速

在多区域部署网关实例，通过跨区域缓存同步，解决跨国团队制品下载延迟问题，提升研发效率。

3.3 第三方制品统一管控

集中管理外部公共仓库（如Maven Central、npmjs.com）访问，实现第三方制品白名单控制，降低供应链安全风险。

3.4 DevOps流水线集成

作为CI/CD流水线的制品枢纽，为构建工具（Jenkins、GitLab CI）提供统一制品源，简化流水线配置，提升构建稳定性。

4. 快速使用指南

4.1 基本启动命令

bash
docker run -d \
  --name artifact-gateway \
  -p 8080:8080 \
  -e GATEWAY_PORT=8080 \
  -e ADMIN_USER=admin \
  -e ADMIN_PASSWORD=SecurePass123! \
  -v ./cache:/var/lib/artifact-gateway/cache \
  artifact-gateway:latest

4.2 环境变量配置说明

4.3 Docker Compose部署示例

yaml
version: '3.8'

services:
  artifact-gateway:
    image: artifact-gateway:latest
    container_name: artifact-gateway
    restart: always
    ports:
      - "8080:8080"
    environment:
      - GATEWAY_PORT=8080
      - ADMIN_USER=admin
      - ADMIN_PASSWORD=${GATEWAY_ADMIN_PASSWORD}
      - MAX_CACHE_SIZE_GB=20
      - LOG_LEVEL=INFO
      - SECURITY_ENABLED=true
    volumes:
      - gateway-cache:/var/lib/artifact-gateway/cache
      - gateway-config:/etc/artifact-gateway
    networks:
      - devops-network

networks:
  devops-network:
    driver: bridge

volumes:
  gateway-cache:
  gateway-config:

5. 详细配置指南

5.1 仓库配置方法

通过Web控制台或API添加仓库配置，以下为典型Maven仓库配置示例：

bash
# 添加Maven中央仓库
curl -X POST http://localhost:8080/api/v1/repositories \
  -u admin:SecurePass123! \
  -H "Content-Type: application/json" \
  -d '{
    "name": "maven-central",
    "type": "maven",
    "url": "[***]",
    "cacheEnabled": true,
    "cacheTTL": 48,
    "priority": 1,
    "authType": "none"
  }'

5.2 仓库配置参数说明

5.3 高可用部署建议

• 多实例部署：通过负载均衡器（如NGINX、HAProxy）实现多实例集群，避免单点故障
• 数据持久化：缓存目录与配置文件必须通过Docker卷挂载，确保容器重启后数据不丢失
• 外部数据库：生产环境建议使用外部MySQL/PostgreSQL存储元数据，替代默认嵌入式数据库
• 监控集成：配置Prometheus指标暴露（默认端口9090），结合Grafana实现性能监控与告警

6. 注意事项

• 首次启动需至少配置一个上游仓库，否则网关无法提供制品服务
• 生产环境必须修改默认管理员密码，并通过SECURITY_ENABLED=true启用安全功能
• 高并发场景下建议调整JVM参数（如-e JAVA_OPTS="-Xms2g -Xmx4g"）
• 缓存目录空间需根据实际制品数量规划，建议不小于20GB
• 建议通过反向代理（如NGINX）配置HTTPS，避免明文传输敏感认证信息