Skip to Content
Last modified by Erik Bakker on 2026/01/30 10:56
From version 122.1
edited by CarlijnKokkeler
on 2024/03/28 11:01
Change comment: There is no comment for this version
To version 13.1
edited by eMagiz
on 2022/10/28 12:21
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.CarlijnKokkeler
1 +XWiki.eMagiz
Content
... ... @@ -1,8 +1,11 @@
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.
3 -
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 +
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 +* Last update: June 24th 2021
7 +* Required reading time: 10 minutes
8 +
6 6  == 1. Prerequisites ==
7 7  
8 8  * Advanced knowledge of the eMagiz platform
... ... @@ -9,132 +9,61 @@
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 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 +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
16 +
16 16  == 3. On-premises deployments ==
17 17  
18 -===3.1 General requirements===
19 +===3.1 Installation requirements Windows Server 2019 version 1806===
19 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
25 - ** Preferably the entry should be *.emagiz.com
26 - ** Preferably the entry should be *.kpn-dsh.com{{/info}}
21 +Below the installation step for this version of Windows
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
23 +* Enable Hyper-V in Windows Server
24 + ** 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.
25 + ** Restart windows
26 +* Install Docker Desktop on the Windows Server
27 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
28 + ** Restart windows
29 +* Update Docker desktop configuration
30 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
31 + ** Restart Docker
32 +* Open Powershell as Administrator
33 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
34 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
35 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
36 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
37 + ** 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.
38 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
39 +* Open the ubuntu terminal, and finish the installation.
40 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
41 +
42 +=== 3.2 Installation agent ===
43 +
44 +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.
45 +
46 +=== 3.3 Cloud architecture for API Gateway ===
47 +
48 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-install-runtime-images.png]]
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
50 +== 4. Assignment ==
42 42  
43 -* When using a cloudslot number **above** 125, the following configuration is needed to communicate to your JMS.
44 - ** 3.74.209.20:443
45 - ** 3.76.127.155:443
46 - ** 3.74.209.20:8443
47 - ** 3.76.127.155:8443
48 - ** 3.74.209.20:8444
49 - ** 3.76.127.155:8444{{/warning}}
52 +Check out the cheatcheet for Docker command line:
53 +
54 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
50 50  
51 -===3.2 Installation Windows===
52 -Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version. Older Windows servers are **not** supported.
56 +== 5. Key takeaways ==
53 53  
58 +* 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
59 +* eMagiz has a specific agent that manages the download of that image to the on-premises server
60 +* 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.
54 54  
55 -==== 3.2.1 Docker Installation ====
56 -To install or update docker on your machine, execute the following commands in powershell with administrative rights:
57 57  
58 -{{code language="cmd"}}
59 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/microsoft/Windows-Containers/Main/helpful_tools/Install-DockerCE/install-docker-ce.ps1" -o install-docker-ce.ps1
60 -.\install-docker-ce.ps1
61 -{{/code}}
62 62  
63 -{{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"]].
64 -{{/info}}
64 +== 6. Suggested Additional Readings ==
65 65  
66 -==== 3.2.2 Check installation ====
66 +N/A
67 +
68 +== 7. Silent demonstration video ==
67 67  
68 -After executing the commands above, the server will restart if required. After the restart, execute the following command
70 +N/A
69 69  
70 -{{code language="cmd"}}
71 -docker ps
72 -{{/code}}
73 -
74 -If the command returns that the command cannot be found, please run the following command again.
75 -
76 -{{code language="cmd"}}
77 -.\install-docker-ce.ps1
78 -{{/code}}
79 -
80 -==== 3.2.3 Verify docker functionality ====
81 -
82 -Execute the following command
83 -
84 -{{code language="cmd"}}
85 -docker ps
86 -{{/code}}
87 -
88 -The result of this call should show the following:
89 -
90 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
91 -
92 -==== 3.2.4 Install eMagiz Deploy Agent ====
93 -
94 -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"]]
95 -
96 -===3.3 Uninstall Docker===
97 -To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
98 -
99 -{{code language="cmd"}}
100 -Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
101 -{{/code}}
102 -
103 -Example usage:
104 -
105 -{{code language="cmd"}}
106 -.\uninstall-docker-ce.ps1
107 -{{/code}}
108 -
109 -{{info}}
110 -By default the docker daemon configuration file is located in the docker data path at {{code language="cmd"}}C:\ProgramData\docker\config\daemon.json{{/code}}.
111 -To check the configuration options and compatible options with Windows you can check: [[Configure Docker in Windows>>https://learn.microsoft.com/en-us/virtualization/windowscontainers/manage-docker/configure-docker-daemon||target="blank"]].
112 -
113 -{{warning}}
114 -Ignore the Uninstall section as it is outdated (For Windows Server 2016), instead refer to the previous section to Uninstall docker
115 -{{/warning}}
116 -
117 -**Example usage of the Docker daemon file**: You maybe want the Docker daemon to keep images and containers in an alternate path (D:
118 -drive for example). To do so you can add the following attribute to the Docker daemon file:
119 -
120 -{{code language="cmd"}}
121 -{
122 - "data-root": "d:\\docker"
123 -}
124 -{{/code}}
125 -
126 -If not specified, the default is {{code language="cmd"}}c:\programdata\docker{{/code}}
127 -
128 -{{/info}}
129 -
130 -== 4. Key takeaways ==
131 -
132 -* 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
133 -* eMagiz has a specific agent that manages the download of that image to the on-premises server
134 -* 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.
135 -
136 -== 5. Suggested Additional Readings ==
137 -
138 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
139 -
140 140  )))((({{toc/}}))){{/container}}{{/container}}