Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 62.1
edited by eMagiz
on 2023/02/07 12:26
Change comment: There is no comment for this version
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 -On-premise Install Guide
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,26 +11,25 @@
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===
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
28 28  
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 -* Follow all steps in section 3.4
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"]]
31 31  
32 -* Install the eMagiz Deploy agent
33 -
34 34  ===3.3 Installation requirements Windows Server 2022 ===
35 35  
36 36  {{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
... ... @@ -48,7 +48,7 @@
48 48  
49 49  **Step 2: Configure linux system**
50 50  Please see section 3.4 for these these steps
51 -
50 +
52 52  **Step 3: Update wsl config file **
53 53  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
54 54  
... ... @@ -60,17 +60,26 @@
60 60   # Settings apply across all Linux distros running on WSL 2
61 61   [wsl2]
62 62   # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
63 - memory=16GB
62 + memory=16GB
64 64   # Sets the VM to use two virtual processors
65 65   processors=2
66 66  {{/code}}
67 67  
68 -
69 69  **Step 4: Auto start the linux subsystem when Windows server restarts **
70 -
71 71  
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 +
72 72  ===3.4 Installation steps to configure Linux subsystem ===
73 -
81 +
74 74  **Step 1: Install Docker **
75 75  
76 76  {{code language="cmd"}}
... ... @@ -84,21 +84,12 @@
84 84   Requires ~335 Mb space to install
85 85  {{/info}}
86 86  
87 -**Step 2: Install Java **
95 +**Step 3: Ensure Docker is autostarted with WSL **
88 88  
89 -{{code language="cmd"}}
90 - wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
91 - 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
92 - sudo apt update # update if you haven't already
93 - sudo apt install temurin-8-jdk
94 -{{/code}}
95 -
96 96  {{info}}
97 - Requires ~335 Mb space to install
98 +This remark is valid for Windows based installations only
98 98  {{/info}}
99 99  
100 -**Step 3: Ensure Docker is autostarted with WSL **
101 -
102 102  {{code language="cmd"}}
103 103  nano .bashrc
104 104  
... ... @@ -120,8 +120,29 @@
120 120   %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
121 121  {{/code}}
122 122  
123 -
122 +**Step 5: Ensure safe IP range for WSL **
124 124  
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 +
125 125  ===3.5 Installation requirements Windows Server 2019 version 1806===
126 126  
127 127  {{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
... ... @@ -132,7 +132,10 @@
132 132   ** Restart windows
133 133  * Cross check is WSL 2.0 is installed
134 134   ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
135 -* 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
136 136   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
137 137   ** Restart windows
138 138  * Update Docker Desktop configuration
... ... @@ -148,6 +148,7 @@
148 148  * Open the ubuntu terminal, and finish the installation.
149 149   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
150 150  * Go to the next section around installing the eMagiz Docker agent
174 +{{/info}}
151 151  
152 152  ===3.6 Installation requirements Windows Server 2012 R2 ===
153 153  
... ... @@ -158,9 +158,9 @@
158 158   ** 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.
159 159   ** Restart windows
160 160  * Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
161 -* Create a VM in HyperV.
185 +* Create a VM in HyperV.
162 162   ** 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).
163 - ** Configure a virtual switch.
187 + ** Configure a virtual switch.
164 164   ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
165 165   ** Install an operating system from bootable CD/DVD, ISO file
166 166  * Install ubuntu downloaded previously on the VM
... ... @@ -167,34 +167,14 @@
167 167  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
168 168  * Go to the next section around installing the eMagiz agent
169 169  
170 -=== 3.7 eMagiz Docker agent installation ===
194 +== 4. Key takeaways ==
171 171  
172 -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.
173 -
174 -[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
175 -
176 -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.
177 -
178 -== 4. Assignment ==
179 -
180 -Check out the cheatcheet for Docker command line:
181 -
182 -[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
183 -
184 -== 5. Key takeaways ==
185 -
186 186  * 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
187 187  * eMagiz has a specific agent that manages the download of that image to the on-premises server
188 188  * 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.
189 189  
200 +== 5. Suggested Additional Readings ==
190 190  
202 +* Docker command line cheatsheet: [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
191 191  
192 -== 6. Suggested Additional Readings ==
193 -
194 -N/A
195 -
196 -== 7. Silent demonstration video ==
197 -
198 -N/A
199 -
200 200  )))((({{toc/}}))){{/container}}{{/container}}