Skip to Content
Last modified by Erik Bakker on 2026/01/30 10:56
From version 24.1
edited by eMagiz
on 2022/11/11 09:45
Change comment: There is no comment for this version
To version 136.1
edited by Erik Bakker
on 2024/11/29 08:30
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,123 +9,164 @@
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 envirionments.
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.5 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 -
18 -===3.1 Installation requirements Linux===
19 19  
20 -These are the 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
18 +===3.1 General requirements===
19 +
20 +{{info}}
21 +* Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
22 + ** registry.emagiz.com:443
23 + ** controlplane.emagiz.com:8000
24 + ** controltower.kpn-dsh.com:443
24 24   ** Preferably the entry should be *.emagiz.com
25 -* Install latest version of Docker
26 -* Go to the next section around installing the eMagiz agent
26 + ** Preferably the entry should be *.kpn-dsh.com{{/info}}
27 27  
28 -===3.2 Installation requirements Windows Server 2022===
28 +{{warning}}
29 +* In case of a very strict firewall configuration, additional configuration is needed to communicate to the eMagiz infrastructure.
30 + ** controltower.emagiz.com:443
31 + ** controltower.kpn-dsh.com:443
32 + ** controlbus.emagiz.com:443
33 + ** controlplane.emagiz.com:443
29 29  
30 -These are the requirements to allow the installation of the eMagiz Docker agent:
31 -* Ensure access to the following URLs is enabled
32 - ** registry.emagiz.com
33 - ** testing.emagiz.com
34 - ** Preferably the entry should be *.emagiz.com
35 -* Install latest version of Docker
36 -* Validate if WSL 2.0 is properly installed
37 -* Go to the next section around installing the eMagiz agent
35 +* When using cloudslot number **equal to or below** 125, 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 + ** 18.199.123.240
43 + ** 18.184.211.189
44 + ** 3.123.136.31
38 38  
39 - ===3.2 Installation requirements Windows Server 2019 version >1806===
46 +* When using a cloudslot number **above** 125, the following configuration is needed to communicate to your JMS.
47 + ** 3.74.209.20:443
48 + ** 3.76.127.155:443
49 + ** 3.74.209.20:8443
50 + ** 3.76.127.155:8443
51 + ** 3.74.209.20:8444
52 + ** 3.76.127.155:8444
53 + ** 18.199.123.240
54 + ** 18.184.211.189
55 + ** 3.123.136.31{{/warning}}
40 40  
41 -These are the requirements to allow the installation of the eMagiz Docker agent:
42 -* Ensure access to the following URLs is enabled
43 - ** registry.emagiz.com
44 - ** testing.emagiz.com
45 - ** Preferably the entry should be *.emagiz.com
46 -* Install latest version of Docker
47 -* Validate if WSL 2.0 is properly installed
48 -* Go to the next section around installing the eMagiz agent
57 +===3.2 Installation Windows===
58 +Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version. Older Windows servers are **not** supported.
59 +
60 +
61 +==== 3.2.1 Docker Installation ====
62 +To install or update docker on your machine, execute the following commands in powershell with administrative rights:
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 +
69 +{{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 to align the on-premise Docker version and update it according to the release notes of the [[Cloud templates>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]].
70 +{{/info}}
71 +
72 +==== 3.2.2 Customization ====
73 +
74 +After installing Docker you have the option to stick with the standard configuration of Docker or you can opt to alter some specific settings. Settings that can be of particular interest are the setting that defines the IP address range your Docker installation will use to run the containers and the setting 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 Docker.{{/warning}}
77 +
78 +===== 3.2.2.1 IP address range =====
49 49  
50 -
51 -===3.3 Installation requirements Windows Server 2019 version 1806===
80 +Below you can find the recommended values depending on the range which can be filled in the value <ip-address> below:
81 +* 10.0.0.1/8
82 +** advised value 10.25.0.1/16
83 +* 172.16.0.1/12
84 +** advised value 172.16.0.1/16
85 +* 192.168.0.1/16
86 +** advised value 192.168.0.1/16
52 52  
53 -These are the requirements to allow the installation of the eMagiz Docker agent:
54 -* Ensure access to the following URLs is enabled
55 - ** registry.emagiz.com
56 - ** testing.emagiz.com
57 - ** Preferably the entry should be *.emagiz.com
58 -* Enable Hyper-V in Windows Server
59 - ** 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.
60 - ** Restart windows
61 -* Install Docker Desktop on the Windows Server
62 - ** Please refer to this link: https://www.docker.com/products/docker-desktop/
63 - ** Restart windows
64 -* Update Docker desktop configuration
65 - ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
66 - ** Restart Docker
67 -* Open Powershell as Administrator
68 - ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
69 - ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
70 - ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
71 - ** Execute Add-AppxPackage .\ubuntu-2004.appx
72 - *** 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.
73 -* Ubuntu should now be a runnable program (press windows key, type ubuntu)
74 -* Open the ubuntu terminal, and finish the installation.
75 - ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
76 -* Go to the next section around installing the eMagiz agent
88 +{{code language="cmd"}}
89 +sudo nano /etc/docker/daemon.json
90 +#Add following lines
91 +{"bip": "<ip-address>"}
92 +{{/code}}
77 77  
78 -===3.4 Installation requirements Windows Server 2012 R2 ===
94 +===== 3.2.2.2 Data location =====
79 79  
80 -These are the requirements to allow the installation of the eMagiz Docker agent:
81 -* Ensure access to the following URLs is enabled
82 - ** registry.emagiz.com
83 - ** testing.emagiz.com
84 - ** Preferably the entry should be *.emagiz.com
85 -* Install & enable Hyper-V in Windows Server
86 - ** 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.
87 - ** Restart windows
88 -* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
89 -* Create a VM in HyperV.
90 - ** 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).
91 - ** Configure a virtual switch.
92 - ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
93 - ** Install an operating system from bootable CD/DVD, ISO file
94 -* Install ubuntu downloaded previously on the VM
95 -* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
96 -* Go to the next section around installing the eMagiz agent
97 -
98 -=== 3.5 eMagiz agent installation agent ===
99 -
100 -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.
96 +Below you can find an example of switching from the default C directory ({{code language="cmd"}}c:\programdata\docker{{/code}}) to the D directory to store data related to Docker. Based on your internal configuration you can choose the best suitable variant if that is needed. To do so you can add the following attribute to the Docker daemon file:
101 101  
102 -After installing the agent, validate it runs by checking if a docker container runs on ubuntu.
103 -* wget https://download.docker.com/linux/static/stable/x86_64/docker-20.10.5.tgz
104 -* tar zxvf docker-20.10.5.tgz
105 -* cd docker
106 -* ./docker psg
98 +{{code language="cmd"}}
99 +{
100 + "data-root": "d:\\docker"
101 +}
102 +{{/code}}
107 107  
104 +==== 3.2.3 Check installation ====
108 108  
109 -== 4. Assignment ==
106 +After executing the commands above, the server will restart if required. After the restart, execute the following command
110 110  
111 -Check out the cheatcheet for Docker command line:
112 -
113 -[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
108 +{{code language="cmd"}}
109 +docker ps
110 +{{/code}}
114 114  
115 -== 5. Key takeaways ==
112 +If the command returns that the command cannot be found, please run the following command again.
116 116  
117 -* 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
118 -* eMagiz has a specific agent that manages the download of that image to the on-premises server
119 -* 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.
114 +{{code language="cmd"}}
115 +.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
116 +{{/code}}
120 120  
118 +==== 3.2.3 Verify docker functionality ====
121 121  
120 +Execute the following command
122 122  
123 -== 6. Suggested Additional Readings ==
122 +{{code language="cmd"}}
123 +docker ps
124 +{{/code}}
124 124  
125 -N/A
126 -
127 -== 7. Silent demonstration video ==
126 +The result of this call should show the following:
128 128  
129 -N/A
128 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
130 130  
130 +==== 3.2.4 Install eMagiz Deploy Agent ====
131 +
132 +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"]]
133 +
134 +===3.3 Uninstall Docker===
135 +To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
136 +
137 +{{code language="cmd"}}
138 +Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
139 +{{/code}}
140 +
141 +Example usage:
142 +
143 +{{code language="cmd"}}
144 +.\uninstall-docker-ce.ps1
145 +{{/code}}
146 +
147 +== 4. Key takeaways ==
148 +
149 +* 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
150 +* eMagiz has a specific agent that manages the download of that image to the on-premises server
151 +* 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.
152 +
153 +== 5. Suggested Additional Readings ==
154 +
155 +* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
156 +** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
157 +* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
158 +** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
159 +* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
160 +** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
161 +*** [[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"]]
162 +*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
163 +* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
164 +** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
165 +*** [[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"]]
166 +* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
167 +** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
168 +*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]
169 +* [[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"]]
170 +* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
171 +
131 131  )))((({{toc/}}))){{/container}}{{/container}}