Go Shell Other
Switch branches/tags
Clone or download
CI
Latest commit 8e37300 Jul 17, 2018
Permalink
Failed to load latest commit information.
.circleci fn: remove confusing parallelism in test scripts (#1079) Jun 20, 2018
.github pull request template (#1069) Jun 20, 2018
api fnserver: 0.3.510 release [skip ci] Jul 17, 2018
clients Ship call logs to the user as text/plain instead of JSON (#615) Jan 2, 2018
cmd/fnserver Adding a way to inject a request ID (#1046) Jun 14, 2018
docs Fixlinks to func-file.md (#1122) Jul 16, 2018
examples server, examples, extensions lint compliant (#1109) Jul 4, 2018
fnext server, examples, extensions lint compliant (#1109) Jul 4, 2018
grpcutil Adding a way to inject a request ID (#1046) Jun 14, 2018
images fn: runner status and docker load images (#1116) Jul 12, 2018
test fn: runner status and docker load images (#1116) Jul 12, 2018
vendor Bye bye openapi (#1081) Jun 21, 2018
.gitignore Use alpine images to make tests take less time (#629) Jan 2, 2018
CHANGELOG.md date change Jan 17, 2018
CONTRIBUTING.md fn: update fn dependencies for go 1.10 (#856) Mar 14, 2018
Dockerfile Moves main into cmd dir. (#977) May 9, 2018
Gopkg.lock Bye bye openapi (#1081) Jun 21, 2018
Gopkg.toml Bye bye openapi (#1081) Jun 21, 2018
LICENSE date change Jan 17, 2018
Makefile fn: runner status and docker load images (#1116) Jul 12, 2018
README.md Note on Shell script about proxy (#1108) Jul 3, 2018
THIRD_PARTY functions: performance improvements - LRU & singleflight DB calls (#322) Nov 21, 2016
build.ps1 Moves main into cmd dir. (#977) May 9, 2018
changed-since-last.sh Selective releasing (#708) Feb 1, 2018
docker-compose.yml fn: docker compose fixups (#985) May 10, 2018
go-fmt.sh fn: go-fmt needs to be more informative (#808) Mar 2, 2018
helpers.sh fn: remove confusing parallelism in test scripts (#1079) Jun 20, 2018
licenses.sh license printing script works again (#676) Jan 11, 2018
release.sh fn: runner status and docker load images (#1116) Jul 12, 2018
system_test.sh fn: api-tests are decommissioned: cleanup Makefile (#1082) Jun 21, 2018
test.sh Add support for Function and Trigger domain objects (#1060) Jun 25, 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!

Quickstart

Pre-requisites

  • Docker 17.10.0-ce or later installed and running
  • A Docker Hub account (Docker Hub) (or other Docker-compliant registry)
  • Log Docker into your Docker Hub account: docker login

Install CLI tool

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

1. Homebrew - macOS

If you're on a Mac and use Homebrew, this one is for you:

brew install fn

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 environmental variables:

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.

3. Download the bin - Linux, macOS and Windows

Head over to our releases and download it.

Run Fn Server

Now fire up an Fn server:

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 super quickly.

Create hello world function:

fn init --runtime go hello

This will create a simple function in the directory hello, so let's cd into it:

cd hello

Feel free to check out the files it created or just keep going and look at it later.

# Set your Docker Hub username
export FN_REGISTRY=<DOCKERHUB_USERNAME>

# Run your function locally
fn run

# Deploy your functions to your local Fn server
fn deploy --app myapp --local

Now you can call your function:

curl http://localhost:8080/r/myapp/hello
# or:
fn call myapp /hello

Or in a browser: http://localhost:8080/r/myapp/hello

That's it! You just deployed your first function and called it. Try updating the function code in func.go then deploy it again to see the change.

Learn More

Get Help

Get Involved

Stay Informed