update all hello examples to use /{language} as the default route instead of /hello, also renamed hello.payload.json to sample.payload.json

This commit is contained in:
Chad Arimura
2017-06-05 14:07:44 -07:00
parent 17bbef04f5
commit d72343a697
10 changed files with 37 additions and 71 deletions

View File

@@ -6,13 +6,13 @@ This example will show you how to test and deploy Go (Golang) code to Oracle Fun
```sh
# Initialize your function creating a func.yaml file
fn init <DOCKERHUB_USERNAME>/hello
fn init <DOCKERHUB_USERNAME>/go
# Test your function. This will run inside a container exactly how it will on the server
fn run
# Now try with an input
cat hello.payload.json | fn run
cat sample.payload.json | fn run
# Deploy your functions to the Oracle Functions server (default localhost:8080)
# This will create a route to your function as well
@@ -21,15 +21,15 @@ fn deploy myapp
### Now call your function:
```sh
curl http://localhost:8080/r/myapp/hello
curl http://localhost:8080/r/myapp/go
```
Or call from a browser: [http://localhost:8080/r/myapp/hello](http://localhost:8080/r/myapp/hello)
Or call from a browser: [http://localhost:8080/r/myapp/go](http://localhost:8080/r/myapp/go)
And now with the JSON input:
```sh
curl -H "Content-Type: application/json" -X POST -d @hello.payload.json http://localhost:8080/r/myapp/hello
curl -H "Content-Type: application/json" -X POST -d @sample.payload.json http://localhost:8080/r/myapp/go
```
That's it!
@@ -42,7 +42,7 @@ In Go, simply put them all in the `vendor/` directory.
1. We piped JSON data into the function at the command line
```sh
cat hello.payload.json | fn run
cat sample.payload.json | fn run
```
2. We received our function input through **stdin**

View File

@@ -6,14 +6,14 @@ This example will show you how to test and deploy Node code to Oracle Functions.
```sh
# Initialize your function creating a func.yaml file
fn init <DOCKERHUB_USERNAME>/hello
fn init <DOCKERHUB_USERNAME>/node
# Test your function.
# This will run inside a container exactly how it will on the server. It will also install and vendor dependencies from Gemfile
fn run
# Now try with an input
cat hello.payload.json | fn run
cat sample.payload.json | fn run
# Deploy your functions to the Oracle Functions server (default localhost:8080)
# This will create a route to your function as well
@@ -22,15 +22,15 @@ fn deploy myapp
### Now call your function:
```sh
curl http://localhost:8080/r/myapp/hello
curl http://localhost:8080/r/myapp/node
```
Or call from a browser: [http://localhost:8080/r/myapp/hello](http://localhost:8080/r/myapp/hello)
Or call from a browser: [http://localhost:8080/r/myapp/node](http://localhost:8080/r/myapp/node)
And now with the JSON input:
```sh
curl -H "Content-Type: application/json" -X POST -d @hello.payload.json http://localhost:8080/r/myapp/hello
curl -H "Content-Type: application/json" -X POST -d @sample.payload.json http://localhost:8080/r/myapp/node
```
That's it! Our `fn deploy` packaged our function and sent it to the Oracle Functions server. Try editing `func.js`
@@ -38,15 +38,8 @@ and then doing another `fn deploy`.
### Note on Dependencies
Create a [package.json](https://docs.npmjs.com/getting-started/using-a-package.json) file in your functions directory.
Run:
```sh
docker run --rm -v "$PWD":/function -w /function funcy/node:dev npm install
```
Then everything should work.
Create a [package.json](https://docs.npmjs.com/getting-started/using-a-package.json) file in your functions directory. The CLI should pick that up and build in all
your dependencies on `fn run` and `fn deploy`.
For example, using the `package.json` file in this directory which includes the [request](https://www.npmjs.com/package/request) package, you can add this to func.js and it will work:
@@ -64,7 +57,7 @@ request('http://www.google.com', function (error, response, body) {
1. We piped JSON data into the function at the command line
```sh
cat hello.payload.json | fn run
cat sample.payload.json | fn run
```
2. We received our function input through **stdin**

View File

@@ -6,14 +6,14 @@ This example will show you how to test and deploy PHP code to Oracle Functions.
```sh
# Initialize your function creating a func.yaml file
fn init <DOCKERHUB_USERNAME>/hello
fn init <DOCKERHUB_USERNAME>/php
# Test your function.
# This will run inside a container exactly how it will on the server. It will also install and vendor dependencies from Gemfile
fn run
# Now try with an input
cat hello.payload.json | fn run
cat sample.payload.json | fn run
# Deploy your functions to the Oracle Functions server (default localhost:8080)
# This will create a route to your function as well
@@ -22,15 +22,15 @@ fn deploy myapp
### Now call your function:
```sh
curl http://localhost:8080/r/myapp/hello
curl http://localhost:8080/r/myapp/php
```
Or call from a browser: [http://localhost:8080/r/myapp/hello](http://localhost:8080/r/myapp/hello)
Or call from a browser: [http://localhost:8080/r/myapp/php](http://localhost:8080/r/myapp/php)
And now with the JSON input:
```sh
curl -H "Content-Type: application/json" -X POST -d @hello.payload.json http://localhost:8080/r/myapp/hello
curl -H "Content-Type: application/json" -X POST -d @sample.payload.json http://localhost:8080/r/myapp/php
```
That's it! Our `fn deploy` packaged our function and sent it to the Oracle Functions server. Try editing `func.php`
@@ -40,10 +40,6 @@ and then doing another `fn deploy`.
In PHP, you can create a [composer](https://getcomposer.org/) file in your function directory, then run:
```sh
fn build
```
This will rebuild your gems and vendor them. PHP doesn't pick them up automatically, so you'll have to add this to the top of your `func.php` file:
```php
@@ -53,21 +49,11 @@ require 'vendor/autoload.php';
Open `func.php` to see it in action.
### 3. Queue jobs for your function
Now you can start jobs on your function. Let's quickly queue up a job to try it out.
```sh
cat hello.payload.json | fn call phpapp /hello
```
# In Review
1. We piped JSON data into the function at the command line
```sh
cat hello.payload.json | fn run
cat sample.payload.json | fn run
```
2. We received our function input through **stdin**

View File

@@ -6,14 +6,14 @@ This example will show you how to test and deploy Python code to Oracle Function
```sh
# Initialize your function creating a func.yaml file
fn init <DOCKERHUB_USERNAME>/hello
fn init <DOCKERHUB_USERNAME>/python
# Test your function.
# This will run inside a container exactly how it will on the server. It will also install and vendor dependencies from Gemfile
fn run
# Now try with an input
cat hello.payload.json | fn run
cat sample.payload.json | fn run
# Deploy your functions to the Oracle Functions server (default localhost:8080)
# This will create a route to your function as well
@@ -22,15 +22,15 @@ fn deploy myapp
### Now call your function:
```sh
curl http://localhost:8080/r/myapp/hello
curl http://localhost:8080/r/myapp/python
```
Or call from a browser: [http://localhost:8080/r/myapp/hello](http://localhost:8080/r/myapp/hello)
Or call from a browser: [http://localhost:8080/r/myapp/python](http://localhost:8080/r/myapp/python)
And now with the JSON input:
```sh
curl -H "Content-Type: application/json" -X POST -d @hello.payload.json http://localhost:8080/r/myapp/hello
curl -H "Content-Type: application/json" -X POST -d @sample.payload.json http://localhost:8080/r/myapp/python
```
That's it! Our `fn deploy` packaged our function and sent it to the Oracle Functions server. Try editing `func.py`
@@ -44,7 +44,7 @@ In Python, we create a [requirements](https://pip.pypa.io/en/stable/user_guide/)
1. We piped JSON data into the function at the command line
```sh
cat hello.payload.json | fn run
cat sample.payload.json | fn run
```
2. We received our function input through **stdin**

View File

@@ -6,14 +6,14 @@ This example will show you how to test and deploy Ruby code to Oracle Functions.
```sh
# Initialize your function creating a func.yaml file
fn init <DOCKERHUB_USERNAME>/hello
fn init <DOCKERHUB_USERNAME>/ruby
# Test your function.
# This will run inside a container exactly how it will on the server. It will also install and vendor dependencies from Gemfile
fn run
# Now try with an input
cat hello.payload.json | fn run
cat sample.payload.json | fn run
# Deploy your functions to the Oracle Functions server (default localhost:8080)
# This will create a route to your function as well
@@ -22,15 +22,15 @@ fn deploy myapp
### Now call your function:
```sh
curl http://localhost:8080/r/myapp/hello
curl http://localhost:8080/r/myapp/ruby
```
Or call from a browser: [http://localhost:8080/r/myapp/hello](http://localhost:8080/r/myapp/hello)
Or call from a browser: [http://localhost:8080/r/myapp/ruby](http://localhost:8080/r/myapp/ruby)
And now with the JSON input:
```sh
curl -H "Content-Type: application/json" -X POST -d @hello.payload.json http://localhost:8080/r/myapp/hello
curl -H "Content-Type: application/json" -X POST -d @sample.payload.json http://localhost:8080/r/myapp/ruby
```
That's it! Our `fn deploy` packaged our function and sent it to the Oracle Functions server. Try editing `func.rb`
@@ -39,13 +39,10 @@ and then doing another `fn deploy`.
### Note on Dependencies
In Ruby, we create a [Gemfile](http://bundler.io/gemfile.html) file in your function directory, then run:
In Ruby, we create a [Gemfile](http://bundler.io/gemfile.html) file in your function directory. Then any `fn run`
or `fn deploy` will rebuild your gems and vendor them.
```sh
fn build
```
This will rebuild your gems and vendor them. Ruby doesn't pick up the gems automatically, so you'll have to add this to the top of your `func.rb` file:
Note: Ruby doesn't pick up the gems automatically, so you'll have to add this to the top of your `func.rb` file:
```ruby
require_relative 'bundle/bundler/setup'
@@ -53,21 +50,11 @@ require_relative 'bundle/bundler/setup'
Open `func.rb` to see it in action.
To update dependencies:
```sh
# Let's run bundle update
docker run --rm -it -v ${PWD}:/worker -w /worker funcy/ruby:dev bundle update
# Then bundle install again to vendor them
docker run --rm -it -v ${PWD}:/worker -w /worker funcy/ruby:dev bundle install --standalone --clean
```
# In Review
1. We piped JSON data into the function at the command line
```sh
cat hello.payload.json | fn run
cat sample.payload.json | fn run
```
2. We received our function input through **stdin**