Skip to Content
Version 24.1 by eMagiz on 2022/11/11 09:45
Show last authors
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
4 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5
6 == 1. Prerequisites ==
7
8 * Advanced knowledge of the eMagiz platform
9 * Good understanding of eMagiz runtimes in general
10
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 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
16 == 3. On-premises deployments ==
17
18 ===3.1 Installation requirements Linux===
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
26 * Go to the next section around installing the eMagiz agent
27
28 ===3.2 Installation requirements Windows Server 2022===
29
30 These are the requirements to allow the installation of the eMagiz Docker agent:
31 * Ensure access to the following URLs is enabled
32 ** registry.emagiz.com
33 ** testing.emagiz.com
34 ** Preferably the entry should be *.emagiz.com
35 * Install latest version of Docker
36 * Validate if WSL 2.0 is properly installed
37 * Go to the next section around installing the eMagiz agent
38
39 ===3.2 Installation requirements Windows Server 2019 version >1806===
40
41 These are the requirements to allow the installation of the eMagiz Docker agent:
42 * Ensure access to the following URLs is enabled
43 ** registry.emagiz.com
44 ** testing.emagiz.com
45 ** Preferably the entry should be *.emagiz.com
46 * Install latest version of Docker
47 * Validate if WSL 2.0 is properly installed
48 * Go to the next section around installing the eMagiz agent
49
50
51 ===3.3 Installation requirements Windows Server 2019 version 1806===
52
53 These are the requirements to allow the installation of the eMagiz Docker agent:
54 * Ensure access to the following URLs is enabled
55 ** registry.emagiz.com
56 ** testing.emagiz.com
57 ** Preferably the entry should be *.emagiz.com
58 * Enable Hyper-V in Windows Server
59 ** 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.
60 ** Restart windows
61 * Install Docker Desktop on the Windows Server
62 ** Please refer to this link: https://www.docker.com/products/docker-desktop/
63 ** Restart windows
64 * Update Docker desktop configuration
65 ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
66 ** Restart Docker
67 * Open Powershell as Administrator
68 ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
69 ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
70 ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
71 ** Execute Add-AppxPackage .\ubuntu-2004.appx
72 *** 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.
73 * Ubuntu should now be a runnable program (press windows key, type ubuntu)
74 * Open the ubuntu terminal, and finish the installation.
75 ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
76 * Go to the next section around installing the eMagiz agent
77
78 ===3.4 Installation requirements Windows Server 2012 R2 ===
79
80 These are the requirements to allow the installation of the eMagiz Docker agent:
81 * Ensure access to the following URLs is enabled
82 ** registry.emagiz.com
83 ** testing.emagiz.com
84 ** Preferably the entry should be *.emagiz.com
85 * Install & enable Hyper-V in Windows Server
86 ** 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.
87 ** Restart windows
88 * Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
89 * Create a VM in HyperV.
90 ** 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).
91 ** Configure a virtual switch.
92 ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
93 ** Install an operating system from bootable CD/DVD, ISO file
94 * Install ubuntu downloaded previously on the VM
95 * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
96 * Go to the next section around installing the eMagiz agent
97
98 === 3.5 eMagiz agent installation agent ===
99
100 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.
101
102 After installing the agent, validate it runs by checking if a docker container runs on ubuntu.
103 * wget https://download.docker.com/linux/static/stable/x86_64/docker-20.10.5.tgz
104 * tar zxvf docker-20.10.5.tgz
105 * cd docker
106 * ./docker psg
107
108
109 == 4. Assignment ==
110
111 Check out the cheatcheet for Docker command line:
112
113 [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
114
115 == 5. Key takeaways ==
116
117 * 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
118 * eMagiz has a specific agent that manages the download of that image to the on-premises server
119 * 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.
120
121
122
123 == 6. Suggested Additional Readings ==
124
125 N/A
126
127 == 7. Silent demonstration video ==
128
129 N/A
130
131 )))((({{toc/}}))){{/container}}{{/container}}