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

187 lines
7.9 KiB
Markdown
Raw Normal View History

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
2018-12-05 23:21:45 +05:30
In this area, you will find settings for Auto DevOps, Runners and job artifacts.
You can find it in the admin area, under **Settings > Continuous Integration and Deployment**.
2016-09-13 17:45:13 +05:30
2018-12-05 23:21:45 +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
2019-07-31 22:56:46 +05:30
1. Go to **Admin area > Settings > Continuous Integration and Deployment**
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)
can be set in the Admin area of your GitLab instance. The value is in *MB* and
the default is 100MB per job; on GitLab.com it's [set to 1G](../../gitlab_com/index.md#gitlab-cicd).
2017-08-17 22:00:37 +05:30
2018-12-05 23:21:45 +05:30
To change it:
2017-08-17 22:00:37 +05:30
2018-12-05 23:21:45 +05:30
1. Go to **Admin area > Settings > Continuous Integration and Deployment**.
1. Change the value of maximum artifacts size (in MB).
1. Hit **Save changes** for the changes to take effect.
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)
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)
2018-12-05 23:21:45 +05:30
and the default value is `30 days`. On GitLab.com they
2019-07-07 11:18:12 +05:30
[never expire](../../gitlab_com/index.md#gitlab-cicd).
2017-08-17 22:00:37 +05:30
2018-12-05 23:21:45 +05:30
1. Go to **Admin area > Settings > Continuous Integration and Deployment**.
1. Change the value of default expiration time.
1. Hit **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
2019-09-30 21:07:59 +05:30
## Shared Runners pipeline minutes quota **(STARTER ONLY)**
2019-07-31 22:56:46 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/1078)
in GitLab Starter 8.16.
If you have enabled shared Runners for your GitLab instance, you can limit their
usage by setting a maximum number of pipeline minutes that a group can use on
shared Runners per month. Setting this to `0` (default value) will grant
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:
1. Go to **Admin area > Settings > Continuous Integration and Deployment**
1. Set the pipeline minutes quota limit.
1. Hit **Save changes** for the changes to take effect
---
While the setting in the Admin area has a global effect, as an admin you can
also change each group's pipeline minutes quota to override the global value.
1. Navigate to the **Groups** admin area and hit the **Edit** button for the
group you wish to change the pipeline minutes quota.
1. Set the pipeline minutes quota to the desired value
1. Hit **Save changes** for the changes to take effect.
Once saved, you can see the build quota in the group admin view.
The quota can also be viewed in the project admin view if shared Runners
are enabled.
![Project admin info](img/admin_project_quota_view.png)
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
## Extra Shared Runners pipeline minutes quota **(FREE ONLY)**
2019-07-31 22:56:46 +05:30
2019-09-30 21:07:59 +05:30
If you're using GitLab.com, you can purchase additional CI minutes so your
pipelines will not be blocked after you have used all your CI minutes from your
main quota.
2019-07-31 22:56:46 +05:30
In order to purchase additional minutes, you should follow these steps:
1. Go to **Group > Settings > Pipelines quota**. Once you are on that page, click on **Buy additional minutes**.
![Buy additional minutes](img/buy_btn.png)
1. Locate the subscription card that is linked to your group on GitLab.com,
2019-09-30 21:07:59 +05:30
click on **Buy more CI minutes**, and complete the details about the transaction.
2019-07-31 22:56:46 +05:30
![Buy additional minutes](img/buy_minutes_card.png)
1. Once we have processed your payment, the extra CI minutes
2019-09-30 21:07:59 +05:30
will be synced to your Group and you can visualize it from the
**Group > Settings > Pipelines quota** page:
2019-07-31 22:56:46 +05:30
![Additional minutes](img/additional_minutes.png)
Be aware that:
1. If you have purchased extra CI minutes before the purchase of a paid plan,
2019-09-30 21:07:59 +05:30
we will calculate a pro-rated charge for your paid plan. That means you may
be charged for less than one year since your subscription was previously
created with the extra CI minutes.
2019-07-31 22:56:46 +05:30
1. Once the extra CI minutes has been assigned to a Group they cannot be transferred
2019-09-30 21:07:59 +05:30
to a different Group.
2019-07-31 22:56:46 +05:30
1. If you have some minutes used over your default quota, these minutes will
2019-09-30 21:07:59 +05:30
be deducted from your Additional Minutes quota immediately after your purchase of additional
minutes.
2019-07-31 22:56:46 +05:30
2019-09-04 21:01:54 +05:30
## What happens when my CI minutes quota run out
When the CI minutes quota run out, an email is sent automatically to notifies the owner(s) of the group/namespace which
includes a link to [purchase more minutes](https://customers.gitlab.com/plans).
If you are not the owner of the group, you will need to contact them to let them know they need to
[purchase more minutes](https://customers.gitlab.com/plans).
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:
1. Go to **Admin area > Settings > CI/CD > Continuous Integration and Deployment**.
1. Change the value of "Archive jobs".
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
<!-- ## 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)**
GitLab administrators can force a pipeline configuration to run on every
pipeline.
The configuration applies to all pipelines for a GitLab instance and is
sourced from:
- The [instance template repository](instance_template_repository.md).
- GitLab-supplied configuration.
To set required pipeline configuration:
1. Go to **Admin area > Settings > CI/CD**.
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)