» 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 Enterprise (TFE)'s VCS features. GitLab.com has separate instructions, as do the other supported VCS providers.
Connecting TFE to your VCS involves five steps:
|On your VCS||On TFE|
|Register your TFE organization as a new app. Get ID and key.|
|Tell TFE how to reach VCS, and provide ID and key. Get callback URL.|
|Provide callback URL.|
|Request VCS access.|
|Approve access request.|
The rest of this page explains the on-premise GitLab versions of these steps.
Important: TFE needs to contact your GitLab instance during setup and during normal operation. For the SaaS version of TFE, this means GitLab must be internet-accessible; for private installs of TFE, you must have network connectivity between your TFE and GitLab instances.
Note: Alternately, you can skip the OAuth configuration process and authenticate with a personal access token. This requires using TFE's API. For details, see the OAuth Clients API page.
» Step 1: On GitLab, Create a New Application
Open your GitLab instance in your browser and log in as whichever account you want TFE 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 TFE must have admin (master) access to any shared repositories of Terraform configurations, since creating webhooks requires admin permissions.
Navigate to GitLab's "User Settings > Applications" page.
This page is located at
https://<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."
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 form as follows:
Field Value (all checkboxes) (empty) Name Terraform Enterprise (
<YOUR ORGANIZATION NAME>)
https://example.com/replace-this-later(or any placeholder; the correct URI doesn't exist until the next step.)
Click the "Save application" button, which creates the application and takes you to its page.
Take note of two items: the Application ID and the Secret. You'll copy and paste these unique strings in the next step. Leave this page open in a browser tab.
» Step 2: On TFE, Add an OAuth Client
Open TFE in your browser and navigate to the "OAuth Configuration" settings for your organization. Click the "Add an OAuth Client" button.
If you just created your organization, you might already be on this page. Otherwise:
- Click the upper-left organization menu, making sure it currently shows your organization.
- Click the "
<ORGANIZATION>Settings" link, right below the name of your organization.
- On the next page, click "OAuth Configuration" in the left sidebar.
- Click the "Add an OAuth Client" button.
The next page has a drop-down and four text fields. Select "GitLab Enterprise Edition" or "GitLab Community Edition" from the drop-down, and fill in all four text fields as follows:
Field Value HTTP URL
https://<GITLAB INSTANCE HOSTNAME>
https://<GITLAB INSTANCE HOSTNAME>/api/v3
Application ID (paste value from previous step) Secret (paste value from previous step)
Note that TFE uses GitLab's v3 API.
Click "Create connection." This will take you back to the OAuth Configuration page, which now includes your new GitLab client.
Locate the new client's "Callback URL," and copy it to your clipboard; you'll paste it in the next step. Leave this page open in a browser tab.
» Step 3: On GitLab, Update the Callback URL
Go back to your GitLab browser tab. (If you accidentally closed it, you can reach your OAuth app page through the menus: use the upper right menu > Settings > Applications > "Terraform Enterprise (
<YOUR ORG NAME>)".)
Click the "Edit" button.
In the "Redirect URI" field, paste the callback URL from TFE's OAuth Configuration page, replacing the "example.com" placeholder you entered earlier.
Click the "Save application" button. A banner saying the update succeeded should appear at the top of the page.
» Step 4: On TFE, Request Access
Go back to your TFE browser tab and click the "Connect organization
<NAME>" button on the OAuth Configuration page.
This takes you to a page on GitLab, asking whether you want to authorize the app.
Click the green "Authorize" button at the bottom of the authorization page. This returns you to TFE's OAuth Configuration page, where the GitLab client's information has been updated.
If this results in a 500 error, it usually means TFE was unable to reach your GitLab instance.
At this point, GitLab access for TFE is fully configured, and you can create Terraform workspaces based on your organization's shared repositories.