faas-fargate

KO | EN

gitlite — search

#javascript #react #typescript #llm #android #machine-learning #deep-learning #docker #java #cli #kubernetes #vue #mcp #open-source

(★ 50)

OpenFaaS on AWS Fargate. Open source Functions as a Service without any infrastructure to manage

faas-fargate Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<p align="center">
  <img alt="Mascot" src="docs/mascot.png" />
  <h3 align="center">faas-fargate</h3>
  <p align="center">Run OpenFaaS on AWS serverless with Fargate.</p>
  <p align="center">
    <a href="https://github.com/goreleaser/goreleaser/releases/latest"><img alt="Release" src="https://img.shields.io/github/release/ewilde/faas-fargate.svg?style=flat-square"></a>
    <a href="/LICENSE.md"><img alt="Software License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square"></a>
    <a href="https://travis-ci.org/ewilde/faas-fargate"><img alt="Travis" src="https://img.shields.io/travis/ewilde/faas-fargate/master.svg?style=flat-square"></a>
    <a href="https://github.com/goreleaser"><img alt="Powered By: GoReleaser" src="https://img.shields.io/badge/powered%20by-goreleaser-green.svg?style=flat-square"></a>   
  </p>
</p>

---

## Installation
### Terraform deployment
_**Easy to get started**_: A [terraform module](https://github.com/ewilde/terraform-aws-openfaas-fargate) has been developed 
to build out a standard deployment of `faas-fargate` on `fargate`. See: https://github.com/ewilde/terraform-aws-openfaas-fargate.
This module deploys the whole stack on Fargate including openfaas `gateway`, `nats` and sets up default security setting
etc...

### Manually
1. Use the [published docker image](https://hub.docker.com/r/ewilde/faas-fargate/)
2. Download from the [releases tab](https://github.com/ewilde/faas-fargate/releases)

## Configuration
All configuration is managed using environment variables

| Option                            | Usage                                                                                          | Default                  | Required |
|-----------------------------------|------------------------------------------------------------------------------------------------|--------------------------|----------|
| `subnet_ids`                      | Comma separated list of subnet ids used to place function                                      | subnets from default vpc |   no     |
| `security_group_id`               | Id of the security group to assign functions. If using [terraform-aws-openfaas-fargate](https://github.com/ewilde/terraform-aws-openfaas-fargate) this is the output variable `service_security_group`                                                  |                          |   no       |
| `cluster_name`                    | Name of the AWS ECS cluster.                                                                   | `openfaas`               |   no     |
| `assign_public_ip`                | Whether or not to associate a public ip address with your function.                            | `DISABLED`               |   no     |
| `enable_function_readiness_probe` | Boolean - enable a readiness probe to test functions.                                          | `true`                   |   no     |
| `write_timeout`                   | HTTP timeout for writing a response body from your function (in seconds).                      | `8`                      |   no     |
| `read_timeout`                    | HTTP timeout for reading the payload from the client caller (in seconds).                      | `8`                      |   no     |
| `image_pull_policy`               | Image pull policy for deployed functions (`Always`, `IfNotPresent`, `Never`)                   | `Always`                 |   no     |
| `LOG_LEVEL`                       | Logging level either: `trace, debug, info, warn, error, fatal, panic`.                         | `info`                   |   no     |
| `AWS_DEFAULT_REGION`              | AWS region faas-fargate is running in.                                                         | `us-east-1`              |   no     |

## Overview
![diagram of the openfaas on fargate architecture](https://raw.githubusercontent.com/ewilde/faas-fargate/master/docs/architecture.png "Openfaas for fargate overview")

## Contributions
We welcome contributions! Please refer to our [contributing guidelines](CONTRIBUTING.md) for further information.

## Releasing
Releases are made using [goreleaser](https://github.com/goreleaser/goreleaser) and use [semver](https://semver.org/)

### Example release
#### Step 1 tag the release
```
git tag v0.5.7 -m "feat: Adds verify_ssl support to environment resource"
git push origin v0.5.7
```
#### Step 2 wait for travis build to complete
Travis will:
1. build the release
1. run tests
1. push to [docker](https://hub.docker.com/r/ewilde/faas-fargate/)
1. create a github release on the [releases tab](https://github.com/ewilde/faas-fargate/releases)

faas-fargate

faas-fargate Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

faas-fargate

faas-fargate Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README