Install Docker for Windows

Version 94.1 by Erik Bakker on 2024/02/08 16:43

In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.

Should you have any questions, please contact academy@emagiz.com.

1. Prerequisites

Advanced knowledge of the eMagiz platform
Good understanding of eMagiz runtimes in general

2. Key concepts

In the new runtime architecture of eMagiz, Docker technology is used to deploy runtimes. eMagiz creates specific runtime images that contain the eMagiz runtime, and can be deployed in dockerized environments.

In the below section the Windows and Linux variants are described in terms of how to prepare the server to allow the eMagiz Deploy agent to be installed. That agent allows to download images from the eMagiz infrastructure.

3. On-premises deployments

3.1 General requirements

These are the general requirements to allow the installation of the eMagiz Docker agent:

Ensure access to the following URLs is enabled
- registry.emagiz.com:443
- controlplane.emagiz.com:8000
- Preferably the entry should be *.emagiz.com

3.2 Installation requirements Linux

Whenever Linux is selected as operating system, the latest version of Ubuntu will work. Other Linux distributions will also work such as Debian or Red Hat.
Step 1: Install linux distribution
Follow the relevant steps in section 3.4

Step 2: Install eMagiz Deploy Agent
Install the eMagiz Deploy agent as can be found in this microlearning

3.3 Installation requirements Windows Server 2022

Please note that this section also applies to Windows Server 2019 version >1806

The steps below will install a linux subsystem under Windows. In that Linux system, Docker and Java will be installed. Please note that the Windows server needs to be able to run Virtualized (either via BIOS setting or via Nested Virtualization).

Step 1: Install linux distribution

  wsl --install -d Ubuntu
  sudo apt-get update
  sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
  . /etc/os-release

Step 2: Configure linux system
Please see section 3.4 for these these steps

Step 3: Update wsl config file
In this step we need to add or update the WSL config file that manages the resources of the Linux subsystem. Important resources to manage are the assigned memory and number of processors. For memory we recommend to review the mempory settings for the runtime that need to run on this server and add 762 MB to the total value of the heap and non-heap of these runtimes. For processor we recommend to set the value to 2 - depending on the amount of processors available on that machine

First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)

  #Add following lines

  # Settings apply across all Linux distros running on WSL 2
  [wsl2]
  # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
  memory=16GB
  # Sets the VM to use two virtual processors
  processors=2

Step 4: Auto start the linux subsystem when Windows server restarts

* Press Windows+R
* Type shell:startup and press enter
* Add or update file start_wsl.bat
* Add following line into the document and save file
* wsl sudo /usr/bin/dockerd

Step 5: Install eMagiz Deploy Agent
Install the eMagiz Deploy agent as can be found in this microlearning.

3.4 Installation steps to configure Linux subsystem

Step 1: Install Docker

  curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
  echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
  sudo apt update
  sudo apt install docker-ce docker-ce-cli containerd.io

Requires 335 Mb space to install

Step 3: Ensure Docker is autostarted with WSL

This remark is valid for Windows based installations only

nano .bashrc

#Add following lines to bashrc
DOCKER_DISTRO="Ubuntu"
DOCKER_LOG_DIR=$HOME/docker_logs
mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
/mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"

Step 4: Add user to Docker group

sudo visudo

  #Add following lines

  # Don't ask for password
  %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd

Step 5: Ensure safe IP range for WSL

This remark is valid for Windows based installations only

This step ensures that the IP address range of the machine doesn't conflict with any IP address of the Linux subsystem. Below the recommended values depending on the range which can be filled in the value <ip-address> below:

10.0.0.1/8
- advised value 10.25.0.1/16
172.16.0.1/12
- advised value 172.16.0.1/16
192.168.0.1/16
- advised value 192.168.0.1/16

sudo nano /etc/docker/daemon.json

#Add following lines

{"bip": "<ip-address>"}

3.5 Installation requirements Windows Server 2019 version 1806

Please note that this section is under construction. Please contact us at productmanagement@emagiz.com

These are the requirements to allow the installation of the eMagiz Docker agent:

Enable Hyper-V in Windows Server
- Go to Server Manager, Manage (top right), enable roles and features, select the desired roles and server selections. In the Features section, enable Hyper-V.
- Restart windows
Cross check is WSL 2.0 is installed
- Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
Please follow the instructions for preparing a Windows 2022 installation in section 3.3

Install Docker Desktop on the Windows Server
- Please refer to this link: https://www.docker.com/products/docker-desktop/
- Restart windows
Update Docker Desktop configuration
- Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
- Restart Docker
Open Powershell as Administrator
- Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
- Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
- Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
- Execute Add-AppxPackage .\ubuntu-2004.appx
  - If errors occur, please consult https://learn.microsoft.com/en-us/windows/wsl/install-on-server. Rename the file to a zip, expand it, and add it to the path variable.
Ubuntu should now be a runnable program (press windows key, type ubuntu)
Open the ubuntu terminal, and finish the installation.
- After installation, execute: export DOCKER_HOST=tcp://localhost:2375
Go to the next section around installing the eMagiz Docker agent

3.6 Installation requirements Windows Server 2012 R2