Integrations

Set up Tidal Control GitLab integration


title: Set up Tidal Control GitLab integration sidebar_position: 1

Setting up the Tidal Control GitLab integration

This guide will walk you through setting up the integration between Tidal Control and GitLab. This integration enables our Tests functionality to automatically retrieve evidence from your GitLab environment.

Creating a GitLab access token

You can use a personal, group, or project access token to integrate with Tidal Control. The steps below guide you through creating a personal access token. For more information on GitLab access tokens, please refer to the GitLab documentation.

Tip

While project access tokens are supported, we recommend using a personal or group access token as project access tokens may have insufficient permissions for some tests.

  1. Navigate to your GitLab environment and log in.

  2. Click on your profile icon in the top left corner and select Edit profile.

  3. In the left sidebar, click on Access Tokens.

  4. Under Personal Access Tokens, click on Add new token.

  5. Fill in the following fields:

    • Name: Enter a name for your token (e.g., Tidal Control).
    • Description: (Optional) Enter a description for your token.
    • Expiration date: (Optional) Set an expiration date for your token.
    Tip

    For optimal experience, we recommend clearing the expiration date field to set the token to its maximum allowed lifetime. Alternatively, you can set a specific expiration period based on your organization's security policies.

    Warning

    When your access token expires, Tidal Control will lose its ability to fetch data from your GitLab environment. You'll need to either create a new token or rotate the existing one to restore the integration. In both cases, you will also need to set it up again in Tidal Control.

    • Scopes: Select read_api.
  6. Click on Create personal access token.

    Warning

    You will only see the token once, so make sure to copy it and store it securely. If you lose it, you will need to create a new one.

Configuring the GitLab integration in Tidal Control

  1. Navigate to the Tidal Portal and log in.

  2. Go to Settings and then Integrations. This requires that you have SUPER_USER permissions within Tidal Control.

    Warning

    This requires that you have SUPER_USER permissions within Tidal Control.

  3. Click on the plus icon next to "GitLab".

  4. Provide the following information:

    • Name: Enter a name for your GitLab integration (e.g., GitLab Integration).
    • Host: Enter the URL of your GitLab instance (e.g., https://gitlab.com).
    • Access Token: Paste the access token you created earlier.
    Add GitLab integration
  5. Click on Create to save the integration settings.