Skip to content

SetUp

Jump to bottom
Alec Clews edited this page Sep 29, 2024 · 12 revisions

Introduction

The workshop is based on the Moby container engine and CLI and you will need to install the docker command in your environment. You can install this via either Rancher Desktop or Docker Desktop.

Note that Finch should also work on MacOS or Windows, but has not been fully tested. Just use the command finch wherever you see docker.

You can either use Rancher Desktop or Docker Desktop as you prefer, but install only one to avoid confusion. You should review the licensing requirements for Docker Desktop first. If you are not sure then I recommend using Rancher Desktop.

Once you have Moby installed you should test your environment and download the workshop files (see below)

The installation instructions first suggest using common package mangers you may already be using. However, links are provided to the standard download instructions if the package management option is not avaliable to you.

Workstation Install

macOS

Note: Works on both Intel and Apple silicon

Rancher Desktop

  • Use Homebrew:

    brew install --cask rancher && brew install docker-completion

    OR

  • Follow the instructions on the website

    Once Rancher is installed (you may need to log out and back in), run the following commands

    rdctl set --container-engine.name=moby  # Set Moby as the default
rdctl set --kubernetes.enabled=false    # Reduce resource use by disabling K8
rdctl set --application.admin-access=true # Stop the prompt for admin access

Docker Desktop

  • Use Homebrew

    brew install --cask docker && brew install docker-completion

    Note: after brew has finished open the application /Applications/Docker.app to complete setup

    OR

  • Follow the instructions on the website

Modern MS Windows

Rancher Desktop

For supported Windows versions and requirements see here

  • Install via Winget at the Powershell prompt -- winget install -e --id suse.RancherDesktop (recommended)

    OR

  • Install via Chocolaty at the PowerShell prompt -- choco install rancher-desktop

    OR

  • Follow the instructions on the website

Once Rancher is installed (you may need to log out and back in), run the following commands

rdctl set --container-engine.name=moby  # Set Moby as the default
rdctl set --kubernetes.enabled=false    # Reduce resource use by disabling K8
rdctl set --application.admin-access=true # Stop the prompt admin access

Docker Desktop

For supported Windows versions and requirements see here)

  • Install via Winget at the Powershell prompt -- winget install -e --id Docker.DockerDesktop (recommended)

    OR

  • Install via Chocolaty at the PowerShell prompt -- choco install docker-desktop

    OR

  • Follow the instructions on the website

Linux

Linux does not require the full Desktop product to be installed. For this reason is is recommended ti install Docker Engine Using the convenience script.

Notes:

  1. Docker Engine does not have the same licensing restrictions as Docker Desktop.
  2. Remember to set up the correct group membership to avoid using sudo.

Thanks to @bretfisher and @jpetazzo for writing these setup instructions and saving me a lot of time.

Cloud Platform

If you do not have access to a shell prompt on your machine (for example because you are using a tablet) then it's possible to run the workshop exercices in a cloud shell.

For example using Google Cloud Platform (GCP)

Docker Engine and Git are supplied be default in the GCP Cloud Shell, and no need to run a dedicated cloud virtual machine for this workshop.

You will need to login to the GCP Console at https://console.cloud.google.com and then follow the instructions at https://cloud.google.com/shell/docs/starting-cloud-shell

Test your setup

From the command prompt run the following commands

  • docker version

Note: The following command need to an active network connection to connect to the Docker registry

  • docker run hello-world

If you get errors ask your partner or the workshop facilitators for help

Get the Workshop files

Clone this wiki locally