On-premise Install Guide

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

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.

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

15

16

== 3. On-premises deployments ==

17

18

===3.1 General requirements===

19

20

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

21

* Ensure access to the following URLs is enabled

22

** registry.emagiz.com:8443

23

** controlplane.emagiz.com:8000

24

** Preferably the entry should be *.emagiz.com

25

26

27

===3.2 Installation requirements Linux===

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

**Step 1: Install linux distribution**

31

Follow all steps in section 3.4

32

33

**Step 2: Install eMagiz Deploy Agent**

34

Install the eMagiz Deploy agent as can be found here

35

36

===3.3 Installation requirements Windows Server 2022 ===

37

38

{{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}

39

40

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

41

42

**Step 1: Install linux distribution**

43

44

45

wsl --install -d Ubuntu

46

sudo apt-get update

47

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

. /etc/os-release

**Step 2: Configure linux system**

52

Please see section 3.4 for these these steps

53

54

**Step 3: Update wsl config file **

55

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

56

57

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

63

[wsl2]

64

# Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB

65

memory=16GB

66

# Sets the VM to use two virtual processors

processors=2

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

72

73

**Step 5: Install eMagiz Deploy Agent**

74

Install the eMagiz Deploy agent as can be found here

75

76

77

===3.4 Installation steps to configure Linux subsystem ===

78

79

**Step 1: Install Docker **

80

81

82

curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc

83

echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list

84

sudo apt update

85

sudo apt install docker-ce docker-ce-cli containerd.io

Requires ~335 Mb space to install

90

91

92

**Step 2: Install Java **

93

94

95

wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -

96

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

97

sudo apt update # update if you haven't already

98

sudo apt install temurin-8-jdk

Requires ~335 Mb space to install

103

104

105

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

nano .bashrc

#Add following lines to bashrc

111

DOCKER_DISTRO="Ubuntu"

112

DOCKER_LOG_DIR=$HOME/docker_logs

113

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

114

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

115

116

117

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

sudo visudo

#Add following lines

# Don't ask for password

125

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

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

131

132

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

133

134

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

135

* Enable Hyper-V in Windows Server

136

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

137

** Restart windows

138

* Cross check is WSL 2.0 is installed

139

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

140

* Install Docker Desktop on the Windows Server

141

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

142

** Restart windows

143

* Update Docker Desktop configuration

144

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

145

** Restart Docker

146

* Open Powershell as Administrator

147

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

148

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

149

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

150

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

151

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

152

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

153

* Open the ubuntu terminal, and finish the installation.

154

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

155

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

156

157

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

158

159

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

160

161

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

162

* Install & enable Hyper-V in Windows Server

163

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

164

** Restart windows

165

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

166

* Create a VM in HyperV.

167

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

168

** Configure a virtual switch.

169

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

170

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

171

* Install ubuntu downloaded previously on the VM

172

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

173

* Go to the next section around installing the eMagiz agent

== 4. Assignment ==

Check out the cheatcheet for Docker command line:

178

179

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

180

181

== 5. Key takeaways ==

182

183

* 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

184

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

185

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

194