mirror of
https://github.com/openfaas/faas.git
synced 2025-06-13 10:46:46 +00:00
183 lines
8.5 KiB
Markdown
183 lines
8.5 KiB
Markdown
## OpenFaaS - Serverless Functions Made Simple
|
|
|
|
[](https://goreportcard.com/report/github.com/openfaas/faas) [](https://travis-ci.org/openfaas/faas) [](https://godoc.org/github.com/openfaas/faas) [](https://opensource.org/licenses/MIT)
|
|
[](https://www.openfaas.com)
|
|
|
|
|
|
|
|
OpenFaaS (Functions as a Service) is a framework for building serverless functions with Docker and Kubernetes which has first class support for metrics. Any process can be packaged as a function enabling you to consume a range of web events without repetitive boiler-plate coding.
|
|
|
|
[](https://twitter.com/openfaas)
|
|
|
|
**Highlights**
|
|
|
|
* Ease of use through UI portal and *one-click* install
|
|
* Write functions in any language for Linux or Windows and package in Docker/OCI image format
|
|
* Portable - runs on existing hardware or public/private cloud - [Kubernetes](https://github.com/openfaas/faas-netes) and Docker Swarm native
|
|
* [CLI](http://github.com/openfaas/faas-cli) available with YAML format for templating and defining functions
|
|
* Auto-scales as demand increases
|
|
|
|
## New: become an OpenFaaS backer or sponsor
|
|
|
|
We need your support to keep delivering on Serverless Functions Made Simple so pledge to OpenFaaS and [become a backer or a sponsor](https://www.patreon.com/alexellis) with a unique set of rewards. Help us hit our goals and get to back a great project at the same time.
|
|
|
|
View the [List of backers and sponsors](https://github.com/openfaas/faas/blob/master/BACKERS.md)
|
|
|
|
## Press-kit/media/swag
|
|
|
|
For stickers, swag, media or press-kit information head over to [openfaas/media](https://github.com/openfaas/media/blob/master/README.md)
|
|
|
|
## Governance
|
|
|
|
OpenFaaS is an independent project created by [Alex Ellis](https://www.alexellis.io) which is now being built and shaped by a growing community of contributors. Project website: [openfaas.com](https://www.openfaas.com).
|
|
|
|
## Overview of OpenFaaS
|
|
|
|
> Serverless Functions Made Simple.
|
|
|
|
|
|
|
|
### Function Watchdog
|
|
|
|
* You can make any Docker image into a serverless function by adding the *Function Watchdog* (a tiny Golang HTTP server)
|
|
* The *Function Watchdog* is the entrypoint allowing HTTP requests to be forwarded to the target process via STDIN. The response is sent back to the caller by writing to STDOUT from your application.
|
|
|
|
### API Gateway / UI Portal
|
|
|
|
* The API Gateway provides an external route into your functions and collects Cloud Native metrics through Prometheus.
|
|
* Your API Gateway will scale functions according to demand by altering the service replica count in the Docker Swarm or Kubernetes API.
|
|
* A UI is baked in allowing you to invoke functions in your browser and create new ones as needed.
|
|
|
|
> The API Gateway is a RESTful micro-service and you can view the [Swagger docs here](https://github.com/openfaas/faas/tree/master/api-docs).
|
|
|
|
### CLI
|
|
|
|
Any container or process in a Docker container can be a serverless function in FaaS. Using the [FaaS CLI](http://github.com/openfaas/faas-cli) you can deploy your functions quickly.
|
|
|
|
Create new functions from templates for Node.js, Python, [Go](https://blog.alexellis.io/serverless-golang-with-openfaas/) and many more. If you can't find a suitable template you can also use a Dockerfile.
|
|
|
|
> The CLI is effectively a RESTful client for the API Gateway.
|
|
|
|
When you have OpenFaaS configured you can [get started with the CLI here](https://blog.alexellis.io/quickstart-openfaas-cli/)
|
|
|
|
### Function examples
|
|
|
|
You can generate new functions using the FaaS-CLI and built-in templates or use any binary for Windows or Linux in a Docker container.
|
|
|
|
* Python example:
|
|
|
|
```python
|
|
import requests
|
|
|
|
def handle(req):
|
|
r = requests.get(req, timeout = 1)
|
|
print(req +" => " + str(r.status_code))
|
|
```
|
|
*handler.py*
|
|
|
|
* Node.js example:
|
|
|
|
```js
|
|
"use strict"
|
|
|
|
module.exports = (callback, context) => {
|
|
callback(null, {"message": "You said: " + context})
|
|
}
|
|
```
|
|
*handler.js*
|
|
|
|
Other [Sample functions](https://github.com/openfaas/faas/tree/master/sample-functions) are available in the Github repository in a range of programming languages.
|
|
|
|
## Documentation
|
|
|
|
We are building a new documentation site at [docs.openfaas.com](http://docs.openfaas.com).
|
|
|
|
For all other guides, tutorials, trouble-shooting and blog posts head over to our [guides page](https://github.com/openfaas/faas/tree/master/guide) on GitHub.
|
|
|
|
## Get started with OpenFaaS
|
|
|
|
### Hands-on labs (detailed getting started)
|
|
|
|
You can learn how to build functions with OpenFaaS using our hands-on labs in the [OpenFaaS workshop](http://github.com/openfaas/workshop).
|
|
|
|
### TestDrive (classic getting started)
|
|
|
|
**Kubernetes**
|
|
|
|
OpenFaaS is Kubernetes-native - you can follow the [deployment guide here](http://docs.openfaas.com/deployment/kubernetes/).
|
|
|
|
**Docker Swarm**
|
|
|
|
The deployment guide for Docker Swarm contains a simple one-line command to get you up and running in around 60 seconds. It also includes a set of [sample functions](https://github.com/openfaas/faas/tree/master/sample-functions) which you can use with the TestDrive instructions below.
|
|
|
|
[Deployment guide for Docker Swarm](http://docs.openfaas.com/deployment/docker-swarm/)
|
|
|
|
The new login feature breaks the one-click deployment to PWD.
|
|
**Docker Playground**
|
|
|
|
You can quickly start OpenFaaS on Docker Swarm online using the community-run Docker playground: play-with-docker.com (PWD) by clicking the button below:
|
|
|
|
[](http://play-with-docker.com?stack=https://raw.githubusercontent.com/openfaas/faas/master/docker-compose.yml&stack_name=func)
|
|
|
|
#### Begin the TestDrive
|
|
|
|
* [Begin the TestDrive with Docker Swarm](https://github.com/openfaas/faas/blob/master/TestDrive.md)
|
|
|
|
Here is a screenshot of the API gateway portal - designed for ease of use.
|
|
|
|
|
|
|
|
## Find out more about OpenFaaS
|
|
|
|
### SkillsMatter video presentation
|
|
|
|
Great overview of OpenFaaS features, users and roadmap
|
|
|
|
* [HD Video](https://skillsmatter.com/skillscasts/10813-faas-and-furious-0-to-serverless-in-60-seconds-anywhere)
|
|
|
|
### OpenFaaS presents to CNCF Serverless workgroup
|
|
|
|
* [Video and blog post](https://blog.alexellis.io/openfaas-cncf-workgroup/)
|
|
|
|
### Closing Keynote at Dockercon 2017
|
|
|
|
Functions as a Service or FaaS was a winner in the Cool Hacks contest for Dockercon 2017.
|
|
|
|
* [Watch my FaaS keynote at Dockercon 2017](https://blog.docker.com/2017/04/dockercon-2017-mobys-cool-hack-sessions/)
|
|
|
|
If you'd like to find the functions I used in the demos head over to the [faas-dockercon](https://github.com/alexellis/faas-dockercon/) repository.
|
|
|
|
**Background story**
|
|
|
|
* [Introducing OpenFaaS (Functions as a Service)](https://blog.alexellis.io/introducing-functions-as-a-service/) - August 2017
|
|
* [Functions as a Service (FaaS)](http://blog.alexellis.io/functions-as-a-service/) - January 2017
|
|
|
|
### Community
|
|
|
|
Have you written a blog about OpenFaaS? Send a Pull Request to the community page below.
|
|
|
|
* [Read blogs/articles and find events about OpenFaaS](https://github.com/openfaas/faas/blob/master/community.md)
|
|
|
|
If you'd like to join OpenFaaS community Slack channel to chat with contributors or get some help then check out [this page on community](https://docs.openfaas.com/community).
|
|
|
|
### Roadmap and contributing
|
|
|
|
OpenFaaS is written in Golang and is MIT licensed - contributions are welcomed whether that means providing feedback, testing existing and new feature or hacking on the source.
|
|
|
|
#### How do I become a contributor?
|
|
|
|
Please see the guide on [community & contributing](https://docs.openfaas.com/community/#contribute)
|
|
|
|
#### Roadmap
|
|
|
|
The roadmap is represented in [GitHub issues](https://github.com/openfaas/faas/issues) and a Trello board. There is also a historical ROADMAP file in the [main faas repository](https://github.com/openfaas/faas/blob/master/ROADMAP.md).
|
|
|
|
### Other
|
|
|
|
Example of a Grafana dashboards linked to OpenFaaS showing auto-scaling live in action: [here](https://grafana.com/dashboards/3526)
|
|
|
|
|
|
|
|
An alternative community dashboard is [available here](https://grafana.com/dashboards/3434)
|