Gitlab
GitLab is a web-based Git repository that provides free open and private repositories, issue-following capabilities, and wikis.
Summary - Creating a Gitlab Credential
Create a read-only personal access token. Copy the token to a secure location.
Go to configure8 app -> Settings -> Credentials -> Add Credential and select Gitlab credential provider.
Set up name for the Credential and fill info based on this.
Hit Save. The credentials will be checked and a discovery job will start. Done!
Prerequisite
In order to get started with embedding your Gitlab repositories in configure8, you must create a new personal API token (PAT). PAT's are unique to your organization. A PAT is required by configure8 to read your branch and pipeline information from Gitlab.You can review the full instructions for creating a personal API token here.
Create a personal access token
You can create as many personal access tokens as you like. Here is how to create one in Gitlab:
Go into your Gitlab application.
In the top-right corner, select your avatar.
Select Edit profile.
On the left sidebar, select Access Tokens.
Enter a name and optional expiry date for the token.
Select the desired scopes. (See note below)
Select Create personal access token.
configure8 only requires "read" access for scopes: read_api, read_user, and read_repository.
Save the personal access token somewhere safe. After you leave the page, you no longer have access to the token.
Creating a Gitlab Credential
To connect your Gitlab account to configure8, perform the following steps.
Start by navigating to the Credentials page by clicking on the "lock" icon on the menu bar.
Next, select the Add Credential button.
From the Add Credential pop-up, select Gitlab from the list of available providers.
Next, enter the information required for your credential.
Name: a recognizable alias for the new credential
Personal Access Token: this is the Gitlab Personal Access Token you generated in the prerequisite section above.
Note: Gitlab supports groups and sub-groups to help organize your repositories. Configure8 can only see repositories that the user creating the personal access token is a member of. Make sure to connect Gitlab with a user who is at least a member of the projects/groups you want to be discovered.
Host URL: This defaults to https://gitlab.com for those using Gitlab's SAS implementation.
If you are using the on-premise version of Gitlab, you can enter the URL of your instance. Just make sure your firewall rules will allow the configure8 app to hit that URL from outside your organization. configure8 can connect to domain based URLs (e.g. https://gitlab.mycompany.com) but not IP addresses (e.g. https://255.255.255.255) for security reasons.
IP's used by configure8 are:
3.134.237.30
18.190.3.63
3.131.181.75
Fetch personal projects on discovery: Your choice
Select Save to create your Gitlab credential in configure8.
The configure8 app will automatically validate the credentials to make sure they work. If they do not, the credentials will not be saved and you will be prompted to fix them.
Scheduling a discovery
configure8 can auto discover the resources within your Gitlab account on an ad-hoc basis or by leveraging our scheduling engine to scan for new resources on a 24/48 hour interval.
To create a discovery job for your Azure account, start by navigating to the Credentials page by navigating to the Settings (gear) icon on the left hand side navigation.
Find the credentials you would like to schedule for auto discovery, select the ellipse button to display the context menu and select the View option.
From the pop-up under the Discovery section, you can schedule an on-going auto discovery of your resources by toggling on the Auto Discovery switch if not enabled, then choosing a frequency from the Schedule dropdown and selecting Save.
From the pop-up under the Manual Discovery section, you can also run an ad-hoc discovery simply by clicking Run Now.
Configuring Gitlab for your Services
Adding a Gitlab plug-in to your service adds the code quality summary to your service overview page. To add a Gitlab plug-in to your service, start by selecting a service from your catalog Services listing.
From your service detail page, select the Add Plug-in button.
From the Plugins dialog, browse through the list of available plugins and select one of the available Gitlab plug-ins by clicking on the Add button.
In the Plug-ins configuration wizard, select an existing credential to connect to the selected plugin provider. If you do not have an existing credential or would like to use a new credential, select the Add Credential button and follow the directions above for install the Gitlab application.
Next, enter the information required for your Gitlab plug-in configuration.
Plugin Title: the title of the plug-in to display on the service overview page
Once you have entered all the required configuration information, select Done. Your Gitlab plug-in is added to your service overview page.
If you added the Gitlab pipeline plug-in, you will now see information on the CI/CD tab of the service.
Last updated
