Repository files navigation

PackagingBenthos configs forAWS Lambda was too exciting, now it's acceptably boring.

If all this still sounds too exciting and you just want to deploy Benthos on AWS Lambda,jump over to theServerless Benthos Project Skeleton or theBenthos Plugin Project Skeleton.

Benthos on AWS Lambda requires either a single config.yaml file inside itsdeployed .zip artifact or the config passed as an environment variable.Since AWS Lambda limits its environment variable size to 4 KB,even simple Benthos configs are too large to deploy.

This tool allows you to write and test Benthos configs as you normally would,i.e., splitting and sharing resources across multiple files.For each config you want to deploy, Blobpack mergesthe selected Benthos YAML files into a single config.yaml andpackages it into a .zip file with Benthos for deployment to AWS Lambda.

This can be used with any tool that can deploy .zip artifacts to AWS Lambda.SinceServerless and theAWS CDK are both popular deploymentsolutions that support Node.js, this tool is distributed as an npm package.

This package exposes the CLI command blobpackand itsunderlying JavaScript API.

Add this as a dependency to your project usingnpm with

$ npm install --save-dev blobpack

In order to create Benthos artifact to deploy to AWS Lambda,the upstream Benthos lambda archive must be downloaded locally totmp.

To have this happen automatically afternpm install,add this to yourpackage.json,

{"scripts": {"postinstall":"blobpack install"  },"blobpack": {"name":"benthos-lambda","version":"4.10.0","platform":"linux_amd64","src":"https://github.com/benthosdev/benthos/releases/download"  }}

First, add a new build step and ensure it runs before deployment,

{"scripts": {"blobpack":"blobpack"  }}

Assuming you want to deploy the below Serverless function,you will need to tell blobpack to generate theboring.zip artifact.

Tip: you can reuse the same artifact for multiple functions.

boring:handler:benthos-lambdapackage:artifact:dist/boring.zipindividually:trueexclude:['*/**']include:[]

First, add theartifacts section to theblobpack config.This will generate a new artifact todist/boring.zip which usesconfig/boring.yaml and intelligently merges resources in bothresources/outputs.yaml andnode_modules/@my-org/blobd/resources/logger.yaml.

Tip: any top level keys which are not of type*_resources will still be included.If two files have the same key, the last one wins.

{"blobpack": {"artifacts": [      {"name":"boring","resources": ["outputs"],"node_modules/@my-org/blobd/resources": ["logger"]      }    ]  }}

Tip: put your common resources in an npm package like @my-org/blobd.

If you only need to package a single config file into the artifact,you can use this shorthand,

{"blobpack": {"artifacts": ["boring"]  }}

If you want to merge a common set of resources into every config,you can use theinclude property,

{"blobpack": {"include": {"resources": ["logger"]    },"artifacts": ["boring"]  }}

If you need ServerlessBento, set thesrc andchecksumPrefix properties,

{"blobpack": {"name":"benthos-lambda","version":"1.2.0","platform":"linux_amd64","checksumPrefix":"bento","src":"https://github.com/warpstreamlabs/bento/releases/download"  }}

  Usage: blobpack [command] [options]  Commands:    install        Download Benthos .zip    build          Build .zip artifacts    help           Display help  Options:    --version         Output the version number    --config-path     Path to the JSON file containing the blobpack config    --tmp-root        Path to a temporary working directory    --config-root     Path to the directory containing the artifact configs    --resources-root  Path to the directory all resources are relative to    --dist-root       Path to the directory to output artifacts

$ git clone https://github.com/razor-x/blobpack.git$ cd blobpack$ nvm install$ npm install

Run the command below in a separate terminal window:

$ npm run test:watch

Primary development tasks are defined underscripts inpackage.jsonand available vianpm run.View them with

$ npm run

Thesource code is hosted on GitHub.Clone the project with

$ git clone git@github.com:razor-x/blobpack.git

You will needNode.js withnpm and aNode.js debugging client.

Be sure that all commands run under the correct Node version, e.g.,if usingnvm, install the correct version with

$ nvm install

Set the active version for each shell session with

$ nvm use

Install the development dependencies with

$ npm install

Use thenpm version command to release a new version.This will push a new git tag which will trigger a GitHub action.

Publishing may be triggered using aworkflow_dispatch on GitHub Actions.

GitHub Actions should already be configured: this section is for reference only.

The following repository secrets must be set onGitHub Actions:

• NPM_TOKEN: npm token for installing and publishing packages.

These must be set manually.

The version and format GitHub actionsrequire a user with write access to the repository.Set these additional secrets to enable the action:

• GH_TOKEN: A personal access token for the user.
• GIT_USER_NAME: The GitHub user's real name.
• GIT_USER_EMAIL: The GitHub user's email.
• GPG_PRIVATE_KEY: The GitHub user'sGPG private key.
• GPG_PASSPHRASE: The GitHub user's GPG passphrase.

These must be set manually.

Please submit and comment on bug reports and feature requests.

To submit a patch:

1. Fork it (https://github.com/razor-x/blobpack/fork).
2. Create your feature branch (git checkout -b my-new-feature).
3. Make changes.
4. Commit your changes (git commit -am 'Add some feature').
5. Push to the branch (git push origin my-new-feature).
6. Create a new Pull Request.

This npm package is licensed under the MIT license.

This software is provided by the copyright holders and contributors "as is" andany express or implied warranties, including, but not limited to, the impliedwarranties of merchantability and fitness for a particular purpose aredisclaimed. In no event shall the copyright holder or contributors be liable forany direct, indirect, incidental, special, exemplary, or consequential damages(including, but not limited to, procurement of substitute goods or services;loss of use, data, or profits; or business interruption) however caused and onany theory of liability, whether in contract, strict liability, or tort(including negligence or otherwise) arising in any way out of the use of thissoftware, even if advised of the possibility of such damage.