https://github.com/cludden/gomplate-lambda-extension
a Gomplate extension for AWS Lambda
https://github.com/cludden/gomplate-lambda-extension
aws config configuration consul dynamic file gcs git gomplate lambda s3 secret-manager secrets ssm vault
Last synced: 6 months ago
JSON representation
a Gomplate extension for AWS Lambda
- Host: GitHub
- URL: https://github.com/cludden/gomplate-lambda-extension
- Owner: cludden
- License: mit
- Created: 2022-01-15T23:23:38.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-24T22:48:29.000Z (over 3 years ago)
- Last Synced: 2025-02-14T10:17:52.608Z (8 months ago)
- Topics: aws, config, configuration, consul, dynamic, file, gcs, git, gomplate, lambda, s3, secret-manager, secrets, ssm, vault
- Language: Go
- Homepage:
- Size: 63.5 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# gomplate-lambda-extension
a [Gomplate](https://github.com/hairyhenderson/gomplate) extension for [AWS Lambda](https://aws.amazon.com/blogs/compute/introducing-aws-lambda-extensions-in-preview/)
## Getting Started
The [example](./example) directory provides a sample Terraform module that can be used to provision a Lambda function with this extension enabled.
*Prereqs:*
- [Terraform v1+](https://www.terraform.io/downloads)
- [An AWS Account](https://aws.amazon.com)
```shell
cd example
terraform init
terraform apply
```
## Installation
**Lambda layer**
For Lambda functions that use .zip deployments, include the following ARN as a layer in your Lambda function:
```
arn:aws:lambda:us-west-2:010013098410:layer:gomplate-lambda-extension:4
```
or publish your own layer:
```shell
just publish
```
**Embed within Lambda container image**
For Lambda functions that use container images, install the extension as part of the container build:
```dockerfile
ADD https://github.com/cludden/gomplate-lambda-extension/releases/v0.1.0/download/gomplate-lambda-extension_0.1.0_linux_amd64 /opt/extensions/gomplate-lambda-extension
```
## Configuration
The extension is configured via [Lambda environment variables](https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html).
| Name | Description |
| :--- | :--- |
| `GOMPLATE_DATASOURCE_{name}` | defines a named datasource |
| `GOMPLATE_INPUT` | anonymous input template (either inline or file path) |
| `GOMPLATE_INPUT_{name}` | configures a named template with an associated input file path |
| `GOMPLATE_OUTPUT` | output file path (e.g. `/tmp/config.json`) |
| `GOMPLATE_OUTPUT_{name}` | configures a named template output file path |
The extension supports either a single anonymous template:
```
# inline
GOMPLATE_INPUT={"foo":"{{ (getenv "FOO" "bar") }}"}
GOMPLATE_OUTPUT=/tmp/config.json
# filesystem
GOMPLATE_INPUT=/tmp/config.tpl.json
GOMPLATE_OUTPUT=/tmp/config.json
```
or one or more named templates:
```
GOMPLATE_INPUT_config=/tmp/config.tpl.json
COMPLATE_OUTPUT_config=/tmp/config.json
COMPLATE_INPUT_data=/tmp/data.tpl.yml
COMPLATE_OUTPUT_data=/tmp/data.yml
```
## License
Licensed under the [MIT License](LICENSE.md)
Copyright (c) 2022 Chris Ludden