Skip to Content

Wiki source code of On-premise Install Guide

Version 59.1 by eMagiz on 2023/02/07 12:09
Hide last authors
eMagiz 1.1 1 {{container}}{{container layoutStyle="columns"}}(((
eMagiz 3.1 2 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.
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 30.1 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.
eMagiz 21.1 15
eMagiz 3.1 16 == 3. On-premises deployments ==
eMagiz 25.1 17
18 ===3.1 General requirements===
eMagiz 17.1 19
eMagiz 25.1 20 These are the general requirements to allow the installation of the eMagiz Docker agent:
eMagiz 17.1 21 * Ensure access to the following URLs is enabled
eMagiz 33.1 22 ** registry.emagiz.com:8443
eMagiz 34.1 23 ** controlplane.emagiz.com:8000
eMagiz 17.1 24 ** Preferably the entry should be *.emagiz.com
eMagiz 31.1 25
eMagiz 25.1 26
27 ===3.2 Installation requirements Linux===
28
eMagiz 57.1 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.
eMagiz 1.1 31
eMagiz 57.1 32 {{code}}https://docs.docker.com/engine/install/ubuntu/{{/code}}
33
34
eMagiz 58.1 35 * Install the eMagiz Deploy agent
eMagiz 57.1 36
eMagiz 58.1 37 ===3.3 Installation requirements Windows Server 2022 (Docker Desktop)===
eMagiz 18.1 38
eMagiz 59.1 39 {{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
40
eMagiz 18.1 41 These are the requirements to allow the installation of the eMagiz Docker agent:
eMagiz 58.1 42 * Install latest version of Docker Desktop from
43
44 {{code}}https://www.docker.com/products/docker-desktop/{{/code}}
45
eMagiz 17.1 46 * Validate if WSL 2.0 is properly installed
eMagiz 58.1 47 * Install the eMagiz Deploy agent
Erik Bakker 38.1 48
eMagiz 44.1 49 ===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
eMagiz 59.1 50
51 {{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
52
eMagiz 58.1 53 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).
54
eMagiz 44.1 55 **Step 1: Install linux distribution**
eMagiz 46.1 56
eMagiz 42.1 57 {{code language="cmd"}}
eMagiz 47.1 58 wsl --install -d Ubuntu
eMagiz 45.1 59 sudo apt-get update
60 sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
61 . /etc/os-release
eMagiz 43.1 62 {{/code}}
eMagiz 44.1 63
64
eMagiz 45.1 65 **Step 2: Install Docker **
eMagiz 47.1 66
eMagiz 45.1 67 {{code language="cmd"}}
eMagiz 47.1 68 curl -fsSL https://download.docker.com/linux/${ID}/gpg | sudo tee /etc/apt/trusted.gpg.d/docker.asc
69 echo "deb [arch=amd64] https://download.docker.com/linux/${ID} ${VERSION_CODENAME} stable" | sudo tee /etc/apt/sources.list.d/docker.list
70 sudo apt update
71 sudo apt install docker-ce docker-ce-cli containerd.io
72 {{/code}}
eMagiz 24.1 73
eMagiz 48.1 74 {{info}}
eMagiz 47.1 75 Requires ~335 Mb space to install
eMagiz 48.1 76 {{/info}}
eMagiz 45.1 77
78 **Step 3: Install Java **
eMagiz 32.1 79
eMagiz 48.1 80 {{code language="cmd"}}
81 wget -O - https://packages.adoptium.net/artifactory/api/gpg/key/public | sudo apt-key add -
82 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
83 sudo apt update # update if you haven't already
84 sudo apt install temurin-8-jdk
85 {{/code}}
eMagiz 45.1 86
eMagiz 48.1 87 {{info}}
88 Requires ~335 Mb space to install
89 {{/info}}
eMagiz 45.1 90
eMagiz 51.1 91 **Step 4: Ensure Docker is autostarted with WSL **
eMagiz 50.1 92
eMagiz 49.1 93 {{code language="cmd"}}
eMagiz 32.1 94 nano .bashrc
95
eMagiz 49.1 96 #Add following lines to bashrc
eMagiz 32.1 97 DOCKER_DISTRO="Ubuntu"
98 DOCKER_LOG_DIR=$HOME/docker_logs
99 mkdir -pm o=,ug=rwx "$DOCKER_LOG_DIR"
100 /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 101 {{/code}}
eMagiz 32.1 102
eMagiz 52.1 103 **Step 5: Add user to Docker group **
eMagiz 51.1 104
eMagiz 52.1 105 {{code language="cmd"}}
eMagiz 32.1 106 sudo visudo
eMagiz 52.1 107
108 #Add following lines
109
eMagiz 51.1 110 # Don't ask for password
111 %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
eMagiz 52.1 112 {{/code}}
113
114 **Step 6: Update wsl config file **
eMagiz 54.1 115 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 52.1 116
eMagiz 54.1 117 First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
eMagiz 55.1 118
eMagiz 56.1 119
eMagiz 52.1 120 {{code language="cmd"}}
121 #Add following lines
eMagiz 54.1 122
eMagiz 51.1 123 # Settings apply across all Linux distros running on WSL 2
124 [wsl2]
125 # Limits VM memory to use no more than 4 GB, this can be set as whole numbers using GB or MB
126 memory=16GB
127 # Sets the VM to use two virtual processors
128 processors=2
eMagiz 56.1 129 {{/code}}
eMagiz 32.1 130
eMagiz 56.1 131
eMagiz 55.1 132 **Step 7: Auto start the linux subsystem when server restarts **
eMagiz 45.1 133
eMagiz 32.1 134
eMagiz 26.1 135 ===3.4 Installation requirements Windows Server 2019 version >1806===
eMagiz 24.1 136
137 These are the requirements to allow the installation of the eMagiz Docker agent:
eMagiz 27.1 138 * Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
eMagiz 24.1 139 * Validate if WSL 2.0 is properly installed
eMagiz 28.1 140 * Go to the next section around installing the eMagiz Docker agent
Erik Bakker 40.1 141
eMagiz 26.1 142 ===3.5 Installation requirements Windows Server 2019 version 1806===
eMagiz 17.1 143
eMagiz 18.1 144 These are the requirements to allow the installation of the eMagiz Docker agent:
eMagiz 12.1 145 * Enable Hyper-V in Windows Server
146 ** 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.
147 ** Restart windows
eMagiz 29.1 148 * Cross check is WSL 2.0 is installed
149 ** Use this command to get WSL 2.0: Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
eMagiz 12.1 150 * Install Docker Desktop on the Windows Server
151 ** Please refer to this link: https://www.docker.com/products/docker-desktop/
152 ** Restart windows
eMagiz 25.1 153 * Update Docker Desktop configuration
eMagiz 12.1 154 ** Go to settings, and enable ‘Expose daemon on tcp://localhost:2375’ without TLS
155 ** Restart Docker
156 * Open Powershell as Administrator
157 ** Execute "C:\Program Files\Docker\Docker\DockerCli.exe" -SwitchLinuxEngine
158 ** Execute Enable-WindowsOptionalFeature -Online -FeatureName Microsoft-Windows-Subsystem-Linux
159 ** Execute curl.exe -L -o ubuntu-2004.appx https://aka.ms/wslubuntu2004
160 ** Execute Add-AppxPackage .\ubuntu-2004.appx
eMagiz 14.1 161 *** 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 162 * Ubuntu should now be a runnable program (press windows key, type ubuntu)
163 * Open the ubuntu terminal, and finish the installation.
164 ** After installation, execute: export DOCKER_HOST=tcp://localhost:2375
eMagiz 28.1 165 * Go to the next section around installing the eMagiz Docker agent
Erik Bakker 40.1 166
eMagiz 26.1 167 ===3.6 Installation requirements Windows Server 2012 R2 ===
Erik Bakker 40.1 168
eMagiz 18.1 169 These are the requirements to allow the installation of the eMagiz Docker agent:
170 * Install & enable Hyper-V in Windows Server
171 ** 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.
172 ** Restart windows
173 * Download a ubuntu server 18.04 (https://releases.ubuntu.com/18.04/ubuntu-18.04.6-live-server-amd64.iso )
174 * Create a VM in HyperV.
175 ** 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 176 ** Configure a virtual switch.
177 ** Add a virtual Hard Disk with proper sizing (e.g. 30 GB)
178 ** Install an operating system from bootable CD/DVD, ISO file
eMagiz 18.1 179 * Install ubuntu downloaded previously on the VM
180 * 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 181 * Go to the next section around installing the eMagiz agent
Erik Bakker 40.1 182
eMagiz 28.1 183 === 3.7 eMagiz Docker agent installation ===
Erik Bakker 40.1 184
eMagiz 36.1 185 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.
Erik Bakker 40.1 186
eMagiz 37.1 187 [[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
eMagiz 1.1 188
eMagiz 26.1 189 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.
eMagiz 23.1 190
eMagiz 1.1 191 == 4. Assignment ==
192
eMagiz 9.1 193 Check out the cheatcheet for Docker command line:
Erik Bakker 40.1 194
eMagiz 9.1 195 [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
eMagiz 1.1 196
197 == 5. Key takeaways ==
198
eMagiz 5.1 199 * 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
200 * eMagiz has a specific agent that manages the download of that image to the on-premises server
Erik Bakker 40.1 201 * 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 202
203
204
205 == 6. Suggested Additional Readings ==
206
eMagiz 8.1 207 N/A
208
eMagiz 1.1 209 == 7. Silent demonstration video ==
210
eMagiz 3.1 211 N/A
eMagiz 1.1 212
213 )))((({{toc/}}))){{/container}}{{/container}}