Last modified by Erik Bakker on 2026/04/21 12:15

From version 148.1
edited by Erik Bakker
on 2026/04/21 11:58
Change comment: There is no comment for this version
To version 96.1
edited by Erik Bakker
on 2024/02/08 17:05
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 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 an on-premises server can be prepared for a eMagiz Deploy agent installation.
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 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.
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 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,88 +16,26 @@
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 -* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
19 +These are the general requirements to allow the installation of the eMagiz Docker agent:
20 +* Ensure access to the following URLs is enabled
25 25   ** registry.emagiz.com:443
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
31 - ** {yourcloudslotid}.emagizcloud.com:8443
32 -
33 -* Preferably we suggest to implement the following entries on DNS level.
34 - ** *.emagizcloud.com
35 - ** *.emagiz.com
36 - ** *.kpn-dsh.com{{/info}}
22 + ** controlplane.emagiz.com:8000
23 + ** Preferably the entry should be *.emagiz.com
37 37  
38 -{{warning}}
39 -* When using **IP Whitelisting**, the following configuration is needed to communicate to your JMS.
40 - ** 35.158.46.28:443
41 - ** 3.74.190.88:443
42 - ** 35.158.46.28:8443
43 - ** 3.74.190.88:8443
44 - ** 35.158.46.28:8444
45 - ** 3.74.190.88:8444
46 - ** 3.74.209.20:443
47 - ** 3.76.127.155:443
48 - ** 3.74.209.20:8443
49 - ** 3.76.127.155:8443
50 - ** 3.74.209.20:8444
51 - ** 3.76.127.155:8444
52 - ** 18.199.123.240
53 - ** 18.184.211.189
54 - ** 3.123.136.31{{/warning}}
55 -
56 -
57 -
58 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.
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.
60 60  
28 +
61 61  ==== 3.2.1 Docker Installation ====
62 -To install Docker on your machine, execute the following commands in PowerShell with administrative rights:
30 +In powershell with administrative rights, execute the following commands
63 63  
64 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
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
67 67  {{/code}}
68 68  
69 -==== 3.2.2 Customization ====
37 +==== 3.2.2 Check installation ====
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"]].
72 -
73 -{{warning}}Be aware that the customization will only take effect once you have restarted the machine.{{/warning}}
74 -
75 -===== 3.2.2.1 IP address range =====
76 -
77 -Below is the code needed to configure a different IP address range.
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}}
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:
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}}
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}}
98 -
99 -==== 3.2.3 Check installation ====
100 -
101 101  After executing the commands above, the server will restart if required. After the restart, execute the following command
102 102  
103 103  {{code language="cmd"}}
... ... @@ -104,13 +104,13 @@
104 104  docker ps
105 105  {{/code}}
106 106  
107 -If the command returns "command not found," please run the following command again.
45 +If the command returns that the command cannot be found, please run the following command again.
108 108  
109 109  {{code language="cmd"}}
110 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
48 +.\install-docker-ce.ps1
111 111  {{/code}}
112 112  
113 -==== 3.2.3 Verify Docker functionality ====
51 +==== 3.2.3 Verify docker functionality ====
114 114  
115 115  Execute the following command
116 116  
... ... @@ -120,63 +120,20 @@
120 120  
121 121  The result of this call should show the following:
122 122  
123 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
61 +[[image:Main.Images.Microlearnings.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
124 124  
125 125  ==== 3.2.4 Install eMagiz Deploy Agent ====
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"]]
65 +Install the eMagiz Deploy agent as can be found in this [[microlearning>>doc:Main.eMagiz Academy.Microlearning.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
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:
131 -
132 -{{code language="cmd"}}
133 -docker version
134 -{{/code}}
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:
137 -
138 -{{code language="cmd"}}
139 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
140 -{{/code}}
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}}
143 -
144 -===3.4 Uninstall Docker===
145 -To uninstall Docker from your machine, execute the following commands in PowerShell with administrative rights:
146 -
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
149 -{{/code}}
150 -
151 -Example usage:
152 -
153 -{{code language="cmd"}}
154 -.\uninstall-docker-ce.ps1
155 -{{/code}}
156 -
157 157  == 4. Key takeaways ==
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
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
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.
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.
162 162  
163 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 180  * Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
181 181  
182 182  )))((({{toc/}}))){{/container}}{{/container}}