Skip to Content
Last modified by Erik Bakker on 2026/01/30 10:56
From version 3.1
edited by eMagiz
on 2022/06/24 14:59
Change comment: There is no comment for this version
To version 121.1
edited by CarlijnKokkeler
on 2024/03/28 11:00
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.CarlijnKokkeler
Content
... ... @@ -1,11 +1,8 @@
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.
3 -
2 +In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
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 -
9 9  == 1. Prerequisites ==
10 10  
11 11  * Advanced knowledge of the eMagiz platform
... ... @@ -12,49 +12,132 @@
12 12  * Good understanding of eMagiz runtimes in general
13 13  
14 14  == 2. Key concepts ==
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 -
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 +
17 17  == 3. On-premises deployments ==
18 18  
19 -===3.1 Installation requirements
20 -Below the list of requirements for an on-premises deployment
18 +===3.1 General requirements===
21 21  
22 -* Windows Server or Linux Server
23 -* Installed Docker software
24 -* Server connected to the internet whereby the firewall doesn't prevent data traffic going outwards to the Internet
25 - ** In case there are outgoing firewall rules, eMagiz can provide the specific URL's and port numbers in order to update the firewall
26 -* Sufficient resources inline with the requirements of the eMagiz runtimes. See this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-determining-needed-memory.WebHome||target="blank"]]
27 -
28 -=== 3.2 Installation agent ===
29 -
30 -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.
31 -
32 -=== 3.3 Cloud architecture for API Gateway ===
33 -
34 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-install-runtime-images.png]]
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}}
35 35  
36 -== 4. Assignment ==
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
37 37  
38 -There is no specific assignment for this microlearning.
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
39 39  
40 -== 5. Key takeaways ==
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}}
41 41  
42 -* eMagiz will help to determine the needed memory via the Design Architecture page.
43 -* eMagiz works with pre-determined sizes that are represented via an S, M, L, XL structure. Every size has a certain amount of memory available
44 -* When you exceed such a threshold you should upgrade (or downgrade) your memory in consultation with your partner manager
45 -* Overhead for OS and support functionality (auto-healing, alerting, monitoring) needs to be taken into account
46 -* Calculating memory can be challenging. Always confer with others before taking action
47 -* You can compare your calculations with the calculations of eMagiz
48 -* The calculations and logic described below are applicable for the Messaging, API Gateway and Event Streaming pattern
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.
49 49  
50 50  
55 +==== 3.2.1 Docker Installation ====
56 +To install or update docker on your machine, execute the following commands in powershell with administrative rights:
51 51  
52 -== 6. Suggested Additional Readings ==
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}}
53 53  
54 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
63 +==== 3.2.2 Check installation ====
55 55  
56 -== 7. Silent demonstration video ==
65 +After executing the commands above, the server will restart if required. After the restart, execute the following command
57 57  
58 -N/A
67 +{{code language="cmd"}}
68 +docker ps
69 +{{/code}}
59 59  
71 +If the command returns that the command cannot be found, please run the following command again.
72 +
73 +{{code language="cmd"}}
74 +.\install-docker-ce.ps1
75 +{{/code}}
76 +
77 +==== 3.2.3 Verify docker functionality ====
78 +
79 +Execute the following command
80 +
81 +{{code language="cmd"}}
82 +docker ps
83 +{{/code}}
84 +
85 +The result of this call should show the following:
86 +
87 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
88 +
89 +==== 3.2.4 Install eMagiz Deploy Agent ====
90 +
91 +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"]]
92 +
93 +===3.3 Uninstall Docker===
94 +To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
95 +
96 +{{code language="cmd"}}
97 +Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
98 +{{/code}}
99 +
100 +Example usage:
101 +
102 +{{code language="cmd"}}
103 +.\uninstall-docker-ce.ps1
104 +{{/code}}
105 +
106 +{{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"]].
107 +{{/info}}
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 +
60 60  )))((({{toc/}}))){{/container}}{{/container}}