Skip to content
fx is a framework to help you do Function as a Service with painless on your own servers
Go Shell Makefile Dockerfile JavaScript Rust Other
Branch: master
Clone or download
dependabot-preview and metrue Bump github.com/pkg/errors from 0.9.0 to 0.9.1 (#450)
Bumps [github.com/pkg/errors](https://github.com/pkg/errors) from 0.9.0 to 0.9.1.
- [Release notes](https://github.com/pkg/errors/releases)
- [Commits](pkg/errors@v0.9.0...v0.9.1)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>
Latest commit 9b3e857 Jan 15, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github add JSON to perl base image (#446) Jan 3, 2020
assets/dockerfiles/base add JSON to perl base image (#446) Jan 3, 2020
config Configurable auto remove (#440) Dec 31, 2019
constants fx on k8s (#278) Oct 5, 2019
container_runtimes Configurable auto remove (#440) Dec 31, 2019
context request a port when not port given (#379) Dec 3, 2019
contrib/docker_packer Better fx run remote docker host (#338) Nov 11, 2019
docs k3s on docker (#401) Dec 6, 2019
doctor Better fx run remote docker host (#338) Nov 11, 2019
examples update docs (#445) Jan 2, 2020
hack add document on ubunut (#352) Nov 15, 2019
handlers fix force option when deploy a function on Docker infra (#443) Jan 2, 2020
infra Refactor kubeconfig persist logic (#412) Dec 18, 2019
middlewares check if source file or directory is ready or not (#447) Jan 7, 2020
packer When check a file is handler or not, should take extension account, Dec 26, 2019
pkg list service as table format (#382) Dec 3, 2019
scripts When there is services deployed via k8s mode on Desktop Docker for Mac ( Dec 19, 2019
test use ssh to install, no dependency on k3sup (#367) Nov 27, 2019
types Refactor provision layer (#403) Dec 12, 2019
utils Squashed commit of the following: Dec 18, 2019
.gitattributes skip images assert (#271) Sep 28, 2019
.gitignore Refactor (#126) Jun 16, 2018
.golangci.yml fix lint issue (#319) Oct 14, 2019
.goreleaser.yml dependencies should be field of brew (#423) Dec 19, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Dec 4, 2017
LICENSE add license to code Nov 19, 2017
Makefile add perl support, Dec 18, 2019
README.md verify deploy function to Google Kubernetes Engine and update Doc (#435) Dec 27, 2019
fx.go check if source file or directory is ready or not (#447) Jan 7, 2020
go.mod Bump github.com/pkg/errors from 0.9.0 to 0.9.1 (#450) Jan 15, 2020
go.sum Bump github.com/pkg/errors from 0.9.0 to 0.9.1 (#450) Jan 15, 2020
k3s.cluster.json support k8s operator (#358) Nov 17, 2019

README.md

fx

Poor man's function as a service.
CI GitHub contributors CodeCov Go Report Card Go Doc Release

Table of Contents

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
Perl Supported fx /examples/Perl
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 (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,

$ KUBECONFIG=~/.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 root@123.11.2.3 --agents 'root@1.1.1.1,root@2.2.2.2'

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!

metrue muka pplam mbesancon chlins xwjdsh DaidoujiChen avelino andre2007 polyrabbit johnlunney tbrand andre2007 border-radius Russtopia FrontMage DropNib
You can’t perform that action at this time.