mirror of
https://github.com/openfaas/faas.git
synced 2025-06-27 09:13:24 +00:00
Migrate from alexellis org to openfaas
Note, not all `alexellis/github` references should be changed, there are a number of repos which are not part of the openfaas org, this commit excludes those. Signed-off-by: John McCabe <john@johnmccabe.net>
This commit is contained in:
@ -6,7 +6,7 @@ By default functions are accessed synchronously via the following route:
|
||||
$ curl --data "message" http://gateway/function/{function_name}
|
||||
```
|
||||
|
||||
As of [PR #131](https://github.com/alexellis/faas/pull/131) asynchronous invocation is available for testing.
|
||||
As of [PR #131](https://github.com/openfaas/faas/pull/131) asynchronous invocation is available for testing.
|
||||
|
||||
*Logical flow for synchronous functions:*
|
||||
|
||||
@ -74,4 +74,4 @@ Hard timeout:
|
||||
|
||||
To make use of these just add them to your Dockerfile when needed as ENV variables.
|
||||
|
||||
> [Function watchdog reference](https://github.com/alexellis/faas/tree/master/watchdog)
|
||||
> [Function watchdog reference](https://github.com/openfaas/faas/tree/master/watchdog)
|
||||
|
@ -13,7 +13,7 @@ There is also community work in-progress to support:
|
||||
|
||||
* Rancher/Cattle
|
||||
|
||||
The Docker Swarm support is built-into the faas repo, but the Kubernetes support is provided by a microservice in the [faas-netes](https://github.com/alexellis/faas-netes) repo.
|
||||
The Docker Swarm support is built-into the faas repo, but the Kubernetes support is provided by a microservice in the [faas-netes](https://github.com/openfaas/faas-netes) repo.
|
||||
|
||||
If you're thinking of writing a new back-end we'd love to hear about it and help you, so please get in touch with alex@openfaas.com. Existing implementations (like OpenFaaS) are written in Golang and this provides a level of consistency across the projects.
|
||||
|
||||
@ -28,11 +28,11 @@ Here are some ideas:
|
||||
* AWS ECS
|
||||
* Hyper.sh
|
||||
|
||||
If you would like to write your own back-end for `X` then you can write your own microservice that conforms to the [Swagger API](https://github.com/alexellis/faas/tree/master/api-docs) here.
|
||||
If you would like to write your own back-end for `X` then you can write your own microservice that conforms to the [Swagger API](https://github.com/openfaas/faas/tree/master/api-docs) here.
|
||||
|
||||
### How does my back-end work?
|
||||
|
||||
In order to support a new back end you will write a new "external_provider" and configure this on the API Gateway. The API Gateway will then proxy any requests to your new microservice. The first "external_provider" was the Kubernetes implementation [faas-netes](https://github.com/alexellis/faas-netes):
|
||||
In order to support a new back end you will write a new "external_provider" and configure this on the API Gateway. The API Gateway will then proxy any requests to your new microservice. The first "external_provider" was the Kubernetes implementation [faas-netes](https://github.com/openfaas/faas-netes):
|
||||
|
||||

|
||||
|
||||
@ -44,7 +44,7 @@ Invoke your function - through the built-in Swarm or via faas-netes
|
||||
|
||||

|
||||
|
||||
Find out more about the [watchdog here](https://github.com/alexellis/faas/tree/master/watchdog).
|
||||
Find out more about the [watchdog here](https://github.com/openfaas/faas/tree/master/watchdog).
|
||||
|
||||
### Automatically compatible OpenFaaS
|
||||
|
||||
@ -54,7 +54,7 @@ The following are fully compatible with any additional back-ends:
|
||||
* Promethes metrics (tracked through API Gateway)
|
||||
* The built-in UI portal (hosted on the API Gateway)
|
||||
* The Function Watchdog and any existing OpenFaaS functions
|
||||
* The [CLI](https://github.com/alexellis/faas-cli)
|
||||
* The [CLI](https://github.com/openfaas/faas-cli)
|
||||
* Asynchronous function invocation
|
||||
|
||||
Dependent on back-end:
|
||||
@ -92,13 +92,13 @@ Method(s): POST
|
||||
|
||||
### Examples / documentation
|
||||
|
||||
* See the [Swagger API](https://github.com/alexellis/faas/tree/master/api-docs) as a starting point.
|
||||
* See the [Swagger API](https://github.com/openfaas/faas/tree/master/api-docs) as a starting point.
|
||||
|
||||
#### faas-netes (Kubernetes)
|
||||
|
||||
The Kubernetes integration was written by Alex Ellis and is officially supported by the project.
|
||||
|
||||
* See the [FaaS-netes handlers](https://github.com/alexellis/faas-netes/tree/master/handlers) for examples of how to implement each endpoint.
|
||||
* See the [FaaS-netes handlers](https://github.com/openfaas/faas-netes/tree/master/handlers) for examples of how to implement each endpoint.
|
||||
|
||||
#### Rancher / Cattle (community)
|
||||
|
||||
|
@ -8,15 +8,15 @@ Below is a demo of how you could use Kong as an authentication layer for OpenFaa
|
||||
|
||||
If you haven't already setup OpenFaaS then you can follow one of the deployment guides available here:
|
||||
|
||||
* [Docker Swarm](https://github.com/alexellis/faas/blob/master/guide/deployment_swarm.md)
|
||||
* [Kubernetes](https://github.com/alexellis/faas/blob/master/guide/deployment_k8s.md)
|
||||
* [Docker Swarm](https://github.com/openfaas/faas/blob/master/guide/deployment_swarm.md)
|
||||
* [Kubernetes](https://github.com/openfaas/faas/blob/master/guide/deployment_k8s.md)
|
||||
|
||||
Here is a quick reference for Docker Swarm:
|
||||
|
||||
```
|
||||
$ docker swarm init --advertise-addr $(hostname -i)
|
||||
|
||||
$ git clone https://github.com/alexellis/faas && \
|
||||
$ git clone https://github.com/openfaas/faas && \
|
||||
cd faas && \
|
||||
./deploy_stack.sh
|
||||
```
|
||||
|
@ -114,7 +114,7 @@ Within the CLI directory for instance:
|
||||
Build the samples:
|
||||
|
||||
```
|
||||
$ git clone https://github.com/alexellis/faas-cli && \
|
||||
$ git clone https://github.com/openfaas/faas-cli && \
|
||||
cd faas-cli
|
||||
$ faas-cli -action build -f ./samples.yml
|
||||
```
|
||||
|
Reference in New Issue
Block a user