Skip to Content
Last modified by Erik Bakker on 2026/01/30 10:56
From version 116.1
edited by CarlijnKokkeler
on 2024/03/28 10:52
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.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,118 +9,101 @@
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===
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
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===
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}}
37 +These are the requirements to allow the installation of the eMagiz Docker agent:
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.
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
61 +
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]]
53 53  
87 +== 4. Assignment ==
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:
89 +Check out the cheatcheet for Docker command line:
90 +
91 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
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}}
93 +== 5. Key takeaways ==
62 62  
63 -==== 3.2.2 Check installation ====
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.
64 64  
65 -After executing the commands above, the server will restart if required. After the restart, execute the following command
66 66  
67 -{{code language="cmd"}}
68 -docker ps
69 -{{/code}}
70 70  
71 -If the command returns that the command cannot be found, please run the following command again.
101 +== 6. Suggested Additional Readings ==
72 72  
73 -{{code language="cmd"}}
74 -.\install-docker-ce.ps1
75 -{{/code}}
103 +N/A
104 +
105 +== 7. Silent demonstration video ==
76 76  
77 -==== 3.2.3 Verify docker functionality ====
107 +N/A
78 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.
107 -{{/info}}
108 -
109 -{{info}}
110 -Docker daemon configuration
111 -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}}.
112 -To check the configuration options and compatible options with Windows you can check: [Configure Docker in Windows (xmlStat.xsd)>>https://learn.microsoft.com/en-us/virtualization/windowscontainers/manage-docker/configure-docker-daemon||target="blank"]]
113 -
114 -{{/info}}
115 -
116 -== 4. Key takeaways ==
117 -
118 -* 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
119 -* eMagiz has a specific agent that manages the download of that image to the on-premises server
120 -* 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.
121 -
122 -== 5. Suggested Additional Readings ==
123 -
124 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
125 -
126 126  )))((({{toc/}}))){{/container}}{{/container}}