GitLab connector settings reference
Add a connector for your GitLab account or repository.
Before Harness uses this connector to sync with your Git repo, it confirms that the connector settings are valid. If the connection fails, Harness can't sync with your Git repo.
Overview settings
Details settings
The Details settings specify which GitLab account or repository you want this connector to connect to, whether to connect over HTTP or SSH, and the URL to use.
URL Type
Select Account to connect an entire GitLab account. This option lets you use one connector to connect to all repositories in the specified GitLab account. Make sure you have at least one repo in the account; you need a repo to test the connection and save the connector.
Select Repository to connect to a single, specific repo in a GitLab account.
Connection Type
Select the protocol, HTTP or SSH , to use for cloning and authentication. The Connection Type determines the URL format required for the GitLab Account/Repository URL field. It also determines the Authentication method you must use in the Credentials settings .
GitLab Account/Repository URL
Enter the URL for the GitLab account or repository that you want to connect to. The required value is determined by the URL Type and Connection Type .
- URL Type: Account
- URL Type: Repository
In the
GitLab Account URL
field, provide only the account-identifying portion of the GitLab URL, such as
https://gitlab.com/YOUR_ACCOUNT_NAME/
. Do not include a repo name. The URL format depends on the
Connection Type
:
-
HTTP:
https://gitlab.com/YOUR_ACCOUNT_NAME/orhttps//gitlab.com -
SSH:
[email protected]:YOUR_ACCOUNT_NAME/
Test Repository
This field is only required if the URL Type is Account . Provide the name of a repo in your GitLab account that Harness can use to test the connector. Harness uses this repo to validate the connection only. When you use this connector in a pipeline, you'll specify a true code repo in your pipeline configuration or at runtime.
In the GitLab Repository URL field, provide the complete URL to the GitLab repository that you want this connector to point to. The URL format depends on the Connection Type :
-
HTTP:
https://gitlab.com/YOUR_ACCOUNT_NAME/YOUR_REPO_NAME -
SSH:
[email protected]:YOUR_ACCOUNT_NAME/YOUR_REPO_NAME - For HTTP connections, you can use OAuth , Username and Password , or Username and Token authentication.
- For SSH connections, you must use SSH Key authentication.
- Username and Password
- Username and Token
- OAuth
- SSH Key
- For Authentication , select Username and Password .
-
In the
Username
field, enter
git. Do not enter any other value besidesgit. - In the Password field, provide your GitLab account password as a Harness encrypted text secret .
- For Authentication , select Username and Token .
-
In the
Username
field, enter
git. Do not enter any other value besidesgit. - In the Personal Access Token field, provide a GitLab personal access token as a Harness encrypted text secret .
- For Authentication , select OAuth .
- Select Link to GitLab to open a new browser tab and authorize access to your GitLab account.
Credentials settings
Provide authentication credentials for the connector.
Authentication
Authentication is required for all accounts and repos, including read-only repos. The Connection Type you chose in the Details settings determines the available Authentication methods:
Username and Password authentication is not valid for GitLab accounts with two-factor authentication. Instead, use Username and Token , OAuth , or SSH Key authentication.
Make sure your personal access token has the following permissions:
api
,
read_repository
, and
write_repository
.
SSH connections require an
SSH Key
in PEM format. OpenSSH keys are not supported. In Harness, SSH Keys are stored as
Harness SSH credential secrets
. When creating an SSH credential secret for a code repo connector, the SSH credential's
Username
must be
git
. Always save the ssh key as a file secret.
For details on creating SSH keys and adding them to your GitLab account, go to the GitLab documentation about Using SSH keys to communicate with GitLab .
If you use the
keygen
command to generate an SSH key, include arguments such as
rsa
and
-m PEM
to ensure your key is properly formatted and uses the RSA algorithm. For example, this command creates an SSHv2 key:
ssh-keygen -t rsa -m PEM
Make sure to follow the prompts to finish creating the key. For more information, go to the Linux ssh-keygen man page .
To sync with GitLab, you must generate an SSH key pair and add the SSH key to your GitLab account. For more information, go to the GitLab documentation on Using SSH keys to communicate with GitLab .
Enable API access
This setting is only available for connection types and authentication methods where it is not enabled by default.
You must enable API access to use Git-based triggers, Git Sync, manage webhooks, or update Git statuses with this connector. If you are using the Harness Git Experience, this setting is required. API access requires personal access token authentication.
In the Personal Access Token field, provide a GitLab personal access token as a Harness encrypted text secret . If you selected Username and Token authentication, use the same personal access token secret for both Personal Access Token fields.
Make sure your personal access token has the following permissions:
api
,
read_repository
, and
write_repository
.
API URL
If you have a GitLab self-managed plan and your base URL format is something like
https://myloadbalancer/gitlab
, then you must provide your GitLab base URL in the
API URL
field. Harness uses this URL for API authentication.
Don't specify an API URL if you use GitLab SaaS or your GitLab self-managed plan's base URL is formatted like
https://mygitlab.internal
.
Connectivity Mode settings
Select whether you want Harness to connect directly to your GitLab account or repo, or if you want Harness to communicate with your GitLab account or repo through a delegate. If you plan to use this connector with Harness Cloud build infrastructure , you must select Connect through Harness Platform .
The Secure Connect option is for Secure Connect with Harness Cloud .
Delegates Setup
If you select Connect through a Harness Delegate , you can select Use any available Delegate or Only use Delegates with all of the following tags .
If you want to use specific delegates, you must identify those delegates. For more information, go to Use delegate selectors .