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: Missing Example Details from "Single Include" #3131

Closed
DevopsMercenary opened this issue May 10, 2024 · 0 comments · Fixed by #3136
Closed

Documentation: Missing Example Details from "Single Include" #3131

DevopsMercenary opened this issue May 10, 2024 · 0 comments · Fixed by #3136
Labels
bug Something isn't working

Comments

@DevopsMercenary
Copy link

Describe the bug

Documentation at the following line, the example is 'incomplete'

Steps To Reproduce

In replicating the example, there are no details for what needs to be in the root /terragrunt.hcl file

Of course, if someone was to assume that nothing was in /terragrunt.hcl the the following error occurrs.

ERRO[0000]   on /Users/greg/workspace/terragrunt/single-include-example/child/terragrunt.hcl line 14:
ERRO[0000]   14:   remote_state_config = include.root.remote_state
ERRO[0000]
ERRO[0000] This object does not have an attribute named "remote_state".

ERRO[0000] /Users/greg/workspace/terragrunt/single-include-example/child/terragrunt.hcl:14,37-50: Unsupported attribute; This object does not have an attribute named "remote_state".
ERRO[0000] Unable to determine underlying exit code, so Terragrunt will exit with error code 1

Inserting the following into /terragrunt.hcl at a minimum at least resolves that errror...

remote_state {
  backend = "s3"
  config = {
    bucket         = "my-terraform-state"
    key            = "${path_relative_to_include()}/terraform.tfstate"
    region         = "us-east-1"
    encrypt        = true
    dynamodb_table = "my-lock-table"
  }
}

Then there is another error, but this gets the point across. Maybe reference a previous example with the necessary code to help guide.

@DevopsMercenary DevopsMercenary added the bug Something isn't working label May 10, 2024
@denis256 denis256 mentioned this issue May 14, 2024
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant