Skip to Content
Last modified by Erik Bakker on 2026/01/30 10:56
From version 119.1
edited by CarlijnKokkeler
on 2024/03/28 10:59
Change comment: There is no comment for this version
To version 17.1
edited by eMagiz
on 2022/11/11 09:20
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,5 +1,5 @@
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.
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,132 +9,85 @@
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 -
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===
18 +* Ensure access to the following URLs is enabled
19 + ** registry.emagiz.com
20 + ** testing.emagiz.com
21 + ** Preferably the entry should be *.emagiz.com
22 +* Install latest version of Docker
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
24 +===3.2 Installation requirements Windows Server 2022===
25 +
26 +* Ensure access to the following URLs is enabled
27 + ** registry.emagiz.com
28 + ** testing.emagiz.com
25 25   ** Preferably the entry should be *.emagiz.com
26 - ** Preferably the entry should be *.kpn-dsh.com{{/info}}
30 +* Install latest version of Docker
31 +* Validate if WSL 2.0 is properly installed
32 +
33 +===3.3 Installation requirements Windows Server 2019 version 1806===
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
35 +Below the installation step for this version of Windows
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
37 +* Ensure access to the following URLs is enabled
38 + ** registry.emagiz.com
39 + ** testing.emagiz.com
40 + ** Preferably the entry should be *.emagiz.com
41 +* Enable Hyper-V in Windows Server
42 + ** 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.
43 + ** Restart windows
44 +* Install Docker Desktop on the Windows Server
45 + ** Please refer to this link: https://www.docker.com/products/docker-desktop/
46 + ** Restart windows
47 +* Update Docker desktop configuration
48 + ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
49 + ** Restart Docker
50 +* Open Powershell as Administrator
51 + ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
52 + ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
53 + ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
54 + ** Execute Add-AppxPackage .\ubuntu-2004.appx
55 + *** 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.
56 +* Ubuntu should now be a runnable program (press windows key, type ubuntu)
57 +* Open the ubuntu terminal, and finish the installation.
58 + ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
59 +
60 +===3.4 Installation requirements Windows Server 2012 R2 ===
61 +
62 +
63 +=== 3.5 Installation agent ===
64 +
65 +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.
66 +
67 +=== 3.3 Cloud architecture for API Gateway ===
68 +
69 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-install-runtime-images.png]]
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}}
71 +== 4. Assignment ==
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.
73 +Check out the cheatcheet for Docker command line:
74 +
75 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
53 53  
77 +== 5. Key takeaways ==
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:
79 +* 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
80 +* eMagiz has a specific agent that manages the download of that image to the on-premises server
81 +* 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.
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 -==== 3.2.2 Check installation ====
64 64  
65 -After executing the commands above, the server will restart if required. After the restart, execute the following command
85 +== 6. Suggested Additional Readings ==
66 66  
67 -{{code language="cmd"}}
68 -docker ps
69 -{{/code}}
87 +N/A
88 +
89 +== 7. Silent demonstration video ==
70 70  
71 -If the command returns that the command cannot be found, please run the following command again.
91 +N/A
72 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[[Cloud templates>>doc:Main.eMagiz Academy.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 -
140 140  )))((({{toc/}}))){{/container}}{{/container}}