Skip to Content
Last modified by Erik Bakker on 2026/01/23 13:45
From version 95.1
edited by Erik Bakker
on 2024/02/08 17:03
Change comment: There is no comment for this version
To version 142.1
edited by Erik Bakker
on 2026/01/23 12:50
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
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.
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -9,7 +9,7 @@
9 9  * Good understanding of eMagiz runtimes in general
10 10  
11 11  == 2. Key concepts ==
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.
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 13  
14 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 15  
... ... @@ -16,26 +16,84 @@
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 -These are the general requirements to allow the installation of the eMagiz Docker agent:
20 -* Ensure access to the following URLs is enabled
19 +
20 +{{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"]].
21 +{{/info}}
22 +
23 +{{info}}
24 +* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
21 21   ** registry.emagiz.com:443
22 - ** controlplane.emagiz.com:8000
26 + ** controlplane.emagiz.com:443
27 + ** controlplane-agent.emagiz.com:443
28 + ** controltower.emagiz.com:443
29 + ** controltower.kpn-dsh.com:443
30 + ** controlbus.emagiz.com:443
23 23   ** Preferably the entry should be *.emagiz.com
32 + ** Preferably the entry should be *.kpn-dsh.com{{/info}}
24 24  
25 -===3.2 Installation Windows===
26 -Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version or a 2019 version (> 1806). Older Windows servers are **not** supported.
34 +{{warning}}
35 +* When using **IP Whitelisting**, the following configuration is needed to communicate to your JMS.
36 + ** 35.158.46.28:443
37 + ** 3.74.190.88:443
38 + ** 35.158.46.28:8443
39 + ** 3.74.190.88:8443
40 + ** 35.158.46.28:8444
41 + ** 3.74.190.88:8444
42 + ** 3.74.209.20:443
43 + ** 3.76.127.155:443
44 + ** 3.74.209.20:8443
45 + ** 3.76.127.155:8443
46 + ** 3.74.209.20:8444
47 + ** 3.76.127.155:8444
48 + ** 18.199.123.240
49 + ** 18.184.211.189
50 + ** 3.123.136.31{{/warning}}
27 27  
28 28  
53 +
54 +===3.2 Installation Windows===
55 +When Windows is selected as the operating system, you need Windows Server 2022. Older Windows servers are **not** supported.
56 +
29 29  ==== 3.2.1 Docker Installation ====
30 -In powershell with administrative rights, execute the following commands
58 +To install Docker on your machine, execute the following commands in PowerShell with administrative rights:
31 31  
32 32  {{code language="cmd"}}
33 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/microsoft/Windows-Containers/Main/helpful_tools/Install-DockerCE/install-docker-ce.ps1" -o install-docker-ce.ps1
34 -.\install-docker-ce.ps1
61 +Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Install-update-docker/install-update-docker.ps1" -o install-update-docker-ce.ps1
62 +.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
35 35  {{/code}}
36 36  
37 -==== 3.2.2 Check installation ====
65 +==== 3.2.2 Customization ====
38 38  
67 +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"]].
68 +
69 +{{warning}}Be aware that the customization will only take effect once you have restarted the machine.{{/warning}}
70 +
71 +===== 3.2.2.1 IP address range =====
72 +
73 +Below is the code needed to configure a different IP address range.
74 +
75 +{{code language="cmd"}}
76 +cd C:\ProgramData\Docker\config\daemon.json
77 +#Add the following lines
78 +{"fixed-cidr": "<ip-address>"}
79 +{{/code}}
80 +
81 +===== 3.2.2.2 Data location =====
82 +
83 +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:
84 +
85 +{{code language="cmd"}}
86 +cd C:\ProgramData\Docker\config\daemon.json
87 +#Add the following lines
88 +{
89 + "data-root": "d:\\docker"
90 +}
91 +{{/code}}
92 +
93 +{{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}}
94 +
95 +==== 3.2.3 Check installation ====
96 +
39 39  After executing the commands above, the server will restart if required. After the restart, execute the following command
40 40  
41 41  {{code language="cmd"}}
... ... @@ -42,13 +42,13 @@
42 42  docker ps
43 43  {{/code}}
44 44  
45 -If the command returns that the command cannot be found, please run the following command again.
103 +If the command returns "command not found," please run the following command again.
46 46  
47 47  {{code language="cmd"}}
48 -.\install-docker-ce.ps1
106 +.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
49 49  {{/code}}
50 50  
51 -==== 3.2.3 Verify docker functionality ====
109 +==== 3.2.3 Verify Docker functionality ====
52 52  
53 53  Execute the following command
54 54  
... ... @@ -58,20 +58,61 @@
58 58  
59 59  The result of this call should show the following:
60 60  
61 -[[image:Main.Images.Microlearnings.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
119 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
62 62  
63 63  ==== 3.2.4 Install eMagiz Deploy Agent ====
64 64  
65 -Install the eMagiz Deploy agent as can be found in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
123 +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"]]
66 66  
125 +==== 3.3 Update Docker ====
126 +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:
127 +
128 +{{code language="cmd"}}
129 +docker version
130 +{{/code}}
131 +
132 +When this returns a version **lower** than the advised version shown below, you can update Docker on your machine. To do so, execute the following command in PowerShell with administrative rights:
133 +
134 +{{code language="cmd"}}
135 +.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
136 +{{/code}}
137 +
138 +===3.4 Uninstall Docker===
139 +To uninstall Docker from your machine, execute the following commands in PowerShell with administrative rights:
140 +
141 +{{code language="cmd"}}
142 +Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
143 +{{/code}}
144 +
145 +Example usage:
146 +
147 +{{code language="cmd"}}
148 +.\uninstall-docker-ce.ps1
149 +{{/code}}
150 +
67 67  == 4. Key takeaways ==
68 68  
69 -* 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
153 +* 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
70 70  * eMagiz has a specific agent that manages the download of that image to the on-premises server
71 -* 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.
155 +* 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.
72 72  
73 73  == 5. Suggested Additional Readings ==
74 74  
159 +* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
160 +** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
161 +* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
162 +** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
163 +* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
164 +** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
165 +*** [[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"]]
166 +*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
167 +* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
168 +** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
169 +*** [[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"]]
170 +* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
171 +** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
172 +*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]
173 +* [[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"]]
75 75  * Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
76 76  
77 77  )))((({{toc/}}))){{/container}}{{/container}}