Code Monkey home page Code Monkey logo

metrue / fx Goto Github PK

View Code? Open in Web Editor NEW
2.1K 31.0 154.0 67.08 MB

A Function as a Service tool makes a function as a container-based service in seconds.

License: MIT License

Makefile 0.97% Go 55.50% Shell 1.59% Dockerfile 1.18% Rust 0.58% C 0.01% D 38.66% Java 0.27% Julia 0.21% JavaScript 0.51% PHP 0.09% Python 0.08% Ruby 0.19% Raku 0.01% Crystal 0.06% Perl 0.09%
faas function-as-a-service docker serverless microservice aws-lambda aks kubernetes k8s self-hosted

fx's Introduction

fx

Poor man's function as a service.
CI GitHub contributors CodeCov Go Report Card Go Doc visitors license 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
Crystal Supported @mvrilo /examples/Crystal
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

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 sure Docker installed and running on your server first. then type fx -h on 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 --host to specify the target host for your function, or you can just set it to FX_HOST environment 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 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 FX_KUBECONF=~/.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,

$ 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!

metrue muka pplam mbesancon chlins xwjdsh DaidoujiChen avelino andre2007 polyrabbit johnlunney tbrand andre2007 border-radius Russtopia FrontMage DropNib

fx's People

Contributors

abirdcfly avatar ahsandar avatar andre2007 avatar avelino avatar bard avatar border-radius avatar chlins avatar christian-fei avatar daidoujichen avatar dependabot-preview[bot] avatar dependabot[bot] avatar frontmage avatar johnlunney avatar kevingimbel avatar kuaima avatar matbesancon avatar metrue avatar muka avatar mvrilo avatar polyrabbit avatar pplam avatar russtopia avatar siddhesh avatar steventhanna avatar testwill avatar viktorbarzin avatar xwjdsh avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

fx's Issues

Binary files should not be included in the repo

Binary files should be provided by github release

When I git clone this repo, I found out the binary file build/fx is included in the git, which cost a lot of time to finish the clone.

Besides, after I clone it, I cannot run it, because architecture doesn't comply my system:

# file build/fx
build/fx: Mach-O 64-bit x86_64 executable

I suggest this binary file should be excluded from the repo, add this line for .gitignore

build/

And tell git to forget this file:

git rm --cached build/fx

Update README for a quicker clone:

git clone --depth 1 https://github.com/metrue/fx

images/go missing fx.go?

I just see an app.go file which seems to use symbols not defined there (Input, Fx), is the fx.go file missing?

a better dependency management

Golang package management is kinda quirky for me, I am using glide, but it seems like I am not doing it right.

@avelino Could you help take a look at my Makefile, I am doing a lot manually jobs there.

Add gRPC / HTTP+JSON endpoint support

I would like to propose to use a gRPC based service to offer intercommunication between CLI and server.
It supports also HTTP+JSON with a proxy extension.

Added benefits are the ease of generating swagger based docs, muti-lanuage SDK client generation and would also make the code a bit simpler (most of the network exchange and serialization is managed by gRPC / protobuf libraries).

With a bit of refactoring, the logic can be made reusable and this may provide benefit also on test coverage and code reusability

I am working on a PoC for validation, if it works well I would propose a PR for evaluation

dial tcp [::1]:8080: getsockopt: connection refused

after start fx server by

$ brew tap metrue/homebrew-fx && brew install fx
$ sudo fx server start

everything works well, but when I enter fx list, I get

➜ $ fx list
dial tcp [::1]:8080: getsockopt: connection refused

Coverage fails on CircleCI environment

#!/bin/bash -eo pipefail
./bin/coverage.sh
bash <(curl -s https://codecov.io/bash) -t ${CODECOV_TOKEN}
ok  	github.com/metrue/fx/image	1.028s	coverage: 90.5% of statements
2017/12/16 21:06:29 build linux
Step 1/5 : FROM metrue/fx-node-base
--- FAIL: TestList (20.01s)
	list_test.go:74: Up failed: rpc error: code = Unavailable desc = transport is closing
FAIL
coverage: 42.1% of statements
FAIL	github.com/metrue/fx/api/service	20.247s
Exited with code 1

make build gives some warning

make build
go generate ./api/fx.go
gen.sh: 3: gen.sh: **Bad substitution**
go build -o ./build/fx fx.go
$ uname -a
Linux ubuntu 4.9.50-x86_64-linode86 #1 SMP Thu Sep 14 19:28:20 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux

faster deployment

here is the idea:
fx can docker pull the base images of all the supported language first background, then deploy should be faster than ever.

Thinking about the message/output again

We should re-think the message delivered to user during fx using.

  • fx up

if everything ok, message should be ____
if error happens, message should be ____

  • fx down

if everything ok, message should be ____
if error happens, message should be ____

  • fx list

if everything ok, message should be ____
if error happens, message should be ____

fx up to remote host directly

  • ~/.fx/config
    fx should be read config ~/.fx/config
  • fx up support remote deploy
    * fx up # default deploy to localhost
    * fx up -host up # deploy to target host if fx agent exist in target agent.

add Julia support

I'm trying to come up with a Julia implementation, this can make fx pretty useful for scientists.

The first steps seem fine, HttpParser.jl seems to fail to build on the docker image. Once this is fixed, the Julia integration can go further

Error in JS example

In the readme, please add 's' to example in fx up ./example/functions/func.js.

It still doesn't work after that change:

image

fx down '*' does not work

fx donw '*' to down alll deployed functions does not work, I think we have not handle this request well now.

Provision tool

fx should be able to run on Linux, Mac, Windows which have docker running on now. so if there is a tool to make docker environment ready on Linux, Mac, Windows.

api/google/ and gitignore

With commit 5b23349 the makefile was enhanced to clone the google apis. These files will be visible in git status. Is there an entry in gitignore missing?

Error go-getting the project: dependency

The way dependencies are handled seem to cause conflict.

The versions of github.com/docker/go-connections/nat used in the project and in the docker/docker packages seem to conflict.

$ go get github.com/metrue/fx    
# github.com/metrue/fx/server/docker-api
go/src/github.com/metrue/fx/server/docker-api/api.go:61:15: cannot use "github.com/docker/go-connections/nat".PortSet literal (type "github.com/docker/go-connections/nat".PortSet) as type "github.com/docker/docker/vendor/github.com/docker/go-connections/nat".PortSet in field value
go/src/github.com/metrue/fx/server/docker-api/api.go:66:15: cannot use "github.com/docker/go-connections/nat".PortMap literal (type "github.com/docker/go-connections/nat".PortMap) as type "github.com/docker/docker/vendor/github.com/docker/go-connections/nat".PortMap in field value

Error management

Errors could be documented a bit further and bubble up the stacktrace instead of panicking. All potentially-failing functions should return an error.
See github.com/pkg/errors

Add LICENSE

Choose a licence and add it to the project

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.