Sceptre zip-code-s3

Hook and resolver for Sceptre v1.3.4+ to package complex Lambda functions on-the-fly and deploy them using S3 bucket.

This solution, fully compatible with Python 2/3, works well for ALL AWS Lambda runtimes: just tune Makefile with your own instructions for concrete runtime.

Overview

Lambda function may consist of several files or may require custom packages, which do not exist in AWS runtime and must be installed manually before packaging.

Many developers tend to store packaged Zip archive within Git repository. That may lead to inconsistent deployment, because such archive has to be recreate, if any source or dependency file has changed.

This important action usually recalled after hours of debugging and tons of redeployments. Therefore, such archived artifacts should never be checked in, rather packaged and deployed to on-the-fly.

Getting Started

How To install

NB! Sceptre 1.x does not yet recognize entry_points installation option from pip setup manifesto. Therefore, it's not possible to install it using pip.

• Clone the repository locally:

  $ git clone [email protected]:cloudreach/sceptre-zip-code-s3.git

• Install required dependencies:

  $ cd sceptre-zip-code-s3
  $ make deps

• Setup plugins to existing Sceptre project:

  $ make plugins TARGET=<existing_sceptre_project_root>

To display available commands, run make or make help command.

Prepare project

• Update config/config.yaml file with preferred values:

  $ cp config/config.yaml.dist config/config.yaml
  $ vi config/config.yaml

Create S3 bucket

• Create new S3 bucket for artifacts deployments:

  $ sceptre launch-env example/storage

  NB! It's possible to refer existing bucket, with enabled Versioning support.

Deploy Lambdas

• Deploy whole environment at once:

  $ sceptre launch-env example/serverless

• Or deploy stacks one by one:

  $ sceptre launch-stack example/serverless lambda-role
  $ sceptre launch-stack example/serverless lambda-py2-deps
  $ sceptre launch-stack example/serverless lambda-py3-deps-custom

This is what have been done (per function):

• install function required dependencies
• prepare files for distribution
• package and deploy artifact to S3 bucket, if checksum differs
• update CloudFormation stack with latest version of S3 file
• remove distribution directory

Test Lambda function from CLI

Find generated function name and region:

$ LAMBDA=( $(sceptre describe-stack-outputs example/serverless lambda-py2-deps \
    | grep ':lambda:' \
    | awk -F: '{print $NF, $5}') )

And then invoke function with JSON payload and parse result file:

$ aws lambda invoke \
    --invocation-type RequestResponse \
    --function-name "${LAMBDA[0]}" \
    --region "${LAMBDA[1]}" \
    --payload '{"key1":"value-1", "key2":[21, 42], "key3":[{"name":"value-3"}]}' \
    output.txt

$ cat output.txt | xargs echo -e

If everything went well, output would be like that:

helper: Hello from Python 2.7.12
key1: value-1
key2: [21, 42]
key3:
- {name: value-3}

Cleanup infrastructure

• Do not forget to cleanup infrastructure after testing:

  $ sceptre delete-env example/serverless

• If new S3 bucket was created during the test:

  $ sceptre delete-env example/storage

  If it errors with You must delete all versions in the bucket, then:

  $ MY_BUCKET="$(awk '$1 == "artifacts_bucket:" {print $2}' config/config.yaml)"
  
  $ python -c "import boto3; boto3.resource('s3').Bucket('${MY_BUCKET}').object_versions.delete()"
  
  $ sceptre delete-env example/storage

Under the hood

Hook definition

s3_package hook is template agnostic solution and it has 2 forms of definitions:

• S3 bucket/key auto-discovery:

  This way hook tries to auto-discover S3Bucket/S3Key values from sceptre_user_data['Code'] config.

  Template & config must follow lambda_function.py template convention for Code parameter.

  hooks:
      before_create:
          - !s3_package <path-to-function-root>
      before_update:
          - !s3_package <path-to-function-root>

• S3 bucket/key passed directly, fallback for custom template:

  hooks:
      before_create:
          - !s3_package <path-to-function-root>^^<s3_bucket>/<s3_key>
      before_update:
          - !s3_package <path-to-function-root>^^<s3_bucket>/<s3_key>

Resolver definition

Cloudformation wont detect stack changes, if no Code.S3ObjectVersion key is provided and lambda wont be redeployed with updates.

As hook definition, resolver also has auto-discovery and direct modes.

• S3 bucket/key auto-discovery:

  sceptre_user_data:
      Code:
          S3Bucket: <s3_bucket>
          S3Key: <s3_key>
          S3ObjectVersion: !s3_version

• S3 bucket/key passed directly, fallback for custom template:

  sceptre_user_data:
      BucketName: <s3_bucket>
      ObjectKey: <s3_key>
      ObjectVersion: !s3_version <s3_bucket>/<s3_key>

• S3 bucket/key names come from another stack:

  sceptre_user_data:
      Code:
          S3Bucket: !stack_output my-other-stack::BucketName
          S3Key: !stack_output my-other-stack::KeyName
          S3ObjectVersion: !s3_version

Function Makefile

Each function has own Makefile file inside it's root.

Why make, you might ask. Because it's cross-platform tool, proven with years.

Important! Instructions and logic in Makefile are outside of s3_package responsibility. Hook does not know what and how should be installed, except one rule:

All files for packaging should be placed into dist directory, inside function root.

Sample Makefile for Python 2.7 Lambda with dependencies installed with pip:

SHELL := bash
TARGET := dist

# Runtime: Python 2.7
PIP := pip2
SOURCES := $(wildcard *.py)

.PHONY: all
all:
	@ rm -rf $(TARGET) && mkdir -p $(TARGET)

	@ printf '[install]\nprefix=\n' > setup.cfg # OSX hack
	$(PIP) install -U -t $(TARGET) -r requirements.txt | grep -i 'installed'

	/bin/cp -f $(SOURCES) $(TARGET)/

	@ rm -rf setup.cfg $(TARGET)/*.so $(TARGET)/*.dist-info $(TARGET)/*.eggs $(TARGET)/*.egg-info
	@ find $(TARGET) -type f -name "*.py[cod]" -delete

	# Files for distribution:
	@ cd $(TARGET); find . -type f | sort -V | sed -e 's,^\./,  ,'

Explanation:

• variable TARGET := dist is convention over configuration, which defines distribution directory.

  It should not be changed, otherwise hook s3_package won't find files for packaging.

• re-/create dist directory, to avoid distribution pollution

• apply OS X hack to allow pip install packages into alternative directory

• install dependencies with pip into dist directory

• copy all *.py source files into dist directory

• remove unattended files from dist directory

Feel free to adjust Makefile as you like, e.g., use Docker to build, just pay attention to /dist/ directory.

S3 encryption

There is a trick if you are using encryption on S3.

According to https://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonResponseHeaders.html documentation, ETag may or may not be an MD5 digest of the object data.

1. Objects encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.
2. Objects encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.
3. Object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the encryption method.

In use-case 1 hook won't upload archive twice, as content MD5 and ETag do match.

using SSEAlgorithm: AES256 on S3 bucket will enable default encryption

In other use-cases hook will upload archive every time it's called, as content MD5 and ETag do not match.

it might be required to build custom MD5/ETag lookup solution and adjust hook.

Caveats

• note that Sceptre v1.3.4 was tested only and it may misbehave on previous versions.
• when running Sceptre from OSX, some packages may contain binary inside, so be sure to upload the proper one.
• custom encryption might require custom MD5/ETag lookup solution, see S3 encryption

How to Contribute

We encourage contribution to our projects, please see our CONTRIBUTING guide for details.

License

sceptre-zip-code-s3 is licensed under the Apache Software License 2.0.

Thanks

Keep It Cloudy (@CloudreachKIC)