goharbor/harbor-acceld

Acceleration Service

概述和主要用途

Acceleration Service 是为 Harbor 提供的通用服务，具备自动将用户镜像转换为加速镜像的能力。当用户执行镜像推送等操作时，Harbor 会通过集成的 https://github.com/dragonflyoss/image-service%E3%80%81https://github.com/containerd/stargz-snapshotter 等驱动，请求该服务完成相应的镜像转换。

https://github.com/goharbor/acceleration-service/actions/workflows/integration-test.yml/badge.svg?branch=main](https://github.com/goharbor/acceleration-service/actions/workflows/integration-test.yml) https://github.com/goharbor/acceleration-service/actions/workflows/concurrent-test.yml/badge.svg?branch=main](https://github.com/goharbor/acceleration-service/actions/workflows/concurrent-test.yml) https://github.com/goharbor/acceleration-service/actions/workflows/webhook-test.yml/badge.svg?branch=main](https://github.com/goharbor/acceleration-service/actions/workflows/webhook-test.yml)

更多详情参见 设计文档。

核心功能和特性

• 多加速器支持：集成 Nydus、eStargz、zstdchunked 等多种镜像加速驱动
• HTTP 服务能力：通过 acceld 守护进程提供 HTTP 服务，处理来自 Harbor 或 accelctl 的镜像转换请求
• CLI 管理工具：提供 accelctl 命令行工具，支持管理 acceld 服务及执行一次性镜像转换

使用场景和适用范围

适用于与 Harbor 容器镜像仓库集成，在用户推送镜像后自动触发加速转换，或通过手动请求/CLI 工具触发转换，满足容器镜像拉取加速需求，提升镜像分发效率。

详细使用方法和配置说明

快速开始

获取 Harbor

若本地未部署 Harbor 服务，请参考 Harbor 官方文档 进行部署。

从发布页面获取二进制文件

当前 Acceleration Service 包含以下工具：

• acceld：作为 HTTP 服务守护进程，处理来自 Harbor 或 accelctl 的镜像转换请求
• accelctl：CLI 工具，用于管理加速服务（acceld）及执行一次性镜像转换

从 https://github.com/goharbor/acceleration-service/releases/latest 获取 accelctl 和 acceld 二进制文件。

配置

配置 Harbor

1. 登录 Harbor Web 界面。

2. 选择一个项目，添加新的 Webhook 配置，填写以下字段：

   • 通知类型：选择 HTTP
   • 事件类型：启用 "artifact pushed"（镜像推送）
   • 端点 URL：<加速服务地址>/api/v1/conversions
   • 认证头：<加速服务配置的认证头>

   注意：Webhook 可帮助加速服务自动转换镜像。也可通过手动发送 HTTP 请求或使用 accelctl 触发镜像转换任务。

3. 创建系统机器人账户，填写以下字段：

   • 过期时间：<自定义>
   • 重置权限：勾选 "Push Artifact"（推送镜像）、"Pull Artifact"（拉取镜像）、"Create Tag"（创建标签）

   获取机器人账户 robot$<robot-name> 后，复制密钥并生成 base64 编码的认证字符串，命令如下：

   bash
   $ echo -n '<robot-name>:<robot-secret>' | base64
   

   注意：编码后的认证字符串将用于下一步配置加速服务。

配置加速服务

1. 复制 https://github.com/goharbor/acceleration-service/tree/main/misc/config%E3%80%82
2. 修改配置文件：
   • 将 provider.source 改为 Harbor 服务主机名，auth 和 webhook.auth_header 需配置为上述步骤生成的认证信息
   • 根据需求修改 converter.driver 字段中的设置

   请参考模板配置文件中的注释进行配置。

使用加速服务转换镜像

通过 acceld 服务转换

1. 在配置文件目录启动 acceld 守护进程：

   bash
   $ ./acceld --config ./config.yaml
   

2. 触发镜像转换：

   • 推送镜像触发 Webhook：

   bash
   $ docker push <harbor服务地址>/library/nginx:latest
   

   • 通过 accelctl 手动触发（确保源 OCI v1 镜像已存在于 Harbor 仓库）：

   bash
   $ ./accelctl task create <harbor服务地址>/library/nginx:latest
   

   • 通过 curl 发送 HTTP 请求触发（参考 开发文档）：

   bash
   $ curl --location 'http://<加速服务地址>/api/v1/conversions?sync=$snyc' \
       --header 'Content-Type: application/json' \
       --data '{
           "type": "PUSH_ARTIFACT",
           "event_data": {
               "resources": [
                   {
                       "resource_url": "<harbor服务地址>/dfns/alpine:latest"
                   }
               ]
           }
       }
       '
   

一次性模式转换

一次性模式无需启动 acceld 服务，直接通过 accelctl 完成转换：

bash
$ ./accelctl convert --config ./config.yaml 192.168.1.1/library/nginx:latest

INFO[2022-01-28T03:39:28.039029557Z] 拉取镜像 192.168.1.1/library/nginx:latest     module=converter
INFO[2022-01-28T03:39:28.075375146Z] 拉取完成 192.168.1.1/library/nginx:latest      module=converter
INFO[2022-01-28T03:39:28.075530522Z] 开始转换镜像 192.168.1.1/library/nginx:latest  module=converter
INFO[2022-01-28T03:39:29.561103924Z] 转换完成 192.168.1.1/library/nginx:latest-nydus  module=converter
INFO[2022-01-28T03:39:29.561197593Z] 推送镜像 192.168.1.1/library/nginx:latest-nydus  module=converter
INFO[2022-01-28T03:39:29.587585066Z] 推送完成 192.168.1.1/library/nginx:latest-nydus  module=converter

检查转换后的镜像

转换后的镜像与源 OCI 镜像位于同一仓库，两者标签后缀不同，可通过 Harbor Web 界面或 docker pull 命令查看。

相关文档

• 开发文档
• 垃圾回收