Skip to content

Latest commit

 

History

History
98 lines (56 loc) · 3.89 KB

lab1.md

File metadata and controls

98 lines (56 loc) · 3.89 KB
Raw

Lab 1 - Prepare for OpenFaaS

OpenFaaS requires a Kubernetes cluster to operate. You can use a single-node cluster or a multi-node cluster, whether that's on your laptop or in the cloud.

The basic primitive for any OpenFaaS function is a Docker image, which is built using the faas-cli tool-chain.

Pre-requisites:

Let's install Docker, the OpenFaaS CLI and setup Kubernetes.

Docker

For Mac

For Windows

Please ensure you use the Linux containers Docker daemon by using the Docker menu in the Windows task bar notification area.

When you install git bash pick the following options: install UNIX commands and use true-type font.

Note: please use Git Bash for all steps: do not attempt to use PowerShell, 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 CLI

You can install the OpenFaaS CLI using the official bash script, brew is also available but can lag one or two versions behind.

With MacOS or Linux run the following in a Terminal:

# MacOS users may need to run "bash" first if this command fails
$ curl -sLSf https://cli.openfaas.com | sudo sh

For Windows, run this in Git Bash:

$ curl -sLSf https://cli.openfaas.com | sh

If you run into any issues then you can download the latest faas-cli.exe manually 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.

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

Configure a registry - The Docker Hub

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

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".

  • Set your OpenFaaS prefix for new images

OpenFaaS images are stored in a Docker registry or the Docker Hub, we can set an environment variable so that your username is automatically added to new functions you create. This will save you some time over the course of the workshop.

Edit ~/.bashrc or ~/.bash_profile - create the file if it doesn't exist.

Now add the following - changing the URL as per the one you saw above.

export OPENFAAS_PREFIX="" # Populate with your Docker Hub username

Setup a single-node cluster

The labs use Kubernetes, Swarm is no longer supported by the OpenFaaS community. Some of the workshop labs will work for faasd, but you may need to alter the commands and we do not provide support for the workshop when taken with faasd.