OpenFaaS Gateway Documentation
repository·master·Indexed Apr 15, 2026
https://github.com/openfaas/faasThe OpenFaaS Gateway is the central entry point for serverless functions, providing a REST API, a built-in UI for deployment, and integration with Prometheus for metrics. It manages function lifecycle, handles request routing, and supports tracing via unique call IDs. The gateway acts as a proxy between clients and upstream providers like Kubernetes, Swarm, or Nomad. Key features include auto-scaling from zero, custom alerting via AlertManager, and a UI for invoking functions or deploying from the Function Store. The repository includes API specifications, provider status guides, and community resources for production use cases.
What's inside OpenFaaS
View OpenFaaS Community Events and Talks
masterAccess a curated list of OpenFaaS community events, conference talks, and webinars to learn about serverless patterns, integrations, and real-world use cases. The repository maintains records of presentations covering topics such as:
- faasd and Kubernetes: Learn how to run OpenFaaS without Kubernetes using
faasd. - WebAssembly: Explore WebAssembly as a universal runtime for serverless functions.
- Crossplane & OpenFaaS: Discover how to find managed services in a serverless world.
- Migration: Strategies for migrating AWS Lambda functions to OpenFaaS.
- GitOps: Implementing GitOps with OpenFaaS and Flux.
- Service Mesh: Integrating OpenFaaS with Linkerd and Kubernetes.
- NATS: Using NATS for serverless on Kubernetes.
These resources include links to video recordings (YouTube, Vimeo), slides, and event pages from conferences like KubeCon, NDC Oslo, and various user groups.
Sources:
community.md- faasd and Kubernetes: Learn how to run OpenFaaS without Kubernetes using
Explore OpenFaaS Community Resources and Learning Materials
masterAccess the OpenFaaS community page to find industry awards, notable mentions, books, interviews, podcasts, and featured videos. This page serves as a central hub for learning about OpenFaaS through community contributions and official content.
Key Resources:
- Books: Includes titles like Serverless for Everyone Else by Alex Ellis and Docker for Serverless Applications with OpenFaaS.
- Awards: Recognitions such as the 2018 Bossie Award for Best OSS Cloud Computing and CNCF Cloud Native Landscape inclusion.
- Podcasts & Interviews: Episodes from Kubernetes Podcast, The Hanselminutes, and Bret Fisher Docker and DevOps Talk.
- Videos: Technical deep dives on topics like auto-scaling with Prometheus, faasd (OpenFaaS without Kubernetes), and secure multi-tenant platforms.
Contribution: To submit a link to this page (e.g., for a blog post, video, or use case), submit a Pull Request or a GitHub Issue. You must sign-off your commit using
git commit -sor addSigned-off-by: {your full name} <{your email address}>to the commit message.Sources:
community.mdBrowse OpenFaaS 2020 Blog Posts and Tutorials
masterAccess a curated list of tutorials, guides, and announcements published in 2020 to learn about specific OpenFaaS features and integrations.Install OpenFaaS on Kubernetes or faasd
masterKey Topics Covered
masterDeployment & Setup:
- Build and deploy OpenFaaS functions with GitHub Actions
- Enable Single Sign-on (SSO) for OpenFaaS with Okta and OpenID Connect
- Bring a lightweight Serverless experience to DigitalOcean with Terraform and faasd
- OpenFaaS with TLS via Faasd and Terraform on Openstack
- Running OpenFaaS and MongoDB on Raspbian 64bit
- Tutorial to get OpenFaas running on top of a Kubernetes cluster on Clear Linux OS
- Turn your Raspberry Pi into a serverless platform with faasd
Language & Framework Guides:
Integrations & Advanced Patterns:
- Kubernetes Webhooks made easy with OpenFaaS
- Time travelling through your OpenFaaS Function logs
- Keep your functions running to schedule with the cron-connector
- Using Azure Storage + lowdb and Node.js to manage state in OpenFaaS functions
- Gain access to your functions with CORS
- Adding Managed Services to Serverless with Crossplane and OpenFaaS
- Applying GitOps to OpenFaaS with Flux Helm Operator
Tools & Ecosystem:
Community & Learning:
Aggregating Logs
masterFor centralized log management, you can install a Docker logging driver to aggregate logs from all functions.Official Training
master- Training Materials: View official tutorials at docs.openfaas.com/tutorials/training.
- eBook: Serverless For Everyone Else by the founder of OpenFaaS. It uses JavaScript/Node.js and the
faasdproject for hands-on exercises. No prior programming experience is required. - Golang Guide: Everyday Go includes a dedicated chapter on development and testing of functions using OpenFaaS and Go.
View OpenFaaS 2019 Community Events and Blog Posts
masterAccess a curated list of OpenFaaS community activities and technical articles from 2019. This includes industry awards, notable mentions, and specific tutorials such as deploying OpenFaaS with MicroK8s, using Bash Functions as a Service, and the Serverless Panel at Dockercon 2018.
Key resources from 2019:
- Deploy OpenFaaS with MicroK8s: A guide by John McCabe on running OpenFaaS on MicroK8s.
- Bash Functions as a Service: An article by Thomas Shaw on using Bash with OpenFaaS.
- Serverless Panel Dockercon 2018: Video recording of the panel discussion featuring Alex Ellis.
- Transmute launches blockchain decentralised app engine: Enterprise Times article on using OpenFaaS for blockchain applications.
These resources provide historical context, learning materials, and real-world adoption stories for developers exploring the platform.
Sources:
community.mdIntegrations & Data
masterOpenFaaS Community Edition (CE)
masterThis repository contains the OpenFaaS Community Edition.
- License: Licensed for non-commercial use by individuals.
- Commercial Use: A time-limited trial is allowed for commercial Proof of Concepts (PoC). Internal use within a company or business requires a separate license.
- Features: Basic or primitive features compared to commercial versions.
- EULA: See the OpenFaaS CE EULA for usage restrictions.
Install OpenFaaS
masterDeploy OpenFaaS to your environment using the official deployment guides. OpenFaaS runs on Kubernetes, OpenShift, or as a lightweight standalone server usingfaasd.