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

225 lines
9.2 KiB
Markdown
Raw Normal View History

2019-09-04 21:01:54 +05:30
---
2020-06-23 00:09:42 +05:30
stage: Verify
group: Continuous Integration
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
---
2019-09-30 21:07:59 +05:30
# Continuous Integration and Deployment Admin settings **(CORE ONLY)**
2016-09-13 17:45:13 +05:30
2020-11-24 15:15:51 +05:30
In this area, you will find settings for Auto DevOps, runners, and job artifacts.
2020-03-13 15:44:24 +05:30
You can find it in the **Admin Area > Settings > CI/CD**.
2016-09-13 17:45:13 +05:30
2020-03-13 15:44:24 +05:30
![Admin Area settings button](../img/admin_area_settings_button.png)
2016-09-13 17:45:13 +05:30
2019-09-30 21:07:59 +05:30
## Auto DevOps **(CORE ONLY)**
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
2020-07-28 23:09:34 +05:30
1. Go to **Admin Area > Settings > CI/CD**.
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)
which is going to be used for Auto Deploy and Auto Review Apps.
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
`.gitlab-ci.yml`, will use 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
2019-07-07 11:18:12 +05:30
[its settings](../../../topics/autodevops/index.md#enablingdisabling-auto-devops).
2016-09-13 17:45:13 +05:30
2019-09-30 21:07:59 +05:30
## Maximum artifacts size **(CORE ONLY)**
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:
2020-03-13 15:44:24 +05:30
1. Go to **Admin Area > Settings > CI/CD**.
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
- [Group level](../../group/index.md#group-settings) (this will override the instance setting):
1. Go to the group's **Settings > CI / CD > General Pipelines**.
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
2020-04-08 14:13:33 +05:30
- [Project level](../../../ci/pipelines/settings.md) (this will override the instance and group settings):
2019-12-21 20:55:43 +05:30
1. Go to the project's **Settings > CI / CD > General Pipelines**.
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
2019-09-30 21:07:59 +05:30
## Default artifacts expiration **(CORE ONLY)**
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
2019-07-07 11:18:12 +05:30
described in [`artifacts:expire_in`](../../../ci/yaml/README.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
2020-03-13 15:44:24 +05:30
1. Go to **Admin Area > 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
2019-07-07 11:18:12 +05:30
[`.gitlab-ci.yml`](../../../ci/yaml/README.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:
2020-03-13 15:44:24 +05:30
Any changes to this setting will apply to new artifacts only. The expiration time will not
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).
2020-11-24 15:15:51 +05:30
## Shared runners pipeline minutes quota **(STARTER ONLY)**
2019-07-31 22:56:46 +05:30
2020-04-22 19:07:51 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1078) in GitLab Starter 8.16.
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
2020-11-24 15:15:51 +05:30
shared runners per month. Setting this to `0` (default value) will grant
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
[subscription plan](https://about.gitlab.com/pricing/#gitlab-com).
To change the pipelines minutes quota:
2020-07-28 23:09:34 +05:30
1. Go to **Admin Area > Settings > CI/CD**.
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
---
2020-03-13 15:44:24 +05:30
While the setting in the Admin Area has a global effect, as an admin 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
Once saved, you can see the build quota in the group admin view.
2020-11-24 15:15:51 +05:30
The quota can also be viewed in the project admin view 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)
2019-09-30 21:07:59 +05:30
## Archive jobs **(CORE ONLY)**
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.
To set the duration for which the jobs will be considered as old and expired:
2020-03-13 15:44:24 +05:30
1. Go to **Admin Area > Settings > CI/CD**.
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.
Once that time passes, the jobs will be archived and no longer able to be
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
2020-07-28 23:09:34 +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 will be archived after September 22, 2020.
2019-12-26 22:10:19 +05:30
## Default CI configuration path
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
The default CI configuration file path for new projects can be set in the Admin
2020-03-13 15:44:24 +05:30
Area of your GitLab instance (`.gitlab-ci.yml` if not set):
2019-12-26 22:10:19 +05:30
2020-03-13 15:44:24 +05:30
1. Go to **Admin Area > Settings > CI/CD**.
2019-12-26 22:10:19 +05:30
1. Input the new path in the **Default CI configuration path** field.
1. Hit **Save changes** for the changes to take effect.
2020-04-08 14:13:33 +05:30
It is also possible to specify a [custom CI configuration path for a specific project](../../../ci/pipelines/settings.md#custom-ci-configuration-path).
2019-12-26 22:10:19 +05:30
2019-09-04 21:01:54 +05:30
<!-- ## Troubleshooting
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
one might have when setting this up, or when something is changed, or on upgrading, it's
important to describe those, too. Think of things that may go wrong and include them here.
This is important to minimize requests for support, and to avoid doc comments with
questions that you know someone might ask.
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
If you have none to add when creating a doc, leave this section in place
but commented out to help encourage others to add to it in the future. -->
2019-09-30 21:07:59 +05:30
## Required pipeline configuration **(PREMIUM ONLY)**
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
2020-06-23 00:09:42 +05:30
[compliance solution](https://gitlab.com/gitlab-org/gitlab/-/issues/34830).
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
2019-09-30 21:07:59 +05:30
GitLab administrators can force a pipeline configuration to run on every
pipeline.
2019-12-04 20:38:33 +05:30
The configuration applies to all pipelines for a GitLab instance and is
2019-09-30 21:07:59 +05:30
sourced from:
- The [instance template repository](instance_template_repository.md).
- GitLab-supplied configuration.
To set required pipeline configuration:
2020-03-13 15:44:24 +05:30
1. Go to **Admin Area > Settings > CI/CD**.
2019-09-30 21:07:59 +05:30
1. Expand the **Required pipeline configuration** section.
1. Select the required configuration from the provided dropdown.
1. Click **Save changes**.
![Required pipeline](img/admin_required_pipeline.png)
2020-04-08 14:13:33 +05:30
2020-11-24 15:15:51 +05:30
## Package Registry configuration
### NPM Forwarding **(PREMIUM ONLY)**
2020-04-08 14:13:33 +05:30
GitLab administrators can disable the forwarding of NPM requests to [npmjs.com](https://www.npmjs.com/).
To disable it:
1. Go to **Admin Area > Settings > CI/CD**.
1. Expand the **Package Registry** section.
1. Uncheck **Enable forwarding of NPM package requests to npmjs.org**.
1. Click **Save changes**.
![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:
1. Go to **Admin Area > Settings > CI/CD**.
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**.