An OpenFaaS plugin for the Serverless Inc framework (work in progress)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
deploy
invoke
pack
promisify-spawn
provider
remove
spawn-listener
.DEREK.yml
.gitignore
CONTRIBUTING.md
Dockerfile
LICENSE
README.md
index.js
package-lock.json
package.json
prep.sh
test-plugin.sh
test.js
tester.js

README.md

This is an OpenFaaS plugin for the Serverless Inc framework.

Were you looking for OpenFaaS?

You are probably looking for OpenFaaS - openfaas/faas.

serverless-openfaas

Status: This plugin for the Serverless Inc Framework is under development - help is wanted.

Work remaining:

  • Documentation on using OpenFaaS with the Serverless Inc framework
  • Validation of plugin from Serverless Inc team
  • Validation of node.js template from Serverless Inc team
  • Breaking out of SDK for spawning faas-cli

Pre-reqs

Installation:

  • Serverless Inc CLI (sls)
sudo npm i -g serverless
  • Get the OpenFaaS CLI:

Note: until 0.6.9 of the CLI is released you will need to rebuild it from source. git clone https://github.com/openfaas/faas-cli and cd faas-cli && ./build_redist.sh

$ curl -sSL https://cli.openfaas.com | sudo sh

Or install via brew install faas-cli.

  • Get OpenFaaS

You can deploy OpenFaaS locally or remotely with Docker Swarm or Kubernetes. See the documentation

Getting started

  • Get this plugin
$ git clone https://github.com/openfaas/serverless-openfaas

Link the plugin so it's available to Node:

$ ./prep.sh
  • Test the happy-path: build/deploy/list/invoke/remove
$ ./test-plugin.sh

Supported commands

sls package
sls deploy
sls deploy function -f <your-function>
sls deploy list
sls invoke -f <your-function> -d <your-data> # -d flag optional
sls remove

Contributing

Help is wanted. Please see the contributing guide