Skip to Content
Last modified by Erik Bakker on 2025/10/19 21:14
From version 26.1
edited by eMagiz
on 2022/11/15 14:51
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  
... ... @@ -10,104 +10,83 @@
10 10  
11 11  == 2. Key concepts ==
12 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 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 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 -
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 17  
18 18  ===3.1 General requirements===
19 -
20 -These are the general 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 -
26 -===3.2 Installation requirements Linux===
27 27  
28 -* Install latest version of Docker
29 -* Go to the next section around installing the eMagiz agent
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}}
30 30  
31 -===3.3 Installation requirements Windows Server 2022===
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
32 32  
33 -These are the requirements to allow the installation of the eMagiz Docker agent:
34 -* Install latest version of Docker
35 -* Validate if WSL 2.0 is properly installed
36 -* Go to the next section around installing the eMagiz agent
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}}
37 37  
38 -===3.4 Installation requirements Windows Server 2019 version >1806===
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.
39 39  
40 -These are the requirements to allow the installation of the eMagiz Docker agent:
41 -* Install latest version of Docker
42 -* Validate if WSL 2.0 is properly installed
43 -* Go to the next section around installing the eMagiz agent
44 -
45 -
46 -===3.5 Installation requirements Windows Server 2019 version 1806===
47 47  
48 -These are the requirements to allow the installation of the eMagiz Docker agent:
49 -* Enable Hyper-V in Windows Server
50 - ** 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.
51 - ** Restart windows
52 -* Install Docker Desktop on the Windows Server
53 - ** Please refer to this link: https://www.docker.com/products/docker-desktop/
54 - ** Restart windows
55 -* Update Docker Desktop configuration
56 - ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
57 - ** Restart Docker
58 -* Open Powershell as Administrator
59 - ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
60 - ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
61 - ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
62 - ** Execute Add-AppxPackage .\ubuntu-2004.appx
63 - *** 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.
64 -* Ubuntu should now be a runnable program (press windows key, type ubuntu)
65 -* Open the ubuntu terminal, and finish the installation.
66 - ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
67 -* Go to the next section around installing the eMagiz agent
68 -
69 -===3.6 Installation requirements Windows Server 2012 R2 ===
70 -
71 -These are the requirements to allow the installation of the eMagiz Docker agent:
72 -* Install & enable Hyper-V in Windows Server
73 - ** 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.
74 - ** Restart windows
75 -* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
76 -* Create a VM in HyperV.
77 - ** 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).
78 - ** Configure a virtual switch.
79 - ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
80 - ** Install an operating system from bootable CD/DVD, ISO file
81 -* Install ubuntu downloaded previously on the VM
82 -* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
83 -* Go to the next section around installing the eMagiz agent
84 -
85 -=== 3.7 eMagiz agent installation agent ===
86 -
87 -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 when the machine is used for the first time deployment of eMagiz runtimes. A popup will appear that displays the commands per type of OS. Once that agent is installed, the image that is generated for every eMagiz release can be downloaded and installed in the Docker instance.
44 +==== 3.2.1 Docker Installation ====
45 +In powershell with administrative rights, execute the following commands
88 88  
89 -After installing the agent, you can use the Docker cheat sheet below to see if the docker containers are running and/or images are available.
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}}
90 90  
91 -== 4. Assignment ==
52 +==== 3.2.2 Check installation ====
92 92  
93 -Check out the cheatcheet for Docker command line:
94 -
95 -[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
54 +After executing the commands above, the server will restart if required. After the restart, execute the following command
96 96  
97 -== 5. Key takeaways ==
56 +{{code language="cmd"}}
57 +docker ps
58 +{{/code}}
98 98  
99 -* 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
100 -* eMagiz has a specific agent that manages the download of that image to the on-premises server
101 -* 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.
60 +If the command returns that the command cannot be found, please run the following command again.
102 102  
62 +{{code language="cmd"}}
63 +.\install-docker-ce.ps1
64 +{{/code}}
103 103  
66 +==== 3.2.3 Verify docker functionality ====
104 104  
105 -== 6. Suggested Additional Readings ==
68 +Execute the following command
106 106  
107 -N/A
108 -
109 -== 7. Silent demonstration video ==
70 +{{code language="cmd"}}
71 +docker ps
72 +{{/code}}
110 110  
111 -N/A
74 +The result of this call should show the following:
112 112  
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 +
113 113  )))((({{toc/}}))){{/container}}{{/container}}