Skip to Content
Version 25.1 by eMagiz on 2022/11/15 14: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 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
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 ===3.2 Installation requirements Linux===
27
28 * Install latest version of Docker
29 * Go to the next section around installing the eMagiz agent
30
31 ===3.2 Installation requirements Windows Server 2022===
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
37
38 ===3.2 Installation requirements Windows Server 2019 version >1806===
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.3 Installation requirements Windows Server 2019 version 1806===
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.4 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.5 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 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.
88
89 After installing the agent, validate it runs by checking if a docker container runs on ubuntu.
90 * wget https://download.docker.com/linux/static/stable/x86_64/docker-20.10.5.tgz
91 * tar zxvf docker-20.10.5.tgz
92 * cd docker
93 * ./docker psg
94
95
96 == 4. Assignment ==
97
98 Check out the cheatcheet for Docker command line:
99
100 [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
101
102 == 5. Key takeaways ==
103
104 * 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
105 * eMagiz has a specific agent that manages the download of that image to the on-premises server
106 * 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.
107
108
109
110 == 6. Suggested Additional Readings ==
111
112 N/A
113
114 == 7. Silent demonstration video ==
115
116 N/A
117
118 )))((({{toc/}}))){{/container}}{{/container}}