Skip to Content

Wiki source code of On-premise Install Guide

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