Skip to Content
Last modified by Erik Bakker on 2026/01/23 13:45
From version 14.1
edited by eMagiz
on 2022/10/28 12:21
Change comment: There is no comment for this version
To version 95.1
edited by Erik Bakker
on 2024/02/08 17:03
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.ebakker
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,61 +12,69 @@
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 Windows Server 2019 version 1806===
18 +===3.1 General requirements===
19 +These are the general requirements to allow the installation of the eMagiz Docker agent:
20 +* Ensure access to the following URLs is enabled
21 + ** registry.emagiz.com:443
22 + ** controlplane.emagiz.com:8000
23 + ** Preferably the entry should be *.emagiz.com
20 20  
21 -Below the installation step for this version of Windows
25 +===3.2 Installation Windows===
26 +Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version or a 2019 version (> 1806). Older Windows servers are **not** supported.
22 22  
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]]
49 49  
50 -== 4. Assignment ==
29 +==== 3.2.1 Docker Installation ====
30 +In powershell with administrative rights, execute the following commands
51 51  
52 -Check out the cheatcheet for Docker command line:
53 -
54 -[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
32 +{{code language="cmd"}}
33 +Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/microsoft/Windows-Containers/Main/helpful_tools/Install-DockerCE/install-docker-ce.ps1" -o install-docker-ce.ps1
34 +.\install-docker-ce.ps1
35 +{{/code}}
55 55  
56 -== 5. Key takeaways ==
37 +==== 3.2.2 Check installation ====
57 57  
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.
39 +After executing the commands above, the server will restart if required. After the restart, execute the following command
61 61  
41 +{{code language="cmd"}}
42 +docker ps
43 +{{/code}}
62 62  
45 +If the command returns that the command cannot be found, please run the following command again.
63 63  
64 -== 6. Suggested Additional Readings ==
47 +{{code language="cmd"}}
48 +.\install-docker-ce.ps1
49 +{{/code}}
65 65  
66 -N/A
67 -
68 -== 7. Silent demonstration video ==
51 +==== 3.2.3 Verify docker functionality ====
69 69  
70 -N/A
53 +Execute the following command
71 71  
55 +{{code language="cmd"}}
56 +docker ps
57 +{{/code}}
58 +
59 +The result of this call should show the following:
60 +
61 +[[image:Main.Images.Microlearnings.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
62 +
63 +==== 3.2.4 Install eMagiz Deploy Agent ====
64 +
65 +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"]]
66 +
67 +== 4. Key takeaways ==
68 +
69 +* 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
70 +* eMagiz has a specific agent that manages the download of that image to the on-premises server
71 +* 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.
72 +
73 +== 5. Suggested Additional Readings ==
74 +
75 +* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
76 +
72 72  )))((({{toc/}}))){{/container}}{{/container}}