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

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

31

32

{{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}

33

34

35

* Install the eMagiz Deploy agent

36

37

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

38

39

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

40

* Install latest version of Docker Desktop from {{code}}https://www.docker.com/products/docker-desktop/{{/code}}

41

* Validate if WSL 2.0 is properly installed

42

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

43

44

===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===

45

46

**Step 1: Install linux distribution**

47

48

49

wsl --install -d Ubuntu

50

sudo apt-get update

51

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

. /etc/os-release

**Step 2: Install Docker **

57

58

59

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

60

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

61

sudo apt update

62

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

Requires ~335 Mb space to install

67

68

69

**Step 3: Install Java **

70

71

72

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

73

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

74

sudo apt update # update if you haven't already

75

sudo apt install temurin-8-jdk

Requires ~335 Mb space to install

80

81

82

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

nano .bashrc

#Add following lines to bashrc

88

DOCKER_DISTRO="Ubuntu"

89

DOCKER_LOG_DIR=$HOME/docker_logs

90

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

91

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

92

93

94

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

sudo visudo

#Add following lines

# Don't ask for password

102

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

103

104

105

**Step 6: Update wsl config file **

106

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

107

108

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

115

[wsl2]

116

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

117

memory=16GB

118

# Sets the VM to use two virtual processors

processors=2

**Step 7: Auto start the linux subsystem when server restarts **

124

125

126

===3.4 Installation requirements Windows Server 2019 version >1806===

127

128

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

129

* Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/

130

* Validate if WSL 2.0 is properly installed

131

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

132

133

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

134

135

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

136

* Enable Hyper-V in Windows Server

137

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

138

** Restart windows

139

* Cross check is WSL 2.0 is installed

140

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

141

* Install Docker Desktop on the Windows Server

142

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

143

** Restart windows

144

* Update Docker Desktop configuration

145

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

146

** Restart Docker

147

* Open Powershell as Administrator

148

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

149

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

150

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

151

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

152

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

153

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

154

* Open the ubuntu terminal, and finish the installation.

155

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

156

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

157

158

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

159

160

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

161

* Install & 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

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

165

* Create a VM in HyperV.

166

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

167

** Configure a virtual switch.

168

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

169

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

170

* Install ubuntu downloaded previously on the VM

171

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

172

* Go to the next section around installing the eMagiz agent

173

174

=== 3.7 eMagiz Docker agent installation ===

175

176

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.

177

178

[[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]

179

180

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.

== 4. Assignment ==

Check out the cheatcheet for Docker command line:

185

186

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

187

188

== 5. Key takeaways ==

189

190

* 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

191

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

192

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

201