README.yaml

---
# This file is used by `mdctl`. Run `mdctl build` to build a README file.

# Name of this project
name: docker-atlantis-terragrunt

# Banner
banner:
  name: Screenshot of example Terraform
  url: ./docs/banner.png

# The short subtitle for this project
subtitle: |-
  A Docker image for running Atlantis with Terragrunt

# Badges to display
badges:
  - name: License
    image: https://img.shields.io/github/license/scalefactory/docker-atlantis-terragrunt.svg
    url: https://github.com/scalefactory/docker-atlantis-terragrunt

# References to display
references:
  - name: Atlantis
    url: https://www.runatlantis.io/
  - name: Terragrunt
    url: https://github.com/gruntwork-io/terragrunt
  - name: Atlantis Terraform module
    url: https://github.com/terraform-aws-modules/terraform-aws-atlantis
  - name: Report a bug
    url: https://github.com/scalefactory/docker-atlantis-terragrunt/issues

# Bulleted features to display
features:
  - "Docker image to run Terragrunt with Atlantis"
  - "SSH key support to access private repositories"

# Guide to use this project
quickstart: |-
  You can find example terraform in the `examples` folder.

  Deploy the reference
  [Atlantis Terraform module](https://github.com/terraform-aws-modules/terraform-aws-atlantis)

  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](https://www.runatlantis.io/docs/access-credentials.html#generating-an-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 |

# Open source license for this project
license: MIT

# Contributors to this project
contributors:
  - name: "Steve Porter"
    github: "steveporter92"