3mcloud/lambda-packager repository overview

⁠lambda-packager

Package code for Python and Node AWS Lambda functions using a docker container.

Github Repository⁠

⁠Supported tags and respective Dockerfile links:

• python-3.9⁠, python-latest⁠, latest⁠
• python-3.8⁠
• python-3.7⁠
• python-3.6⁠
• node-14.18⁠, node-latest⁠
• node-12.22⁠

⁠Python

⁠TL;DR

Lets say all our code is within a src directory and within that src directory we have a requirements.txt. We want the output to be deployment.zip at the root of our project. Then all we need to do is:

	docker run -it --rm \
        -v $(if ${PWD},${PWD},${CURDIR}):/src \ # First mount our code to the container
		3mcloud/lambda-packager:python-latest

And boom, deployment.zip should be in your repository root.

Note: $(if ${PWD},${PWD},${CURDIR}) is a ternary operator which we use to make it Windows and Mac agnostic with Makefiles.

⁠Container Variables

You can change the default behavior of this packager by using the environment variables of the container

⁠Examples

Our code is in a directory named code and we have a reqs.txt file within that directory. We want deployment.zip to be at the root level of our project.

	docker run -it --rm \
        -v $(if ${PWD},${PWD},${CURDIR}):/src \ # First mount our project to the container
        -e CI_WORKSPACE=/src \ # We will be working with /src
		-e LAMBDA_CODE_DIR=/code \ # The code to be packaged is within /src/code
		-e REQUIREMENTS_FILE=reqs.txt \ # Requirements are in /src/code/reqs.txt
		3mcloud/lambda-packager:python-latest

Alternatively, lets say we only want to mount the code directory and not the entire root of our project:

	docker run -it --rm \
        -v $(if ${PWD},${PWD},${CURDIR})/code:/src \ # First mount our code to the container
		-e LAMBDA_CODE_DIR=/src \ # The code to be packaged is within /src (Note CI_WORKSPACE is /)
		-e REQUIREMENTS_FILE=reqs.txt \ # Requirements are in /src/reqs.txt
        -e ARTIFACT_NAME=/src/deployment.zip \ # We need to save the zip within /src/ since we didn't mount the root level.
		3mcloud/lambda-packager:python-latest

Lasty, we can try to leverage the default values. Lets say all our code is within a src directory and within that src directory we have a requirements.txt. We want the output to be deployment.zip at the root of our project. Then all we need to do is:

	docker run -it --rm \
        -v $(if ${PWD},${PWD},${CURDIR}):/src \ # First mount our code to the container
		3mcloud/lambda-packager:python-latest

⁠Node

⁠TL;DR for Node

Make sure:

• your node code is in a folder called src, relative to the working directory
• you have a package.json (and preferrably, also a package-lock.json) in your working directory

docker run -it --rm -v $(pwd):/workspace -w /workspace 3mcloud/lambda-packager:node-12.22

And boom, deployment.zip should be in your repository root.

⁠Container variables for node

You can change the default behavior of this packager by using the environment variables of the container

⁠Examples

See the Examples for Python, except where you see 3mcloud/lambda-packager:python-latest replace that with 3mcloud/lambda-packager:node-12.22

The default behavior of the node packager is to assume that the package.json and package-lock.json are in the same directory as the entry point for your application. For example, your application looks like this:

.
├── app.js
├── package.json

Then just use the defaults as shown in the Examples.

Some projects, however, have a nested structure. If you have a folder structure that looks like this, which was created by sam init:

.
├── README.md
├── __tests__
│   └── unit
│       └── handlers
│           ├── get-all-items.test.js
│           ├── get-by-id.test.js
│           └── put-item.test.js
├── buildspec.yml
├── env.json
├── events
│   ├── event-get-all-items.json
│   ├── event-get-by-id.json
│   └── event-post-item.json
├── package.json
├── src
│   └── handlers
│       ├── get-all-items.js
│       ├── get-by-id.js
│       └── put-item.js
└── template.yml

And you want a package that looks like this on the inside:

.
├── node_modules
└── src

Then use this incantation, from the base folder.

docker run -it --rm -w /test -v $(pwd):/test \
    -e NPM_PACKAGE_FILE=./package.json \
    -e NPM_PACKAGE_LOCK=./package-lock.json \
    -e LAMBDA_CODE_DIR=src \
    -e ARTIFACT_CODE_PREFIX=src \
    3mcloud/lambda-packager:node-12.22