diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-31 00:08:01 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-31 00:08:01 +0300 |
commit | 95ad46159e4cd93f2b31838199180d824e041994 (patch) | |
tree | d41880d3b6a0093463694978590e590efb08caef /doc | |
parent | 2c72daf2f1744f2b8c8c6674c266907e9ef55558 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
38 files changed, 183 insertions, 163 deletions
diff --git a/doc/README.md b/doc/README.md index 95a8b09dd07..3a3e93244c4 100644 --- a/doc/README.md +++ b/doc/README.md @@ -211,7 +211,7 @@ The following documentation relates to the DevOps **Create** stage: | [GitLab Integration](integration/README.md) | Integrate with multiple third-party services with GitLab to allow external issue trackers and external authentication. | | [GitLab Webhooks](user/project/integrations/webhooks.md) | Let GitLab notify you when new code has been pushed to your project. | | [Jira Development Panel](integration/jira_development_panel.md) **(PREMIUM)** | See GitLab information in the Jira Development Panel. | -| [Project Services](user/project/integrations/project_services.md) | Integrate a project with external services, such as CI and chat. | +| [Integrations](user/project/integrations/overview.md) | Integrate a project with external services, such as CI and chat. | | [Trello Power-Up](integration/trello_power_up.md) | Integrate with GitLab's Trello Power-Up. | <div align="right"> diff --git a/doc/administration/instance_limits.md b/doc/administration/instance_limits.md index c1ab7730903..e44fc8679ce 100644 --- a/doc/administration/instance_limits.md +++ b/doc/administration/instance_limits.md @@ -196,7 +196,7 @@ than the specified limit, hooks won't be executed. More information can be found in these docs: - [Webhooks push events](../user/project/integrations/webhooks.md#push-events) -- [Project services push hooks limit](../user/project/integrations/project_services.md#push-hooks-limit) +- [Project services push hooks limit](../user/project/integrations/overview.md#push-hooks-limit) ### Activities diff --git a/doc/administration/logs.md b/doc/administration/logs.md index 01774f8d320..5a6eb95de42 100644 --- a/doc/administration/logs.md +++ b/doc/administration/logs.md @@ -228,7 +228,7 @@ This file lives in `/var/log/gitlab/gitlab-rails/integrations_json.log` for Omnibus GitLab packages or in `/home/git/gitlab/log/integrations_json.log` for installations from source. -It contains information about [integrations](../user/project/integrations/project_services.md) activities such as Jira, Asana, and Irker services. It uses JSON format like the example below: +It contains information about [integrations](../user/project/integrations/overview.md) activities such as Jira, Asana, and Irker services. It uses JSON format like the example below: ```json { diff --git a/doc/ci/enable_or_disable_ci.md b/doc/ci/enable_or_disable_ci.md index 732b4676c56..12ed41e81ee 100644 --- a/doc/ci/enable_or_disable_ci.md +++ b/doc/ci/enable_or_disable_ci.md @@ -30,7 +30,7 @@ either: NOTE: **Note:** This only applies to pipelines run as part of GitLab CI/CD. This will not enable or disable -pipelines that are run from an [external integration](../user/project/integrations/project_services.md#services). +pipelines that are run from an [external integration](../user/project/integrations/overview.md#integrations-listing). ## Per-project user setting diff --git a/doc/ci/variables/README.md b/doc/ci/variables/README.md index 831669b6f6b..1ec4c154039 100644 --- a/doc/ci/variables/README.md +++ b/doc/ci/variables/README.md @@ -435,13 +435,13 @@ To learn more about about scoping environments, see [Scoping environments with s > Introduced in GitLab 8.15. -[Project services](../../user/project/integrations/project_services.md) that are +[Integrations](../../user/project/integrations/overview.md) that are responsible for deployment configuration may define their own variables that are set in the build environment. These variables are only defined for [deployment jobs](../environments.md). Please consult the documentation of -the project services that you are using to learn which variables they define. +the integrations that you are using to learn which variables they define. -An example project service that defines deployment variables is the +An example integration that defines deployment variables is the [Kubernetes integration](../../user/project/clusters/index.md#deployment-variables). ### Auto DevOps environment variables diff --git a/doc/development/integrations/jenkins.md b/doc/development/integrations/jenkins.md index 44ee80b7b3f..31c479bc898 100644 --- a/doc/development/integrations/jenkins.md +++ b/doc/development/integrations/jenkins.md @@ -90,3 +90,22 @@ To activate the Jenkins service you must have a Starter subscription or higher. ## Test your setup Make a change in your repository and open an MR. In your Jenkins project it should have triggered a new build and on your MR, there should be a widget saying "Pipeline #NUMBER passed". It will also include a link to your Jenkins build. + +### Run QA test + +The [jenkins_build_status_spec](https://gitlab.com/gitlab-org/gitlab/-/blob/v12.9.0-ee/qa/qa/specs/features/ee/browser_ui/3_create/jenkins/jenkins_build_status_spec.rb) performs an end-to-end test of the Jenkins setup using [GitLab QA](https://gitlab.com/gitlab-org/gitlab-qa). + +To run the test against your GDK, follow the [run QA tests against your GDK setup](https://gitlab.com/gitlab-org/gitlab-qa/-/blob/master/docs/run_qa_against_gdk.md#run-qa-tests-against-your-gdk-setup) instructions. + +The following environment variables are required to run the test: + +- `GITLAB_USERNAME` +- `GITLAB_PASSWORD` +- `GITLAB_ADMIN_USERNAME` +- `GITLAB_ADMIN_PASSWORD` + +Run the test in the **qa** directory using: + +```shell +bundle exec bin/qa Test::Instance::All http://<your_network_ip_address>:3000 -- qa/specs/features/ee/browser_ui/3_create/jenkins/jenkins_build_status_spec.rb --tag quarantine +``` diff --git a/doc/integration/README.md b/doc/integration/README.md index 5cda537ac39..bba38922b9d 100644 --- a/doc/integration/README.md +++ b/doc/integration/README.md @@ -57,9 +57,9 @@ GitLab can be integrated with the following enhancements: - Attach merge requests to [Trello](trello_power_up.md) cards. - Enable integrated code intelligence powered by [Sourcegraph](sourcegraph.md). -## Project services +## Integrations -Integration with services such as Campfire, Flowdock, HipChat, Pivotal Tracker, and Slack are available as [Project Services](../user/project/integrations/project_services.md). +Integration with services such as Campfire, Flowdock, HipChat, Pivotal Tracker, and Slack are available as [Integrations](../user/project/integrations/overview.md). ## Troubleshooting diff --git a/doc/integration/external-issue-tracker.md b/doc/integration/external-issue-tracker.md index c3328e01081..8b4ebc337de 100644 --- a/doc/integration/external-issue-tracker.md +++ b/doc/integration/external-issue-tracker.md @@ -15,11 +15,11 @@ GitLab menu always opens the internal issue tracker. When disabled, the link is ## Configuration -The configuration is done via a project's **Services**. +The configuration is done via a project's **Integrations**. -### Project Service +### Integration -To enable an external issue tracker you must configure the appropriate **Service**. +To enable an external issue tracker you must configure the appropriate **Integration**. Visit the links below for details: - [Redmine](../user/project/integrations/redmine.md) diff --git a/doc/integration/jenkins.md b/doc/integration/jenkins.md index fee30578be4..5514b756c00 100644 --- a/doc/integration/jenkins.md +++ b/doc/integration/jenkins.md @@ -6,8 +6,8 @@ In GitLab 8.3, Jenkins integration using the was deprecated in favor of the [GitLab Plugin](https://wiki.jenkins.io/display/JENKINS/GitLab+Plugin). The deprecated integration has been renamed to [Jenkins CI (Deprecated)](jenkins_deprecated.md) in the -project service settings. We may remove this in a future release and recommend -using the new 'Jenkins CI' project service instead which is described in this +integration settings. We may remove this in a future release and recommend +using the new 'Jenkins CI' integration instead which is described in this document. ## Overview @@ -138,7 +138,7 @@ configured or there was an error reporting the status via the API. ### Merge Request event does not trigger a Jenkins Pipeline -Check [service hook logs](../user/project/integrations/project_services.md#troubleshooting-project-services) for request failures or check the `/var/log/gitlab/gitlab-rails/production.log` file for messages like: +Check [service hook logs](../user/project/integrations/overview.md#troubleshooting-integrations) for request failures or check the `/var/log/gitlab/gitlab-rails/production.log` file for messages like: ```plaintext WebHook Error => Net::ReadTimeout diff --git a/doc/integration/slash_commands.md b/doc/integration/slash_commands.md index f74a4f1a77f..11abf3ca203 100644 --- a/doc/integration/slash_commands.md +++ b/doc/integration/slash_commands.md @@ -2,7 +2,7 @@ > The `run` command was [introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/4466) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 10.6. [Moved](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/24780) to [GitLab Core](https://about.gitlab.com/pricing/) in 11.9. -Slash commands in Mattermost and Slack allow you to control GitLab and view GitLab content right inside your chat client, without having to leave it. For Slack, this requires a [project service configuration](../user/project/integrations/slack_slash_commands.md). Simply type the command as a message in your chat client to activate it. +Slash commands in Mattermost and Slack allow you to control GitLab and view GitLab content right inside your chat client, without having to leave it. For Slack, this requires an [integration configuration](../user/project/integrations/slack_slash_commands.md). Simply type the command as a message in your chat client to activate it. Commands are scoped to a project, with a trigger term that is specified during configuration. diff --git a/doc/project_services/project_services.md b/doc/project_services/project_services.md index 2ae7a0ce3ce..2d58e0ca065 100644 --- a/doc/project_services/project_services.md +++ b/doc/project_services/project_services.md @@ -1,5 +1,5 @@ --- -redirect_to: '../user/project/integrations/project_services.md' +redirect_to: '../user/project/integrations/overview.md' --- -This document was moved to [another location](../user/project/integrations/project_services.md). +This document was moved to [another location](../user/project/integrations/overview.md). diff --git a/doc/user/index.md b/doc/user/index.md index fdcc87aca0b..b6defdc3f65 100644 --- a/doc/user/index.md +++ b/doc/user/index.md @@ -66,7 +66,7 @@ With GitLab Enterprise Edition, you can also: - Leverage continuous delivery method with [Canary Deployments](project/canary_deployments.md). - Scan your code for vulnerabilities and [display them in merge requests](application_security/sast/index.md). -You can also [integrate](project/integrations/project_services.md) GitLab with numerous third-party applications, such as Mattermost, Microsoft Teams, HipChat, Trello, Slack, Bamboo CI, Jira, and a lot more. +You can also [integrate](project/integrations/overview.md) GitLab with numerous third-party applications, such as Mattermost, Microsoft Teams, HipChat, Trello, Slack, Bamboo CI, Jira, and a lot more. ## Projects diff --git a/doc/user/project/clusters/index.md b/doc/user/project/clusters/index.md index 4594d415fa0..1517e8ad64e 100644 --- a/doc/user/project/clusters/index.md +++ b/doc/user/project/clusters/index.md @@ -78,7 +78,7 @@ Kubernetes clusters can be used without Auto DevOps. > Introduced in GitLab 8.15. -When enabled, the Kubernetes service adds [web terminal](../../../ci/environments.md#web-terminals) +When enabled, the Kubernetes integration adds [web terminal](../../../ci/environments.md#web-terminals) support to your [environments](../../../ci/environments.md). This is based on the `exec` functionality found in Docker and Kubernetes, so you get a new shell session within your existing containers. To use this integration, you should deploy to Kubernetes using diff --git a/doc/user/project/deploy_boards.md b/doc/user/project/deploy_boards.md index daeca8aa614..d8d1db4fbcb 100644 --- a/doc/user/project/deploy_boards.md +++ b/doc/user/project/deploy_boards.md @@ -72,7 +72,7 @@ To display the Deploy Boards for a specific [environment] you should: 1. [Configure GitLab Runner][runners] with the [Docker][docker-exec] or [Kubernetes][kube-exec] executor. -1. Configure the [Kubernetes service][kube-service] in your project for the +1. Configure the [Kubernetes integration][kube-integration] in your project for the cluster. The Kubernetes namespace is of particular note as you will need it for your deployment scripts (exposed by the `KUBE_NAMESPACE` env variable). 1. Ensure Kubernetes annotations of `app.gitlab.com/env: $CI_ENVIRONMENT_SLUG` @@ -151,7 +151,7 @@ version of your application. [environment]: ../../ci/environments.md "Environments and deployments documentation" [docker-exec]: https://docs.gitlab.com/runner/executors/docker.html "GitLab Runner Docker executor" [kube-exec]: https://docs.gitlab.com/runner/executors/kubernetes.html "GitLab Runner Kubernetes executor" -[kube-service]: integrations/kubernetes.md "Kubernetes project service" +[kube-integration]: clusters/index.md "Kubernetes integration" [review apps]: ../../ci/review_apps/index.md "Review Apps documentation" [variables]: ../../ci/variables/README.md "GitLab CI/CD variables" [autodeploy]: ../../topics/autodevops/index.md#auto-deploy "GitLab Autodeploy" diff --git a/doc/user/project/integrations/bamboo.md b/doc/user/project/integrations/bamboo.md index a43082d9415..726b5f657ea 100644 --- a/doc/user/project/integrations/bamboo.md +++ b/doc/user/project/integrations/bamboo.md @@ -37,7 +37,7 @@ service in GitLab. ### Complete these steps in GitLab 1. Navigate to the project you want to configure to trigger builds. -1. Navigate to the [Integrations page](project_services.md#accessing-the-project-services) +1. Navigate to the [Integrations page](overview.md#accessing-integrations) 1. Click 'Atlassian Bamboo CI' 1. Select the 'Active' checkbox. 1. Enter the base URL of your Bamboo server. `https://bamboo.example.com` @@ -55,7 +55,7 @@ service in GitLab. ## Troubleshooting If builds are not triggered, ensure you entered the right GitLab IP address in -Bamboo under 'Trigger IP addresses'. Also check [service hook logs](project_services.md#troubleshooting-project-services) for request failures. +Bamboo under 'Trigger IP addresses'. Also check [service hook logs](overview.md#troubleshooting-integrations) for request failures. NOTE: **Note:** Starting with GitLab 8.14.0, builds are triggered on push events. diff --git a/doc/user/project/integrations/bugzilla.md b/doc/user/project/integrations/bugzilla.md index 109080f463e..de43c504b05 100644 --- a/doc/user/project/integrations/bugzilla.md +++ b/doc/user/project/integrations/bugzilla.md @@ -1,6 +1,6 @@ # Bugzilla Service -Navigate to the [Integrations page](project_services.md#accessing-the-project-services), +Navigate to the [Integrations page](overview.md#accessing-integrations), select the **Bugzilla** service and fill in the required details as described in the table below. @@ -29,4 +29,4 @@ address specified in `issues_url`. ## Troubleshooting -To see recent service hook deliveries, check [service hook logs](project_services.md#troubleshooting-project-services). +To see recent service hook deliveries, check [service hook logs](overview.md#troubleshooting-integrations). diff --git a/doc/user/project/integrations/custom_issue_tracker.md b/doc/user/project/integrations/custom_issue_tracker.md index 99f80aea8d1..848e89c18cb 100644 --- a/doc/user/project/integrations/custom_issue_tracker.md +++ b/doc/user/project/integrations/custom_issue_tracker.md @@ -1,7 +1,7 @@ # Custom Issue Tracker Service To enable the Custom Issue Tracker integration in a project, navigate to the -[Integrations page](project_services.md#accessing-the-project-services), click +[Integrations page](overview.md#accessing-integrations), click the **Customer Issue Tracker** service, and fill in the required details on the page as described in the table below. You will be able to edit the title and description later as well. diff --git a/doc/user/project/integrations/discord_notifications.md b/doc/user/project/integrations/discord_notifications.md index e9fa01246f7..9252b7dd0f9 100644 --- a/doc/user/project/integrations/discord_notifications.md +++ b/doc/user/project/integrations/discord_notifications.md @@ -19,8 +19,8 @@ To send GitLab event notifications to a Discord channel, create a webhook in Dis With the webhook URL created in the Discord channel, you can set up the Discord Notifications service in GitLab. -1. Navigate to the [Integrations page](project_services.md#accessing-the-project-services) in your project's settings. That is, **Project > Settings > Integrations**. -1. Select the **Discord Notifications** project service to configure it. +1. Navigate to the [Integrations page](overview.md#accessing-integrations) in your project's settings. That is, **Project > Settings > Integrations**. +1. Select the **Discord Notifications** integration to configure it. 1. Check the **Active** checkbox to turn on the service. 1. Check the checkboxes corresponding to the GitLab events for which you want to send notifications to Discord. 1. Paste the webhook URL that you copied from the create Discord webhook step. diff --git a/doc/user/project/integrations/emails_on_push.md b/doc/user/project/integrations/emails_on_push.md index 61359dcaa90..b0838690d3b 100644 --- a/doc/user/project/integrations/emails_on_push.md +++ b/doc/user/project/integrations/emails_on_push.md @@ -3,7 +3,7 @@ By enabling this service, you will receive email notifications for every change that is pushed to your project. -From the [Integrations page](project_services.md#accessing-the-project-services) +From the [Integrations page](overview.md#accessing-integrations) select **Emails on push** service to activate and configure it. In the _Recipients_ area, provide a list of emails separated by spaces or newlines. diff --git a/doc/user/project/integrations/github.md b/doc/user/project/integrations/github.md index f84f1bb06cd..2e3801f3a32 100644 --- a/doc/user/project/integrations/github.md +++ b/doc/user/project/integrations/github.md @@ -25,7 +25,7 @@ with `repo:status` access granted: ### Complete these steps on GitLab 1. Navigate to the project you want to configure. -1. Navigate to the [Integrations page](project_services.md#accessing-the-project-services) +1. Navigate to the [Integrations page](overview.md#accessing-integrations) 1. Click "GitHub". 1. Select the "Active" checkbox. 1. Paste the token you've generated on GitHub diff --git a/doc/user/project/integrations/hangouts_chat.md b/doc/user/project/integrations/hangouts_chat.md index 6e77708162d..bd32ef91e3c 100644 --- a/doc/user/project/integrations/hangouts_chat.md +++ b/doc/user/project/integrations/hangouts_chat.md @@ -17,8 +17,8 @@ See also [the Hangouts Chat documentation for configuring incoming webhooks](htt When you have the **Webhook URL** for your Hangouts Chat room webhook, you can set up the GitLab service. -1. Navigate to the [Integrations page](project_services.md#accessing-the-project-services) in your project's settings, i.e. **Project > Settings > Integrations**. -1. Select the **Hangouts Chat** project service to configure it. +1. Navigate to the [Integrations page](overview.md#accessing-integrations) in your project's settings, i.e. **Project > Settings > Integrations**. +1. Select the **Hangouts Chat** integration to configure it. 1. Check the **Active** checkbox to turn on the service. 1. Check the checkboxes corresponding to the GitLab events you want to receive. 1. Paste the **Webhook URL** that you copied from the Hangouts Chat configuration step. diff --git a/doc/user/project/integrations/hipchat.md b/doc/user/project/integrations/hipchat.md index 347f7973c84..1e04e28143a 100644 --- a/doc/user/project/integrations/hipchat.md +++ b/doc/user/project/integrations/hipchat.md @@ -35,7 +35,7 @@ service in GitLab. ### Complete these steps in GitLab 1. Navigate to the project you want to configure for notifications. -1. Navigate to the [Integrations page](project_services.md#accessing-the-project-services) +1. Navigate to the [Integrations page](overview.md#accessing-integrations) 1. Click "HipChat". 1. Select the "Active" checkbox. 1. Insert the `token` field from the URL into the `Token` field on the Web page. diff --git a/doc/user/project/integrations/index.md b/doc/user/project/integrations/index.md index 363e994f36d..21df15c90f4 100644 --- a/doc/user/project/integrations/index.md +++ b/doc/user/project/integrations/index.md @@ -4,13 +4,13 @@ You can find the available integrations under your project's **Settings ➔ Integrations** page. You need to have at least [maintainer permission][permissions] on the project. -## Project services +## Integrations -Project services allow you to integrate GitLab with other applications. +Integrations allow you to integrate GitLab with other applications. They are a bit like plugins in that they allow a lot of freedom in adding functionality to GitLab. -[Learn more about project services.](project_services.md) +[Learn more about integrations.](overview.md) ## Project webhooks diff --git a/doc/user/project/integrations/irker.md b/doc/user/project/integrations/irker.md index cadf01c382a..f7e129d1e7f 100644 --- a/doc/user/project/integrations/irker.md +++ b/doc/user/project/integrations/irker.md @@ -26,7 +26,7 @@ need to follow the firsts steps of the next section. ## Complete these steps in GitLab 1. Navigate to the project you want to configure for notifications. -1. Navigate to the [Integrations page](project_services.md#accessing-the-project-services) +1. Navigate to the [Integrations page](overview.md#accessing-integrations) 1. Click "Irker". 1. Select the "Active" checkbox. 1. Enter the server host address where `irkerd` runs (defaults to `localhost`) diff --git a/doc/user/project/integrations/jira.md b/doc/user/project/integrations/jira.md index 76b1d187698..cef9300fc67 100644 --- a/doc/user/project/integrations/jira.md +++ b/doc/user/project/integrations/jira.md @@ -65,7 +65,7 @@ In order to enable the Jira service in GitLab, you need to first configure the p > a value of `fromDialog`. To enable the Jira integration in a project, navigate to the -[Integrations page](project_services.md#accessing-the-project-services), click +[Integrations page](overview.md#accessing-integrations), click the **Jira** service, and fill in the required details on the page as described in the table below. @@ -101,7 +101,7 @@ When you reference a Jira issue, it will always link back to the source commit/M To disable the automated commenting on Jira issues: -1. Open the [Integrations page](project_services.md#accessing-the-project-services) and select **Jira**. +1. Open the [Integrations page](overview.md#accessing-integrations) and select **Jira**. 1. In the **Event Action** section, uncheck **Comment**. ## Jira issues diff --git a/doc/user/project/integrations/mattermost.md b/doc/user/project/integrations/mattermost.md index c240b6cb6b4..67d60984c22 100644 --- a/doc/user/project/integrations/mattermost.md +++ b/doc/user/project/integrations/mattermost.md @@ -27,7 +27,7 @@ Display name override is not enabled by default, you need to ask your admin to e After you set up Mattermost, it's time to set up GitLab. -Navigate to the [Integrations page](project_services.md#accessing-the-project-services) +Navigate to the [Integrations page](overview.md#accessing-integrations) and select the **Mattermost notifications** service to configure it. There, you will see a checkbox with the following events that can be triggered: diff --git a/doc/user/project/integrations/mattermost_slash_commands.md b/doc/user/project/integrations/mattermost_slash_commands.md index 563cad717e2..35bcc907185 100644 --- a/doc/user/project/integrations/mattermost_slash_commands.md +++ b/doc/user/project/integrations/mattermost_slash_commands.md @@ -53,7 +53,7 @@ the administrator console. ### Step 2. Open the Mattermost slash commands service in GitLab 1. Open a new tab for GitLab, go to your project's - [Integrations page](project_services.md#accessing-the-project-services) + [Integrations page](overview.md#accessing-integrations) and select the **Mattermost command** service to configure it. A screen will appear with all the values you need to copy in Mattermost as described in the next step. Leave the window open. diff --git a/doc/user/project/integrations/microsoft_teams.md b/doc/user/project/integrations/microsoft_teams.md index f2a94de9906..6d37646d75b 100644 --- a/doc/user/project/integrations/microsoft_teams.md +++ b/doc/user/project/integrations/microsoft_teams.md @@ -9,7 +9,7 @@ Teams by following the steps described in [Sending messages to Connectors and We After you set up Microsoft Teams, it's time to set up GitLab. -Navigate to the [Integrations page](project_services.md#accessing-the-project-services) +Navigate to the [Integrations page](overview.md#accessing-integrations) and select the **Microsoft Teams Notification** service to configure it. There, you will see a checkbox with the following events that can be triggered: diff --git a/doc/user/project/integrations/overview.md b/doc/user/project/integrations/overview.md new file mode 100644 index 00000000000..b973abbe210 --- /dev/null +++ b/doc/user/project/integrations/overview.md @@ -0,0 +1,108 @@ +# Integrations + +Integrations allow you to integrate GitLab with other applications. They +are a bit like plugins in that they allow a lot of freedom in adding +functionality to GitLab. + +## Accessing integrations + +You can find the available integrations under your project's +**Settings ➔ Integrations** page. + +There are more than 20 integrations to integrate with. Click on the one that you +want to configure. + +![Integrations list](img/project_services.png) + +Below, you will find a list of the currently supported ones accompanied with comprehensive documentation. + +## Integrations listing + +Click on the service links to see further configuration instructions and details. + +| Service | Description | Service Hooks | +| ------- | ----------- | ------------- | +| Asana | Asana - Teamwork without email | No | +| Assembla | Project Management Software (Source Commits Endpoint) | No | +| [Atlassian Bamboo CI](bamboo.md) | A continuous integration and build server | Yes | +| Buildkite | Continuous integration and deployments | Yes | +| [Bugzilla](bugzilla.md) | Bugzilla issue tracker | No | +| Campfire | Simple web-based real-time group chat | No | +| Custom Issue Tracker | Custom issue tracker | No | +| [Discord Notifications](discord_notifications.md) | Receive event notifications in Discord | No | +| Drone CI | Continuous Integration platform built on Docker, written in Go | Yes | +| [Emails on push](emails_on_push.md) | Email the commits and diff of each push to a list of recipients | No | +| External Wiki | Replaces the link to the internal wiki with a link to an external wiki | No | +| Flowdock | Flowdock is a collaboration web app for technical teams | No | +| [Generic alerts](generic_alerts.md) **(ULTIMATE)** | Receive alerts on GitLab from any source | No | +| [GitHub](github.md) **(PREMIUM)** | Sends pipeline notifications to GitHub | No | +| [Hangouts Chat](hangouts_chat.md) | Receive events notifications in Google Hangouts Chat | No | +| [HipChat](hipchat.md) | Private group chat and IM | No | +| [Irker (IRC gateway)](irker.md) | Send IRC messages, on update, to a list of recipients through an Irker gateway | No | +| [Jira](jira.md) | Jira issue tracker | No | +| [Jenkins](../../../integration/jenkins.md) **(STARTER)** | An extendable open source continuous integration server | Yes | +| JetBrains TeamCity CI | A continuous integration and build server | Yes | +| [Mattermost slash commands](mattermost_slash_commands.md) | Mattermost chat and ChatOps slash commands | No | +| [Mattermost Notifications](mattermost.md) | Receive event notifications in Mattermost | No | +| [Microsoft teams](microsoft_teams.md) | Receive notifications for actions that happen on GitLab into a room on Microsoft Teams using Office 365 Connectors | No | +| Packagist | Update your project on Packagist, the main Composer repository | Yes | +| Pipelines emails | Email the pipeline status to a list of recipients | No | +| [Slack Notifications](slack.md) | Send GitLab events (e.g. issue created) to Slack as notifications | No | +| [Slack slash commands](slack_slash_commands.md) **(CORE ONLY)** | Use slash commands in Slack to control GitLab | No | +| [GitLab Slack application](gitlab_slack_application.md) **(FREE ONLY)** | Use Slack's official application | No | +| PivotalTracker | Project Management Software (Source Commits Endpoint) | No | +| [Prometheus](prometheus.md) | Monitor the performance of your deployed apps | No | +| Pushover | Pushover makes it easy to get real-time notifications on your Android device, iPhone, iPad, and Desktop | No | +| [Redmine](redmine.md) | Redmine issue tracker | No | +| [Unify Circuit](unify_circuit.md) | Receive events notifications in Unify Circuit | No | +| [YouTrack](youtrack.md) | YouTrack issue tracker | No | + +## Push hooks limit + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17874) in GitLab 12.4. + +If a single push includes changes to more than three branches or tags, services +supported by `push_hooks` and `tag_push_hooks` events won't be executed. + +The number of branches or tags supported can be changed via +[`push_event_hooks_limit` application setting](../../../api/settings.md#list-of-settings-that-can-be-accessed-via-api-calls). + +## Services templates + +Services templates is a way to set some predefined values in the Service of +your liking which will then be pre-filled on each project's Service. + +Read more about [Services templates in this document](services_templates.md). + +## Troubleshooting integrations + +Some integrations use service hooks for integration with external applications. To confirm which ones use service hooks, see the [integrations listing](#integrations-listing). GitLab stores details of service hook requests made within the last 2 days. To view details of the requests, go to the service's configuration page. + +The **Recent Deliveries** section lists the details of each request made within the last 2 days: + +- HTTP status code (green for 200-299 codes, red for the others, `internal error` for failed deliveries) +- Triggered event +- URL to which the request was sent +- Elapsed time of the request +- Relative time in which the request was made + +To view more information about the request's execution, click the respective **View details** link. +On the details page, you can see the data sent by GitLab (request headers and body) and the data received by GitLab (response headers and body). + +From this page, you can repeat delivery with the same data by clicking **Resend Request**. + +![Recent deliveries](img/webhook_logs.png) + +## Contributing to integrations + +Because GitLab is open source we can ship with the code and tests for all +plugins. This allows the community to keep the plugins up to date so that they +always work in newer GitLab versions. + +For an overview of what integrations are available, please see the +[project_services source directory][projects-code]. + +Contributions are welcome! + +[projects-code]: https://gitlab.com/gitlab-org/gitlab-foss/tree/master/app/models/project_services +[permissions]: ../../permissions.md diff --git a/doc/user/project/integrations/project_services.md b/doc/user/project/integrations/project_services.md index 96221971908..2c681db1692 100644 --- a/doc/user/project/integrations/project_services.md +++ b/doc/user/project/integrations/project_services.md @@ -1,108 +1 @@ -# Project services - -Project services allow you to integrate GitLab with other applications. They -are a bit like plugins in that they allow a lot of freedom in adding -functionality to GitLab. - -## Accessing the project services - -You can find the available services under your project's -**Settings ➔ Integrations** page. - -There are more than 20 services to integrate with. Click on the one that you -want to configure. - - ![Project services list](img/project_services.png) - -Below, you will find a list of the currently supported ones accompanied with comprehensive documentation. - -## Services - -Click on the service links to see further configuration instructions and details. - -| Service | Description | Service Hooks | -| ------- | ----------- | ------------- | -| Asana | Asana - Teamwork without email | No | -| Assembla | Project Management Software (Source Commits Endpoint) | No | -| [Atlassian Bamboo CI](bamboo.md) | A continuous integration and build server | Yes | -| Buildkite | Continuous integration and deployments | Yes | -| [Bugzilla](bugzilla.md) | Bugzilla issue tracker | No | -| Campfire | Simple web-based real-time group chat | No | -| Custom Issue Tracker | Custom issue tracker | No | -| [Discord Notifications](discord_notifications.md) | Receive event notifications in Discord | No | -| Drone CI | Continuous Integration platform built on Docker, written in Go | Yes | -| [Emails on push](emails_on_push.md) | Email the commits and diff of each push to a list of recipients | No | -| External Wiki | Replaces the link to the internal wiki with a link to an external wiki | No | -| Flowdock | Flowdock is a collaboration web app for technical teams | No | -| [Generic alerts](generic_alerts.md) **(ULTIMATE)** | Receive alerts on GitLab from any source | No | -| [GitHub](github.md) **(PREMIUM)** | Sends pipeline notifications to GitHub | No | -| [Hangouts Chat](hangouts_chat.md) | Receive events notifications in Google Hangouts Chat | No | -| [HipChat](hipchat.md) | Private group chat and IM | No | -| [Irker (IRC gateway)](irker.md) | Send IRC messages, on update, to a list of recipients through an Irker gateway | No | -| [Jira](jira.md) | Jira issue tracker | No | -| [Jenkins](../../../integration/jenkins.md) **(STARTER)** | An extendable open source continuous integration server | Yes | -| JetBrains TeamCity CI | A continuous integration and build server | Yes | -| [Mattermost slash commands](mattermost_slash_commands.md) | Mattermost chat and ChatOps slash commands | No | -| [Mattermost Notifications](mattermost.md) | Receive event notifications in Mattermost | No | -| [Microsoft teams](microsoft_teams.md) | Receive notifications for actions that happen on GitLab into a room on Microsoft Teams using Office 365 Connectors | No | -| Packagist | Update your project on Packagist, the main Composer repository | Yes | -| Pipelines emails | Email the pipeline status to a list of recipients | No | -| [Slack Notifications](slack.md) | Send GitLab events (e.g. issue created) to Slack as notifications | No | -| [Slack slash commands](slack_slash_commands.md) **(CORE ONLY)** | Use slash commands in Slack to control GitLab | No | -| [GitLab Slack application](gitlab_slack_application.md) **(FREE ONLY)** | Use Slack's official application | No | -| PivotalTracker | Project Management Software (Source Commits Endpoint) | No | -| [Prometheus](prometheus.md) | Monitor the performance of your deployed apps | No | -| Pushover | Pushover makes it easy to get real-time notifications on your Android device, iPhone, iPad, and Desktop | No | -| [Redmine](redmine.md) | Redmine issue tracker | No | -| [Unify Circuit](unify_circuit.md) | Receive events notifications in Unify Circuit | No | -| [YouTrack](youtrack.md) | YouTrack issue tracker | No | - -## Push hooks limit - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/17874) in GitLab 12.4. - -If a single push includes changes to more than three branches or tags, services -supported by `push_hooks` and `tag_push_hooks` events won't be executed. - -The number of branches or tags supported can be changed via -[`push_event_hooks_limit` application setting](../../../api/settings.md#list-of-settings-that-can-be-accessed-via-api-calls). - -## Services templates - -Services templates is a way to set some predefined values in the Service of -your liking which will then be pre-filled on each project's Service. - -Read more about [Services templates in this document](services_templates.md). - -## Troubleshooting project services - -Some project services use service hooks for integration with external applications. To confirm which ones use service hooks, see the [services table](#services). GitLab stores details of service hook requests made within the last 2 days. To view details of the requests, go to the service's configuration page. - -The **Recent Deliveries** section lists the details of each request made within the last 2 days: - -- HTTP status code (green for 200-299 codes, red for the others, `internal error` for failed deliveries) -- Triggered event -- URL to which the request was sent -- Elapsed time of the request -- Relative time in which the request was made - -To view more information about the request's execution, click the respective **View details** link. -On the details page, you can see the data sent by GitLab (request headers and body) and the data received by GitLab (response headers and body). - -From this page, you can repeat delivery with the same data by clicking **Resend Request**. - -![Recent deliveries](img/webhook_logs.png) - -## Contributing to project services - -Because GitLab is open source we can ship with the code and tests for all -plugins. This allows the community to keep the plugins up to date so that they -always work in newer GitLab versions. - -For an overview of what projects services are available, please see the -[project_services source directory][projects-code]. - -Contributions are welcome! - -[projects-code]: https://gitlab.com/gitlab-org/gitlab-foss/tree/master/app/models/project_services -[permissions]: ../../permissions.md +This document was moved to [Integrations](overview.md). diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index 230b4a379b1..04be63de5ea 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -105,7 +105,7 @@ The actual configuration of Prometheus integration within GitLab is very simple. All you will need is the domain name or IP address of the Prometheus server you'd like to integrate with. -1. Navigate to the [Integrations page](project_services.md#accessing-the-project-services). +1. Navigate to the [Integrations page](overview.md#accessing-integrations). 1. Click the **Prometheus** service. 1. Provide the domain name or IP address of your server, for example `http://prometheus.example.com/` or `http://192.0.2.1/`. 1. Click **Save changes**. @@ -118,7 +118,7 @@ You can configure [Thanos](https://thanos.io/) as a drop-in replacement for Prom with GitLab. You will need the domain name or IP address of the Thanos server you'd like to integrate with. -1. Navigate to the [Integrations page](project_services.md#accessing-the-project-services). +1. Navigate to the [Integrations page](overview.md#accessing-integrations). 1. Click the **Prometheus** service. 1. Provide the domain name or IP address of your server, for example `http://thanos.example.com/` or `http://192.0.2.1/`. 1. Click **Save changes**. diff --git a/doc/user/project/integrations/redmine.md b/doc/user/project/integrations/redmine.md index 56e219fade5..9e1cdf0490c 100644 --- a/doc/user/project/integrations/redmine.md +++ b/doc/user/project/integrations/redmine.md @@ -1,7 +1,7 @@ # Redmine Service 1. To enable the Redmine integration in a project, navigate to the - [Integrations page](project_services.md#accessing-the-project-services), click + [Integrations page](overview.md#accessing-integrations), click the **Redmine** service, and fill in the required details on the page as described in the table below. diff --git a/doc/user/project/integrations/slack.md b/doc/user/project/integrations/slack.md index c6a8941785a..6ceb398fa17 100644 --- a/doc/user/project/integrations/slack.md +++ b/doc/user/project/integrations/slack.md @@ -12,8 +12,8 @@ The Slack Notifications Service allows your GitLab project to send events (e.g. ## GitLab Configuration -1. Navigate to the [Integrations page](project_services.md#accessing-the-project-services) in your project's settings, i.e. **Project > Settings > Integrations**. -1. Select the **Slack notifications** project service to configure it. +1. Navigate to the [Integrations page](overview.md#accessing-integrations) in your project's settings, i.e. **Project > Settings > Integrations**. +1. Select the **Slack notifications** integration to configure it. 1. Check the **Active** checkbox to turn on the service. 1. Check the checkboxes corresponding to the GitLab events you want to send to Slack as a notification. 1. For each event, optionally enter the Slack channel names where you want to send the event, separated by a comma. If left empty, the event will be sent to the default channel that you configured in the Slack Configuration step. **Note:** Usernames and private channels are not supported. To send direct messages, use the Member ID found under user's Slack profile. diff --git a/doc/user/project/integrations/slack_slash_commands.md b/doc/user/project/integrations/slack_slash_commands.md index 813066c51ac..d39d5cde46a 100644 --- a/doc/user/project/integrations/slack_slash_commands.md +++ b/doc/user/project/integrations/slack_slash_commands.md @@ -13,8 +13,8 @@ For GitLab.com, use the [Slack app](gitlab_slack_application.md) instead. ## Configuration -1. Slack slash commands are scoped to a project. Navigate to the [Integrations page](project_services.md#accessing-the-project-services) in your project's settings, i.e. **Project > Settings > Integrations**. -1. Select the **Slack slash commands** project service to configure it. This page contains required information to complete the configuration in Slack. Leave this browser tab open. +1. Slack slash commands are scoped to a project. Navigate to the [Integrations page](overview.md#accessing-integrations) in your project's settings, i.e. **Project > Settings > Integrations**. +1. Select the **Slack slash commands** integration to configure it. This page contains required information to complete the configuration in Slack. Leave this browser tab open. 1. Open a new browser tab and sign in to your Slack team. [Start a new Slash Commands integration](https://my.slack.com/services/new/slash-commands). 1. Enter a trigger term. We suggest you use the project name. Click **Add Slash Command Integration**. 1. Complete the rest of the fields in the Slack configuration page using information from the GitLab browser tab. In particular, the URL needs to be copied and pasted. Click **Save Integration** to complete the configuration in Slack. diff --git a/doc/user/project/integrations/unify_circuit.md b/doc/user/project/integrations/unify_circuit.md index e357afb9224..51f524f95c3 100644 --- a/doc/user/project/integrations/unify_circuit.md +++ b/doc/user/project/integrations/unify_circuit.md @@ -15,8 +15,8 @@ For more information, see the [Unify Circuit documentation for configuring incom When you have the **Webhook URL** for your Unify Circuit conversation webhook, you can set up the GitLab service. -1. Navigate to the [Integrations page](project_services.md#accessing-the-project-services) in your project's settings, i.e. **Project > Settings > Integrations**. -1. Select the **Unify Circuit** project service to configure it. +1. Navigate to the [Integrations page](overview.md#accessing-integrations) in your project's settings, i.e. **Project > Settings > Integrations**. +1. Select the **Unify Circuit** integration to configure it. 1. Check the **Active** checkbox to turn on the service. 1. Check the checkboxes corresponding to the GitLab events you want to receive in Unify Circuit. 1. Paste the **Webhook URL** that you copied from the Unify Circuit configuration step. diff --git a/doc/user/project/integrations/youtrack.md b/doc/user/project/integrations/youtrack.md index 81c148e41fd..a72eaaa9ff1 100644 --- a/doc/user/project/integrations/youtrack.md +++ b/doc/user/project/integrations/youtrack.md @@ -8,7 +8,7 @@ You can configure YouTrack as an [External Issue Tracker](../../../integration/e To enable YouTrack integration in a project: -1. Navigate to the project's **Settings > [Integrations](project_services.md#accessing-the-project-services)** page. +1. Navigate to the project's **Settings > [Integrations](overview.md#accessing-integrations)** page. 1. Click the **YouTrack** service, ensure it's active, and enter the required details on the page as described in the table below. | Field | Description | diff --git a/doc/user/project/merge_requests/merge_when_pipeline_succeeds.md b/doc/user/project/merge_requests/merge_when_pipeline_succeeds.md index cc3e00bc098..50412e0b319 100644 --- a/doc/user/project/merge_requests/merge_when_pipeline_succeeds.md +++ b/doc/user/project/merge_requests/merge_when_pipeline_succeeds.md @@ -39,7 +39,7 @@ You can prevent merge requests from being merged if their pipeline did not succe or if there are threads to be resolved. This works for both: - GitLab CI/CD pipelines -- Pipelines run from an [external CI integration](../integrations/project_services.md#services) +- Pipelines run from an [external CI integration](../integrations/overview.md#integrations-listing) As a result, [disabling GitLab CI/CD pipelines](../../../ci/enable_or_disable_ci.md) will not disable this feature, as it will still be possible to use pipelines from external diff --git a/doc/user/project/repository/web_editor.md b/doc/user/project/repository/web_editor.md index f1947066279..3a6fef0bc51 100644 --- a/doc/user/project/repository/web_editor.md +++ b/doc/user/project/repository/web_editor.md @@ -124,7 +124,7 @@ When you click the **Create branch** button in an empty repository project, GitLab automatically creates a `master` branch, commits a blank `README.md` file to it, and creates and redirects you to a new branch based on the issue title. -If your [project is already configured with a deployment service](../integrations/project_services.md), +If your [project is already configured with a deployment service](../integrations/overview.md), such as Kubernetes, GitLab takes one step further and prompts you to set up [auto deploy](../../../topics/autodevops/index.md#auto-deploy) by helping you create a `.gitlab-ci.yml` file. |