Fn is an event-driven, open source, functions-as-a-service compute platform that you can run anywhere. Some of it's key features:
- Write once
- Run anywhere
- Public, private and hybrid cloud
- Import functions directly from Lambda and run them wherever you want
- Easy to use for developers
- Easy to manage for operators
- Written in Go
- Simple yet powerful extensibility
Prequisites
- Docker 17.05 or later installed and running
- A Docker Hub account (Docker Hub)
- Log Docker into your Docker Hub account:
docker login
Quickstart
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 fn2. Shell script
This one works on Linux and MacOS (partially on Windows):
curl -LSs https://raw.githubusercontent.com/fnproject/cli/master/install | shThis 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
Head over to our releases and download it.
Run Fn Server
Now fire up an Fn server:
fn startThis 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.
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.
First, create an empty directory called hello and cd into it.
The following is a simple Go program that outputs a string to STDOUT. Copy and paste the code below into a file called func.go.
package main
import (
"fmt"
)
func main() {
fmt.Println("Hello from Fn!")
}Now run the following CLI commands:
# Initialize your function
# This detects your runtime from the code above and creates a func.yaml
fn init
# Set your Docker Hub username
export FN_REGISTRY=<DOCKERHUB_USERNAME>
# Test your function
# This will run inside a container exactly how it will on the server
fn run
# Deploy your functions to the Fn server (default localhost:8080)
# This will create a route to your function as well
fn deploy --app myappNow you can call your function:
curl http://localhost:8080/r/myapp/hello
# or:
fn call myapp /helloOr in a browser: http://localhost:8080/r/myapp/hello
That's it! You just deployed your first function and called it. To update your function you can update your code and run fn deploy myapp again.
To Learn More
- Visit our Functions Tutorial Series
- See our full documentation
- View all of our examples
- You can also write your functions in AWS Lambda format
Get Help
- Ask your question on StackOverflow and tag it with
fn - Join our Slack Community
Stay Informed
Get Involved
- Join our Slack Community
- Learn how to contribute
- See milestones for detailed issues
User Interface
Check out this graphical user interface for Fn.
docker run --rm -it --link functions:api -p 4000:4000 -e "API_URL=http://api:8080" fnproject/uiFor more information, see: github.com/fnproject/u…
Next up
Check out the Tutorial Series
This tutorial will demonstrate some of the core Fn capabilities through a series of examples. We'll try to show examples in most major languages. This is a great Fn place to start!
