Skip to content
Snippets Groups Projects
Verified Commit da05687d authored by Achilleas Pipinellis's avatar Achilleas Pipinellis
Browse files

Update a bunch of docs images

parent b9f78eae
No related branches found
No related tags found
No related merge requests found
Showing
with 25 additions and 29 deletions
## Enable or disable GitLab CI
## Enable or disable GitLab CI/CD
 
_To effectively use GitLab CI, you need a valid [`.gitlab-ci.yml`](yaml/README.md)
To effectively use GitLab CI/CD, you need a valid [`.gitlab-ci.yml`](yaml/README.md)
file present at the root directory of your project and a
[runner](runners/README.md) properly set up. You can read our
[quick start guide](quick_start/README.md) to get you started._
[quick start guide](quick_start/README.md) to get you started.
 
If you are using an external CI server like Jenkins or Drone CI, it is advised
to disable GitLab CI in order to not have any conflicts with the commits status
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
API.
 
---
 
GitLab CI is exposed via the `/pipelines` and `/builds` pages of a project.
Disabling GitLab CI in a project does not delete any previous jobs.
In fact, the `/pipelines` and `/builds` pages can still be accessed, although
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
it's hidden from the left sidebar menu.
 
GitLab CI is enabled by default on new installations and can be disabled either
GitLab CI/CD is enabled by default on new installations and can be disabled either
individually under each project's settings, or site-wide by modifying the
settings in `gitlab.yml` and `gitlab.rb` for source and Omnibus installations
respectively.
 
### Per-project user setting
 
The setting to enable or disable GitLab CI can be found with the name **Pipelines**
under the **Sharing & Permissions** area of a project's settings along with
**Merge Requests**. Choose one of **Disabled**, **Only team members** and
**Everyone with access** and hit **Save changes** for the settings to take effect.
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.
 
![Sharing & Permissions settings](img/permissions_settings.png)
![Sharing & Permissions settings](../user/project/settings/img/sharing_and_permissions_settings.png)
 
---
### Site-wide administrator setting
### Site-wide admin setting
 
You can disable GitLab CI site-wide, by modifying the settings in `gitlab.yml`
You can disable GitLab CI/CD site-wide, by modifying the settings in `gitlab.yml`
and `gitlab.rb` for source and Omnibus installations respectively.
 
Two things to note:
 
1. Disabling GitLab CI, will affect only newly-created projects. Projects that
1. Disabling GitLab CI/CD, will affect only newly-created projects. Projects that
had it enabled prior to this modification, will work as before.
1. Even if you disable GitLab CI, users will still be able to enable it in the
1. Even if you disable GitLab CI/CD, users will still be able to enable it in the
project's settings.
 
---
For installations from source, open `gitlab.yml` with your editor and set
`builds` to `false`:
 
Loading
Loading
Loading
Loading
@@ -26,7 +26,7 @@ so every environment can have one or more deployments. GitLab keeps track of
your deployments, so you always know what is currently being deployed on your
servers. If you have a deployment service such as [Kubernetes][kubernetes-service]
enabled for your project, you can use it to assist with your deployments, and
can even access a web terminal for your environment from within GitLab!
can even access a [web terminal](#web-terminals) for your environment from within GitLab!
 
To better understand how environments and deployments work, let's consider an
example. We assume that you have already created a project in GitLab and set up
Loading
Loading
@@ -119,7 +119,7 @@ where you can find information of the last deployment status of an environment.
 
Here's how the Environments page looks so far.
 
![Staging environment view](img/environments_available_staging.png)
![Environment view](img/environments_available.png)
 
There's a bunch of information there, specifically you can see:
 
Loading
Loading
@@ -229,7 +229,7 @@ You can find it in the pipeline, job, environment, and deployment views.
 
| Pipelines | Single pipeline | Environments | Deployments | jobs |
| --------- | ----------------| ------------ | ----------- | -------|
| ![Pipelines manual action](img/environments_manual_action_pipelines.png) | ![Pipelines manual action](img/environments_manual_action_single_pipeline.png) | ![Environments manual action](img/environments_manual_action_environments.png) | ![Deployments manual action](img/environments_manual_action_deployments.png) | ![Builds manual action](img/environments_manual_action_builds.png) |
| ![Pipelines manual action](img/environments_manual_action_pipelines.png) | ![Pipelines manual action](img/environments_manual_action_single_pipeline.png) | ![Environments manual action](img/environments_manual_action_environments.png) | ![Deployments manual action](img/environments_manual_action_deployments.png) | ![Builds manual action](img/environments_manual_action_jobs.png) |
 
Clicking on the play button in either of these places will trigger the
`deploy_prod` job, and the deployment will be recorded under a new
Loading
Loading
@@ -402,7 +402,7 @@ places within GitLab.
 
| In a merge request widget as a link | In the Environments view as a button | In the Deployments view as a button |
| -------------------- | ------------ | ----------- |
| ![Environment URL in merge request](img/environments_mr_review_app.png) | ![Environment URL in environments](img/environments_link_url.png) | ![Environment URL in deployments](img/environments_link_url_deployments.png) |
| ![Environment URL in merge request](img/environments_mr_review_app.png) | ![Environment URL in environments](img/environments_available.png) | ![Environment URL in deployments](img/deployments_view.png) |
 
If a merge request is eventually merged to the default branch (in our case
`master`) and that branch also deploys to an environment (in our case `staging`
Loading
Loading
@@ -574,7 +574,7 @@ Once configured, GitLab will attempt to retrieve [supported performance metrics]
environment which has had a successful deployment. If monitoring data was
successfully retrieved, a Monitoring button will appear for each environment.
 
![Environment Detail with Metrics](img/prometheus_environment_detail_with_metrics.png)
![Environment Detail with Metrics](img/deployments_view.png)
 
Clicking on the Monitoring button will display a new page, showing up to the last
8 hours of performance data. It may take a minute or two for data to appear
Loading
Loading
@@ -593,10 +593,11 @@ Web terminals were added in GitLab 8.15 and are only available to project
masters and owners.
 
If you deploy to your environments with the help of a deployment service (e.g.,
the [Kubernetes service][kubernetes-service], GitLab can open
the [Kubernetes service][kubernetes-service]), GitLab can open
a terminal session to your environment! This is a very powerful feature that
allows you to debug issues without leaving the comfort of your web browser. To
enable it, just follow the instructions given in the service documentation.
enable it, just follow the instructions given in the service integration
documentation.
 
Once enabled, your environments will gain a "terminal" button:
 
Loading
Loading
doc/ci/img/builds_tab.png

1.91 KiB

doc/ci/img/deployments_view.png

19.5 KiB | W: 1252px | H: 372px

doc/ci/img/deployments_view.png

59.7 KiB | W: 1080px | H: 441px

doc/ci/img/deployments_view.png
doc/ci/img/deployments_view.png
doc/ci/img/deployments_view.png
doc/ci/img/deployments_view.png
  • 2-up
  • Swipe
  • Onion skin
doc/ci/img/environments_available.png

20.6 KiB

doc/ci/img/environments_available_staging.png

9.86 KiB

doc/ci/img/environments_dynamic_groups.png

44.3 KiB | W: 1268px | H: 685px

doc/ci/img/environments_dynamic_groups.png

56.9 KiB | W: 1080px | H: 498px

doc/ci/img/environments_dynamic_groups.png
doc/ci/img/environments_dynamic_groups.png
doc/ci/img/environments_dynamic_groups.png
doc/ci/img/environments_dynamic_groups.png
  • 2-up
  • Swipe
  • Onion skin
doc/ci/img/environments_link_url.png

12 KiB

doc/ci/img/environments_link_url_deployments.png

7.31 KiB

doc/ci/img/environments_link_url_mr.png

17.5 KiB | W: 731px | H: 529px

doc/ci/img/environments_link_url_mr.png

33.6 KiB | W: 671px | H: 362px

doc/ci/img/environments_link_url_mr.png
doc/ci/img/environments_link_url_mr.png
doc/ci/img/environments_link_url_mr.png
doc/ci/img/environments_link_url_mr.png
  • 2-up
  • Swipe
  • Onion skin
doc/ci/img/environments_manual_action_builds.png

10.9 KiB

doc/ci/img/environments_manual_action_deployments.png

12.3 KiB | W: 1257px | H: 244px

doc/ci/img/environments_manual_action_deployments.png

32 KiB | W: 1298px | H: 249px

doc/ci/img/environments_manual_action_deployments.png
doc/ci/img/environments_manual_action_deployments.png
doc/ci/img/environments_manual_action_deployments.png
doc/ci/img/environments_manual_action_deployments.png
  • 2-up
  • Swipe
  • Onion skin
doc/ci/img/environments_manual_action_environments.png

14.6 KiB | W: 1265px | H: 248px

doc/ci/img/environments_manual_action_environments.png

23.6 KiB | W: 1285px | H: 276px

doc/ci/img/environments_manual_action_environments.png
doc/ci/img/environments_manual_action_environments.png
doc/ci/img/environments_manual_action_environments.png
doc/ci/img/environments_manual_action_environments.png
  • 2-up
  • Swipe
  • Onion skin
doc/ci/img/environments_manual_action_jobs.png

19.5 KiB

doc/ci/img/environments_manual_action_pipelines.png

15.9 KiB | W: 1264px | H: 307px

doc/ci/img/environments_manual_action_pipelines.png

38.1 KiB | W: 1267px | H: 253px

doc/ci/img/environments_manual_action_pipelines.png
doc/ci/img/environments_manual_action_pipelines.png
doc/ci/img/environments_manual_action_pipelines.png
doc/ci/img/environments_manual_action_pipelines.png
  • 2-up
  • Swipe
  • Onion skin
doc/ci/img/environments_manual_action_single_pipeline.png

16.2 KiB | W: 1276px | H: 765px

doc/ci/img/environments_manual_action_single_pipeline.png

22.8 KiB | W: 735px | H: 409px

doc/ci/img/environments_manual_action_single_pipeline.png
doc/ci/img/environments_manual_action_single_pipeline.png
doc/ci/img/environments_manual_action_single_pipeline.png
doc/ci/img/environments_manual_action_single_pipeline.png
  • 2-up
  • Swipe
  • Onion skin
doc/ci/img/environments_mr_review_app.png

15 KiB | W: 1265px | H: 400px

doc/ci/img/environments_mr_review_app.png

30.3 KiB | W: 958px | H: 279px

doc/ci/img/environments_mr_review_app.png
doc/ci/img/environments_mr_review_app.png
doc/ci/img/environments_mr_review_app.png
doc/ci/img/environments_mr_review_app.png
  • 2-up
  • Swipe
  • Onion skin
doc/ci/img/environments_terminal_button_on_index.png

77.9 KiB | W: 2782px | H: 326px

doc/ci/img/environments_terminal_button_on_index.png

28.5 KiB | W: 1271px | H: 250px

doc/ci/img/environments_terminal_button_on_index.png
doc/ci/img/environments_terminal_button_on_index.png
doc/ci/img/environments_terminal_button_on_index.png
doc/ci/img/environments_terminal_button_on_index.png
  • 2-up
  • Swipe
  • Onion skin
doc/ci/img/environments_terminal_button_on_show.png

71.5 KiB | W: 2774px | H: 364px

doc/ci/img/environments_terminal_button_on_show.png

17.4 KiB | W: 1278px | H: 177px

doc/ci/img/environments_terminal_button_on_show.png
doc/ci/img/environments_terminal_button_on_show.png
doc/ci/img/environments_terminal_button_on_show.png
doc/ci/img/environments_terminal_button_on_show.png
  • 2-up
  • Swipe
  • Onion skin
doc/ci/img/environments_view.png

20.7 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment