Skip to Content
Last modified by Erik Bakker on 2026/01/30 10:56
From version 138.1
edited by Erik Bakker
on 2024/11/29 08:37
Change comment: There is no comment for this version
To version 18.1
edited by eMagiz
on 2022/11/11 09:25
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,162 +9,101 @@
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===
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
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
25 25   ** Preferably the entry should be *.emagiz.com
26 - ** Preferably the entry should be *.kpn-dsh.com{{/info}}
23 +* Install latest version of Docker
27 27  
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
25 +===3.2 Installation requirements Windows Server 2022===
34 34  
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
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
34 +
35 +===3.3 Installation requirements Windows Server 2019 version 1806===
45 45  
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}}
37 +These are the requirements to allow the installation of the eMagiz Docker agent:
56 56  
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 the machine.{{/warning}}
77 -
78 -===== 3.2.2.1 IP address range =====
39 +* Ensure access to the following URLs is enabled
40 + ** registry.emagiz.com
41 + ** testing.emagiz.com
42 + ** Preferably the entry should be *.emagiz.com
43 +* Enable Hyper-V in Windows Server
44 + ** 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.
45 + ** Restart windows
46 +* Install Docker Desktop on the Windows Server
47 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
48 + ** Restart windows
49 +* Update Docker desktop configuration
50 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
51 + ** Restart Docker
52 +* Open Powershell as Administrator
53 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
54 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
55 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
56 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
57 + *** 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.
58 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
59 +* Open the ubuntu terminal, and finish the installation.
60 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
79 79  
80 -Below you can find the code necessary to configure a different IP address range.
62 +===3.4 Installation requirements Windows Server 2012 R2 ===
63 +
64 +These are the requirements to allow the installation of the eMagiz Docker agent:
65 +* Ensure access to the following URLs is enabled
66 + ** registry.emagiz.com
67 + ** testing.emagiz.com
68 + ** Preferably the entry should be *.emagiz.com
69 +* Install & enable Hyper-V in Windows Server
70 + ** 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.
71 + ** Restart windows
72 +* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
73 +* Create a VM in HyperV.
74 + ** 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).
75 + ** Configure a virtual switch. Add a virtual Hard Disk with proper sizing (e.g. 30 GB), install an operating system from bootable CD/DVD, ISO file
76 +* Install ubuntu downloaded previously on the VM
77 +* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
78 +
79 +=== 3.5 Installation agent ===
80 +
81 +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.
82 +
83 +=== 3.3 Cloud architecture for API Gateway ===
84 +
85 +[[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 following lines
85 -{"fixed-cidr": "<ip-address>"}
86 -{{/code}}
87 +== 4. Assignment ==
87 87  
88 -===== 3.2.2.2 Data location =====
89 +Check out the cheatcheet for Docker command line:
89 89  
90 -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:
91 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
91 91  
92 -{{code language="cmd"}}
93 -cd C:\ProgramData\Docker\config\daemon.json
94 -#Add following lines
95 -{
96 - "data-root": "d:\\docker"
97 -}
98 -{{/code}}
93 +== 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}}
95 +* 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
96 +* eMagiz has a specific agent that manages the download of that image to the on-premises server
97 +* 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}}
101 +== 6. Suggested Additional Readings ==
109 109  
110 -If the command returns that the command cannot be found, please run the following command again.
103 +N/A
104 +
105 +== 7. Silent demonstration video ==
111 111  
112 -{{code language="cmd"}}
113 -.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
114 -{{/code}}
107 +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 can be found 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 Uninstall Docker===
133 -To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
134 -
135 -{{code language="cmd"}}
136 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
137 -{{/code}}
138 -
139 -Example usage:
140 -
141 -{{code language="cmd"}}
142 -.\uninstall-docker-ce.ps1
143 -{{/code}}
144 -
145 -== 4. Key takeaways ==
146 -
147 -* 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
148 -* eMagiz has a specific agent that manages the download of that image to the on-premises server
149 -* 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.
150 -
151 -== 5. Suggested Additional Readings ==
152 -
153 -* [[Fundamentals (Navigation)>>doc:Main.eMagiz Academy.Fundamentals.WebHome||target="blank"]]
154 -** [[eMagiz Runtime Generation 3 (Explanation)>>doc:Main.eMagiz Academy.Fundamentals.fundamental-runtime-generation3||target="blank"]]
155 -* [[Release Information (Menu)>>doc:Main.Release Information.WebHome||target="blank"]]
156 -** [[Environment Templates (Navigation)>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]]
157 -* [[Intermediate (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.WebHome||target="blank"]]
158 -** [[eMagiz Runtime Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.WebHome||target="blank"]]
159 -*** [[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"]]
160 -*** [[eMagiz Deploy agent (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
161 -* [[Advanced (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.WebHome||target="blank"]]
162 -** [[Lifecycle Management (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Advanced Level.Lifecycle Management.WebHome||target="blank"]]
163 -*** [[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"]]
164 -* [[Expert (Menu)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.WebHome||target="blank"]]
165 -** [[Solution Architecture (Navigation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.WebHome||target="blank"]]
166 -*** [[Install Docker for Linux (Explanation)>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-onpremises-server-linux-installguide.WebHome||target="blank"]]
167 -* [[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"]]
168 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
169 -
170 170  )))((({{toc/}}))){{/container}}{{/container}}