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

Documentation Show the contents of the 'common_vars.yaml' file and format reasoning #3129

Closed
DevopsMercenary opened this issue May 10, 2024 · 0 comments · Fixed by #3148
Closed
Assignees
Labels
bug Something isn't working docs terragrunt

Comments

@DevopsMercenary
Copy link

Describe the Documentation

In the documentation for https://terragrunt.gruntwork.io/docs/features/locals/ there is a reference to a file named common_vars.yaml

Documentation File: https://github.com/gruntwork-io/terragrunt/blob/master/docs/_docs/02_features/locals.md

The documentation doesn't show what the contents of the common_vars.yaml file. Additionally there is added complexity to understanding the documentation because a YAML file is used.

After some reflection I assume the file might include the following 'common vars'

account_id="123456789012"
role_arn="arn:aws:iam::account:role/role-name-with-path"

or if I YAML-ized it

account_id:  123456789012
role_arn: "arn:aws:iam::account:role/role-name-with-path"

it's really handy to show all of the pieces for any example.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs terragrunt
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants