Changes for page Install Docker for Windows

Last modified by Erik Bakker on 2026/01/23 13:45

From 69.1 to 70.1 From 144.1 to 145.1

From version 70.1

edited by eMagiz
on 2023/02/07 13:22

Change comment: There is no comment for this version

To version 144.1

edited by Erik Bakker
on 2026/01/23 12:51

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Pre-requisite installation of on-premises server
++Install Docker for Windows

Author

@@ -1,1 +1,1 @@
--XWiki.eMagiz
++XWiki.ebakker

Content

@@ -1,5 +1,5 @@
  {{container}}{{container layoutStyle="columns"}}(((
--In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
++In eMagiz's current runtime architecture, Docker technology is utilized to deploy runtimes efficiently. eMagiz provides specific runtime images that can be deployed within dockerized environments. This section outlines the steps needed to prepare a Windows server for the installation of the eMagiz Deploy Agent, which is responsible for downloading these images from the eMagiz infrastructure.
  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
@@ -9,186 +9,168 @@
  * 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.
--
++In the current 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>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]] 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:8443
--    ** 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 all steps in section 3.4
++{{info}}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 aligning the on-premise Docker version and updating it according to the release notes of the [[Cloud templates>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]].
++{{/info}}
--**Step 2: Install eMagiz Deploy Agent**
--Install the eMagiz Deploy agent as can be found [[on this link>>https://docs.emagiz.com/bin/view/Main/eMagiz%20Academy/Microlearnings/Intermediate%20Level/eMagiz%20Runtime%20Management/intermediate-runtime-management-deploy-agent/||target="_blank"]]
++{{info}}
++* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
++    ** registry.emagiz.com:443
++    ** controlplane.emagiz.com:443
++    ** controlplane-agent.emagiz.com:443
++    ** controltower.emagiz.com:443
++    ** controltower.kpn-dsh.com:443
++    ** controlbus.emagiz.com:443
++    ** Preferably the entry should be *.emagiz.com
++    ** Preferably the entry should be *.kpn-dsh.com{{/info}}
--===3.3 Installation requirements Windows Server 2022 ===
++{{warning}}
++* When using **IP Whitelisting**, 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
++    ** 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
++    ** 18.199.123.240
++    ** 18.184.211.189
++    ** 3.123.136.31{{/warning}}
--{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
--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**
++===3.2 Installation Windows===
++When Windows is selected as the operating system, you need Windows Server 2022. Older Windows servers are **not** supported.
++==== 3.2.1 Docker Installation ====
++To install Docker on your machine, execute the following commands in PowerShell with administrative rights:
++
  {{code language="cmd"}}
--  wsl --install -d Ubuntu
--  sudo apt-get update
--  sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
--  . /etc/os-release
++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
  {{/code}}
--**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
++==== 3.2.2 Customization ====
--First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
++After installing Docker, you can stick with the standard configuration or adjust specific settings. Settings that can be of particular interest include the one that defines the IP address range your Docker installation will use to run containers, and the one that defines where to store data (i.e., containers and images). To check the full list of compatible configuration options for Windows, you can check: [[Configure Docker in Windows>>https://learn.microsoft.com/en-us/virtualization/windowscontainers/manage-docker/configure-docker-daemon||target="blank"]].
++{{warning}}Be aware that the customization will only take effect once you have restarted the machine.{{/warning}}
++
++===== 3.2.2.1 IP address range =====
++
++Below is the code needed to configure a different IP address range.
++
  {{code language="cmd"}}
--  #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
++cd C:\ProgramData\Docker\config\daemon.json
++#Add the following lines
++{"fixed-cidr": "<ip-address>"}
  {{/code}}
++===== 3.2.2.2 Data location =====
--**Step 4: Auto start the linux subsystem when Windows server restarts **
--
--**Step 5: Install eMagiz Deploy Agent**
--Install the eMagiz Deploy agent as can be found [[on this link>>https://docs.emagiz.com/bin/view/Main/eMagiz%20Academy/Microlearnings/Intermediate%20Level/eMagiz%20Runtime%20Management/intermediate-runtime-management-deploy-agent/||target="_blank"]]
--
--
--===3.4 Installation steps to configure Linux subsystem ===
++Below is an example of switching from the default C directory ({{code language="cmd"}}c:\programdata\docker{{/code}}) to the D directory to store Docker data. Based on your internal configuration, you can choose the best suitable variant if needed. To do so, you can add the following attribute to the Docker daemon file:
--**Step 1: Install Docker **
--
  {{code language="cmd"}}
--  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
++cd C:\ProgramData\Docker\config\daemon.json
++#Add the following lines
++{
++ "data-root": "d:\\docker"
++}
  {{/code}}
--{{info}}
-- Requires ~335 Mb space to install
--{{/info}}
++{{warning}}Note that when you want to create multiple customizations to your configuration, the result in the daemon.json file should be a **valid** JSON structure{{/warning}}
--**Step 2: Install Java **
++==== 3.2.3 Check installation ====
++After executing the commands above, the server will restart if required. After the restart, execute the following command
++
  {{code language="cmd"}}
--  wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
--  echo "deb https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | sudo tee /etc/apt/sources.list.d/adoptium.list
--  sudo apt update # update if you haven't already
--  sudo apt install temurin-8-jdk
++docker ps
  {{/code}}
--{{info}}
-- Requires ~335 Mb space to install
--{{/info}}
++If the command returns "command not found," please run the following command again.
--**Step 3: Ensure Docker is autostarted with WSL **
--
  {{code language="cmd"}}
--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"
++.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
  {{/code}}
--**Step 4: Add user to Docker group **
++==== 3.2.3 Verify Docker functionality ====
++Execute the following command
++
  {{code language="cmd"}}
--sudo visudo
++docker ps
++{{/code}}
--  #Add following lines
++The result of this call should show the following:
--  # Don't ask for password
--  %docker ALL=(ALL)  NOPASSWD: /usr/bin/dockerd
--{{/code}}
++[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
--
++==== 3.2.4 Install eMagiz Deploy Agent ====
--===3.5 Installation requirements Windows Server 2019 version 1806===
++Install the eMagiz Deploy agent as described in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
--{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
++=== 3.3 Update Docker ===
++When you are advised to update your Docker version, you can verify whether you are on the correct Docker version by executing the following command in PowerShell with administrative rights:
--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
--* 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
++{{code language="cmd"}}
++docker version
++{{/code}}
--===3.6 Installation requirements Windows Server 2012 R2 ===
++When this returns a version **lower** than the advised version shown under the "General requirements" section, you can update Docker on your machine. To do so, execute the following command in PowerShell with administrative rights:
--{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
++{{code language="cmd"}}
++.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
++{{/code}}
--These are the requirements to allow the installation of the eMagiz Docker agent:
--* Install & 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
--* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
--* Create a VM in HyperV.
--  ** For this, choose Generation 1, the amount of memory you want to assign to ubuntu and thus to the containers. Please consider the overhead for memory as well (such as OS).
--  ** Configure a virtual switch.
--  ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
--  ** Install an operating system from bootable CD/DVD, ISO file
--* Install ubuntu downloaded previously on the VM
--* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
--* Go to the next section around installing the eMagiz agent
++===3.4 Uninstall Docker===
++To uninstall Docker from your machine, execute the following commands in PowerShell with administrative rights:
--== 4. Assignment ==
++{{code language="cmd"}}
++Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
++{{/code}}
--Check out the cheatcheet for Docker command line:
++Example usage:
--[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
++{{code language="cmd"}}
++.\uninstall-docker-ce.ps1
++{{/code}}
--== 5. Key takeaways ==
++== 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 uses runtime images to deploy the 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.
++* The firewall of the on-premises environment should allow outgoing traffic without any restrictions. If that is not desirable, eMagiz can provide the addresses and ports needed to set up the appropriate firewall rules.
++== 5. Suggested Additional Readings ==
++* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
++** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
++* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
++** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
++* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
++** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
++*** [[Interpret on-premise logging (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-emagiz-runtime-management-interpret-on-premise-logging.WebHome||target="blank"]]
++*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
++* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
++** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
++*** [[Impact of Runtime Image Upgrades (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.advanced-lifecycle-management-impact-of-runtime-image-upgrades.WebHome||target="blank"]]
++* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
++** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
++*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]
++* [[Install Docker (Search Result)>>url:https://docs.emagiz.com/bin/view/Main/Search?sort=score&sortOrder=desc&highlight=true&facet=true&r=1&f_space_facet=0%2FMain.&f_type=DOCUMENT&f_locale=en&f_locale=&f_locale=en&text=install+docker||target="blank"]]
++* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
--== 6. Suggested Additional Readings ==
--
--N/A
--
--== 7. Silent demonstration video ==
--
--N/A
--
  )))((({{toc/}}))){{/container}}{{/container}}