Skip to Content

Wiki source code of On-premise Install Guide

Version 57.1 by eMagiz on 2023/02/07 11:42
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
35 * Install the eMagiz Deploy agent
36
eMagiz 26.1 37 ===3.3 Installation requirements Windows Server 2022===
eMagiz 18.1 38
39 These are the requirements to allow the installation of the eMagiz Docker agent:
Erik Bakker 38.1 40 * Install latest version of Docker Desktop from {{code}}https://www.docker.com/products/docker-desktop/{{/code}}
eMagiz 17.1 41 * Validate if WSL 2.0 is properly installed
eMagiz 28.1 42 * Go to the next section around installing the eMagiz Docker agent
Erik Bakker 38.1 43
eMagiz 44.1 44 ===3.3 Installation requirements Windows Server 2022 (without Docker Desktop) ===
45
46 **Step 1: Install linux distribution**
eMagiz 46.1 47
eMagiz 42.1 48 {{code language="cmd"}}
eMagiz 47.1 49 wsl --install -d Ubuntu
eMagiz 45.1 50 sudo apt-get update
51 sudo apt install --no-install-recommends apt-transport-https ca-certificates curl gnupg2
52 . /etc/os-release
eMagiz 43.1 53 {{/code}}
eMagiz 44.1 54
55
eMagiz 45.1 56 **Step 2: Install Docker **
eMagiz 47.1 57
eMagiz 45.1 58 {{code language="cmd"}}
eMagiz 47.1 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
63 {{/code}}
eMagiz 24.1 64
eMagiz 48.1 65 {{info}}
eMagiz 47.1 66 Requires ~335 Mb space to install
eMagiz 48.1 67 {{/info}}
eMagiz 45.1 68
69 **Step 3: Install Java **
eMagiz 32.1 70
eMagiz 48.1 71 {{code language="cmd"}}
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
76 {{/code}}
eMagiz 45.1 77
eMagiz 48.1 78 {{info}}
79 Requires ~335 Mb space to install
80 {{/info}}
eMagiz 45.1 81
eMagiz 51.1 82 **Step 4: Ensure Docker is autostarted with WSL **
eMagiz 50.1 83
eMagiz 49.1 84 {{code language="cmd"}}
eMagiz 32.1 85 nano .bashrc
86
eMagiz 49.1 87 #Add following lines to bashrc
eMagiz 32.1 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"
eMagiz 49.1 92 {{/code}}
eMagiz 32.1 93
eMagiz 52.1 94 **Step 5: Add user to Docker group **
eMagiz 51.1 95
eMagiz 52.1 96 {{code language="cmd"}}
eMagiz 32.1 97 sudo visudo
eMagiz 52.1 98
99 #Add following lines
100
eMagiz 51.1 101 # Don't ask for password
102 %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
eMagiz 52.1 103 {{/code}}
104
105 **Step 6: Update wsl config file **
eMagiz 54.1 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
eMagiz 52.1 107
eMagiz 54.1 108 First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
eMagiz 55.1 109
eMagiz 56.1 110
eMagiz 52.1 111 {{code language="cmd"}}
112 #Add following lines
eMagiz 54.1 113
eMagiz 51.1 114 # 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
119 processors=2
eMagiz 56.1 120 {{/code}}
eMagiz 32.1 121
eMagiz 56.1 122
eMagiz 55.1 123 **Step 7: Auto start the linux subsystem when server restarts **
eMagiz 45.1 124
eMagiz 32.1 125
eMagiz 26.1 126 ===3.4 Installation requirements Windows Server 2019 version >1806===
eMagiz 24.1 127
128 These are the requirements to allow the installation of the eMagiz Docker agent:
eMagiz 27.1 129 * Install latest version of Docker Desktop from https://www.docker.com/products/docker-desktop/
eMagiz 24.1 130 * Validate if WSL 2.0 is properly installed
eMagiz 28.1 131 * Go to the next section around installing the eMagiz Docker agent
Erik Bakker 40.1 132
eMagiz 26.1 133 ===3.5 Installation requirements Windows Server 2019 version 1806===
eMagiz 17.1 134
eMagiz 18.1 135 These are the requirements to allow the installation of the eMagiz Docker agent:
eMagiz 12.1 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
eMagiz 29.1 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
eMagiz 12.1 141 * Install Docker Desktop on the Windows Server
142 ** Please refer to this link: https://www.docker.com/products/docker-desktop/
143 ** Restart windows
eMagiz 25.1 144 * Update Docker Desktop configuration
eMagiz 12.1 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
eMagiz 14.1 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.
eMagiz 12.1 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
eMagiz 28.1 156 * Go to the next section around installing the eMagiz Docker agent
Erik Bakker 40.1 157
eMagiz 26.1 158 ===3.6 Installation requirements Windows Server 2012 R2 ===
Erik Bakker 40.1 159
eMagiz 18.1 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).
eMagiz 19.1 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
eMagiz 18.1 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
eMagiz 22.1 172 * Go to the next section around installing the eMagiz agent
Erik Bakker 40.1 173
eMagiz 28.1 174 === 3.7 eMagiz Docker agent installation ===
Erik Bakker 40.1 175
eMagiz 36.1 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.
Erik Bakker 40.1 177
eMagiz 37.1 178 [[image:Main.Images.Microlearning.WebHome@expert-solution-architecture-onpremises-installguide-deployagent.png]]
eMagiz 1.1 179
eMagiz 26.1 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.
eMagiz 23.1 181
eMagiz 1.1 182 == 4. Assignment ==
183
eMagiz 9.1 184 Check out the cheatcheet for Docker command line:
Erik Bakker 40.1 185
eMagiz 9.1 186 [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
eMagiz 1.1 187
188 == 5. Key takeaways ==
189
eMagiz 5.1 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
Erik Bakker 40.1 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.
eMagiz 1.1 193
194
195
196 == 6. Suggested Additional Readings ==
197
eMagiz 8.1 198 N/A
199
eMagiz 1.1 200 == 7. Silent demonstration video ==
201
eMagiz 3.1 202 N/A
eMagiz 1.1 203
204 )))((({{toc/}}))){{/container}}{{/container}}