mirror of
https://github.com/fnproject/fn.git
synced 2022-10-28 21:29:17 +03:00
5b3971060b
* fnctl: improve UX for howto's * doc: go function howto * fnctl: show the progress of build calls * doc: php function howto * doc: fix Go HOWTO * doc: Node Functions HOWTO * doc: Python Functions HOWTO * doc: improve README files * doc: ccirello -> USERNAME * docs: fix Python example Used an idiomatic method (isatty) to decide whether stdin must be read or not. * doc: fix go example * fnctl: fix docker push output
40 lines
1.1 KiB
Markdown
40 lines
1.1 KiB
Markdown
## Quick Example for a NodeJS Function (4 minutes)
|
|
|
|
This example will show you how to test and deploy Go (Golang) code to IronFunctions.
|
|
|
|
### 1. Prepare the `functions.yaml` file:
|
|
|
|
At functions.yaml you will find:
|
|
```yml
|
|
app: nodeapp
|
|
route: /hello
|
|
image: USERNAME/hello:0.0.1
|
|
build:
|
|
- docker run --rm -v "$PWD":/worker -w /worker iron/node:dev npm install
|
|
```
|
|
|
|
The important step here is to ensure you replace `USERNAME` with your Docker Hub account name. Some points of note:
|
|
the application name is `nodeapp` and the route for incoming requests is `/hello`. These informations are relevant for
|
|
the moment you try to test this function.
|
|
|
|
### 2. Build:
|
|
|
|
```sh
|
|
fnctl publish
|
|
```
|
|
|
|
`-v` is optional, but it allows you to see how this function is being built.
|
|
|
|
### 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 | fnctl run nodeapp /hello
|
|
```
|
|
|
|
Here's a curl example to show how easy it is to do in any language:
|
|
|
|
```sh
|
|
curl -H "Content-Type: application/json" -X POST -d @hello.payload.json http://localhost:8080/r/nodeapp/hello
|
|
``` |