» Configuring GitLab EE and CE Access

These instructions are for using an on-premise installation of GitLab Enterprise Edition (EE) or GitLab Community Edition (CE) for Terraform Cloud's VCS features. GitLab.com has 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 Terraform Cloud to your VCS involves four steps:

On your VCS On Terraform Cloud
  Create a new connection in Terraform Cloud. Get redirect URI.
Register your Terraform Cloud organization as a new app. Provide redirect URI. Get ID and key.  
  Provide Terraform Cloud with application ID and secret. Request VCS access.
Approve access request.  

The rest of this page explains the on-premise GitLab versions of these steps.

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

  1. Open Terraform Cloud in your browser and navigate to the "VCS Providers" settings for your organization. Click the "Add VCS Provider" button.

    If you just created your organization, you might already be on this page. Otherwise:

    1. Make sure the upper-left organization menu currently shows your organization.
    2. Click the "Settings" link at the top of the page (or within the ☰ menu)
    3. On the next page, click "VCS Providers" in the left sidebar.
    4. Click the "Add VCS Provider" button.
  2. The "Add VCS Provider" page is divided into multiple steps to guide you through adding a new VCS provider.

    For the first step, select "GitLab" then select "GitLab Enterprise Edition" or "GitLab Community Edition" from the dropdown. The page will move to the next step.

  3. In the "Set up provider" step, fill in the HTTP URL and API URL of your GitLab Enterprise Edition or GitLab Community Edition instance, as well as an optional Name for this VCS connection. Click "Continue."

    Field Value
    HTTP URL https://<GITLAB INSTANCE HOSTNAME>
    API URL https://<GITLAB INSTANCE HOSTNAME>/api/v4

    Terraform Cloud screenshot: add HTTP URL and API URL fields

    Note that Terraform Cloud uses GitLab's v4 API.

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 Terraform Cloud.

» Step 2: On GitLab, Create a New Application

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

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

    This page is located at https://<GITLAB INSTANCE HOSTNAME>/profile/applications. You can also reach it through GitLab's menus:

    • In the upper right corner, click your profile picture and choose "Settings."
    • In the navigation sidebar, 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 Terraform Cloud browser tab. Terraform Cloud lists the values in the order they appear, and includes controls for copying values to your clipboard.

    GitLab screenshot: new application fields

    Fill out the form as follows:

    Field Value
    Name Terraform Cloud (<YOUR ORGANIZATION NAME>)
    Redirect URI https://app.terraform.io/<YOUR CALLBACK URL>
    Confidential (checkbox) ✔️ (enabled)
    Scopes (all checkboxes) api
  4. Click the "Save application" button, which creates the application and takes you to its page.

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

    GitLab screenshot: the new application's application ID and secret

» Step 3: On Terraform Cloud, Set up Your Provider

  1. On the "Configure settings" step on Terraform Cloud, enter the Application ID and Secret from the previous step.

    Terraform Cloud screenshot: add Application ID and Secret fields

  2. Click "Connect and continue." This takes you to a page on GitLab asking whether you want to authorize the app.

    GitLab screenshot: the authorization screen

    If this results in a 500 error, it usually means Terraform Cloud was unable to reach your GitLab instance.

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

» Step 4: On Terraform Cloud, Set Up a PEM formatted 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 Terraform Cloud and GitLab; generate a new one or use an existing key reserved for service access.
  • In the following steps, you must provide Terraform Cloud with the private key. Although Terraform Cloud 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 a PEM formatted SSH Keypair:

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

» If You Do Need aa PEM formatted SSH Keypair:

  1. On a secure workstation, create a PEM formatted SSH keypair that Terraform Cloud can use to connect to GitLab. 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. Terraform Cloud cannot use SSH keys that require a passphrase.

  2. While logged into the GitLab account you want Terraform Cloud 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 Terraform Cloud'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 Terraform Cloud's VCS Provider page, which now includes your new GitLab client.

    Terraform Cloud screenshot: the ssh key screen

» Finished

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