debian-mirror-gitlab/doc/user/admin_area/settings/continuous_integration.md

332 lines
14 KiB
Markdown
Raw Normal View History

2019-09-04 21:01:54 +05:30
---
2020-06-23 00:09:42 +05:30
stage: Verify
2021-09-04 01:27:46 +05:30
group: Pipeline Execution
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2019-09-04 21:01:54 +05:30
type: reference
---
2021-09-04 01:27:46 +05:30
# Continuous Integration and Deployment Admin Area settings **(FREE SELF)**
2016-09-13 17:45:13 +05:30
2021-09-04 01:27:46 +05:30
The [Admin Area](index.md) has the instance settings for Auto DevOps, runners, and
job artifacts.
2016-09-13 17:45:13 +05:30
2021-09-04 01:27:46 +05:30
## Auto DevOps
2016-09-13 17:45:13 +05:30
2018-12-05 23:21:45 +05:30
To enable (or disable) [Auto DevOps](../../../topics/autodevops/index.md)
for all projects:
2016-09-13 17:45:13 +05:30
2021-09-04 01:27:46 +05:30
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Settings > CI/CD**.
2020-07-28 23:09:34 +05:30
1. Check (or uncheck to disable) the box that says **Default to Auto DevOps pipeline for all projects**.
2018-12-05 23:21:45 +05:30
1. Optionally, set up the [Auto DevOps base domain](../../../topics/autodevops/index.md#auto-devops-base-domain)
2021-06-08 01:23:25 +05:30
which is used for Auto Deploy and Auto Review Apps.
2018-12-05 23:21:45 +05:30
1. Hit **Save changes** for the changes to take effect.
2016-09-13 17:45:13 +05:30
2018-12-05 23:21:45 +05:30
From now on, every existing project and newly created ones that don't have a
2021-06-08 01:23:25 +05:30
`.gitlab-ci.yml`, uses the Auto DevOps pipelines.
2016-09-13 17:45:13 +05:30
2018-12-05 23:21:45 +05:30
If you want to disable it for a specific project, you can do so in
2021-04-17 20:07:23 +05:30
[its settings](../../../topics/autodevops/index.md#enable-or-disable-auto-devops).
2016-09-13 17:45:13 +05:30
2021-09-04 01:27:46 +05:30
## Shared runner details
To display details about the instance's shared runners in all projects'
runner settings:
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Settings > CI/CD**.
1. Expand **Continuous Integration and Deployment**.
1. Enter your shared runner details in the **Shared runner details** field.
You can use [Markdown](../../markdown.md) for improved formatting. To see the rendered
details:
1. On the top bar, select **Menu > Project** and select any group or project.
1. On the left sidebar, select **Settings > CI/CD**.
1. Expand **Runners**.
![Shared runner details example](img/continuous_integration_shared_runner_details_v14_0.png)
2021-03-11 19:13:27 +05:30
## Maximum artifacts size **(FREE SELF)**
2018-11-20 20:47:30 +05:30
2019-07-31 22:56:46 +05:30
The maximum size of the [job artifacts](../../../administration/job_artifacts.md)
2019-12-21 20:55:43 +05:30
can be set at:
2017-08-17 22:00:37 +05:30
2019-12-21 20:55:43 +05:30
- The instance level.
2020-06-23 00:09:42 +05:30
- [From GitLab 12.4](https://gitlab.com/gitlab-org/gitlab/-/issues/21688), the project and group level.
2017-08-17 22:00:37 +05:30
2019-12-21 20:55:43 +05:30
The value is:
- In *MB* and the default is 100MB per job.
- [Set to 1G](../../gitlab_com/index.md#gitlab-cicd) on GitLab.com.
To change it at the:
- Instance level:
2021-09-04 01:27:46 +05:30
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Settings > CI/CD**.
1. Change the value of maximum artifacts size (in MB).
1. Click **Save changes** for the changes to take effect.
2019-12-21 20:55:43 +05:30
2021-06-08 01:23:25 +05:30
- Group level (this overrides the instance setting):
2019-12-21 20:55:43 +05:30
2021-04-17 20:07:23 +05:30
1. Go to the group's **Settings > CI/CD > General Pipelines**.
2019-12-21 20:55:43 +05:30
1. Change the value of **maximum artifacts size (in MB)**.
2020-07-28 23:09:34 +05:30
1. Click **Save changes** for the changes to take effect.
2019-12-21 20:55:43 +05:30
2021-06-08 01:23:25 +05:30
- Project level (this overrides the instance and group settings):
2019-12-21 20:55:43 +05:30
2021-04-17 20:07:23 +05:30
1. Go to the project's **Settings > CI/CD > General Pipelines**.
2019-12-21 20:55:43 +05:30
1. Change the value of **maximum artifacts size (in MB)**.
2020-07-28 23:09:34 +05:30
1. Click **Save changes** for the changes to take effect.
2019-12-21 20:55:43 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2019-12-21 20:55:43 +05:30
The setting at all levels is only available to GitLab administrators.
2017-08-17 22:00:37 +05:30
2021-09-04 01:27:46 +05:30
## Default artifacts expiration
2017-08-17 22:00:37 +05:30
2018-12-05 23:21:45 +05:30
The default expiration time of the [job artifacts](../../../administration/job_artifacts.md)
2020-03-13 15:44:24 +05:30
can be set in the Admin Area of your GitLab instance. The syntax of duration is
2021-09-30 23:02:18 +05:30
described in [`artifacts:expire_in`](../../../ci/yaml/index.md#artifactsexpire_in)
2020-07-28 23:09:34 +05:30
and the default value is `30 days`.
2017-08-17 22:00:37 +05:30
2021-09-04 01:27:46 +05:30
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Settings > CI/CD**.
2018-12-05 23:21:45 +05:30
1. Change the value of default expiration time.
2020-07-28 23:09:34 +05:30
1. Click **Save changes** for the changes to take effect.
2017-08-17 22:00:37 +05:30
2018-12-05 23:21:45 +05:30
This setting is set per job and can be overridden in
2021-09-30 23:02:18 +05:30
[`.gitlab-ci.yml`](../../../ci/yaml/index.md#artifactsexpire_in).
2018-12-05 23:21:45 +05:30
To disable the expiration, set it to `0`. The default unit is in seconds.
2018-12-13 13:39:08 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2021-06-08 01:23:25 +05:30
Any changes to this setting applies to new artifacts only. The expiration time is not
2020-03-13 15:44:24 +05:30
be updated for artifacts created before this setting was changed.
The administrator may need to manually search for and expire previously-created
artifacts, as described in the [troubleshooting documentation](../../../administration/troubleshooting/gitlab_rails_cheat_sheet.md#remove-artifacts-more-than-a-week-old).
2021-09-04 01:27:46 +05:30
## Keep the latest artifacts for all jobs in the latest successful pipelines
2019-07-31 22:56:46 +05:30
2021-09-04 01:27:46 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/50889) in GitLab 13.9.
2021-03-11 19:13:27 +05:30
2021-09-04 01:27:46 +05:30
When enabled (default), the artifacts of the most recent pipeline for each Git ref
([branches and tags](https://git-scm.com/book/en/v2/Git-Internals-Git-References))
are locked against deletion and kept regardless of the expiry time.
2021-03-11 19:13:27 +05:30
When disabled, the latest artifacts for any **new** successful or fixed pipelines
are allowed to expire.
This setting takes precedence over the [project level setting](../../../ci/pipelines/job_artifacts.md#keep-artifacts-from-most-recent-successful-jobs).
If disabled at the instance level, you cannot enable this per-project.
2021-04-17 20:07:23 +05:30
To disable the setting:
2021-09-04 01:27:46 +05:30
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Settings > CI/CD**.
2021-04-17 20:07:23 +05:30
1. Expand **Continuous Integration and Deployment**.
1. Clear the **Keep the latest artifacts for all jobs in the latest successful pipelines** checkbox.
1. Click **Save changes**
2021-03-11 19:13:27 +05:30
When you disable the feature, the latest artifacts do not immediately expire.
A new pipeline must run before the latest artifacts can expire and be deleted.
NOTE:
All application settings have a [customizable cache expiry interval](../../../administration/application_settings_cache.md) which can delay the settings affect.
## Shared runners pipeline minutes quota **(PREMIUM SELF)**
> [Moved](https://about.gitlab.com/blog/2021/01/26/new-gitlab-product-subscription-model/) to GitLab Premium in 13.9.
2019-07-31 22:56:46 +05:30
2020-11-24 15:15:51 +05:30
If you have enabled shared runners for your GitLab instance, you can limit their
2019-07-31 22:56:46 +05:30
usage by setting a maximum number of pipeline minutes that a group can use on
2021-06-08 01:23:25 +05:30
shared runners per month. Setting this to `0` (default value) grants
2019-07-31 22:56:46 +05:30
unlimited pipeline minutes. While build limits are stored as minutes, the
counting is done in seconds. Usage resets on the first day of each month.
On GitLab.com, the quota is calculated based on your
2021-09-04 01:27:46 +05:30
[subscription plan](../../../subscriptions/gitlab_com/index.md#ci-pipeline-minutes).
2019-07-31 22:56:46 +05:30
To change the pipelines minutes quota:
2021-09-04 01:27:46 +05:30
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Settings > CI/CD**.
2020-07-28 23:09:34 +05:30
1. Expand **Continuous Integration and Deployment**.
1. In the **Pipeline minutes quota** box, enter the maximum number of minutes.
1. Click **Save changes** for the changes to take effect.
2019-07-31 22:56:46 +05:30
2021-09-04 01:27:46 +05:30
While the setting in the Admin Area has a global effect, as an administrator you can
2019-07-31 22:56:46 +05:30
also change each group's pipeline minutes quota to override the global value.
2020-03-13 15:44:24 +05:30
1. Navigate to the **Admin Area > Overview > Groups** and hit the **Edit**
button for the group you wish to change the pipeline minutes quota.
2020-07-28 23:09:34 +05:30
1. In the **Pipeline Minutes Quota** box, enter the maximum number of minutes.
1. Click **Save changes** for the changes to take effect.
2019-07-31 22:56:46 +05:30
2021-09-04 01:27:46 +05:30
Once saved, you can see the build quota in the group settings.
The quota can also be viewed in the project settings if shared runners
2019-07-31 22:56:46 +05:30
are enabled.
2020-04-22 19:07:51 +05:30
![Project admin information](img/admin_project_quota_view.png)
2019-07-31 22:56:46 +05:30
2019-09-04 21:01:54 +05:30
You can see an overview of the pipeline minutes quota of all projects of
a group in the **Usage Quotas** page available to the group page settings list.
2019-07-31 22:56:46 +05:30
![Group pipelines quota](img/group_pipelines_quota.png)
2021-09-04 01:27:46 +05:30
## Archive jobs
2018-12-13 13:39:08 +05:30
Archiving jobs is useful for reducing the CI/CD footprint on the system by
removing some of the capabilities of the jobs (metadata needed to run the job),
but persisting the traces and artifacts for auditing purposes.
2021-06-08 01:23:25 +05:30
To set the duration for which the jobs are considered as old and expired:
2018-12-13 13:39:08 +05:30
2021-09-04 01:27:46 +05:30
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Settings > CI/CD**.
2020-03-13 15:44:24 +05:30
1. Expand the **Continuous Integration and Deployment** section.
1. Set the value of **Archive jobs**.
2018-12-13 13:39:08 +05:30
1. Hit **Save changes** for the changes to take effect.
2021-09-04 01:27:46 +05:30
After that time passes, the jobs are archived and no longer able to be
2018-12-13 13:39:08 +05:30
retried. Make it empty to never expire jobs. It has to be no less than 1 day,
for example: <code>15 days</code>, <code>1 month</code>, <code>2 years</code>.
2019-09-04 21:01:54 +05:30
2021-06-08 01:23:25 +05:30
As of June 22, 2020 the [value is set](../../gitlab_com/index.md#gitlab-cicd) to 3 months on GitLab.com. Jobs created before that date were archived after September 22, 2020.
2020-07-28 23:09:34 +05:30
2021-09-04 01:27:46 +05:30
## Protect CI/CD variables by default
2021-09-30 23:02:18 +05:30
To set all new [CI/CD variables](../../../ci/variables/index.md) as
[protected](../../../ci/variables/index.md#protect-a-cicd-variable) by default:
2021-09-04 01:27:46 +05:30
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Settings > CI/CD**.
1. Select **Protect CI/CD variables by default**.
## Default CI/CD configuration file
2019-12-26 22:10:19 +05:30
2020-03-13 15:44:24 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/18073) in GitLab 12.5.
2019-12-26 22:10:19 +05:30
2021-09-04 01:27:46 +05:30
The default CI/CD configuration file and path for new projects can be set in the Admin Area
of your GitLab instance (`.gitlab-ci.yml` if not set):
2019-12-26 22:10:19 +05:30
2021-09-04 01:27:46 +05:30
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Settings > CI/CD**.
1. Input the new file and path in the **Default CI/CD configuration file** field.
2019-12-26 22:10:19 +05:30
1. Hit **Save changes** for the changes to take effect.
2021-09-30 23:02:18 +05:30
It is also possible to specify a [custom CI/CD configuration file for a specific project](../../../ci/pipelines/settings.md#specify-a-custom-cicd-configuration-file).
2019-12-26 22:10:19 +05:30
2021-03-11 19:13:27 +05:30
## Required pipeline configuration **(PREMIUM SELF)**
2019-09-30 21:07:59 +05:30
2021-02-22 17:27:13 +05:30
WARNING:
2020-03-13 15:44:24 +05:30
This feature is being re-evaluated in favor of a different
2021-03-08 18:12:59 +05:30
[compliance solution](https://gitlab.com/groups/gitlab-org/-/epics/3156).
2020-03-13 15:44:24 +05:30
We recommend that users who haven't yet implemented this feature wait for
the new solution.
2019-12-26 22:10:19 +05:30
2021-09-30 23:02:18 +05:30
You can set a [CI/CD template](../../../ci/examples/index.md#cicd-templates)
2021-09-04 01:27:46 +05:30
as a required pipeline configuration for all projects on a GitLab instance. You can
use a template from:
2019-09-30 21:07:59 +05:30
2021-09-04 01:27:46 +05:30
- The default CI/CD templates.
- A custom template stored in an [instance template repository](instance_template_repository.md).
2019-09-30 21:07:59 +05:30
2021-09-04 01:27:46 +05:30
NOTE:
When you use a configuration defined in an instance template repository,
2021-09-30 23:02:18 +05:30
nested [`include:`](../../../ci/yaml/index.md#include) keywords
2021-09-04 01:27:46 +05:30
(including `include:file`, `include:local`, `include:remote`, and `include:template`)
[do not work](https://gitlab.com/gitlab-org/gitlab/-/issues/35345).
2019-09-30 21:07:59 +05:30
2021-09-04 01:27:46 +05:30
The project CI/CD configuration merges into the required pipeline configuration when
a pipeline runs. The merged configuration is the same as if the required pipeline configuration
2021-09-30 23:02:18 +05:30
added the project configuration with the [`include` keyword](../../../ci/yaml/index.md#include).
2021-09-04 01:27:46 +05:30
To view a project's full merged configuration, [View the merged YAML](../../../ci/pipeline_editor/index.md#view-expanded-configuration)
in the pipeline editor.
2021-03-08 18:12:59 +05:30
2021-09-04 01:27:46 +05:30
To select a CI/CD template for the required pipeline configuration:
2019-09-30 21:07:59 +05:30
2021-09-04 01:27:46 +05:30
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Settings > CI/CD**.
2019-09-30 21:07:59 +05:30
1. Expand the **Required pipeline configuration** section.
2021-09-04 01:27:46 +05:30
1. Select a CI/CD template from the dropdown.
2019-09-30 21:07:59 +05:30
1. Click **Save changes**.
2020-11-24 15:15:51 +05:30
## Package Registry configuration
2021-03-11 19:13:27 +05:30
### npm Forwarding **(PREMIUM SELF)**
2020-04-08 14:13:33 +05:30
2021-03-11 19:13:27 +05:30
GitLab administrators can disable the forwarding of npm requests to [npmjs.com](https://www.npmjs.com/).
2020-04-08 14:13:33 +05:30
To disable it:
2021-09-04 01:27:46 +05:30
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Settings > CI/CD**.
2020-04-08 14:13:33 +05:30
1. Expand the **Package Registry** section.
2021-03-11 19:13:27 +05:30
1. Uncheck **Enable forwarding of npm package requests to npmjs.org**.
2020-04-08 14:13:33 +05:30
1. Click **Save changes**.
2021-03-11 19:13:27 +05:30
![npm package requests forwarding](img/admin_package_registry_npm_package_requests_forward.png)
2020-11-24 15:15:51 +05:30
### Package file size limits
GitLab administrators can adjust the maximum allowed file size for each package type.
To set the maximum file size:
2021-09-04 01:27:46 +05:30
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. On the left sidebar, select **Settings > CI/CD**.
2020-11-24 15:15:51 +05:30
1. Expand the **Package Registry** section.
1. Find the package type you would like to adjust.
1. Enter the maximum file size, in bytes.
1. Click **Save size limits**.
2021-03-11 19:13:27 +05:30
2021-09-30 23:02:18 +05:30
## Runner registration
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/22225) in GitLab 14.1.
> - [Deployed behind a feature flag](../../feature_flags.md), disabled by default.
> - Disabled on GitLab.com.
> - Not recommended for production use.
> - To use in GitLab self-managed instances, ask a GitLab administrator to enable it. **(FREE SELF)**
GitLab administrators can adjust who is allowed to register runners, by showing and hiding areas of the UI.
By default, all members of a project and group are able to register runners.
To change this:
1. On the top bar, select **Menu >** **{admin}** **Admin**.
1. Go to **Settings > CI/CD**.
1. Expand the **Runner registration** section.
1. Select the desired options.
1. Click **Save changes**.
When the registration sections are hidden in the UI, members of the project or group that need to register runners must contact the administrators.
This feature is currently behind a feature flag.
To enable it:
**In Omnibus installations:**
1. Enter the Rails console:
```shell
sudo gitlab-rails console
```
1. Flip the switch and enable the feature flag:
```ruby
Feature.enable(:runner_registration_control)
```
2021-03-11 19:13:27 +05:30
## Troubleshooting
### 413 Request Entity Too Large
When build jobs fail with the following error,
increase the [maximum artifacts size](#maximum-artifacts-size).
```plaintext
Uploading artifacts as "archive" to coordinator... too large archive <job-id> responseStatus=413 Request Entity Too Large status=413" at end of a build job on pipeline when trying to store artifacts to <object-storage>.
```