Skip to content
The container native, cloud agnostic serverless platform.
Branch: master
Clone or download
CI
Latest commit 695bfbc Mar 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
.github
api fnserver: 0.3.675 release [skip ci] Mar 15, 2019
clients
cmd/fnserver fn: add stats for image cleaner and driver instance id (#1375) Jan 15, 2019
docs Make syslog-url nullable in the swagger so it can be explicitly set t… Dec 10, 2018
examples MISC Remove php example since it is unsupported and not working (#1360) Jan 9, 2019
fnext
grpcutil
images Prevent in-built docker VOLUME commands (#1378) Feb 5, 2019
noop
test fn: docker pull retry / backoff options (#1434) Mar 14, 2019
vendor update opencensus (#1416) Feb 22, 2019
.gitignore
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Dockerfile Moves main into cmd dir. (#977) May 9, 2018
LICENSE date change Jan 17, 2018
Makefile
README.md Move and expand community section in prep of first community call (#1425 Mar 6, 2019
THIRD_PARTY functions: performance improvements - LRU & singleflight DB calls (#322) Nov 21, 2016
build.ps1
changed-since-last.sh
go-fmt.sh fn: go-fmt needs to be more informative (#808) Mar 2, 2018
go.mod
go.sum add mod changes (#1417) Feb 22, 2019
helpers.sh fn: remove confusing parallelism in test scripts (#1079) Jun 20, 2018
licenses.sh
release.sh
system_test.sh
test.sh go modifyed (#1284) Nov 7, 2018

README.md

Fn Project

Quickstart  |  Tutorials  |  Docs  |  API  |  Operating  |  Flow  |  UI

CircleCI GoDoc Go Report Card

Welcome

Fn is an event-driven, open source, Functions-as-a-Service (FaaS) compute platform that you can run anywhere. Some of its key features:

  • Open Source
  • Native Docker: use any Docker container as your Function
  • Supports all languages
  • Run anywhere
    • Public, private and hybrid cloud
    • Import Lambda functions and run them anywhere
  • Easy to use for developers
  • Easy to manage for operators
  • Written in Go
  • Simple yet powerful extensibility

The fastest way to experience Fn is to follow the quickstart below, or you can jump right to our full documentation, API Docs, or hit us up in our Slack Community or Community Page!

Quickstart

Pre-requisites

  • Docker 17.10.0-ce or later installed and running
  • Docker Hub account (or other Docker-compliant registry) (Not required for local development)
  • Logged into Registry: ie docker login (Not required for local development)

Install CLI tool

The command line tool isn't required, but it makes things a lot easier. There are a few options to install it:

Option 1. Homebrew - macOS

If you're on a Mac and use Homebrew:

brew install fn

Option 2. Shell script - Linux and macOS

This one works on Linux and macOS (partially on Windows).

If you are running behind a proxy first set your http_proxy and https_proxy environment vars:

curl -LSs https://raw.githubusercontent.com/fnproject/cli/master/install | sh

This will download a shell script and execute it. If the script asks for a password, that is because it invokes sudo.

Option 3. Download the bin - Linux, macOS and Windows

Head over to our releases and download it.

Run Fn Server

First, start up an Fn server locally:

fn start

This will start Fn in single server mode, using an embedded database and message queue. You can find all the configuration options here. If you are on Windows, check here. If you are on a Linux system where the SELinux security policy is set to "Enforcing", such as Oracle Linux 7, check here.

Your First Function

Functions are small but powerful blocks of code that generally do one simple thing. Forget about monoliths when using functions, just focus on the task that you want the function to perform. Our CLI tool will help you get started quickly.

Let's create your function. You can use any runtime (ie go, node, java, python, etc.) hello will be the name of your function as well as create a directory called hello. You can name your function anything.

fn init --runtime go hello
cd hello

We need to create an "app" which acts as a top-level collection of functions and other elements:

fn create app myapp

Deploy your function:

fn deploy --app myapp --local

Note: --local flag will skip the push to remote container registry making local development faster

Now let's actually run your function using the invoke command:

fn invoke myapp hello

That's it! You just deployed and ran your first function! Try updating the function code in func.go (or .js, .java, etc.) then deploy it again to see the change.

Learn More

Get Help

Get Involved

Stay Informed

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.