Skip to main content
Version: v2.1.x

Preheat

There are two ways to preheat, one is to preheat through the Open API, and the other is to preheat through the console.

Open API​

Use Open API to preheat.

Configuration​

If the client is containerd, it is recommended to configure proxy.defaultFilter in dfget.yaml and set it to Expires&Signature&ns, because containerd will add ns query params to the blobs download URL, refer to containerd/remotes/docker/resolver.go. Which will cause the generated Task ID to be different from the preheat Task ID, so it is impossible to hit the preheat blobs.

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

Create Personal Access Token​

Please create personal access Token before calling Open API, and select job for access scopes, refer to personal-access-tokens.

Operation​

Use preheat api for preheating. First create a POST request for preheating.

If the scheduler_cluster_ids does not exist, it means to preheat all scheduler clusters.

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",
    }
}'

The command-line log returns the preheat job 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",
    }
}

Polling the preheating status with job id.

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

If the status is SUCCESS, the preheating is successful.

{
    "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"
    }
}

Console​

Use console for preheating, for file preheating.

Preheat​

Display all of the preheat tasks.

preheats

Create Preheat​

Click the ADD PREHEAT button to create preheat task.

Description: Set a description.

Clusters: Used for clusters that need to be preheat.

URL: URL address used to specify the resource to be preheat.

Tag: When the URL of the preheat task are the same but the Tag are different, they will be distinguished based on the tag and the generated preheat task will be different.

Filtered Query Params: By setting the filteredQueryParams parameter, you can specify the file type of the resource that needs to be preheated. The filteredQueryParams is used to generate a unique preheat task and filter unnecessary query parameters in the URL.

create-preheat

Click the SAVE to generate the preheat task,the generated preheat task will not return results immediately and you need to wait.

penging-preheat

Preheat Success​

If the status is SUCCESS, the preheating is successful.

success-preheat

Preheat Failure​

If the status is FAILURE, the preheating is failure and an error log is displayed.

failure-preheat