GitLab

Overview

GitLab is a web-based DevOps platform that allows software development teams to collaborate, manage source code repositories, track issues, and automate the software delivery pipeline.

Entitle can manage groups (all versions) and projects (on-prem version only) in GitLab.

This page will provide you with instructions on how to integrate Entitle and GitLab.

General guidelines

To integrate your GitLab in Entitle, you will need to create a Personal Access Token.

Set up Gitlab to work with Entitle

Stage 1: Obtain your GitLab domain

1. Copy the domain you use to log in to GitLab.
2. If you don’t use a self-hosted GitLab domain, the domain is https://gitlab.com.

Stage 2: Create a Personal Access Token

1. In the upper-right corner, select your avatar.
2. Select Edit profile.

3. On the left sidebar, select Access Tokens.
4. Enter a name and expiry date for the token.
5. The token expires on that date at midnight UTC.
6. If you do not enter an expiry date, the expiry date is automatically set to 365 days later than the current date.
7. Select the api scope.
8. Select Create personal access token, and copy it to your clipboard. You will need it for the configuration later on in this guide.

ℹ️

Note

Entitle supports fetching user emails from Gitlab:

• This will be possible only if a GitLab user adds their email address under the Email or Public email fields on their Profile.

• If the Email field is empty, Entitle will attempt to fetch the Public email instead.

• If both the Email and Public email fields are empty, Entitle will not be able to fetch the user’s email.

  

Create the integration in Entitle

All that is left to do is create an integration on the Entitle application.

1. Log into Entitle and navigate to the Integrations page.
2. After clicking the Add Integration button, type GitLab in the Application field.
3. Don’t forget to set the Save on field with your configuration, i.e. your own hosted agent or Entitle’s cloud.

4. Under the 'domain' field, fill in your GitLab domain URL.
   1. If you don’t use a self-hosted GitLab domain, fill in https://gitlab.com.
5. Under the 'private_token' field, fill in your Salesforce domain URL.
6. Optional: Provide an SSL certificate

   📘

   Notes

   • General Behavior

     • If no certificate is provided, verify=true is the default behavior.
     • If verify=false is set, SSL verification is disabled, and the connection will work without a certificate.

   • Public vs. Self-Signed Certificates

     • Public certificates: No need to provide ca_cert.
     • Self-signed certificates: You must provide ca_cert.
       In this case, you will need to ensure that the agent has access to the domain.
       You can use the following script on your ca file to get the correct format for ca to provide:
       
       
     JSON

     #!/bin/bash
     
     # Check if the file path is provided
     if [ -z "$1" ]; then
         echo "Usage: $0 <path_to_ca.crt>"
         exit 1
     fi
     
     # Read the file
     if [ ! -f "$1" ]; then
         echo "File not found: $1"
         exit 1
     fi
     
     # Convert the file contents to a single line with \n instead of newlines
     crt_string=$(awk '{printf "%s\\n", $0}' "$1")
     
     # Print the result
     echo "$crt_string"
     

     
     

   1. To use a self-signed certificate, provide under the "options" field "ca_cert" under "SSL" in the following format:
      JSON

      options = {
          "ssl": {
              "ca_cert": "/etc/ssl/certs/custom_ca.pem"
          }
      }
      

   2. If not using a self-signed certificate, ca_cert is not required.
   3. If you don’t want to provide ca_cert but would like Entitle to work, set verify=false.
   4. Set correct permissions using:
      Shell

      chmod +x convert_crt.sh 
      then 
      ./convert_crt.sh path-to/ca.crt
      

7. Example Connection JSON with “options” field:

{
  "domain": "<YOUR_GITLAB_DOMAIN>",
  "private_token": "<YOUR_PRIVATE_TOKEN>"
  "options": = {
    "ssl": {
        "ca_cert": "/etc/ssl/certs/custom_ca.pem"
    }
  }
}

7. Click Save.
   The Entitle integration with GitLab saves