Skip to content

scalefactory/docker-atlantis-terragrunt

Repository files navigation

Screenshot of example Terraform

docker-atlantis-terragrunt

This is an open source project published by The Scale Factory.

We currently consider this project to be hibernating.

These are projects that we’re no longer prioritising, but which we keep ticking over for the benefit of the few customers we support who still use them.

ℹ️ We’re not regularly patching these projects, or actively watching for issues or PRs. We’ll periodically make updates or respond to contributions if one of the team has some spare time to invest.

A Docker image for running Atlantis with Terragrunt

License

✨ Features

  • Docker image to run Terragrunt with Atlantis
  • SSH key support to access private repositories

💡 Quick Start

You can find example terraform in the examples folder.

Deploy the reference Atlantis Terraform module

Tweak the custom_environments_secret_secrets and atlantis_image variables. Put your private SSH key into AWS secrets manager under the /atlantis/github/user/private_ssh_key path

# terraform-aws-modules/terraform-aws-atlantis
...
custom_environment_secrets = [
  {
    name  = "GITHUB_USER_SSH_KEY"
    valueFrom = "/atlantis/github/user/private_ssh_key"
  }
]
atlantis_image = "scalefactory/docker-atlantis-terragrunt:v0.19.20"
...

Note: You will need to grant the Fargate task permission to read the secret above.

📄 Examples

Copy the Terraform in the examples folder.

We recommend creating a dedicated bot GitHub account to run atlantis as. Put a valid GitHub personal access token for this user into secrets manager with the key token. Note down the ARN for this secret, you will need it later.

Set the following Terraform variables

Name Description Type Default Required
github_secret_token_arn The arn of the github token in Secrets Manager string `` yes
github_user The name of the github user Atlantis will run as (@sfatlantisbot). string `` yes
domain The domain to run atlantis under (example.com). string `` yes

📄 License

docker-atlantis-terragrunt is an open-sourced software licensed under the MIT license.

📘 References

⭐ Contributors

Steve Porter
Steve Porter

This README was generated with ❤️ by mdctl