Prerequisites

You need to install Docker and K3s first before installing CAPE. We have created a helpful script that will get all of the infrastructure set up for you.

Docker Installation

Installing Docker Desktop for Windows

Double-click Docker Desktop Installer.exe to run the installer.

If you haven’t already downloaded the installer (Docker Desktop Installer.exe), you can get it from Docker Hub. It typically downloads to your Downloads folder, or you can run it from the recent downloads bar at the bottom of your web browser.

When prompted, ensure the Enable Hyper-V Windows Features option is selected on the Configuration page.

Follow the instructions on the installation wizard to authorize the installer and proceed with the install.

When the installation is successful, click Close to complete the installation process.

Start Docker Desktop

Docker Desktop does not start automatically after installation. To start Docker Desktop, search for Docker, and select Docker Desktop in the search results. When the whale icon in the status bar stays steady, Docker Desktop is up-and-running, and is accessible from any terminal window.

K3s Installation

Installing K3s

k3s in docker - k3s is the lightweight Kubernetes distribution by Rancher

k3d creates containerized k3s clusters. This means, that you can spin up a multi-node k3s cluster on a single machine using docker.

Requirements: Docker

Installation

There are several options to install k3d as shown below.

  • use the install script to grab the latest release.

    wget: wget -q -O - https://raw.githubusercontent.com/rancher/k3d/master/install.sh | bash
    curl: curl -s https://raw.githubusercontent.com/rancher/k3d/master/install.sh | bash

    a. use the install script to grab a specific release (via TAG environment variable):

    wget: wget -q -O - https://raw.githubusercontent.com/rancher/k3d/master/install.sh | TAG=v3.0.0-beta.0 bash
    curl: curl -s https://raw.githubusercontent.com/rancher/k3d/master/install.sh | TAG=v3.0.0-beta.0 bash
  • Use Homebrew. (Homebrew is available for MacOS and Linux)

    brew install k3d
  • Install via AUR package rancher-k3d-bin:

    yay -S rancher-k3d-bin
  • Grab a release from the release tab and install it yourself.

  • Install via go. (Note: this will give you unreleased/bleeding-edge changes)

    go install github.com/rancher/k3d
  • Build

    a. Clone this repo, e.g. via

    go get -u github.com/rancher/k3d

    b. Inside the repo run the following command to make sure required go packages are installed

    make install-tools

    c. Inside the repo run one of the following command to build for your current system

    make build