fx

Poor man's function as a service.

Table of Contents

• Introduction
• Installation
• Usage

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@_metrueon Twitter,@metrueon 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
Perl	Supported	fx	/examples/Perl
Crystal	Supported	@mvrilo	/examples/Crystal
R	Working onneed your help

Installation

Binaries are available for Windows, MacOS and Linux/Unix on x86. For other architectures and platforms, follow instructions tobuild 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 /metrue/fx/master/scripts/install.sh|bash

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

fx will be installed into /usr/local/bin, sometimes you may needsource ~/.zshrcorsource ~/.bashrcto make fx available in$PATH.

• Windows

You can go the release page todownloadfx manually;

Usage

NAME:
fx - makes function as a service

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

COMMANDS:
up deploy a function
down destroy a service
list, ls list deployed services
image manage image of service
help, h Shows a list of commands or help for one command

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

Deploy function

Local Docker environment

By default, function will be deployed on localhost, make sureDockerinstalled and running on your server first. then typefx -hon your terminal to check out basic help.

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

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

Remote host

Use--hostto specify the target host for your function, or you can just set it toFX_HOSTenvironment variable.

$ fx up --host roo@<your host>--name hello./examples/functions/JavaScript/func.js

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

Kubernetes

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

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

Test 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

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 foundhere.

$ 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 withkubectl,

$ 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/configand set to be current context after you runaz aks get-credentialscommand, so you can just set KUBECONFIG to default config also,

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

But we would suggest you runkubectl config current-contextto check if the current context is what you want.

• Amazon Elastic Kubernetes Service (EKS) TODO

• Google Kubernetes Engine (GKE)

First you should create a Kubernetes cluster in your GKE, then make sure your KUBECONFIG is ready in~/.kube/config,if not, you can run following commands,

$ gcloud auth login
$ gcloud container clusters get-credentials<your cluster>--zone<zone>--project<project>

Then make sure you current context is GKE cluster, you can check it with command,

$ kubectl config current-context

Then you can deploy your function onto GKE cluster with,

$ FX_KUBECONF=~/.kube/config fx up examples/functions/JavaScript/func.js --name hellojs

• Setup your own Kubernetes cluster

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

Contributors

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