Pre-requisite installation of on-premises server

{{container}}{{container layoutStyle="columns"}}(((

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:8443

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

42

wsl --install -d Ubuntu

43

sudo apt-get update

44

sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2

. /etc/os-release

**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)

#Add following lines

# 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

processors=2

**Step 4: Auto start the linux subsystem when Windows server restarts **

* Press Windows+R

* 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

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

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

Requires ~335 Mb space to install

95

96

97

**Step 2: Install Java **

98

99

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

Requires ~335 Mb space to install

108

109

110

**Step 3: Ensure Docker is autostarted with WSL **

nano .bashrc

#Add following lines to bashrc

116

DOCKER_DISTRO="Ubuntu"

117

DOCKER_LOG_DIR=$HOME/docker_logs

118

mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"

119

/mnt/c/Windows/System32/wsl.exe -d $DOCKER_DISTRO sh -c "nohup sudo -b dockerd < /dev/null > $DOCKER_LOG_DIR/dockerd.log 2>&1"

120

121

122

**Step 4: Add user to Docker group **

sudo visudo

#Add following lines

# Don't ask for password

130

%docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd

131

132

133

**Step 5: Ensure safe IP range for WSL **

134

135

136

This remark is valid for Windows based installations only

137

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

141

** advised value 10.25.0.1/16

142

* 172.16.0.1/12

143

** advised value 172.16.0.1/16

144

* 192.168.0.1/16

145

** advised value 10.25.0.1/16

146

147

148

sudo nano /etc/docker/daemon.json

#Add following lines

{"bip": "<ip-address>"}

===3.5 Installation requirements Windows Server 2019 version 1806===

157

158

{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}

159

160

These are the requirements to allow the installation of the eMagiz Docker agent:

161

* Enable Hyper-V in Windows Server

162

** 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.

163

** Restart windows

164

* Cross check is WSL 2.0 is installed

165

** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux

166

* Please follow the instructions for preparing a Windows 2022 installation in section 3.3

167

168

169

* Install Docker Desktop on the Windows Server

170

** Please refer to this link: https://www.docker.com/products/docker-desktop/

171

** Restart windows

172

* Update Docker Desktop configuration

173

** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS

174

** Restart Docker

175

* Open Powershell as Administrator

176

** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine

177

** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux

178

** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004

179

** Execute Add-AppxPackage .\ubuntu-2004.appx

180

*** 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.

181

* Ubuntu should now be a runnable program (press windows key, type ubuntu)

182

* Open the ubuntu terminal, and finish the installation.

183

** After installation, execute: export DOCKER_HOST=tcp://localhost:2375

184

* Go to the next section around installing the eMagiz Docker agent

185

186

187

===3.6 Installation requirements Windows Server 2012 R2 ===

188

189

{{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}

190

191

These are the requirements to allow the installation of the eMagiz Docker agent:

192

* Install & enable Hyper-V in Windows Server

193

** 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.

194

** Restart windows

195

* Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )

196

* Create a VM in HyperV.

197

** 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).

198

** Configure a virtual switch.

199

** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)

200

** Install an operating system from bootable CD/DVD, ISO file

201

* Install ubuntu downloaded previously on the VM

202

* Install docker as per official ubuntu documentation (See https://docs.docker.com/engine/install/ubuntu/#install-using-the-repository) on the VM

203

* Go to the next section around installing the eMagiz agent

== 4. Assignment ==

Check out the cheatcheet for Docker command line:

208

209

[[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]

210

211

== 5. Key takeaways ==

212

213

* 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

214

* eMagiz has a specific agent that manages the download of that image to the on-premises server

215

* 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.

== 6. Suggested Additional Readings ==

N/A

== 7. Silent demonstration video ==

224