tegola_lambda

README

tegola_lambda

Run tegola on AWS lambda. This implementation uses the native Go AWS Lambda rutime. There are a couple limitations to using lambda to run tegola:

• No connection pooling: The database connection will be rebuilt on every lambda request.
• No built in viewer: Lambda + API Gateway have limitations which restrict the configuration from being easily setup to support the built in viewer and return vector tiles.

The following steps assume you have a working tegola configuration.

Creating a new lambda function

From the AWS console:

• Navigate to lambda and click "Create function". We're going to "Author from scratch".
  • Name: name your function whatever you like.
  • Runtime: At the bottom of the drop down select "Provide your own bootstrap on Amazon Linux 2".
  • Architecture: Select your desired architecture. There's a tegola lambda version for both x86_64 and arm64 available.
  • Role: Depends on your environment. For the sake of this walk through we will "Create a new role from template"
  • Role Name: Up to you. tegola is a good role name.
  • Policy Templates: Select "Basic Edge Lambda Permissions".
• Click "Create function".

Preparing the function for upload

Lambda expects an archive with the function to be uploaded. In tegola's case we will be creating an archive of the binary bootstrap and a config.toml file:

zip deployment.zip bootstrap config.toml

Note: tegola will check for a config file named config.toml by default. This can be changed by setting the environment variable TEGOLA_CONFIG

Back in the AWS console for the function that was created earlier, locate the section "Code" and click "Upload from" and choose ".zip file". Find and upload the deployment.zip archive you just created.

Configuring the Lambda function

• Under "Basic Settings"
  • Memory: Adjust to your preference. Depending on the config.toml file you may need more or less memory for the function.
  • Timeout: Set to max time (5 minutes).

Deployment

AWS Supports several ways to trigger lambda functions (i.e. API Gateway, ALB, Function URL). tegola_lambda uses the algnhsa package as the AWS lambda shim. Various deployment configs are documented in the README for algnhsa.

Setting up API Gateway

When using API Gateway there are a few key details that need to be configured during setup:

• Under "Content Encoding" check the box to enable and set the value to 0. This is important as tegola will return tiles in gzip encoded. Without this checked the content encoding will be improperly handled.
• Under "Binary Media Types" click "Add Binary Media Type".
• Input */* as the value. This is necessary as tegola returns protocol buffers, which are a binary format. Without this configuration API gateway will return the vector tile payloads as base64 encoded strings.

Building from source

Building tegola_lambda works the same way as building normal tegola with the exception that it must be built for linux. Navigate to the repository root then cmd/tegola_lambda and execute the following command to create an arm64 binary:

GOARCH=arm64 GOOS=linux go build -tags lambda.norpc -o bootstrap main.go

A binary named bootstrap will be created.