chore: add make commands to package and clean zip (#885)

* add make cmds to package and clean zip

Signed-off-by: Kavindu Dodanduwa <[email protected]>

* build with x86_64 deps and bump es apm to support python 12

Signed-off-by: Kavindu Dodanduwa <[email protected]>

* document build options

Signed-off-by: Kavindu Dodanduwa <[email protected]>

---------

Signed-off-by: Kavindu Dodanduwa <[email protected]>

Author: Kavindu-Dodan

.gitignore

@@ -5,6 +5,7 @@
 *.egg
 *.db
 *.pid
+*.zip
 .coverage*
 .DS_Store
 .idea

Makefile

@@ -36,6 +36,19 @@ isort:  ## Run isort in the project on the host
 mypy: ## Run mypy in the project on the host
 	tests/scripts/${SCRIPTS_BASE_DIR}mypy.sh
 
+package: ## Package lambda by installing python dependencies matching x86_64
+	mkdir deps && \
+    pip install --target=./deps --platform manylinux2014_x86_64 --implementation cp --python-version 3.12 --only-binary=:all: --upgrade -r requirements.txt && \
+    cd ./deps && \
+    zip -r ../local_esf.zip . && \
+    cd .. && \
+    zip -r local_esf.zip main_aws.py handlers share storage shippers && \
+    rm -r ./deps
+
+clean: ## cleanup any leftover resources
+	rm -f -r ./deps
+	rm -f local_esf.zip
+
 docker-test:  ## Run all tests on docker
 docker-test: SCRIPTS_BASE_DIR=docker/
 docker-test: test

dev-corner/how-to-test-locally/README.md

@@ -1,17 +1,38 @@
-This is just an example of how to build and run ESF locally.
+This document contains details about how to build ESF Lambda locally.
+Once built, the Lambda can be deployed to validate functionality.
 
-## Requirements
+## Building lambda
+
+To build the Lambda, you may use one of the options below,
+
+### Using Makefile
+
+To build,
+
+```shell
+make package
+```
+
+This will generate a Lambda zip named `local_esf.zip`.
+
+To clean up any leftover resources,
+
+```shell
+make clean
+```
+
+### Using Task file
+
+#### Requirements
 
 - [Terraform](https://www.terraform.io/)
 - (Optional) [Taskfile](https://taskfile.dev/installation/)
 
 
-## Steps
+#### Building
 
 **Important note**: ESF dependencies have been tested on architecture `x86_64`. Make sure to use it as well.
 
-### Step 1: Build your dependencies zip file
-
 You can build your own, or you can choose to run:
 ```bash
 task
@@ -24,13 +45,12 @@ You can update the task variables in the `.env` file:
 - The name of the zip file, `FILENAME`.
 
 
-### Step 2: Run ESF terraform
+## Deploying Lambda
 
-Use the code in [ESF terraform repository](https://github.com/elastic/terraform-elastic-esf).
+Once Lambda zip is ready, you should use the code in [ESF terraform repository](https://github.com/elastic/terraform-elastic-esf).
 
 > **NOTE**: ESF lambda function is using architecture `x86_64`.
 
-
 Place your `local_esf.zip` (or `<FILENAME>` if you changed the value) in the same directory as ESF terraform.
 
 Go to `esf.tf` file and edit: