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

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -expert-solution-architecture-onpremises-installguide2
1 +Pre-requisite installation of on-premises server
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.eMagiz
1 +XWiki.ebakker
Content
... ... @@ -1,5 +1,5 @@
1 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.
2 +In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
3 3  
4 4  Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5 5  
... ... @@ -11,27 +11,24 @@
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 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.
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.
15 15  
16 16  == 3. On-premises deployments ==
17 17  
18 18  ===3.1 General requirements===
19 -
20 20  These are the general requirements to allow the installation of the eMagiz Docker agent:
21 21  * Ensure access to the following URLs is enabled
22 - ** registry.emagiz.com:8443
21 + ** registry.emagiz.com:5443
23 23   ** controlplane.emagiz.com:8000
24 24   ** Preferably the entry should be *.emagiz.com
25 25  
26 -
27 27  ===3.2 Installation requirements Linux===
28 -
29 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 30  **Step 1: Install linux distribution**
31 31  Follow all steps in section 3.4
32 32  
33 33  **Step 2: Install eMagiz Deploy Agent**
34 -Install the eMagiz Deploy agent as can be found here
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"]]
35 35  
36 36  ===3.3 Installation requirements Windows Server 2022 ===
37 37  
... ... @@ -50,7 +50,7 @@
50 50  
51 51  **Step 2: Configure linux system**
52 52  Please see section 3.4 for these these steps
53 -
50 +
54 54  **Step 3: Update wsl config file **
55 55  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
56 56  
... ... @@ -62,20 +62,26 @@
62 62   # Settings apply across all Linux distros running on WSL 2
63 63   [wsl2]
64 64   # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
65 - memory=16GB
62 + memory=16GB
66 66   # Sets the VM to use two virtual processors
67 67   processors=2
68 68  {{/code}}
69 69  
70 -
71 71  **Step 4: Auto start the linux subsystem when Windows server restarts **
72 -
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 +
73 73  **Step 5: Install eMagiz Deploy Agent**
74 -Install the eMagiz Deploy agent as can be found here
75 -
76 -
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 +
77 77  ===3.4 Installation steps to configure Linux subsystem ===
78 -
81 +
79 79  **Step 1: Install Docker **
80 80  
81 81  {{code language="cmd"}}
... ... @@ -89,21 +89,12 @@
89 89   Requires ~335 Mb space to install
90 90  {{/info}}
91 91  
92 -**Step 2: Install Java **
95 +**Step 3: Ensure Docker is autostarted with WSL **
93 93  
94 -{{code language="cmd"}}
95 - wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
96 - 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
97 - sudo apt update # update if you haven't already
98 - sudo apt install temurin-8-jdk
99 -{{/code}}
100 -
101 101  {{info}}
102 - Requires ~335 Mb space to install
98 +This remark is valid for Windows based installations only
103 103  {{/info}}
104 104  
105 -**Step 3: Ensure Docker is autostarted with WSL **
106 -
107 107  {{code language="cmd"}}
108 108  nano .bashrc
109 109  
... ... @@ -125,8 +125,29 @@
125 125   %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
126 126  {{/code}}
127 127  
128 -
122 +**Step 5: Ensure safe IP range for WSL **
129 129  
124 +{{info}}
125 +This remark is valid for Windows based installations only
126 +{{/info}}
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 +
136 +{{code language="cmd"}}
137 +sudo nano /etc/docker/daemon.json
138 +
139 + #Add following lines
140 +
141 + {"bip": "<ip-address>"}
142 +{{/code}}
143 +
144 +
130 130  ===3.5 Installation requirements Windows Server 2019 version 1806===
131 131  
132 132  {{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
... ... @@ -137,7 +137,10 @@
137 137   ** Restart windows
138 138  * Cross check is WSL 2.0 is installed
139 139   ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
140 -* Install Docker Desktop on the Windows Server
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
141 141   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
142 142   ** Restart windows
143 143  * Update Docker Desktop configuration
... ... @@ -153,6 +153,7 @@
153 153  * Open the ubuntu terminal, and finish the installation.
154 154   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
155 155  * Go to the next section around installing the eMagiz Docker agent
174 +{{/info}}
156 156  
157 157  ===3.6 Installation requirements Windows Server 2012 R2 ===
158 158  
... ... @@ -163,9 +163,9 @@
163 163   ** 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.
164 164   ** Restart windows
165 165  * Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
166 -* Create a VM in HyperV.
185 +* Create a VM in HyperV.
167 167   ** 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).
168 - ** Configure a virtual switch.
187 + ** Configure a virtual switch.
169 169   ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
170 170   ** Install an operating system from bootable CD/DVD, ISO file
171 171  * Install ubuntu downloaded previously on the VM
... ... @@ -172,26 +172,14 @@
172 172  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
173 173  * Go to the next section around installing the eMagiz agent
174 174  
175 -== 4. Assignment ==
194 +== 4. Key takeaways ==
176 176  
177 -Check out the cheatcheet for Docker command line:
178 -
179 -[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
180 -
181 -== 5. Key takeaways ==
182 -
183 183  * 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
184 184  * eMagiz has a specific agent that manages the download of that image to the on-premises server
185 185  * 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.
186 186  
200 +== 5. Suggested Additional Readings ==
187 187  
202 +* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
188 188  
189 -== 6. Suggested Additional Readings ==
190 -
191 -N/A
192 -
193 -== 7. Silent demonstration video ==
194 -
195 -N/A
196 -
197 197  )))((({{toc/}}))){{/container}}{{/container}}