2017-11-01 11:56:40 -04:00
|
|
|
# How to enable or disable GitLab CI/CD
|
2016-01-06 14:05:22 -05:00
|
|
|
|
2017-10-03 09:11:49 -04:00
|
|
|
To effectively use GitLab CI/CD, you need a valid [`.gitlab-ci.yml`](yaml/README.md)
|
2016-01-06 14:05:22 -05:00
|
|
|
file present at the root directory of your project and a
|
|
|
|
[runner](runners/README.md) properly set up. You can read our
|
2017-10-03 09:11:49 -04:00
|
|
|
[quick start guide](quick_start/README.md) to get you started.
|
2016-01-06 14:05:22 -05:00
|
|
|
|
2017-10-03 09:11:49 -04:00
|
|
|
If you are using an external CI/CD server like Jenkins or Drone CI, it is advised
|
|
|
|
to disable GitLab CI/CD in order to not have any conflicts with the commits status
|
2016-01-06 14:05:22 -05:00
|
|
|
API.
|
|
|
|
|
|
|
|
---
|
|
|
|
|
2017-10-03 09:11:49 -04:00
|
|
|
GitLab CI/CD is exposed via the `/pipelines` and `/jobs` pages of a project.
|
|
|
|
Disabling GitLab CI/CD in a project does not delete any previous jobs.
|
|
|
|
In fact, the `/pipelines` and `/jobs` pages can still be accessed, although
|
2017-02-03 13:24:17 -05:00
|
|
|
it's hidden from the left sidebar menu.
|
2016-01-06 14:05:22 -05:00
|
|
|
|
2017-10-03 09:11:49 -04:00
|
|
|
GitLab CI/CD is enabled by default on new installations and can be disabled either
|
2016-01-07 04:10:46 -05:00
|
|
|
individually under each project's settings, or site-wide by modifying the
|
2016-01-06 14:05:22 -05:00
|
|
|
settings in `gitlab.yml` and `gitlab.rb` for source and Omnibus installations
|
|
|
|
respectively.
|
|
|
|
|
2017-11-01 11:56:40 -04:00
|
|
|
## Per-project user setting
|
2016-01-06 14:05:22 -05:00
|
|
|
|
2017-10-03 09:11:49 -04:00
|
|
|
The setting to enable or disable GitLab CI/CD can be found under your project's
|
|
|
|
**Settings > General > Permissions**. Choose one of "Disabled", "Only team members"
|
|
|
|
or "Everyone with access" and hit **Save changes** for the settings to take effect.
|
2016-01-06 14:05:22 -05:00
|
|
|
|
2017-10-03 09:11:49 -04:00
|
|
|
![Sharing & Permissions settings](../user/project/settings/img/sharing_and_permissions_settings.png)
|
2016-01-06 14:05:22 -05:00
|
|
|
|
2017-11-01 11:56:40 -04:00
|
|
|
## Site-wide admin setting
|
2016-01-06 14:05:22 -05:00
|
|
|
|
2017-10-03 09:11:49 -04:00
|
|
|
You can disable GitLab CI/CD site-wide, by modifying the settings in `gitlab.yml`
|
2016-01-06 14:05:22 -05:00
|
|
|
and `gitlab.rb` for source and Omnibus installations respectively.
|
|
|
|
|
2016-01-07 04:10:46 -05:00
|
|
|
Two things to note:
|
2016-01-06 14:05:22 -05:00
|
|
|
|
2017-10-03 09:11:49 -04:00
|
|
|
1. Disabling GitLab CI/CD, will affect only newly-created projects. Projects that
|
2016-01-07 04:10:46 -05:00
|
|
|
had it enabled prior to this modification, will work as before.
|
2017-10-03 09:11:49 -04:00
|
|
|
1. Even if you disable GitLab CI/CD, users will still be able to enable it in the
|
2016-01-06 14:05:22 -05:00
|
|
|
project's settings.
|
|
|
|
|
|
|
|
For installations from source, open `gitlab.yml` with your editor and set
|
|
|
|
`builds` to `false`:
|
|
|
|
|
|
|
|
```yaml
|
|
|
|
## Default project features settings
|
|
|
|
default_projects_features:
|
|
|
|
issues: true
|
|
|
|
merge_requests: true
|
|
|
|
wiki: true
|
|
|
|
snippets: false
|
|
|
|
builds: false
|
|
|
|
```
|
|
|
|
|
|
|
|
Save the file and restart GitLab: `sudo service gitlab restart`.
|
|
|
|
|
|
|
|
For Omnibus installations, edit `/etc/gitlab/gitlab.rb` and add the line:
|
|
|
|
|
|
|
|
```
|
2016-03-11 14:26:18 -05:00
|
|
|
gitlab_rails['gitlab_default_projects_features_builds'] = false
|
2016-01-06 14:05:22 -05:00
|
|
|
```
|
|
|
|
|
|
|
|
Save the file and reconfigure GitLab: `sudo gitlab-ctl reconfigure`.
|