-
Notifications
You must be signed in to change notification settings - Fork 4.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add jobservice monitoring api list pool, worker and stop running task (…
…#17658) Add REST API to list job pool, worker, stop running task Add jobservice handler to retrieve configuration Add RBAC for jobservice monitoring dashboard Add REST API to list pool, worker and stop running task Signed-off-by: stonezdj <[email protected]> Signed-off-by: stonezdj <[email protected]>
- Loading branch information
Showing
20 changed files
with
958 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,155 @@ | ||
| // Copyright Project Harbor 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 jobmonitor | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "strings" | ||
| "time" | ||
|
|
||
| "github.com/goharbor/harbor/src/lib/orm" | ||
|
|
||
| "github.com/goharbor/harbor/src/lib/log" | ||
|
|
||
| "github.com/gocraft/work" | ||
|
|
||
| "github.com/goharbor/harbor/src/common/job" | ||
| "github.com/goharbor/harbor/src/lib/errors" | ||
| "github.com/goharbor/harbor/src/lib/q" | ||
| libRedis "github.com/goharbor/harbor/src/lib/redis" | ||
| jm "github.com/goharbor/harbor/src/pkg/jobmonitor" | ||
| "github.com/goharbor/harbor/src/pkg/scheduler" | ||
| "github.com/goharbor/harbor/src/pkg/task" | ||
| ) | ||
|
|
||
| // All the jobs in the pool, or all pools | ||
| const All = "all" | ||
|
|
||
| // Ctl the controller instance of the worker pool controller | ||
| var Ctl = NewMonitorController() | ||
|
|
||
| // MonitorController defines the worker pool operations | ||
| type MonitorController interface { | ||
| // ListPools lists the worker pools | ||
| ListPools(ctx context.Context) ([]*jm.WorkerPool, error) | ||
| // ListWorkers lists the workers in the pool | ||
| ListWorkers(ctx context.Context, poolID string) ([]*jm.Worker, error) | ||
| // StopRunningJob stop the running job | ||
| StopRunningJob(ctx context.Context, jobID string) error | ||
| } | ||
|
|
||
| type monitorController struct { | ||
| poolManager jm.PoolManager | ||
| workerManager jm.WorkerManager | ||
| taskManager task.Manager | ||
| sch scheduler.Scheduler | ||
| monitorClient func() (jm.JobServiceMonitorClient, error) | ||
| } | ||
|
|
||
| // NewMonitorController ... | ||
| func NewMonitorController() MonitorController { | ||
| return &monitorController{ | ||
| poolManager: jm.NewPoolManager(), | ||
| workerManager: jm.NewWorkerManager(), | ||
| taskManager: task.NewManager(), | ||
| monitorClient: jobServiceMonitorClient, | ||
| } | ||
| } | ||
|
|
||
| func (w *monitorController) StopRunningJob(ctx context.Context, jobID string) error { | ||
| if strings.EqualFold(jobID, All) { | ||
| allRunningJobs, err := w.allRunningJobs(ctx) | ||
| if err != nil { | ||
| log.Errorf("failed to get all running jobs: %v", err) | ||
| return err | ||
| } | ||
| for _, jobID := range allRunningJobs { | ||
| if err := w.stopJob(ctx, jobID); err != nil { | ||
| log.Errorf("failed to stop running job %s: %v", jobID, err) | ||
| return err | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
| return w.stopJob(ctx, jobID) | ||
| } | ||
|
|
||
| func (w *monitorController) stopJob(ctx context.Context, jobID string) error { | ||
| tasks, err := w.taskManager.List(ctx, &q.Query{Keywords: q.KeyWords{"job_id": jobID}}) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if len(tasks) == 0 { | ||
| return errors.BadRequestError(nil).WithMessage("job %s not found", jobID) | ||
| } | ||
| if len(tasks) != 1 { | ||
| return fmt.Errorf("there are more than one task with the same job ID") | ||
| } | ||
| // use local transaction to avoid rollback batch success tasks to previous state when one fail | ||
| if ctx == nil { | ||
| log.Debug("context is nil, skip stop operation") | ||
| return nil | ||
| } | ||
| return orm.WithTransaction(func(ctx context.Context) error { | ||
| return w.taskManager.Stop(ctx, tasks[0].ID) | ||
| })(orm.SetTransactionOpNameToContext(ctx, "tx-stop-job")) | ||
| } | ||
|
|
||
| func (w *monitorController) allRunningJobs(ctx context.Context) ([]string, error) { | ||
| jobIDs := make([]string, 0) | ||
| wks, err := w.ListWorkers(ctx, All) | ||
| if err != nil { | ||
| log.Errorf("failed to list workers: %v", err) | ||
| return nil, err | ||
| } | ||
| for _, wk := range wks { | ||
| jobIDs = append(jobIDs, wk.JobID) | ||
| } | ||
| return jobIDs, nil | ||
| } | ||
|
|
||
| func jobServiceMonitorClient() (jm.JobServiceMonitorClient, error) { | ||
| cfg, err := job.GlobalClient.GetJobServiceConfig() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| config := cfg.RedisPoolConfig | ||
| pool, err := libRedis.GetRedisPool("JobService", config.RedisURL, &libRedis.PoolParam{ | ||
| PoolMaxIdle: 0, | ||
| PoolIdleTimeout: time.Duration(config.IdleTimeoutSecond) * time.Second, | ||
| }) | ||
| if err != nil { | ||
| log.Errorf("failed to get redis pool: %v", err) | ||
| return nil, err | ||
| } | ||
| return work.NewClient(fmt.Sprintf("{%s}", config.Namespace), pool), nil | ||
| } | ||
|
|
||
| func (w *monitorController) ListWorkers(ctx context.Context, poolID string) ([]*jm.Worker, error) { | ||
| mClient, err := w.monitorClient() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return w.workerManager.List(ctx, mClient, poolID) | ||
| } | ||
|
|
||
| func (w *monitorController) ListPools(ctx context.Context) ([]*jm.WorkerPool, error) { | ||
| mClient, err := w.monitorClient() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return w.poolManager.List(ctx, mClient) | ||
| } |
Oops, something went wrong.