faas-rs/faas
1
0
Fork 0
mirror of https://github.com/openfaas/faas.git synced 2025-06-09 08:46:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add OpenFaaS branding.

Browse Source
This commit is contained in:
Alex Ellis 2017-08-18 08:41:52 +01:00 committed by GitHub
parent 49ea79cf01
commit 982765bdab
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,9 +1,11 @@
## Functions as a Service (FaaS)
## Functions as a Service (OpenFaaS)
[![Build
Status](https://travis-ci.org/alexellis/faas.svg?branch=master)](https://travis-ci.org/alexellis/faas)
FaaS is a framework for building serverless functions with Docker 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.
![OpenFaaS](https://blog.alexellis.io/content/images/2017/08/faas_side.png)
OpenFaaS is a framework for building serverless functions with Docker 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.
**Highlights**
@ -13,7 +15,7 @@ FaaS is a framework for building serverless functions with Docker which has firs
* [CLI](http://github.com/alexellis/faas-cli) available with YAML format for templating and defining functions
* Auto-scales as demand increases
## Overview of FaaS
## Overview of OpenFaaS
![Stack](https://pbs.twimg.com/media/DFrkF4NXoAAJwN2.jpg)
@ -95,7 +97,7 @@ https://cli.openfaas.com => 200
[Sample functions](https://github.com/alexellis/faas/tree/master/sample-functions) are available in the Github repository in a range of programming languages.
## Get started with FaaS
## Get started with OpenFaaS
### Closing Keynote at Dockercon 2017
@ -113,13 +115,13 @@ This is my original blog post on FaaS from January: [Functions as a Service blog
**Docker Playground**
You can quickly start FaaS on Docker Swarm online using the community-run Docker playground: play-with-docker.com (PWD) by clicking the button below:
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:
[![Try in PWD](https://cdn.rawgit.com/play-with-docker/stacks/cff22438/assets/images/button.png)](http://play-with-docker.com?stack=https://raw.githubusercontent.com/alexellis/faas/master/docker-compose.yml&stack_name=func)
**Docker Swarm**
A set of one-line scripts are provided to help you quickly test-drive FaaS on Docker Swarm with a set of sample functions as defined in the provided [docker-compose.yml](https://github.com/alexellis/faas/blob/master/docker-compose.yml) file.
A set of one-line scripts are provided to help you quickly test-drive OpenFaaS on Docker Swarm with a set of sample functions as defined in the provided [docker-compose.yml](https://github.com/alexellis/faas/blob/master/docker-compose.yml) file.
- `deploy_stack.sh` - for OSX/Linux on x86_64
- `deploy_stack.armhf.sh` - for Linux on ARM (Raspberry Pi for example)
@ -137,24 +139,24 @@ Here is a screenshot of the API gateway portal - designed for ease of use.
### Community
Have you written a blog about FaaS? Send a Pull Request to the community page below.
Have you written a blog about OpenFaaS? Send a Pull Request to the community page below.
* [Read blogs/articles and find events about FaaS](https://github.com/alexellis/faas/blob/master/community.md)
* [Read blogs/articles and find events about OpenFaaS](https://github.com/alexellis/faas/blob/master/community.md)
If you'd like to join FaaS community Slack channel to chat with contributors or get some help - then send a Tweet to [@alexellisuk](https://twitter.com/alexellisuk/) or open a Github issue.
If you'd like to join OpenFaaS community Slack channel to chat with contributors or get some help - then send a Tweet to [@alexellisuk](https://twitter.com/alexellisuk/) or open a Github issue.
## Roadmap and contributing
FaaS 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. To get started you can checkout the [roadmap and contribution guide](https://github.com/alexellis/faas/blob/master/ROADMAP.md) or [browse the open issues on Github](https://github.com/alexellis/faas/issues).
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. To get started you can checkout the [roadmap and contribution guide](https://github.com/alexellis/faas/blob/master/ROADMAP.md) or [browse the open issues on Github](https://github.com/alexellis/faas/issues).
Highlights:
* New: Kubernetes support via [FaaS-netes](https://github.com/alexellis/faas-netes) plugin
* New: FaaS CLI and easy install via `curl` and `brew`
* New: Windows function support
* In development: Asynchronous/long-running FaaS functions via NATS Streaming [Test it now](https://gist.github.com/alexellis/62dad83b11890962ba49042afe258bb1)
* In development: Asynchronous/long-running OpenFaaS functions via [NATS Streaming](https://nats.io/documentation/streaming/nats-streaming-intro/) - [Test it using this guide](https://gist.github.com/alexellis/62dad83b11890962ba49042afe258bb1)
Example of a Grafana dashboard linked to FaaS showing auto-scaling live in action:
Example of a Grafana dashboard linked to OpenFaaS showing auto-scaling live in action:
![](https://pbs.twimg.com/media/C9caE6CXUAAX_64.jpg:large)