GitLab

Overview

Firefly integrates with GitLab to connect your infrastructure code repositories with your cloud resources. This integration enables powerful features like tracing cloud resources back to their defining code ("Jump to Code") and automatically creating Merge Requests for newly codified resources and drift remediation.

Prerequisites

• A GitLab account with access to your infrastructure repositories

• Appropriate permissions to create Personal Access Tokens

• Repositories containing Terraform, CloudFormation, or other IaC files you want to connect to Firefly

Setup Procedure

1. Login to your GitLab account and to create a personal access token

2. Select User Settings > Access Tokens

3. Enter a Token name and Expiration date

4. Select both of the following scopes:

   • api

   • read_repository

5. Select Create token

6. Copy the token

7. In Firefly, select Settings > Integrations

8. Select Add New > GitLab (under version control integrations)

9. Enter a descriptive name into the Nickname field

10. Paste the token into the Token field

11. If you are using GitLab on-premises, enter the GitLab instance URL into the Instance URL field

12. Select Next

Features Enabled

• Jump to Code: Trace resources in your cloud inventory back to the GitLab file and specific line that defines them

• Automated Merge Requests: When Firefly codifies an unmanaged resource, it can commit the new infrastructure code as a Merge Request

• IaC Tracking: Firefly maintains awareness of which resources are defined in code and which are not

• Drift Remediation: Firefly can detect drift between the code and the actual resources and create a Merge Request to fix it

Best Practices

• Consider creating a dedicated GitLab user or bot account for Firefly to make tracking its contributions easier

• Ensure the access token has appropriate permissions to create Merge Requests

• Regularly review Merge Requests created by Firefly

• If you are using GitLab on-premises, ensure the GitLab instance URL is correct

Troubleshooting

1. For authentication issues:

   • Verify GitLab credentials and permissions

   • Check if the token has expired or been revoked

   • Ensure the OAuth application is properly configured

2. For repository access issues:

   • Verify the integration has access to the required repositories

   • Check group permissions if applicable

   • Review Firefly integration logs