opencollective/fx

fx is a framework to help you do Function as a Service with painless on your own servers

fx

Poor man's function as a service.

Table of Contents

• Introduction
• Installation
• Usage
• Manage Infrastructure
• Contribute

Introduction

fx is a tool to help you do Function as a Service on your own server, fx can make your stateless function a service in seconds, both Docker host and Kubernetes cluster supported. The most exciting thing is that you can write your functions with most programming languages.

Feel free hacking fx to support the languages not listed. Welcome to tweet me @_metrue on Twitter, @metrue on Weibo.

Language	Status	Contributor	Example
Go	Supported	fx	/examples/Golang
Rust	Supported	@FrontMage	/examples/Rust
Node	Supported	fx	/examples/JavaScript
Python	Supported	fx	/examples/Python
Ruby	Supported	fx	/examples/Ruby
Java	Supported	fx	/examples/Java
PHP	Supported	@chlins	/examples/PHP
Julia	Supported	@matbesancon	/examples/Julia
D	Supported	@andre2007	/examples/D
R	Working on need your help

Installation

Binaries are available for Windows, MacOS and Linux/Unix on x86. For other architectures and platforms, follow instructions to build fx from source.

• MacOS

brew tap metrue/homebrew-fx
brew install metrue/fx/fx

• Linux/Unix

via cURL

# Install to local directory
curl -o- https://raw.githubusercontent.com/metrue/fx/master/scripts/install.sh | bash

# Install to /usr/local/bin/
curl -o- https://raw.githubusercontent.com/metrue/fx/master/scripts/install.sh | sudo bash

fx will be installed into /usr/local/bin, sometimes you may need source ~/.zshrc or source ~/.bashrc to make fx available in $PATH.

• Windows

You can go the release page to download fx manually;

Usage

Make sure Docker installed and running on your server first. then type fx -h on your terminal to check out basic help.

NAME:
   fx - makes function as a service

USAGE:
   fx [global options] command [command options] [arguments...]

VERSION:
   0.8.7

COMMANDS:
   infra     manage infrastructure
   up        deploy a function
   down      destroy a service
   list, ls  list deployed services
   call      run a function instantly
   image     manage image of service
   doctor    health check for fx
   help, h   Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --help, -h     show help
   --version, -v  print the version

Deploy your function to Docker

$ fx up --name hello-fx ./examples/functions/JavaScript/func.js

+------------------------------------------------------------------+-----------+---------------+
|                                ID                                |   NAME    |   ENDPOINT    |
+------------------------------------------------------------------+-----------+---------------+
| 5b24d36608ee392c937a61a530805f74551ddec304aea3aca2ffa0fabcf98cf3 | /hello-fx | 0.0.0.0:58328 |
+------------------------------------------------------------------+-----------+---------------+

Deploy your function to Kubernetes

$ KUBECONFIG=~/.kube/config ./build/fx up examples/functions/JavaScript/func.js --name hello-fx

+-------------------------------+------+----------------+
| ID                     | NAME        |    ENDPOINT    |
+----+--------------------------+-----------------------+
|  5b24d36608ee392c937a  | hello-fx    | 10.0.242.75:80 |
+------------------------+-------------+----------------+

Test your service

then you can test your service:

$ curl -v 0.0.0.0:58328


GET / HTTP/1.1
Accept: */*
Accept-Encoding: gzip, deflate
Connection: keep-alive
Host: 0.0.0.0:10001
User-Agent: HTTPie/1.0.2



HTTP/1.1 200 OK
Connection: keep-alive
Content-Length: 11
Content-Type: text/plain; charset=utf-8
Date: Sat, 10 Aug 2019 05:28:03 GMT

hello world

Manage Infrastructure

fx is originally designed to turn a function into a runnable Docker container in a easiest way, on a host with Docker running, you can just deploy your function with fx up command, and now fx supports deploy function to be a service onto Kubernetes cluster infrasture, and we encourage you to do that other than on bare Docker environment, there are lots of advantage to run your function on Kubernetes like self-healing, load balancing, easy horizontal scaling, etc. It's pretty simple to deploy your function onto Kubernetes with fx, you just set KUBECONFIG in your enviroment.

By default. fx use localhost as target infrastructure to run your service, and you can also setup your remote virtual machines as fx's infrastructure and deploy your functions onto it.

fx infra create

You can create types (docker and k8s) of infrastructures for fx to deploy functions

$ fx infra create --name infra_us --type docker --host <user>@<ip>                                            ## create docker type infrasture on <ip>
$ fx infra create --name infra_bj --type k8s --master <user>@<ip> --agents '<user1>@<ip1>,<user2>@<ip2>'      ## create k8s type infrasture use <ip> as master node, and <ip1> and <ip2> as agents nodes

fx infra use

To use a infrastructure, you can use fx infra use command to activate it.

fx infra use <infrastructure name>

and you can list your infrastructure with fx infra list

Use Public Cloud Kubernetes Service as infrastructure to run your functions

• Azure Kubernetes Service (AKS)

You should create a Kubernetes cluster if you don't have one on AKS, detail document can found here.

$ az group create --name <myResourceGroup> --location eastus
$ az aks create --resource-group <myResourceGroup> --name myAKSCluster --node-count <count>
$ az aks get-credentials --resource-group <myResourceGroup> --name <myAKSCluster>

Then you can verify it with kubectl,

$ kubectl get nodes

NAME                       STATUS   ROLES   AGE     VERSION
aks-nodepool1-31718369-0   Ready    agent   6m44s   v1.12.8

Since AKS's config will be merged into ~/.kube/config and set to be current context after you run az aks get-credentials command, so you can just set KUBECONFIG to default config also,

$ export KUBECONFIG=~/.kube/config  # then fx will take the config to deloy function

But we would suggest you run kubectl config current-context to check if the current context is what you want.

• Amazon Elastic Kubernetes Service (EKS) TODO

• Google Kubernetes Engine (GKET) TODO

• Setup your own Kubernetes cluster

fx infra create --type k3s --name fx-cluster-1 --master [email protected] --agents '[email protected],[email protected]'

Contribute

fx uses Project to manage the development.

Prerequisites

Docker: make sure Docker installed and running on your server.

Build & Test

$ git clone https://github.com/metrue/fx
$ cd fx
$ make build

Then you can build and test:

$ make build
$ ./build/fx -h

Contributors

Thank you to all the people who already contributed to fx!