预热

可以使用两种方式预热，一种是通过 Open API 预热，一种是通过控制台预热。

Open API

使用 Open API 进行预热。

配置

如果客户端为 containerd，建议将 dfget.yaml 配置 proxy.defaultFilter 设置为 Expires&Signature&ns, 因为 containerd 会将 blobs 下载 URL 增加 ns query params, 参考代码 containerd/remotes/docker/resolver.go。 这样会导致生成的 Task ID 和预热的 Task ID 不相同，因此无法命中已经预热好的 Task ID。

# proxy service detail option
proxy:
  defaultFilter: 'Expires&Signature&ns'

申请 Personal Access Token

调用 Open API 之前请先申请 Personal Access Token，并且 Access Scopes 选择为 job，参考文档 personal-access-tokens。

操作

用户使用 api 进行预热。首先发送 POST 请求创建预热任务。

如果 scheduler_cluster_ids 不存在，表示对所有 scheduler cluster 进行预热。

curl --location --request POST 'http://dragonfly-manager:8080/oapi/v1/jobs' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ZDkxMDMyYTEtZDE1ZC00ZmUxLWE0ODItNDI3NTk1ZGM2YWU0' \
--data-raw '{
    "type": "preheat",
    "args": {
        "type": "image",
        "url": "https://index.docker.io/v2/library/redis/manifests/latest"
        "filteredQueryParams": "Expires&Signature",
        "username": "registry_username",
        "password": "registry_password",
    }
}'

命令行日志返回预热任务 ID。

{
    "id": 1,
    "task_id": "group_4d1ea00e-740f-4dbf-a47e-dbdc08eb33e1",
    "type": "preheat",
    "status": "PENDING",
    "args": {
        "type": "image",
        "url": "https://index.docker.io/v2/library/redis/manifests/latest"
        "filteredQueryParams": "Expires&Signature",
    }
}

使用预热任务 ID 轮训查询任务是否成功。

curl --request GET 'http://dragonfly-manager:8080/oapi/v1/jobs/1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ZDkxMDMyYTEtZDE1ZC00ZmUxLWE0ODItNDI3NTk1ZGM2YWU0'

如果返回预热任务状态为 SUCCESS，表示预热成功。

{
    "id": 1,
    "task_id": "group_4d1ea00e-740f-4dbf-a47e-dbdc08eb33e1",
    "type": "preheat",
    "status": "SUCCESS",
    "args": {
        "type": "image",
        "url": "https://index.docker.io/v2/library/redis/manifests/latest"
    }
}

控制台

使用控制台进行预热，用于文件预热。

展示预热信息

展示所有预热任务信息列表。

创建预热任务

点击 ADD PREHEAT 按钮创建预热任务。

Description: 添加说明来描述预热的用途。

Clusters: 至少选择一个或多个 Cluster 进行预热。

URL: 需要进行预热资源的 URL 地址。

Tag: 当预热任务的 URL 相同但 Tag 不同时，会根据 Tag 进行区分，生成的预热任务也会不同。

Filtered Query Params: 通过设置 filteredQueryParams 参数，可以指定需要预热的资源的文件类型，过滤器用于生成唯一的任务 ID，过滤 URL 中不必要的查询参数。

点击 SAVE 创建完成后，生成的预热任务不会立即返回结果，该预热任务会一直轮询直到返回结果。

预热成功

显示预热任务详细信息，status 属性显示预热任务是否成功。

预热失败

如果返回预热任务状态为 FAILURE，表示预热失败，并且可以查看失败日志。