README

OpenFaaS ® - Serverless Functions Made Simple





!OpenFaaS Logo

OpenFaaS® makes it easy for developers to deploy event-driven functions and microservices to Kubernetes without repetitive, boiler-plate coding. Package your code or an existing binary in an OCI-compatible image to get a highly scalable endpoint with auto-scaling and metrics.

 "OpenFaaS Community Edition (CE) is licensed for individual exploration and hobbyist use. A 60 day limit applies for commercial PoCs. Commercial and production workloads require OpenFaaS Standard or OpenFaaS for Enterprises."



Highlights

 Ease of use through UI portal and one-click install
 Write services and functions in any language with Template Store or a Dockerfile
 Build and ship your code in an OCI-compatible/Docker image
 Portable: runs on existing hardware or public/private cloud by leveraging Kubernetes
 CLI available with YAML format for templating and defining functions
 Auto-scales as demand increases including to zero
 Commercially supported Pro distribution by the team behind OpenFaaS

Want to dig deeper into OpenFaaS?

 Trigger endpoints with either HTTP or events sources such as Apache Kafka and AWS SQS
 Offload tasks to the built-in queuing and background processing
 Quick-start your Kubernetes journey with GitOps from OpenFaaS Cloud
 Go secure or go home with 5 must-know security tips
 Learn everything you need to know to go to production
 Integrate with Istio or Linkerd with Featured Tutorials
 Deploy to Kubernetes or OpenShift

 OpenFaaS Tiers and Pricing

This repository is part of OpenFaaS Community Edition (CE), which is licensed for non-commercial use by individuals, and a time-limited trial for commercial Proof Of Concepts (PoC). Internal use within a company or business requires a license.

OpenFaaS CE:

 has usage restrictions, which you can learn about in the OpenFaaS CE EULA
 has basic or primitive features and capabilities compared to the commercial versions
 is not licensed for commercial use of any kind beyond an initial trial period

OpenFaaS Standard and OpenFaaS for Enterprises are full and distinct commercial products. 

They are maintained and developed independently, by a full-time team, with commercial support, and active maintenance for CVEs, and updates in the Kubernetes and Cloud Native ecosystem.

Learn more about the tiers at https://www.openfaas.com/pricing/

 Overview of OpenFaaS (Serverless Functions Made Simple)

!Conceptual architecture

 Conceptual architecture and stack, more detail available in the docs

 Code samples

You can scaffold a new function using the faas-cli new command passing in the name of the function and the language template you want to use i.e. faas-cli new --lang node20 stripe-webhooks.

Official templates exist for many popular languages and are easily extensible with Dockerfiles.

Learn about OpenFaaS templates in the docs

 Node.js (node20) example:

    js
   "use strict"

    module.exports = async (event, context) = {