Skip to Content
Version 90.1 by Erik Bakker on 2023/06/22 14:49
Hide last authors
eMagiz 1.1 1 {{container}}{{container layoutStyle="columns"}}(((
eMagiz 70.1 2 In this microlearning, we will focus on how an on-premises server can be prepared for a eMagiz Deploy agent installation.
Erik Bakker 15.1 3
eMagiz 1.1 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
eMagiz 3.1 9 * Good understanding of eMagiz runtimes in general
eMagiz 1.1 10
11 == 2. Key concepts ==
eMagiz 25.1 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.
eMagiz 3.1 13
eMagiz 70.1 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.
eMagiz 21.1 15
eMagiz 3.1 16 == 3. On-premises deployments ==
eMagiz 25.1 17
18 ===3.1 General requirements===
19 These are the general requirements to allow the installation of the eMagiz Docker agent:
eMagiz 17.1 20 * Ensure access to the following URLs is enabled
Erik Bakker 90.1 21 ** registry.emagiz.com:5443
eMagiz 34.1 22 ** controlplane.emagiz.com:8000
eMagiz 17.1 23 ** Preferably the entry should be *.emagiz.com
eMagiz 31.1 24
eMagiz 25.1 25 ===3.2 Installation requirements Linux===
eMagiz 63.1 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
eMagiz 1.1 29
eMagiz 63.1 30 **Step 2: Install eMagiz Deploy Agent**
eMagiz 75.1 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"]]
eMagiz 57.1 32
eMagiz 62.1 33 ===3.3 Installation requirements Windows Server 2022 ===
eMagiz 18.1 34
eMagiz 59.1 35 {{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
36
eMagiz 58.1 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
eMagiz 44.1 39 **Step 1: Install linux distribution**
eMagiz 46.1 40
eMagiz 42.1 41 {{code language="cmd"}}
eMagiz 47.1 42 wsl --install -d Ubuntu
eMagiz 45.1 43 sudo apt-get update
44 sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
45 . /etc/os-release
eMagiz 43.1 46 {{/code}}
eMagiz 44.1 47
eMagiz 62.1 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
eMagiz 44.1 53
eMagiz 62.1 54 First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
eMagiz 47.1 55
eMagiz 45.1 56 {{code language="cmd"}}
eMagiz 62.1 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 **
eMagiz 72.1 69
70 {{code language="cmd"}}
eMagiz 77.1 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
eMagiz 72.1 76 {{/code}}
77
eMagiz 63.1 78 **Step 5: Install eMagiz Deploy Agent**
eMagiz 76.1 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"]].
eMagiz 63.1 80
81
eMagiz 62.1 82 ===3.4 Installation steps to configure Linux subsystem ===
eMagiz 69.1 83
eMagiz 62.1 84 **Step 1: Install Docker **
85
86 {{code language="cmd"}}
eMagiz 47.1 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}}
eMagiz 24.1 92
eMagiz 48.1 93 {{info}}
eMagiz 47.1 94 Requires ~335 Mb space to install
eMagiz 48.1 95 {{/info}}
eMagiz 45.1 96
eMagiz 62.1 97 **Step 2: Install Java **
eMagiz 32.1 98
eMagiz 48.1 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}}
eMagiz 45.1 105
eMagiz 48.1 106 {{info}}
107 Requires ~335 Mb space to install
108 {{/info}}
eMagiz 45.1 109
eMagiz 62.1 110 **Step 3: Ensure Docker is autostarted with WSL **
eMagiz 50.1 111
eMagiz 87.1 112 {{info}}
113 This remark is valid for Windows based installations only
114 {{/info}}
115
eMagiz 49.1 116 {{code language="cmd"}}
eMagiz 32.1 117 nano .bashrc
118
eMagiz 49.1 119 #Add following lines to bashrc
eMagiz 32.1 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"
eMagiz 49.1 124 {{/code}}
eMagiz 32.1 125
eMagiz 62.1 126 **Step 4: Add user to Docker group **
eMagiz 51.1 127
eMagiz 52.1 128 {{code language="cmd"}}
eMagiz 32.1 129 sudo visudo
eMagiz 52.1 130
131 #Add following lines
132
eMagiz 51.1 133 # Don't ask for password
134 %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
eMagiz 52.1 135 {{/code}}
136
eMagiz 80.1 137 **Step 5: Ensure safe IP range for WSL **
eMagiz 32.1 138
eMagiz 84.1 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:
eMagiz 85.1 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
eMagiz 88.1 149 ** advised value 192.168.0.1/16
eMagiz 81.1 150
eMagiz 80.1 151 {{code language="cmd"}}
152 sudo nano /etc/docker/daemon.json
153
154 #Add following lines
155
eMagiz 82.1 156 {"bip": "<ip-address>"}
eMagiz 80.1 157 {{/code}}
158
159
eMagiz 60.1 160 ===3.5 Installation requirements Windows Server 2019 version 1806===
eMagiz 24.1 161
eMagiz 61.1 162 {{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
Erik Bakker 40.1 163
eMagiz 18.1 164 These are the requirements to allow the installation of the eMagiz Docker agent:
eMagiz 12.1 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
eMagiz 29.1 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
eMagiz 79.1 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
eMagiz 12.1 174 ** Please refer to this link: https://www.docker.com/products/docker-desktop/
175 ** Restart windows
eMagiz 25.1 176 * Update Docker Desktop configuration
eMagiz 12.1 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
eMagiz 14.1 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.
eMagiz 12.1 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
eMagiz 28.1 188 * Go to the next section around installing the eMagiz Docker agent
eMagiz 79.1 189 {{/info}}
Erik Bakker 40.1 190
eMagiz 26.1 191 ===3.6 Installation requirements Windows Server 2012 R2 ===
Erik Bakker 40.1 192
eMagiz 61.1 193 {{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
eMagiz 60.1 194
eMagiz 18.1 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).
eMagiz 19.1 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
eMagiz 18.1 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
eMagiz 22.1 207 * Go to the next section around installing the eMagiz agent
Erik Bakker 40.1 208
eMagiz 1.1 209 == 4. Assignment ==
210
eMagiz 9.1 211 Check out the cheatcheet for Docker command line:
Erik Bakker 40.1 212
eMagiz 9.1 213 [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
eMagiz 1.1 214
215 == 5. Key takeaways ==
216
eMagiz 5.1 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
Erik Bakker 40.1 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.
eMagiz 1.1 220
221
222
223 == 6. Suggested Additional Readings ==
224
eMagiz 8.1 225 N/A
226
eMagiz 1.1 227 == 7. Silent demonstration video ==
228
eMagiz 3.1 229 N/A
eMagiz 1.1 230
231 )))((({{toc/}}))){{/container}}{{/container}}