Configuring GitLab.com Access

These instructions are for using GitLab.com for HCP Terraform's VCS features. GitLab CE and GitLab EE have separate instructions, as do the other supported VCS providers.

Configuring a new VCS provider requires permission to manage VCS settings for the organization. (More about permissions.)

Connecting HCP Terraform to your VCS involves four steps:

The rest of this page explains the GitLab.com versions of these steps.

Step 1: On HCP Terraform, Begin Adding a New VCS Provider

1. Go to your organization's settings and then click Providers. The VCS Providers page appears.

2. Click Add VCS Provider. The VCS Providers page appears.

3. Select GitLab and then select GitLab.com from the menu. The page moves to the next step.

4. Locate the "Redirect URI" and copy it to your clipboard; you'll paste it in the next step.

Leave the page open in a browser tab. In the next step you will copy values from this page, and in later steps you will continue configuring HCP Terraform.

Step 2: On GitLab, Create a New Application

1. In a new browser tab, open gitlab.com and log in as whichever account you want HCP Terraform to act as. For most organizations this should be a dedicated service user, but a personal account will also work.

   Important: The account you use for connecting HCP Terraform must have Maintainer access to any shared repositories of Terraform configurations, since creating webhooks requires Maintainer permissions. Refer to the GitLab documentation for details.

2. Navigate to GitLab's User Settings > Applications page.

   This page is located at https://gitlab.com/-/profile/applications. You can also reach it through GitLab's menus:

   • Click your profile picture and choose "Settings."
   • Click "Applications."

3. This page has a list of applications and a form for adding new ones. The form has two text fields and some checkboxes.

   Fill out the fields and checkboxes with the corresponding values currently displayed in your HCP Terraform browser tab. HCP Terraform lists the values in the order they appear, and includes controls for copying values to your clipboard.

   Fill out the form as follows:

   Field	Value
   Name	HCP Terraform (<YOUR ORGANIZATION NAME>)
   Redirect URI	https://app.terraform.io/<YOUR CALLBACK URL>, the redirect URI you copied from HCP Terraform
   Confidential (checkbox)	✔️ (enabled)
   Scopes (all checkboxes)	api

1. Click the "Save application" button, which creates the application and takes you to its page.

2. Leave this page open in a browser tab. In the next step, you will copy and paste the unique Application ID and Secret.

Step 3: On HCP Terraform, Set up Your Provider

1. Enter the Application ID and Secret from the previous step, as well as an option Name for this VCS connection.

2. Click Connect and continue. This takes you to a page on GitLab.com, which asks if you want to authorize the app.

3. Click the green Authorize button at the bottom of the authorization page.

Step 4: On HCP Terraform, Set Up SSH Keypair (Optional)

Most organizations will not need to add an SSH private key. However, if the organization repositories include Git submodules that can only be accessed via SSH, an SSH key can be added along with the OAuth credentials. You can add or update the SSH private key at a later time.

Important Notes

• SSH will only be used to clone Git submodules. All other Git operations will still use HTTPS.
• Do not use your personal SSH key to connect HCP Terraform and GitLab; generate a new one or use an existing key reserved for service access.
• In the following steps, you must provide HCP Terraform with the private key. Although HCP Terraform does not display the text of the key to users after it is entered, it retains it and will use it for authenticating to GitLab.
• Protect this private key carefully. It can push code to the repositories you use to manage your infrastructure. Take note of your organization's policies for protecting important credentials and be sure to follow them.

If You Don't Need an SSH Keypair:

1. Click the "Skip and Finish" button. This returns you to HCP Terraform's VCS Providers page, which now includes your new GitLab client.

If You Do Need an SSH Keypair:

1. On a secure workstation, create an SSH keypair that HCP Terraform can use to connect to GitLab.com. The exact command depends on your OS, but is usually something like: ssh-keygen -t rsa -m PEM -f "/Users/<NAME>/.ssh/service_terraform" -C "service_terraform_enterprise" This creates a service_terraform file with the private key, and a service_terraform.pub file with the public key. This SSH key must have an empty passphrase. HCP Terraform cannot use SSH keys that require a passphrase.

2. While logged into the GitLab.com account you want HCP Terraform to act as, navigate to the SSH Keys settings page, add a new SSH key and paste the value of the SSH public key you just created.

3. In HCP Terraform's "Add VCS Provider" page, paste the text of the SSH private key you just created, and click the "Add SSH Key" button. This returns you to HCP Terraform's VCS Provider page, which now includes your new GitLab client.

Finished

At this point, GitLab.com access for HCP Terraform is fully configured, and you can create Terraform workspaces based on your organization's shared repositories.