Skip to Content
Version 90.1 by Erik Bakker on 2023/06/22 14:49
Show last authors
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.
3
4 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
5
6 == 1. Prerequisites ==
7
8 * Advanced knowledge of the eMagiz platform
9 * Good understanding of eMagiz runtimes in general
10
11 == 2. Key concepts ==
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
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
16 == 3. On-premises deployments ==
17
18 ===3.1 General requirements===
19 These are the general requirements to allow the installation of the eMagiz Docker agent:
20 * Ensure access to the following URLs is enabled
21 ** registry.emagiz.com:5443
22 ** controlplane.emagiz.com:8000
23 ** Preferably the entry should be *.emagiz.com
24
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
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"]]
32
33 ===3.3 Installation requirements Windows Server 2022 ===
34
35 {{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
36
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
39 **Step 1: Install linux distribution**
40
41 {{code language="cmd"}}
42 wsl --install -d Ubuntu
43 sudo apt-get update
44 sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
45 . /etc/os-release
46 {{/code}}
47
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
53
54 First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
55
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
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"}}
87 curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
88 echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
89 sudo apt update
90 sudo apt install docker-ce docker-ce-cli containerd.io
91 {{/code}}
92
93 {{info}}
94 Requires ~335 Mb space to install
95 {{/info}}
96
97 **Step 2: Install Java **
98
99 {{code language="cmd"}}
100 wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
101 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
102 sudo apt update # update if you haven't already
103 sudo apt install temurin-8-jdk
104 {{/code}}
105
106 {{info}}
107 Requires ~335 Mb space to install
108 {{/info}}
109
110 **Step 3: Ensure Docker is autostarted with WSL **
111
112 {{info}}
113 This remark is valid for Windows based installations only
114 {{/info}}
115
116 {{code language="cmd"}}
117 nano .bashrc
118
119 #Add following lines to bashrc
120 DOCKER_DISTRO="Ubuntu"
121 DOCKER_LOG_DIR=$HOME/docker_logs
122 mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
123 /mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"
124 {{/code}}
125
126 **Step 4: Add user to Docker group **
127
128 {{code language="cmd"}}
129 sudo visudo
130
131 #Add following lines
132
133 # Don't ask for password
134 %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
135 {{/code}}
136
137 **Step 5: Ensure safe IP range for WSL **
138
139 {{info}}
140 This remark is valid for Windows based installations only
141 {{/info}}
142
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
150
151 {{code language="cmd"}}
152 sudo nano /etc/docker/daemon.json
153
154 #Add following lines
155
156 {"bip": "<ip-address>"}
157 {{/code}}
158
159
160 ===3.5 Installation requirements Windows Server 2019 version 1806===
161
162 {{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
163
164 These are the requirements to allow the installation of the eMagiz Docker agent:
165 * Enable Hyper-V in Windows Server
166 ** 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.
167 ** Restart windows
168 * Cross check is WSL 2.0 is installed
169 ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
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
174 ** Please refer to this link: https://www.docker.com/products/docker-desktop/
175 ** Restart windows
176 * Update Docker Desktop configuration
177 ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
178 ** Restart Docker
179 * Open Powershell as Administrator
180 ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
181 ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
182 ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
183 ** Execute Add-AppxPackage .\ubuntu-2004.appx
184 *** If errors occur, please consult https://learn.microsoft.com/en-us/windows/wsl/install-on-server. Rename the file to a zip, expand it, and add it to the path variable.
185 * Ubuntu should now be a runnable program (press windows key, type ubuntu)
186 * Open the ubuntu terminal, and finish the installation.
187 ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
188 * Go to the next section around installing the eMagiz Docker agent
189 {{/info}}
190
191 ===3.6 Installation requirements Windows Server 2012 R2 ===
192
193 {{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
194
195 These are the requirements to allow the installation of the eMagiz Docker agent:
196 * Install & enable Hyper-V in Windows Server
197 ** 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.
198 ** Restart windows
199 * Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
200 * Create a VM in HyperV.
201 ** 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).
202 ** Configure a virtual switch.
203 ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
204 ** Install an operating system from bootable CD/DVD, ISO file
205 * Install ubuntu downloaded previously on the VM
206 * Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM
207 * Go to the next section around installing the eMagiz agent
208
209 == 4. Assignment ==
210
211 Check out the cheatcheet for Docker command line:
212
213 [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
214
215 == 5. Key takeaways ==
216
217 * 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
218 * eMagiz has a specific agent that manages the download of that image to the on-premises server
219 * 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.
220
221
222
223 == 6. Suggested Additional Readings ==
224
225 N/A
226
227 == 7. Silent demonstration video ==
228
229 N/A
230
231 )))((({{toc/}}))){{/container}}{{/container}}