diff options
| author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-02-02 15:10:15 +0300 |
|---|---|---|
| committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-02-02 15:10:15 +0300 |
| commit | bdf5d637dab13620c56063c628274746182196ad (patch) | |
| tree | ac85f7fd0a998f0edd373adebf5a71f8714e9c2b /doc/development/cicd | |
| parent | 0c178b535cda98a248e136ba5128f0d903edb17d (diff) | |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/cicd')
| -rw-r--r-- | doc/development/cicd/index.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/development/cicd/index.md b/doc/development/cicd/index.md index eede1d691a9..196b6461f72 100644 --- a/doc/development/cicd/index.md +++ b/doc/development/cicd/index.md @@ -143,3 +143,25 @@ Finally if the runner can only pick jobs that are tagged, all untagged jobs are At this point we loop through remaining `pending` jobs and we try to assign the first job that the runner "can pick" based on additional policies. For example, runners marked as `protected` can only pick jobs that run against protected branches (such as production deployments). As we increase the number of runners in the pool we also increase the chances of conflicts which would arise if assigning the same job to different runners. To prevent that we gracefully rescue conflict errors and assign the next job in the list. + +## The definition of "Job" in GitLab CI/CD + +"Job" in GitLab CI context refers a task to drive Continuous Integartion, Delivery and Deployment. +Typically, a pipeline contains multiple stages, and a stage contains multiple jobs. + +In Active Record modeling, Job is defined as `CommitStatus` class. +On top of that, we have the following types of jobs: + +- `Ci::Build` ... The job to be executed by runners. +- `Ci::Bridge` ... The job to trigger a downstream pipeline. +- `GenericCommitStatus` ... The job to be executed in an external CI/CD system e.g. Jenkins. + +Please note that, when you use the "Job" terminology in codebase, readers would +assume that the class/object is any type of above. +If you specifically refer `Ci::Build` class, you should not name the object/class +as "job" as this could cause some confusions. In documentation, +we should use "Job" in general, instead of "Build". + +We have a few inconsistencies in our codebase that should be refactored. +For example, `CommitStatus` should be `Ci::Job` and `Ci::JobArtifact` should be `Ci::BuildArtifact`. +Please read [this isse](https://gitlab.com/gitlab-org/gitlab/-/issues/16111) for the full refactoring plan. |