GitLab

CatalogDiscoveryGitOpsScorecards

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

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.

Multi-account support

GitLab has multi account support - entities can be tagged across different GitLab organizations, instances, and credentials.

Each GitLab configuration requires a GitLab Personal Token with the read_api scope and an alias. We use the alias to correlate the instance you want to use with the application registrations for various entities. There is also a default configuration used by registrations without an alias listed. You can edit aliases and the default configuration under Settings → GitLab.

If using the Scaffolder, you'll need the full api scope.

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.
We route our requests through a static IP address. Reach out to support at help@cortex.io to receive details about our static IP. If you're unable to directly whitelist our static IP, you can route requests through a secondary proxy in your network that has this IP whitelisted, and have that proxy route traffic to your GitLab instance.

Registration

Catalog descriptor

x-cortex-git:
  gitlab:
    repository: <namespace>/<project>
    basepath: myService # optional
    alias: myApp # 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
alias	Alias is optional and only relevant if you have opted into multi account support	false