Terraform Images

This repository won't upgrade to any new Terraform releases with the BSL license for now. Please follow this issue for updates.

This repository provides a docker image which contains the gitlab-terraform shell script. This script is a thin wrapper around the terraform binary. Its main purpose is to serve the Infrastructure as code with Terraform and GitLab , by extracting some of the standard configuration a user would need to set up to use the Terraform backend on GitLab as well as the Terraform merge request widget.

How to use it

Required Environment Variables

The wrapper expects three environment variables to be set:

TF_ADDRESS

Should be the backend URL. For the GitLab backend it will be something like:

"<GITLAB_API_URL>/projects/<PROJECT_ID>/terraform/state/<STATE_NAME>"

• GITLAB_API_URL is the URL of your GitLab API (you can use $CI_API_V4_URL in GitLab CI/CD).
• PROJECT_ID is the id of the project you're using as your infrastructure as code (you can use $CI_PROJECT_ID in GitLab CI/CD)
• STATE_NAME can be arbitrarily defined to the Terraform state name that you create.

TF_USERNAME

Is your user login name, which must have maintainer access. If this is unset, it will default to the value of GITLAB_USER_LOGIN which is the username that triggered the build.

TF_PASSWORD

An access token created for the above maintainer with the api scope. If this is unset, it will default to the value of CI_JOB_TOKEN and override the TF_USERNAME to match.

Support for Gitlab CI Environment Variables

gitlab-terraform exposes the following Gitlab CI Environment Variables as TF_VAR inputs

• CI_JOB_ID

• CI_COMMIT_SHA

• TF_VAR_CI_JOB_STAGE

• CI_PROJECT_ID

• CI_PROJECT_NAME

• CI_PROJECT_NAMESPACE

• CI_PROJECT_PATH

• CI_PROJECT_URL

You can use these in your terraform files in the following way

variable "CI_PROJECT_NAME" {
  type    = string
}

Terraform lockfile handling

If you commit the .terraform.lock.hcl file to your repository we recommend setting TF_INIT_FLAGS to -lockfile=readonly to prevent changes to the lockfile.

How to contribute?

Contributions are always welcome. Don't be shy!

If there's no other issue already discussing what you want, simply open a new issue and the maintainers will gladly review it and respond as soon as possible. If there's an open issue with the "Accepting merge requests" label, simply open up a merge request proposal linking to that issue and we'll also review it as soon as possible.

Git Commit Guidelines

This project uses Semantic Versioning. We use commit messages to automatically determine the version bumps, so they should adhere to the conventions of Conventional Commits (v1.0.0).

Release

Currently we release three versions of this image to support the last three stable major versions of Terraform. The image versioning is documented here.