Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to override default terragrunt boilerplate template for terragrunt catalog #3658

Open
tgeijg opened this issue Dec 13, 2024 · 2 comments
Labels
contributions-requested Requesting contributions from the community enhancement New feature or request preserved Preserved issues never go stale

Comments

@tgeijg
Copy link

tgeijg commented Dec 13, 2024

Describe the enhancement

Currently terragrunt scaffold has three ways of consuming a boilerplate template:

  1. The built-in default terragrunt template
  2. Supplying a custom template as the second argument to the scaffold command
  3. Adding a .boilerplate folder in the terraform module

When using terragrunt catalog option 2 is not available. Additionally, the default terragrunt boilerplate template is not particularly useful. That leaves only option 3. This is not ideal for reasons listed below.

The request would be to add an option to the catalog config that would allow overriding the default template:

catalog {
  boilerplate_template = "https://github.com/gruntwork-io/custom-boilerplate-template",
  urls = [
    "https://github.com/gruntwork-io/terragrunt-infrastructure-modules-example",
    "https://github.com/gruntwork-io/terraform-aws-utilities",
    "https://github.com/gruntwork-io/terraform-kubernetes-namespace"
  ]
}

Additional context

The result of the current options for defining a custom boilerplate template in combination with terragrunt catalog is that we end up needing to maintain boilerplate templates in all our terraform modules. Since many of these templates are 99.9% identical, it would be much easier for us to maintain a single boilerplate template which can be in its own remote repository. Any updates to that template then automatically apply to all terraform modules, and do not require us to go and update hundreds of terraform modules.

@tgeijg tgeijg added the enhancement New feature or request label Dec 13, 2024
@yhakbar yhakbar added contributions-requested Requesting contributions from the community preserved Preserved issues never go stale labels Dec 20, 2024
@yhakbar
Copy link
Collaborator

yhakbar commented Dec 20, 2024

This seems like a totally sensible request, @tgeijg . I'm not sure when we'd be able to prioritize it, so I'll mark it as requesting community contributions.

It seems like you have a good number of features you'd like to see in boilerplate/scaffold/catalog. If I haven't asked already, are you interested in becoming a Terragrunt contributor?

@grahitoraditya
Copy link

saya tertarik dengan masalah ini, ini sangat mendewasakan saya dalam belajar pemrograman

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributions-requested Requesting contributions from the community enhancement New feature or request preserved Preserved issues never go stale
Projects
None yet
Development

No branches or pull requests

3 participants