GitLab Integration

The GitLab Integration allows Turbot Pipes access to your GitLab projects to be able to search and install custom mods from private and public projects.

Once a GitLab integration has been added, you will be able to browse and install both private and public mods from the projects in scope and constrain them by either a semantic version constraint or branch. Pipes will detect changes to the source repository and automatically synchronize these changes to your workspaces!

Creating the GitLab Integration

You can create an integration for a tenant or an identity (organization or developer account). Where you create the integration affects the scope of the resources it creates; the resulting mods are only visible within the entity in which it was created.

Level	Plan	Description
Tenant	Enterprise	Mods are available to all workspaces in the tenant.
Org	Team or Enterprise	Mods are available to all workspaces in the organization.
User (Developer Account)	any	Mods are available to all workspaces in the account.

First, navigate to the Integrations page for the appropriate resource:

To configure a GitLab integration for your Developer Account, click the double arrow button from the navigation at the top of the page, select your account from the dropdown, and then select the Integrations tab to manage integrations for your account.
To configure a GitLab integration for your Organization, click the double arrow button from the organization switcher at the top of the page and select the organization from the dropdown. Once you've selected your organization, go to the Integrations tab to manage the integrations for the organization.
To configure a GitLab integration for your Tenant, click the double arrow button from the tenant switcher at the top of the Pipes console, select your tenant, and then select Tenant Settings. This option will only be visible in a custom tenant for which you are a tenant owner. Once you've selected your tenant, go to the Integrations tab to manage the integrations for the tenant.

Next, click the New Integration button. You will be asked to select the type of integration to be created.

Select GitLab and click Next.

GitLab Integration configuration management form shows up. Enter the following information:

Handle for the integration. This handle should be meaningful and must be unique for all integrations in the tenant (including any org-level integrations).
Host for your GitLab installation which defaults to gitlab.com.
Token to be used by Pipes to discover projects. Please note that the token must be granted api scope which is required to create and manage webhooks that enables Pipes to keep the mods managed by the integration up-to-date. Pipes supports personal, group or project access tokens.
Filter path denotes the path of the group / project where Pipes will setup the webhook and restrict project searches to. Note that this field is required when using a personal access token and must be the path to a single project. It is optional when using a group token and cannot be set when using a project token.

Click on Test to verify whether your configuration is accurate before creating the integration. Click on Create after entering the appropriate information.

After clicking on Create, Pipes will validate the configuration and setup the necessary webhook at the desired level. You will then be re-directed back to the integration list page with the new GitLab integration setup and ready for usage.

Modifying the GitLab Integration

After you have created a GitLab integration, you are only allowed to change its Handle and Access Token.

Navigate to the Integrations page for the appropriate resource:

To configure a GitLab integration for your Developer Account, click the double arrow button from the navigation at the top of the page, select your account from the dropdown, and then select the Integrations tab to manage integrations for your account.
To configure a GitLab integration for your Organization, click the double arrow button from the organization switcher at the top of the page and select the organization from the dropdown. Once you've selected your organization, go to the Integrations tab to manage the integrations for the organization.
To configure a GitLab integration for your Tenant, click the double arrow button from the tenant switcher at the top of the Pipes console, select your tenant, and then select Tenant Settings. This option will only be visible in a custom tenant for which you are a tenant owner. Once you've selected your tenant, go to the Integrations tab to manage the integrations for the tenant.

Click on the appropriate GitLab integration which you want to modify.

Token can be modified in the Config tab.
Handle can be edited from the Advanced tab.

Deleting the GitLab Integration

You can delete an integration from its Advanced page.

If you delete a GitLab integration, all of its associated mods will be removed from all workspaces the next time they are rebooted. This action is not reversible!

Navigate to the Integrations page for the appropriate resource:

To configure a GitLab integration for your Developer Account, click the double arrow button from the navigation at the top of the page, select your account from the dropdown, and then select the Integrations tab to manage integrations for your account.
To configure a GitLab integration for your Organization, click the double arrow button from the organization switcher at the top of the page and select the organization from the dropdown. Once you've selected your organization, go to the Integrations tab to manage the integrations for the organization.
To configure a GitLab integration for your Tenant, click the double arrow button from the tenant switcher at the top of the Pipes console, select your tenant, and then select Tenant Settings. This option will only be visible in a custom tenant for which you are a tenant owner. Once you've selected your tenant, go to the Integrations tab to manage the integrations for the tenant.

Click on the appropriate GitLab integration which you want to delete. Go to the Advanced page and click the Delete Integration button. You will be asked to enter the handle to confirm deletion. If you wish to permanently delete the integration and all of its resources, click Delete.