Skip to Content
Last modified by Erik Bakker on 2026/04/21 12:15
From version 151.1
edited by Erik Bakker
on 2026/04/21 12:15
Change comment: There is no comment for this version
To version 19.1
edited by eMagiz
on 2022/11/11 09:27
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-premises deployment new runtime architecture
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,177 +9,102 @@
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 envirionments
13 +
16 16  == 3. On-premises deployments ==
15 +
16 +===3.1 Installation requirements Linux===
17 17  
18 -===3.1 General requirements===
18 +These are the requirements to allow the installation of the eMagiz Docker agent:
19 +* Ensure access to the following URLs is enabled
20 + ** registry.emagiz.com
21 + ** testing.emagiz.com
22 + ** Preferably the entry should be *.emagiz.com
23 +* Install latest version of Docker
19 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}}
25 +===3.2 Installation requirements Windows Server 2022===
22 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.
27 +These are the requirements to allow the installation of the eMagiz Docker agent:
28 +* Ensure access to the following URLs is enabled
29 + ** registry.emagiz.com
30 + ** testing.emagiz.com
31 + ** Preferably the entry should be *.emagiz.com
32 +* Install latest version of Docker
33 +* Validate if WSL 2.0 is properly installed
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}}
35 +===3.3 Installation requirements Windows Server 2019 version 1806===
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.
37 +These are the requirements to allow the installation of the eMagiz Docker agent:
38 +* Ensure access to the following URLs is enabled
39 + ** registry.emagiz.com
40 + ** testing.emagiz.com
41 + ** Preferably the entry should be *.emagiz.com
42 +* Enable Hyper-V in Windows Server
43 + ** 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.
44 + ** Restart windows
45 +* Install Docker Desktop on the Windows Server
46 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
47 + ** Restart windows
48 +* Update Docker desktop configuration
49 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
50 + ** Restart Docker
51 +* Open Powershell as Administrator
52 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
53 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
54 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
55 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
56 + *** 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.
57 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
58 +* Open the ubuntu terminal, and finish the installation.
59 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
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:443
55 - ** 18.184.211.189:443
56 - ** 3.123.136.31:443
57 - ** 3.66.44.69:443
58 - ** 52.57.64.170:443
59 - ** 63.182.102.95:443{{/warning}}
60 -
61 -===3.2 Installation Windows===
62 -When Windows is selected as the operating system, you need Windows Server 2022. Older Windows servers are **not** supported.
63 -
64 -==== 3.2.1 Docker Installation ====
65 -To install Docker on your machine, execute the following commands in PowerShell with administrative rights:
66 -
67 -{{code language="cmd"}}
68 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Install-update-docker/install-update-docker.ps1" -o install-update-docker-ce.ps1
69 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
70 -{{/code}}
71 -
72 -==== 3.2.2 Customization ====
73 -
74 -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"]].
75 -
76 -{{warning}}Be aware that the customization will only take effect once you have restarted the machine.{{/warning}}
77 -
78 -===== 3.2.2.1 IP address range =====
61 +===3.4 Installation requirements Windows Server 2012 R2 ===
79 79  
80 -Below is the code needed to configure a different IP address range.
63 +These are the requirements to allow the installation of the eMagiz Docker agent:
64 +* Ensure access to the following URLs is enabled
65 + ** registry.emagiz.com
66 + ** testing.emagiz.com
67 + ** Preferably the entry should be *.emagiz.com
68 +* Install & enable Hyper-V in Windows Server
69 + ** 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.
70 + ** Restart windows
71 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
72 +* Create a VM in HyperV.
73 + ** 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).
74 + ** Configure a virtual switch.
75 + ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
76 + ** Install an operating system from bootable CD/DVD, ISO file
77 +* Install ubuntu downloaded previously on the VM
78 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
79 +
80 +=== 3.5 Installation agent ===
81 +
82 +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 or is available upon request. Once that agent is installed, the image that is generated for every eMagiz release can be downloaded and installed in the Docker instance.
83 +
84 +=== 3.3 Cloud architecture for API Gateway ===
85 +
86 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-install-runtime-images.png]]
81 81  
82 -{{code language="cmd"}}
83 -cd C:\ProgramData\Docker\config\daemon.json
84 -#Add the following lines
85 -{"fixed-cidr": "<ip-address>"}
86 -{{/code}}
88 +== 4. Assignment ==
87 87  
88 -===== 3.2.2.2 Data location =====
90 +Check out the cheatcheet for Docker command line:
89 89  
90 -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:
92 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
91 91  
92 -{{code language="cmd"}}
93 -cd C:\ProgramData\Docker\config\daemon.json
94 -#Add the following lines
95 -{
96 - "data-root": "d:\\docker"
97 -}
98 -{{/code}}
94 +== 5. Key takeaways ==
99 99  
100 -{{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}}
96 +* 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
97 +* eMagiz has a specific agent that manages the download of that image to the on-premises server
98 +* 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.
101 101  
102 -==== 3.2.3 Check installation ====
103 103  
104 -After executing the commands above, the server will restart if required. After the restart, execute the following command
105 105  
106 -{{code language="cmd"}}
107 -docker ps
108 -{{/code}}
102 +== 6. Suggested Additional Readings ==
109 109  
110 -If the command returns "command not found," please run the following command again.
104 +N/A
105 +
106 +== 7. Silent demonstration video ==
111 111  
112 -{{code language="cmd"}}
113 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
114 -{{/code}}
108 +N/A
115 115  
116 -==== 3.2.3 Verify Docker functionality ====
117 -
118 -Execute the following command
119 -
120 -{{code language="cmd"}}
121 -docker ps
122 -{{/code}}
123 -
124 -The result of this call should show the following:
125 -
126 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
127 -
128 -==== 3.2.4 Install eMagiz Deploy Agent ====
129 -
130 -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"]]
131 -
132 -=== 3.3 Update Docker ===
133 -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:
134 -
135 -{{code language="cmd"}}
136 -docker version
137 -{{/code}}
138 -
139 -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:
140 -
141 -{{code language="cmd"}}
142 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
143 -{{/code}}
144 -
145 -{{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}}
146 -
147 -===3.4 Uninstall Docker===
148 -To uninstall Docker from your machine, execute the following commands in PowerShell with administrative rights:
149 -
150 -{{code language="cmd"}}
151 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
152 -{{/code}}
153 -
154 -Example usage:
155 -
156 -{{code language="cmd"}}
157 -.\uninstall-docker-ce.ps1
158 -{{/code}}
159 -
160 -== 4. Key takeaways ==
161 -
162 -* 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
163 -* eMagiz has a specific agent that manages the download of that image to the on-premises server
164 -* 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.
165 -
166 -== 5. Suggested Additional Readings ==
167 -
168 -* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
169 -** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
170 -* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
171 -** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
172 -* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
173 -** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
174 -*** [[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"]]
175 -*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
176 -* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
177 -** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
178 -*** [[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"]]
179 -* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
180 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
181 -*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]
182 -* [[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"]]
183 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
184 -
185 185  )))((({{toc/}}))){{/container}}{{/container}}