OpenFaaS runs on top of several major platforms including Docker Swarm and Kubernetes. For this tutorial we will get started with Docker Swarm on your local computer.
The basic primitive for any OpenFaaS function is a Docker image, which is built using the faas-cli tool-chain.
For Mac
For Windows
- Use Windows 10 Pro or Enterprise only
- Install Docker CE for Windows
Please ensure you use the Linux containers Docker daemon by using the Docker menu in the Windows task bar notification area.
- Install Git Bash
Note: please use Git Bash for all steps: do not attempt to use WSL or Bash for Windows.
Linux - Ubuntu or Debian
- Docker CE for Linux
You can install Docker CE from the Docker Store.
Note: As a last resort if you have an incompatible PC you can run the workshop on https://labs.play-with-docker.com/.
OpenFaaS works both with Kubernetes and Docker Swarm. If you're taking part in a workshop event then the organiser will probably ask you to use Docker Swarm because it's much easier to set up in a short period of time. There are deployment guides for both options in the documentation.
On your laptop or VM setup a single-node Docker Swarm:
$ docker swarm init
If you receive an error then pass the
--advertise-addrparameter along with your laptop's IP address.
You can follow the labs whilst using Kubernetes, but you may need to make some small changes along the way. The service address for the gateway changes from http://gateway:8080 to http://gateway.openfaas:8080.
If using a NodePort then the gateway address for the OpenFaaS CLI is normally http://IP_ADDRESS:31112/
Sign up for a Docker Hub account. The Docker Hub allows you to publish your Docker images on the Internet for use on multi-node clusters or to share with the wider community. We will be using the Docker Hub to publish our functions during the workshop.
You can sign up here: Docker Hub
Note: The Docker Hub can also be setup to automate builds of Docker images.
Open a Terminal or Git Bash window and log into the Docker Hub using the username you signed up for above.
$ docker login
Note: Tip from community - if you get an error while trying to run this command on a Windows machine, then click on the Docker for Windows icon in the taskbar and log into Docker there instead "Sign in / Create Docker ID".
You can install the OpenFaaS CLI with brew on a Mac or with a utility script on Mac or Linux:
Using a Terminal on Mac or Linux:
$ curl -sL cli.openfaas.com | sudo sh
On Windows download the the latest faas-cli.exe from the releases page. You can place it in a local directory or in the C:\Windows\ path so that it's available from a command prompt.
If you're an advanced Windows user, place the CLI in a directory of your choice and then add that folder to your PATH environmental variable.
We will use the faas-cli to scaffold new functions, build, deploy and invoke functions. You can find out commands available for the cli with faas-cli --help.
Test the faas-cli
Open a Terminal or Git Bash window and type in:
$ faas-cli help
$ faas-cli version
The instructions for deploying OpenFaaS change from time to time as we strive to make this easier. The following will get OpenFaaS deployed in around 60 seconds:
- First clone the repo:
$ git clone https://github.com/openfaas/faas
- Now checkout the latest version with Git
$ cd faas && \
git checkout master
Note: you can see the latest releases on the project release page.
- Now deploy the stack with Docker Swarm:
$ ./deploy_stack.sh --no-auth
You should now have OpenFaaS deployed. If you are on a shared WiFi connection at an event then it may take several minutes to pull down all the Docker images and start them.
Check the services show 1/1 on this screen:
$ docker service ls
If you run into any problems, please consult the Deployment guide for Docker Swarm.
Now move onto Lab 2