Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 21.1
edited by eMagiz
on 2022/11/11 09:34
Change comment: There is no comment for this version
To version 4.1
edited by eMagiz
on 2022/06/24 15:00
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,8 +1,11 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 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 -
3 +
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
6 +* Last update: June 24th 2021
7 +* Required reading time: 10 minutes
8 +
6 6  == 1. Prerequisites ==
7 7  
8 8  * Advanced knowledge of the eMagiz platform
... ... @@ -9,98 +9,47 @@
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.
15 +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 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 -
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
19 +===3.1 Installation requirements===
20 +Below the list of requirements for an on-premises deployment
26 26  
27 -===3.2 Installation requirements Windows Server 2022===
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
22 +* Windows Server or Linux Server
23 +* Installed Docker software
24 +* Server connected to the internet whereby the firewall doesn't prevent data traffic going outwards to the Internet
25 + ** In case there are outgoing firewall rules, eMagiz can provide the specific URL's and port numbers in order to update the firewall
26 +* Sufficient resources inline with the requirements of the eMagiz runtimes. See this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Expert Level.Solution Architecture.expert-solution-architecture-determining-needed-memory.WebHome||target="blank"]]
36 36  
37 -===3.3 Installation requirements Windows Server 2019 version 1806===
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
28 +=== 3.2 Installation agent ===
62 62  
63 -===3.4 Installation requirements Windows Server 2012 R2 ===
30 +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.
64 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
32 +=== 3.3 Cloud architecture for API Gateway ===
81 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.
34 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-install-runtime-images.png]]
85 85  
86 86  == 4. Assignment ==
87 87  
88 -Check out the cheatcheet for Docker command line:
89 -
90 -[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
38 +There is no specific assignment for this microlearning.
91 91  
92 92  == 5. Key takeaways ==
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.
42 +* eMagiz will help to determine the needed memory via the Design Architecture page.
43 +* eMagiz works with pre-determined sizes that are represented via an S, M, L, XL structure. Every size has a certain amount of memory available
44 +* When you exceed such a threshold you should upgrade (or downgrade) your memory in consultation with your partner manager
45 +* Overhead for OS and support functionality (auto-healing, alerting, monitoring) needs to be taken into account
46 +* Calculating memory can be challenging. Always confer with others before taking action
47 +* You can compare your calculations with the calculations of eMagiz
48 +* The calculations and logic described below are applicable for the Messaging, API Gateway and Event Streaming pattern
97 97  
98 98  
99 99  
100 100  == 6. Suggested Additional Readings ==
101 101  
102 -N/A
103 -
54 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
55 +
104 104  == 7. Silent demonstration video ==
105 105  
106 106  N/A