Skip to Content
Last modified by Erik Bakker on 2025/04/18 13:54
From version 61.1
edited by eMagiz
on 2023/02/07 12:15
Change comment: There is no comment for this version
To version 90.1
edited by Erik Bakker
on 2023/06/22 14:49
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,45 +11,29 @@
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 -* 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.
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 -{{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
33 +===3.3 Installation requirements Windows Server 2022 ===
33 33  
34 -
35 -* Install the eMagiz Deploy agent
36 -
37 -===3.3 Installation requirements Windows Server 2022 (Docker Desktop)===
38 -
39 39  {{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
40 40  
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 -
53 53  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).
54 54  
55 55  **Step 1: Install linux distribution**
... ... @@ -61,10 +61,45 @@
61 61   . /etc/os-release
62 62  {{/code}}
63 63  
48 +**Step 2: Configure linux system**
49 +Please see section 3.4 for these these steps
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
64 64  
65 -**Step 2: Install Docker **
54 +First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
66 66  
67 67  {{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 +
68 +**Step 4: Auto start the linux subsystem when Windows server restarts **
69 +
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"]].
80 +
81 +
82 +===3.4 Installation steps to configure Linux subsystem ===
83 +
84 +**Step 1: Install Docker **
85 +
86 +{{code language="cmd"}}
68 68   curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
69 69   echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
70 70   sudo apt update
... ... @@ -75,7 +75,7 @@
75 75   Requires ~335 Mb space to install
76 76  {{/info}}
77 77  
78 -**Step 3: Install Java **
97 +**Step 2: Install Java **
79 79  
80 80  {{code language="cmd"}}
81 81   wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
... ... @@ -88,8 +88,12 @@
88 88   Requires ~335 Mb space to install
89 89  {{/info}}
90 90  
91 -**Step 4: Ensure Docker is autostarted with WSL **
110 +**Step 3: Ensure Docker is autostarted with WSL **
92 92  
112 +{{info}}
113 +This remark is valid for Windows based installations only
114 +{{/info}}
115 +
93 93  {{code language="cmd"}}
94 94  nano .bashrc
95 95  
... ... @@ -100,7 +100,7 @@
100 100   /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
101 101  {{/code}}
102 102  
103 -**Step 5: Add user to Docker group **
126 +**Step 4: Add user to Docker group **
104 104  
105 105  {{code language="cmd"}}
106 106  sudo visudo
... ... @@ -111,26 +111,28 @@
111 111   %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
112 112  {{/code}}
113 113  
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
137 +**Step 5: Ensure safe IP range for WSL **
116 116  
117 -First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
139 +{{info}}
140 +This remark is valid for Windows based installations only
141 +{{/info}}
118 118  
143 +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:
144 +* 10.0.0.1/8
145 + ** advised value 10.25.0.1/16
146 +* 172.16.0.1/12
147 + ** advised value 172.16.0.1/16
148 +* 192.168.0.1/16
149 + ** advised value 192.168.0.1/16
119 119  
120 120  {{code language="cmd"}}
152 +sudo nano /etc/docker/daemon.json
153 +
121 121   #Add following lines
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
155 +
156 + {"bip": "<ip-address>"}
129 129  {{/code}}
130 130  
131 -
132 -**Step 7: Auto start the linux subsystem when server restarts **
133 -
134 134  
135 135  ===3.5 Installation requirements Windows Server 2019 version 1806===
136 136  
... ... @@ -142,7 +142,10 @@
142 142   ** Restart windows
143 143  * Cross check is WSL 2.0 is installed
144 144   ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
145 -* Install Docker Desktop on the Windows Server
170 +* Please follow the instructions for preparing a Windows 2022 installation in section 3.3
171 +
172 +{{info}}
173 + * Install Docker Desktop on the Windows Server
146 146   ** Please refer to this link: https://www.docker.com/products/docker-desktop/
147 147   ** Restart windows
148 148  * Update Docker Desktop configuration
... ... @@ -158,6 +158,7 @@
158 158  * Open the ubuntu terminal, and finish the installation.
159 159   ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
160 160  * Go to the next section around installing the eMagiz Docker agent
189 +{{/info}}
161 161  
162 162  ===3.6 Installation requirements Windows Server 2012 R2 ===
163 163  
... ... @@ -177,14 +177,6 @@
177 177  * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
178 178  * Go to the next section around installing the eMagiz agent
179 179  
180 -=== 3.7 eMagiz Docker agent installation ===
181 -
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 188  == 4. Assignment ==
189 189  
190 190  Check out the cheatcheet for Docker command line: