schema

type ActionType string

type Artifacts struct {
	Input  map[string]string `yaml:"input"       json:"input"`
	Output map[string]string `yaml:"output"      json:"output"`
}

type Cache struct {
	Enable         bool      `yaml:"enable"           json:"enable"`
	MaxExpiredTime string    `yaml:"max_expired_time" json:"maxExpiredTime"` // seconds
	FsScope        []FsScope `yaml:"fs_scope"         json:"fsScope"`        // seperated by ","
}

type ClientOptions struct {
	Master string
	Config string
	QPS    float32
	Burst  int
}

type Cluster struct {
	ID   string
	Name string
	Type string

	// ClientOpt defines client config for cluster
	ClientOpt ClientOptions
}

type Component interface {
	GetDeps() []string
	GetArtifacts() Artifacts
	GetArtifactPath(artName string) (string, error)
	GetInputArtifactPath(artName string) (string, error)
	GetOutputArtifactPath(artName string) (string, error)
	GetParameters() map[string]interface{}
	GetParameterValue(paramName string) (interface{}, error)
	GetCondition() string
	GetLoopArgument() interface{}
	GetLoopArgumentLength() int
	GetType() string
	GetName() string

	// 下面几个Update 函数在进行模板替换的时候会用到
	UpdateCondition(string)
	UpdateLoopArguemt(interface{})
	UpdateName(name string)
	UpdateDeps(deps string)

	InitInputArtifacts()
	InitOutputArtifacts()
	InitParameters()

	// 用于 deepCopy, 避免复用时出现问题
	DeepCopy() Component
}

type ComponentView interface {
	GetComponentName() string
	GetParentDagID() string
	GetStatus() JobStatus
	GetSeq() int
	GetDeps() string
	GetMsg() string
	GetName() string
	GetStartTime() string
	GetEndTime() string

	SetDeps(string)
}

type Conf struct {
	Name string `json:"name"`
	// 存储资源
	FileSystem      FileSystem   `json:"fs,omitempty"`
	ExtraFileSystem []FileSystem `json:"extraFS,omitempty"`
	// 计算资源
	Flavour   Flavour `json:"flavour,omitempty"`
	Priority  string  `json:"priority"`
	ClusterID string  `json:"clusterID"`
	QueueID   string  `json:"queueID"`
	QueueName string  `json:"queueName,omitempty"`
	// 运行时需要的参数
	Labels      map[string]string `json:"labels"`
	Annotations map[string]string `json:"annotations"`
	Env         map[string]string `json:"env,omitempty"`
	Command     string            `json:"command,omitempty"`
	Image       string            `json:"image"`
	Port        int               `json:"port,omitempty"`
	Args        []string          `json:"args,omitempty"`
}

type DagView struct {
	PK          int64                      `json:"-"`
	DagID       string                     `json:"id"`
	Name        string                     `json:"name"`
	Type        string                     `json:"type"`
	DagName     string                     `json:"dagName"`
	ParentDagID string                     `json:"parentDagID"`
	LoopSeq     int                        `json:"-"`
	Deps        string                     `json:"deps"`
	Parameters  map[string]string          `json:"parameters"`
	Artifacts   Artifacts                  `json:"artifacts"`
	StartTime   string                     `json:"startTime"`
	EndTime     string                     `json:"endTime"`
	Status      JobStatus                  `json:"status"`
	Message     string                     `json:"message"`
	EntryPoints map[string][]ComponentView `json:"entryPoints"`
}

type FailureOptions struct {
	Strategy string `yaml:"strategy"     json:"strategy"`
}

type FileSystem struct {
	ID        string `json:"id,omitempty"`
	Name      string `json:"name"`
	Type      string `json:"type"`
	HostPath  string `json:"hostPath,omitempty"`
	MountPath string `json:"mountPath,omitempty"`
	SubPath   string `json:"subPath,omitempty"`
	ReadOnly  bool   `json:"readOnly,omitempty"`
}

type Flavour struct {
	ResourceInfo `yaml:",inline"`
	Name         string `json:"name" yaml:"name"`
}

type Framework string

type FrameworkVersion struct {
	Framework  string `json:"framework"`
	APIVersion string `json:"apiVersion"`
}

type FsMount struct {
	ID        string `yaml:"-"             json:"id"`
	Name      string `yaml:"name"          json:"name"`
	MountPath string `yaml:"mount_path"    json:"mountPath"`
	SubPath   string `yaml:"sub_path"      json:"subPath"`
	ReadOnly  bool   `yaml:"read_only"     json:"readOnly"`
}

type FsOptions struct {
	MainFS  FsMount   `yaml:"main_fs"      json:"mainFS"`
	ExtraFS []FsMount `yaml:"extra_fs"     json:"extraFS,omitempty"`
}

type FsScope struct {
	Name string `yaml:"name"          json:"name"`
	ID   string `yaml:"-"             json:"id"`
	Path string `yaml:"path"          json:"path"`
}

type JobLogInfo struct {
	JobID    string        `json:"jobID"`
	TaskList []TaskLogInfo `json:"taskList"`
}

type JobLogRequest struct {
	JobID           string `json:"jobID"`
	JobType         string `json:"jobType"`
	Namespace       string `json:"namespace"`
	LogFilePosition string `json:"logFilePosition"`
	LogPageSize     int    `json:"logPageSize"`
	LogPageNo       int    `json:"logPageNo"`
}

type JobStatus string

type JobType string

type JobView struct {
	PK          int64             `json:"-"`
	JobID       string            `json:"jobID"`
	Name        string            `json:"name"`
	Type        string            `json:"type"`
	StepName    string            `json:"stepName"`
	ParentDagID string            `json:"parentDagID"`
	LoopSeq     int               `json:"-"`
	Command     string            `json:"command"`
	Parameters  map[string]string `json:"parameters"`
	Env         map[string]string `json:"env"`
	ExtraFS     []FsMount         `json:"extraFS"`
	StartTime   string            `json:"startTime"`
	EndTime     string            `json:"endTime"`
	Status      JobStatus         `json:"status"`
	Deps        string            `json:"deps"`
	DockerEnv   string            `json:"dockerEnv"`
	Artifacts   Artifacts         `json:"artifacts"`
	Cache       Cache             `json:"cache"`
	JobMessage  string            `json:"jobMessage"`
	CacheRunID  string            `json:"cacheRunID"`
	CacheJobID  string            `json:"cacheJobID"`
}

type LogInfo struct {
	LogContent  string `json:"logContent"`
	HasNextPage bool   `json:"hasNextPage"`
	Truncated   bool   `json:"truncated"`
}

type LogRunArtifactRequest struct {
	Md5          string `json:"md5"`
	RunID        string `json:"runID"`
	FsID         string `json:"fsID"`
	FsName       string `json:"fsname"`
	UserName     string `json:"username"`
	ArtifactPath string `json:"artifactPath"`
	Step         string `json:"step"`
	JobID        string `json:"jobID"`
	Type         string `json:"type"`
	ArtifactName string `json:"artifactName"`
	Meta         string `json:"meta"`
}

type LogRunCacheRequest struct {
	FirstFp     string `json:"firstFp"`
	SecondFp    string `json:"secondFp"`
	Source      string `json:"source"`
	RunID       string `json:"runID"`
	Step        string `json:"step"`
	JobID       string `json:"jobID"`
	FsID        string `json:"fsID"`
	FsName      string `json:"fsname"`
	UserName    string `json:"username"`
	ExpiredTime string `json:"expiredTime"`
	Strategy    string `json:"strategy"`
}

type Member struct {
	ID       string     `json:"id"`
	Replicas int        `json:"replicas"`
	Role     MemberRole `json:"role"`
	Conf     `json:",inline"`
}

type MemberRole string

type NodeQuotaInfo struct {
	NodeName    string             `json:"nodeName"`
	Schedulable bool               `json:"schedulable"`
	Total       resources.Resource `json:"total"`
	Idle        resources.Resource `json:"idle"`
}

type PFJobConf interface {
	GetName() string
	GetEnv() map[string]string
	GetEnvValue(key string) string
	GetEnvSubset(prefix string) map[string]string
	GetCommand() string
	GetImage() string

	GetFileSystem() FileSystem
	GetExtraFS() []FileSystem
	GetArgs() []string

	GetPriority() string
	SetPriority(string)

	GetQueueName() string
	GetQueueID() string
	GetClusterID() string
	GetUserName() string

	// Deprecated
	GetFS() string
	SetFS(string)

	GetYamlPath() string
	GetNamespace() string
	GetJobMode() string

	GetFlavour() string
	GetPSFlavour() string
	GetWorkerFlavour() string

	SetQueueID(string)
	SetClusterID(string)
	SetNamespace(string)
	SetEnv(string, string)
	SetLabels(string, string)
	SetAnnotations(string, string)

	Type() JobType
	Framework() Framework
}

type Parser struct {
}

type PostProcessView map[string]*JobView

type QuotaSummary struct {
	TotalQuota resources.Resource `json:"total"`
	IdleQuota  resources.Resource `json:"idle"`
}

type Reference struct {
	Component string `yaml:"component" json:"component"`
}

type ResourceInfo struct {
	CPU             string              `json:"cpu" yaml:"cpu"`
	Mem             string              `json:"mem" yaml:"mem"`
	ScalarResources ScalarResourcesType `json:"scalarResources,omitempty" yaml:"scalarResources,omitempty"`
}

type ResourceName string

type RunOptions struct {
	FSUsername string
	StopForce  bool
}

type RuntimeView map[string][]ComponentView

type ScalarResourcesType map[ResourceName]string

type TaskLogInfo struct {
	TaskID string  `json:"taskID"`
	Info   LogInfo `json:"logInfo"`
}

type TaskStatus string

type WorkflowSource struct {
	Name           string                         `yaml:"name"               json:"name"`
	DockerEnv      string                         `yaml:"docker_env"         json:"dockerEnv"`
	EntryPoints    WorkflowSourceDag              `yaml:"entry_points"       json:"entryPoints"`
	Components     map[string]Component           `yaml:"components"         json:"components"`
	Cache          Cache                          `yaml:"cache"              json:"cache"`
	Parallelism    int                            `yaml:"parallelism"        json:"parallelism"`
	Disabled       string                         `yaml:"disabled"           json:"disabled"`
	FailureOptions FailureOptions                 `yaml:"failure_options"    json:"failureOptions"`
	PostProcess    map[string]*WorkflowSourceStep `yaml:"post_process"       json:"postProcess"`
	FsOptions      FsOptions                      `yaml:"fs_options"         json:"fsOptions"`
}

type WorkflowSourceDag struct {
	Name         string                 `yaml:"-"              json:"name"`
	Type         string                 `yaml:"-"              json:"type"`
	LoopArgument interface{}            `yaml:"loop_argument"  json:"loopArgument"`
	Condition    string                 `yaml:"condition"      json:"condition"`
	Parameters   map[string]interface{} `yaml:"parameters"     json:"parameters"`
	Deps         string                 `yaml:"deps"           json:"deps"`
	Artifacts    Artifacts              `yaml:"artifacts"      json:"artifacts"`
	EntryPoints  map[string]Component   `yaml:"entry_points"   json:"entryPoints"`
}

type WorkflowSourceStep struct {
	Name         string                 `yaml:"-"                 json:"name"`
	LoopArgument interface{}            `yaml:"loop_argument"     json:"loopArgument"`
	Condition    string                 `yaml:"condition"         json:"condition"`
	Parameters   map[string]interface{} `yaml:"parameters"        json:"parameters"`
	Command      string                 `yaml:"command"           json:"command"`
	Deps         string                 `yaml:"deps"              json:"deps"`
	Artifacts    Artifacts              `yaml:"artifacts"         json:"artifacts"`
	Env          map[string]string      `yaml:"env"               json:"env"`
	DockerEnv    string                 `yaml:"docker_env"        json:"dockerEnv"`
	Cache        Cache                  `yaml:"cache"             json:"cache"`
	Reference    Reference              `yaml:"reference"         json:"reference"`
	ExtraFS      []FsMount              `yaml:"extra_fs"          json:"extraFS"`
}