Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/openfaas/faasd

A lightweight & portable faas engine
https://github.com/openfaas/faasd

api arm containerd containers deploy edge faas faasd golang http microservices openfaas remote rest serverless webhooks

Last synced: 7 days ago
JSON representation

A lightweight & portable faas engine

Awesome Lists containing this project

README 

        
# faasd - a lightweight & portable faas engine



[![Sponsor faasd](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&link=https://github.com/sponsors/openfaas)](https://github.com/sponsors/openfaas)

[![Build Status](https://github.com/openfaas/faasd/workflows/build/badge.svg?branch=master)](https://github.com/openfaas/faasd/actions)

![Downloads](https://img.shields.io/github/downloads/openfaas/faasd/total)



faasd is [OpenFaaS](https://github.com/openfaas/) reimagined, but without the cost and complexity of Kubernetes. It runs on a single host with very modest requirements, making it fast and easy to manage. Under the hood it uses [containerd](https://containerd.io/) and [Container Networking Interface (CNI)](https://github.com/containernetworking/cni) along with the same core OpenFaaS components from the main project.



![faasd logo](docs/media/social.png)



## Use-cases and tutorials



faasd is just another way to run OpenFaaS, so many things you read in the docs or in blog posts will work the same way.



Videos and overviews:



* [Exploring of serverless use-cases from commercial and personal users (YouTube)](https://www.youtube.com/watch?v=mzuXVuccaqI)

* [Meet faasd. Look Ma’ No Kubernetes! (YouTube)](https://www.youtube.com/watch?v=ZnZJXI377ak)



Use-cases and tutorials:



* [Serverless Node.js that you can run anywhere](https://www.openfaas.com/blog/serverless-nodejs/)

* [Simple Serverless with Golang Functions and Microservices](https://www.openfaas.com/blog/golang-serverless/)

* [Build a Flask microservice with OpenFaaS](https://www.openfaas.com/blog/openfaas-flask/)

* [Get started with Java 11 and Vert.x on Kubernetes with OpenFaaS](https://www.openfaas.com/blog/get-started-with-java-openjdk11/)

* [Deploy to faasd via GitHub Actions](https://www.openfaas.com/blog/openfaas-functions-with-github-actions/)

* [Scrape and automate websites with Puppeteer](https://www.openfaas.com/blog/puppeteer-scraping/)



Additional resources:



* The official handbook - [Serverless For Everyone Else](https://openfaas.gumroad.com/l/serverless-for-everyone-else)

* For reference: [OpenFaaS docs](https://docs.openfaas.com)

* For use-cases and tutorials: [OpenFaaS blog](https://openfaas.com/blog/)

* For self-paced learning: [OpenFaaS workshop](https://github.com/openfaas/workshop/)



### About faasd



* faasd is a single static Golang binary, which runs on Linux with systemd

* uses the same core components and ecosystem of OpenFaaS

* uses containerd for its runtime and CNI for networking

* is multi-arch, so works on Intel `x86_64` and Arm out the box

* runs stateful containers through its `docker-compose.yaml` file like Grafana, MongoDB, InfluxDB, or Postgres, etc



Most importantly, it's easy to manage so you can set it up and leave it alone to run your functions.



[![demo](https://pbs.twimg.com/media/EPNQz00W4AEwDxM?format=jpg&name=medium)](https://www.youtube.com/watch?v=WX1tZoSXy8E)



> Demo of faasd running asynchronous functions



Watch the video: [faasd walk-through with cloud-init and Multipass](https://www.youtube.com/watch?v=WX1tZoSXy8E)



### What does faasd deploy?



* faasd - itself, and its [faas-provider](https://github.com/openfaas/faas-provider) for containerd - CRUD for functions and services, implements the OpenFaaS REST API

* [Prometheus](https://github.com/prometheus/prometheus) - for monitoring of services, metrics, scaling and dashboards

* [OpenFaaS CE Gateway](https://github.com/openfaas/faas/tree/master/gateway) - the UI portal, CLI, and other OpenFaaS tooling can talk to this.

* [OpenFaaS CE queue-worker for NATS Streaming](https://github.com/openfaas/nats-queue-worker) - run your invocations in the background without adding any code. See also: [asynchronous invocations](https://docs.openfaas.com/reference/triggers/#async-nats-streaming)

* [NATS](https://nats.io) for asynchronous processing and queues



## Licensing & EULA for OpenFaaS (faasd)



faasd (which is a distribution of OpenFaaS) is licensed under the [OpenFaaS Community Edition (CE) EULA](https://github.com/openfaas/faas/blob/master/EULA.md), [additional clauses apply](EULA.md) to enable faasd to be used for Personal Use and within Small Business Environments.



A separate OpenFaaS Standard license is available for commercial use-cases, which is required for certain commercial use.



### When should you use faasd over OpenFaaS on Kubernetes?



faasd relies on industry-standard tools for running containers:



* [CNI](https://github.com/containernetworking/plugins)

* [containerd](https://github.com/containerd/containerd)

* [runc](https://github.com/opencontainers/runc)



You can use the standard [faas-cli](https://github.com/openfaas/faas-cli) along with pre-packaged functions from *the Function Store*, or build your own using any OpenFaaS template.



* To deploy microservices and functions that you can update and monitor remotely

* When you don't have the bandwidth to learn or manage Kubernetes

* To deploy embedded apps in IoT and edge use-cases

* To distribute applications to a customer or client

* You have a cost sensitive project - run faasd on a 1GB VM for 5-10 USD / mo or on your Raspberry Pi

* When you just need a few functions or microservices, without the cost of a cluster



faasd does not create the same maintenance burden you'll find with maintaining, upgrading, and securing a Kubernetes cluster. You can deploy it and walk away, in the worst case, just deploy a new VM and deploy your functions again.



You can learn more about supported OpenFaaS features in the [ROADMAP.md](/docs/ROADMAP.md)



## Learning faasd



You can find various resources to learn about faasd for free, however the official handbook is the most comprehensive guide to getting started with faasd and OpenFaaS.



["Serverless For Everyone Else"](https://openfaas.gumroad.com/l/serverless-for-everyone-else) is the official handbook and was written to contribute funds towards the upkeep and maintenance of the project.



### The official handbook and docs for faasd








You'll learn how to deploy code in any language, lift and shift Dockerfiles, run requests in queues, write background jobs and to integrate with databases. faasd packages the same code as OpenFaaS, so you get built-in metrics for your HTTP endpoints, a user-friendly CLI, pre-packaged functions and templates from the store and a UI.



Topics include:



* Should you deploy to a VPS or Raspberry Pi?

* Deploying your server with bash, cloud-init or terraform

* Using a private container registry

* Finding functions in the store

* Building your first function with Node.js

* Using environment variables for configuration

* Using secrets from functions, and enabling authentication tokens

* Customising templates

* Monitoring your functions with Grafana and Prometheus

* Scheduling invocations and background jobs

* Tuning timeouts, parallelism, running tasks in the background

* Adding TLS to faasd and custom domains for functions

* Self-hosting on your Raspberry Pi

* Adding a database for storage with InfluxDB and Postgresql

* Troubleshooting and logs

* CI/CD with GitHub Actions and multi-arch

* Taking things further, community and case-studies



View sample pages, reviews and testimonials on Gumroad:



["Serverless For Everyone Else"](https://openfaas.gumroad.com/l/serverless-for-everyone-else)



### Deploy OpenFaaS Edge (commercial distribution of faasd)



OpenFaaS Edge is a commercial distribution of faasd, with enhancements and additional features from OpenFaaS Pro. The [OpenFaaS Pro EULA applies](https://github.com/openfaas/faas/blob/master/pro/EULA.md).



* Upgraded Pro components from OpenFaaS Standard: Gateway, Cron Connector, JetStream Queue Worker and Classic Scale to Zero

* Deploy up to 250 functions per installation

* Configure private DNS servers

* Airgap-friendly with installation bundled in an OCI image

* Detailed RAM/CPU metrics for stateful containers, and functions, including Out Of Memory (OOM) events

* Multiple namespace support



This version is intended for resale as part of a wider solution, and to be deployed both into industrial and on-premises environments.



Individual [GitHub Sponsors of OpenFaaS](https://github.com/sponsors/openfaas) (25 USD / mo and higher) can use OpenFaaS Edge for personal use.



You can install OpenFaaS Edge with the following script:



```bash

curl -sLSf \

    https://raw.githubusercontent.com/openfaas/faasd/refs/heads/master/hack/install-edge.sh \

    -o install-edge.sh && \

chmod +x install-edge.sh

sudo -E ./install-edge.sh

```



*For an offline installation*



Copy the OCI bundle and the install-edge.sh script to the remote server.



Then mirror the various images from docker-compose.yaml into your private registry, and update the references from i.e. `image: ghcr.io/openfaasltd/gateway` to the equivalents in your registry.



If your system is unable to install apt, yum, or pacman packages, due to limited network access, then set the `SKIP_OS` environment to 1. The list of packages is available in the `install_required_packages` section of the script.



### Deploy faasd CE



faasd-ce supports 15 functions and needs a computer with a stable Internet connection to run. There are some restrictions on commercial use, but [individuals and certain small businesses can use it for free](EULA.md).



The easiest way to deploy faasd is with cloud-init, we give several examples below, and post IaaS platforms will accept "user-data" pasted into their UI, or via their API.



For trying it out on MacOS or Windows, we recommend using [multipass](https://multipass.run) to run faasd in a VM.



If you don't use cloud-init, or have already created your Linux server you can use the installation script as per below:



```bash

git clone https://github.com/openfaas/faasd --depth=1

cd faasd



./hack/install.sh

```



> This approach also works for Raspberry Pi when using the 64-bit OS or Ubuntu 22.04 or higher.



It's recommended that you do not install Docker on the same host as faasd, since 1) they may both use different versions of containerd and 2) docker's networking rules can disrupt faasd's networking. When using faasd - make your faasd server a faasd server, and build container image on your laptop or in a CI pipeline.



#### Deployment tutorials



* [Use multipass on Windows, MacOS or Linux](/docs/MULTIPASS.md)

* [Deploy to DigitalOcean with Terraform and TLS](https://www.openfaas.com/blog/faasd-tls-terraform/)

* [Deploy to any IaaS with cloud-init](https://blog.alexellis.io/deploy-serverless-faasd-with-cloud-init/)

* [Deploy faasd to your Raspberry Pi](https://blog.alexellis.io/faasd-for-lightweight-serverless/)



Terraform scripts:



* [Provision faasd on DigitalOcean with Terraform](docs/bootstrap/README.md)

* [Provision faasd with TLS on DigitalOcean with Terraform](docs/bootstrap/digitalocean-terraform/README.md)



### Function and template store



For community functions see `faas-cli store --help`



For templates built by the community see: `faas-cli template store list`, you can also use the `dockerfile` template if you just want to migrate an existing service without the benefits of using a template.



### Community support



Commercial users and solo business owners should become OpenFaaS GitHub Sponsors to receive regular email updates on changes, tutorials and new features.



If you are learning faasd, or want to share your use-case, you can join the OpenFaaS Slack community.



* [Become an OpenFaaS GitHub Sponsor](https://github.com/sponsors/openfaas/)

* [Join the weekly Office Hours call](https://docs.openfaas.com/community/)



### Backlog, features, design limitations and any known issues



For open backlog items, shipped features, design limitations and any known issues, see [ROADMAP.md](docs/ROADMAP.md)



Want to build a patch without setting up a complete development environment? See [docs/PATCHES.md](docs/PATCHES.md)



Are you looking to hack on faasd? Follow the [developer instructions](docs/DEV.md) for a manual installation, or use the `hack/install.sh` script and pick up from there.