Last modified by Erik Bakker on 2025/10/19 21:14

From version 21.1
edited by eMagiz
on 2022/11/11 09:34
Change comment: There is no comment for this version
To version 102.1
edited by Eva Torken
on 2024/03/01 15:32
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.etorken
Content
... ... @@ -1,5 +1,5 @@
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.
2 +In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -9,100 +9,84 @@
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 envirionments.
13 -
14 -In the below section the specific operating systems and versions are discussed in a sense that the prerequisite installations are described. Once the right installation is done, refer to section 3.5 for the installation of the eMagiz portainer agent that manages the interaction with the eMagiz platform. That agent will download the created docker images that will be deployed in the Docker environment.
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 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 +
16 16  == 3. On-premises deployments ==
17 -
18 -===3.1 Installation requirements Linux===
19 19  
20 -These are the requirements to allow the installation of the eMagiz Docker agent:
21 -* Ensure access to the following URLs is enabled
22 - ** registry.emagiz.com
23 - ** testing.emagiz.com
24 - ** Preferably the entry should be *.emagiz.com
25 -* Install latest version of Docker
18 +===3.1 General requirements===
26 26  
27 -===3.2 Installation requirements Windows Server 2022===
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 + ** Preferably the entry should be *.emagiz.com{{/info}}
28 28  
29 -These are the requirements to allow the installation of the eMagiz Docker agent:
30 -* Ensure access to the following URLs is enabled
31 - ** registry.emagiz.com
32 - ** testing.emagiz.com
33 - ** Preferably the entry should be *.emagiz.com
34 -* Install latest version of Docker
35 -* Validate if WSL 2.0 is properly installed
36 -
37 -===3.3 Installation requirements Windows Server 2019 version 1806===
26 +{{warning}}
27 +* In case of a very strict firewall configuration, additional configuration is needed.
28 + ** controltower.emagiz.com:443
29 + ** controlbus.emagiz.com:443
30 + ** controlplane.emagiz.com:443
38 38  
39 -These are the requirements to allow the installation of the eMagiz Docker agent:
40 -* Ensure access to the following URLs is enabled
41 - ** registry.emagiz.com
42 - ** testing.emagiz.com
43 - ** Preferably the entry should be *.emagiz.com
44 -* Enable Hyper-V in Windows Server
45 - ** 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.
46 - ** Restart windows
47 -* Install Docker Desktop on the Windows Server
48 - ** Please refer to this link: https://www.docker.com/products/docker-desktop/
49 - ** Restart windows
50 -* Update Docker desktop configuration
51 - ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
52 - ** Restart Docker
53 -* Open Powershell as Administrator
54 - ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
55 - ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
56 - ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
57 - ** Execute Add-AppxPackage .\ubuntu-2004.appx
58 - *** 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.
59 -* Ubuntu should now be a runnable program (press windows key, type ubuntu)
60 -* Open the ubuntu terminal, and finish the installation.
61 - ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
62 -
63 -===3.4 Installation requirements Windows Server 2012 R2 ===
64 -
65 -These are the requirements to allow the installation of the eMagiz Docker agent:
66 -* Ensure access to the following URLs is enabled
67 - ** registry.emagiz.com
68 - ** testing.emagiz.com
69 - ** Preferably the entry should be *.emagiz.com
70 -* Install & enable Hyper-V in Windows Server
71 - ** 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.
72 - ** Restart windows
73 -* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
74 -* Create a VM in HyperV.
75 - ** 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).
76 - ** Configure a virtual switch.
77 - ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
78 - ** Install an operating system from bootable CD/DVD, ISO file
79 -* Install ubuntu downloaded previously on the VM
80 -* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
81 -
82 -=== 3.5 Installation agent ===
83 -
84 -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.
32 +* When using cloudslot number 125 or less, the following configuration is needed.
33 + ** 35.158.46.28:443
34 + ** 3.74.190.88:443
35 + ** 35.158.46.28:8443
36 + ** 3.74.190.88:8443
37 + ** 35.158.46.28:8444
38 + ** 3.74.190.88:8444 {{/warning}}
85 85  
86 -== 4. Assignment ==
40 +===3.2 Installation Windows===
41 +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.
87 87  
88 -Check out the cheatcheet for Docker command line:
89 -
90 -[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
91 91  
92 -== 5. Key takeaways ==
44 +==== 3.2.1 Docker Installation ====
45 +In powershell with administrative rights, execute the following commands
93 93  
94 -* 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
95 -* eMagiz has a specific agent that manages the download of that image to the on-premises server
96 -* 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.
47 +{{code language="cmd"}}
48 +Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/microsoft/Windows-Containers/Main/helpful_tools/Install-DockerCE/install-docker-ce.ps1" -o install-docker-ce.ps1
49 +.\install-docker-ce.ps1
50 +{{/code}}
97 97  
52 +==== 3.2.2 Check installation ====
98 98  
54 +After executing the commands above, the server will restart if required. After the restart, execute the following command
99 99  
100 -== 6. Suggested Additional Readings ==
56 +{{code language="cmd"}}
57 +docker ps
58 +{{/code}}
101 101  
102 -N/A
103 -
104 -== 7. Silent demonstration video ==
60 +If the command returns that the command cannot be found, please run the following command again.
105 105  
106 -N/A
62 +{{code language="cmd"}}
63 +.\install-docker-ce.ps1
64 +{{/code}}
107 107  
66 +==== 3.2.3 Verify docker functionality ====
67 +
68 +Execute the following command
69 +
70 +{{code language="cmd"}}
71 +docker ps
72 +{{/code}}
73 +
74 +The result of this call should show the following:
75 +
76 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-server-windows-installguide--correct-result.png]]
77 +
78 +==== 3.2.4 Install eMagiz Deploy Agent ====
79 +
80 +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"]]
81 +
82 +== 4. Key takeaways ==
83 +
84 +* 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
85 +* eMagiz has a specific agent that manages the download of that image to the on-premises server
86 +* 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.
87 +
88 +== 5. Suggested Additional Readings ==
89 +
90 +* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
91 +
108 108  )))((({{toc/}}))){{/container}}{{/container}}