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