From 8fa7cd8ac3b3e3990dcbe4cff9abad0eefba33c2 Mon Sep 17 00:00:00 2001 From: mahesh-naxa Date: Mon, 8 Jan 2024 17:37:04 +0545 Subject: [PATCH] docs: updated readme for tm-extrctor lambda setup. --- scripts/aws/lambda/TM-Extractor/README.md | 36 +++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 scripts/aws/lambda/TM-Extractor/README.md diff --git a/scripts/aws/lambda/TM-Extractor/README.md b/scripts/aws/lambda/TM-Extractor/README.md new file mode 100644 index 0000000000..77d93be5fa --- /dev/null +++ b/scripts/aws/lambda/TM-Extractor/README.md @@ -0,0 +1,36 @@ + +## TM-Extractor with Terragrunt + +This directory contains infrastructure config for deploying [tm-extractor](https://github.com/hotosm/TM-Extractor) on AWS Lambda. + +Check [tm-extractor](https://github.com/hotosm/TM-Extractor) for resources created and exporter script. + +To get it running on your environment follow the following. + +### Prerequisites + +This are list of things you will need. +* AWS IAM User with permission for creating resources such as lambda function, cloudwatch group, cloudwatch event etc. +See all resource [here](https://github.com/hotosm/TM-Extractor/blob/ec37c1318325c534b4ac47f057263050e6e92f03/main.tf). +* [Terraform](https://www.terraform.io/) +* [Terragrunt](https://terragrunt.gruntwork.io/) + +### Environments + +Before running deployment, make sure you have the following environment variables exported. +- `TF_VAR_rawdata_api_auth_token`, Auth token for raw data api, Request [here](https://github.com/hotosm/raw-data-api/). +- `TF_VAR_raw_data_api`, API endpoint. Defaults to https://api-prod.raw-data.hotosm.org/v1 +- `TF_VAR_active_projects_api_base_url`, Your [tasking-manager](https://github.com/hotosm/tasking-manager) instance. +Defaults to https://tasking-manager-staging-api.hotosm.org/api/v2 + + +## Plan and Apply +- `cd` into `scripts/aws/lambda/TM-Extractor//tm-extractor`. +- `terragrunt init`, initializes providers and resources. +- `terragrunt plan`, run a plan to check for infrastructure changes. +- `terragrunt apply`, applies the configuration. + + +_For more information, please refer to the [TM-Extractor](https://github.com/hotosm/TM-Extractor)_ repository. + +

(back to top)

\ No newline at end of file