Skip to main content
Version: main

Installing WKP on Footloose

Install the dependencies#

On the computer that will be used for the installation, you need to install:

  • git
  • kubectl
  • The wk binary. You can ensure it is in your path by running wk version

Install WKP on footloose containers#

Footloose allows the creation of containers that emulate virtual machines.

It provides an easy way for deploying on a single machine and demoing WKP features.

First, create a directory which will contain the cluster management scripts and binaries.

It is required to provide a valid entitlements file for this step.

The default location for it is at /home/${USER}/.wks/entitlements, to specify a different location use the --entitlements flag:

mkdir wkp-footloose-cluster && cd wkp-footloose-cluster
wk setup install --entitlements=/path/to/my/entitlements

The main configuration file is unpacked at setup/config.yaml.

The required values are your git provider organization or user, your Docker Hub user, and an absolute path to a file containing your Docker Hub password:

mkdir -p ~/.wks
echo 'my-dockerhub-password' > ~/.wks/dockerhub-password
chmod 600 ~/.wks/dockerhub-password

Enter your gitProvider, dockerIOUser, and dockerIOPasswordFile in your setup/config.yaml (See Git Config Repository for details about git parameters).

Optionally, set the clusterName and kubernetesVersion fields.

vim setup/config.yaml

Example snippet of config.yaml:

track: wks-footloose
clusterName: my-cluster
gitProvider: gitlab
dockerIOUser: my-docker-user
dockerIOPasswordFile: /home/my-user/.wks/my-dockerhub-password

Changes for Docker Desktop on MacOS

Docker Desktop for Mac requires setting specific CIDR blocks. Make sure to set them in config.yaml:

serviceCIDRBlocks: []
podCIDRBlocks: []

In the footlooseConfig section of setup/config.yaml, you can set the number of nodes according to your specifications and available resources, as well as the backend for creating them. The default is docker, which will deploy WKP on footloose containers.

Another possibility, available only on Linux due to its KVM requirement, is to use ignite to deploy WKP on lightweight VMs.

For this example we will use the default backend docker.

WKP uses a personal access token to create the cluster repository on GitHub. The token needs to have permissions in the repo scope. The github documentation on how to create one can be found on this page. Once you have created one, set the environment variable for it:

export GITHUB_TOKEN=my-token


If you would like to run EKS-D in your cluster using the experimental support for EKS-D in WKP, please follow the instructions at: Using the EKS-D Kubernetes distribution

Now we are ready to install the cluster:

wk setup run

Access the WKP UI#

via wk ui command#

To expose the WKP UI via wk ui command, run:

wk ui

You should now be able to view it at http://localhost:8090

To expose the WKP UI to a different port other than the default, run:

wk ui --port 8081

Delete a WKP cluster#

You can use the script:

./setup/ wk