diff options
| -rw-r--r-- | app/models/ci/build.rb | 2 | ||||
| -rw-r--r-- | changelogs/unreleased/ci-resource-group-doc.yml | 6 | ||||
| -rw-r--r-- | doc/ci/yaml/README.md | 34 | ||||
| -rw-r--r-- | lib/gitlab/ci/pipeline/seed/build/resource_group.rb | 2 |
4 files changed, 42 insertions, 2 deletions
diff --git a/app/models/ci/build.rb b/app/models/ci/build.rb index 5324d59c155..5edd2f52fc8 100644 --- a/app/models/ci/build.rb +++ b/app/models/ci/build.rb @@ -481,7 +481,7 @@ module Ci end def requires_resource? - Feature.enabled?(:ci_resource_group, project) && + Feature.enabled?(:ci_resource_group, project, default_enabled: true) && self.resource_group_id.present? end diff --git a/changelogs/unreleased/ci-resource-group-doc.yml b/changelogs/unreleased/ci-resource-group-doc.yml new file mode 100644 index 00000000000..a675e5f2971 --- /dev/null +++ b/changelogs/unreleased/ci-resource-group-doc.yml @@ -0,0 +1,6 @@ +--- +title: Add 'resource_group' keyword to .gitlab-ci.yml for pipeline job concurrency + limitation +merge_request: 21617 +author: +type: added diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 84e0bb873a7..62a113a407c 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -119,6 +119,7 @@ The following table lists available parameters for jobs: | [`pages`](#pages) | Upload the result of a job to use with GitLab Pages. | | [`variables`](#variables) | Define job variables on a job level. | | [`interruptible`](#interruptible) | Defines if a job can be canceled when made redundant by a newer run. | +| [`resource_group`](#resource_group) | Limit job concurrency. | NOTE: **Note:** Parameters `types` and `type` are [deprecated](#deprecated-parameters). @@ -2634,6 +2635,39 @@ In the example above, a new pipeline run will cause an existing running pipeline NOTE: **Note:** Once an uninterruptible job is running, the pipeline will never be canceled, regardless of the final job's state. +### `resource_group` + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/15536) in GitLab 12.7. + +Sometimes running multiples jobs or pipelines at the same time in an environment +can lead to errors during the deployment. + +To avoid these errors, the `resource_group` attribute can be used to ensure that +the Runner will not run certain jobs simultaneously. + +When the `resource_group` key is defined in a job in `.gitlab-ci.yml`, +job runs are mutually exclusive across different pipelines in the same project. +If multiple jobs belonging to the same resource group are enqueued simultaneously, +only one of them will be picked by the Runner, and the other jobs will wait until the +`resource_group` is free. + +Here is a simple example: + +```yaml +deploy-to-production: + script: deploy + resource_group: production +``` + +In this case, if a `deploy-to-production` job is running in a pipeline, and a new +`deploy-to-production` job is created in a different pipeline, it will not run until +the currently running/pending `deploy-to-production` job is finished. As a result, +you can ensure that concurrent deployments will never happen to the production environment. + +There can be multiple `resource_group`s defined per environment. A good use case for this +is when deploying to physical devices. You may have more than one phyisical device, and each +one can be deployed to, but there can be only one deployment per device at any given time. + ### `include` > - Introduced in [GitLab Premium](https://about.gitlab.com/pricing/) 10.5. diff --git a/lib/gitlab/ci/pipeline/seed/build/resource_group.rb b/lib/gitlab/ci/pipeline/seed/build/resource_group.rb index 100eb1d4084..3bec6d1e8b6 100644 --- a/lib/gitlab/ci/pipeline/seed/build/resource_group.rb +++ b/lib/gitlab/ci/pipeline/seed/build/resource_group.rb @@ -16,7 +16,7 @@ module Gitlab end def to_resource - return unless Feature.enabled?(:ci_resource_group, build.project) + return unless Feature.enabled?(:ci_resource_group, build.project, default_enabled: true) return unless resource_group_key.present? resource_group = build.project.resource_groups |