https://github.com/vitwit/faas-akash

OpenFaaS provider for Akash-Network
https://github.com/vitwit/faas-akash

akash akash-network openfaas serverless-computing serverless-functions

Last synced: 12 days ago
JSON representation

OpenFaaS provider for Akash-Network

• Host: GitHub
• URL: https://github.com/vitwit/faas-akash
• Owner: vitwit
• License: mit
• Created: 2019-12-26T08:15:02.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-01-04T13:50:16.000Z (about 6 years ago)
• Last Synced: 2024-04-01T16:10:10.771Z (almost 2 years ago)
• Topics: akash, akash-network, openfaas, serverless-computing, serverless-functions
• Language: Go
• Size: 65.4 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# `faas-akash provider`



[![version](https://img.shields.io/github/tag/vitwit/faas-akash.svg)](https://github.com/vitwit/faas-akash/releases/latest)

[![Build Status](https://circleci.com/gh/vitwit/faas-akash.svg?style=svg)](https://circleci.com/gh/vitwit/faas-akash)

[![codecov](https://codecov.io/gh/vitwit/faas-akash/branch/master/graph/badge.svg)](https://codecov.io/gh/vitwit/faas-akash)

[![Go Report Card](https://goreportcard.com/badge/github.com/openfaas/faas)](https://goreportcard.com/report/github.com/openfaas/faas)[![GoDoc](https://godoc.org/github.com/vitwit/go-faas?status.svg)](https://godoc.org/github.com/vitwit/go-faas) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

## Contents

* [Requirements](#requirements)

* [Installation](#installation)

Requirements

------------

- [Go](https://golang.org/doc/install) 1.13+ (to build the provider plugin)

- [faas-cli](https://github.com/openfaas/faas-cli/releases) 

- [akash-cli](https://github.com/ovrclk/akash/releases) (make sure to put akash-cli in your $PATH or /usr/local/bin)

Installation

------------

* Clone this repository and cd into the directory

* Run `make build`, it will generate a file named `faas-akash`  

* run `./faas-akash` and enjoy OpenFaas :handshaking: Akash Network 

Provider Configuration

------------

* by default, faas-akash provider assumes a `config.yaml` to be present in $HOME/.faas-akash/

* few fields can be set using this config file or environmental variables

| Property                      | Description                                                                                                           | Required    |

| ----------------------------- | ------------------------------------------------- | ---------- |

| `port`                        | OpenFaas Gateway Port                             | `No`       |

| `readTimeout`                 | Request body ReadTimeout in seconds               | `No`       |

| `writeTimeout`                | Request Body WriteTimeout in seconds              | `No`       |

### Example

```yaml

port: 8090

readTimeout: 180

writeTimeout: 180

```

[install-go]: https://golang.org/doc/install#install