Skip to Content
Version 31.1 by eMagiz on 2022/11/28 14:12
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 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.7 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 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
27 ===3.2 Installation requirements Linux===
28
29 * Whenever Linux is selected as operating system, the latest version of Ubuntu will work
30 * Install latest version of the Docker engine - see for instance https://docs.docker.com/engine/install/ubuntu/
31 * Go to the next section around installing the eMagiz agent
32
33 ===3.3 Installation requirements Windows Server 2022===
34
35 These are the requirements to allow the installation of the eMagiz Docker agent:
36 * Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
37 * Validate if WSL 2.0 is properly installed
38 * Go to the next section around installing the eMagiz Docker agent
39
40 ===3.4 Installation requirements Windows Server 2019 version >1806===
41
42 These are the requirements to allow the installation of the eMagiz Docker agent:
43 * Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
44 * Validate if WSL 2.0 is properly installed
45 * Go to the next section around installing the eMagiz Docker agent
46
47 ===3.5 Installation requirements Windows Server 2019 version 1806===
48
49 These are the requirements to allow the installation of the eMagiz Docker agent:
50 * Enable Hyper-V in Windows Server
51 ** 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.
52 ** Restart windows
53 * Cross check is WSL 2.0 is installed
54 ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
55 * Install Docker Desktop on the Windows Server
56 ** Please refer to this link: https://www.docker.com/products/docker-desktop/
57 ** Restart windows
58 * Update Docker Desktop configuration
59 ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
60 ** Restart Docker
61 * Open Powershell as Administrator
62 ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
63 ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
64 ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
65 ** Execute Add-AppxPackage .\ubuntu-2004.appx
66 *** 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.
67 * Ubuntu should now be a runnable program (press windows key, type ubuntu)
68 * Open the ubuntu terminal, and finish the installation.
69 ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
70 * Go to the next section around installing the eMagiz Docker agent
71
72 ===3.6 Installation requirements Windows Server 2012 R2 ===
73
74 These are the requirements to allow the installation of the eMagiz Docker agent:
75 * Install & enable Hyper-V in Windows Server
76 ** 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.
77 ** Restart windows
78 * Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
79 * Create a VM in HyperV.
80 ** 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).
81 ** Configure a virtual switch.
82 ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
83 ** Install an operating system from bootable CD/DVD, ISO file
84 * Install ubuntu downloaded previously on the VM
85 * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
86 * Go to the next section around installing the eMagiz agent
87
88 === 3.7 eMagiz Docker agent installation ===
89
90 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.
91
92 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.
93
94 == 4. Assignment ==
95
96 Check out the cheatcheet for Docker command line:
97
98 [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
99
100 == 5. Key takeaways ==
101
102 * 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
103 * eMagiz has a specific agent that manages the download of that image to the on-premises server
104 * 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.
105
106
107
108 == 6. Suggested Additional Readings ==
109
110 N/A
111
112 == 7. Silent demonstration video ==
113
114 N/A
115
116 )))((({{toc/}}))){{/container}}{{/container}}