MCPcopy
hub / github.com/openfaas/faas

github.com/openfaas/faas @0.27.14 sqlite

repository ↗ · DeepWiki ↗ · release 0.27.14 ↗
731 symbols 3,042 edges 65 files 88 documented · 12%
README

OpenFaaS ® - Serverless Functions Made Simple

Build Status go.dev reference OpenFaaS

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."

Follow @openfaas on X

Highlights

Want to dig deeper into OpenFaaS?

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) => { return context .status(200) .headers({"Content-Type": "text/html"}) .succeed(<h1> 👋 Hello World 🌍 </h1>); }

    ``` handler.js

  • Python 3 example (python3-http):

    python def handle(event, context): return { "statusCode": 200, "body": "Hello from OpenFaaS!" }

    handler.py

  • Golang example (golang-middleware)

    ```go package function

    import ( "fmt" "io" "net/http" )

    func Handle(w http.ResponseWriter, r *http.Request) { var input []byte

    if r.Body != nil {
            defer r.Body.Close()
            body, _ := io.ReadAll(r.Body)
            input = body
    }
    
    w.WriteHeader(http.StatusOK)
    w.Write([]byte(fmt.Sprintf("Body: %s", string(input))))
    

    } ```

Get started with OpenFaaS

Official training resources

View our official training materials

Official eBook and video workshop

eBook logo

The founder of OpenFaaS wrote Serverless For Everyone Else to help developers understand the use-case for functions through practical hands-on exercises using JavaScript and Node.js. No programming experience is required to try the exercises.

The examples use the faasd project, which is an easy to use and lightweight way to start learning about OpenFaaS and functions.

Check out Serverless For Everyone Else on Gumroad

OpenFaaS and Golang

Everyday Go is a practical, hands-on guide to writing CLIs, web pages, and microservices in Go. It also features a chapter dedicated to development and testing of functions using OpenFaaS and Go.

Community blog and documentation

Quickstart

OpenFaaS Community Edition UI

Here is a screenshot of the OpenFaaS Community Edition UI which was designed for ease of use. The inception function is being run which is available on the in the store.

Deploy OpenFaaS to Kubernetes, OpenShift, or faasd now with a deployment guide

OpenFaaS Standard and OpenFaaS for Enterprises have their own, brand new dashboard with multi-tenancy support, learn more about the OpenFaaS Dashboard.

Video presentations

Community events and blog posts

Have you written a blog about OpenFaaS? Do you have a speaking event? Send a Pull Request to the community page below.

Contributing

OpenFaaS Community Edition is written in Golang. All third-party contributions to the source code are made under the MIT license, additional restrictions apply to OpenFaaS CE as a whole, where contributions from OpenFaaS Ltd are licensed under the OpenFaaS CE EULA. Various types of contributions are welcomed whether that means providing feedback, testing existing and new feature or hacking on the source code.

How do I become a contributor?

Please see the guide on community & contributing

Dashboards

Example of a Grafana dashboard linked to OpenFaaS showing auto-scaling live in action: here

OpenFaaS Pro auto-scaling dashboard with Grafana

OpenFaaS Pro auto-scaling dashboard with Grafana

An alternative community dashboard is available here

Press / Branding / Website Sponsorship

  • OpenFaaS for commercial and internal use

    OpenFaaS Pro (Standard and For Enterprises) is fully featured, supported, and built for production. The Community Edition (CE) is licensed for a 60-day Proof of Concept (PoC) and limited experimentation.

    Learn more about OpenFaaS editions

  • Website Sponsorship 🌎

If you'd like to gain visibility by displaying your logon on the openfaas.com homepage, feel free to reach out via email or browse the tiers via GitHub Sponsors.

  • Press / Analysts

Looking at these repositories for commit counts and activity? All public repositories are part of OpenFaaS CE, a limited version of OpenFaaS aimed at giving people a low-barrier trial experience without having to sign up with a credit card. OpenFaaS CE is maintained on a best effort basis, but is not "OpenFaaS" itself. All OpenFaaS product development is done in private repositories, and cannot be tracked by third parties or by simply browsing GitHub.

How are GitHub Stars and Forks counted? OpenFaaS CE is not a mono-repo, you cannot simply look at one repository and say "ah that's the count" - statistics are gathered from the whole GitHub organisation.

Governance

OpenFaaS ® is an independent open-source project created by Alex Ellis, which is being built and shaped by a growing community of contributors.

OpenFaaS is hosted by OpenFaaS Ltd (registration: 11076587), a company which also offers commercial services, homepage sponsorships, and support. OpenFaaS ® is a registered trademark in England and Wales.

Users

View a selection of end-user companies who have given permission to have their logo listed at openfaas.com.

Extension points exported contracts — how you extend this code

HTTPNotifier (Interface)
HTTPNotifier notify about HTTP request/response [3 implementers]
gateway/handlers/notifiers.go
HasEnv (Interface)
HasEnv provides interface for os.Getenv [2 implementers]
gateway/types/readconfig.go
BaseURLResolver (Interface)
BaseURLResolver URL resolver for upstream requests [2 implementers]
gateway/pkg/middleware/resolver.go
FunctionCacher (Interface)
FunctionCacher queries functions and caches the results [1 implementers]
gateway/scaling/function_cache.go
PrometheusQueryFetcher (Interface)
(no doc) [2 implementers]
gateway/metrics/prometheus_query.go
URLPathTransformer (Interface)
URLPathTransformer Transform the incoming URL path for upstream requests [2 implementers]
gateway/pkg/middleware/resolver.go
ServiceQuery (Interface)
ServiceQuery provides interface for replica querying/setting [1 implementers]
gateway/scaling/service_query.go
AuthInjector (Interface)
AuthInjector is an interface for injecting authentication information into a request which will be proxied or made to a [1 …
gateway/pkg/middleware/serviceauthinjector.go

Core symbols most depended-on inside this repo

Get
called by 43
gateway/scaling/function_query.go
Read
called by 26
gateway/types/readconfig.go
Set
called by 25
gateway/scaling/function_cache.go
Getenv
called by 22
gateway/types/readconfig.go
Write
called by 14
gateway/handlers/logs.go
Do
called by 13
gateway/scaling/single.go
MakeForwardingProxyHandler
called by 13
gateway/handlers/forwarding_proxy.go
CalculateReplicas
called by 12
gateway/handlers/alerthandler.go

Shape

Function 627
Method 51
Struct 42
Interface 10
FuncType 1

Languages

TypeScript65%
Go35%

Modules by API surface

gateway/assets/script/angularjs/1.8.0/angular.min.js285 symbols
gateway/assets/script/angular_material/1.2.1/angular-material.min.js115 symbols
gateway/assets/script/angularjs/1.8.0/angular-animate.min.js53 symbols
gateway/types/readconfig_test.go23 symbols
gateway/pkg/middleware/resolver.go16 symbols
gateway/types/readconfig.go11 symbols
gateway/handlers/alerthandler_test.go11 symbols
gateway/handlers/forwarding_proxy_test.go10 symbols
gateway/pkg/middleware/baseurlresolver_test.go9 symbols
gateway/assets/script/bootstrap.js9 symbols
gateway/metrics/exporter.go8 symbols
gateway/scaling/function_query.go7 symbols

Used by 1 indexed graphs manifest dependencies, hub-wide

Dependencies from manifests, versioned

github.com/beorn7/perksv1.0.1 · 1×
github.com/cespare/xxhash/v2v2.3.0 · 1×
github.com/docker/distributionv2.8.3+incompatible · 1×
github.com/hashicorp/go-hclogv1.6.3 · 1×
github.com/hashicorp/go-msgpack/v2v2.1.3 · 1×
github.com/hashicorp/raftv1.7.3 · 1×
github.com/minio/highwayhashv1.0.3 · 1×
github.com/munnerz/goautonegv0.0.0-2019101008341 · 1×
github.com/nats-io/jwt/v2v2.8.0 · 1×

For agents

$ claude mcp add faas \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact