247 lines
8.4 KiB
Go
247 lines
8.4 KiB
Go
/*
|
|
* Copyright 2020 The Dragonfly Authors
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
package types
|
|
|
|
import "time"
|
|
|
|
const (
|
|
// SingleSeedPeerScope represents the scope that only single seed peer will be preheated.
|
|
SingleSeedPeerScope = "single_seed_peer"
|
|
|
|
// AllSeedPeersScope represents the scope that all seed peers will be preheated.
|
|
AllSeedPeersScope = "all_seed_peers"
|
|
|
|
// AllPeersScope represents the scope that all peers will be preheated.
|
|
AllPeersScope = "all_peers"
|
|
)
|
|
|
|
const (
|
|
// DefaultPreheatConcurrentCount is the default concurrent count for preheating all peers.
|
|
DefaultPreheatConcurrentCount = 50
|
|
|
|
// DefaultJobTimeout is the default timeout for executing job.
|
|
DefaultJobTimeout = 30 * time.Minute
|
|
)
|
|
|
|
type CreateJobRequest struct {
|
|
// BIO is the description of the job.
|
|
BIO string `json:"bio" binding:"omitempty"`
|
|
|
|
// Type is the type of the job.
|
|
Type string `json:"type" binding:"required"`
|
|
|
|
// Args is the arguments of the job.
|
|
Args map[string]any `json:"args" binding:"omitempty"`
|
|
|
|
// UserID is the user id of the job.
|
|
UserID uint `json:"user_id" binding:"omitempty"`
|
|
|
|
// SeedPeerClusterIDs is the seed peer cluster ids of the job.
|
|
SeedPeerClusterIDs []uint `json:"seed_peer_cluster_ids" binding:"omitempty"`
|
|
|
|
// SchedulerClusterIDs is the scheduler cluster ids of the job.
|
|
SchedulerClusterIDs []uint `json:"scheduler_cluster_ids" binding:"omitempty"`
|
|
}
|
|
|
|
type UpdateJobRequest struct {
|
|
// BIO is the description of the job.
|
|
BIO string `json:"bio" binding:"omitempty"`
|
|
|
|
// UserID is the user id of the job.
|
|
UserID uint `json:"user_id" binding:"omitempty"`
|
|
}
|
|
|
|
type JobParams struct {
|
|
// Type is the type of the job.
|
|
ID uint `uri:"id" binding:"required"`
|
|
}
|
|
|
|
type GetJobsQuery struct {
|
|
// Type is the type of the job.
|
|
Type string `form:"type" binding:"omitempty"`
|
|
|
|
// State is the state of the job.
|
|
State string `form:"state" binding:"omitempty,oneof=PENDING RECEIVED STARTED RETRY SUCCESS FAILURE"`
|
|
|
|
// UserID is the user id of the job.
|
|
UserID uint `form:"user_id" binding:"omitempty"`
|
|
|
|
// Page is the page number of the job list.
|
|
Page int `form:"page" binding:"omitempty,gte=1"`
|
|
|
|
// PerPage is the item count per page of the job list.
|
|
PerPage int `form:"per_page" binding:"omitempty,gte=1,lte=10000000"`
|
|
}
|
|
|
|
type CreatePreheatJobRequest struct {
|
|
// BIO is the description of the job.
|
|
BIO string `json:"bio" binding:"omitempty"`
|
|
|
|
// Type is the preheating type, support image and file.
|
|
Type string `json:"type" binding:"required"`
|
|
|
|
// Args is the arguments of the preheating job.
|
|
Args PreheatArgs `json:"args" binding:"omitempty"`
|
|
|
|
// UserID is the user id of the job.
|
|
UserID uint `json:"user_id" binding:"omitempty"`
|
|
|
|
// SchedulerClusterIDs is the scheduler cluster ids of the job.
|
|
SchedulerClusterIDs []uint `json:"scheduler_cluster_ids" binding:"omitempty"`
|
|
}
|
|
|
|
type PreheatArgs struct {
|
|
// Type is the preheating type, support image and file.
|
|
Type string `json:"type" binding:"required,oneof=image file"`
|
|
|
|
// URL is the image url for preheating.
|
|
URL string `json:"url" binding:"required"`
|
|
|
|
// PieceLength is the piece length(bytes) for downloading file. The value needs to
|
|
// be greater than or equal to 4194304, for example: 4194304(4mib), 8388608(8mib).
|
|
// If the piece length is not specified, the piece length will be calculated
|
|
// according to the file size.
|
|
PieceLength *uint64 `json:"piece_length" binding:"omitempty,gte=4194304"`
|
|
|
|
// Tag is the tag for preheating.
|
|
Tag string `json:"tag" binding:"omitempty"`
|
|
|
|
// FilteredQueryParams is the filtered query params for preheating.
|
|
FilteredQueryParams string `json:"filtered_query_params" binding:"omitempty"`
|
|
|
|
// Headers is the http headers for authentication.
|
|
Headers map[string]string `json:"headers" binding:"omitempty"`
|
|
|
|
// Username is the username for authentication.
|
|
Username string `json:"username" binding:"omitempty"`
|
|
|
|
// Password is the password for authentication.
|
|
Password string `json:"password" binding:"omitempty"`
|
|
|
|
// The image type preheating task can specify the image architecture type. eg: linux/amd64.
|
|
Platform string `json:"platform" binding:"omitempty"`
|
|
|
|
// Scope is the scope for preheating, default is single_seed_peer.
|
|
Scope string `json:"scope" binding:"omitempty"`
|
|
|
|
// BatchSize is the batch size for preheating all peers, default is 50.
|
|
ConcurrentCount int64 `json:"concurrent_count" binding:"omitempty,gte=1,lte=500"`
|
|
|
|
// Timeout is the timeout for preheating, default is 30 minutes.
|
|
Timeout time.Duration `json:"timeout" binding:"omitempty"`
|
|
|
|
// LoadToCache is the flag for preheating content in cache storage, default is false.
|
|
LoadToCache bool `json:"load_to_cache" binding:"omitempty"`
|
|
}
|
|
|
|
type CreateSyncPeersJobRequest struct {
|
|
// BIO is the description of the job.
|
|
BIO string `json:"bio" binding:"omitempty"`
|
|
|
|
// Type is the type of the job.
|
|
Type string `json:"type" binding:"required"`
|
|
|
|
// UserID is the user id of the job.
|
|
UserID uint `json:"user_id" binding:"omitempty"`
|
|
|
|
// SchedulerClusterIDs is the scheduler cluster ids of the job.
|
|
SchedulerClusterIDs []uint `json:"scheduler_cluster_ids" binding:"omitempty"`
|
|
}
|
|
|
|
type CreateGetTaskJobRequest struct {
|
|
// BIO is the description of the job.
|
|
BIO string `json:"bio" binding:"omitempty"`
|
|
|
|
// Type is the type of the job.
|
|
Type string `json:"type" binding:"required"`
|
|
|
|
// Args is the arguments of the job.
|
|
Args GetTaskArgs `json:"args" binding:"omitempty"`
|
|
|
|
// UserID is the user id of the job.
|
|
UserID uint `json:"user_id" binding:"omitempty"`
|
|
|
|
// SchedulerClusterIDs is the scheduler cluster ids of the job.
|
|
SchedulerClusterIDs []uint `json:"scheduler_cluster_ids" binding:"omitempty"`
|
|
}
|
|
|
|
type GetTaskArgs struct {
|
|
// TaskID is the task id for getting.
|
|
TaskID string `json:"task_id" binding:"omitempty"`
|
|
|
|
// URL is the download url of the task.
|
|
URL string `json:"url" binding:"omitempty"`
|
|
|
|
// PieceLength is the piece length(bytes) for downloading file. The value needs to
|
|
// be greater than or equal to 4194304, for example: 4194304(4mib), 8388608(8mib).
|
|
// If the piece length is not specified, the piece length will be calculated
|
|
// according to the file size.
|
|
PieceLength *uint64 `json:"piece_length" binding:"omitempty,gte=4194304"`
|
|
|
|
// Tag is the tag of the task.
|
|
Tag string `json:"tag" binding:"omitempty"`
|
|
|
|
// Application is the application of the task.
|
|
Application string `json:"application" binding:"omitempty"`
|
|
|
|
// FilteredQueryParams is the filtered query params of the task.
|
|
FilteredQueryParams string `json:"filtered_query_params" binding:"omitempty"`
|
|
}
|
|
|
|
type CreateDeleteTaskJobRequest struct {
|
|
// BIO is the description of the job.
|
|
BIO string `json:"bio" binding:"omitempty"`
|
|
|
|
// Type is the type of the job.
|
|
Type string `json:"type" binding:"required"`
|
|
|
|
// Args is the arguments of the job.
|
|
Args DeleteTaskArgs `json:"args" binding:"omitempty"`
|
|
|
|
// UserID is the user id of the job.
|
|
UserID uint `json:"user_id" binding:"omitempty"`
|
|
|
|
// SchedulerClusterIDs is the scheduler cluster ids of the job.
|
|
SchedulerClusterIDs []uint `json:"scheduler_cluster_ids" binding:"omitempty"`
|
|
}
|
|
|
|
type DeleteTaskArgs struct {
|
|
// TaskID is the task id for deleting.
|
|
TaskID string `json:"task_id" binding:"omitempty"`
|
|
|
|
// URL is the download url of the task.
|
|
URL string `json:"url" binding:"omitempty"`
|
|
|
|
// PieceLength is the piece length(bytes) for downloading file. The value needs to
|
|
// be greater than or equal to 4194304, for example: 4194304(4mib), 8388608(8mib).
|
|
// If the piece length is not specified, the piece length will be calculated
|
|
// according to the file size.
|
|
PieceLength *uint64 `json:"piece_length" binding:"omitempty,gte=4194304"`
|
|
|
|
// Tag is the tag of the task.
|
|
Tag string `json:"tag" binding:"omitempty"`
|
|
|
|
// Application is the application of the task.
|
|
Application string `json:"application" binding:"omitempty"`
|
|
|
|
// FilteredQueryParams is the filtered query params of the task.
|
|
FilteredQueryParams string `json:"filtered_query_params" binding:"omitempty"`
|
|
|
|
// Timeout is the timeout for deleting, default is 30 minutes.
|
|
Timeout time.Duration `json:"timeout" binding:"omitempty"`
|
|
}
|