pipeline_job

Documentation

Index

• Constants
• type FileLogger
  • func NewFileLogger(jobId uint, logFilePath string) (*FileLogger, error)
  • func (l *FileLogger) Close() error
  • func (l *FileLogger) Log(format string, a ...interface{})
  • func (l *FileLogger) Reset(format string, a ...interface{})
• type JobCancelParams
• type JobCleanParams
• type JobExecutor
  • func NewJobExecutor(dataDir string, client *httpclient.HttpClient) *JobExecutor
  • func (j *JobExecutor) Cancel(c *gin.Context)
  • func (j *JobExecutor) Cleanup(c *gin.Context)
  • func (j *JobExecutor) Execute(c *gin.Context)
  • func (j *JobExecutor) Status(c *gin.Context)
• type JobRunParams
• type JobStatus
  • func NewJobStatus(filePath string) *JobStatus
  • func (s *JobStatus) Get() (*StatusResult, error)
  • func (s *JobStatus) Set(sr *StatusResult) error
• type JobStatusParams
• type SpaceletJobRun
  • func NewSpaceletJobRun(dataDir string, client *httpclient.HttpClient) *SpaceletJobRun
  • func (b *SpaceletJobRun) Cancel(jobId uint) error
  • func (b *SpaceletJobRun) Cleanup(jobId uint) error
  • func (b *SpaceletJobRun) Execute(jobId uint, pluginKey string, params map[string]interface{}) (resp *utils.Response)
  • func (b *SpaceletJobRun) GetJobLogFile(jobId uint) (string, error)
  • func (b *SpaceletJobRun) GetJobStatusFile(jobId uint) (string, error)
  • func (b *SpaceletJobRun) GetRootDir(jobId uint) (string, error)
  • func (b *SpaceletJobRun) GetStatusLog(jobId uint, withLog bool) (*StatusLog, error)
• type StatusLog
• type StatusResult

Constants

const PipelineCallbackUri = "/api/v1/spacelet/pipeline/callback"

Types

type FileLogger

type FileLogger struct {
	*os.File
	// contains filtered or unexported fields
}

FileLogger 任务执行时日志写入文件

func NewFileLogger

func NewFileLogger(jobId uint, logFilePath string) (*FileLogger, error)

func (*FileLogger) Close

func (l *FileLogger) Close() error

func (*FileLogger) Log

func (l *FileLogger) Log(format string, a ...interface{})

Log 日志存储到文件

func (*FileLogger) Reset

func (l *FileLogger) Reset(format string, a ...interface{})

Reset 从头日志重写

type JobCancelParams

type JobCancelParams struct {
	JobId uint `json:"job_id" form:"job_id" url:"job_id"`
}

type JobCleanParams

type JobCleanParams struct {
	JobId uint `json:"job_id" form:"job_id" url:"job_id"`
}

type JobExecutor

type JobExecutor struct {
	// contains filtered or unexported fields
}

func NewJobExecutor

func NewJobExecutor(dataDir string, client *httpclient.HttpClient) *JobExecutor

func (*JobExecutor) Cancel

func (j *JobExecutor) Cancel(c *gin.Context)

func (*JobExecutor) Cleanup

func (j *JobExecutor) Cleanup(c *gin.Context)

func (*JobExecutor) Execute

func (j *JobExecutor) Execute(c *gin.Context)

func (*JobExecutor) Status

func (j *JobExecutor) Status(c *gin.Context)

type JobRunParams

type JobRunParams struct {
	JobId  uint                   `json:"job_id" form:"job_id"`
	Plugin string                 `json:"plugin" form:"plugin"`
	Params map[string]interface{} `json:"params" form:"params"`
}

type JobStatus

type JobStatus struct {
	// contains filtered or unexported fields
}

func NewJobStatus

func NewJobStatus(filePath string) *JobStatus

func (*JobStatus) Get

func (s *JobStatus) Get() (*StatusResult, error)

Get 从文件获取任务状态以及执行结果

func (*JobStatus) Set

func (s *JobStatus) Set(sr *StatusResult) error

Set 将任务状态以及执行结果写入到文件

type JobStatusParams

type JobStatusParams struct {
	JobId   uint `json:"job_id" form:"job_id" url:"job_id"`
	WithLog bool `json:"with_log" form:"with_log" url:"with_log"`
}

type SpaceletJobRun

type SpaceletJobRun struct {
	// contains filtered or unexported fields
}

SpaceletJobRun Spacelet流水线任务插件执行处理

func NewSpaceletJobRun

func NewSpaceletJobRun(dataDir string, client *httpclient.HttpClient) *SpaceletJobRun

func (*SpaceletJobRun) Cancel

func (b *SpaceletJobRun) Cancel(jobId uint) error

func (*SpaceletJobRun) Cleanup

func (b *SpaceletJobRun) Cleanup(jobId uint) error

Cleanup 清理任务目录

func (*SpaceletJobRun) Execute

func (b *SpaceletJobRun) Execute(jobId uint, pluginKey string, params map[string]interface{}) (resp *utils.Response)

Execute 执行任务插件，任务开启一个协程后台执行，该方法立即返回，后续的任务执行状态通过回调接口上报

func (*SpaceletJobRun) GetJobLogFile

func (b *SpaceletJobRun) GetJobLogFile(jobId uint) (string, error)

GetJobLogFile 获取任务执行的日志文件

func (*SpaceletJobRun) GetJobStatusFile

func (b *SpaceletJobRun) GetJobStatusFile(jobId uint) (string, error)

GetJobStatusFile 获取任务执行的结果以及状态文件

func (*SpaceletJobRun) GetRootDir

func (b *SpaceletJobRun) GetRootDir(jobId uint) (string, error)

GetRootDir 获取pipeline任务执行的根目录，如果目录不存在则创建一个

func (*SpaceletJobRun) GetStatusLog

func (b *SpaceletJobRun) GetStatusLog(jobId uint, withLog bool) (*StatusLog, error)

GetStatusLog 从pipelline当前任务目录中的status文件获取状态信息

type StatusLog

type StatusLog struct {
	StatusResult *StatusResult `json:"status"`
	Log          string        `json:"log"`
}

StatusLog 任务状态以及日志

type StatusResult

type StatusResult struct {
	Status string          `json:"status"`
	Result *utils.Response `json:"result"`
}

StatusResult 任务状态以及执行结果存储查询