Create new functions¶
The OpenFaaS CLI has a template engine built-in which can create new functions in a given programming language. The way this works is by reading a list of templates from the
./template location in your current working folder.
Before creating a new function make sure you pull in the official OpenFaaS language templates from GitHub via the templates repository.
$ faas-cli template pull
This page shows how to generate functions in three of the most common languages and explains how to manage their dependencies.
To create a new function named
go-fn in Go type in the following:
$ faas-cli new go-fn --lang go
You will now see two files generate:
go-fn.yml ./go-fn/ ./go-fn/handler.go
You can now edit
handler.go and use the
deploy your function.
1.1 Go: dependencies¶
Dependencies should be managed with a Go vendoring tool such as dep.
- Get dep
$ go get -u github.com/golang/dep/cmd/dep
- Initialise the dependencies
$ $GOPATH/bin/dep init
- Now vendor a library
Make sure you're in the
go-fn folder, now use
dep ensure -add and the name of the library you want. In this example we are vendoring the
github.com/cnf/structhash package for use in our function.
$ dep ensure -add github.com/cnf/structhash
- Reference the package from function
You can now edit your function and add an import statement in
To create a Python function named
pycon type in:
$ faas-cli new pycon --lang python3
pycon.yml pycon/handler.py pycon/requirements.txt
2.1 Python: dependencies¶
You should edit
pycon/requirements.txt and add any pip modules you want with each one on a new line, for instance
The primary Python template uses Alpine Linux as a runtime environment due to its minimal size, but if you need a Debian environment so that you can compile
numpy or other modules then read on to the next section.
2.2 Python: advanced dependencies¶
If you need to use pip modules that require compilation then you should try the python3-debian template then add your pip modules to the
$ faas-cli template pull https://github.com/openfaas-incubator/python3-debian $ faas-cli new numpy-function --lang python3-debian $ echo "numpy" > ./numpy-function/requirements.txt $ faas-build -f ./numpy-function.yml ... Step 11/17 : RUN pip install -r requirements.txt ---> Running in d0ff430a607e Collecting numpy (from -r requirements.txt (line 1)) Downloading https://files.pythonhosted.org/packages/6e/dc/92c0f670e7b986829fc92c4c0208edb9d72908149da38ecda50d816ea057/numpy-1.14.2-cp36-cp36m-manylinux1_x86_64.whl (12.2MB) Installing collected packages: numpy Successfully installed numpy-1.14.2 ...
Generate a function named
$ faas-cli new js-fn --lang node
./js-fn.yml ./js-fn/ ./js-fn/handler.js ./js-fn/package.json
3.1 Node.js dependencies¶
Node.js dependencies are managed with
npm and the
package.json file which was generated for you.
To add the
cheerio module type in:
cd js-fn npm i --save cheerio
You can now add a
require('cheerio') statement into your function and make use of this library.
4.0 Customise a template¶
It is recommended that you use the official templates as they are provided and if there is a short-coming that you raise a GitHub issue so we can improve the templates for everyone.
All templates are driven by a Dockerfile and can be customised by editing the files found in the ./template folder.
4.1 Update the Dockerfile¶
There are several reasons why you may want to update your Dockerfile, just edit
New base image - some companies prefer to use their own base images for Docker images for compliance, support or licensing reasons
Add native package - sometimes you may want to add a native package from the Alpine Linux repository or the Debian package repository - just add a step into the Dockerfile
Try a new version of a base-image - it may be that the project is showing support for Node.js LTS, but you want the cutting-edge version, you can do that too
4.2 Update a template's configuration¶
The name of a template is read from a "template.yml" file kept within the template folder:
csharp we have the following:
language: csharp fprocess: dotnet ./root.dll
languageis the display name used for
faas-cli new --list.
fprocessprovides the process to run for each invocation - i.e. your function
4.3 Use your own templates¶
You can use your own Git repository for a custom or forked set of templates. This can be public or private.
faas-cli template pull for more information.
5.0 ARM / Raspberry Pi¶
Templates for ARM and Raspberry Pi are provided on a best-effort basis. If you can help with maintenance please let the project contributors know.
- ARMv7 / Raspberry Pi
faas-cli new --list and look for any languages ending in
-armhf. You can use any of these for your functions.
- ARM64 / Packet.net / Scaleway ARM 64-bit
For these platforms do the same as above and look for the
It is easy to make your own templates so if you need to use this platform please convert one of the "regular" templates for your platform.