29fdbc9b49
* disable pure runner logging there's a racey bug where the logger is being written to when it's closing, but this led to figuring out that we don't need the logger at all in pure runner really, the syslog thing isn't an in process fn thing and we don't need the logs from attach for anything further in pure runner. so this disables the logger at the docker level, to save sending the bytes back over the wire, this could be a nice little performance bump too. of course, with this, it means agents can be configured to not log debug or have logs to store at all, and not a lot of guards have been put on this for 'full' agent mode while it hangs on a cross feeling the breeze awaiting its demise - the default configuration remains the same, and no behavior changes in 'full' agent are here. it was a lot smoother to make the noop than to try to plumb in 'nil' for stdout/stderr, this has a lot lower risk of nil panic issues for the same effect, though it's not perfect relying on type casting, plumbing in an interface to check has the same issues (loss of interface adherence for any decorator), so this seems ok. defaulting to not having a logger was similarly painful, and ended up with this. but open to ideas. * replace usage of old null reader writer impl * make Read return io.EOF for io.Copy usage
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!