Reed Allman 5a77e2633e Merge branch 'fix-startup-output' into 'master'
Fixes scary output on docker startup.

Closes #26

See merge request !55
2017-06-15 15:48:34 -07:00
2017-06-15 15:48:34 -07:00
2017-06-08 11:46:56 -07:00
2017-06-15 15:48:34 -07:00
2017-06-06 14:12:50 -07:00
2017-05-15 14:04:01 -07:00
2017-05-18 18:59:34 +00:00
2017-05-15 12:00:43 -07:00
2017-05-18 18:59:34 +00:00
2017-06-09 13:42:59 -07:00
2017-06-06 16:45:45 -07:00
2017-06-08 11:46:56 -07:00
2017-05-18 18:59:34 +00:00
2017-05-29 17:10:47 -07:00
2017-06-15 15:48:34 -07:00
2017-06-09 13:42:59 -07:00
2017-06-14 12:50:23 -07:00

Oracle Functions build status

Oracle Functions is an event-driven, open source, functions-as-a-service compute platform that you can run anywhere. Some of it's key features:

Prequisites

  • Docker 17.05 or later installed and running
  • Logged into Docker Hub (docker login)

Usage

Installation (if running locally)

NOTE: The following instructions apply while the project is a private repo. This will build the Functions server and the CLI tool directly from the repo instead of using pre-built containers. Once the project is public, these steps will be unnecessary.

# Build and Install CLI tool
cd fn
make dep # just once
make install

# Build and Run Functions Server
cd ..
make dep # just once
make run # will build as well

Installation (if using internal alpha service)

Set your system to point to the internal service on BMC:

export API_URL=http://129.146.10.253:80

Download the pre-built CLI binary:

  1. Visit: https://gitlab-odx.oracle.com/odx/functions/tree/master/fn/releases/download/0.3.2
  2. Download the CLI for your platform
  3. Put in /usr/local/bin
  4. chmod +x

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.

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. Currently the function must be named func.your_language_extention (ie func.go, func.js, etc.)

package main

import (
	"fmt"
)

func main() {
	fmt.Println("Hello from Oracle Functions!")
}

Now run the following CLI commands:

# Initialize your function
# This detects your runtime from the code above and creates a func.yaml
fn init <DOCKERHUB_USERNAME>/hello

# Test your function
# This will run inside a container exactly how it will on the server
fn run

# Deploy your functions to the Oracle Functions server (default localhost:8080)
# This will create a route to your function as well
fn deploy myapp

Now you can call your function:

curl http://localhost:8080/r/myapp/hello

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

That's it! You just deployed your first function and called it. Now to update your function you can update your code and run fn deploy myapp again.

To Learn More

Get Involved

User Interface

This is the graphical user interface for Oracle Functions. It is currently not buildable.

docker run --rm -it --link functions:api -p 4000:4000 -e "API_URL=http://api:8080" treeder/functions-ui

For more information, see: https://github.com/treeder/functions-ui

Next up

Check out the Tutorial Series.

It will demonstrate some of Oracle Functions capabilities through a series of exmaples. We'll try to show examples in most major languages. This is a great place to start!

Description
The container native, cloud agnostic serverless platform.
Readme Apache-2.0 170 MiB
Languages
Go 97.4%
Shell 1.2%
Ruby 0.5%
Makefile 0.4%
Dockerfile 0.4%
Other 0.1%