Skip to Content

Wiki source code of On-premise Install Guide

Version 64.1 by eMagiz on 2023/02/07 12:36
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 63.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 **Step 1: Install linux distribution**
31 Follow all steps in section 3.4
eMagiz 1.1 32
eMagiz 63.1 33 **Step 2: Install eMagiz Deploy Agent**
34 Install the eMagiz Deploy agent as can be found here
eMagiz 57.1 35
eMagiz 62.1 36 ===3.3 Installation requirements Windows Server 2022 ===
eMagiz 18.1 37
eMagiz 59.1 38 {{info}}Please note that this section also applies to Windows Server 2019 version >1806{{/info}}
39
eMagiz 58.1 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
eMagiz 44.1 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
eMagiz 62.1 51 **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
eMagiz 44.1 56
eMagiz 62.1 57 First, locate the config file or add it to the location %USERPROFILE%. The name should be .wslconfig (no extension)
eMagiz 47.1 58
eMagiz 45.1 59 {{code language="cmd"}}
eMagiz 62.1 60 #Add following lines
61
62 # 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
67 processors=2
68 {{/code}}
69
70
71 **Step 4: Auto start the linux subsystem when Windows server restarts **
72
eMagiz 63.1 73 **Step 5: Install eMagiz Deploy Agent**
74 Install the eMagiz Deploy agent as can be found here
75
76
eMagiz 62.1 77 ===3.4 Installation steps to configure Linux subsystem ===
78
79 **Step 1: Install Docker **
80
81 {{code language="cmd"}}
eMagiz 47.1 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
86 {{/code}}
eMagiz 24.1 87
eMagiz 48.1 88 {{info}}
eMagiz 47.1 89 Requires ~335 Mb space to install
eMagiz 48.1 90 {{/info}}
eMagiz 45.1 91
eMagiz 62.1 92 **Step 2: Install Java **
eMagiz 32.1 93
eMagiz 48.1 94 {{code language="cmd"}}
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
99 {{/code}}
eMagiz 45.1 100
eMagiz 48.1 101 {{info}}
102 Requires ~335 Mb space to install
103 {{/info}}
eMagiz 45.1 104
eMagiz 62.1 105 **Step 3: Ensure Docker is autostarted with WSL **
eMagiz 50.1 106
eMagiz 49.1 107 {{code language="cmd"}}
eMagiz 32.1 108 nano .bashrc
109
eMagiz 49.1 110 #Add following lines to bashrc
eMagiz 32.1 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"
eMagiz 49.1 115 {{/code}}
eMagiz 32.1 116
eMagiz 62.1 117 **Step 4: Add user to Docker group **
eMagiz 51.1 118
eMagiz 52.1 119 {{code language="cmd"}}
eMagiz 32.1 120 sudo visudo
eMagiz 52.1 121
122 #Add following lines
123
eMagiz 51.1 124 # Don't ask for password
125 %docker ALL=(ALL) NOPASSWD: /usr/bin/dockerd
eMagiz 52.1 126 {{/code}}
127
eMagiz 45.1 128
eMagiz 32.1 129
eMagiz 60.1 130 ===3.5 Installation requirements Windows Server 2019 version 1806===
eMagiz 24.1 131
eMagiz 61.1 132 {{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
Erik Bakker 40.1 133
eMagiz 18.1 134 These are the requirements to allow the installation of the eMagiz Docker agent:
eMagiz 12.1 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
eMagiz 29.1 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
eMagiz 12.1 140 * Install Docker Desktop on the Windows Server
141 ** Please refer to this link: https://www.docker.com/products/docker-desktop/
142 ** Restart windows
eMagiz 25.1 143 * Update Docker Desktop configuration
eMagiz 12.1 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
eMagiz 14.1 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.
eMagiz 12.1 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
eMagiz 28.1 155 * Go to the next section around installing the eMagiz Docker agent
Erik Bakker 40.1 156
eMagiz 26.1 157 ===3.6 Installation requirements Windows Server 2012 R2 ===
Erik Bakker 40.1 158
eMagiz 61.1 159 {{warning}}Please note that this section is under construction. Please contact us at productmanagement@emagiz.com{{/warning}}
eMagiz 60.1 160
eMagiz 18.1 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).
eMagiz 19.1 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
eMagiz 18.1 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
eMagiz 22.1 173 * Go to the next section around installing the eMagiz agent
Erik Bakker 40.1 174
eMagiz 1.1 175 == 4. Assignment ==
176
eMagiz 9.1 177 Check out the cheatcheet for Docker command line:
Erik Bakker 40.1 178
eMagiz 9.1 179 [[image:Main.Images.Microlearning.WebHome@docker-cheatsheet.png]]
eMagiz 1.1 180
181 == 5. Key takeaways ==
182
eMagiz 5.1 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
Erik Bakker 40.1 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.
eMagiz 1.1 186
187
188
189 == 6. Suggested Additional Readings ==
190
eMagiz 8.1 191 N/A
192
eMagiz 1.1 193 == 7. Silent demonstration video ==
194
eMagiz 3.1 195 N/A
eMagiz 1.1 196
197 )))((({{toc/}}))){{/container}}{{/container}}