GitLab Cloud

GitLab is a DevOps platform that provides Git repos, CI/CD pipelines, issue management, and more.

SEI supports two integrations to integrate SEI with GIthub.

• Gitlab Cloud

• Gitlab Enterprise

To integrate with Gitlab Enterprise, use the SEI Gitlab Enterprise integration.

Configuring the authentication

The SEI GitLab Cloud integration can use either OAuth or personal access token authentication.

For OAuth, your account must have the Reporter role or higher.

If you can't use OAuth, you must create a GitLab Personal Access Token to configure the SEI GitLab integration.

1. Log in to your GitLab account and create a Personal Access Token. For instructions, go to the GitLab documentation on Personal access tokens.

2. Select the api scope with complete read/write API access.

3. Copy the token somewhere that you can retrieve it when you configure the integration.

SEI fetches the history for both the builds jobs and triggers jobs for each pipeline from GitLab. The list of all jobs is available in the job selection tab under Deployment Frequency when configuring the DORA profile.

Configure the integration on cloud

1. Select Integrations under Settings.

2. Select Available Integrations, locate the GitLab Cloud integration, and select Install. Note: To integrate with an on-premises, privately-hosted GitLab instance, install the GitLab Enterprise integration with API key (personal access token) authentication and an Ingestion Satellite. To learn more, Go to Gitlab Enterprise integration.

3. Select an authentication method for the integration:

   1. To use OAuth, select Authorize and follow the prompts to grant access to GitLab.

   2. To use a personal access token, enter the URL for your GitLab instance and paste your Access Token.

4. In Integration Name, enter a name for the integration.

5. Finish configuration and save the integration.

Configure the integration using satellite

The steps for configuring the integration using satellite is similar to configuring the integration on the cloud using the PAT, with the exception of using the satellite to communicate with the Gitlab server.

Make sure to select the satellite integration checkbox while configuring the integration. If you experience any issues while configuring the integration using the Ingestion Satellite, refer to the Ingestion Satellite Troubleshooting and FAQs.

1. Enter the Personal Access Token and click Next.

2. In Integration Name, enter a name for the integration.

3. Add a description for the integration. (Optional)

4. In the URL field, add the URL where your Gitlab repository is deployed. For example, if your Gitlab is deployed on a virtual machine (VM), add the URL in the format: https://<GITLAB_INSTANCE>.

5. If applicable, configure Additional Options:

   1. Fetch PRs: Allow SEI to ingest PR data from GitLab.

   2. Fetch Issues: Allow SEI to ingest data from GitLab Issues.

   3. Fetch Projects: Allow SEI to ingest data from GitLab Projects.

   4. Fetch Commits: Allow SEI to ingest commit metadata from GitLab.

   5. Fetch Commit Files: Allow SEI to ingest data within commits from GitLab.

Note that SEI fetches a maximum of 250 commits for a pull request.

6. Select Next and click on Download Config and save the satellite.yml file. Update it following the instructions here.

Here’s a sample satellite.yml file:

satellite:
  tenant: foo
  api_key: <api-key>
  url: 'https://testapi1.propelo.ai'
integrations:
  - id: '4691'
    application: gitlab
    url: ' https://<IP_ADDRESS>/'
    metadata:
      fetch_prs: true
      fetch_issues: true
      fetch_projects: true
      fetch_commits: true
      fetch_commit_files: true
    authentication: apikey

Use the following optional metadata fields to optimize the ingestion functionality while configuring the integration using the Ingestion Satellite:

Name	Field	Values	Properties
Check Project Membership	check_project_membership	The supported values are True/False. By default, this field is set to True.	When set to True, SEI selectively considers projects based on token owner membership. For self-hosted Gitlab instances, switching to False enables SEI to fetch all projects, regardless of the membership. You should never disable this for cloud Gitlab instances.
Fetch PR Patches	fetch_pr_patches	The supported values are True/False	This field determines whether to retrieve patches or file differentials for Pull Requests (PRs).
Fetch Commit Patches	fetch_commit_patches	The supported values are True/False	This field governs the inclusion of commit patches or file differentials in the data.
Fetch Pipelines	fetch_pipelines	The supported values are True/False	This field specifies whether to fetch pipeline data.
PR Commit Limit	pr_commit_limit	Default value: 250	This field sets a cap on the number of commits fetched per Pull Request.