GitLab repository integration
By setting up the GitLab repository integration, you enable the DX Catalog to read file contents from your GitLab projects. This is required to use file matching rules and other repository-aware features.
Prerequisites
To connect GitLab to the DX Catalog, you need:
- a GitLab account that can create a Group Access Token or a Service Account
- allowlist DX IP addresses if your GitLab instance is behind a firewall or has IP restrictions
Setup instructions
Follow the steps below to connect GitLab to the DX Catalog.
Step 1
Either create a Group Access Token with the Developer role and the read_api scope, or create a group service account, add it to the group with the Developer role, and create an access token with the read_api scope.
Step 2
Grant the group access to the projects whose repositories the Catalog should read.
Step 3
- Navigate to the Catalog settings in DX and open the Repository integrations section. Click Add integration, choose GitLab, and enter a name and your Personal access token (the token value from Step 1).
- If you use a self-hosted GitLab instance, enter its root URL in the GitLab instance URL field (for example,
https://gitlab.example.com). Leave this field blank to use GitLab.com. - DX verifies the token and scopes; when verification succeeds, the integration is saved.