Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 91.1
edited by Erik Bakker
on 2023/09/08 11:07
Change comment: There is no comment for this version
To version 61.1
edited by eMagiz
on 2023/02/07 12:15
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Pre-requisite installation of on-premises server
1 +On-premise Install Guide
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.ebakker
1 +XWiki.eMagiz
Content
... ... @@ -1,5 +1,5 @@
1 1  {{container}}{{container layoutStyle="columns"}}(((
2 -In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
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  
... ... @@ -11,29 +11,45 @@
11 11  == 2. Key concepts ==
12 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 13  
14 -In the below section the Windows and Linux variants are described in terms of how to prepare the server to allow the eMagiz Deploy agent to be installed. That agent allows to download images from the eMagiz infrastructure.
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 15  
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 +
19 19  These are the general requirements to allow the installation of the eMagiz Docker agent:
20 20  * Ensure access to the following URLs is enabled
21 - ** registry.emagiz.com:5443
22 + ** registry.emagiz.com:8443
22 22   ** controlplane.emagiz.com:8000
23 23   ** Preferably the entry should be *.emagiz.com
24 24  
26 +
25 25  ===3.2 Installation requirements Linux===
26 -Whenever Linux is selected as operating system, the latest version of Ubuntu will work. Other Linux distributions will also work such as Debian or Red Hat.
27 -**Step 1: Install linux distribution**
28 -Follow all steps in section 3.4
29 29  
30 -**Step 2: Install eMagiz Deploy Agent**
31 -Install the eMagiz Deploy agent as can be found in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
29 +* Whenever Linux is selected as operating system, the latest version of Ubuntu will work. Other Linux distributions will also work such as Debian or Red Hat.
30 +* Install latest version of the Docker engine - see for instance this link below. For other Linux distributions similar install guides are available on this link.
32 32  
33 -===3.3 Installation requirements Windows Server 2022 ===
32 +{{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
34 34  
34 +
35 +* Install the eMagiz Deploy agent
36 +
37 +===3.3 Installation requirements Windows Server 2022 (Docker Desktop)===
38 +
35 35  {{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
36 36  
41 +These are the requirements to allow the installation of the eMagiz Docker agent:
42 +* Install latest version of Docker Desktop from
43 +
44 +{{code}}https://www.docker.com/products/docker-desktop/{{/code}}
45 +
46 +* Validate if WSL 2.0 is properly installed
47 +* Install the eMagiz Deploy agent
48 +
49 +===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
50 +
51 +{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
52 +
37 37  The steps below will install a linux subsystem under Windows. In that Linux system, Docker and Java will be installed. Please note that the Windows server needs to be able to run Virtualized (either via BIOS setting or via Nested Virtualization).
38 38  
39 39  **Step 1: Install linux distribution**
... ... @@ -45,43 +45,10 @@
45 45   . /etc/os-release
46 46  {{/code}}
47 47  
48 -**Step 2: Configure linux system**
49 -Please see section 3.4 for these these steps
50 50  
51 -**Step 3: Update wsl config file **
52 -In this step we need to add or update the WSL config file that manages the resources of the Linux subsystem. Important resources to manage are the assigned memory and number of processors. For memory we recommend to review the mempory settings for the runtime that need to run on this server and add 762 MB to the total value of the heap and non-heap of these runtimes. For processor we recommend to set the value to 2 - depending on the amount of processors available on that machine
65 +**Step 2: Install Docker **
53 53  
54 -First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
55 -
56 56  {{code language="cmd"}}
57 - #Add following lines
58 -
59 - # Settings apply across all Linux distros running on WSL 2
60 - [wsl2]
61 - # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
62 - memory=16GB
63 - # Sets the VM to use two virtual processors
64 - processors=2
65 -{{/code}}
66 -
67 -**Step 4: Auto start the linux subsystem when Windows server restarts **
68 -
69 -{{code language="cmd"}}
70 -* Press Windows+R
71 -* Type shell:startup and press enter
72 -* Add or update file start_wsl.bat
73 -* Add following line into the document and save file
74 - * wsl sudo /usr/bin/dockerd
75 - {{/code}}
76 -
77 -**Step 5: Install eMagiz Deploy Agent**
78 -Install the eMagiz Deploy agent as can be found in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]].
79 -
80 -===3.4 Installation steps to configure Linux subsystem ===
81 -
82 -**Step 1: Install Docker **
83 -
84 -{{code language="cmd"}}
85 85   curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
86 86   echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
87 87   sudo apt update
... ... @@ -92,12 +92,21 @@
92 92   Requires ~335 Mb space to install
93 93  {{/info}}
94 94  
95 -**Step 3: Ensure Docker is autostarted with WSL **
78 +**Step 3: Install Java **
96 96  
80 +{{code language="cmd"}}
81 + wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
82 + echo "deb https://packages.adoptium.net/artifactory/deb $(awk -F= '/^VERSION_CODENAME/{print$2}' /etc/os-release) main" | sudo tee /etc/apt/sources.list.d/adoptium.list
83 + sudo apt update # update if you haven't already
84 + sudo apt install temurin-8-jdk
85 +{{/code}}
86 +
97 97  {{info}}
98 -This remark is valid for Windows based installations only
88 + Requires ~335 Mb space to install
99 99  {{/info}}
100 100  
91 +**Step 4: Ensure Docker is autostarted with WSL **
92 +
101 101  {{code language="cmd"}}
102 102  nano .bashrc
103 103  
... ... @@ -108,7 +108,7 @@
108 108   /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
109 109  {{/code}}
110 110  
111 -**Step 4: Add user to Docker group **
103 +**Step 5: Add user to Docker group **
112 112  
113 113  {{code language="cmd"}}
114 114  sudo visudo
... ... @@ -119,28 +119,26 @@
119 119   %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
120 120  {{/code}}
121 121  
122 -**Step 5: Ensure safe IP range for WSL **
114 +**Step 6: Update wsl config file **
115 +In this step we need to add or update the WSL config file that manages the resources of the Linux subsystem. Important resources to manage are the assigned memory and number of processors. For memory we recommend to review the mempory settings for the runtime that need to run on this server and add 762 MB to the total value of the heap and non-heap of these runtimes. For processor we recommend to set the value to 2 - depending on the amount of processors available on that machine
123 123  
124 -{{info}}
125 -This remark is valid for Windows based installations only
126 -{{/info}}
117 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
127 127  
128 -This step ensures that the IP address range of the machine doesn't conflict with any IP address of the Linux subsystem. Below the recommended values depending on the range which can be filled in the value <ip-address> below:
129 -* 10.0.0.1/8
130 - ** advised value 10.25.0.1/16
131 -* 172.16.0.1/12
132 - ** advised value 172.16.0.1/16
133 -* 192.168.0.1/16
134 - ** advised value 192.168.0.1/16
135 135  
136 136  {{code language="cmd"}}
137 -sudo nano /etc/docker/daemon.json
138 -
139 139   #Add following lines
140 -
141 - {"bip": "<ip-address>"}
122 +
123 + # Settings apply across all Linux distros running on WSL 2
124 + [wsl2]
125 + # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
126 + memory=16GB
127 + # Sets the VM to use two virtual processors
128 + processors=2
142 142  {{/code}}
143 143  
131 +
132 +**Step 7: Auto start the linux subsystem when server restarts **
133 +
144 144  
145 145  ===3.5 Installation requirements Windows Server 2019 version 1806===
146 146  
... ... @@ -152,10 +152,7 @@
152 152   ** Restart windows
153 153  * Cross check is WSL 2.0 is installed
154 154   ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
155 -* Please follow the instructions for preparing a Windows 2022 installation in section 3.3
156 -
157 -{{info}}
158 - * Install Docker Desktop on the Windows Server
145 +* Install Docker Desktop on the Windows Server
159 159   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
160 160   ** Restart windows
161 161  * Update Docker Desktop configuration
... ... @@ -171,7 +171,6 @@
171 171  * Open the ubuntu terminal, and finish the installation.
172 172   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
173 173  * Go to the next section around installing the eMagiz Docker agent
174 -{{/info}}
175 175  
176 176  ===3.6 Installation requirements Windows Server 2012 R2 ===
177 177  
... ... @@ -182,9 +182,9 @@
182 182   ** 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.
183 183   ** Restart windows
184 184  * Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
185 -* Create a VM in HyperV.
171 +* Create a VM in HyperV.
186 186   ** 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).
187 - ** Configure a virtual switch.
173 + ** Configure a virtual switch.
188 188   ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
189 189   ** Install an operating system from bootable CD/DVD, ISO file
190 190  * Install ubuntu downloaded previously on the VM
... ... @@ -191,14 +191,34 @@
191 191  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
192 192  * Go to the next section around installing the eMagiz agent
193 193  
194 -== 4. Key takeaways ==
180 +=== 3.7 eMagiz Docker agent installation ===
195 195  
182 +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 under Deploy Architecture. At the runtime connector, there is a right click option called Deploy Agent. That presents either the command or the location where that agent is installed.
183 +
184 +[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
185 +
186 +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.
187 +
188 +== 4. Assignment ==
189 +
190 +Check out the cheatcheet for Docker command line:
191 +
192 +[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
193 +
194 +== 5. Key takeaways ==
195 +
196 196  * 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
197 197  * eMagiz has a specific agent that manages the download of that image to the on-premises server
198 198  * 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.
199 199  
200 -== 5. Suggested Additional Readings ==
201 201  
202 -* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
203 203  
202 +== 6. Suggested Additional Readings ==
203 +
204 +N/A
205 +
206 +== 7. Silent demonstration video ==
207 +
208 +N/A
209 +
204 204  )))((({{toc/}}))){{/container}}{{/container}}