Skip to Content
Last modified by Erik Bakker on 2026/01/30 10:56
From version 31.1
edited by eMagiz
on 2022/11/28 14:12
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
Title
... ... @@ -1,1 +1,1 @@
1 -On-premises deployment new runtime architecture
1 +Install Docker for Windows
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.eMagiz
1 +XWiki.ebakker
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
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.
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,108 +9,168 @@
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.
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 -
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 +
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 -
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
23 - ** testing.emagiz.com
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.
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
24 24   ** Preferably the entry should be *.emagiz.com
32 + ** Preferably the entry should be *.kpn-dsh.com{{/info}}
25 25  
26 -
27 -===3.2 Installation requirements Linux===
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}}
28 28  
29 -* Whenever Linux is selected as operating system, the latest version of Ubuntu will work
30 -* Install latest version of the Docker engine - see for instance https://docs.docker.com/engine/install/ubuntu/
31 -* Go to the next section around installing the eMagiz agent
32 32  
33 -===3.3 Installation requirements Windows Server 2022===
34 34  
35 -These are the requirements to allow the installation of the eMagiz Docker agent:
36 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
37 -* Validate if WSL 2.0 is properly installed
38 -* Go to the next section around installing the eMagiz Docker agent
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.
39 39  
40 -===3.4 Installation requirements Windows Server 2019 version >1806===
57 +==== 3.2.1 Docker Installation ====
58 +To install Docker on your machine, execute the following commands in PowerShell with administrative rights:
41 41  
42 -These are the requirements to allow the installation of the eMagiz Docker agent:
43 -* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
44 -* Validate if WSL 2.0 is properly installed
45 -* Go to the next section around installing the eMagiz Docker agent
60 +{{code language="cmd"}}
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
63 +{{/code}}
64 +
65 +==== 3.2.2 Customization ====
66 +
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 =====
46 46  
47 -===3.5 Installation requirements Windows Server 2019 version 1806===
73 +Below is the code needed to configure a different IP address range.
48 48  
49 -These are the requirements to allow the installation of the eMagiz Docker agent:
50 -* Enable Hyper-V in Windows Server
51 - ** 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.
52 - ** Restart windows
53 -* Cross check is WSL 2.0 is installed
54 - ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
55 -* Install Docker Desktop on the Windows Server
56 - ** Please refer to this link: https://www.docker.com/products/docker-desktop/
57 - ** Restart windows
58 -* Update Docker Desktop configuration
59 - ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
60 - ** Restart Docker
61 -* Open Powershell as Administrator
62 - ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
63 - ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
64 - ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
65 - ** Execute Add-AppxPackage .\ubuntu-2004.appx
66 - *** 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.
67 -* Ubuntu should now be a runnable program (press windows key, type ubuntu)
68 -* Open the ubuntu terminal, and finish the installation.
69 - ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
70 -* Go to the next section around installing the eMagiz Docker agent
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 =====
71 71  
72 -===3.6 Installation requirements Windows Server 2012 R2 ===
73 -
74 -These are the requirements to allow the installation of the eMagiz Docker agent:
75 -* Install & enable Hyper-V in Windows Server
76 - ** 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.
77 - ** Restart windows
78 -* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
79 -* Create a VM in HyperV.
80 - ** 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).
81 - ** Configure a virtual switch.
82 - ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
83 - ** Install an operating system from bootable CD/DVD, ISO file
84 -* Install ubuntu downloaded previously on the VM
85 -* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
86 -* Go to the next section around installing the eMagiz agent
87 -
88 -=== 3.7 eMagiz Docker agent installation ===
89 -
90 -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 when the machine is used for the first time deployment of eMagiz runtimes. A popup will appear that displays the commands per type of OS. Once that agent is installed, the image that is generated for every eMagiz release can be downloaded and installed in the Docker instance.
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:
91 91  
92 -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.
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}}
93 93  
94 -== 4. Assignment ==
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}}
95 95  
96 -Check out the cheatcheet for Docker command line:
97 -
98 -[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
95 +==== 3.2.3 Check installation ====
99 99  
100 -== 5. Key takeaways ==
97 +After executing the commands above, the server will restart if required. After the restart, execute the following command
101 101  
102 -* 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
103 -* eMagiz has a specific agent that manages the download of that image to the on-premises server
104 -* 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.
99 +{{code language="cmd"}}
100 +docker ps
101 +{{/code}}
105 105  
103 +If the command returns "command not found," please run the following command again.
106 106  
105 +{{code language="cmd"}}
106 +.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
107 +{{/code}}
107 107  
108 -== 6. Suggested Additional Readings ==
109 +==== 3.2.3 Verify Docker functionality ====
109 109  
110 -N/A
111 -
112 -== 7. Silent demonstration video ==
111 +Execute the following command
113 113  
114 -N/A
113 +{{code language="cmd"}}
114 +docker ps
115 +{{/code}}
115 115  
117 +The result of this call should show the following:
118 +
119 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
120 +
121 +==== 3.2.4 Install eMagiz Deploy Agent ====
122 +
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"]]
124 +
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 +
151 +== 4. Key takeaways ==
152 +
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
154 +* eMagiz has a specific agent that manages the download of that image to the on-premises server
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.
156 +
157 +== 5. Suggested Additional Readings ==
158 +
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"]]
174 +* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
175 +
116 116  )))((({{toc/}}))){{/container}}{{/container}}