README
¶
Quickstart | Tutorials | Docs | API | Operating | Flow | UI
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
- 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.
# Deploy your functions to your local Fn server
fn deploy --app myapp --local
Now you can call your function:
fn invoke 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
- Visit Fn tutorials for step by step guides to creating apps with Fn . These tutorials range from introductory to more advanced.
- See our full documentation
- View our YouTube Channel
- View our API Docs
- Check out our sub-projects: Flow, UI, FnLB
- For a full presentation with lots of content you can use in your own presentations, see The Fn Project Presentation Master
Get Help
- Ask your question on StackOverflow and tag it with
fn
Get Involved
- Join our Slack Community
- See our new Community Page
- Learn how to contribute
- See issues for issues you can help with
- Join us at one of our Fn Events or even speak at one!
Stay Informed
Directories
¶
| Path | Synopsis |
|---|---|
|
agent
Package agent defines the Agent interface and related concepts.
|
Package agent defines the Agent interface and related concepts. |
|
agent/drivers
Package drivers is intended as a general purpose container abstraction library.
|
Package drivers is intended as a general purpose container abstraction library. |
|
agent/drivers/docker
Package docker provides a Docker driver for Fn.
|
Package docker provides a Docker driver for Fn. |
|
agent/drivers/mock
Package mock provides a fake Driver implementation that is only used for testing.
|
Package mock provides a fake Driver implementation that is only used for testing. |
|
datastore/sql/dbhelper
Package dbhelper wraps SQL and specific capabilities of an SQL db
|
Package dbhelper wraps SQL and specific capabilities of an SQL db |
|
logs/s3
Package s3 implements an s3 api compatible log store
|
Package s3 implements an s3 api compatible log store |
|
runnerpool
The consistent hash ring from the original fnlb.
|
The consistent hash ring from the original fnlb. |
|
server/defaultexts
Package defaultexts are the extensions that are auto-loaded in to the default fnserver binary included here as a package to simplify inclusion in testing
|
Package defaultexts are the extensions that are auto-loaded in to the default fnserver binary included here as a package to simplify inclusion in testing |
|
cmd
|
|
|
examples
|
|
|
images
|
|