Skip to Content
Last modified by Erik Bakker on 2026/04/21 12:15
From version 150.1
edited by Erik Bakker
on 2026/04/21 12:06
Change comment: There is no comment for this version
To version 59.1
edited by eMagiz
on 2023/02/07 12:09
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Install Docker for Windows
1 +On-premise Install Guide
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.eMagiz
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -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.
2 +In this microlearning, we will focus on how the installation requirements for on-premises deployments of eMagiz runtimes that are part of the new runtime architecture. The new runtime architecture uses a containerized approach to deploy runtimes.
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -9,174 +9,205 @@
9 9  * Good understanding of eMagiz runtimes in general
10 10  
11 11  == 2. Key concepts ==
12 -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.
13 -
14 -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.
15 -
12 +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.
13 +
14 +In the below section the specific operating systems and versions are discussed in a sense that the prerequisite installations are described. Once the right installation is done, refer to section 3.7 for the installation of the eMagiz agent that manages the interaction with the eMagiz platform. That agent will download the created docker images that will be deployed in the Docker environment.
15 +
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 -
20 -{{info}}It is advised to use Docker version 29.1.3 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"]].
21 -{{/info}}
22 -
23 -{{info}}
24 -* When **your** security requirements require **DNS Whitelisting**, the following DNS-level configuration is needed to communicate with our infrastructure and the specific eMagiz model(s) you need to connect to. These IP addresses are subject to periodic change on our end.
25 25  
26 - ** registry.emagiz.com:443
27 - ** controlplane.emagiz.com:443
28 - ** controlplane-agent.emagiz.com:443
29 - ** controltower.emagiz.com:443
30 - ** controltower.kpn-dsh.com:443
31 - ** controlbus.emagiz.com:443
32 - ** {yourcloudslotid}.emagizcloud.com:8443
33 -
34 -* Preferably we suggest to implement the following entries on DNS level.
35 - ** *.emagizcloud.com
36 - ** *.emagiz.com
37 - ** *.kpn-dsh.com{{/info}}
20 +These are the general requirements to allow the installation of the eMagiz Docker agent:
21 +* Ensure access to the following URLs is enabled
22 + ** registry.emagiz.com:8443
23 + ** controlplane.emagiz.com:8000
24 + ** Preferably the entry should be *.emagiz.com
38 38  
39 -{{warning}}
40 -* When **your** security requirements require **IP Whitelisting**, the following IP-level configuration is needed to communicate with our infrastructure and the specific eMagiz model(s) you need to connect to. These IP addresses are subject to periodic change on our end.
41 41  
42 - ** 35.158.46.28:443
43 - ** 3.74.190.88:443
44 - ** 35.158.46.28:8443
45 - ** 3.74.190.88:8443
46 - ** 35.158.46.28:8444
47 - ** 3.74.190.88:8444
48 - ** 3.74.209.20:443
49 - ** 3.76.127.155:443
50 - ** 3.74.209.20:8443
51 - ** 3.76.127.155:8443
52 - ** 3.74.209.20:8444
53 - ** 3.76.127.155:8444
54 - ** 18.199.123.240
55 - ** 18.184.211.189
56 - ** 3.123.136.31{{/warning}}
27 +===3.2 Installation requirements Linux===
57 57  
58 -===3.2 Installation Windows===
59 -When Windows is selected as the operating system, you need Windows Server 2022. Older Windows servers are **not** supported.
29 +* 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.
30 +* Install latest version of the Docker engine - see for instance this link below. For other Linux distributions similar install guides are available on this link.
60 60  
61 -==== 3.2.1 Docker Installation ====
62 -To install Docker on your machine, execute the following commands in PowerShell with administrative rights:
32 +{{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
63 63  
64 -{{code language="cmd"}}
65 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Install-update-docker/install-update-docker.ps1" -o install-update-docker-ce.ps1
66 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
67 -{{/code}}
68 68  
69 -==== 3.2.2 Customization ====
35 +* Install the eMagiz Deploy agent
70 70  
71 -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"]].
37 +===3.3 Installation requirements Windows Server 2022 (Docker Desktop)===
72 72  
73 -{{warning}}Be aware that the customization will only take effect once you have restarted the machine.{{/warning}}
39 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
74 74  
75 -===== 3.2.2.1 IP address range =====
76 -
77 -Below is the code needed to configure a different IP address range.
41 +These are the requirements to allow the installation of the eMagiz Docker agent:
42 +* Install latest version of Docker Desktop from
78 78  
79 -{{code language="cmd"}}
80 -cd C:\ProgramData\Docker\config\daemon.json
81 -#Add the following lines
82 -{"fixed-cidr": "<ip-address>"}
83 -{{/code}}
44 +{{code}}https://www.docker.com/products/docker-desktop/{{/code}}
84 84  
85 -===== 3.2.2.2 Data location =====
86 -
87 -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:
46 +* Validate if WSL 2.0 is properly installed
47 +* Install the eMagiz Deploy agent
88 88  
89 -{{code language="cmd"}}
90 -cd C:\ProgramData\Docker\config\daemon.json
91 -#Add the following lines
92 -{
93 - "data-root": "d:\\docker"
94 -}
95 -{{/code}}
49 +===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
96 96  
97 -{{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}}
51 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
98 98  
99 -==== 3.2.3 Check installation ====
53 +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).
100 100  
101 -After executing the commands above, the server will restart if required. After the restart, execute the following command
55 +**Step 1: Install linux distribution**
102 102  
103 103  {{code language="cmd"}}
104 -docker ps
58 + wsl --install -d Ubuntu
59 + sudo apt-get update
60 + sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
61 + . /etc/os-release
105 105  {{/code}}
106 106  
107 -If the command returns "command not found," please run the following command again.
108 108  
65 +**Step 2: Install Docker **
66 +
109 109  {{code language="cmd"}}
110 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
68 + curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
69 + echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
70 + sudo apt update
71 + sudo apt install docker-ce docker-ce-cli containerd.io
111 111  {{/code}}
112 112  
113 -==== 3.2.3 Verify Docker functionality ====
74 +{{info}}
75 + Requires ~335 Mb space to install
76 +{{/info}}
114 114  
115 -Execute the following command
78 +**Step 3: Install Java **
116 116  
117 117  {{code language="cmd"}}
118 -docker ps
81 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
82 + 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
83 + sudo apt update # update if you haven't already
84 + sudo apt install temurin-8-jdk
119 119  {{/code}}
120 120  
121 -The result of this call should show the following:
87 +{{info}}
88 + Requires ~335 Mb space to install
89 +{{/info}}
122 122  
123 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
91 +**Step 4: Ensure Docker is autostarted with WSL **
124 124  
125 -==== 3.2.4 Install eMagiz Deploy Agent ====
93 +{{code language="cmd"}}
94 +nano .bashrc
126 126  
127 -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"]]
96 + #Add following lines to bashrc
97 + DOCKER_DISTRO="Ubuntu"
98 + DOCKER_LOG_DIR=$HOME/docker_logs
99 + mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
100 + /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
101 +{{/code}}
128 128  
129 -=== 3.3 Update Docker ===
130 -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:
103 +**Step 5: Add user to Docker group **
131 131  
132 132  {{code language="cmd"}}
133 -docker version
134 -{{/code}}
106 +sudo visudo
135 135  
136 -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:
108 + #Add following lines
137 137  
138 -{{code language="cmd"}}
139 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
110 + # Don't ask for password
111 + %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
140 140  {{/code}}
141 141  
142 -{{warning}}It may happen that, due to the update, your containers are no longer starting up. To resolve this, please restart the containers, which can be done via a deployment plan or the deploy architecture.{{/warning}}
114 +**Step 6: Update wsl config file **
115 +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
143 143  
144 -===3.4 Uninstall Docker===
145 -To uninstall Docker from your machine, execute the following commands in PowerShell with administrative rights:
117 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
146 146  
119 +
147 147  {{code language="cmd"}}
148 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
121 + #Add following lines
122 +
123 + # Settings apply across all Linux distros running on WSL 2
124 + [wsl2]
125 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
126 + memory=16GB
127 + # Sets the VM to use two virtual processors
128 + processors=2
149 149  {{/code}}
150 150  
151 -Example usage:
131 +
132 +**Step 7: Auto start the linux subsystem when server restarts **
133 +
152 152  
153 -{{code language="cmd"}}
154 -.\uninstall-docker-ce.ps1
155 -{{/code}}
135 +===3.4 Installation requirements Windows Server 2019 version >1806===
156 156  
157 -== 4. Key takeaways ==
137 +These are the requirements to allow the installation of the eMagiz Docker agent:
138 +* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
139 +* Validate if WSL 2.0 is properly installed
140 +* Go to the next section around installing the eMagiz Docker agent
158 158  
159 -* 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
142 +===3.5 Installation requirements Windows Server 2019 version 1806===
143 +
144 +These are the requirements to allow the installation of the eMagiz Docker agent:
145 +* Enable Hyper-V in Windows Server
146 + ** 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.
147 + ** Restart windows
148 +* Cross check is WSL 2.0 is installed
149 + ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
150 +* Install Docker Desktop on the Windows Server
151 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
152 + ** Restart windows
153 +* Update Docker Desktop configuration
154 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
155 + ** Restart Docker
156 +* Open Powershell as Administrator
157 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
158 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
159 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
160 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
161 + *** 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.
162 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
163 +* Open the ubuntu terminal, and finish the installation.
164 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
165 +* Go to the next section around installing the eMagiz Docker agent
166 +
167 +===3.6 Installation requirements Windows Server 2012 R2 ===
168 +
169 +These are the requirements to allow the installation of the eMagiz Docker agent:
170 +* Install & enable Hyper-V in Windows Server
171 + ** 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.
172 + ** Restart windows
173 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
174 +* Create a VM in HyperV.
175 + ** 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).
176 + ** Configure a virtual switch.
177 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
178 + ** Install an operating system from bootable CD/DVD, ISO file
179 +* Install ubuntu downloaded previously on the VM
180 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
181 +* Go to the next section around installing the eMagiz agent
182 +
183 +=== 3.7 eMagiz Docker agent installation ===
184 +
185 +eMagiz needs to install a specific agent in the Docker instance that allows to download runtime images that needs to be installed on the Docker instance. The specific command to run inside the Docker instance is specific for the machine that is configured inside eMagiz Design & Deploy Architectures. It can be found inside the eMagiz iPaaS portal under Deploy Architecture. At the runtime connector, there is a right click option called Deploy Agent. That presents either the command or the location where that agent is installed.
186 +
187 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
188 +
189 +After installing the agent, you can use the Docker cheat sheet below to see if the docker containers are running and/or images are available.
190 +
191 +== 4. Assignment ==
192 +
193 +Check out the cheatcheet for Docker command line:
194 +
195 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
196 +
197 +== 5. Key takeaways ==
198 +
199 +* 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
160 160  * eMagiz has a specific agent that manages the download of that image to the on-premises server
161 -* 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.
201 +* 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.
162 162  
163 -== 5. Suggested Additional Readings ==
164 164  
165 -* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
166 -** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
167 -* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
168 -** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
169 -* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
170 -** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
171 -*** [[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"]]
172 -*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
173 -* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
174 -** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
175 -*** [[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"]]
176 -* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
177 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
178 -*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]
179 -* [[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"]]
180 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
181 181  
205 +== 6. Suggested Additional Readings ==
206 +
207 +N/A
208 +
209 +== 7. Silent demonstration video ==
210 +
211 +N/A
212 +
182 182  )))((({{toc/}}))){{/container}}{{/container}}