Deployment guide for Docker Swarm¶
Note: If you need to use
sudoto access the
dockerCLI then you should prefix this behind any shell scripts or CLIs used in this guide or any related tutorials.
1.0 Install the
You can install the OpenFaaS CLI using
brew or a
brew install faas-cli
$ curl -sL https://cli.openfaas.com | sudo sh
If you run the script as a normal non-root user then the script will be downloaded to the current folder.
1.1 Initialize Swarm Mode¶
You can create a single-host Docker Swarm on your laptop with a single command. You don't need any additional software to Docker 17.06 or greater. You can also run these commands on a Linux VM or cloud host.
This is how you initialize your master node:
$ docker swarm init
If you have more than one IP address you may need to pass a string like
--advertise-addr eth0 to this command.
Take a note of the join token
1.2 Join any workers you need¶
Log into your worker node and type in the output from
docker swarm init on the master. If you've lost this info then type in
docker swarm join-token worker and then enter that on the worker.
It's also important to pass the
--advertise-addr string to any hosts which have a public IP address.
Check whether you need to enable firewall rules for the Docker Swarm ports listed here.
2.0 Deploy the stack¶
Clone OpenFaaS and then checkout the latest stable release:
$ git clone https://github.com/openfaas/faas && \ cd faas && \ ./deploy_stack.sh
As of OpenFaaS 0.8.6 basic authentication will be enabled by default when running ./deploy_stack.sh. If you need to disable it pass the flag
--no-auth to the ./deploy_stack.sh script as above.
2.0.1 Raspberry Pi / 32-bit ARM¶
For a complete tutorial on setting up OpenFaaS for Raspberry Pi / 32-bit ARM using Docker Swarm see the following blog post from Alex Ellis: Your Serverless Raspberry Pi cluster with Docker.
If you are using Raspberry Pi or 32-bit ARM devices then please run the following instead:
$ git clone https://github.com/openfaas/faas && \ cd faas && \ ./deploy_stack.armhf.sh
When creating new functions please use the templates with a suffix of
-armhf such as
python-armhf to ensure you get the correct versions for your devices.
Note: you cannot deploy the sample functions to ARM devices, but you can use the function store in the gateway UI or via
faas-cli store list --yaml https://raw.githubusercontent.com/openfaas/store/master/store-armhf.json
2.1 Store your admin credentials¶
The default configuration will create a username and password combination for you:
Attempting to create credentials for gateway.. ... [Credentials] username: admin password: <some_hash_secret> echo -n <some_hash_secret> | faas-cli login --username=admin -- password-stdin
Run the command as you see it in your console, do not copy/paste the login command. Once you run
faas-cli login your password will be stored as a hash at
You will need the password for the CLI, UI and REST API on the gateway, but you can invoke your functions without it.
2.1 Test out the UI¶
Within a few seconds (or minutes if on a poor WiFi connection) the API gateway and associated OpenFaaS images will be pulled into your local Docker library and you will be able to access the UI at:
If you're running on Linux you may find that accessing
localhost times out. We recommend using an IPv4 address such as http://127.0.0.1:8080 to prevent any ambiguity.
2.2 Deploy functions from the OpenFaaS Function Store¶
You can find many different sample functions from the community through the OpenFaaS Function Store. The Function Store is built into the UI portal and also available via the CLI.
To search the store:
$ faas-cli store list
$ faas-cli store deploy figlet
Now find the function deployed in the cluster and invoke it.
$ faas-cli list $ echo "OpenFaaS!" | faas-cli invoke figlet
You can also access the Function Store from the Portal UI and find a range of functions covering everything from machine-learning to network tools.
3.0 Start the hands-on labs¶
Learn how to build serverless functions with OpenFaaS and Python in our half-day workshop. You can follow along online at your own pace.
If you are running into any issues please check out the troubleshooting guide and search the documentation / past issues before raising na issue.