Skip to content

Commit fd94007

Browse files
committed
readme: Updated readme with input documentation
1 parent ed24bef commit fd94007

File tree

4 files changed

+26
-0
lines changed

4 files changed

+26
-0
lines changed

scripts/aws/lambda/TM-Extractor/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,29 @@ Before running deployment, make sure you have the following environment variable
2525
- `TF_VAR_active_projects_api_base_url`, Your [tasking-manager](https://github.com/hotosm/tasking-manager) instance.
2626
Defaults to https://tasking-manager-staging-api.hotosm.org/api/v2
2727

28+
## Inputs and Local Variables
29+
`env.hcl` within each deployment environment overrides the input vars.
30+
```
31+
locals {
32+
environment = "stag"
33+
# Appends to all the resource names eg: tm-extrator-hotosm-lambda-stag
34+
35+
account_name = "hotosm"
36+
# Also appends to the resource names for better naming
37+
38+
aws_profile = "default"
39+
# Acts as AWS_PROFILE environment var, If you have multiple profile defined in ~/.aws/credentials, you can set these so each envionment deployment uses its own set of profiles.
40+
41+
aws_region = "ap-south-1"
42+
# The AWS region the resources should be created on.
43+
44+
application = "tasking-manager"
45+
team = "HOTOSM"
46+
creator = "HOTOSM"
47+
owner = "HOTOSM"
48+
# Above are used for generating tags for AWS resources.
49+
}
50+
```
2851

2952
## Plan and Apply
3053
- `cd` into `scripts/aws/lambda/TM-Extractor/<your-environment-here>/tm-extractor`.

scripts/aws/lambda/TM-Extractor/dev/env.hcl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Set common variables for the environment. This is automatically pulled in in the root terragrunt.hcl configuration to
22
# feed forward to the child modules.
3+
# Check ../README.md ## Inputs and Local Variables for details.
34

45
locals {
56
environment = "dev"

scripts/aws/lambda/TM-Extractor/prod/env.hcl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Set common variables for the environment. This is automatically pulled in in the root terragrunt.hcl configuration to
22
# feed forward to the child modules.
3+
# Check ../README.md ## Inputs and Local Variables for details.
34

45
locals {
56
environment = "prod"

scripts/aws/lambda/TM-Extractor/stag/env.hcl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Set common variables for the environment. This is automatically pulled in in the root terragrunt.hcl configuration to
22
# feed forward to the child modules.
3+
# Check ../README.md ## Inputs and Local Variables for details.
34

45
locals {
56
environment = "stag"

0 commit comments

Comments
 (0)