fx
Poor man's function as a service.
<br/>
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 root@123.11.2.3 --agents 'root@1.1.1.1,root@2.2.2.2'
Contributors
Thank you to all the people who already contributed to fx!
<table> <tbody> <tr> <a href="https://github.com/metrue" target="_blank"> <img alt="metrue" src="https://avatars2.githubusercontent.com/u/1001246?v=4&s=50" width="50"> </a> <a href="https://github.com/muka" target="_blank"> <img alt="muka" src="https://avatars2.githubusercontent.com/u/1021269?v=4&s=50" width="50"> </a> <a href="https://github.com/pplam" target="_blank"> <img alt="pplam" src="https://avatars2.githubusercontent.com/u/12783579?v=4&s=50" width="50"> </a> <a href="https://github.com/matbesancon" target="_blank"> <img alt="mbesancon" src="https://avatars2.githubusercontent.com/u/7623090?s=60&v=4" width="50"> </a> <a href="https://github.com/chlins" target="_blank"> <img alt="chlins" src="https://avatars2.githubusercontent.com/u/31262637?v=4&s=50" width="50"> </a> <a href="https://github.com/xwjdsh" target="_blank"> <img alt="xwjdsh" src="https://avatars2.githubusercontent.com/u/11025519?v=4&s=50" width="50"> </a> <a href="https://github.com/DaidoujiChen" target="_blank"> <img alt="DaidoujiChen" src="https://avatars0.githubusercontent.com/u/670441?v=4&s=50" width="50"> </a> <a href="https://github.com/avelino" target="_blank"> <img alt="avelino" src="https://avatars2.githubusercontent.com/u/31996?v=4&s=50" width="50"> </a> <a href="https://github.com/andre2007" target="_blank"> <img alt="andre2007" src="https://avatars1.githubusercontent.com/u/1451047?s=50&v=4" width="50"> </a> <a href="https://github.com/polyrabbit" target="_blank"> <img alt="polyrabbit" src="https://avatars0.githubusercontent.com/u/2657334?s=60&v=4" width="50"> </a> <a href="https://github.com/johnlunney" target="_blank"> <img alt="johnlunney" src="https://avatars3.githubusercontent.com/u/536947?s=60&v=4" width="50"> </a> <a href="https://github.com/tbrand" target="_blank"> <img alt="tbrand" src="https://avatars0.githubusercontent.com/u/3483230?s=60&v=4" width="50"> </a> <a href="https://github.com/steventhanna" target="_blank"> <img alt="andre2007" src="https://avatars1.githubusercontent.com/u/2541678?s=50&v=4" width="50"> </a> <a href="https://github.com/border-radius" target="_blank"> <img alt="border-radius" src="https://avatars0.githubusercontent.com/u/3204785?s=60&v=4" width="50"> </a> <a href="https://github.com/Russtopia" target="_blank"> <img alt="Russtopia" src="https://avatars1.githubusercontent.com/u/2966177?s=60&v=4<Paste>" width="50"> </a> <a href="https://github.com/FrontMage" target="_blank"> <img alt="FrontMage" src="https://avatars2.githubusercontent.com/u/17007026?s=60&v=4" width="50"> </a> <a href="https://github.com/DropNib" target="_blank"> <img alt="DropNib" src="https://avatars0.githubusercontent.com/u/32019589?s=60&v=4" width="50"> </a> </tr>编辑推荐精选
SimilarWeb流量提升
稳定高效的流量提升解决方案，助力品牌曝光
稳定高效的流量提升解决方案，助力品牌曝光
Sora2视频免费生成
最新版Sora2模型免费使用，一键生成无水印视频
最新版Sora2模型免费使用，一键生成无水印视频
Transly
实时语音翻译/同声传译工具
Transly是一个 多场景的AI大语言模型驱动的同声传译、专业翻译助手，它拥有超精准的音频识别翻译能力，几乎零延迟的使用体验和支持多国语言可以让你带它走遍全球，无论你是留学生、商务人士、韩剧美剧爱好者，还是出国游玩、多国会议、跨国追星等等，都可以满足你所有需要同传的场景需求，线上线下通用，扫除语言障碍，让全世界的语言交流不再有国界。
讯飞绘文
选题、配图、成文，一站式创作，让内容运营更高效
讯飞绘文，一个AI集成平台，支持写作、选题、配图、排版和发布。高效生成适用于各类媒体的定制内容，加速品牌传播，提升内容营销效果。
TRAE编程
AI辅助编程，代码自动修复
Trae是一种自适应的集成开发环境（IDE），通过自动 化和多元协作改变开发流程。利用Trae，团队能够更快速、精确地编写和部署代码，从而提高编程效率和项目交付速度。Trae具备上下文感知和代码自动完成功能，是提升开发效率的理想工具。
商汤小浣熊
最强AI数据分析助手
小浣熊家族Raccoon，您的AI智能助手，致力于通过先进的人工智能技术，为用户提供高效、便捷的智能服务。无论是日常咨询还是专业问题解答，小浣熊都能以快速、准确的响应满足您的需求，让您的生活更加智能便捷。
imini AI
像人一样思考的AI智能体
imini 是一款超级AI智能体，能根据人类指令，自主思考、自主完成、并且交付结果的AI智能体。
Keevx
AI数字人视频创作平台
Keevx 一款开箱即用的AI数字人视频创作平台，广泛适用于电商广告、企业培训与社媒宣传，让全球企业与个人创作者无需拍摄剪辑，就能快速生成多语言、高质量的专业视频。
即梦AI
一站式AI创作平台
提供 AI 驱动的图片、视频生成及数字人等功能，助力创意创作
扣子-AI办公
AI办公助手，复杂任务高效处理
AI办公助手，复杂任务高效处理。办公效率低？扣子空间AI助手支持播客生成、PPT制作、网页开发及报告写作，覆盖科研、商业、舆情等领域的专家Agent 7x24小时响应，生活工作无缝切换，提升50%效率！
推荐工具精选
AI云服务特惠
懂AI专属折扣关注微信公众号
最新AI工具、AI资讯
独家AI资源、AI项目落地
微信扫一扫关注公众号