Install Docker for Windows

Last modified by Erik Bakker on 2024/04/11 08:21

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 variant is 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

  • Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
    • registry.emagiz.com:443
    • controlplane.emagiz.com:8000
    • controltower.kpn-dsh.com:443
    • Preferably the entry should be *.emagiz.com
    • Preferably the entry should be *.kpn-dsh.com
  • In case of a very strict firewall configuration, additional configuration is needed to communicate to the eMagiz infrastructure.
    • controltower.emagiz.com:443
    • controltower.kpn-dsh.com:443
    • controlbus.emagiz.com:443
    • controlplane.emagiz.com:443
  • When using cloudslot number equal to or below 125, the following configuration is needed to communicate to your JMS.
    • 35.158.46.28:443
    • 3.74.190.88:443
    • 35.158.46.28:8443
    • 3.74.190.88:8443
    • 35.158.46.28:8444
    • 3.74.190.88:8444
  • When using a cloudslot number above 125, the following configuration is needed to communicate to your JMS.
    • 3.74.209.20:443
    • 3.76.127.155:443
    • 3.74.209.20:8443
    • 3.76.127.155:8443
    • 3.74.209.20:8444
    • 3.76.127.155:8444

3.2 Installation Windows

Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version. Older Windows servers are not supported.

3.2.1 Docker Installation

To install or update docker on your machine, execute the following commands in powershell with administrative rights:

Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Install-update-docker/install-update-docker.ps1" -o install-update-docker-ce.ps1
.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION

It is advised to use Docker version 24.0.7 as this is the version being used in the latest eMagiz cloud template. We advise to align the on-premise Docker version and update it according to the release notes of the Cloud templates.

By default the docker daemon configuration file is located in the docker data path at C:\ProgramData\docker\config\daemon.json.
To check the configuration options and compatible options with Windows you can check: Configure Docker in Windows.

Example usage of the Docker daemon file: You maybe want the Docker daemon to keep images and containers in an alternate path (D:
drive for example). To do so you can add the following attribute to the Docker daemon file:

{
 "data-root": "d:\\docker"
}

If not specified, the default is c:\programdata\docker.

3.2.2 Check installation

After executing the commands above, the server will restart if required. After the restart, execute the following command

docker ps

If the command returns that the command cannot be found, please run the following command again.

.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION

3.2.3 Verify docker functionality

Execute the following command

docker ps

The result of this call should show the following:

expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png

3.2.4 Install eMagiz Deploy Agent

Install the eMagiz Deploy agent as can be found in this microlearning

3.3 Uninstall Docker

To uninstall docker from your machine, execute the following commands in powershell with administrative rights:

Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1

Example usage:

.\uninstall-docker-ce.ps1

4. Key takeaways

  • eMagiz uses runtime images to deploy emagiz runtime on dockerized environments. The runtime image holds all the information and components required to run the runtime
  • eMagiz has a specific agent that manages the download of that image to the on-premises server
  • The firewall of the on-premises environment should allow outgoing traffic without any restriction. In case that is not desirable, eMagiz can provide the addresses and ports needed to setup the right firewall rules.

5. Suggested Additional Readings

  • Docker command line cheatsheet: docker-cheatsheet.png