Skip to content

Commit

Permalink
- Updated readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
Michaellh0079 committed Aug 15, 2023
1 parent 85fc7ed commit 1586394
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,30 @@ This terraform module is provided as a template for DAACs to use in combination
The EDPub Copy File Utility uses the following Node and Terraform versions- also listed in .nvmrc and .terraform-version respectively:
```
Node: v18.14.1
Python: 3.8
Terraform: v0.13.6
```

### Where To Deploy
This module can be deployed to any environment; however, it should be deployed in the us-west-2 AWS region; otherwise, additional modifications to the lambda source may be necessary.

### How To Build
The module supports both javascript and python lambda runtimes. The benefit of the python deployment
is that it is easy to modify the source code for testing in the aws lambda web console but instructrions for building
both deployments are listed here. The runtime can be configured by setting the `lambda_runtime` terraform
variable.

#### Javascript
If you make any changes to the `src/index.js` file, you will need to rebuild the lambda package. To build the module, you will need to run the following commands:
```
npm install --include=dev
npm run build
npm run package
```
Running the above command will build the source and dependencies to a zip file which will be used for your deployment.
#### Python
For local deployments, after you have modified the `./src_py/main.py` file just run `python create_package.py`

Running the above commands will build the source and dependencies to a zip file which will be used for your deployment.

### How To Deploy
To deploy, you will need to define the following variables in a .tfvars file:
Expand Down

0 comments on commit 1586394

Please sign in to comment.