Code Repositories
Code repositories¶
All source is organised under two repositories on GitHub: openfaas and openfaas-incubator.
OpenFaaS org¶
OpenFaaS started as a single mono-repo called faas and has been broken out into separate repositories in the openfaas organisation.
For this reason you should always collate statistics from the openfaas organisation, rather than the repository of a single component, which would provide invalid data. So whether counting issues, PRs, contributors, stars, or any other metric, use the whole organisation.
| Repository | Headline |
|---|---|
| docs | Official docs repository for this site - i.e. https://docs.openfaas.com |
| faas-cli | CLI for operating with OpenFaaS similar to kubectl or docker CLI |
| faas | Main repository for project issues, suggestions, documentation and roadmap/backlog items. Also includes UI portal and API gateway |
| faas-netes | Kubernetes provider for OpenFaaS contains YAML and helm for deployment |
| faasd | Alternative to faas-netes - OpenFaaS for containerd, for a single node. |
| templates | Official templates for OpenFaaS CLI used to scaffold a new function |
| nats-queue-worker | Asynchronous processing for deferred / queued work with OpenFaaS, based upon NATS Streaming |
| certifier | End-to-end tests written in Go for verifying OpenFaaS with Kubernetes or faasd after a release, this also runs through CI for the faas repo |
| of-watchdog | The OpenFaaS watchdog re-written with mode-abstractions for both STDIO & HTTP |
| classic-watchdog | The OpenFaaS watchdog re-written with mode-abstractions for both STDIO & HTTP |
| openfaas.github.io | Source for https://www.openfaas.com and blog |
| store | Function and template store manifests |
| media | Press-kit and media for the project branding and merchandise |
| ingress-operator | Provides FunctionIngress CRD for Custom Domains on Kubernetes |
| connector-sdk | Build your own event connectors for OpenFaaS |
| workshop | Practical training and hands-on labs for learning OpenFaaS |
| vcenter-connector | Trigger OpenFaaS Functions from events in VMware vCenter |
| faas-memory | An OpenFaaS Provider example using memory for state. |
Deprecated¶
No longer maintained, source available.
| Repository | Headline |
|---|---|
| faas-swarm | Docker Swarm provider for OpenFaaS contains a stack file for deployment |
| openfaas-cloud | OpenFaaS Cloud - portable, multi-user Serverless Functions powered by GitOps |
| ofc-bootstrap | "one-click" CLI to install OpenFaaS Cloud on Kubernetes |
| faas-federation | Federate two OpenFaaS installations into one API |
Training & tutorials¶
| Repository | Headline |
|---|---|
| workshop-vscode | Run a Kubernetes workshop with VSCode in the browser |
| openfaas-linkerd-workshop | Lightweight Serverless on Kubernetes with mTLS and traffic-splitting with Linkerd2 |
| openfaas-function-auth | Examples of authentication in OpenFaaS Serverless functions. |
Templates¶
| Repository | Headline |
|---|---|
| templates | Official templates for OpenFaaS CLI used to scaffold a new function |
| golang-http-template | Golang template providing additional control over the HTTP request and response. |
| powershell-http | PowerShell HTTP template |
| ruby-http | A Ruby HTTP template for OpenFaaS |
| python-flask-template | OpenFaaS templates for Python 2.7/3.6 with Flask |
| python3-debian | Template for Python3 on Debian for data-science / compiled pip modules |
| perl-template | Perl template for OpenFaaS |