OpenFaaS Babashka template

An OpenFaaS template for writing Functions in Planck.

Prerequisites

• OpenFaaS CLI: makes the faas command available.

Usage

Pull OpenFaaS template

To create Planck Functions with this template, use the following command once:

faas template pull https://github.com/ccfontes/faas-planck

If you ever need to update the template, simply run the command above with the --overwrite flag.

Create a Planck Function

Create Planck Functions as with the following command example:

faas new --lang planck my-planck-function

A new project is created for a function defined as my-planck-function. It will contain an fn.handler namespace that is required for the template to work properly. The requirement for this namespace is to have a top-level function defined as handler.

Specs

OpenFaaS watchdog is of-watchdog in Streaming fork mode.

Function examples

See the examples directory to find a fully working set of OpenFaaS Functions written in Planck.

Tests

Tests run in CI with Github Actions. Some commands can be found in a Github Actions workflow to help you with testing your changes before pushing them to a topic branch.

Contributing

Contributions are welcome! If you find a bug or have an idea for a new feature, please open an issue or submit a pull request.

License

Copyright (c) 2023 Carlos da Cunha Fontes

The MIT License