Skip to content

Commit

Permalink
docs: updated readme for tm-extrctor lambda setup.
Browse files Browse the repository at this point in the history
  • Loading branch information
mahesh-naxa committed Jan 8, 2024
1 parent c101bcf commit 8fa7cd8
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions scripts/aws/lambda/TM-Extractor/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<!-- GETTING STARTED -->
## 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/<your-environment-here>/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.

<p align="right">(<a href="#readme-top">back to top</a>)</p>

0 comments on commit 8fa7cd8

Please sign in to comment.