GitLab
Summary
GitLab is a Git-based VCS that has a Cloud and Self-Hosted option. You can use GitLab to drive insights into values such as:
- Git repository details (commit history, contributors)
- Scorecard rules
Setup
In order to connect Cortex to your GitLab instance, you’ll need to add a GitLab Personal Token with the read_api scope under Settings → GitLab.
If using the Scaffolder, you'll need the full api scope.
caution
If you do not see the Settings page you're looking for in the sidebar, you likely don't have the proper permissions and need to contact your admin.
caution
If you’re using a self-hosted instance of GitLab, you’ll need to verify that your Cortex instance is able to reach the GitLab instance. See our IP Whitelist section for more.
Registration
Catalog Descriptor
x-cortex-git:
gitlab:
repository: <namespace>/<project>
basepath: myService # optional
| Field | Description | Required |
|---|---|---|
repository | namespace/repo as defined in GitLab | true |
basepath | If the entity is in a monorepo (e.g. in a subdirectory), use this field to define the subdir | false |