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 84.1
edited by eMagiz
on 2023/04/11 15:22
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
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,12 +11,11 @@
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 22   ** registry.emagiz.com:8443
... ... @@ -23,14 +23,14 @@
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}}
... ... @@ -67,10 +67,21 @@
67 67  
68 68  
69 69  **Step 4: Auto start the linux subsystem when Windows server restarts **
70 -
71 71  
72 -===3.4 Installation steps to configure Linux subsystem ===
70 +{{code language="cmd"}}
71 +* Press Windows+R
72 +* Type shell:startup and press enter
73 +* Add or update file start_wsl.bat
74 +* Add following line into the document and save file
75 + * wsl sudo /usr/bin/dockerd
76 + {{/code}}
77 +
78 +**Step 5: Install eMagiz Deploy Agent**
79 +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"]].
73 73  
81 +
82 +===3.4 Installation steps to configure Linux subsystem ===
83 +
74 74  **Step 1: Install Docker **
75 75  
76 76  {{code language="cmd"}}
... ... @@ -120,8 +120,26 @@
120 120   %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
121 121  {{/code}}
122 122  
123 -
133 +**Step 5: Ensure safe IP range for WSL **
124 124  
135 +{{info}}
136 +This remark is valid for Windows based installations only
137 +{{/info}}
138 +
139 +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:
140 +* 10.0.0.1/8 - use 10.25.0.1/16
141 +* 172.16.0.1/12 - use 172.16.0.1/16
142 +* 192.168.0.1/16 - use 10.25.0.1/16
143 +
144 +{{code language="cmd"}}
145 +sudo nano /etc/docker/daemon.json
146 +
147 + #Add following lines
148 +
149 + {"bip": "<ip-address>"}
150 +{{/code}}
151 +
152 +
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
163 +* Please follow the instructions for preparing a Windows 2022 installation in section 3.3
164 +
165 +{{info}}
166 + * 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
182 +{{/info}}
151 151  
152 152  ===3.6 Installation requirements Windows Server 2012 R2 ===
153 153  
... ... @@ -167,14 +167,6 @@
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 ===
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 178  == 4. Assignment ==
179 179  
180 180  Check out the cheatcheet for Docker command line: