96aa2a67ae
code is feature complete in the general sense, with minor TODO left. this is just a patch with 'migratex' and does not use it for fn's migrations yet, would like to get feedback prior to doing that. presenting: A migration library loosely based on pressly/goose and mattes/migrate design, that does migrations across a smattering of sql databases by only accepting a `*sqlx.DB`. why? * goose didn't support kindly allowing us to rebind transactions based on a given db to various dialects or offer oracle support * goose didn't support locking the db (maybe not needed with tx? it's late.. we may want to lock the whole db eventually?) * goose requires us to do semi-complex migration to it from mattes/migrate * mattes has stepped down as migrate maintainer and the project is in flux * mattes/migrate did not allow us to define migrations in go and rebind to different dialects, an issue since we need to insert ids in our own format and can't define this in sql * neither handled context plumbing and risked issues there for various reasons (deadlock, etc). * I think I'm forgetting 1 or 2 in the style of goose, this lets us define `*sqlx.Tx` up and down funcs in go code, but uses mattes' migration table so we don't need to migrate that and retains its lock behavior with added tx sugar and less errors. most importantly, this code is terse, leveraging sqlx to support a lot of sql dbs (unlike mattes) and we control this. there is one useful TODO to handle migrations failing at startup more gracefully, in prod stuff like that will be nice to have. open to discussion of putting in a separate library, the landscape of go sql migrators is... really something. TODO make test suite and test against sqlite3, pg, mysql [, oracledb] like we have for our own unit tests. I'm thinking it's faster to wire up through there and use our bevy of migrations?
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!
Quickstart
Pre-requisites
- Docker 17.06 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):
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
- With our Fn Getting Started Series, quickly create Fn Hello World applications in multiple languages. This is a great Fn place to start!
- 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 all of our examples
- 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 - Join our Slack Community
Get Involved
- Join our Slack Community
- Learn how to contribute
- See issues for issues you can help with